1c1b5066c17a60a7b56d86116b11038c400ede80
[people/indolent/gpxe.git/.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 };
95
96 /**
97  * Handle an unknown PXE API call
98  *
99  * @v pxenv_unknown                     Pointer to a struct s_PXENV_UNKNOWN
100  * @ret #PXENV_EXIT_FAILURE             Always
101  * @err #PXENV_STATUS_UNSUPPORTED       Always
102  */
103 static PXENV_EXIT_t pxenv_unknown ( struct s_PXENV_UNKNOWN *pxenv_unknown ) {
104         pxenv_unknown->Status = PXENV_STATUS_UNSUPPORTED;
105         return PXENV_EXIT_FAILURE;
106 }
107
108 /**
109  * Dispatch PXE API call
110  *
111  * @v bx                PXE opcode
112  * @v es:di             Address of PXE parameter block
113  * @ret ax              PXE exit code
114  */
115 __cdecl void pxe_api_call ( struct i386_all_regs *ix86 ) {
116         int opcode = ix86->regs.bx;
117         userptr_t parameters = real_to_user ( ix86->segs.es, ix86->regs.di );
118         size_t param_len;
119         union u_PXENV_ANY pxenv_any;
120         union pxenv_call pxenv_call;
121         PXENV_EXIT_t ret;
122
123         switch ( opcode ) {
124         case PXENV_UNLOAD_STACK:
125                 pxenv_call.unload_stack = pxenv_unload_stack;
126                 param_len = sizeof ( pxenv_any.unload_stack );
127                 break;
128         case PXENV_GET_CACHED_INFO:
129                 pxenv_call.get_cached_info = pxenv_get_cached_info;
130                 param_len = sizeof ( pxenv_any.get_cached_info );
131                 break;
132         case PXENV_RESTART_TFTP:
133                 pxenv_call.restart_tftp = pxenv_restart_tftp;
134                 param_len = sizeof ( pxenv_any.restart_tftp );
135                 break;
136         case PXENV_START_UNDI:
137                 pxenv_call.start_undi = pxenv_start_undi;
138                 param_len = sizeof ( pxenv_any.start_undi );
139                 break;
140         case PXENV_STOP_UNDI:
141                 pxenv_call.stop_undi = pxenv_stop_undi;
142                 param_len = sizeof ( pxenv_any.stop_undi );
143                 break;
144         case PXENV_START_BASE:
145                 pxenv_call.start_base = pxenv_start_base;
146                 param_len = sizeof ( pxenv_any.start_base );
147                 break;
148         case PXENV_STOP_BASE:
149                 pxenv_call.stop_base = pxenv_stop_base;
150                 param_len = sizeof ( pxenv_any.stop_base );
151                 break;
152         case PXENV_TFTP_OPEN:
153                 pxenv_call.tftp_open = pxenv_tftp_open;
154                 param_len = sizeof ( pxenv_any.tftp_open );
155                 break;
156         case PXENV_TFTP_CLOSE:
157                 pxenv_call.tftp_close = pxenv_tftp_close;
158                 param_len = sizeof ( pxenv_any.tftp_close );
159                 break;
160         case PXENV_TFTP_READ:
161                 pxenv_call.tftp_read = pxenv_tftp_read;
162                 param_len = sizeof ( pxenv_any.tftp_read );
163                 break;
164         case PXENV_TFTP_READ_FILE:
165                 pxenv_call.tftp_read_file = pxenv_tftp_read_file;
166                 param_len = sizeof ( pxenv_any.tftp_read_file );
167                 break;
168         case PXENV_TFTP_GET_FSIZE:
169                 pxenv_call.tftp_get_fsize = pxenv_tftp_get_fsize;
170                 param_len = sizeof ( pxenv_any.tftp_get_fsize );
171                 break;
172         case PXENV_UDP_OPEN:
173                 pxenv_call.udp_open = pxenv_udp_open;
174                 param_len = sizeof ( pxenv_any.udp_open );
175                 break;
176         case PXENV_UDP_CLOSE:
177                 pxenv_call.udp_close = pxenv_udp_close;
178                 param_len = sizeof ( pxenv_any.udp_close );
179                 break;
180         case PXENV_UDP_WRITE:
181                 pxenv_call.udp_write = pxenv_udp_write;
182                 param_len = sizeof ( pxenv_any.udp_write );
183                 break;
184         case PXENV_UDP_READ:
185                 pxenv_call.udp_read = pxenv_udp_read;
186                 param_len = sizeof ( pxenv_any.udp_read );
187                 break;
188         case PXENV_UNDI_STARTUP:
189                 pxenv_call.undi_startup = pxenv_undi_startup;
190                 param_len = sizeof ( pxenv_any.undi_startup );
191                 break;
192         case PXENV_UNDI_CLEANUP:
193                 pxenv_call.undi_cleanup = pxenv_undi_cleanup;
194                 param_len = sizeof ( pxenv_any.undi_cleanup );
195                 break;
196         case PXENV_UNDI_INITIALIZE:
197                 pxenv_call.undi_initialize = pxenv_undi_initialize;
198                 param_len = sizeof ( pxenv_any.undi_initialize );
199                 break;
200         case PXENV_UNDI_RESET_ADAPTER:
201                 pxenv_call.undi_reset_adapter = pxenv_undi_reset_adapter;
202                 param_len = sizeof ( pxenv_any.undi_reset_adapter );
203                 break;
204         case PXENV_UNDI_SHUTDOWN:
205                 pxenv_call.undi_shutdown = pxenv_undi_shutdown;
206                 param_len = sizeof ( pxenv_any.undi_shutdown );
207                 break;
208         case PXENV_UNDI_OPEN:
209                 pxenv_call.undi_open = pxenv_undi_open;
210                 param_len = sizeof ( pxenv_any.undi_open );
211                 break;
212         case PXENV_UNDI_CLOSE:
213                 pxenv_call.undi_close = pxenv_undi_close;
214                 param_len = sizeof ( pxenv_any.undi_close );
215                 break;
216         case PXENV_UNDI_TRANSMIT:
217                 pxenv_call.undi_transmit = pxenv_undi_transmit;
218                 param_len = sizeof ( pxenv_any.undi_transmit );
219                 break;
220         case PXENV_UNDI_SET_MCAST_ADDRESS:
221                 pxenv_call.undi_set_mcast_address =
222                         pxenv_undi_set_mcast_address;
223                 param_len = sizeof ( pxenv_any.undi_set_mcast_address );
224                 break;
225         case PXENV_UNDI_SET_STATION_ADDRESS:
226                 pxenv_call.undi_set_station_address =
227                         pxenv_undi_set_station_address;
228                 param_len = sizeof ( pxenv_any.undi_set_station_address );
229                 break;
230         case PXENV_UNDI_SET_PACKET_FILTER:
231                 pxenv_call.undi_set_packet_filter =
232                         pxenv_undi_set_packet_filter;
233                 param_len = sizeof ( pxenv_any.undi_set_packet_filter );
234                 break;
235         case PXENV_UNDI_GET_INFORMATION:
236                 pxenv_call.undi_get_information = pxenv_undi_get_information;
237                 param_len = sizeof ( pxenv_any.undi_get_information );
238                 break;
239         case PXENV_UNDI_GET_STATISTICS:
240                 pxenv_call.undi_get_statistics = pxenv_undi_get_statistics;
241                 param_len = sizeof ( pxenv_any.undi_get_statistics );
242                 break;
243         case PXENV_UNDI_CLEAR_STATISTICS:
244                 pxenv_call.undi_clear_statistics = pxenv_undi_clear_statistics;
245                 param_len = sizeof ( pxenv_any.undi_clear_statistics );
246                 break;
247         case PXENV_UNDI_INITIATE_DIAGS:
248                 pxenv_call.undi_initiate_diags = pxenv_undi_initiate_diags;
249                 param_len = sizeof ( pxenv_any.undi_initiate_diags );
250                 break;
251         case PXENV_UNDI_FORCE_INTERRUPT:
252                 pxenv_call.undi_force_interrupt = pxenv_undi_force_interrupt;
253                 param_len = sizeof ( pxenv_any.undi_force_interrupt );
254                 break;
255         case PXENV_UNDI_GET_MCAST_ADDRESS:
256                 pxenv_call.undi_get_mcast_address =
257                         pxenv_undi_get_mcast_address;
258                 param_len = sizeof ( pxenv_any.undi_get_mcast_address );
259                 break;
260         case PXENV_UNDI_GET_NIC_TYPE:
261                 pxenv_call.undi_get_nic_type = pxenv_undi_get_nic_type;
262                 param_len = sizeof ( pxenv_any.undi_get_nic_type );
263                 break;
264         case PXENV_UNDI_GET_IFACE_INFO:
265                 pxenv_call.undi_get_iface_info = pxenv_undi_get_iface_info;
266                 param_len = sizeof ( pxenv_any.undi_get_iface_info );
267                 break;
268         case PXENV_UNDI_ISR:
269                 pxenv_call.undi_isr = pxenv_undi_isr;
270                 param_len = sizeof ( pxenv_any.undi_isr );
271                 break;
272         default:
273                 DBG ( "PXENV_UNKNOWN_%hx", opcode );
274                 pxenv_call.unknown = pxenv_unknown;
275                 param_len = sizeof ( pxenv_any.unknown );
276                 break;
277         }
278
279         /* Copy parameter block from caller */
280         copy_from_user ( &pxenv_any, parameters, 0, param_len );
281
282         /* Set default status in case child routine fails to do so */
283         pxenv_any.Status = PXENV_STATUS_FAILURE;
284
285         /* Hand off to relevant API routine */
286         DBG ( "[" );
287         ret = pxenv_call.any ( &pxenv_any );
288         if ( pxenv_any.Status != PXENV_STATUS_SUCCESS ) {
289                 DBG ( " %02x", pxenv_any.Status );
290         }
291         if ( ret != PXENV_EXIT_SUCCESS ) {
292                 DBG ( ret == PXENV_EXIT_FAILURE ? " err" : " ??" );
293         }
294         DBG ( "]" );
295         
296         /* Copy modified parameter block back to caller and return */
297         copy_to_user ( parameters, 0, &pxenv_any, param_len );
298         ix86->regs.ax = ret;
299 }
300
301 /**
302  * Dispatch PXE loader call
303  *
304  * @v es:di             Address of PXE parameter block
305  * @ret ax              PXE exit code
306  */
307 __cdecl void pxe_loader_call ( struct i386_all_regs *ix86 ) {
308         userptr_t uparams = real_to_user ( ix86->segs.es, ix86->regs.di );
309         struct s_UNDI_LOADER params;
310         PXENV_EXIT_t ret;
311
312         /* Copy parameter block from caller */
313         copy_from_user ( &params, uparams, 0, sizeof ( params ) );
314
315         /* Set default status in case child routine fails to do so */
316         params.Status = PXENV_STATUS_FAILURE;
317
318         /* Call UNDI loader */
319         ret = undi_loader ( &params );
320
321         /* Copy modified parameter block back to caller and return */
322         copy_to_user ( uparams, 0, &params, sizeof ( params ) );
323         ix86->regs.ax = ret;
324 }
325
326 /**
327  * Hook INT 1A for PXE
328  *
329  */
330 void pxe_hook_int1a ( void ) {
331         hook_bios_interrupt ( 0x1a, ( unsigned int ) pxe_int_1a,
332                               &pxe_int_1a_vector );
333 }
334
335 /**
336  * Unhook INT 1A for PXE
337  *
338  * @ret rc              Return status code
339  */
340 int pxe_unhook_int1a ( void ) {
341         return unhook_bios_interrupt ( 0x1a, ( unsigned int ) pxe_int_1a,
342                                        &pxe_int_1a_vector );
343 }
344
345 /**
346  * Calculate byte checksum as used by PXE
347  *
348  * @v data              Data
349  * @v size              Length of data
350  * @ret sum             Checksum
351  */
352 static uint8_t pxe_checksum ( void *data, size_t size ) {
353         uint8_t *bytes = data;
354         uint8_t sum = 0;
355
356         while ( size-- ) {
357                 sum += *bytes++;
358         }
359         return sum;
360 }
361
362 /**
363  * Initialise !PXE and PXENV+ structures
364  *
365  */
366 void pxe_init_structures ( void ) {
367         uint32_t rm_cs_phys = ( rm_cs << 4 );
368         uint32_t rm_ds_phys = ( rm_ds << 4 );
369
370         /* Fill in missing segment fields */
371         ppxe.EntryPointSP.segment = rm_cs;
372         ppxe.EntryPointESP.segment = rm_cs;
373         ppxe.Stack.segment_address = rm_ds;
374         ppxe.Stack.Physical_address = rm_ds_phys;
375         ppxe.UNDIData.segment_address = rm_ds;
376         ppxe.UNDIData.Physical_address = rm_ds_phys;
377         ppxe.UNDICode.segment_address = rm_cs;
378         ppxe.UNDICode.Physical_address = rm_cs_phys;
379         ppxe.UNDICodeWrite.segment_address = rm_cs;
380         ppxe.UNDICodeWrite.Physical_address = rm_cs_phys;
381         pxenv.RMEntry.segment = rm_cs;
382         pxenv.StackSeg = rm_ds;
383         pxenv.UNDIDataSeg = rm_ds;
384         pxenv.UNDICodeSeg = rm_cs;
385         pxenv.PXEPtr.segment = rm_cs;
386
387         /* Update checksums */
388         ppxe.StructCksum -= pxe_checksum ( &ppxe, sizeof ( ppxe ) );
389         pxenv.Checksum -= pxe_checksum ( &pxenv, sizeof ( pxenv ) );
390 }
391
392 /**
393  * Start PXE NBP at 0000:7c00
394  *
395  * @ret rc              Return status code
396  */
397 int pxe_start_nbp ( void ) {
398         int discard_b, discard_c;
399         uint16_t rc;
400
401         /* Far call to PXE NBP */
402         __asm__ __volatile__ ( REAL_CODE ( "pushw %%cx\n\t"
403                                            "pushw %%ax\n\t"
404                                            "movw %%cx, %%es\n\t"
405                                            "lcall $0, $0x7c00\n\t"
406                                            "addw $4, %%sp\n\t" )
407                                : "=a" ( rc ), "=b" ( discard_b ),
408                                  "=c" ( discard_c )
409                                :  "a" ( & __from_text16 ( ppxe ) ),
410                                   "b" ( & __from_text16 ( pxenv ) ),
411                                   "c" ( rm_cs )
412                                : "edx", "esi", "edi", "ebp", "memory" );
413
414         return rc;
415 }