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