| | 1 | /** @file\r |
| | 2 | This header file contains all of the PXE type definitions,\r |
| | 3 | structure prototypes, global variables and constants that\r |
| | 4 | are needed for porting PXE to EFI.\r |
| | 5 | \r |
| | 6 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| | 8 | \r |
| | 9 | @par Revision Reference:\r |
| | 10 | 32/64-bit PXE specification:\r |
| | 11 | alpha-4, 99-Dec-17.\r |
| | 12 | \r |
| | 13 | **/\r |
| | 14 | \r |
| | 15 | #ifndef __EFI_PXE_H__\r |
| | 16 | #define __EFI_PXE_H__\r |
| | 17 | \r |
| | 18 | #pragma pack(1)\r |
| | 19 | \r |
| | 20 | #define PXE_BUSTYPE(a, b, c, d) \\r |
| | 21 | ( \\r |
| | 22 | (((PXE_UINT32) (d) & 0xFF) << 24) | (((PXE_UINT32) (c) & 0xFF) << 16) | (((PXE_UINT32) (b) & 0xFF) << 8) | \\r |
| | 23 | ((PXE_UINT32) (a) & 0xFF) \\r |
| | 24 | )\r |
| | 25 | \r |
| | 26 | ///\r |
| | 27 | /// UNDI ROM ID and devive ID signature.\r |
| | 28 | ///\r |
| | 29 | #define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')\r |
| | 30 | \r |
| | 31 | ///\r |
| | 32 | /// BUS ROM ID signatures.\r |
| | 33 | ///\r |
| | 34 | #define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')\r |
| | 35 | #define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')\r |
| | 36 | #define PXE_BUSTYPE_USB PXE_BUSTYPE ('U', 'S', 'B', 'R')\r |
| | 37 | #define PXE_BUSTYPE_1394 PXE_BUSTYPE ('1', '3', '9', '4')\r |
| | 38 | \r |
| | 39 | #define PXE_SWAP_UINT16(n) ((((PXE_UINT16) (n) & 0x00FF) << 8) | (((PXE_UINT16) (n) & 0xFF00) >> 8))\r |
| | 40 | \r |
| | 41 | #define PXE_SWAP_UINT32(n) \\r |
| | 42 | ((((PXE_UINT32)(n) & 0x000000FF) << 24) | \\r |
| | 43 | (((PXE_UINT32)(n) & 0x0000FF00) << 8) | \\r |
| | 44 | (((PXE_UINT32)(n) & 0x00FF0000) >> 8) | \\r |
| | 45 | (((PXE_UINT32)(n) & 0xFF000000) >> 24))\r |
| | 46 | \r |
| | 47 | #define PXE_SWAP_UINT64(n) \\r |
| | 48 | ((((PXE_UINT64)(n) & 0x00000000000000FFULL) << 56) | \\r |
| | 49 | (((PXE_UINT64)(n) & 0x000000000000FF00ULL) << 40) | \\r |
| | 50 | (((PXE_UINT64)(n) & 0x0000000000FF0000ULL) << 24) | \\r |
| | 51 | (((PXE_UINT64)(n) & 0x00000000FF000000ULL) << 8) | \\r |
| | 52 | (((PXE_UINT64)(n) & 0x000000FF00000000ULL) >> 8) | \\r |
| | 53 | (((PXE_UINT64)(n) & 0x0000FF0000000000ULL) >> 24) | \\r |
| | 54 | (((PXE_UINT64)(n) & 0x00FF000000000000ULL) >> 40) | \\r |
| | 55 | (((PXE_UINT64)(n) & 0xFF00000000000000ULL) >> 56))\r |
| | 56 | \r |
| | 57 | #define PXE_CPBSIZE_NOT_USED 0 ///< zero\r |
| | 58 | #define PXE_DBSIZE_NOT_USED 0 ///< zero\r |
| | 59 | #define PXE_CPBADDR_NOT_USED (PXE_UINT64) 0 ///< zero\r |
| | 60 | #define PXE_DBADDR_NOT_USED (PXE_UINT64) 0 ///< zero\r |
| | 61 | #define PXE_CONST CONST\r |
| | 62 | \r |
| | 63 | #define PXE_VOLATILE volatile\r |
| | 64 | \r |
| | 65 | typedef VOID PXE_VOID;\r |
| | 66 | typedef UINT8 PXE_UINT8;\r |
| | 67 | typedef UINT16 PXE_UINT16;\r |
| | 68 | typedef UINT32 PXE_UINT32;\r |
| | 69 | typedef UINTN PXE_UINTN;\r |
| | 70 | \r |
| | 71 | ///\r |
| | 72 | /// Typedef unsigned long PXE_UINT64.\r |
| | 73 | ///\r |
| | 74 | typedef UINT64 PXE_UINT64;\r |
| | 75 | \r |
| | 76 | typedef PXE_UINT8 PXE_BOOL;\r |
| | 77 | #define PXE_FALSE 0 ///< zero\r |
| | 78 | #define PXE_TRUE (!PXE_FALSE)\r |
| | 79 | \r |
| | 80 | typedef PXE_UINT16 PXE_OPCODE;\r |
| | 81 | \r |
| | 82 | ///\r |
| | 83 | /// Return UNDI operational state.\r |
| | 84 | ///\r |
| | 85 | #define PXE_OPCODE_GET_STATE 0x0000\r |
| | 86 | \r |
| | 87 | ///\r |
| | 88 | /// Change UNDI operational state from Stopped to Started.\r |
| | 89 | ///\r |
| | 90 | #define PXE_OPCODE_START 0x0001\r |
| | 91 | \r |
| | 92 | ///\r |
| | 93 | /// Change UNDI operational state from Started to Stopped.\r |
| | 94 | ///\r |
| | 95 | #define PXE_OPCODE_STOP 0x0002\r |
| | 96 | \r |
| | 97 | ///\r |
| | 98 | /// Get UNDI initialization information.\r |
| | 99 | ///\r |
| | 100 | #define PXE_OPCODE_GET_INIT_INFO 0x0003\r |
| | 101 | \r |
| | 102 | ///\r |
| | 103 | /// Get NIC configuration information.\r |
| | 104 | ///\r |
| | 105 | #define PXE_OPCODE_GET_CONFIG_INFO 0x0004\r |
| | 106 | \r |
| | 107 | ///\r |
| | 108 | /// Changed UNDI operational state from Started to Initialized.\r |
| | 109 | ///\r |
| | 110 | #define PXE_OPCODE_INITIALIZE 0x0005\r |
| | 111 | \r |
| | 112 | ///\r |
| | 113 | /// Re-initialize the NIC H/W.\r |
| | 114 | ///\r |
| | 115 | #define PXE_OPCODE_RESET 0x0006\r |
| | 116 | \r |
| | 117 | ///\r |
| | 118 | /// Change the UNDI operational state from Initialized to Started.\r |
| | 119 | ///\r |
| | 120 | #define PXE_OPCODE_SHUTDOWN 0x0007\r |
| | 121 | \r |
| | 122 | ///\r |
| | 123 | /// Read & change state of external interrupt enables.\r |
| | 124 | ///\r |
| | 125 | #define PXE_OPCODE_INTERRUPT_ENABLES 0x0008\r |
| | 126 | \r |
| | 127 | ///\r |
| | 128 | /// Read & change state of packet receive filters.\r |
| | 129 | ///\r |
| | 130 | #define PXE_OPCODE_RECEIVE_FILTERS 0x0009\r |
| | 131 | \r |
| | 132 | ///\r |
| | 133 | /// Read & change station MAC address.\r |
| | 134 | ///\r |
| | 135 | #define PXE_OPCODE_STATION_ADDRESS 0x000A\r |
| | 136 | \r |
| | 137 | ///\r |
| | 138 | /// Read traffic statistics.\r |
| | 139 | ///\r |
| | 140 | #define PXE_OPCODE_STATISTICS 0x000B\r |
| | 141 | \r |
| | 142 | ///\r |
| | 143 | /// Convert multicast IP address to multicast MAC address.\r |
| | 144 | ///\r |
| | 145 | #define PXE_OPCODE_MCAST_IP_TO_MAC 0x000C\r |
| | 146 | \r |
| | 147 | ///\r |
| | 148 | /// Read or change non-volatile storage on the NIC.\r |
| | 149 | ///\r |
| | 150 | #define PXE_OPCODE_NVDATA 0x000D\r |
| | 151 | \r |
| | 152 | ///\r |
| | 153 | /// Get & clear interrupt status.\r |
| | 154 | ///\r |
| | 155 | #define PXE_OPCODE_GET_STATUS 0x000E\r |
| | 156 | \r |
| | 157 | ///\r |
| | 158 | /// Fill media header in packet for transmit.\r |
| | 159 | ///\r |
| | 160 | #define PXE_OPCODE_FILL_HEADER 0x000F\r |
| | 161 | \r |
| | 162 | ///\r |
| | 163 | /// Transmit packet(s).\r |
| | 164 | ///\r |
| | 165 | #define PXE_OPCODE_TRANSMIT 0x0010\r |
| | 166 | \r |
| | 167 | ///\r |
| | 168 | /// Receive packet.\r |
| | 169 | ///\r |
| | 170 | #define PXE_OPCODE_RECEIVE 0x0011\r |
| | 171 | \r |
| | 172 | ///\r |
| | 173 | /// Last valid PXE UNDI OpCode number.\r |
| | 174 | ///\r |
| | 175 | #define PXE_OPCODE_LAST_VALID 0x0011\r |
| | 176 | \r |
| | 177 | typedef PXE_UINT16 PXE_OPFLAGS;\r |
| | 178 | \r |
| | 179 | #define PXE_OPFLAGS_NOT_USED 0x0000\r |
| | 180 | \r |
| | 181 | //\r |
| | 182 | // //////////////////////////////////////\r |
| | 183 | // UNDI Get State\r |
| | 184 | //\r |
| | 185 | // No OpFlags\r |
| | 186 | \r |
| | 187 | ////////////////////////////////////////\r |
| | 188 | // UNDI Start\r |
| | 189 | //\r |
| | 190 | // No OpFlags\r |
| | 191 | \r |
| | 192 | ////////////////////////////////////////\r |
| | 193 | // UNDI Stop\r |
| | 194 | //\r |
| | 195 | // No OpFlags\r |
| | 196 | \r |
| | 197 | ////////////////////////////////////////\r |
| | 198 | // UNDI Get Init Info\r |
| | 199 | //\r |
| | 200 | // No Opflags\r |
| | 201 | \r |
| | 202 | ////////////////////////////////////////\r |
| | 203 | // UNDI Get Config Info\r |
| | 204 | //\r |
| | 205 | // No Opflags\r |
| | 206 | \r |
| | 207 | ///\r |
| | 208 | /// UNDI Initialize\r |
| | 209 | ///\r |
| | 210 | #define PXE_OPFLAGS_INITIALIZE_CABLE_DETECT_MASK 0x0001\r |
| | 211 | #define PXE_OPFLAGS_INITIALIZE_DETECT_CABLE 0x0000\r |
| | 212 | #define PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE 0x0001\r |
| | 213 | \r |
| | 214 | ///\r |
| | 215 | ///\r |
| | 216 | /// UNDI Reset\r |
| | 217 | ///\r |
| | 218 | #define PXE_OPFLAGS_RESET_DISABLE_INTERRUPTS 0x0001\r |
| | 219 | #define PXE_OPFLAGS_RESET_DISABLE_FILTERS 0x0002\r |
| | 220 | \r |
| | 221 | ///\r |
| | 222 | /// UNDI Shutdown.\r |
| | 223 | ///\r |
| | 224 | /// No OpFlags.\r |
| | 225 | \r |
| | 226 | ///\r |
| | 227 | /// UNDI Interrupt Enables.\r |
| | 228 | ///\r |
| | 229 | ///\r |
| | 230 | /// Select whether to enable or disable external interrupt signals.\r |
| | 231 | /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPFLAGS.\r |
| | 232 | ///\r |
| | 233 | #define PXE_OPFLAGS_INTERRUPT_OPMASK 0xC000\r |
| | 234 | #define PXE_OPFLAGS_INTERRUPT_ENABLE 0x8000\r |
| | 235 | #define PXE_OPFLAGS_INTERRUPT_DISABLE 0x4000\r |
| | 236 | #define PXE_OPFLAGS_INTERRUPT_READ 0x0000\r |
| | 237 | \r |
| | 238 | ///\r |
| | 239 | /// Enable receive interrupts. An external interrupt will be generated\r |
| | 240 | /// after a complete non-error packet has been received.\r |
| | 241 | ///\r |
| | 242 | #define PXE_OPFLAGS_INTERRUPT_RECEIVE 0x0001\r |
| | 243 | \r |
| | 244 | ///\r |
| | 245 | /// Enable transmit interrupts. An external interrupt will be generated\r |
| | 246 | /// after a complete non-error packet has been transmitted.\r |
| | 247 | ///\r |
| | 248 | #define PXE_OPFLAGS_INTERRUPT_TRANSMIT 0x0002\r |
| | 249 | \r |
| | 250 | ///\r |
| | 251 | /// Enable command interrupts. An external interrupt will be generated\r |
| | 252 | /// when command execution stops.\r |
| | 253 | ///\r |
| | 254 | #define PXE_OPFLAGS_INTERRUPT_COMMAND 0x0004\r |
| | 255 | \r |
| | 256 | ///\r |
| | 257 | /// Generate software interrupt. Setting this bit generates an external\r |
| | 258 | /// interrupt, if it is supported by the hardware.\r |
| | 259 | ///\r |
| | 260 | #define PXE_OPFLAGS_INTERRUPT_SOFTWARE 0x0008\r |
| | 261 | \r |
| | 262 | ///\r |
| | 263 | /// UNDI Receive Filters.\r |
| | 264 | ///\r |
| | 265 | ///\r |
| | 266 | /// Select whether to enable or disable receive filters.\r |
| | 267 | /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPCODE.\r |
| | 268 | ///\r |
| | 269 | #define PXE_OPFLAGS_RECEIVE_FILTER_OPMASK 0xC000\r |
| | 270 | #define PXE_OPFLAGS_RECEIVE_FILTER_ENABLE 0x8000\r |
| | 271 | #define PXE_OPFLAGS_RECEIVE_FILTER_DISABLE 0x4000\r |
| | 272 | #define PXE_OPFLAGS_RECEIVE_FILTER_READ 0x0000\r |
| | 273 | \r |
| | 274 | ///\r |
| | 275 | /// To reset the contents of the multicast MAC address filter list,\r |
| | 276 | /// set this OpFlag:\r |
| | 277 | ///\r |
| | 278 | #define PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST 0x2000\r |
| | 279 | \r |
| | 280 | ///\r |
| | 281 | /// Enable unicast packet receiving. Packets sent to the current station\r |
| | 282 | /// MAC address will be received.\r |
| | 283 | ///\r |
| | 284 | #define PXE_OPFLAGS_RECEIVE_FILTER_UNICAST 0x0001\r |
| | 285 | \r |
| | 286 | ///\r |
| | 287 | /// Enable broadcast packet receiving. Packets sent to the broadcast\r |
| | 288 | /// MAC address will be received.\r |
| | 289 | ///\r |
| | 290 | #define PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST 0x0002\r |
| | 291 | \r |
| | 292 | ///\r |
| | 293 | /// Enable filtered multicast packet receiving. Packets sent to any\r |
| | 294 | /// of the multicast MAC addresses in the multicast MAC address filter\r |
| | 295 | /// list will be received. If the filter list is empty, no multicast\r |
| | 296 | ///\r |
| | 297 | #define PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004\r |
| | 298 | \r |
| | 299 | ///\r |
| | 300 | /// Enable promiscuous packet receiving. All packets will be received.\r |
| | 301 | ///\r |
| | 302 | #define PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008\r |
| | 303 | \r |
| | 304 | ///\r |
| | 305 | /// Enable promiscuous multicast packet receiving. All multicast\r |
| | 306 | /// packets will be received.\r |
| | 307 | ///\r |
| | 308 | #define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010\r |
| | 309 | \r |
| | 310 | ///\r |
| | 311 | /// UNDI Station Address.\r |
| | 312 | ///\r |
| | 313 | #define PXE_OPFLAGS_STATION_ADDRESS_READ 0x0000\r |
| | 314 | #define PXE_OPFLAGS_STATION_ADDRESS_WRITE 0x0000\r |
| | 315 | #define PXE_OPFLAGS_STATION_ADDRESS_RESET 0x0001\r |
| | 316 | \r |
| | 317 | ///\r |
| | 318 | /// UNDI Statistics.\r |
| | 319 | ///\r |
| | 320 | #define PXE_OPFLAGS_STATISTICS_READ 0x0000\r |
| | 321 | #define PXE_OPFLAGS_STATISTICS_RESET 0x0001\r |
| | 322 | \r |
| | 323 | ///\r |
| | 324 | /// UNDI MCast IP to MAC.\r |
| | 325 | ///\r |
| | 326 | ///\r |
| | 327 | /// Identify the type of IP address in the CPB.\r |
| | 328 | ///\r |
| | 329 | #define PXE_OPFLAGS_MCAST_IP_TO_MAC_OPMASK 0x0003\r |
| | 330 | #define PXE_OPFLAGS_MCAST_IPV4_TO_MAC 0x0000\r |
| | 331 | #define PXE_OPFLAGS_MCAST_IPV6_TO_MAC 0x0001\r |
| | 332 | \r |
| | 333 | ///\r |
| | 334 | /// UNDI NvData.\r |
| | 335 | ///\r |
| | 336 | ///\r |
| | 337 | /// Select the type of non-volatile data operation.\r |
| | 338 | ///\r |
| | 339 | #define PXE_OPFLAGS_NVDATA_OPMASK 0x0001\r |
| | 340 | #define PXE_OPFLAGS_NVDATA_READ 0x0000\r |
| | 341 | #define PXE_OPFLAGS_NVDATA_WRITE 0x0001\r |
| | 342 | \r |
| | 343 | ///\r |
| | 344 | /// UNDI Get Status.\r |
| | 345 | ///\r |
| | 346 | ///\r |
| | 347 | /// Return current interrupt status. This will also clear any interrupts\r |
| | 348 | /// that are currently set. This can be used in a polling routine. The\r |
| | 349 | /// interrupt flags are still set and cleared even when the interrupts\r |
| | 350 | /// are disabled.\r |
| | 351 | ///\r |
| | 352 | #define PXE_OPFLAGS_GET_INTERRUPT_STATUS 0x0001\r |
| | 353 | \r |
| | 354 | ///\r |
| | 355 | /// Return list of transmitted buffers for recycling. Transmit buffers\r |
| | 356 | /// must not be changed or unallocated until they have recycled. After\r |
| | 357 | /// issuing a transmit command, wait for a transmit complete interrupt.\r |
| | 358 | /// When a transmit complete interrupt is received, read the transmitted\r |
| | 359 | /// buffers. Do not plan on getting one buffer per interrupt. Some\r |
| | 360 | /// NICs and UNDIs may transmit multiple buffers per interrupt.\r |
| | 361 | ///\r |
| | 362 | #define PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS 0x0002\r |
| | 363 | \r |
| | 364 | ///\r |
| | 365 | /// Return current media status.\r |
| | 366 | ///\r |
| | 367 | #define PXE_OPFLAGS_GET_MEDIA_STATUS 0x0004\r |
| | 368 | \r |
| | 369 | ///\r |
| | 370 | /// UNDI Fill Header.\r |
| | 371 | ///\r |
| | 372 | #define PXE_OPFLAGS_FILL_HEADER_OPMASK 0x0001\r |
| | 373 | #define PXE_OPFLAGS_FILL_HEADER_FRAGMENTED 0x0001\r |
| | 374 | #define PXE_OPFLAGS_FILL_HEADER_WHOLE 0x0000\r |
| | 375 | \r |
| | 376 | ///\r |
| | 377 | /// UNDI Transmit.\r |
| | 378 | ///\r |
| | 379 | ///\r |
| | 380 | /// S/W UNDI only. Return after the packet has been transmitted. A\r |
| | 381 | /// transmit complete interrupt will still be generated and the transmit\r |
| | 382 | /// buffer will have to be recycled.\r |
| | 383 | ///\r |
| | 384 | #define PXE_OPFLAGS_SWUNDI_TRANSMIT_OPMASK 0x0001\r |
| | 385 | #define PXE_OPFLAGS_TRANSMIT_BLOCK 0x0001\r |
| | 386 | #define PXE_OPFLAGS_TRANSMIT_DONT_BLOCK 0x0000\r |
| | 387 | \r |
| | 388 | #define PXE_OPFLAGS_TRANSMIT_OPMASK 0x0002\r |
| | 389 | #define PXE_OPFLAGS_TRANSMIT_FRAGMENTED 0x0002\r |
| | 390 | #define PXE_OPFLAGS_TRANSMIT_WHOLE 0x0000\r |
| | 391 | \r |
| | 392 | ///\r |
| | 393 | /// UNDI Receive.\r |
| | 394 | ///\r |
| | 395 | /// No OpFlags.\r |
| | 396 | ///\r |
| | 397 | \r |
| | 398 | ///\r |
| | 399 | /// PXE STATFLAGS.\r |
| | 400 | ///\r |
| | 401 | typedef PXE_UINT16 PXE_STATFLAGS;\r |
| | 402 | \r |
| | 403 | #define PXE_STATFLAGS_INITIALIZE 0x0000\r |
| | 404 | \r |
| | 405 | ///\r |
| | 406 | /// Common StatFlags that can be returned by all commands.\r |
| | 407 | ///\r |
| | 408 | ///\r |
| | 409 | /// The COMMAND_COMPLETE and COMMAND_FAILED status flags must be\r |
| | 410 | /// implemented by all UNDIs. COMMAND_QUEUED is only needed by UNDIs\r |
| | 411 | /// that support command queuing.\r |
| | 412 | ///\r |
| | 413 | #define PXE_STATFLAGS_STATUS_MASK 0xC000\r |
| | 414 | #define PXE_STATFLAGS_COMMAND_COMPLETE 0xC000\r |
| | 415 | #define PXE_STATFLAGS_COMMAND_FAILED 0x8000\r |
| | 416 | #define PXE_STATFLAGS_COMMAND_QUEUED 0x4000\r |
| | 417 | \r |
| | 418 | ///\r |
| | 419 | /// UNDI Get State.\r |
| | 420 | ///\r |
| | 421 | #define PXE_STATFLAGS_GET_STATE_MASK 0x0003\r |
| | 422 | #define PXE_STATFLAGS_GET_STATE_INITIALIZED 0x0002\r |
| | 423 | #define PXE_STATFLAGS_GET_STATE_STARTED 0x0001\r |
| | 424 | #define PXE_STATFLAGS_GET_STATE_STOPPED 0x0000\r |
| | 425 | \r |
| | 426 | ///\r |
| | 427 | /// UNDI Start.\r |
| | 428 | ///\r |
| | 429 | /// No additional StatFlags.\r |
| | 430 | ///\r |
| | 431 | \r |
| | 432 | ///\r |
| | 433 | /// UNDI Get Init Info.\r |
| | 434 | ///\r |
| | 435 | #define PXE_STATFLAGS_CABLE_DETECT_MASK 0x0001\r |
| | 436 | #define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000\r |
| | 437 | #define PXE_STATFLAGS_CABLE_DETECT_SUPPORTED 0x0001\r |
| | 438 | \r |
| | 439 | #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK 0x0002\r |
| | 440 | #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED 0x0000\r |
| | 441 | #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED 0x0002\r |
| | 442 | \r |
| | 443 | ///\r |
| | 444 | /// UNDI Initialize.\r |
| | 445 | ///\r |
| | 446 | #define PXE_STATFLAGS_INITIALIZED_NO_MEDIA 0x0001\r |
| | 447 | \r |
| | 448 | ///\r |
| | 449 | /// UNDI Reset.\r |
| | 450 | ///\r |
| | 451 | #define PXE_STATFLAGS_RESET_NO_MEDIA 0x0001\r |
| | 452 | \r |
| | 453 | ///\r |
| | 454 | /// UNDI Shutdown.\r |
| | 455 | ///\r |
| | 456 | /// No additional StatFlags.\r |
| | 457 | \r |
| | 458 | ///\r |
| | 459 | /// UNDI Interrupt Enables.\r |
| | 460 | ///\r |
| | 461 | ///\r |
| | 462 | /// If set, receive interrupts are enabled.\r |
| | 463 | ///\r |
| | 464 | #define PXE_STATFLAGS_INTERRUPT_RECEIVE 0x0001\r |
| | 465 | \r |
| | 466 | ///\r |
| | 467 | /// If set, transmit interrupts are enabled.\r |
| | 468 | ///\r |
| | 469 | #define PXE_STATFLAGS_INTERRUPT_TRANSMIT 0x0002\r |
| | 470 | \r |
| | 471 | ///\r |
| | 472 | /// If set, command interrupts are enabled.\r |
| | 473 | ///\r |
| | 474 | #define PXE_STATFLAGS_INTERRUPT_COMMAND 0x0004\r |
| | 475 | \r |
| | 476 | ///\r |
| | 477 | /// UNDI Receive Filters.\r |
| | 478 | ///\r |
| | 479 | \r |
| | 480 | ///\r |
| | 481 | /// If set, unicast packets will be received.\r |
| | 482 | ///\r |
| | 483 | #define PXE_STATFLAGS_RECEIVE_FILTER_UNICAST 0x0001\r |
| | 484 | \r |
| | 485 | ///\r |
| | 486 | /// If set, broadcast packets will be received.\r |
| | 487 | ///\r |
| | 488 | #define PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST 0x0002\r |
| | 489 | \r |
| | 490 | ///\r |
| | 491 | /// If set, multicast packets that match up with the multicast address\r |
| | 492 | /// filter list will be received.\r |
| | 493 | ///\r |
| | 494 | #define PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004\r |
| | 495 | \r |
| | 496 | ///\r |
| | 497 | /// If set, all packets will be received.\r |
| | 498 | ///\r |
| | 499 | #define PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008\r |
| | 500 | \r |
| | 501 | ///\r |
| | 502 | /// If set, all multicast packets will be received.\r |
| | 503 | ///\r |
| | 504 | #define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010\r |
| | 505 | \r |
| | 506 | ///\r |
| | 507 | /// UNDI Station Address.\r |
| | 508 | ///\r |
| | 509 | /// No additional StatFlags.\r |
| | 510 | ///\r |
| | 511 | \r |
| | 512 | ///\r |
| | 513 | /// UNDI Statistics.\r |
| | 514 | ///\r |
| | 515 | /// No additional StatFlags.\r |
| | 516 | ///\r |
| | 517 | \r |
| | 518 | ///\r |
| | 519 | //// UNDI MCast IP to MAC.\r |
| | 520 | ////\r |
| | 521 | //// No additional StatFlags.\r |
| | 522 | \r |
| | 523 | ///\r |
| | 524 | /// UNDI NvData.\r |
| | 525 | ///\r |
| | 526 | /// No additional StatFlags.\r |
| | 527 | ///\r |
| | 528 | \r |
| | 529 | ///\r |
| | 530 | /// UNDI Get Status.\r |
| | 531 | ///\r |
| | 532 | \r |
| | 533 | ///\r |
| | 534 | /// Use to determine if an interrupt has occurred.\r |
| | 535 | ///\r |
| | 536 | #define PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK 0x000F\r |
| | 537 | #define PXE_STATFLAGS_GET_STATUS_NO_INTERRUPTS 0x0000\r |
| | 538 | \r |
| | 539 | ///\r |
| | 540 | /// If set, at least one receive interrupt occurred.\r |
| | 541 | ///\r |
| | 542 | #define PXE_STATFLAGS_GET_STATUS_RECEIVE 0x0001\r |
| | 543 | \r |
| | 544 | ///\r |
| | 545 | /// If set, at least one transmit interrupt occurred.\r |
| | 546 | ///\r |
| | 547 | #define PXE_STATFLAGS_GET_STATUS_TRANSMIT 0x0002\r |
| | 548 | \r |
| | 549 | ///\r |
| | 550 | /// If set, at least one command interrupt occurred.\r |
| | 551 | ///\r |
| | 552 | #define PXE_STATFLAGS_GET_STATUS_COMMAND 0x0004\r |
| | 553 | \r |
| | 554 | ///\r |
| | 555 | /// If set, at least one software interrupt occurred.\r |
| | 556 | ///\r |
| | 557 | #define PXE_STATFLAGS_GET_STATUS_SOFTWARE 0x0008\r |
| | 558 | \r |
| | 559 | ///\r |
| | 560 | /// This flag is set if the transmitted buffer queue is empty. This flag\r |
| | 561 | /// will be set if all transmitted buffer addresses get written into the DB.\r |
| | 562 | ///\r |
| | 563 | #define PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY 0x0010\r |
| | 564 | \r |
| | 565 | ///\r |
| | 566 | /// This flag is set if no transmitted buffer addresses were written\r |
| | 567 | /// into the DB. (This could be because DBsize was too small.)\r |
| | 568 | ///\r |
| | 569 | #define PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN 0x0020\r |
| | 570 | \r |
| | 571 | ///\r |
| | 572 | /// This flag is set if there is no media detected.\r |
| | 573 | ///\r |
| | 574 | #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA 0x0040\r |
| | 575 | \r |
| | 576 | ///\r |
| | 577 | /// UNDI Fill Header.\r |
| | 578 | ///\r |
| | 579 | /// No additional StatFlags.\r |
| | 580 | ///\r |
| | 581 | \r |
| | 582 | ///\r |
| | 583 | /// UNDI Transmit.\r |
| | 584 | ///\r |
| | 585 | /// No additional StatFlags.\r |
| | 586 | \r |
| | 587 | ///\r |
| | 588 | /// UNDI Receive\r |
| | 589 | /// .\r |
| | 590 | \r |
| | 591 | ///\r |
| | 592 | /// No additional StatFlags.\r |
| | 593 | ///\r |
| | 594 | typedef PXE_UINT16 PXE_STATCODE;\r |
| | 595 | \r |
| | 596 | #define PXE_STATCODE_INITIALIZE 0x0000\r |
| | 597 | \r |
| | 598 | ///\r |
| | 599 | /// Common StatCodes returned by all UNDI commands, UNDI protocol functions\r |
| | 600 | /// and BC protocol functions.\r |
| | 601 | ///\r |
| | 602 | #define PXE_STATCODE_SUCCESS 0x0000\r |
| | 603 | \r |
| | 604 | #define PXE_STATCODE_INVALID_CDB 0x0001\r |
| | 605 | #define PXE_STATCODE_INVALID_CPB 0x0002\r |
| | 606 | #define PXE_STATCODE_BUSY 0x0003\r |
| | 607 | #define PXE_STATCODE_QUEUE_FULL 0x0004\r |
| | 608 | #define PXE_STATCODE_ALREADY_STARTED 0x0005\r |
| | 609 | #define PXE_STATCODE_NOT_STARTED 0x0006\r |
| | 610 | #define PXE_STATCODE_NOT_SHUTDOWN 0x0007\r |
| | 611 | #define PXE_STATCODE_ALREADY_INITIALIZED 0x0008\r |
| | 612 | #define PXE_STATCODE_NOT_INITIALIZED 0x0009\r |
| | 613 | #define PXE_STATCODE_DEVICE_FAILURE 0x000A\r |
| | 614 | #define PXE_STATCODE_NVDATA_FAILURE 0x000B\r |
| | 615 | #define PXE_STATCODE_UNSUPPORTED 0x000C\r |
| | 616 | #define PXE_STATCODE_BUFFER_FULL 0x000D\r |
| | 617 | #define PXE_STATCODE_INVALID_PARAMETER 0x000E\r |
| | 618 | #define PXE_STATCODE_INVALID_UNDI 0x000F\r |
| | 619 | #define PXE_STATCODE_IPV4_NOT_SUPPORTED 0x0010\r |
| | 620 | #define PXE_STATCODE_IPV6_NOT_SUPPORTED 0x0011\r |
| | 621 | #define PXE_STATCODE_NOT_ENOUGH_MEMORY 0x0012\r |
| | 622 | #define PXE_STATCODE_NO_DATA 0x0013\r |
| | 623 | \r |
| | 624 | typedef PXE_UINT16 PXE_IFNUM;\r |
| | 625 | \r |
| | 626 | ///\r |
| | 627 | /// This interface number must be passed to the S/W UNDI Start command.\r |
| | 628 | ///\r |
| | 629 | #define PXE_IFNUM_START 0x0000\r |
| | 630 | \r |
| | 631 | ///\r |
| | 632 | /// This interface number is returned by the S/W UNDI Get State and\r |
| | 633 | /// Start commands if information in the CDB, CPB or DB is invalid.\r |
| | 634 | ///\r |
| | 635 | #define PXE_IFNUM_INVALID 0x0000\r |
| | 636 | \r |
| | 637 | typedef PXE_UINT16 PXE_CONTROL;\r |
| | 638 | \r |
| | 639 | ///\r |
| | 640 | /// Setting this flag directs the UNDI to queue this command for later\r |
| | 641 | /// execution if the UNDI is busy and it supports command queuing.\r |
| | 642 | /// If queuing is not supported, a PXE_STATCODE_INVALID_CONTROL error\r |
| | 643 | /// is returned. If the queue is full, a PXE_STATCODE_CDB_QUEUE_FULL\r |
| | 644 | /// error is returned.\r |
| | 645 | ///\r |
| | 646 | #define PXE_CONTROL_QUEUE_IF_BUSY 0x0002\r |
| | 647 | \r |
| | 648 | ///\r |
| | 649 | /// These two bit values are used to determine if there are more UNDI\r |
| | 650 | /// CDB structures following this one. If the link bit is set, there\r |
| | 651 | /// must be a CDB structure following this one. Execution will start\r |
| | 652 | /// on the next CDB structure as soon as this one completes successfully.\r |
| | 653 | /// If an error is generated by this command, execution will stop.\r |
| | 654 | ///\r |
| | 655 | #define PXE_CONTROL_LINK 0x0001\r |
| | 656 | #define PXE_CONTROL_LAST_CDB_IN_LIST 0x0000\r |
| | 657 | \r |
| | 658 | typedef PXE_UINT8 PXE_FRAME_TYPE;\r |
| | 659 | \r |
| | 660 | #define PXE_FRAME_TYPE_NONE 0x00\r |
| | 661 | #define PXE_FRAME_TYPE_UNICAST 0x01\r |
| | 662 | #define PXE_FRAME_TYPE_BROADCAST 0x02\r |
| | 663 | #define PXE_FRAME_TYPE_FILTERED_MULTICAST 0x03\r |
| | 664 | #define PXE_FRAME_TYPE_PROMISCUOUS 0x04\r |
| | 665 | #define PXE_FRAME_TYPE_PROMISCUOUS_MULTICAST 0x05\r |
| | 666 | \r |
| | 667 | #define PXE_FRAME_TYPE_MULTICAST PXE_FRAME_TYPE_FILTERED_MULTICAST\r |
| | 668 | \r |
| | 669 | typedef PXE_UINT32 PXE_IPV4;\r |
| | 670 | \r |
| | 671 | typedef PXE_UINT32 PXE_IPV6[4];\r |
| | 672 | #define PXE_MAC_LENGTH 32\r |
| | 673 | \r |
| | 674 | typedef PXE_UINT8 PXE_MAC_ADDR[PXE_MAC_LENGTH];\r |
| | 675 | \r |
| | 676 | typedef PXE_UINT8 PXE_IFTYPE;\r |
| | 677 | typedef UINT16 PXE_MEDIA_PROTOCOL;\r |
| | 678 | \r |
| | 679 | ///\r |
| | 680 | /// This information is from the ARP section of RFC 1700.\r |
| | 681 | ///\r |
| | 682 | /// 1 Ethernet (10Mb) [JBP]\r |
| | 683 | /// 2 Experimental Ethernet (3Mb) [JBP]\r |
| | 684 | /// 3 Amateur Radio AX.25 [PXK]\r |
| | 685 | /// 4 Proteon ProNET Token Ring [JBP]\r |
| | 686 | /// 5 Chaos [GXP]\r |
| | 687 | /// 6 IEEE 802 Networks [JBP]\r |
| | 688 | /// 7 ARCNET [JBP]\r |
| | 689 | /// 8 Hyperchannel [JBP]\r |
| | 690 | /// 9 Lanstar [TU]\r |
| | 691 | /// 10 Autonet Short Address [MXB1]\r |
| | 692 | /// 11 LocalTalk [JKR1]\r |
| | 693 | /// 12 LocalNet (IBM* PCNet or SYTEK* LocalNET) [JXM]\r |
| | 694 | /// 13 Ultra link [RXD2]\r |
| | 695 | /// 14 SMDS [GXC1]\r |
| | 696 | /// 15 Frame Relay [AGM]\r |
| | 697 | /// 16 Asynchronous Transmission Mode (ATM) [JXB2]\r |
| | 698 | /// 17 HDLC [JBP]\r |
| | 699 | /// 18 Fibre Channel [Yakov Rekhter]\r |
| | 700 | /// 19 Asynchronous Transmission Mode (ATM) [Mark Laubach]\r |
| | 701 | /// 20 Serial Line [JBP]\r |
| | 702 | /// 21 Asynchronous Transmission Mode (ATM) [MXB1]\r |
| | 703 | ///\r |
| | 704 | /// * Other names and brands may be claimed as the property of others.\r |
| | 705 | ///\r |
| | 706 | #define PXE_IFTYPE_ETHERNET 0x01\r |
| | 707 | #define PXE_IFTYPE_TOKENRING 0x04\r |
| | 708 | #define PXE_IFTYPE_FIBRE_CHANNEL 0x12\r |
| | 709 | \r |
| | 710 | typedef struct s_pxe_hw_undi {\r |
| | 711 | PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.\r |
| | 712 | PXE_UINT8 Len; ///< sizeof(PXE_HW_UNDI).\r |
| | 713 | PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero.\r |
| | 714 | PXE_UINT8 Rev; ///< PXE_ROMID_REV.\r |
| | 715 | PXE_UINT8 IFcnt; ///< physical connector count lower byte.\r |
| | 716 | PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.\r |
| | 717 | PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.\r |
| | 718 | PXE_UINT8 IFcntExt; ///< physical connector count upper byte.\r |
| | 719 | PXE_UINT8 reserved; ///< zero, not used.\r |
| | 720 | PXE_UINT32 Implementation; ///< implementation flags.\r |
| | 721 | ///< reserved ///< vendor use.\r |
| | 722 | ///< UINT32 Status; ///< status port.\r |
| | 723 | ///< UINT32 Command; ///< command port.\r |
| | 724 | ///< UINT64 CDBaddr; ///< CDB address port.\r |
| | 725 | ///<\r |
| | 726 | } PXE_HW_UNDI;\r |
| | 727 | \r |
| | 728 | ///\r |
| | 729 | /// Status port bit definitions.\r |
| | 730 | ///\r |
| | 731 | \r |
| | 732 | ///\r |
| | 733 | /// UNDI operation state.\r |
| | 734 | ///\r |
| | 735 | #define PXE_HWSTAT_STATE_MASK 0xC0000000\r |
| | 736 | #define PXE_HWSTAT_BUSY 0xC0000000\r |
| | 737 | #define PXE_HWSTAT_INITIALIZED 0x80000000\r |
| | 738 | #define PXE_HWSTAT_STARTED 0x40000000\r |
| | 739 | #define PXE_HWSTAT_STOPPED 0x00000000\r |
| | 740 | \r |
| | 741 | ///\r |
| | 742 | /// If set, last command failed.\r |
| | 743 | ///\r |
| | 744 | #define PXE_HWSTAT_COMMAND_FAILED 0x20000000\r |
| | 745 | \r |
| | 746 | ///\r |
| | 747 | /// If set, identifies enabled receive filters.\r |
| | 748 | ///\r |
| | 749 | #define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000\r |
| | 750 | #define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800\r |
| | 751 | #define PXE_HWSTAT_BROADCAST_RX_ENABLED 0x00000400\r |
| | 752 | #define PXE_HWSTAT_MULTICAST_RX_ENABLED 0x00000200\r |
| | 753 | #define PXE_HWSTAT_UNICAST_RX_ENABLED 0x00000100\r |
| | 754 | \r |
| | 755 | ///\r |
| | 756 | /// If set, identifies enabled external interrupts.\r |
| | 757 | ///\r |
| | 758 | #define PXE_HWSTAT_SOFTWARE_INT_ENABLED 0x00000080\r |
| | 759 | #define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040\r |
| | 760 | #define PXE_HWSTAT_PACKET_RX_INT_ENABLED 0x00000020\r |
| | 761 | #define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010\r |
| | 762 | \r |
| | 763 | ///\r |
| | 764 | /// If set, identifies pending interrupts.\r |
| | 765 | ///\r |
| | 766 | #define PXE_HWSTAT_SOFTWARE_INT_PENDING 0x00000008\r |
| | 767 | #define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004\r |
| | 768 | #define PXE_HWSTAT_PACKET_RX_INT_PENDING 0x00000002\r |
| | 769 | #define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001\r |
| | 770 | \r |
| | 771 | ///\r |
| | 772 | /// Command port definitions.\r |
| | 773 | ///\r |
| | 774 | \r |
| | 775 | ///\r |
| | 776 | /// If set, CDB identified in CDBaddr port is given to UNDI.\r |
| | 777 | /// If not set, other bits in this word will be processed.\r |
| | 778 | ///\r |
| | 779 | #define PXE_HWCMD_ISSUE_COMMAND 0x80000000\r |
| | 780 | #define PXE_HWCMD_INTS_AND_FILTS 0x00000000\r |
| | 781 | \r |
| | 782 | ///\r |
| | 783 | /// Use these to enable/disable receive filters.\r |
| | 784 | ///\r |
| | 785 | #define PXE_HWCMD_PROMISCUOUS_MULTICAST_RX_ENABLE 0x00001000\r |
| | 786 | #define PXE_HWCMD_PROMISCUOUS_RX_ENABLE 0x00000800\r |
| | 787 | #define PXE_HWCMD_BROADCAST_RX_ENABLE 0x00000400\r |
| | 788 | #define PXE_HWCMD_MULTICAST_RX_ENABLE 0x00000200\r |
| | 789 | #define PXE_HWCMD_UNICAST_RX_ENABLE 0x00000100\r |
| | 790 | \r |
| | 791 | ///\r |
| | 792 | /// Use these to enable/disable external interrupts.\r |
| | 793 | ///\r |
| | 794 | #define PXE_HWCMD_SOFTWARE_INT_ENABLE 0x00000080\r |
| | 795 | #define PXE_HWCMD_TX_COMPLETE_INT_ENABLE 0x00000040\r |
| | 796 | #define PXE_HWCMD_PACKET_RX_INT_ENABLE 0x00000020\r |
| | 797 | #define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010\r |
| | 798 | \r |
| | 799 | ///\r |
| | 800 | /// Use these to clear pending external interrupts.\r |
| | 801 | ///\r |
| | 802 | #define PXE_HWCMD_CLEAR_SOFTWARE_INT 0x00000008\r |
| | 803 | #define PXE_HWCMD_CLEAR_TX_COMPLETE_INT 0x00000004\r |
| | 804 | #define PXE_HWCMD_CLEAR_PACKET_RX_INT 0x00000002\r |
| | 805 | #define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT 0x00000001\r |
| | 806 | \r |
| | 807 | typedef struct s_pxe_sw_undi {\r |
| | 808 | PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.\r |
| | 809 | PXE_UINT8 Len; ///< sizeof(PXE_SW_UNDI).\r |
| | 810 | PXE_UINT8 Fudge; ///< makes 8-bit cksum zero.\r |
| | 811 | PXE_UINT8 Rev; ///< PXE_ROMID_REV.\r |
| | 812 | PXE_UINT8 IFcnt; ///< physical connector count lower byte.\r |
| | 813 | PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.\r |
| | 814 | PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.\r |
| | 815 | PXE_UINT8 IFcntExt; ///< physical connector count upper byte.\r |
| | 816 | PXE_UINT8 reserved1; ///< zero, not used.\r |
| | 817 | PXE_UINT32 Implementation; ///< Implementation flags.\r |
| | 818 | PXE_UINT64 EntryPoint; ///< API entry point.\r |
| | 819 | PXE_UINT8 reserved2[3]; ///< zero, not used.\r |
| | 820 | PXE_UINT8 BusCnt; ///< number of bustypes supported.\r |
| | 821 | PXE_UINT32 BusType[1]; ///< list of supported bustypes.\r |
| | 822 | } PXE_SW_UNDI;\r |
| | 823 | \r |
| | 824 | typedef union u_pxe_undi {\r |
| | 825 | PXE_HW_UNDI hw;\r |
| | 826 | PXE_SW_UNDI sw;\r |
| | 827 | } PXE_UNDI;\r |
| | 828 | \r |
| | 829 | ///\r |
| | 830 | /// Signature of !PXE structure.\r |
| | 831 | ///\r |
| | 832 | #define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')\r |
| | 833 | \r |
| | 834 | ///\r |
| | 835 | /// !PXE structure format revision\r |
| | 836 | /// .\r |
| | 837 | #define PXE_ROMID_REV 0x02\r |
| | 838 | \r |
| | 839 | ///\r |
| | 840 | /// UNDI command interface revision. These are the values that get sent\r |
| | 841 | /// in option 94 (Client Network Interface Identifier) in the DHCP Discover\r |
| | 842 | /// and PXE Boot Server Request packets.\r |
| | 843 | ///\r |
| | 844 | #define PXE_ROMID_MAJORVER 0x03\r |
| | 845 | #define PXE_ROMID_MINORVER 0x01\r |
| | 846 | \r |
| | 847 | ///\r |
| | 848 | /// Implementation flags.\r |
| | 849 | ///\r |
| | 850 | #define PXE_ROMID_IMP_HW_UNDI 0x80000000\r |
| | 851 | #define PXE_ROMID_IMP_SW_VIRT_ADDR 0x40000000\r |
| | 852 | #define PXE_ROMID_IMP_64BIT_DEVICE 0x00010000\r |
| | 853 | #define PXE_ROMID_IMP_FRAG_SUPPORTED 0x00008000\r |
| | 854 | #define PXE_ROMID_IMP_CMD_LINK_SUPPORTED 0x00004000\r |
| | 855 | #define PXE_ROMID_IMP_CMD_QUEUE_SUPPORTED 0x00002000\r |
| | 856 | #define PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED 0x00001000\r |
| | 857 | #define PXE_ROMID_IMP_NVDATA_SUPPORT_MASK 0x00000C00\r |
| | 858 | #define PXE_ROMID_IMP_NVDATA_BULK_WRITABLE 0x00000C00\r |
| | 859 | #define PXE_ROMID_IMP_NVDATA_SPARSE_WRITABLE 0x00000800\r |
| | 860 | #define PXE_ROMID_IMP_NVDATA_READ_ONLY 0x00000400\r |
| | 861 | #define PXE_ROMID_IMP_NVDATA_NOT_AVAILABLE 0x00000000\r |
| | 862 | #define PXE_ROMID_IMP_STATISTICS_SUPPORTED 0x00000200\r |
| | 863 | #define PXE_ROMID_IMP_STATION_ADDR_SETTABLE 0x00000100\r |
| | 864 | #define PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED 0x00000080\r |
| | 865 | #define PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED 0x00000040\r |
| | 866 | #define PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED 0x00000020\r |
| | 867 | #define PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED 0x00000010\r |
| | 868 | #define PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED 0x00000008\r |
| | 869 | #define PXE_ROMID_IMP_TX_COMPLETE_INT_SUPPORTED 0x00000004\r |
| | 870 | #define PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED 0x00000002\r |
| | 871 | #define PXE_ROMID_IMP_CMD_COMPLETE_INT_SUPPORTED 0x00000001\r |
| | 872 | \r |
| | 873 | typedef struct s_pxe_cdb {\r |
| | 874 | PXE_OPCODE OpCode;\r |
| | 875 | PXE_OPFLAGS OpFlags;\r |
| | 876 | PXE_UINT16 CPBsize;\r |
| | 877 | PXE_UINT16 DBsize;\r |
| | 878 | PXE_UINT64 CPBaddr;\r |
| | 879 | PXE_UINT64 DBaddr;\r |
| | 880 | PXE_STATCODE StatCode;\r |
| | 881 | PXE_STATFLAGS StatFlags;\r |
| | 882 | PXE_UINT16 IFnum;\r |
| | 883 | PXE_CONTROL Control;\r |
| | 884 | } PXE_CDB;\r |
| | 885 | \r |
| | 886 | typedef union u_pxe_ip_addr {\r |
| | 887 | PXE_IPV6 IPv6;\r |
| | 888 | PXE_IPV4 IPv4;\r |
| | 889 | } PXE_IP_ADDR;\r |
| | 890 | \r |
| | 891 | typedef union pxe_device {\r |
| | 892 | ///\r |
| | 893 | /// PCI and PC Card NICs are both identified using bus, device\r |
| | 894 | /// and function numbers. For PC Card, this may require PC\r |
| | 895 | /// Card services to be loaded in the BIOS or preboot\r |
| | 896 | /// environment.\r |
| | 897 | ///\r |
| | 898 | struct {\r |
| | 899 | ///\r |
| | 900 | /// See S/W UNDI ROMID structure definition for PCI and\r |
| | 901 | /// PCC BusType definitions.\r |
| | 902 | ///\r |
| | 903 | PXE_UINT32 BusType;\r |
| | 904 | \r |
| | 905 | ///\r |
| | 906 | /// Bus, device & function numbers that locate this device.\r |
| | 907 | ///\r |
| | 908 | PXE_UINT16 Bus;\r |
| | 909 | PXE_UINT8 Device;\r |
| | 910 | PXE_UINT8 Function;\r |
| | 911 | } PCI, PCC;\r |
| | 912 | } PXE_DEVICE;\r |
| | 913 | \r |
| | 914 | ///\r |
| | 915 | /// cpb and db definitions\r |
| | 916 | ///\r |
| | 917 | #define MAX_PCI_CONFIG_LEN 64 ///< # of dwords.\r |
| | 918 | #define MAX_EEPROM_LEN 128 ///< # of dwords.\r |
| | 919 | #define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done.\r |
| | 920 | #define MAX_MCAST_ADDRESS_CNT 8\r |
| | 921 | \r |
| | 922 | typedef struct s_pxe_cpb_start_30 {\r |
| | 923 | ///\r |
| | 924 | /// PXE_VOID Delay(UINTN microseconds);\r |
| | 925 | ///\r |
| | 926 | /// UNDI will never request a delay smaller than 10 microseconds\r |
| | 927 | /// and will always request delays in increments of 10 microseconds.\r |
| | 928 | /// The Delay() CallBack routine must delay between n and n + 10\r |
| | 929 | /// microseconds before returning control to the UNDI.\r |
| | 930 | ///\r |
| | 931 | /// This field cannot be set to zero.\r |
| | 932 | ///\r |
| | 933 | UINT64 Delay;\r |
| | 934 | \r |
| | 935 | ///\r |
| | 936 | /// PXE_VOID Block(UINT32 enable);\r |
| | 937 | ///\r |
| | 938 | /// UNDI may need to block multi-threaded/multi-processor access to\r |
| | 939 | /// critical code sections when programming or accessing the network\r |
| | 940 | /// device. To this end, a blocking service is needed by the UNDI.\r |
| | 941 | /// When UNDI needs a block, it will call Block() passing a non-zero\r |
| | 942 | /// value. When UNDI no longer needs a block, it will call Block()\r |
| | 943 | /// with a zero value. When called, if the Block() is already enabled,\r |
| | 944 | /// do not return control to the UNDI until the previous Block() is\r |
| | 945 | /// disabled.\r |
| | 946 | ///\r |
| | 947 | /// This field cannot be set to zero.\r |
| | 948 | ///\r |
| | 949 | UINT64 Block;\r |
| | 950 | \r |
| | 951 | ///\r |
| | 952 | /// PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);\r |
| | 953 | ///\r |
| | 954 | /// UNDI will pass the virtual address of a buffer and the virtual\r |
| | 955 | /// address of a 64-bit physical buffer. Convert the virtual address\r |
| | 956 | /// to a physical address and write the result to the physical address\r |
| | 957 | /// buffer. If virtual and physical addresses are the same, just\r |
| | 958 | /// copy the virtual address to the physical address buffer.\r |
| | 959 | ///\r |
| | 960 | /// This field can be set to zero if virtual and physical addresses\r |
| | 961 | /// are equal.\r |
| | 962 | ///\r |
| | 963 | UINT64 Virt2Phys;\r |
| | 964 | ///\r |
| | 965 | /// PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port,\r |
| | 966 | /// UINT64 buf_addr);\r |
| | 967 | ///\r |
| | 968 | /// UNDI will read or write the device io space using this call back\r |
| | 969 | /// function. It passes the number of bytes as the len parameter and it\r |
| | 970 | /// will be either 1,2,4 or 8.\r |
| | 971 | ///\r |
| | 972 | /// This field can not be set to zero.\r |
| | 973 | ///\r |
| | 974 | UINT64 Mem_IO;\r |
| | 975 | } PXE_CPB_START_30;\r |
| | 976 | \r |
| | 977 | typedef struct s_pxe_cpb_start_31 {\r |
| | 978 | ///\r |
| | 979 | /// PXE_VOID Delay(UINT64 UnqId, UINTN microseconds);\r |
| | 980 | ///\r |
| | 981 | /// UNDI will never request a delay smaller than 10 microseconds\r |
| | 982 | /// and will always request delays in increments of 10 microseconds.\r |
| | 983 | /// The Delay() CallBack routine must delay between n and n + 10\r |
| | 984 | /// microseconds before returning control to the UNDI.\r |
| | 985 | ///\r |
| | 986 | /// This field cannot be set to zero.\r |
| | 987 | ///\r |
| | 988 | UINT64 Delay;\r |
| | 989 | \r |
| | 990 | ///\r |
| | 991 | /// PXE_VOID Block(UINT64 unq_id, UINT32 enable);\r |
| | 992 | ///\r |
| | 993 | /// UNDI may need to block multi-threaded/multi-processor access to\r |
| | 994 | /// critical code sections when programming or accessing the network\r |
| | 995 | /// device. To this end, a blocking service is needed by the UNDI.\r |
| | 996 | /// When UNDI needs a block, it will call Block() passing a non-zero\r |
| | 997 | /// value. When UNDI no longer needs a block, it will call Block()\r |
| | 998 | /// with a zero value. When called, if the Block() is already enabled,\r |
| | 999 | /// do not return control to the UNDI until the previous Block() is\r |
| | 1000 | /// disabled.\r |
| | 1001 | ///\r |
| | 1002 | /// This field cannot be set to zero.\r |
| | 1003 | ///\r |
| | 1004 | UINT64 Block;\r |
| | 1005 | \r |
| | 1006 | ///\r |
| | 1007 | /// PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);\r |
| | 1008 | ///\r |
| | 1009 | /// UNDI will pass the virtual address of a buffer and the virtual\r |
| | 1010 | /// address of a 64-bit physical buffer. Convert the virtual address\r |
| | 1011 | /// to a physical address and write the result to the physical address\r |
| | 1012 | /// buffer. If virtual and physical addresses are the same, just\r |
| | 1013 | /// copy the virtual address to the physical address buffer.\r |
| | 1014 | ///\r |
| | 1015 | /// This field can be set to zero if virtual and physical addresses\r |
| | 1016 | /// are equal.\r |
| | 1017 | ///\r |
| | 1018 | UINT64 Virt2Phys;\r |
| | 1019 | ///\r |
| | 1020 | /// PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port,\r |
| | 1021 | /// UINT64 buf_addr);\r |
| | 1022 | ///\r |
| | 1023 | /// UNDI will read or write the device io space using this call back\r |
| | 1024 | /// function. It passes the number of bytes as the len parameter and it\r |
| | 1025 | /// will be either 1,2,4 or 8.\r |
| | 1026 | ///\r |
| | 1027 | /// This field can not be set to zero.\r |
| | 1028 | ///\r |
| | 1029 | UINT64 Mem_IO;\r |
| | 1030 | ///\r |
| | 1031 | /// PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,\r |
| | 1032 | /// UINT32 Direction, UINT64 mapped_addr);\r |
| | 1033 | ///\r |
| | 1034 | /// UNDI will pass the virtual address of a buffer, direction of the data\r |
| | 1035 | /// flow from/to the mapped buffer (the constants are defined below)\r |
| | 1036 | /// and a place holder (pointer) for the mapped address.\r |
| | 1037 | /// This call will Map the given address to a physical DMA address and write\r |
| | 1038 | /// the result to the mapped_addr pointer. If there is no need to\r |
| | 1039 | /// map the given address to a lower address (i.e. the given address is\r |
| | 1040 | /// associated with a physical address that is already compatible to be\r |
| | 1041 | /// used with the DMA, it converts the given virtual address to it's\r |
| | 1042 | /// physical address and write that in the mapped address pointer.\r |
| | 1043 | ///\r |
| | 1044 | /// This field can be set to zero if there is no mapping service available.\r |
| | 1045 | ///\r |
| | 1046 | UINT64 Map_Mem;\r |
| | 1047 | \r |
| | 1048 | ///\r |
| | 1049 | /// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,\r |
| | 1050 | /// UINT32 Direction, UINT64 mapped_addr);\r |
| | 1051 | ///\r |
| | 1052 | /// UNDI will pass the virtual and mapped addresses of a buffer.\r |
| | 1053 | /// This call will un map the given address.\r |
| | 1054 | ///\r |
| | 1055 | /// This field can be set to zero if there is no unmapping service available.\r |
| | 1056 | ///\r |
| | 1057 | UINT64 UnMap_Mem;\r |
| | 1058 | \r |
| | 1059 | ///\r |
| | 1060 | /// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,\r |
| | 1061 | /// UINT32 size, UINT32 Direction, UINT64 mapped_addr);\r |
| | 1062 | ///\r |
| | 1063 | /// UNDI will pass the virtual and mapped addresses of a buffer.\r |
| | 1064 | /// This call will synchronize the contents of both the virtual and mapped.\r |
| | 1065 | /// buffers for the given Direction.\r |
| | 1066 | ///\r |
| | 1067 | /// This field can be set to zero if there is no service available.\r |
| | 1068 | ///\r |
| | 1069 | UINT64 Sync_Mem;\r |
| | 1070 | \r |
| | 1071 | ///\r |
| | 1072 | /// protocol driver can provide anything for this Unique_ID, UNDI remembers\r |
| | 1073 | /// that as just a 64bit value associated to the interface specified by\r |
| | 1074 | /// the ifnum and gives it back as a parameter to all the call-back routines\r |
| | 1075 | /// when calling for that interface!\r |
| | 1076 | ///\r |
| | 1077 | UINT64 Unique_ID;\r |
| | 1078 | } PXE_CPB_START_31;\r |
| | 1079 | \r |
| | 1080 | #define TO_AND_FROM_DEVICE 0\r |
| | 1081 | #define FROM_DEVICE 1\r |
| | 1082 | #define TO_DEVICE 2\r |
| | 1083 | \r |
| | 1084 | #define PXE_DELAY_MILLISECOND 1000\r |
| | 1085 | #define PXE_DELAY_SECOND 1000000\r |
| | 1086 | #define PXE_IO_READ 0\r |
| | 1087 | #define PXE_IO_WRITE 1\r |
| | 1088 | #define PXE_MEM_READ 2\r |
| | 1089 | #define PXE_MEM_WRITE 4\r |
| | 1090 | \r |
| | 1091 | typedef struct s_pxe_db_get_init_info {\r |
| | 1092 | ///\r |
| | 1093 | /// Minimum length of locked memory buffer that must be given to\r |
| | 1094 | /// the Initialize command. Giving UNDI more memory will generally\r |
| | 1095 | /// give better performance.\r |
| | 1096 | ///\r |
| | 1097 | /// If MemoryRequired is zero, the UNDI does not need and will not\r |
| | 1098 | /// use system memory to receive and transmit packets.\r |
| | 1099 | ///\r |
| | 1100 | PXE_UINT32 MemoryRequired;\r |
| | 1101 | \r |
| | 1102 | ///\r |
| | 1103 | /// Maximum frame data length for Tx/Rx excluding the media header.\r |
| | 1104 | ///\r |
| | 1105 | PXE_UINT32 FrameDataLen;\r |
| | 1106 | \r |
| | 1107 | ///\r |
| | 1108 | /// Supported link speeds are in units of mega bits. Common ethernet\r |
| | 1109 | /// values are 10, 100 and 1000. Unused LinkSpeeds[] entries are zero\r |
| | 1110 | /// filled.\r |
| | 1111 | ///\r |
| | 1112 | PXE_UINT32 LinkSpeeds[4];\r |
| | 1113 | \r |
| | 1114 | ///\r |
| | 1115 | /// Number of non-volatile storage items.\r |
| | 1116 | ///\r |
| | 1117 | PXE_UINT32 NvCount;\r |
| | 1118 | \r |
| | 1119 | ///\r |
| | 1120 | /// Width of non-volatile storage item in bytes. 0, 1, 2 or 4\r |
| | 1121 | ///\r |
| | 1122 | PXE_UINT16 NvWidth;\r |
| | 1123 | \r |
| | 1124 | ///\r |
| | 1125 | /// Media header length. This is the typical media header length for\r |
| | 1126 | /// this UNDI. This information is needed when allocating receive\r |
| | 1127 | /// and transmit buffers.\r |
| | 1128 | ///\r |
| | 1129 | PXE_UINT16 MediaHeaderLen;\r |
| | 1130 | \r |
| | 1131 | ///\r |
| | 1132 | /// Number of bytes in the NIC hardware (MAC) address.\r |
| | 1133 | ///\r |
| | 1134 | PXE_UINT16 HWaddrLen;\r |
| | 1135 | \r |
| | 1136 | ///\r |
| | 1137 | /// Maximum number of multicast MAC addresses in the multicast\r |
| | 1138 | /// MAC address filter list.\r |
| | 1139 | ///\r |
| | 1140 | PXE_UINT16 MCastFilterCnt;\r |
| | 1141 | \r |
| | 1142 | ///\r |
| | 1143 | /// Default number and size of transmit and receive buffers that will\r |
| | 1144 | /// be allocated by the UNDI. If MemoryRequired is non-zero, this\r |
| | 1145 | /// allocation will come out of the memory buffer given to the Initialize\r |
| | 1146 | /// command. If MemoryRequired is zero, this allocation will come out of\r |
| | 1147 | /// memory on the NIC.\r |
| | 1148 | ///\r |
| | 1149 | PXE_UINT16 TxBufCnt;\r |
| | 1150 | PXE_UINT16 TxBufSize;\r |
| | 1151 | PXE_UINT16 RxBufCnt;\r |
| | 1152 | PXE_UINT16 RxBufSize;\r |
| | 1153 | \r |
| | 1154 | ///\r |
| | 1155 | /// Hardware interface types defined in the Assigned Numbers RFC\r |
| | 1156 | /// and used in DHCP and ARP packets.\r |
| | 1157 | /// See the PXE_IFTYPE typedef and PXE_IFTYPE_xxx macros.\r |
| | 1158 | ///\r |
| | 1159 | PXE_UINT8 IFtype;\r |
| | 1160 | \r |
| | 1161 | ///\r |
| | 1162 | /// Supported duplex. See PXE_DUPLEX_xxxxx #defines below.\r |
| | 1163 | ///\r |
| | 1164 | PXE_UINT8 SupportedDuplexModes;\r |
| | 1165 | \r |
| | 1166 | ///\r |
| | 1167 | /// Supported loopback options. See PXE_LOOPBACK_xxxxx #defines below.\r |
| | 1168 | ///\r |
| | 1169 | PXE_UINT8 SupportedLoopBackModes;\r |
| | 1170 | } PXE_DB_GET_INIT_INFO;\r |
| | 1171 | \r |
| | 1172 | #define PXE_MAX_TXRX_UNIT_ETHER 1500\r |
| | 1173 | \r |
| | 1174 | #define PXE_HWADDR_LEN_ETHER 0x0006\r |
| | 1175 | #define PXE_MAC_HEADER_LEN_ETHER 0x000E\r |
| | 1176 | \r |
| | 1177 | #define PXE_DUPLEX_ENABLE_FULL_SUPPORTED 1\r |
| | 1178 | #define PXE_DUPLEX_FORCE_FULL_SUPPORTED 2\r |
| | 1179 | \r |
| | 1180 | #define PXE_LOOPBACK_INTERNAL_SUPPORTED 1\r |
| | 1181 | #define PXE_LOOPBACK_EXTERNAL_SUPPORTED 2\r |
| | 1182 | \r |
| | 1183 | typedef struct s_pxe_pci_config_info {\r |
| | 1184 | ///\r |
| | 1185 | /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.\r |
| | 1186 | /// For PCI bus devices, this field is set to PXE_BUSTYPE_PCI.\r |
| | 1187 | ///\r |
| | 1188 | UINT32 BusType;\r |
| | 1189 | \r |
| | 1190 | ///\r |
| | 1191 | /// This identifies the PCI network device that this UNDI interface.\r |
| | 1192 | /// is bound to.\r |
| | 1193 | ///\r |
| | 1194 | UINT16 Bus;\r |
| | 1195 | UINT8 Device;\r |
| | 1196 | UINT8 Function;\r |
| | 1197 | \r |
| | 1198 | ///\r |
| | 1199 | /// This is a copy of the PCI configuration space for this\r |
| | 1200 | /// network device.\r |
| | 1201 | ///\r |
| | 1202 | union {\r |
| | 1203 | UINT8 Byte[256];\r |
| | 1204 | UINT16 Word[128];\r |
| | 1205 | UINT32 Dword[64];\r |
| | 1206 | } Config;\r |
| | 1207 | } PXE_PCI_CONFIG_INFO;\r |
| | 1208 | \r |
| | 1209 | typedef struct s_pxe_pcc_config_info {\r |
| | 1210 | ///\r |
| | 1211 | /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.\r |
| | 1212 | /// For PCC bus devices, this field is set to PXE_BUSTYPE_PCC.\r |
| | 1213 | ///\r |
| | 1214 | PXE_UINT32 BusType;\r |
| | 1215 | \r |
| | 1216 | ///\r |
| | 1217 | /// This identifies the PCC network device that this UNDI interface\r |
| | 1218 | /// is bound to.\r |
| | 1219 | ///\r |
| | 1220 | PXE_UINT16 Bus;\r |
| | 1221 | PXE_UINT8 Device;\r |
| | 1222 | PXE_UINT8 Function;\r |
| | 1223 | \r |
| | 1224 | ///\r |
| | 1225 | /// This is a copy of the PCC configuration space for this\r |
| | 1226 | /// network device.\r |
| | 1227 | ///\r |
| | 1228 | union {\r |
| | 1229 | PXE_UINT8 Byte[256];\r |
| | 1230 | PXE_UINT16 Word[128];\r |
| | 1231 | PXE_UINT32 Dword[64];\r |
| | 1232 | } Config;\r |
| | 1233 | } PXE_PCC_CONFIG_INFO;\r |
| | 1234 | \r |
| | 1235 | typedef union u_pxe_db_get_config_info {\r |
| | 1236 | PXE_PCI_CONFIG_INFO pci;\r |
| | 1237 | PXE_PCC_CONFIG_INFO pcc;\r |
| | 1238 | } PXE_DB_GET_CONFIG_INFO;\r |
| | 1239 | \r |
| | 1240 | typedef struct s_pxe_cpb_initialize {\r |
| | 1241 | ///\r |
| | 1242 | /// Address of first (lowest) byte of the memory buffer. This buffer must\r |
| | 1243 | /// be in contiguous physical memory and cannot be swapped out. The UNDI\r |
| | 1244 | /// will be using this for transmit and receive buffering.\r |
| | 1245 | ///\r |
| | 1246 | PXE_UINT64 MemoryAddr;\r |
| | 1247 | \r |
| | 1248 | ///\r |
| | 1249 | /// MemoryLength must be greater than or equal to MemoryRequired\r |
| | 1250 | /// returned by the Get Init Info command.\r |
| | 1251 | ///\r |
| | 1252 | PXE_UINT32 MemoryLength;\r |
| | 1253 | \r |
| | 1254 | ///\r |
| | 1255 | /// Desired link speed in Mbit/sec. Common ethernet values are 10, 100\r |
| | 1256 | /// and 1000. Setting a value of zero will auto-detect and/or use the\r |
| | 1257 | /// default link speed (operation depends on UNDI/NIC functionality).\r |
| | 1258 | ///\r |
| | 1259 | PXE_UINT32 LinkSpeed;\r |
| | 1260 | \r |
| | 1261 | ///\r |
| | 1262 | /// Suggested number and size of receive and transmit buffers to\r |
| | 1263 | /// allocate. If MemoryAddr and MemoryLength are non-zero, this\r |
| | 1264 | /// allocation comes out of the supplied memory buffer. If MemoryAddr\r |
| | 1265 | /// and MemoryLength are zero, this allocation comes out of memory\r |
| | 1266 | /// on the NIC.\r |
| | 1267 | ///\r |
| | 1268 | /// If these fields are set to zero, the UNDI will allocate buffer\r |
| | 1269 | /// counts and sizes as it sees fit.\r |
| | 1270 | ///\r |
| | 1271 | PXE_UINT16 TxBufCnt;\r |
| | 1272 | PXE_UINT16 TxBufSize;\r |
| | 1273 | PXE_UINT16 RxBufCnt;\r |
| | 1274 | PXE_UINT16 RxBufSize;\r |
| | 1275 | \r |
| | 1276 | ///\r |
| | 1277 | /// The following configuration parameters are optional and must be zero\r |
| | 1278 | /// to use the default values.\r |
| | 1279 | ///\r |
| | 1280 | PXE_UINT8 DuplexMode;\r |
| | 1281 | \r |
| | 1282 | PXE_UINT8 LoopBackMode;\r |
| | 1283 | } PXE_CPB_INITIALIZE;\r |
| | 1284 | \r |
| | 1285 | #define PXE_DUPLEX_DEFAULT 0x00\r |
| | 1286 | #define PXE_FORCE_FULL_DUPLEX 0x01\r |
| | 1287 | #define PXE_ENABLE_FULL_DUPLEX 0x02\r |
| | 1288 | #define PXE_FORCE_HALF_DUPLEX 0x04\r |
| | 1289 | #define PXE_DISABLE_FULL_DUPLEX 0x08\r |
| | 1290 | \r |
| | 1291 | #define LOOPBACK_NORMAL 0\r |
| | 1292 | #define LOOPBACK_INTERNAL 1\r |
| | 1293 | #define LOOPBACK_EXTERNAL 2\r |
| | 1294 | \r |
| | 1295 | typedef struct s_pxe_db_initialize {\r |
| | 1296 | ///\r |
| | 1297 | /// Actual amount of memory used from the supplied memory buffer. This\r |
| | 1298 | /// may be less that the amount of memory suppllied and may be zero if\r |
| | 1299 | /// the UNDI and network device do not use external memory buffers.\r |
| | 1300 | ///\r |
| | 1301 | /// Memory used by the UNDI and network device is allocated from the\r |
| | 1302 | /// lowest memory buffer address.\r |
| | 1303 | ///\r |
| | 1304 | PXE_UINT32 MemoryUsed;\r |
| | 1305 | \r |
| | 1306 | ///\r |
| | 1307 | /// Actual number and size of receive and transmit buffers that were\r |
| | 1308 | /// allocated.\r |
| | 1309 | ///\r |
| | 1310 | PXE_UINT16 TxBufCnt;\r |
| | 1311 | PXE_UINT16 TxBufSize;\r |
| | 1312 | PXE_UINT16 RxBufCnt;\r |
| | 1313 | PXE_UINT16 RxBufSize;\r |
| | 1314 | } PXE_DB_INITIALIZE;\r |
| | 1315 | \r |
| | 1316 | typedef struct s_pxe_cpb_receive_filters {\r |
| | 1317 | ///\r |
| | 1318 | /// List of multicast MAC addresses. This list, if present, will\r |
| | 1319 | /// replace the existing multicast MAC address filter list.\r |
| | 1320 | ///\r |
| | 1321 | PXE_MAC_ADDR MCastList[MAX_MCAST_ADDRESS_CNT];\r |
| | 1322 | } PXE_CPB_RECEIVE_FILTERS;\r |
| | 1323 | \r |
| | 1324 | typedef struct s_pxe_db_receive_filters {\r |
| | 1325 | ///\r |
| | 1326 | /// Filtered multicast MAC address list.\r |
| | 1327 | ///\r |
| | 1328 | PXE_MAC_ADDR MCastList[MAX_MCAST_ADDRESS_CNT];\r |
| | 1329 | } PXE_DB_RECEIVE_FILTERS;\r |
| | 1330 | \r |
| | 1331 | typedef struct s_pxe_cpb_station_address {\r |
| | 1332 | ///\r |
| | 1333 | /// If supplied and supported, the current station MAC address\r |
| | 1334 | /// will be changed.\r |
| | 1335 | ///\r |
| | 1336 | PXE_MAC_ADDR StationAddr;\r |
| | 1337 | } PXE_CPB_STATION_ADDRESS;\r |
| | 1338 | \r |
| | 1339 | typedef struct s_pxe_dpb_station_address {\r |
| | 1340 | ///\r |
| | 1341 | /// Current station MAC address.\r |
| | 1342 | ///\r |
| | 1343 | PXE_MAC_ADDR StationAddr;\r |
| | 1344 | \r |
| | 1345 | ///\r |
| | 1346 | /// Station broadcast MAC address.\r |
| | 1347 | ///\r |
| | 1348 | PXE_MAC_ADDR BroadcastAddr;\r |
| | 1349 | \r |
| | 1350 | ///\r |
| | 1351 | /// Permanent station MAC address.\r |
| | 1352 | ///\r |
| | 1353 | PXE_MAC_ADDR PermanentAddr;\r |
| | 1354 | } PXE_DB_STATION_ADDRESS;\r |
| | 1355 | \r |
| | 1356 | typedef struct s_pxe_db_statistics {\r |
| | 1357 | ///\r |
| | 1358 | /// Bit field identifying what statistic data is collected by the\r |
| | 1359 | /// UNDI/NIC.\r |
| | 1360 | /// If bit 0x00 is set, Data[0x00] is collected.\r |
| | 1361 | /// If bit 0x01 is set, Data[0x01] is collected.\r |
| | 1362 | /// If bit 0x20 is set, Data[0x20] is collected.\r |
| | 1363 | /// If bit 0x21 is set, Data[0x21] is collected.\r |
| | 1364 | /// Etc.\r |
| | 1365 | ///\r |
| | 1366 | PXE_UINT64 Supported;\r |
| | 1367 | \r |
| | 1368 | ///\r |
| | 1369 | /// Statistic data.\r |
| | 1370 | ///\r |
| | 1371 | PXE_UINT64 Data[64];\r |
| | 1372 | } PXE_DB_STATISTICS;\r |
| | 1373 | \r |
| | 1374 | ///\r |
| | 1375 | /// Total number of frames received. Includes frames with errors and\r |
| | 1376 | /// dropped frames.\r |
| | 1377 | ///\r |
| | 1378 | #define PXE_STATISTICS_RX_TOTAL_FRAMES 0x00\r |
| | 1379 | \r |
| | 1380 | ///\r |
| | 1381 | /// Number of valid frames received and copied into receive buffers.\r |
| | 1382 | ///\r |
| | 1383 | #define PXE_STATISTICS_RX_GOOD_FRAMES 0x01\r |
| | 1384 | \r |
| | 1385 | ///\r |
| | 1386 | /// Number of frames below the minimum length for the media.\r |
| | 1387 | /// This would be <64 for ethernet.\r |
| | 1388 | ///\r |
| | 1389 | #define PXE_STATISTICS_RX_UNDERSIZE_FRAMES 0x02\r |
| | 1390 | \r |
| | 1391 | ///\r |
| | 1392 | /// Number of frames longer than the maxminum length for the\r |
| | 1393 | /// media. This would be >1500 for ethernet.\r |
| | 1394 | ///\r |
| | 1395 | #define PXE_STATISTICS_RX_OVERSIZE_FRAMES 0x03\r |
| | 1396 | \r |
| | 1397 | ///\r |
| | 1398 | /// Valid frames that were dropped because receive buffers were full.\r |
| | 1399 | ///\r |
| | 1400 | #define PXE_STATISTICS_RX_DROPPED_FRAMES 0x04\r |
| | 1401 | \r |
| | 1402 | ///\r |
| | 1403 | /// Number of valid unicast frames received and not dropped.\r |
| | 1404 | ///\r |
| | 1405 | #define PXE_STATISTICS_RX_UNICAST_FRAMES 0x05\r |
| | 1406 | \r |
| | 1407 | ///\r |
| | 1408 | /// Number of valid broadcast frames received and not dropped.\r |
| | 1409 | ///\r |
| | 1410 | #define PXE_STATISTICS_RX_BROADCAST_FRAMES 0x06\r |
| | 1411 | \r |
| | 1412 | ///\r |
| | 1413 | /// Number of valid mutlicast frames received and not dropped.\r |
| | 1414 | ///\r |
| | 1415 | #define PXE_STATISTICS_RX_MULTICAST_FRAMES 0x07\r |
| | 1416 | \r |
| | 1417 | ///\r |
| | 1418 | /// Number of frames w/ CRC or alignment errors.\r |
| | 1419 | ///\r |
| | 1420 | #define PXE_STATISTICS_RX_CRC_ERROR_FRAMES 0x08\r |
| | 1421 | \r |
| | 1422 | ///\r |
| | 1423 | /// Total number of bytes received. Includes frames with errors\r |
| | 1424 | /// and dropped frames.\r |
| | 1425 | ///\r |
| | 1426 | #define PXE_STATISTICS_RX_TOTAL_BYTES 0x09\r |
| | 1427 | \r |
| | 1428 | ///\r |
| | 1429 | /// Transmit statistics.\r |
| | 1430 | ///\r |
| | 1431 | #define PXE_STATISTICS_TX_TOTAL_FRAMES 0x0A\r |
| | 1432 | #define PXE_STATISTICS_TX_GOOD_FRAMES 0x0B\r |
| | 1433 | #define PXE_STATISTICS_TX_UNDERSIZE_FRAMES 0x0C\r |
| | 1434 | #define PXE_STATISTICS_TX_OVERSIZE_FRAMES 0x0D\r |
| | 1435 | #define PXE_STATISTICS_TX_DROPPED_FRAMES 0x0E\r |
| | 1436 | #define PXE_STATISTICS_TX_UNICAST_FRAMES 0x0F\r |
| | 1437 | #define PXE_STATISTICS_TX_BROADCAST_FRAMES 0x10\r |
| | 1438 | #define PXE_STATISTICS_TX_MULTICAST_FRAMES 0x11\r |
| | 1439 | #define PXE_STATISTICS_TX_CRC_ERROR_FRAMES 0x12\r |
| | 1440 | #define PXE_STATISTICS_TX_TOTAL_BYTES 0x13\r |
| | 1441 | \r |
| | 1442 | ///\r |
| | 1443 | /// Number of collisions detection on this subnet.\r |
| | 1444 | ///\r |
| | 1445 | #define PXE_STATISTICS_COLLISIONS 0x14\r |
| | 1446 | \r |
| | 1447 | ///\r |
| | 1448 | /// Number of frames destined for unsupported protocol.\r |
| | 1449 | ///\r |
| | 1450 | #define PXE_STATISTICS_UNSUPPORTED_PROTOCOL 0x15\r |
| | 1451 | \r |
| | 1452 | ///\r |
| | 1453 | /// Number of valid frames received that were duplicated.\r |
| | 1454 | ///\r |
| | 1455 | #define PXE_STATISTICS_RX_DUPLICATED_FRAMES 0x16\r |
| | 1456 | \r |
| | 1457 | ///\r |
| | 1458 | /// Number of encrypted frames received that failed to decrypt.\r |
| | 1459 | ///\r |
| | 1460 | #define PXE_STATISTICS_RX_DECRYPT_ERROR_FRAMES 0x17\r |
| | 1461 | \r |
| | 1462 | ///\r |
| | 1463 | /// Number of frames that failed to transmit after exceeding the retry limit.\r |
| | 1464 | ///\r |
| | 1465 | #define PXE_STATISTICS_TX_ERROR_FRAMES 0x18\r |
| | 1466 | \r |
| | 1467 | ///\r |
| | 1468 | /// Number of frames transmitted successfully after more than one attempt.\r |
| | 1469 | ///\r |
| | 1470 | #define PXE_STATISTICS_TX_RETRY_FRAMES 0x19\r |
| | 1471 | \r |
| | 1472 | typedef struct s_pxe_cpb_mcast_ip_to_mac {\r |
| | 1473 | ///\r |
| | 1474 | /// Multicast IP address to be converted to multicast MAC address.\r |
| | 1475 | ///\r |
| | 1476 | PXE_IP_ADDR IP;\r |
| | 1477 | } PXE_CPB_MCAST_IP_TO_MAC;\r |
| | 1478 | \r |
| | 1479 | typedef struct s_pxe_db_mcast_ip_to_mac {\r |
| | 1480 | ///\r |
| | 1481 | /// Multicast MAC address.\r |
| | 1482 | ///\r |
| | 1483 | PXE_MAC_ADDR MAC;\r |
| | 1484 | } PXE_DB_MCAST_IP_TO_MAC;\r |
| | 1485 | \r |
| | 1486 | typedef struct s_pxe_cpb_nvdata_sparse {\r |
| | 1487 | ///\r |
| | 1488 | /// NvData item list. Only items in this list will be updated.\r |
| | 1489 | ///\r |
| | 1490 | struct {\r |
| | 1491 | ///\r |
| | 1492 | /// Non-volatile storage address to be changed.\r |
| | 1493 | ///\r |
| | 1494 | PXE_UINT32 Addr;\r |
| | 1495 | \r |
| | 1496 | ///\r |
| | 1497 | /// Data item to write into above storage address.\r |
| | 1498 | ///\r |
| | 1499 | union {\r |
| | 1500 | PXE_UINT8 Byte;\r |
| | 1501 | PXE_UINT16 Word;\r |
| | 1502 | PXE_UINT32 Dword;\r |
| | 1503 | } Data;\r |
| | 1504 | } Item[MAX_EEPROM_LEN];\r |
| | 1505 | } PXE_CPB_NVDATA_SPARSE;\r |
| | 1506 | \r |
| | 1507 | ///\r |
| | 1508 | /// When using bulk update, the size of the CPB structure must be\r |
| | 1509 | /// the same size as the non-volatile NIC storage.\r |
| | 1510 | ///\r |
| | 1511 | typedef union u_pxe_cpb_nvdata_bulk {\r |
| | 1512 | ///\r |
| | 1513 | /// Array of byte-wide data items.\r |
| | 1514 | ///\r |
| | 1515 | PXE_UINT8 Byte[MAX_EEPROM_LEN << 2];\r |
| | 1516 | \r |
| | 1517 | ///\r |
| | 1518 | /// Array of word-wide data items.\r |
| | 1519 | ///\r |
| | 1520 | PXE_UINT16 Word[MAX_EEPROM_LEN << 1];\r |
| | 1521 | \r |
| | 1522 | ///\r |
| | 1523 | /// Array of dword-wide data items.\r |
| | 1524 | ///\r |
| | 1525 | PXE_UINT32 Dword[MAX_EEPROM_LEN];\r |
| | 1526 | } PXE_CPB_NVDATA_BULK;\r |
| | 1527 | \r |
| | 1528 | typedef struct s_pxe_db_nvdata {\r |
| | 1529 | ///\r |
| | 1530 | /// Arrays of data items from non-volatile storage.\r |
| | 1531 | ///\r |
| | 1532 | union {\r |
| | 1533 | ///\r |
| | 1534 | /// Array of byte-wide data items.\r |
| | 1535 | ///\r |
| | 1536 | PXE_UINT8 Byte[MAX_EEPROM_LEN << 2];\r |
| | 1537 | \r |
| | 1538 | ///\r |
| | 1539 | /// Array of word-wide data items.\r |
| | 1540 | ///\r |
| | 1541 | PXE_UINT16 Word[MAX_EEPROM_LEN << 1];\r |
| | 1542 | \r |
| | 1543 | ///\r |
| | 1544 | /// Array of dword-wide data items.\r |
| | 1545 | ///\r |
| | 1546 | PXE_UINT32 Dword[MAX_EEPROM_LEN];\r |
| | 1547 | } Data;\r |
| | 1548 | } PXE_DB_NVDATA;\r |
| | 1549 | \r |
| | 1550 | typedef struct s_pxe_db_get_status {\r |
| | 1551 | ///\r |
| | 1552 | /// Length of next receive frame (header + data). If this is zero,\r |
| | 1553 | /// there is no next receive frame available.\r |
| | 1554 | ///\r |
| | 1555 | PXE_UINT32 RxFrameLen;\r |
| | 1556 | \r |
| | 1557 | ///\r |
| | 1558 | /// Reserved, set to zero.\r |
| | 1559 | ///\r |
| | 1560 | PXE_UINT32 reserved;\r |
| | 1561 | \r |
| | 1562 | ///\r |
| | 1563 | /// Addresses of transmitted buffers that need to be recycled.\r |
| | 1564 | ///\r |
| | 1565 | PXE_UINT64 TxBuffer[MAX_XMIT_BUFFERS];\r |
| | 1566 | } PXE_DB_GET_STATUS;\r |
| | 1567 | \r |
| | 1568 | typedef struct s_pxe_cpb_fill_header {\r |
| | 1569 | ///\r |
| | 1570 | /// Source and destination MAC addresses. These will be copied into\r |
| | 1571 | /// the media header without doing byte swapping.\r |
| | 1572 | ///\r |
| | 1573 | PXE_MAC_ADDR SrcAddr;\r |
| | 1574 | PXE_MAC_ADDR DestAddr;\r |
| | 1575 | \r |
| | 1576 | ///\r |
| | 1577 | /// Address of first byte of media header. The first byte of packet data\r |
| | 1578 | /// follows the last byte of the media header.\r |
| | 1579 | ///\r |
| | 1580 | PXE_UINT64 MediaHeader;\r |
| | 1581 | \r |
| | 1582 | ///\r |
| | 1583 | /// Length of packet data in bytes (not including the media header).\r |
| | 1584 | ///\r |
| | 1585 | PXE_UINT32 PacketLen;\r |
| | 1586 | \r |
| | 1587 | ///\r |
| | 1588 | /// Protocol type. This will be copied into the media header without\r |
| | 1589 | /// doing byte swapping. Protocol type numbers can be obtained from\r |
| | 1590 | /// the Assigned Numbers RFC 1700.\r |
| | 1591 | ///\r |
| | 1592 | PXE_UINT16 Protocol;\r |
| | 1593 | \r |
| | 1594 | ///\r |
| | 1595 | /// Length of the media header in bytes.\r |
| | 1596 | ///\r |
| | 1597 | PXE_UINT16 MediaHeaderLen;\r |
| | 1598 | } PXE_CPB_FILL_HEADER;\r |
| | 1599 | \r |
| | 1600 | #define PXE_PROTOCOL_ETHERNET_IP 0x0800\r |
| | 1601 | #define PXE_PROTOCOL_ETHERNET_ARP 0x0806\r |
| | 1602 | #define MAX_XMIT_FRAGMENTS 16\r |
| | 1603 | \r |
| | 1604 | typedef struct s_pxe_cpb_fill_header_fragmented {\r |
| | 1605 | ///\r |
| | 1606 | /// Source and destination MAC addresses. These will be copied into\r |
| | 1607 | /// the media header without doing byte swapping.\r |
| | 1608 | ///\r |
| | 1609 | PXE_MAC_ADDR SrcAddr;\r |
| | 1610 | PXE_MAC_ADDR DestAddr;\r |
| | 1611 | \r |
| | 1612 | ///\r |
| | 1613 | /// Length of packet data in bytes (not including the media header).\r |
| | 1614 | ///\r |
| | 1615 | PXE_UINT32 PacketLen;\r |
| | 1616 | \r |
| | 1617 | ///\r |
| | 1618 | /// Protocol type. This will be copied into the media header without\r |
| | 1619 | /// doing byte swapping. Protocol type numbers can be obtained from\r |
| | 1620 | /// the Assigned Numbers RFC 1700.\r |
| | 1621 | ///\r |
| | 1622 | PXE_MEDIA_PROTOCOL Protocol;\r |
| | 1623 | \r |
| | 1624 | ///\r |
| | 1625 | /// Length of the media header in bytes.\r |
| | 1626 | ///\r |
| | 1627 | PXE_UINT16 MediaHeaderLen;\r |
| | 1628 | \r |
| | 1629 | ///\r |
| | 1630 | /// Number of packet fragment descriptors.\r |
| | 1631 | ///\r |
| | 1632 | PXE_UINT16 FragCnt;\r |
| | 1633 | \r |
| | 1634 | ///\r |
| | 1635 | /// Reserved, must be set to zero.\r |
| | 1636 | ///\r |
| | 1637 | PXE_UINT16 reserved;\r |
| | 1638 | \r |
| | 1639 | ///\r |
| | 1640 | /// Array of packet fragment descriptors. The first byte of the media\r |
| | 1641 | /// header is the first byte of the first fragment.\r |
| | 1642 | ///\r |
| | 1643 | struct {\r |
| | 1644 | ///\r |
| | 1645 | /// Address of this packet fragment.\r |
| | 1646 | ///\r |
| | 1647 | PXE_UINT64 FragAddr;\r |
| | 1648 | \r |
| | 1649 | ///\r |
| | 1650 | /// Length of this packet fragment.\r |
| | 1651 | ///\r |
| | 1652 | PXE_UINT32 FragLen;\r |
| | 1653 | \r |
| | 1654 | ///\r |
| | 1655 | /// Reserved, must be set to zero.\r |
| | 1656 | ///\r |
| | 1657 | PXE_UINT32 reserved;\r |
| | 1658 | } FragDesc[MAX_XMIT_FRAGMENTS];\r |
| | 1659 | } PXE_CPB_FILL_HEADER_FRAGMENTED;\r |
| | 1660 | \r |
| | 1661 | typedef struct s_pxe_cpb_transmit {\r |
| | 1662 | ///\r |
| | 1663 | /// Address of first byte of frame buffer. This is also the first byte\r |
| | 1664 | /// of the media header.\r |
| | 1665 | ///\r |
| | 1666 | PXE_UINT64 FrameAddr;\r |
| | 1667 | \r |
| | 1668 | ///\r |
| | 1669 | /// Length of the data portion of the frame buffer in bytes. Do not\r |
| | 1670 | /// include the length of the media header.\r |
| | 1671 | ///\r |
| | 1672 | PXE_UINT32 DataLen;\r |
| | 1673 | \r |
| | 1674 | ///\r |
| | 1675 | /// Length of the media header in bytes.\r |
| | 1676 | ///\r |
| | 1677 | PXE_UINT16 MediaheaderLen;\r |
| | 1678 | \r |
| | 1679 | ///\r |
| | 1680 | /// Reserved, must be zero.\r |
| | 1681 | ///\r |
| | 1682 | PXE_UINT16 reserved;\r |
| | 1683 | } PXE_CPB_TRANSMIT;\r |
| | 1684 | \r |
| | 1685 | typedef struct s_pxe_cpb_transmit_fragments {\r |
| | 1686 | ///\r |
| | 1687 | /// Length of packet data in bytes (not including the media header).\r |
| | 1688 | ///\r |
| | 1689 | PXE_UINT32 FrameLen;\r |
| | 1690 | \r |
| | 1691 | ///\r |
| | 1692 | /// Length of the media header in bytes.\r |
| | 1693 | ///\r |
| | 1694 | PXE_UINT16 MediaheaderLen;\r |
| | 1695 | \r |
| | 1696 | ///\r |
| | 1697 | /// Number of packet fragment descriptors.\r |
| | 1698 | ///\r |
| | 1699 | PXE_UINT16 FragCnt;\r |
| | 1700 | \r |
| | 1701 | ///\r |
| | 1702 | /// Array of frame fragment descriptors. The first byte of the first\r |
| | 1703 | /// fragment is also the first byte of the media header.\r |
| | 1704 | ///\r |
| | 1705 | struct {\r |
| | 1706 | ///\r |
| | 1707 | /// Address of this frame fragment.\r |
| | 1708 | ///\r |
| | 1709 | PXE_UINT64 FragAddr;\r |
| | 1710 | \r |
| | 1711 | ///\r |
| | 1712 | /// Length of this frame fragment.\r |
| | 1713 | ///\r |
| | 1714 | PXE_UINT32 FragLen;\r |
| | 1715 | \r |
| | 1716 | ///\r |
| | 1717 | /// Reserved, must be set to zero.\r |
| | 1718 | ///\r |
| | 1719 | PXE_UINT32 reserved;\r |
| | 1720 | } FragDesc[MAX_XMIT_FRAGMENTS];\r |
| | 1721 | } PXE_CPB_TRANSMIT_FRAGMENTS;\r |
| | 1722 | \r |
| | 1723 | typedef struct s_pxe_cpb_receive {\r |
| | 1724 | ///\r |
| | 1725 | /// Address of first byte of receive buffer. This is also the first byte\r |
| | 1726 | /// of the frame header.\r |
| | 1727 | ///\r |
| | 1728 | PXE_UINT64 BufferAddr;\r |
| | 1729 | \r |
| | 1730 | ///\r |
| | 1731 | /// Length of receive buffer. This must be large enough to hold the\r |
| | 1732 | /// received frame (media header + data). If the length of smaller than\r |
| | 1733 | /// the received frame, data will be lost.\r |
| | 1734 | ///\r |
| | 1735 | PXE_UINT32 BufferLen;\r |
| | 1736 | \r |
| | 1737 | ///\r |
| | 1738 | /// Reserved, must be set to zero.\r |
| | 1739 | ///\r |
| | 1740 | PXE_UINT32 reserved;\r |
| | 1741 | } PXE_CPB_RECEIVE;\r |
| | 1742 | \r |
| | 1743 | typedef struct s_pxe_db_receive {\r |
| | 1744 | ///\r |
| | 1745 | /// Source and destination MAC addresses from media header.\r |
| | 1746 | ///\r |
| | 1747 | PXE_MAC_ADDR SrcAddr;\r |
| | 1748 | PXE_MAC_ADDR DestAddr;\r |
| | 1749 | \r |
| | 1750 | ///\r |
| | 1751 | /// Length of received frame. May be larger than receive buffer size.\r |
| | 1752 | /// The receive buffer will not be overwritten. This is how to tell\r |
| | 1753 | /// if data was lost because the receive buffer was too small.\r |
| | 1754 | ///\r |
| | 1755 | PXE_UINT32 FrameLen;\r |
| | 1756 | \r |
| | 1757 | ///\r |
| | 1758 | /// Protocol type from media header.\r |
| | 1759 | ///\r |
| | 1760 | PXE_MEDIA_PROTOCOL Protocol;\r |
| | 1761 | \r |
| | 1762 | ///\r |
| | 1763 | /// Length of media header in received frame.\r |
| | 1764 | ///\r |
| | 1765 | PXE_UINT16 MediaHeaderLen;\r |
| | 1766 | \r |
| | 1767 | ///\r |
| | 1768 | /// Type of receive frame.\r |
| | 1769 | ///\r |
| | 1770 | PXE_FRAME_TYPE Type;\r |
| | 1771 | \r |
| | 1772 | ///\r |
| | 1773 | /// Reserved, must be zero.\r |
| | 1774 | ///\r |
| | 1775 | PXE_UINT8 reserved[7];\r |
| | 1776 | } PXE_DB_RECEIVE;\r |
| | 1777 | \r |
| | 1778 | #pragma pack()\r |
| | 1779 | \r |
| | 1780 | #endif\r |
projects / mirror_edk2.git / blame_incremental