22be2e0269fb41c8708dc70fb64642c587f471f3
[people/pcmattman/gpxe.git] / src / arch / i386 / interface / pxe / pxe_preboot.c
1 /** @file
2  *
3  * PXE Preboot API
4  *
5  */
6
7 /* PXE API interface for Etherboot.
8  *
9  * Copyright (C) 2004 Michael Brown <mbrown@fensystems.co.uk>.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License as
13  * published by the Free Software Foundation; either version 2 of the
14  * License, or any later version.
15  *
16  * This program is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  */
25
26 FILE_LICENCE ( GPL2_OR_LATER );
27
28 #include <stdint.h>
29 #include <string.h>
30 #include <stdlib.h>
31 #include <gpxe/uaccess.h>
32 #include <gpxe/dhcp.h>
33 #include <gpxe/fakedhcp.h>
34 #include <gpxe/device.h>
35 #include <gpxe/netdevice.h>
36 #include <gpxe/isapnp.h>
37 #include <gpxe/init.h>
38 #include <gpxe/if_ether.h>
39 #include <basemem_packet.h>
40 #include <biosint.h>
41 #include "pxe.h"
42 #include "pxe_call.h"
43
44 /* Avoid dragging in isapnp.o unnecessarily */
45 uint16_t isapnp_read_port;
46
47 /** Zero-based versions of PXENV_GET_CACHED_INFO::PacketType */
48 enum pxe_cached_info_indices {
49         CACHED_INFO_DHCPDISCOVER = ( PXENV_PACKET_TYPE_DHCP_DISCOVER - 1 ),
50         CACHED_INFO_DHCPACK = ( PXENV_PACKET_TYPE_DHCP_ACK - 1 ),
51         CACHED_INFO_BINL = ( PXENV_PACKET_TYPE_CACHED_REPLY - 1 ),
52         NUM_CACHED_INFOS
53 };
54
55 /** A cached DHCP packet */
56 union pxe_cached_info {
57         struct dhcphdr dhcphdr;
58         /* This buffer must be *exactly* the size of a BOOTPLAYER_t
59          * structure, otherwise WinPE will die horribly.  It takes the
60          * size of *our* buffer and feeds it in to us as the size of
61          * one of *its* buffers.  If our buffer is larger than it
62          * expects, we therefore end up overwriting part of its data
63          * segment, since it tells us to do so.  (D'oh!)
64          *
65          * Note that a BOOTPLAYER_t is not necessarily large enough to
66          * hold a DHCP packet; this is a flaw in the PXE spec.
67          */
68         BOOTPLAYER_t packet;
69 } __attribute__ (( packed ));
70
71 /** A PXE DHCP packet creator */
72 struct pxe_dhcp_packet_creator {
73         /** Create DHCP packet
74          *
75          * @v netdev            Network device
76          * @v data              Buffer for DHCP packet
77          * @v max_len           Size of DHCP packet buffer
78          * @ret rc              Return status code
79          */
80         int ( * create ) ( struct net_device *netdev, void *data,
81                            size_t max_len );
82 };
83
84 /** PXE DHCP packet creators */
85 static struct pxe_dhcp_packet_creator pxe_dhcp_packet_creators[] = {
86         [CACHED_INFO_DHCPDISCOVER] = { create_fakedhcpdiscover },
87         [CACHED_INFO_DHCPACK] = { create_fakedhcpack },
88         [CACHED_INFO_BINL] = { create_fakepxebsack },
89 };
90
91 /* The case in which the caller doesn't supply a buffer is really
92  * awkward to support given that we have multiple sources of options,
93  * and that we don't actually store the DHCP packets.  (We may not
94  * even have performed DHCP; we may have obtained all configuration
95  * from non-volatile stored options or from the command line.)
96  *
97  * Some NBPs rely on the buffers we provide being persistent, so we
98  * can't just use the temporary packet buffer.  4.5kB of base memory
99  * always wasted just because some clients are too lazy to provide
100  * their own buffers...
101  */
102 static union pxe_cached_info __bss16_array ( cached_info, [NUM_CACHED_INFOS] );
103 #define cached_info __use_data16 ( cached_info )
104
105 /**
106  * UNLOAD BASE CODE STACK
107  *
108  * @v None                              -
109  * @ret ...
110  *
111  */
112 PXENV_EXIT_t pxenv_unload_stack ( struct s_PXENV_UNLOAD_STACK *unload_stack ) {
113         DBG ( "PXENV_UNLOAD_STACK" );
114
115         unload_stack->Status = PXENV_STATUS_SUCCESS;
116         return PXENV_EXIT_SUCCESS;
117 }
118
119 /* PXENV_GET_CACHED_INFO
120  *
121  * Status: working
122  */
123 PXENV_EXIT_t pxenv_get_cached_info ( struct s_PXENV_GET_CACHED_INFO
124                                      *get_cached_info ) {
125         struct pxe_dhcp_packet_creator *creator;
126         union pxe_cached_info *info;
127         unsigned int idx;
128         size_t len;
129         userptr_t buffer;
130         int rc;
131
132         DBG ( "PXENV_GET_CACHED_INFO %d", get_cached_info->PacketType );
133
134         DBG ( " to %04x:%04x+%x", get_cached_info->Buffer.segment,
135               get_cached_info->Buffer.offset, get_cached_info->BufferSize );
136
137         /* Sanity check */
138         idx = ( get_cached_info->PacketType - 1 );
139         if ( idx >= NUM_CACHED_INFOS ) {
140                 DBG ( " bad PacketType" );
141                 goto err;
142         }
143         info = &cached_info[idx];
144
145         /* Construct cached version of packet, if not already constructed. */
146         if ( ! info->dhcphdr.op ) {
147                 /* Construct DHCP packet */
148                 creator = &pxe_dhcp_packet_creators[idx];
149                 if ( ( rc = creator->create ( pxe_netdev, info,
150                                               sizeof ( *info ) ) ) != 0 ) {
151                         DBG ( " failed to build packet" );
152                         goto err;
153                 }
154         }
155
156         len = get_cached_info->BufferSize;
157         if ( len == 0 ) {
158                 /* Point client at our cached buffer.
159                  *
160                  * To add to the fun, Intel decided at some point in
161                  * the evolution of the PXE specification to add the
162                  * BufferLimit field, which we are meant to fill in
163                  * with the length of our packet buffer, so that the
164                  * caller can safely modify the boot server reply
165                  * packet stored therein.  However, this field was not
166                  * present in earlier versions of the PXE spec, and
167                  * there is at least one PXE NBP (Altiris) which
168                  * allocates only exactly enough space for this
169                  * earlier, shorter version of the structure.  If we
170                  * actually fill in the BufferLimit field, we
171                  * therefore risk trashing random areas of the
172                  * caller's memory.  If we *don't* fill it in, then
173                  * the caller is at liberty to assume that whatever
174                  * random value happened to be in that location
175                  * represents the length of the buffer we've just
176                  * passed back to it.
177                  *
178                  * Since older PXE stacks won't fill this field in
179                  * anyway, it's probably safe to assume that no
180                  * callers actually rely on it, so we choose to not
181                  * fill it in.
182                  */
183                 get_cached_info->Buffer.segment = rm_ds;
184                 get_cached_info->Buffer.offset = __from_data16 ( info );
185                 get_cached_info->BufferSize = sizeof ( *info );
186                 DBG ( " returning %04x:%04x+%04x['%x']",
187                       get_cached_info->Buffer.segment,
188                       get_cached_info->Buffer.offset,
189                       get_cached_info->BufferSize,
190                       get_cached_info->BufferLimit );
191         } else {
192                 /* Copy packet to client buffer */
193                 if ( len > sizeof ( *info ) )
194                         len = sizeof ( *info );
195                 if ( len < sizeof ( *info ) )
196                         DBG ( " buffer may be too short" );
197                 buffer = real_to_user ( get_cached_info->Buffer.segment,
198                                         get_cached_info->Buffer.offset );
199                 copy_to_user ( buffer, 0, info, len );
200                 get_cached_info->BufferSize = len;
201         }
202
203         get_cached_info->Status = PXENV_STATUS_SUCCESS;
204         return PXENV_EXIT_SUCCESS;
205
206  err:
207         get_cached_info->Status = PXENV_STATUS_OUT_OF_RESOURCES;
208         return PXENV_EXIT_FAILURE;
209 }
210
211 /* PXENV_RESTART_TFTP
212  *
213  * Status: working
214  */
215 PXENV_EXIT_t pxenv_restart_tftp ( struct s_PXENV_TFTP_READ_FILE
216                                   *restart_tftp ) {
217         PXENV_EXIT_t tftp_exit;
218
219         DBG ( "PXENV_RESTART_TFTP " );
220
221         /* Words cannot describe the complete mismatch between the PXE
222          * specification and any possible version of reality...
223          */
224         restart_tftp->Buffer = PXE_LOAD_PHYS; /* Fixed by spec, apparently */
225         restart_tftp->BufferSize = ( 0xa0000 - PXE_LOAD_PHYS ); /* Near enough */
226         tftp_exit = pxenv_tftp_read_file ( restart_tftp );
227         if ( tftp_exit != PXENV_EXIT_SUCCESS )
228                 return tftp_exit;
229
230         /* Fire up the new NBP */
231         restart_tftp->Status = pxe_start_nbp();
232
233         /* Not sure what "SUCCESS" actually means, since we can only
234          * return if the new NBP failed to boot...
235          */
236         return PXENV_EXIT_SUCCESS;
237 }
238
239 /* PXENV_START_UNDI
240  *
241  * Status: working
242  */
243 PXENV_EXIT_t pxenv_start_undi ( struct s_PXENV_START_UNDI *start_undi ) {
244         unsigned int bus_type;
245         unsigned int location;
246         struct net_device *netdev;
247
248         DBG ( "PXENV_START_UNDI %04x:%04x:%04x",
249               start_undi->AX, start_undi->BX, start_undi->DX );
250
251         /* Determine bus type and location.  Use a heuristic to decide
252          * whether we are PCI or ISAPnP
253          */
254         if ( ( start_undi->DX >= ISAPNP_READ_PORT_MIN ) &&
255              ( start_undi->DX <= ISAPNP_READ_PORT_MAX ) &&
256              ( start_undi->BX >= ISAPNP_CSN_MIN ) &&
257              ( start_undi->BX <= ISAPNP_CSN_MAX ) ) {
258                 bus_type = BUS_TYPE_ISAPNP;
259                 location = start_undi->BX;
260                 /* Record ISAPnP read port for use by isapnp.c */
261                 isapnp_read_port = start_undi->DX;
262         } else {
263                 bus_type = BUS_TYPE_PCI;
264                 location = start_undi->AX;
265         }
266
267         /* Probe for devices, etc. */
268         startup();
269
270         /* Look for a matching net device */
271         netdev = find_netdev_by_location ( bus_type, location );
272         if ( ! netdev ) {
273                 DBG ( " no net device found" );
274                 start_undi->Status = PXENV_STATUS_UNDI_CANNOT_INITIALIZE_NIC;
275                 return PXENV_EXIT_FAILURE;
276         }
277         DBG ( " using netdev %s", netdev->name );
278
279         /* Activate PXE */
280         pxe_activate ( netdev );
281
282         start_undi->Status = PXENV_STATUS_SUCCESS;
283         return PXENV_EXIT_SUCCESS;
284 }
285
286 /* PXENV_STOP_UNDI
287  *
288  * Status: working
289  */
290 PXENV_EXIT_t pxenv_stop_undi ( struct s_PXENV_STOP_UNDI *stop_undi ) {
291         DBG ( "PXENV_STOP_UNDI" );
292
293         /* Deactivate PXE */
294         pxe_deactivate();
295
296         /* Prepare for unload */
297         shutdown ( SHUTDOWN_BOOT );
298
299         /* Check to see if we still have any hooked interrupts */
300         if ( hooked_bios_interrupts != 0 ) {
301                 DBG ( "PXENV_STOP_UNDI failed: %d interrupts still hooked\n",
302                       hooked_bios_interrupts );
303                 stop_undi->Status = PXENV_STATUS_KEEP_UNDI;
304                 return PXENV_EXIT_FAILURE;
305         }
306
307         stop_undi->Status = PXENV_STATUS_SUCCESS;
308         return PXENV_EXIT_SUCCESS;
309 }
310
311 /* PXENV_START_BASE
312  *
313  * Status: won't implement (requires major structural changes)
314  */
315 PXENV_EXIT_t pxenv_start_base ( struct s_PXENV_START_BASE *start_base ) {
316         DBG ( "PXENV_START_BASE" );
317
318         start_base->Status = PXENV_STATUS_UNSUPPORTED;
319         return PXENV_EXIT_FAILURE;
320 }
321
322 /* PXENV_STOP_BASE
323  *
324  * Status: working
325  */
326 PXENV_EXIT_t pxenv_stop_base ( struct s_PXENV_STOP_BASE *stop_base ) {
327         DBG ( "PXENV_STOP_BASE" );
328
329         /* The only time we will be called is when the NBP is trying
330          * to shut down the PXE stack.  There's nothing we need to do
331          * in this call.
332          */
333
334         stop_base->Status = PXENV_STATUS_SUCCESS;
335         return PXENV_EXIT_SUCCESS;
336 }