2 * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * License, or any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 FILE_LICENCE ( GPL2_OR_LATER );
21 #include <gpxe/uaccess.h>
22 #include <gpxe/init.h>
23 #include <registers.h>
33 /** Vector for chaining INT 1A */
34 extern struct segoff __text16 ( pxe_int_1a_vector );
35 #define pxe_int_1a_vector __use_text16 ( pxe_int_1a_vector )
38 extern void pxe_int_1a ( void );
40 /** INT 1A hooked flag */
41 static int int_1a_hooked = 0;
43 /** A function pointer to hold any PXE API call
45 * Used by pxe_api_call() to avoid large swathes of duplicated code.
48 PXENV_EXIT_t ( * any ) ( union u_PXENV_ANY * );
49 PXENV_EXIT_t ( * unknown ) ( struct s_PXENV_UNKNOWN * );
50 PXENV_EXIT_t ( * unload_stack ) ( struct s_PXENV_UNLOAD_STACK * );
51 PXENV_EXIT_t ( * get_cached_info )
52 ( struct s_PXENV_GET_CACHED_INFO * );
53 PXENV_EXIT_t ( * restart_tftp ) ( struct s_PXENV_TFTP_READ_FILE * );
54 PXENV_EXIT_t ( * start_undi ) ( struct s_PXENV_START_UNDI * );
55 PXENV_EXIT_t ( * stop_undi ) ( struct s_PXENV_STOP_UNDI * );
56 PXENV_EXIT_t ( * start_base ) ( struct s_PXENV_START_BASE * );
57 PXENV_EXIT_t ( * stop_base ) ( struct s_PXENV_STOP_BASE * );
58 PXENV_EXIT_t ( * tftp_open ) ( struct s_PXENV_TFTP_OPEN * );
59 PXENV_EXIT_t ( * tftp_close ) ( struct s_PXENV_TFTP_CLOSE * );
60 PXENV_EXIT_t ( * tftp_read ) ( struct s_PXENV_TFTP_READ * );
61 PXENV_EXIT_t ( * tftp_read_file ) ( struct s_PXENV_TFTP_READ_FILE * );
62 PXENV_EXIT_t ( * tftp_get_fsize ) ( struct s_PXENV_TFTP_GET_FSIZE * );
63 PXENV_EXIT_t ( * udp_open ) ( struct s_PXENV_UDP_OPEN * );
64 PXENV_EXIT_t ( * udp_close ) ( struct s_PXENV_UDP_CLOSE * );
65 PXENV_EXIT_t ( * udp_write ) ( struct s_PXENV_UDP_WRITE * );
66 PXENV_EXIT_t ( * udp_read ) ( struct s_PXENV_UDP_READ * );
67 PXENV_EXIT_t ( * undi_startup ) ( struct s_PXENV_UNDI_STARTUP * );
68 PXENV_EXIT_t ( * undi_cleanup ) ( struct s_PXENV_UNDI_CLEANUP * );
69 PXENV_EXIT_t ( * undi_initialize )
70 ( struct s_PXENV_UNDI_INITIALIZE * );
71 PXENV_EXIT_t ( * undi_reset_adapter ) ( struct s_PXENV_UNDI_RESET * );
72 PXENV_EXIT_t ( * undi_shutdown ) ( struct s_PXENV_UNDI_SHUTDOWN * );
73 PXENV_EXIT_t ( * undi_open ) ( struct s_PXENV_UNDI_OPEN * );
74 PXENV_EXIT_t ( * undi_close ) ( struct s_PXENV_UNDI_CLOSE * );
75 PXENV_EXIT_t ( * undi_transmit ) ( struct s_PXENV_UNDI_TRANSMIT * );
76 PXENV_EXIT_t ( * undi_set_mcast_address )
77 ( struct s_PXENV_UNDI_SET_MCAST_ADDRESS * );
78 PXENV_EXIT_t ( * undi_set_station_address )
79 ( struct s_PXENV_UNDI_SET_STATION_ADDRESS * );
80 PXENV_EXIT_t ( * undi_set_packet_filter )
81 ( struct s_PXENV_UNDI_SET_PACKET_FILTER * );
82 PXENV_EXIT_t ( * undi_get_information )
83 ( struct s_PXENV_UNDI_GET_INFORMATION * );
84 PXENV_EXIT_t ( * undi_get_statistics )
85 ( struct s_PXENV_UNDI_GET_STATISTICS * );
86 PXENV_EXIT_t ( * undi_clear_statistics )
87 ( struct s_PXENV_UNDI_CLEAR_STATISTICS * );
88 PXENV_EXIT_t ( * undi_initiate_diags )
89 ( struct s_PXENV_UNDI_INITIATE_DIAGS * );
90 PXENV_EXIT_t ( * undi_force_interrupt )
91 ( struct s_PXENV_UNDI_FORCE_INTERRUPT * );
92 PXENV_EXIT_t ( * undi_get_mcast_address )
93 ( struct s_PXENV_UNDI_GET_MCAST_ADDRESS * );
94 PXENV_EXIT_t ( * undi_get_nic_type )
95 ( struct s_PXENV_UNDI_GET_NIC_TYPE * );
96 PXENV_EXIT_t ( * undi_get_iface_info )
97 ( struct s_PXENV_UNDI_GET_IFACE_INFO * );
98 PXENV_EXIT_t ( * undi_get_state ) ( struct s_PXENV_UNDI_GET_STATE * );
99 PXENV_EXIT_t ( * undi_isr ) ( struct s_PXENV_UNDI_ISR * );
100 PXENV_EXIT_t ( * file_open ) ( struct s_PXENV_FILE_OPEN * );
101 PXENV_EXIT_t ( * file_close ) ( struct s_PXENV_FILE_CLOSE * );
102 PXENV_EXIT_t ( * file_select ) ( struct s_PXENV_FILE_SELECT * );
103 PXENV_EXIT_t ( * file_read ) ( struct s_PXENV_FILE_READ * );
104 PXENV_EXIT_t ( * get_file_size ) ( struct s_PXENV_GET_FILE_SIZE * );
105 PXENV_EXIT_t ( * file_exec ) ( struct s_PXENV_FILE_EXEC * );
106 PXENV_EXIT_t ( * file_api_check ) ( struct s_PXENV_FILE_API_CHECK * );
110 * Handle an unknown PXE API call
112 * @v pxenv_unknown Pointer to a struct s_PXENV_UNKNOWN
113 * @ret #PXENV_EXIT_FAILURE Always
114 * @err #PXENV_STATUS_UNSUPPORTED Always
116 static PXENV_EXIT_t pxenv_unknown ( struct s_PXENV_UNKNOWN *pxenv_unknown ) {
117 pxenv_unknown->Status = PXENV_STATUS_UNSUPPORTED;
118 return PXENV_EXIT_FAILURE;
122 * Dispatch PXE API call
125 * @v es:di Address of PXE parameter block
126 * @ret ax PXE exit code
128 __asmcall void pxe_api_call ( struct i386_all_regs *ix86 ) {
129 int opcode = ix86->regs.bx;
130 userptr_t parameters = real_to_user ( ix86->segs.es, ix86->regs.di );
132 union u_PXENV_ANY pxenv_any;
133 union pxenv_call pxenv_call;
137 case PXENV_UNLOAD_STACK:
138 pxenv_call.unload_stack = pxenv_unload_stack;
139 param_len = sizeof ( pxenv_any.unload_stack );
141 case PXENV_GET_CACHED_INFO:
142 pxenv_call.get_cached_info = pxenv_get_cached_info;
143 param_len = sizeof ( pxenv_any.get_cached_info );
145 case PXENV_RESTART_TFTP:
146 pxenv_call.restart_tftp = pxenv_restart_tftp;
147 param_len = sizeof ( pxenv_any.restart_tftp );
149 case PXENV_START_UNDI:
150 pxenv_call.start_undi = pxenv_start_undi;
151 param_len = sizeof ( pxenv_any.start_undi );
153 case PXENV_STOP_UNDI:
154 pxenv_call.stop_undi = pxenv_stop_undi;
155 param_len = sizeof ( pxenv_any.stop_undi );
157 case PXENV_START_BASE:
158 pxenv_call.start_base = pxenv_start_base;
159 param_len = sizeof ( pxenv_any.start_base );
161 case PXENV_STOP_BASE:
162 pxenv_call.stop_base = pxenv_stop_base;
163 param_len = sizeof ( pxenv_any.stop_base );
165 case PXENV_TFTP_OPEN:
166 pxenv_call.tftp_open = pxenv_tftp_open;
167 param_len = sizeof ( pxenv_any.tftp_open );
169 case PXENV_TFTP_CLOSE:
170 pxenv_call.tftp_close = pxenv_tftp_close;
171 param_len = sizeof ( pxenv_any.tftp_close );
173 case PXENV_TFTP_READ:
174 pxenv_call.tftp_read = pxenv_tftp_read;
175 param_len = sizeof ( pxenv_any.tftp_read );
177 case PXENV_TFTP_READ_FILE:
178 pxenv_call.tftp_read_file = pxenv_tftp_read_file;
179 param_len = sizeof ( pxenv_any.tftp_read_file );
181 case PXENV_TFTP_GET_FSIZE:
182 pxenv_call.tftp_get_fsize = pxenv_tftp_get_fsize;
183 param_len = sizeof ( pxenv_any.tftp_get_fsize );
186 pxenv_call.udp_open = pxenv_udp_open;
187 param_len = sizeof ( pxenv_any.udp_open );
189 case PXENV_UDP_CLOSE:
190 pxenv_call.udp_close = pxenv_udp_close;
191 param_len = sizeof ( pxenv_any.udp_close );
193 case PXENV_UDP_WRITE:
194 pxenv_call.udp_write = pxenv_udp_write;
195 param_len = sizeof ( pxenv_any.udp_write );
198 pxenv_call.udp_read = pxenv_udp_read;
199 param_len = sizeof ( pxenv_any.udp_read );
201 case PXENV_UNDI_STARTUP:
202 pxenv_call.undi_startup = pxenv_undi_startup;
203 param_len = sizeof ( pxenv_any.undi_startup );
205 case PXENV_UNDI_CLEANUP:
206 pxenv_call.undi_cleanup = pxenv_undi_cleanup;
207 param_len = sizeof ( pxenv_any.undi_cleanup );
209 case PXENV_UNDI_INITIALIZE:
210 pxenv_call.undi_initialize = pxenv_undi_initialize;
211 param_len = sizeof ( pxenv_any.undi_initialize );
213 case PXENV_UNDI_RESET_ADAPTER:
214 pxenv_call.undi_reset_adapter = pxenv_undi_reset_adapter;
215 param_len = sizeof ( pxenv_any.undi_reset_adapter );
217 case PXENV_UNDI_SHUTDOWN:
218 pxenv_call.undi_shutdown = pxenv_undi_shutdown;
219 param_len = sizeof ( pxenv_any.undi_shutdown );
221 case PXENV_UNDI_OPEN:
222 pxenv_call.undi_open = pxenv_undi_open;
223 param_len = sizeof ( pxenv_any.undi_open );
225 case PXENV_UNDI_CLOSE:
226 pxenv_call.undi_close = pxenv_undi_close;
227 param_len = sizeof ( pxenv_any.undi_close );
229 case PXENV_UNDI_TRANSMIT:
230 pxenv_call.undi_transmit = pxenv_undi_transmit;
231 param_len = sizeof ( pxenv_any.undi_transmit );
233 case PXENV_UNDI_SET_MCAST_ADDRESS:
234 pxenv_call.undi_set_mcast_address =
235 pxenv_undi_set_mcast_address;
236 param_len = sizeof ( pxenv_any.undi_set_mcast_address );
238 case PXENV_UNDI_SET_STATION_ADDRESS:
239 pxenv_call.undi_set_station_address =
240 pxenv_undi_set_station_address;
241 param_len = sizeof ( pxenv_any.undi_set_station_address );
243 case PXENV_UNDI_SET_PACKET_FILTER:
244 pxenv_call.undi_set_packet_filter =
245 pxenv_undi_set_packet_filter;
246 param_len = sizeof ( pxenv_any.undi_set_packet_filter );
248 case PXENV_UNDI_GET_INFORMATION:
249 pxenv_call.undi_get_information = pxenv_undi_get_information;
250 param_len = sizeof ( pxenv_any.undi_get_information );
252 case PXENV_UNDI_GET_STATISTICS:
253 pxenv_call.undi_get_statistics = pxenv_undi_get_statistics;
254 param_len = sizeof ( pxenv_any.undi_get_statistics );
256 case PXENV_UNDI_CLEAR_STATISTICS:
257 pxenv_call.undi_clear_statistics = pxenv_undi_clear_statistics;
258 param_len = sizeof ( pxenv_any.undi_clear_statistics );
260 case PXENV_UNDI_INITIATE_DIAGS:
261 pxenv_call.undi_initiate_diags = pxenv_undi_initiate_diags;
262 param_len = sizeof ( pxenv_any.undi_initiate_diags );
264 case PXENV_UNDI_FORCE_INTERRUPT:
265 pxenv_call.undi_force_interrupt = pxenv_undi_force_interrupt;
266 param_len = sizeof ( pxenv_any.undi_force_interrupt );
268 case PXENV_UNDI_GET_MCAST_ADDRESS:
269 pxenv_call.undi_get_mcast_address =
270 pxenv_undi_get_mcast_address;
271 param_len = sizeof ( pxenv_any.undi_get_mcast_address );
273 case PXENV_UNDI_GET_NIC_TYPE:
274 pxenv_call.undi_get_nic_type = pxenv_undi_get_nic_type;
275 param_len = sizeof ( pxenv_any.undi_get_nic_type );
277 case PXENV_UNDI_GET_IFACE_INFO:
278 pxenv_call.undi_get_iface_info = pxenv_undi_get_iface_info;
279 param_len = sizeof ( pxenv_any.undi_get_iface_info );
282 pxenv_call.undi_isr = pxenv_undi_isr;
283 param_len = sizeof ( pxenv_any.undi_isr );
285 case PXENV_FILE_OPEN:
286 pxenv_call.file_open = pxenv_file_open;
287 param_len = sizeof ( pxenv_any.file_open );
289 case PXENV_FILE_CLOSE:
290 pxenv_call.file_close = pxenv_file_close;
291 param_len = sizeof ( pxenv_any.file_close );
293 case PXENV_FILE_SELECT:
294 pxenv_call.file_select = pxenv_file_select;
295 param_len = sizeof ( pxenv_any.file_select );
297 case PXENV_FILE_READ:
298 pxenv_call.file_read = pxenv_file_read;
299 param_len = sizeof ( pxenv_any.file_read );
301 case PXENV_GET_FILE_SIZE:
302 pxenv_call.get_file_size = pxenv_get_file_size;
303 param_len = sizeof ( pxenv_any.get_file_size );
305 case PXENV_FILE_EXEC:
306 pxenv_call.file_exec = pxenv_file_exec;
307 param_len = sizeof ( pxenv_any.file_exec );
309 case PXENV_FILE_API_CHECK:
310 pxenv_call.file_api_check = pxenv_file_api_check;
311 param_len = sizeof ( pxenv_any.file_api_check );
314 DBG ( "PXENV_UNKNOWN_%hx", opcode );
315 pxenv_call.unknown = pxenv_unknown;
316 param_len = sizeof ( pxenv_any.unknown );
320 /* Copy parameter block from caller */
321 copy_from_user ( &pxenv_any, parameters, 0, param_len );
323 /* Set default status in case child routine fails to do so */
324 pxenv_any.Status = PXENV_STATUS_FAILURE;
326 /* Hand off to relevant API routine */
328 ret = pxenv_call.any ( &pxenv_any );
329 if ( pxenv_any.Status != PXENV_STATUS_SUCCESS ) {
330 DBG ( " %02x", pxenv_any.Status );
332 if ( ret != PXENV_EXIT_SUCCESS ) {
333 DBG ( ret == PXENV_EXIT_FAILURE ? " err" : " ??" );
337 /* Copy modified parameter block back to caller and return */
338 copy_to_user ( parameters, 0, &pxenv_any, param_len );
343 * Dispatch weak PXE API call with PXE stack available
345 * @v ix86 Registers for PXE call
346 * @ret present Zero (PXE stack present)
348 int _pxe_api_call_weak ( struct i386_all_regs *ix86 )
350 pxe_api_call ( ix86 );
355 * Dispatch PXE loader call
357 * @v es:di Address of PXE parameter block
358 * @ret ax PXE exit code
360 __asmcall void pxe_loader_call ( struct i386_all_regs *ix86 ) {
361 userptr_t uparams = real_to_user ( ix86->segs.es, ix86->regs.di );
362 struct s_UNDI_LOADER params;
365 /* Copy parameter block from caller */
366 copy_from_user ( ¶ms, uparams, 0, sizeof ( params ) );
368 /* Fill in ROM segment address */
369 ppxe.UNDIROMID.segment = ix86->segs.ds;
371 /* Set default status in case child routine fails to do so */
372 params.Status = PXENV_STATUS_FAILURE;
374 /* Call UNDI loader */
375 ret = undi_loader ( ¶ms );
377 /* Copy modified parameter block back to caller and return */
378 copy_to_user ( uparams, 0, ¶ms, sizeof ( params ) );
383 * Calculate byte checksum as used by PXE
386 * @v size Length of data
389 static uint8_t pxe_checksum ( void *data, size_t size ) {
390 uint8_t *bytes = data;
400 * Initialise !PXE and PXENV+ structures
403 static void pxe_init_structures ( void ) {
404 uint32_t rm_cs_phys = ( rm_cs << 4 );
405 uint32_t rm_ds_phys = ( rm_ds << 4 );
407 /* Fill in missing segment fields */
408 ppxe.EntryPointSP.segment = rm_cs;
409 ppxe.EntryPointESP.segment = rm_cs;
410 ppxe.Stack.segment_address = rm_ds;
411 ppxe.Stack.Physical_address = rm_ds_phys;
412 ppxe.UNDIData.segment_address = rm_ds;
413 ppxe.UNDIData.Physical_address = rm_ds_phys;
414 ppxe.UNDICode.segment_address = rm_cs;
415 ppxe.UNDICode.Physical_address = rm_cs_phys;
416 ppxe.UNDICodeWrite.segment_address = rm_cs;
417 ppxe.UNDICodeWrite.Physical_address = rm_cs_phys;
418 pxenv.RMEntry.segment = rm_cs;
419 pxenv.StackSeg = rm_ds;
420 pxenv.UNDIDataSeg = rm_ds;
421 pxenv.UNDICodeSeg = rm_cs;
422 pxenv.PXEPtr.segment = rm_cs;
424 /* Update checksums */
425 ppxe.StructCksum -= pxe_checksum ( &ppxe, sizeof ( ppxe ) );
426 pxenv.Checksum -= pxe_checksum ( &pxenv, sizeof ( pxenv ) );
429 /** PXE structure initialiser */
430 struct init_fn pxe_init_fn __init_fn ( INIT_NORMAL ) = {
431 .initialise = pxe_init_structures,
437 * @v netdev Net device to use as PXE net device
439 void pxe_activate ( struct net_device *netdev ) {
441 /* Ensure INT 1A is hooked */
442 if ( ! int_1a_hooked ) {
443 hook_bios_interrupt ( 0x1a, ( unsigned int ) pxe_int_1a,
444 &pxe_int_1a_vector );
448 /* Set PXE network device */
449 pxe_set_netdev ( netdev );
453 * Deactivate PXE stack
455 * @ret rc Return status code
457 int pxe_deactivate ( void ) {
460 /* Clear PXE network device */
461 pxe_set_netdev ( NULL );
463 /* Ensure INT 1A is unhooked, if possible */
464 if ( int_1a_hooked ) {
465 if ( ( rc = unhook_bios_interrupt ( 0x1a,
466 (unsigned int) pxe_int_1a,
467 &pxe_int_1a_vector ))!= 0){
468 DBG ( "Could not unhook INT 1A: %s\n",
479 * Start PXE NBP at 0000:7c00
481 * @ret rc Return status code
483 int pxe_start_nbp ( void ) {
484 int discard_b, discard_c, discard_d, discard_D;
487 /* Far call to PXE NBP */
488 __asm__ __volatile__ ( REAL_CODE ( "movw %%cx, %%es\n\t"
492 "lcall $0, $0x7c00\n\t"
493 "addw $4, %%sp\n\t" )
494 : "=a" ( rc ), "=b" ( discard_b ),
495 "=c" ( discard_c ), "=d" ( discard_d ),
497 : "a" ( 0 ), "b" ( __from_text16 ( &pxenv ) ),
499 "d" ( virt_to_phys ( &pxenv ) ),
500 "D" ( __from_text16 ( &ppxe ) )
501 : "esi", "ebp", "memory" );