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