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