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         PXENV_EXIT_t ( * file_api_check ) ( struct s_PXENV_FILE_API_CHECK * );
 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 __asmcall 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         case PXENV_FILE_OPEN:
 280                 pxenv_call.file_open = pxenv_file_open;
 281                 param_len = sizeof ( pxenv_any.file_open );
 282                 break;
 283         case PXENV_FILE_CLOSE:
 284                 pxenv_call.file_close = pxenv_file_close;
 285                 param_len = sizeof ( pxenv_any.file_close );
 286                 break;
 287         case PXENV_FILE_SELECT:
 288                 pxenv_call.file_select = pxenv_file_select;
 289                 param_len = sizeof ( pxenv_any.file_select );
 290                 break;
 291         case PXENV_FILE_READ:
 292                 pxenv_call.file_read = pxenv_file_read;
 293                 param_len = sizeof ( pxenv_any.file_read );
 294                 break;
 295         case PXENV_GET_FILE_SIZE:
 296                 pxenv_call.get_file_size = pxenv_get_file_size;
 297                 param_len = sizeof ( pxenv_any.get_file_size );
 298                 break;
 299         case PXENV_FILE_EXEC:
 300                 pxenv_call.file_exec = pxenv_file_exec;
 301                 param_len = sizeof ( pxenv_any.file_exec );
 302                 break;
 303         case PXENV_FILE_API_CHECK:
 304                 pxenv_call.file_api_check = pxenv_file_api_check;
 305                 param_len = sizeof ( pxenv_any.file_api_check );
 306                 break;
 307         default:
 308                 DBG ( "PXENV_UNKNOWN_%hx", opcode );
 309                 pxenv_call.unknown = pxenv_unknown;
 310                 param_len = sizeof ( pxenv_any.unknown );
 311                 break;
 312         }
 313
 314         /* Copy parameter block from caller */
 315         copy_from_user ( &pxenv_any, parameters, 0, param_len );
 316
 317         /* Set default status in case child routine fails to do so */
 318         pxenv_any.Status = PXENV_STATUS_FAILURE;
 319
 320         /* Hand off to relevant API routine */
 321         DBG ( "[" );
 322         ret = pxenv_call.any ( &pxenv_any );
 323         if ( pxenv_any.Status != PXENV_STATUS_SUCCESS ) {
 324                 DBG ( " %02x", pxenv_any.Status );
 325         }
 326         if ( ret != PXENV_EXIT_SUCCESS ) {
 327                 DBG ( ret == PXENV_EXIT_FAILURE ? " err" : " ??" );
 328         }
 329         DBG ( "]" );
 330
 331         /* Copy modified parameter block back to caller and return */
 332         copy_to_user ( parameters, 0, &pxenv_any, param_len );
 333         ix86->regs.ax = ret;
 334 }
 335
 336 /**
 337  * Dispatch PXE loader call
 338  *
 339  * @v es:di             Address of PXE parameter block
 340  * @ret ax              PXE exit code
 341  */
 342 __asmcall void pxe_loader_call ( struct i386_all_regs *ix86 ) {
 343         userptr_t uparams = real_to_user ( ix86->segs.es, ix86->regs.di );
 344         struct s_UNDI_LOADER params;
 345         PXENV_EXIT_t ret;
 346
 347         /* Copy parameter block from caller */
 348         copy_from_user ( &params, uparams, 0, sizeof ( params ) );
 349
 350         /* Fill in ROM segment address */
 351         ppxe.UNDIROMID.segment = ix86->segs.ds;
 352
 353         /* Set default status in case child routine fails to do so */
 354         params.Status = PXENV_STATUS_FAILURE;
 355
 356         /* Call UNDI loader */
 357         ret = undi_loader ( &params );
 358
 359         /* Copy modified parameter block back to caller and return */
 360         copy_to_user ( uparams, 0, &params, sizeof ( params ) );
 361         ix86->regs.ax = ret;
 362 }
 363
 364 /**
 365  * Hook INT 1A for PXE
 366  *
 367  */
 368 void pxe_hook_int1a ( void ) {
 369         hook_bios_interrupt ( 0x1a, ( unsigned int ) pxe_int_1a,
 370                               &pxe_int_1a_vector );
 371 }
 372
 373 /**
 374  * Unhook INT 1A for PXE
 375  *
 376  * @ret rc              Return status code
 377  */
 378 int pxe_unhook_int1a ( void ) {
 379         return unhook_bios_interrupt ( 0x1a, ( unsigned int ) pxe_int_1a,
 380                                        &pxe_int_1a_vector );
 381 }
 382
 383 /**
 384  * Calculate byte checksum as used by PXE
 385  *
 386  * @v data              Data
 387  * @v size              Length of data
 388  * @ret sum             Checksum
 389  */
 390 static uint8_t pxe_checksum ( void *data, size_t size ) {
 391         uint8_t *bytes = data;
 392         uint8_t sum = 0;
 393
 394         while ( size-- ) {
 395                 sum += *bytes++;
 396         }
 397         return sum;
 398 }
 399
 400 /**
 401  * Initialise !PXE and PXENV+ structures
 402  *
 403  */
 404 void pxe_init_structures ( void ) {
 405         uint32_t rm_cs_phys = ( rm_cs << 4 );
 406         uint32_t rm_ds_phys = ( rm_ds << 4 );
 407
 408         /* Fill in missing segment fields */
 409         ppxe.EntryPointSP.segment = rm_cs;
 410         ppxe.EntryPointESP.segment = rm_cs;
 411         ppxe.Stack.segment_address = rm_ds;
 412         ppxe.Stack.Physical_address = rm_ds_phys;
 413         ppxe.UNDIData.segment_address = rm_ds;
 414         ppxe.UNDIData.Physical_address = rm_ds_phys;
 415         ppxe.UNDICode.segment_address = rm_cs;
 416         ppxe.UNDICode.Physical_address = rm_cs_phys;
 417         ppxe.UNDICodeWrite.segment_address = rm_cs;
 418         ppxe.UNDICodeWrite.Physical_address = rm_cs_phys;
 419         pxenv.RMEntry.segment = rm_cs;
 420         pxenv.StackSeg = rm_ds;
 421         pxenv.UNDIDataSeg = rm_ds;
 422         pxenv.UNDICodeSeg = rm_cs;
 423         pxenv.PXEPtr.segment = rm_cs;
 424
 425         /* Update checksums */
 426         ppxe.StructCksum -= pxe_checksum ( &ppxe, sizeof ( ppxe ) );
 427         pxenv.Checksum -= pxe_checksum ( &pxenv, sizeof ( pxenv ) );
 428 }
 429
 430 /**
 431  * Start PXE NBP at 0000:7c00
 432  *
 433  * @ret rc              Return status code
 434  */
 435 int pxe_start_nbp ( void ) {
 436         int discard_b, discard_c, discard_d, discard_D;
 437         uint16_t rc;
 438
 439         /* Far call to PXE NBP */
 440         __asm__ __volatile__ ( REAL_CODE ( "movw %%cx, %%es\n\t"
 441                                            "pushw %%es\n\t"
 442                                            "pushw %%di\n\t"
 443                                            "sti\n\t"
 444                                            "lcall $0, $0x7c00\n\t"
 445                                            "addw $4, %%sp\n\t" )
 446                                : "=a" ( rc ), "=b" ( discard_b ),
 447                                  "=c" ( discard_c ), "=d" ( discard_d ),
 448                                  "=D" ( discard_D )
 449                                : "a" ( 0 ), "b" ( __from_text16 ( &pxenv ) ),
 450                                  "c" ( rm_cs ),
 451                                  "d" ( virt_to_phys ( &pxenv ) ),
 452                                  "D" ( __from_text16 ( &ppxe ) )
 453                                : "esi", "ebp", "memory" );
 454
 455         return rc;
 456 }