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 };
  62
  63 typedef union u_PXENV_ANY PXENV_ANY_t;
  64
  65 /** An UNDI expansion ROM */
  66 struct undi_rom {
  67         /** Signature
  68          *
  69          * Must be equal to @c ROM_SIGNATURE
  70          */
  71         UINT16_t Signature;
  72         /** ROM length in 512-byte blocks */
  73         UINT8_t ROMLength;
  74         /** Unused */
  75         UINT8_t unused[0x13];
  76         /** Offset of the PXE ROM ID structure */
  77         UINT16_t PXEROMID;
  78         /** Offset of the PCI ROM structure */
  79         UINT16_t PCIRHeader;
  80 } PACKED;
  81
  82 /** Signature for an expansion ROM */
  83 #define ROM_SIGNATURE 0xaa55
  84
  85 /** An UNDI ROM ID structure */
  86 struct undi_rom_id {
  87         /** Signature
  88          *
  89          * Must be equal to @c UNDI_ROM_ID_SIGNATURE
  90          */
  91         UINT32_t Signature;
  92         /** Length of structure */
  93         UINT8_t StructLength;
  94         /** Checksum */
  95         UINT8_t StructCksum;
  96         /** Structure revision
  97          *
  98          * Must be zero.
  99          */
 100         UINT8_t StructRev;
 101         /** UNDI revision
 102          *
 103          * Version 2.1.0 is encoded as the byte sequence 0x00, 0x01, 0x02.
 104          */
 105         UINT8_t UNDIRev[3];
 106         /** Offset to UNDI loader */
 107         UINT16_t UNDILoader;
 108         /** Minimum required stack segment size */
 109         UINT16_t StackSize;
 110         /** Minimum required data segment size */
 111         UINT16_t DataSize;
 112         /** Minimum required code segment size */
 113         UINT16_t CodeSize;
 114 } PACKED;
 115
 116 /** Signature for an UNDI ROM ID structure */
 117 #define UNDI_ROM_ID_SIGNATURE \
 118         ( ( 'U' << 0 ) + ( 'N' << 8 ) + ( 'D' << 16 ) + ( 'I' << 24 ) )
 119
 120 /** A PCI expansion header */
 121 struct pcir_header {
 122         /** Signature
 123          *
 124          * Must be equal to @c PCIR_SIGNATURE
 125          */
 126         uint32_t signature;
 127         /** PCI vendor ID */
 128         uint16_t vendor_id;
 129         /** PCI device ID */
 130         uint16_t device_id;
 131 } PACKED;
 132
 133 /** Signature for an UNDI ROM ID structure */
 134 #define PCIR_SIGNATURE \
 135         ( ( 'P' << 0 ) + ( 'C' << 8 ) + ( 'I' << 16 ) + ( 'R' << 24 ) )
 136
 137 /** A PXE PCI device ID */
 138 struct pxe_pci_device_id {
 139         /** PCI vendor ID */
 140         unsigned int vendor_id;
 141         /** PCI device ID */
 142         unsigned int device_id;
 143 };
 144
 145 /** A PXE device ID */
 146 union pxe_device_id {
 147         /** PCI device ID */
 148         struct pxe_pci_device_id pci;
 149 };
 150
 151 /** A PXE driver */
 152 struct pxe_driver {
 153         /** List of PXE drivers */
 154         struct list_head list;
 155         /** ROM segment address */
 156         unsigned int rom_segment;
 157         /** UNDI loader entry point */
 158         SEGOFF16_t loader_entry;
 159         /** Code segment size */
 160         size_t code_size;
 161         /** Data segment size */
 162         size_t data_size;
 163         /** Bus type
 164          *
 165          * Values are as used by @c PXENV_UNDI_GET_NIC_TYPE
 166          */
 167         unsigned int bus_type;
 168         /** Device ID */
 169         union pxe_device_id bus_id;
 170 };
 171
 172 /** A PXE device */
 173 struct pxe_device {
 174         /** Generic device */
 175         struct device dev;
 176         /** Driver-private data
 177          *
 178          * Use pxe_set_drvdata() and pxe_get_drvdata() to access this
 179          * field.
 180          */
 181         void *priv;
 182
 183         /** PXENV+ structure address */
 184         SEGOFF16_t pxenv;
 185         /** !PXE structure address */
 186         SEGOFF16_t ppxe;
 187         /** Entry point */
 188         SEGOFF16_t entry;
 189         /** MAC address */
 190         MAC_ADDR_t hwaddr;
 191         /** Assigned IRQ number */
 192         UINT16_t irq;
 193         /** ROM segment address */
 194         SEGSEL_t rom_segment;
 195 };
 196
 197 /**
 198  * Set PXE driver-private data
 199  *
 200  * @v pxe               PXE device
 201  * @v priv              Private data
 202  */
 203 static inline void pxe_set_drvdata ( struct pxe_device *pxe, void *priv ) {
 204         pxe->priv = priv;
 205 }
 206
 207 /**
 208  * Get PXE driver-private data
 209  *
 210  * @v pxe               PXE device
 211  * @ret priv            Private data
 212  */
 213 static inline void * pxe_get_drvdata ( struct pxe_device *pxe ) {
 214         return pxe->priv;
 215 }
 216
 217 extern int pxe_call ( struct pxe_device *pxe, unsigned int function,
 218                       void *params, size_t params_len );
 219 extern int undi_probe ( struct pxe_device *pxe );
 220 extern void undi_remove ( struct pxe_device *pxe );
 221
 222 extern struct pxe_driver * pxedrv_find_pci_driver ( unsigned int vendor_id,
 223                                                     unsigned int device_id,
 224                                                     unsigned int rombase );
 225
 226 extern struct net_device *pxe_netdev;
 227
 228 #endif /* PXE_H */