[PXEXT] Add PXENV_FILE_EXEC call to PXE extensions API.
[people/mcb30/gpxe.git] / src / arch / i386 / interface / pxe / pxe_call.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
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.
8  *
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.
13  *
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.
17  */
18
19 #include <gpxe/uaccess.h>
20 #include <registers.h>
21 #include <biosint.h>
22 #include <pxe.h>
23 #include <pxe_call.h>
24
25 /** @file
26  *
27  * PXE API entry point
28  */
29
30 /** Vector for chaining INT 1A */
31 extern struct segoff __text16 ( pxe_int_1a_vector );
32 #define pxe_int_1a_vector __use_text16 ( pxe_int_1a_vector )
33
34 /** INT 1A handler */
35 extern void pxe_int_1a ( void );
36
37 /** A function pointer to hold any PXE API call
38  *
39  * Used by pxe_api_call() to avoid large swathes of duplicated code.
40  */
41 union pxenv_call {
42         PXENV_EXIT_t ( * any ) ( union u_PXENV_ANY * );
43         PXENV_EXIT_t ( * unknown ) ( struct s_PXENV_UNKNOWN * );
44         PXENV_EXIT_t ( * unload_stack ) ( struct s_PXENV_UNLOAD_STACK * );
45         PXENV_EXIT_t ( * get_cached_info )
46                         ( struct s_PXENV_GET_CACHED_INFO * );
47         PXENV_EXIT_t ( * restart_tftp ) ( struct s_PXENV_TFTP_READ_FILE * );
48         PXENV_EXIT_t ( * start_undi ) ( struct s_PXENV_START_UNDI * );
49         PXENV_EXIT_t ( * stop_undi ) ( struct s_PXENV_STOP_UNDI * );
50         PXENV_EXIT_t ( * start_base ) ( struct s_PXENV_START_BASE * );
51         PXENV_EXIT_t ( * stop_base ) ( struct s_PXENV_STOP_BASE * );
52         PXENV_EXIT_t ( * tftp_open ) ( struct s_PXENV_TFTP_OPEN * );
53         PXENV_EXIT_t ( * tftp_close ) ( struct s_PXENV_TFTP_CLOSE * );
54         PXENV_EXIT_t ( * tftp_read ) ( struct s_PXENV_TFTP_READ * );
55         PXENV_EXIT_t ( * tftp_read_file ) ( struct s_PXENV_TFTP_READ_FILE * );
56         PXENV_EXIT_t ( * tftp_get_fsize ) ( struct s_PXENV_TFTP_GET_FSIZE * );
57         PXENV_EXIT_t ( * udp_open ) ( struct s_PXENV_UDP_OPEN * );
58         PXENV_EXIT_t ( * udp_close ) ( struct s_PXENV_UDP_CLOSE * );
59         PXENV_EXIT_t ( * udp_write ) ( struct s_PXENV_UDP_WRITE * );
60         PXENV_EXIT_t ( * udp_read ) ( struct s_PXENV_UDP_READ * );
61         PXENV_EXIT_t ( * undi_startup ) ( struct s_PXENV_UNDI_STARTUP * );
62         PXENV_EXIT_t ( * undi_cleanup ) ( struct s_PXENV_UNDI_CLEANUP * );
63         PXENV_EXIT_t ( * undi_initialize )
64                         ( struct s_PXENV_UNDI_INITIALIZE * );
65         PXENV_EXIT_t ( * undi_reset_adapter ) ( struct s_PXENV_UNDI_RESET * );
66         PXENV_EXIT_t ( * undi_shutdown ) ( struct s_PXENV_UNDI_SHUTDOWN * );
67         PXENV_EXIT_t ( * undi_open ) ( struct s_PXENV_UNDI_OPEN * );
68         PXENV_EXIT_t ( * undi_close ) ( struct s_PXENV_UNDI_CLOSE * );
69         PXENV_EXIT_t ( * undi_transmit ) ( struct s_PXENV_UNDI_TRANSMIT * );
70         PXENV_EXIT_t ( * undi_set_mcast_address )
71                         ( struct s_PXENV_UNDI_SET_MCAST_ADDRESS * );
72         PXENV_EXIT_t ( * undi_set_station_address )
73                         ( struct s_PXENV_UNDI_SET_STATION_ADDRESS * );
74         PXENV_EXIT_t ( * undi_set_packet_filter )
75                         ( struct s_PXENV_UNDI_SET_PACKET_FILTER * );
76         PXENV_EXIT_t ( * undi_get_information )
77                         ( struct s_PXENV_UNDI_GET_INFORMATION * );
78         PXENV_EXIT_t ( * undi_get_statistics )
79                         ( struct s_PXENV_UNDI_GET_STATISTICS * );
80         PXENV_EXIT_t ( * undi_clear_statistics )
81                         ( struct s_PXENV_UNDI_CLEAR_STATISTICS * );
82         PXENV_EXIT_t ( * undi_initiate_diags )
83                         ( struct s_PXENV_UNDI_INITIATE_DIAGS * );
84         PXENV_EXIT_t ( * undi_force_interrupt )
85                         ( struct s_PXENV_UNDI_FORCE_INTERRUPT * );
86         PXENV_EXIT_t ( * undi_get_mcast_address )
87                         ( struct s_PXENV_UNDI_GET_MCAST_ADDRESS * );
88         PXENV_EXIT_t ( * undi_get_nic_type )
89                         ( struct s_PXENV_UNDI_GET_NIC_TYPE * );
90         PXENV_EXIT_t ( * undi_get_iface_info )
91                         ( struct s_PXENV_UNDI_GET_IFACE_INFO * );
92         PXENV_EXIT_t ( * undi_get_state ) ( struct s_PXENV_UNDI_GET_STATE * );
93         PXENV_EXIT_t ( * undi_isr ) ( struct s_PXENV_UNDI_ISR * );
94         PXENV_EXIT_t ( * file_open ) ( struct s_PXENV_FILE_OPEN * );
95         PXENV_EXIT_t ( * file_close ) ( struct s_PXENV_FILE_CLOSE * );
96         PXENV_EXIT_t ( * file_select ) ( struct s_PXENV_FILE_SELECT * );
97         PXENV_EXIT_t ( * file_read ) ( struct s_PXENV_FILE_READ * );
98         PXENV_EXIT_t ( * get_file_size ) ( struct s_PXENV_GET_FILE_SIZE * );
99         PXENV_EXIT_t ( * file_exec ) ( struct s_PXENV_FILE_EXEC * );
100 };
101
102 /**
103  * Handle an unknown PXE API call
104  *
105  * @v pxenv_unknown                     Pointer to a struct s_PXENV_UNKNOWN
106  * @ret #PXENV_EXIT_FAILURE             Always
107  * @err #PXENV_STATUS_UNSUPPORTED       Always
108  */
109 static PXENV_EXIT_t pxenv_unknown ( struct s_PXENV_UNKNOWN *pxenv_unknown ) {
110         pxenv_unknown->Status = PXENV_STATUS_UNSUPPORTED;
111         return PXENV_EXIT_FAILURE;
112 }
113
114 /**
115  * Dispatch PXE API call
116  *
117  * @v bx                PXE opcode
118  * @v es:di             Address of PXE parameter block
119  * @ret ax              PXE exit code
120  */
121 __cdecl void pxe_api_call ( struct i386_all_regs *ix86 ) {
122         int opcode = ix86->regs.bx;
123         userptr_t parameters = real_to_user ( ix86->segs.es, ix86->regs.di );
124         size_t param_len;
125         union u_PXENV_ANY pxenv_any;
126         union pxenv_call pxenv_call;
127         PXENV_EXIT_t ret;
128
129         switch ( opcode ) {
130         case PXENV_UNLOAD_STACK:
131                 pxenv_call.unload_stack = pxenv_unload_stack;
132                 param_len = sizeof ( pxenv_any.unload_stack );
133                 break;
134         case PXENV_GET_CACHED_INFO:
135                 pxenv_call.get_cached_info = pxenv_get_cached_info;
136                 param_len = sizeof ( pxenv_any.get_cached_info );
137                 break;
138         case PXENV_RESTART_TFTP:
139                 pxenv_call.restart_tftp = pxenv_restart_tftp;
140                 param_len = sizeof ( pxenv_any.restart_tftp );
141                 break;
142         case PXENV_START_UNDI:
143                 pxenv_call.start_undi = pxenv_start_undi;
144                 param_len = sizeof ( pxenv_any.start_undi );
145                 break;
146         case PXENV_STOP_UNDI:
147                 pxenv_call.stop_undi = pxenv_stop_undi;
148                 param_len = sizeof ( pxenv_any.stop_undi );
149                 break;
150         case PXENV_START_BASE:
151                 pxenv_call.start_base = pxenv_start_base;
152                 param_len = sizeof ( pxenv_any.start_base );
153                 break;
154         case PXENV_STOP_BASE:
155                 pxenv_call.stop_base = pxenv_stop_base;
156                 param_len = sizeof ( pxenv_any.stop_base );
157                 break;
158         case PXENV_TFTP_OPEN:
159                 pxenv_call.tftp_open = pxenv_tftp_open;
160                 param_len = sizeof ( pxenv_any.tftp_open );
161                 break;
162         case PXENV_TFTP_CLOSE:
163                 pxenv_call.tftp_close = pxenv_tftp_close;
164                 param_len = sizeof ( pxenv_any.tftp_close );
165                 break;
166         case PXENV_TFTP_READ:
167                 pxenv_call.tftp_read = pxenv_tftp_read;
168                 param_len = sizeof ( pxenv_any.tftp_read );
169                 break;
170         case PXENV_TFTP_READ_FILE:
171                 pxenv_call.tftp_read_file = pxenv_tftp_read_file;
172                 param_len = sizeof ( pxenv_any.tftp_read_file );
173                 break;
174         case PXENV_TFTP_GET_FSIZE:
175                 pxenv_call.tftp_get_fsize = pxenv_tftp_get_fsize;
176                 param_len = sizeof ( pxenv_any.tftp_get_fsize );
177                 break;
178         case PXENV_UDP_OPEN:
179                 pxenv_call.udp_open = pxenv_udp_open;
180                 param_len = sizeof ( pxenv_any.udp_open );
181                 break;
182         case PXENV_UDP_CLOSE:
183                 pxenv_call.udp_close = pxenv_udp_close;
184                 param_len = sizeof ( pxenv_any.udp_close );
185                 break;
186         case PXENV_UDP_WRITE:
187                 pxenv_call.udp_write = pxenv_udp_write;
188                 param_len = sizeof ( pxenv_any.udp_write );
189                 break;
190         case PXENV_UDP_READ:
191                 pxenv_call.udp_read = pxenv_udp_read;
192                 param_len = sizeof ( pxenv_any.udp_read );
193                 break;
194         case PXENV_UNDI_STARTUP:
195                 pxenv_call.undi_startup = pxenv_undi_startup;
196                 param_len = sizeof ( pxenv_any.undi_startup );
197                 break;
198         case PXENV_UNDI_CLEANUP:
199                 pxenv_call.undi_cleanup = pxenv_undi_cleanup;
200                 param_len = sizeof ( pxenv_any.undi_cleanup );
201                 break;
202         case PXENV_UNDI_INITIALIZE:
203                 pxenv_call.undi_initialize = pxenv_undi_initialize;
204                 param_len = sizeof ( pxenv_any.undi_initialize );
205                 break;
206         case PXENV_UNDI_RESET_ADAPTER:
207                 pxenv_call.undi_reset_adapter = pxenv_undi_reset_adapter;
208                 param_len = sizeof ( pxenv_any.undi_reset_adapter );
209                 break;
210         case PXENV_UNDI_SHUTDOWN:
211                 pxenv_call.undi_shutdown = pxenv_undi_shutdown;
212                 param_len = sizeof ( pxenv_any.undi_shutdown );
213                 break;
214         case PXENV_UNDI_OPEN:
215                 pxenv_call.undi_open = pxenv_undi_open;
216                 param_len = sizeof ( pxenv_any.undi_open );
217                 break;
218         case PXENV_UNDI_CLOSE:
219                 pxenv_call.undi_close = pxenv_undi_close;
220                 param_len = sizeof ( pxenv_any.undi_close );
221                 break;
222         case PXENV_UNDI_TRANSMIT:
223                 pxenv_call.undi_transmit = pxenv_undi_transmit;
224                 param_len = sizeof ( pxenv_any.undi_transmit );
225                 break;
226         case PXENV_UNDI_SET_MCAST_ADDRESS:
227                 pxenv_call.undi_set_mcast_address =
228                         pxenv_undi_set_mcast_address;
229                 param_len = sizeof ( pxenv_any.undi_set_mcast_address );
230                 break;
231         case PXENV_UNDI_SET_STATION_ADDRESS:
232                 pxenv_call.undi_set_station_address =
233                         pxenv_undi_set_station_address;
234                 param_len = sizeof ( pxenv_any.undi_set_station_address );
235                 break;
236         case PXENV_UNDI_SET_PACKET_FILTER:
237                 pxenv_call.undi_set_packet_filter =
238                         pxenv_undi_set_packet_filter;
239                 param_len = sizeof ( pxenv_any.undi_set_packet_filter );
240                 break;
241         case PXENV_UNDI_GET_INFORMATION:
242                 pxenv_call.undi_get_information = pxenv_undi_get_information;
243                 param_len = sizeof ( pxenv_any.undi_get_information );
244                 break;
245         case PXENV_UNDI_GET_STATISTICS:
246                 pxenv_call.undi_get_statistics = pxenv_undi_get_statistics;
247                 param_len = sizeof ( pxenv_any.undi_get_statistics );
248                 break;
249         case PXENV_UNDI_CLEAR_STATISTICS:
250                 pxenv_call.undi_clear_statistics = pxenv_undi_clear_statistics;
251                 param_len = sizeof ( pxenv_any.undi_clear_statistics );
252                 break;
253         case PXENV_UNDI_INITIATE_DIAGS:
254                 pxenv_call.undi_initiate_diags = pxenv_undi_initiate_diags;
255                 param_len = sizeof ( pxenv_any.undi_initiate_diags );
256                 break;
257         case PXENV_UNDI_FORCE_INTERRUPT:
258                 pxenv_call.undi_force_interrupt = pxenv_undi_force_interrupt;
259                 param_len = sizeof ( pxenv_any.undi_force_interrupt );
260                 break;
261         case PXENV_UNDI_GET_MCAST_ADDRESS:
262                 pxenv_call.undi_get_mcast_address =
263                         pxenv_undi_get_mcast_address;
264                 param_len = sizeof ( pxenv_any.undi_get_mcast_address );
265                 break;
266         case PXENV_UNDI_GET_NIC_TYPE:
267                 pxenv_call.undi_get_nic_type = pxenv_undi_get_nic_type;
268                 param_len = sizeof ( pxenv_any.undi_get_nic_type );
269                 break;
270         case PXENV_UNDI_GET_IFACE_INFO:
271                 pxenv_call.undi_get_iface_info = pxenv_undi_get_iface_info;
272                 param_len = sizeof ( pxenv_any.undi_get_iface_info );
273                 break;
274         case PXENV_UNDI_ISR:
275                 pxenv_call.undi_isr = pxenv_undi_isr;
276                 param_len = sizeof ( pxenv_any.undi_isr );
277                 break;
278         case PXENV_FILE_OPEN:
279                 pxenv_call.file_open = pxenv_file_open;
280                 param_len = sizeof ( pxenv_any.file_open );
281                 break;
282         case PXENV_FILE_CLOSE:
283                 pxenv_call.file_close = pxenv_file_close;
284                 param_len = sizeof ( pxenv_any.file_close );
285                 break;
286         case PXENV_FILE_SELECT:
287                 pxenv_call.file_select = pxenv_file_select;
288                 param_len = sizeof ( pxenv_any.file_select );
289                 break;
290         case PXENV_FILE_READ:
291                 pxenv_call.file_read = pxenv_file_read;
292                 param_len = sizeof ( pxenv_any.file_read );
293                 break;
294         case PXENV_GET_FILE_SIZE:
295                 pxenv_call.get_file_size = pxenv_get_file_size;
296                 param_len = sizeof ( pxenv_any.get_file_size );
297                 break;
298         case PXENV_FILE_EXEC:
299                 pxenv_call.file_exec = pxenv_file_exec;
300                 param_len = sizeof ( pxenv_any.file_exec );
301                 break;
302         default:
303                 DBG ( "PXENV_UNKNOWN_%hx", opcode );
304                 pxenv_call.unknown = pxenv_unknown;
305                 param_len = sizeof ( pxenv_any.unknown );
306                 break;
307         }
308
309         /* Copy parameter block from caller */
310         copy_from_user ( &pxenv_any, parameters, 0, param_len );
311
312         /* Set default status in case child routine fails to do so */
313         pxenv_any.Status = PXENV_STATUS_FAILURE;
314
315         /* Hand off to relevant API routine */
316         DBG ( "[" );
317         ret = pxenv_call.any ( &pxenv_any );
318         if ( pxenv_any.Status != PXENV_STATUS_SUCCESS ) {
319                 DBG ( " %02x", pxenv_any.Status );
320         }
321         if ( ret != PXENV_EXIT_SUCCESS ) {
322                 DBG ( ret == PXENV_EXIT_FAILURE ? " err" : " ??" );
323         }
324         DBG ( "]" );
325         
326         /* Copy modified parameter block back to caller and return */
327         copy_to_user ( parameters, 0, &pxenv_any, param_len );
328         ix86->regs.ax = ret;
329 }
330
331 /**
332  * Dispatch PXE loader call
333  *
334  * @v es:di             Address of PXE parameter block
335  * @ret ax              PXE exit code
336  */
337 __cdecl void pxe_loader_call ( struct i386_all_regs *ix86 ) {
338         userptr_t uparams = real_to_user ( ix86->segs.es, ix86->regs.di );
339         struct s_UNDI_LOADER params;
340         PXENV_EXIT_t ret;
341
342         /* Copy parameter block from caller */
343         copy_from_user ( &params, uparams, 0, sizeof ( params ) );
344
345         /* Set default status in case child routine fails to do so */
346         params.Status = PXENV_STATUS_FAILURE;
347
348         /* Call UNDI loader */
349         ret = undi_loader ( &params );
350
351         /* Copy modified parameter block back to caller and return */
352         copy_to_user ( uparams, 0, &params, sizeof ( params ) );
353         ix86->regs.ax = ret;
354 }
355
356 /**
357  * Hook INT 1A for PXE
358  *
359  */
360 void pxe_hook_int1a ( void ) {
361         hook_bios_interrupt ( 0x1a, ( unsigned int ) pxe_int_1a,
362                               &pxe_int_1a_vector );
363 }
364
365 /**
366  * Unhook INT 1A for PXE
367  *
368  * @ret rc              Return status code
369  */
370 int pxe_unhook_int1a ( void ) {
371         return unhook_bios_interrupt ( 0x1a, ( unsigned int ) pxe_int_1a,
372                                        &pxe_int_1a_vector );
373 }
374
375 /**
376  * Calculate byte checksum as used by PXE
377  *
378  * @v data              Data
379  * @v size              Length of data
380  * @ret sum             Checksum
381  */
382 static uint8_t pxe_checksum ( void *data, size_t size ) {
383         uint8_t *bytes = data;
384         uint8_t sum = 0;
385
386         while ( size-- ) {
387                 sum += *bytes++;
388         }
389         return sum;
390 }
391
392 /**
393  * Initialise !PXE and PXENV+ structures
394  *
395  */
396 void pxe_init_structures ( void ) {
397         uint32_t rm_cs_phys = ( rm_cs << 4 );
398         uint32_t rm_ds_phys = ( rm_ds << 4 );
399
400         /* Fill in missing segment fields */
401         ppxe.EntryPointSP.segment = rm_cs;
402         ppxe.EntryPointESP.segment = rm_cs;
403         ppxe.Stack.segment_address = rm_ds;
404         ppxe.Stack.Physical_address = rm_ds_phys;
405         ppxe.UNDIData.segment_address = rm_ds;
406         ppxe.UNDIData.Physical_address = rm_ds_phys;
407         ppxe.UNDICode.segment_address = rm_cs;
408         ppxe.UNDICode.Physical_address = rm_cs_phys;
409         ppxe.UNDICodeWrite.segment_address = rm_cs;
410         ppxe.UNDICodeWrite.Physical_address = rm_cs_phys;
411         pxenv.RMEntry.segment = rm_cs;
412         pxenv.StackSeg = rm_ds;
413         pxenv.UNDIDataSeg = rm_ds;
414         pxenv.UNDICodeSeg = rm_cs;
415         pxenv.PXEPtr.segment = rm_cs;
416
417         /* Update checksums */
418         ppxe.StructCksum -= pxe_checksum ( &ppxe, sizeof ( ppxe ) );
419         pxenv.Checksum -= pxe_checksum ( &pxenv, sizeof ( pxenv ) );
420 }
421
422 /**
423  * Start PXE NBP at 0000:7c00
424  *
425  * @ret rc              Return status code
426  */
427 int pxe_start_nbp ( void ) {
428         int discard_b, discard_c;
429         uint16_t rc;
430
431         /* Far call to PXE NBP */
432         __asm__ __volatile__ ( REAL_CODE ( "pushw %%cx\n\t"
433                                            "pushw %%ax\n\t"
434                                            "movw %%cx, %%es\n\t"
435                                            "lcall $0, $0x7c00\n\t"
436                                            "addw $4, %%sp\n\t" )
437                                : "=a" ( rc ), "=b" ( discard_b ),
438                                  "=c" ( discard_c )
439                                :  "a" ( & __from_text16 ( ppxe ) ),
440                                   "b" ( & __from_text16 ( pxenv ) ),
441                                   "c" ( rm_cs )
442                                : "edx", "esi", "edi", "ebp", "memory" );
443
444         return rc;
445 }