src/include/pxe.h

   1 #ifndef PXE_H
   2 #define PXE_H
   3
   4 #include "pxe_types.h"
   5 #include "pxe_api.h"
   6 #include <gpxe/device.h>
   7
   8 /* Parameter block for pxenv_unknown() */
   9 struct s_PXENV_UNKNOWN {
  10         PXENV_STATUS_t Status;                  /**< PXE status code */
  11 } PACKED;
  12
  13 typedef struct s_PXENV_UNKNOWN PXENV_UNKNOWN_t;
  14
  15 /* Union used for PXE API calls; we don't know the type of the
  16  * structure until we interpret the opcode.  Also, Status is available
  17  * in the same location for any opcode, and it's convenient to have
  18  * non-specific access to it.
  19  */
  20 union u_PXENV_ANY {
  21         /* Make it easy to read status for any operation */
  22         PXENV_STATUS_t                          Status;
  23         struct s_PXENV_UNKNOWN                  unknown;
  24         struct s_PXENV_UNLOAD_STACK             unload_stack;
  25         struct s_PXENV_GET_CACHED_INFO          get_cached_info;
  26         struct s_PXENV_TFTP_READ_FILE           restart_tftp;
  27         struct s_PXENV_START_UNDI               start_undi;
  28         struct s_PXENV_STOP_UNDI                stop_undi;
  29         struct s_PXENV_START_BASE               start_base;
  30         struct s_PXENV_STOP_BASE                stop_base;
  31         struct s_PXENV_TFTP_OPEN                tftp_open;
  32         struct s_PXENV_TFTP_CLOSE               tftp_close;
  33         struct s_PXENV_TFTP_READ                tftp_read;
  34         struct s_PXENV_TFTP_READ_FILE           tftp_read_file;
  35         struct s_PXENV_TFTP_GET_FSIZE           tftp_get_fsize;
  36         struct s_PXENV_UDP_OPEN                 udp_open;
  37         struct s_PXENV_UDP_CLOSE                udp_close;
  38         struct s_PXENV_UDP_WRITE                udp_write;
  39         struct s_PXENV_UDP_READ                 udp_read;
  40         struct s_PXENV_UNDI_STARTUP             undi_startup;
  41         struct s_PXENV_UNDI_CLEANUP             undi_cleanup;
  42         struct s_PXENV_UNDI_INITIALIZE          undi_initialize;
  43         struct s_PXENV_UNDI_RESET               undi_reset_adapter;
  44         struct s_PXENV_UNDI_SHUTDOWN            undi_shutdown;
  45         struct s_PXENV_UNDI_OPEN                undi_open;
  46         struct s_PXENV_UNDI_CLOSE               undi_close;
  47         struct s_PXENV_UNDI_TRANSMIT            undi_transmit;
  48         struct s_PXENV_UNDI_SET_MCAST_ADDRESS   undi_set_mcast_address;
  49         struct s_PXENV_UNDI_SET_STATION_ADDRESS undi_set_station_address;
  50         struct s_PXENV_UNDI_SET_PACKET_FILTER   undi_set_packet_filter;
  51         struct s_PXENV_UNDI_GET_INFORMATION     undi_get_information;
  52         struct s_PXENV_UNDI_GET_STATISTICS      undi_get_statistics;
  53         struct s_PXENV_UNDI_CLEAR_STATISTICS    undi_clear_statistics;
  54         struct s_PXENV_UNDI_INITIATE_DIAGS      undi_initiate_diags;
  55         struct s_PXENV_UNDI_FORCE_INTERRUPT     undi_force_interrupt;
  56         struct s_PXENV_UNDI_GET_MCAST_ADDRESS   undi_get_mcast_address;
  57         struct s_PXENV_UNDI_GET_NIC_TYPE        undi_get_nic_type;
  58         struct s_PXENV_UNDI_GET_IFACE_INFO      undi_get_iface_info;
  59         struct s_PXENV_UNDI_GET_STATE           undi_get_state;
  60         struct s_PXENV_UNDI_ISR                 undi_isr;
  61         struct s_PXENV_FILE_OPEN                file_open;
  62         struct s_PXENV_FILE_CLOSE               file_close;
  63         struct s_PXENV_FILE_SELECT              file_select;
  64         struct s_PXENV_FILE_READ                file_read;
  65         struct s_PXENV_GET_FILE_SIZE            get_file_size;
  66         struct s_PXENV_FILE_EXEC                file_exec;
  67 };
  68
  69 typedef union u_PXENV_ANY PXENV_ANY_t;
  70
  71 /** An UNDI expansion ROM header */
  72 struct undi_rom_header {
  73         /** Signature
  74          *
  75          * Must be equal to @c ROM_SIGNATURE
  76          */
  77         UINT16_t Signature;
  78         /** ROM length in 512-byte blocks */
  79         UINT8_t ROMLength;
  80         /** Unused */
  81         UINT8_t unused[0x13];
  82         /** Offset of the PXE ROM ID structure */
  83         UINT16_t PXEROMID;
  84         /** Offset of the PCI ROM structure */
  85         UINT16_t PCIRHeader;
  86 } PACKED;
  87
  88 /** Signature for an expansion ROM */
  89 #define ROM_SIGNATURE 0xaa55
  90
  91 /** An UNDI ROM ID structure */
  92 struct undi_rom_id {
  93         /** Signature
  94          *
  95          * Must be equal to @c UNDI_ROM_ID_SIGNATURE
  96          */
  97         UINT32_t Signature;
  98         /** Length of structure */
  99         UINT8_t StructLength;
 100         /** Checksum */
 101         UINT8_t StructCksum;
 102         /** Structure revision
 103          *
 104          * Must be zero.
 105          */
 106         UINT8_t StructRev;
 107         /** UNDI revision
 108          *
 109          * Version 2.1.0 is encoded as the byte sequence 0x00, 0x01, 0x02.
 110          */
 111         UINT8_t UNDIRev[3];
 112         /** Offset to UNDI loader */
 113         UINT16_t UNDILoader;
 114         /** Minimum required stack segment size */
 115         UINT16_t StackSize;
 116         /** Minimum required data segment size */
 117         UINT16_t DataSize;
 118         /** Minimum required code segment size */
 119         UINT16_t CodeSize;
 120 } PACKED;
 121
 122 /** Signature for an UNDI ROM ID structure */
 123 #define UNDI_ROM_ID_SIGNATURE \
 124         ( ( 'U' << 0 ) + ( 'N' << 8 ) + ( 'D' << 16 ) + ( 'I' << 24 ) )
 125
 126 /** A PCI expansion header */
 127 struct pcir_header {
 128         /** Signature
 129          *
 130          * Must be equal to @c PCIR_SIGNATURE
 131          */
 132         uint32_t signature;
 133         /** PCI vendor ID */
 134         uint16_t vendor_id;
 135         /** PCI device ID */
 136         uint16_t device_id;
 137 } PACKED;
 138
 139 /** Signature for an UNDI ROM ID structure */
 140 #define PCIR_SIGNATURE \
 141         ( ( 'P' << 0 ) + ( 'C' << 8 ) + ( 'I' << 16 ) + ( 'R' << 24 ) )
 142
 143
 144 extern struct net_device *pxe_netdev;
 145
 146 extern void pxe_set_netdev ( struct net_device *netdev );
 147
 148 extern void pxe_set_cached_filename ( const unsigned char *filename );
 149
 150 #endif /* PXE_H */