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