123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770 |
- /** @file
- This header file contains all of the PXE type definitions,
- structure prototypes, global variables and constants that
- are needed for porting PXE to EFI.
-
- Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
- This program and the accompanying materials are licensed and made available under
- the terms and conditions of the BSD License that accompanies this distribution.
- The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php.
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- 32/64-bit PXE specification:
- alpha-4, 99-Dec-17.
-
- **/
-
- #ifndef __EFI_PXE_H__
- #define __EFI_PXE_H__
-
- #pragma pack(1)
-
- #define PXE_BUSTYPE(a, b, c, d) \
- ( \
- (((PXE_UINT32) (d) & 0xFF) << 24) | (((PXE_UINT32) (c) & 0xFF) << 16) | (((PXE_UINT32) (b) & 0xFF) << 8) | \
- ((PXE_UINT32) (a) & 0xFF) \
- )
-
- ///
- /// UNDI ROM ID and devive ID signature.
- ///
- #define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')
-
- ///
- /// BUS ROM ID signatures.
- ///
- #define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')
- #define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')
- #define PXE_BUSTYPE_USB PXE_BUSTYPE ('U', 'S', 'B', 'R')
- #define PXE_BUSTYPE_1394 PXE_BUSTYPE ('1', '3', '9', '4')
-
- #define PXE_SWAP_UINT16(n) ((((PXE_UINT16) (n) & 0x00FF) << 8) | (((PXE_UINT16) (n) & 0xFF00) >> 8))
-
- #define PXE_SWAP_UINT32(n) \
- ((((PXE_UINT32)(n) & 0x000000FF) << 24) | \
- (((PXE_UINT32)(n) & 0x0000FF00) << 8) | \
- (((PXE_UINT32)(n) & 0x00FF0000) >> 8) | \
- (((PXE_UINT32)(n) & 0xFF000000) >> 24))
-
- #define PXE_SWAP_UINT64(n) \
- ((((PXE_UINT64)(n) & 0x00000000000000FFULL) << 56) | \
- (((PXE_UINT64)(n) & 0x000000000000FF00ULL) << 40) | \
- (((PXE_UINT64)(n) & 0x0000000000FF0000ULL) << 24) | \
- (((PXE_UINT64)(n) & 0x00000000FF000000ULL) << 8) | \
- (((PXE_UINT64)(n) & 0x000000FF00000000ULL) >> 8) | \
- (((PXE_UINT64)(n) & 0x0000FF0000000000ULL) >> 24) | \
- (((PXE_UINT64)(n) & 0x00FF000000000000ULL) >> 40) | \
- (((PXE_UINT64)(n) & 0xFF00000000000000ULL) >> 56))
-
-
- #define PXE_CPBSIZE_NOT_USED 0 ///< zero
- #define PXE_DBSIZE_NOT_USED 0 ///< zero
- #define PXE_CPBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
- #define PXE_DBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
- #define PXE_CONST CONST
-
- #define PXE_VOLATILE volatile
-
- typedef VOID PXE_VOID;
- typedef UINT8 PXE_UINT8;
- typedef UINT16 PXE_UINT16;
- typedef UINT32 PXE_UINT32;
- typedef UINTN PXE_UINTN;
-
- ///
- /// Typedef unsigned long PXE_UINT64.
- ///
- typedef UINT64 PXE_UINT64;
-
- typedef PXE_UINT8 PXE_BOOL;
- #define PXE_FALSE 0 ///< zero
- #define PXE_TRUE (!PXE_FALSE)
-
- typedef PXE_UINT16 PXE_OPCODE;
-
- ///
- /// Return UNDI operational state.
- ///
- #define PXE_OPCODE_GET_STATE 0x0000
-
- ///
- /// Change UNDI operational state from Stopped to Started.
- ///
- #define PXE_OPCODE_START 0x0001
-
- ///
- /// Change UNDI operational state from Started to Stopped.
- ///
- #define PXE_OPCODE_STOP 0x0002
-
- ///
- /// Get UNDI initialization information.
- ///
- #define PXE_OPCODE_GET_INIT_INFO 0x0003
-
- ///
- /// Get NIC configuration information.
- ///
- #define PXE_OPCODE_GET_CONFIG_INFO 0x0004
-
- ///
- /// Changed UNDI operational state from Started to Initialized.
- ///
- #define PXE_OPCODE_INITIALIZE 0x0005
-
- ///
- /// Re-initialize the NIC H/W.
- ///
- #define PXE_OPCODE_RESET 0x0006
-
- ///
- /// Change the UNDI operational state from Initialized to Started.
- ///
- #define PXE_OPCODE_SHUTDOWN 0x0007
-
- ///
- /// Read & change state of external interrupt enables.
- ///
- #define PXE_OPCODE_INTERRUPT_ENABLES 0x0008
-
- ///
- /// Read & change state of packet receive filters.
- ///
- #define PXE_OPCODE_RECEIVE_FILTERS 0x0009
-
- ///
- /// Read & change station MAC address.
- ///
- #define PXE_OPCODE_STATION_ADDRESS 0x000A
-
- ///
- /// Read traffic statistics.
- ///
- #define PXE_OPCODE_STATISTICS 0x000B
-
- ///
- /// Convert multicast IP address to multicast MAC address.
- ///
- #define PXE_OPCODE_MCAST_IP_TO_MAC 0x000C
-
- ///
- /// Read or change non-volatile storage on the NIC.
- ///
- #define PXE_OPCODE_NVDATA 0x000D
-
- ///
- /// Get & clear interrupt status.
- ///
- #define PXE_OPCODE_GET_STATUS 0x000E
-
- ///
- /// Fill media header in packet for transmit.
- ///
- #define PXE_OPCODE_FILL_HEADER 0x000F
-
- ///
- /// Transmit packet(s).
- ///
- #define PXE_OPCODE_TRANSMIT 0x0010
-
- ///
- /// Receive packet.
- ///
- #define PXE_OPCODE_RECEIVE 0x0011
-
- ///
- /// Last valid PXE UNDI OpCode number.
- ///
- #define PXE_OPCODE_LAST_VALID 0x0011
-
- typedef PXE_UINT16 PXE_OPFLAGS;
-
- #define PXE_OPFLAGS_NOT_USED 0x0000
-
- //
- // //////////////////////////////////////
- // UNDI Get State
- //
- // No OpFlags
-
- ////////////////////////////////////////
- // UNDI Start
- //
- // No OpFlags
-
- ////////////////////////////////////////
- // UNDI Stop
- //
- // No OpFlags
-
- ////////////////////////////////////////
- // UNDI Get Init Info
- //
- // No Opflags
-
- ////////////////////////////////////////
- // UNDI Get Config Info
- //
- // No Opflags
-
- ///
- /// UNDI Initialize
- ///
- #define PXE_OPFLAGS_INITIALIZE_CABLE_DETECT_MASK 0x0001
- #define PXE_OPFLAGS_INITIALIZE_DETECT_CABLE 0x0000
- #define PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE 0x0001
-
- ///
- ///
- /// UNDI Reset
- ///
- #define PXE_OPFLAGS_RESET_DISABLE_INTERRUPTS 0x0001
- #define PXE_OPFLAGS_RESET_DISABLE_FILTERS 0x0002
-
- ///
- /// UNDI Shutdown.
- ///
- /// No OpFlags.
-
- ///
- /// UNDI Interrupt Enables.
- ///
- ///
- /// Select whether to enable or disable external interrupt signals.
- /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPFLAGS.
- ///
- #define PXE_OPFLAGS_INTERRUPT_OPMASK 0xC000
- #define PXE_OPFLAGS_INTERRUPT_ENABLE 0x8000
- #define PXE_OPFLAGS_INTERRUPT_DISABLE 0x4000
- #define PXE_OPFLAGS_INTERRUPT_READ 0x0000
-
- ///
- /// Enable receive interrupts. An external interrupt will be generated
- /// after a complete non-error packet has been received.
- ///
- #define PXE_OPFLAGS_INTERRUPT_RECEIVE 0x0001
-
- ///
- /// Enable transmit interrupts. An external interrupt will be generated
- /// after a complete non-error packet has been transmitted.
- ///
- #define PXE_OPFLAGS_INTERRUPT_TRANSMIT 0x0002
-
- ///
- /// Enable command interrupts. An external interrupt will be generated
- /// when command execution stops.
- ///
- #define PXE_OPFLAGS_INTERRUPT_COMMAND 0x0004
-
- ///
- /// Generate software interrupt. Setting this bit generates an external
- /// interrupt, if it is supported by the hardware.
- ///
- #define PXE_OPFLAGS_INTERRUPT_SOFTWARE 0x0008
-
- ///
- /// UNDI Receive Filters.
- ///
- ///
- /// Select whether to enable or disable receive filters.
- /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPCODE.
- ///
- #define PXE_OPFLAGS_RECEIVE_FILTER_OPMASK 0xC000
- #define PXE_OPFLAGS_RECEIVE_FILTER_ENABLE 0x8000
- #define PXE_OPFLAGS_RECEIVE_FILTER_DISABLE 0x4000
- #define PXE_OPFLAGS_RECEIVE_FILTER_READ 0x0000
-
- ///
- /// To reset the contents of the multicast MAC address filter list,
- /// set this OpFlag:
- ///
- #define PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST 0x2000
-
- ///
- /// Enable unicast packet receiving. Packets sent to the current station
- /// MAC address will be received.
- ///
- #define PXE_OPFLAGS_RECEIVE_FILTER_UNICAST 0x0001
-
- ///
- /// Enable broadcast packet receiving. Packets sent to the broadcast
- /// MAC address will be received.
- ///
- #define PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
-
- ///
- /// Enable filtered multicast packet receiving. Packets sent to any
- /// of the multicast MAC addresses in the multicast MAC address filter
- /// list will be received. If the filter list is empty, no multicast
- ///
- #define PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
-
- ///
- /// Enable promiscuous packet receiving. All packets will be received.
- ///
- #define PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
-
- ///
- /// Enable promiscuous multicast packet receiving. All multicast
- /// packets will be received.
- ///
- #define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
-
- ///
- /// UNDI Station Address.
- ///
- #define PXE_OPFLAGS_STATION_ADDRESS_READ 0x0000
- #define PXE_OPFLAGS_STATION_ADDRESS_WRITE 0x0000
- #define PXE_OPFLAGS_STATION_ADDRESS_RESET 0x0001
-
- ///
- /// UNDI Statistics.
- ///
- #define PXE_OPFLAGS_STATISTICS_READ 0x0000
- #define PXE_OPFLAGS_STATISTICS_RESET 0x0001
-
- ///
- /// UNDI MCast IP to MAC.
- ///
- ///
- /// Identify the type of IP address in the CPB.
- ///
- #define PXE_OPFLAGS_MCAST_IP_TO_MAC_OPMASK 0x0003
- #define PXE_OPFLAGS_MCAST_IPV4_TO_MAC 0x0000
- #define PXE_OPFLAGS_MCAST_IPV6_TO_MAC 0x0001
-
- ///
- /// UNDI NvData.
- ///
- ///
- /// Select the type of non-volatile data operation.
- ///
- #define PXE_OPFLAGS_NVDATA_OPMASK 0x0001
- #define PXE_OPFLAGS_NVDATA_READ 0x0000
- #define PXE_OPFLAGS_NVDATA_WRITE 0x0001
-
- ///
- /// UNDI Get Status.
- ///
- ///
- /// Return current interrupt status. This will also clear any interrupts
- /// that are currently set. This can be used in a polling routine. The
- /// interrupt flags are still set and cleared even when the interrupts
- /// are disabled.
- ///
- #define PXE_OPFLAGS_GET_INTERRUPT_STATUS 0x0001
-
- ///
- /// Return list of transmitted buffers for recycling. Transmit buffers
- /// must not be changed or unallocated until they have recycled. After
- /// issuing a transmit command, wait for a transmit complete interrupt.
- /// When a transmit complete interrupt is received, read the transmitted
- /// buffers. Do not plan on getting one buffer per interrupt. Some
- /// NICs and UNDIs may transmit multiple buffers per interrupt.
- ///
- #define PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS 0x0002
-
- ///
- /// Return current media status.
- ///
- #define PXE_OPFLAGS_GET_MEDIA_STATUS 0x0004
-
- ///
- /// UNDI Fill Header.
- ///
- #define PXE_OPFLAGS_FILL_HEADER_OPMASK 0x0001
- #define PXE_OPFLAGS_FILL_HEADER_FRAGMENTED 0x0001
- #define PXE_OPFLAGS_FILL_HEADER_WHOLE 0x0000
-
- ///
- /// UNDI Transmit.
- ///
- ///
- /// S/W UNDI only. Return after the packet has been transmitted. A
- /// transmit complete interrupt will still be generated and the transmit
- /// buffer will have to be recycled.
- ///
- #define PXE_OPFLAGS_SWUNDI_TRANSMIT_OPMASK 0x0001
- #define PXE_OPFLAGS_TRANSMIT_BLOCK 0x0001
- #define PXE_OPFLAGS_TRANSMIT_DONT_BLOCK 0x0000
-
- #define PXE_OPFLAGS_TRANSMIT_OPMASK 0x0002
- #define PXE_OPFLAGS_TRANSMIT_FRAGMENTED 0x0002
- #define PXE_OPFLAGS_TRANSMIT_WHOLE 0x0000
-
- ///
- /// UNDI Receive.
- ///
- /// No OpFlags.
- ///
-
- ///
- /// PXE STATFLAGS.
- ///
- typedef PXE_UINT16 PXE_STATFLAGS;
-
- #define PXE_STATFLAGS_INITIALIZE 0x0000
-
- ///
- /// Common StatFlags that can be returned by all commands.
- ///
- ///
- /// The COMMAND_COMPLETE and COMMAND_FAILED status flags must be
- /// implemented by all UNDIs. COMMAND_QUEUED is only needed by UNDIs
- /// that support command queuing.
- ///
- #define PXE_STATFLAGS_STATUS_MASK 0xC000
- #define PXE_STATFLAGS_COMMAND_COMPLETE 0xC000
- #define PXE_STATFLAGS_COMMAND_FAILED 0x8000
- #define PXE_STATFLAGS_COMMAND_QUEUED 0x4000
-
- ///
- /// UNDI Get State.
- ///
- #define PXE_STATFLAGS_GET_STATE_MASK 0x0003
- #define PXE_STATFLAGS_GET_STATE_INITIALIZED 0x0002
- #define PXE_STATFLAGS_GET_STATE_STARTED 0x0001
- #define PXE_STATFLAGS_GET_STATE_STOPPED 0x0000
-
- ///
- /// UNDI Start.
- ///
- /// No additional StatFlags.
- ///
-
- ///
- /// UNDI Get Init Info.
- ///
- #define PXE_STATFLAGS_CABLE_DETECT_MASK 0x0001
- #define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000
- #define PXE_STATFLAGS_CABLE_DETECT_SUPPORTED 0x0001
-
- #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK 0x0002
- #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED 0x0000
- #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED 0x0002
-
- ///
- /// UNDI Initialize.
- ///
- #define PXE_STATFLAGS_INITIALIZED_NO_MEDIA 0x0001
-
- ///
- /// UNDI Reset.
- ///
- #define PXE_STATFLAGS_RESET_NO_MEDIA 0x0001
-
- ///
- /// UNDI Shutdown.
- ///
- /// No additional StatFlags.
-
- ///
- /// UNDI Interrupt Enables.
- ///
- ///
- /// If set, receive interrupts are enabled.
- ///
- #define PXE_STATFLAGS_INTERRUPT_RECEIVE 0x0001
-
- ///
- /// If set, transmit interrupts are enabled.
- ///
- #define PXE_STATFLAGS_INTERRUPT_TRANSMIT 0x0002
-
- ///
- /// If set, command interrupts are enabled.
- ///
- #define PXE_STATFLAGS_INTERRUPT_COMMAND 0x0004
-
- ///
- /// UNDI Receive Filters.
- ///
-
- ///
- /// If set, unicast packets will be received.
- ///
- #define PXE_STATFLAGS_RECEIVE_FILTER_UNICAST 0x0001
-
- ///
- /// If set, broadcast packets will be received.
- ///
- #define PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
-
- ///
- /// If set, multicast packets that match up with the multicast address
- /// filter list will be received.
- ///
- #define PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
-
- ///
- /// If set, all packets will be received.
- ///
- #define PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
-
- ///
- /// If set, all multicast packets will be received.
- ///
- #define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
-
- ///
- /// UNDI Station Address.
- ///
- /// No additional StatFlags.
- ///
-
- ///
- /// UNDI Statistics.
- ///
- /// No additional StatFlags.
- ///
-
- ///
- //// UNDI MCast IP to MAC.
- ////
- //// No additional StatFlags.
-
- ///
- /// UNDI NvData.
- ///
- /// No additional StatFlags.
- ///
-
- ///
- /// UNDI Get Status.
- ///
-
- ///
- /// Use to determine if an interrupt has occurred.
- ///
- #define PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK 0x000F
- #define PXE_STATFLAGS_GET_STATUS_NO_INTERRUPTS 0x0000
-
- ///
- /// If set, at least one receive interrupt occurred.
- ///
- #define PXE_STATFLAGS_GET_STATUS_RECEIVE 0x0001
-
- ///
- /// If set, at least one transmit interrupt occurred.
- ///
- #define PXE_STATFLAGS_GET_STATUS_TRANSMIT 0x0002
-
- ///
- /// If set, at least one command interrupt occurred.
- ///
- #define PXE_STATFLAGS_GET_STATUS_COMMAND 0x0004
-
- ///
- /// If set, at least one software interrupt occurred.
- ///
- #define PXE_STATFLAGS_GET_STATUS_SOFTWARE 0x0008
-
- ///
- /// This flag is set if the transmitted buffer queue is empty. This flag
- /// will be set if all transmitted buffer addresses get written into the DB.
- ///
- #define PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY 0x0010
-
- ///
- /// This flag is set if no transmitted buffer addresses were written
- /// into the DB. (This could be because DBsize was too small.)
- ///
- #define PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN 0x0020
-
- ///
- /// This flag is set if there is no media detected.
- ///
- #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA 0x0040
-
- ///
- /// UNDI Fill Header.
- ///
- /// No additional StatFlags.
- ///
-
- ///
- /// UNDI Transmit.
- ///
- /// No additional StatFlags.
-
- ///
- /// UNDI Receive
- ///.
-
- ///
- /// No additional StatFlags.
- ///
- typedef PXE_UINT16 PXE_STATCODE;
-
- #define PXE_STATCODE_INITIALIZE 0x0000
-
- ///
- /// Common StatCodes returned by all UNDI commands, UNDI protocol functions
- /// and BC protocol functions.
- ///
- #define PXE_STATCODE_SUCCESS 0x0000
-
- #define PXE_STATCODE_INVALID_CDB 0x0001
- #define PXE_STATCODE_INVALID_CPB 0x0002
- #define PXE_STATCODE_BUSY 0x0003
- #define PXE_STATCODE_QUEUE_FULL 0x0004
- #define PXE_STATCODE_ALREADY_STARTED 0x0005
- #define PXE_STATCODE_NOT_STARTED 0x0006
- #define PXE_STATCODE_NOT_SHUTDOWN 0x0007
- #define PXE_STATCODE_ALREADY_INITIALIZED 0x0008
- #define PXE_STATCODE_NOT_INITIALIZED 0x0009
- #define PXE_STATCODE_DEVICE_FAILURE 0x000A
- #define PXE_STATCODE_NVDATA_FAILURE 0x000B
- #define PXE_STATCODE_UNSUPPORTED 0x000C
- #define PXE_STATCODE_BUFFER_FULL 0x000D
- #define PXE_STATCODE_INVALID_PARAMETER 0x000E
- #define PXE_STATCODE_INVALID_UNDI 0x000F
- #define PXE_STATCODE_IPV4_NOT_SUPPORTED 0x0010
- #define PXE_STATCODE_IPV6_NOT_SUPPORTED 0x0011
- #define PXE_STATCODE_NOT_ENOUGH_MEMORY 0x0012
- #define PXE_STATCODE_NO_DATA 0x0013
-
- typedef PXE_UINT16 PXE_IFNUM;
-
- ///
- /// This interface number must be passed to the S/W UNDI Start command.
- ///
- #define PXE_IFNUM_START 0x0000
-
- ///
- /// This interface number is returned by the S/W UNDI Get State and
- /// Start commands if information in the CDB, CPB or DB is invalid.
- ///
- #define PXE_IFNUM_INVALID 0x0000
-
- typedef PXE_UINT16 PXE_CONTROL;
-
- ///
- /// Setting this flag directs the UNDI to queue this command for later
- /// execution if the UNDI is busy and it supports command queuing.
- /// If queuing is not supported, a PXE_STATCODE_INVALID_CONTROL error
- /// is returned. If the queue is full, a PXE_STATCODE_CDB_QUEUE_FULL
- /// error is returned.
- ///
- #define PXE_CONTROL_QUEUE_IF_BUSY 0x0002
-
- ///
- /// These two bit values are used to determine if there are more UNDI
- /// CDB structures following this one. If the link bit is set, there
- /// must be a CDB structure following this one. Execution will start
- /// on the next CDB structure as soon as this one completes successfully.
- /// If an error is generated by this command, execution will stop.
- ///
- #define PXE_CONTROL_LINK 0x0001
- #define PXE_CONTROL_LAST_CDB_IN_LIST 0x0000
-
- typedef PXE_UINT8 PXE_FRAME_TYPE;
-
- #define PXE_FRAME_TYPE_NONE 0x00
- #define PXE_FRAME_TYPE_UNICAST 0x01
- #define PXE_FRAME_TYPE_BROADCAST 0x02
- #define PXE_FRAME_TYPE_FILTERED_MULTICAST 0x03
- #define PXE_FRAME_TYPE_PROMISCUOUS 0x04
- #define PXE_FRAME_TYPE_PROMISCUOUS_MULTICAST 0x05
-
- #define PXE_FRAME_TYPE_MULTICAST PXE_FRAME_TYPE_FILTERED_MULTICAST
-
- typedef PXE_UINT32 PXE_IPV4;
-
- typedef PXE_UINT32 PXE_IPV6[4];
- #define PXE_MAC_LENGTH 32
-
- typedef PXE_UINT8 PXE_MAC_ADDR[PXE_MAC_LENGTH];
-
- typedef PXE_UINT8 PXE_IFTYPE;
- typedef UINT16 PXE_MEDIA_PROTOCOL;
-
- ///
- /// This information is from the ARP section of RFC 1700.
- ///
- /// 1 Ethernet (10Mb) [JBP]
- /// 2 Experimental Ethernet (3Mb) [JBP]
- /// 3 Amateur Radio AX.25 [PXK]
- /// 4 Proteon ProNET Token Ring [JBP]
- /// 5 Chaos [GXP]
- /// 6 IEEE 802 Networks [JBP]
- /// 7 ARCNET [JBP]
- /// 8 Hyperchannel [JBP]
- /// 9 Lanstar [TU]
- /// 10 Autonet Short Address [MXB1]
- /// 11 LocalTalk [JKR1]
- /// 12 LocalNet (IBM* PCNet or SYTEK* LocalNET) [JXM]
- /// 13 Ultra link [RXD2]
- /// 14 SMDS [GXC1]
- /// 15 Frame Relay [AGM]
- /// 16 Asynchronous Transmission Mode (ATM) [JXB2]
- /// 17 HDLC [JBP]
- /// 18 Fibre Channel [Yakov Rekhter]
- /// 19 Asynchronous Transmission Mode (ATM) [Mark Laubach]
- /// 20 Serial Line [JBP]
- /// 21 Asynchronous Transmission Mode (ATM) [MXB1]
- ///
- /// * Other names and brands may be claimed as the property of others.
- ///
- #define PXE_IFTYPE_ETHERNET 0x01
- #define PXE_IFTYPE_TOKENRING 0x04
- #define PXE_IFTYPE_FIBRE_CHANNEL 0x12
-
- typedef struct s_pxe_hw_undi {
- PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.
- PXE_UINT8 Len; ///< sizeof(PXE_HW_UNDI).
- PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero.
- PXE_UINT8 Rev; ///< PXE_ROMID_REV.
- PXE_UINT8 IFcnt; ///< physical connector count.
- PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.
- PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.
- PXE_UINT16 reserved; ///< zero, not used.
- PXE_UINT32 Implementation; ///< implementation flags.
- ///< reserved ///< vendor use.
- ///< UINT32 Status; ///< status port.
- ///< UINT32 Command; ///< command port.
- ///< UINT64 CDBaddr; ///< CDB address port.
- ///<
- } PXE_HW_UNDI;
-
- ///
- /// Status port bit definitions.
- ///
-
- ///
- /// UNDI operation state.
- ///
- #define PXE_HWSTAT_STATE_MASK 0xC0000000
- #define PXE_HWSTAT_BUSY 0xC0000000
- #define PXE_HWSTAT_INITIALIZED 0x80000000
- #define PXE_HWSTAT_STARTED 0x40000000
- #define PXE_HWSTAT_STOPPED 0x00000000
-
- ///
- /// If set, last command failed.
- ///
- #define PXE_HWSTAT_COMMAND_FAILED 0x20000000
-
- ///
- /// If set, identifies enabled receive filters.
- ///
- #define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000
- #define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800
- #define PXE_HWSTAT_BROADCAST_RX_ENABLED 0x00000400
- #define PXE_HWSTAT_MULTICAST_RX_ENABLED 0x00000200
- #define PXE_HWSTAT_UNICAST_RX_ENABLED 0x00000100
-
- ///
- /// If set, identifies enabled external interrupts.
- ///
- #define PXE_HWSTAT_SOFTWARE_INT_ENABLED 0x00000080
- #define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040
- #define PXE_HWSTAT_PACKET_RX_INT_ENABLED 0x00000020
- #define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010
-
- ///
- /// If set, identifies pending interrupts.
- ///
- #define PXE_HWSTAT_SOFTWARE_INT_PENDING 0x00000008
- #define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004
- #define PXE_HWSTAT_PACKET_RX_INT_PENDING 0x00000002
- #define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001
-
- ///
- /// Command port definitions.
- ///
-
- ///
- /// If set, CDB identified in CDBaddr port is given to UNDI.
- /// If not set, other bits in this word will be processed.
- ///
- #define PXE_HWCMD_ISSUE_COMMAND 0x80000000
- #define PXE_HWCMD_INTS_AND_FILTS 0x00000000
-
- ///
- /// Use these to enable/disable receive filters.
- ///
- #define PXE_HWCMD_PROMISCUOUS_MULTICAST_RX_ENABLE 0x00001000
- #define PXE_HWCMD_PROMISCUOUS_RX_ENABLE 0x00000800
- #define PXE_HWCMD_BROADCAST_RX_ENABLE 0x00000400
- #define PXE_HWCMD_MULTICAST_RX_ENABLE 0x00000200
- #define PXE_HWCMD_UNICAST_RX_ENABLE 0x00000100
-
- ///
- /// Use these to enable/disable external interrupts.
- ///
- #define PXE_HWCMD_SOFTWARE_INT_ENABLE 0x00000080
- #define PXE_HWCMD_TX_COMPLETE_INT_ENABLE 0x00000040
- #define PXE_HWCMD_PACKET_RX_INT_ENABLE 0x00000020
- #define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010
-
- ///
- /// Use these to clear pending external interrupts.
- ///
- #define PXE_HWCMD_CLEAR_SOFTWARE_INT 0x00000008
- #define PXE_HWCMD_CLEAR_TX_COMPLETE_INT 0x00000004
- #define PXE_HWCMD_CLEAR_PACKET_RX_INT 0x00000002
- #define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT 0x00000001
-
- typedef struct s_pxe_sw_undi {
- PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.
- PXE_UINT8 Len; ///< sizeof(PXE_SW_UNDI).
- PXE_UINT8 Fudge; ///< makes 8-bit cksum zero.
- PXE_UINT8 Rev; ///< PXE_ROMID_REV.
- PXE_UINT8 IFcnt; ///< physical connector count.
- PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.
- PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.
- PXE_UINT16 reserved1; ///< zero, not used.
- PXE_UINT32 Implementation; ///< Implementation flags.
- PXE_UINT64 EntryPoint; ///< API entry point.
- PXE_UINT8 reserved2[3]; ///< zero, not used.
- PXE_UINT8 BusCnt; ///< number of bustypes supported.
- PXE_UINT32 BusType[1]; ///< list of supported bustypes.
- } PXE_SW_UNDI;
-
- typedef union u_pxe_undi {
- PXE_HW_UNDI hw;
- PXE_SW_UNDI sw;
- } PXE_UNDI;
-
- ///
- /// Signature of !PXE structure.
- ///
- #define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')
-
- ///
- /// !PXE structure format revision
- ///.
- #define PXE_ROMID_REV 0x02
-
- ///
- /// UNDI command interface revision. These are the values that get sent
- /// in option 94 (Client Network Interface Identifier) in the DHCP Discover
- /// and PXE Boot Server Request packets.
- ///
- #define PXE_ROMID_MAJORVER 0x03
- #define PXE_ROMID_MINORVER 0x01
-
- ///
- /// Implementation flags.
- ///
- #define PXE_ROMID_IMP_HW_UNDI 0x80000000
- #define PXE_ROMID_IMP_SW_VIRT_ADDR 0x40000000
- #define PXE_ROMID_IMP_64BIT_DEVICE 0x00010000
- #define PXE_ROMID_IMP_FRAG_SUPPORTED 0x00008000
- #define PXE_ROMID_IMP_CMD_LINK_SUPPORTED 0x00004000
- #define PXE_ROMID_IMP_CMD_QUEUE_SUPPORTED 0x00002000
- #define PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED 0x00001000
- #define PXE_ROMID_IMP_NVDATA_SUPPORT_MASK 0x00000C00
- #define PXE_ROMID_IMP_NVDATA_BULK_WRITABLE 0x00000C00
- #define PXE_ROMID_IMP_NVDATA_SPARSE_WRITABLE 0x00000800
- #define PXE_ROMID_IMP_NVDATA_READ_ONLY 0x00000400
- #define PXE_ROMID_IMP_NVDATA_NOT_AVAILABLE 0x00000000
- #define PXE_ROMID_IMP_STATISTICS_SUPPORTED 0x00000200
- #define PXE_ROMID_IMP_STATION_ADDR_SETTABLE 0x00000100
- #define PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED 0x00000080
- #define PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED 0x00000040
- #define PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED 0x00000020
- #define PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED 0x00000010
- #define PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED 0x00000008
- #define PXE_ROMID_IMP_TX_COMPLETE_INT_SUPPORTED 0x00000004
- #define PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED 0x00000002
- #define PXE_ROMID_IMP_CMD_COMPLETE_INT_SUPPORTED 0x00000001
-
- typedef struct s_pxe_cdb {
- PXE_OPCODE OpCode;
- PXE_OPFLAGS OpFlags;
- PXE_UINT16 CPBsize;
- PXE_UINT16 DBsize;
- PXE_UINT64 CPBaddr;
- PXE_UINT64 DBaddr;
- PXE_STATCODE StatCode;
- PXE_STATFLAGS StatFlags;
- PXE_UINT16 IFnum;
- PXE_CONTROL Control;
- } PXE_CDB;
-
- typedef union u_pxe_ip_addr {
- PXE_IPV6 IPv6;
- PXE_IPV4 IPv4;
- } PXE_IP_ADDR;
-
- typedef union pxe_device {
- ///
- /// PCI and PC Card NICs are both identified using bus, device
- /// and function numbers. For PC Card, this may require PC
- /// Card services to be loaded in the BIOS or preboot
- /// environment.
- ///
- struct {
- ///
- /// See S/W UNDI ROMID structure definition for PCI and
- /// PCC BusType definitions.
- ///
- PXE_UINT32 BusType;
-
- ///
- /// Bus, device & function numbers that locate this device.
- ///
- PXE_UINT16 Bus;
- PXE_UINT8 Device;
- PXE_UINT8 Function;
- }
- PCI, PCC;
-
- } PXE_DEVICE;
-
- ///
- /// cpb and db definitions
- ///
- #define MAX_PCI_CONFIG_LEN 64 ///< # of dwords.
- #define MAX_EEPROM_LEN 128 ///< # of dwords.
- #define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done.
- #define MAX_MCAST_ADDRESS_CNT 8
-
- typedef struct s_pxe_cpb_start_30 {
- ///
- /// PXE_VOID Delay(UINTN microseconds);
- ///
- /// UNDI will never request a delay smaller than 10 microseconds
- /// and will always request delays in increments of 10 microseconds.
- /// The Delay() CallBack routine must delay between n and n + 10
- /// microseconds before returning control to the UNDI.
- ///
- /// This field cannot be set to zero.
- ///
- UINT64 Delay;
-
- ///
- /// PXE_VOID Block(UINT32 enable);
- ///
- /// UNDI may need to block multi-threaded/multi-processor access to
- /// critical code sections when programming or accessing the network
- /// device. To this end, a blocking service is needed by the UNDI.
- /// When UNDI needs a block, it will call Block() passing a non-zero
- /// value. When UNDI no longer needs a block, it will call Block()
- /// with a zero value. When called, if the Block() is already enabled,
- /// do not return control to the UNDI until the previous Block() is
- /// disabled.
- ///
- /// This field cannot be set to zero.
- ///
- UINT64 Block;
-
- ///
- /// PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);
- ///
- /// UNDI will pass the virtual address of a buffer and the virtual
- /// address of a 64-bit physical buffer. Convert the virtual address
- /// to a physical address and write the result to the physical address
- /// buffer. If virtual and physical addresses are the same, just
- /// copy the virtual address to the physical address buffer.
- ///
- /// This field can be set to zero if virtual and physical addresses
- /// are equal.
- ///
- UINT64 Virt2Phys;
- ///
- /// PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port,
- /// UINT64 buf_addr);
- ///
- /// UNDI will read or write the device io space using this call back
- /// function. It passes the number of bytes as the len parameter and it
- /// will be either 1,2,4 or 8.
- ///
- /// This field can not be set to zero.
- ///
- UINT64 Mem_IO;
- } PXE_CPB_START_30;
-
- typedef struct s_pxe_cpb_start_31 {
- ///
- /// PXE_VOID Delay(UINT64 UnqId, UINTN microseconds);
- ///
- /// UNDI will never request a delay smaller than 10 microseconds
- /// and will always request delays in increments of 10 microseconds.
- /// The Delay() CallBack routine must delay between n and n + 10
- /// microseconds before returning control to the UNDI.
- ///
- /// This field cannot be set to zero.
- ///
- UINT64 Delay;
-
- ///
- /// PXE_VOID Block(UINT64 unq_id, UINT32 enable);
- ///
- /// UNDI may need to block multi-threaded/multi-processor access to
- /// critical code sections when programming or accessing the network
- /// device. To this end, a blocking service is needed by the UNDI.
- /// When UNDI needs a block, it will call Block() passing a non-zero
- /// value. When UNDI no longer needs a block, it will call Block()
- /// with a zero value. When called, if the Block() is already enabled,
- /// do not return control to the UNDI until the previous Block() is
- /// disabled.
- ///
- /// This field cannot be set to zero.
- ///
- UINT64 Block;
-
- ///
- /// PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);
- ///
- /// UNDI will pass the virtual address of a buffer and the virtual
- /// address of a 64-bit physical buffer. Convert the virtual address
- /// to a physical address and write the result to the physical address
- /// buffer. If virtual and physical addresses are the same, just
- /// copy the virtual address to the physical address buffer.
- ///
- /// This field can be set to zero if virtual and physical addresses
- /// are equal.
- ///
- UINT64 Virt2Phys;
- ///
- /// PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port,
- /// UINT64 buf_addr);
- ///
- /// UNDI will read or write the device io space using this call back
- /// function. It passes the number of bytes as the len parameter and it
- /// will be either 1,2,4 or 8.
- ///
- /// This field can not be set to zero.
- ///
- UINT64 Mem_IO;
- ///
- /// PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
- /// UINT32 Direction, UINT64 mapped_addr);
- ///
- /// UNDI will pass the virtual address of a buffer, direction of the data
- /// flow from/to the mapped buffer (the constants are defined below)
- /// and a place holder (pointer) for the mapped address.
- /// This call will Map the given address to a physical DMA address and write
- /// the result to the mapped_addr pointer. If there is no need to
- /// map the given address to a lower address (i.e. the given address is
- /// associated with a physical address that is already compatible to be
- /// used with the DMA, it converts the given virtual address to it's
- /// physical address and write that in the mapped address pointer.
- ///
- /// This field can be set to zero if there is no mapping service available.
- ///
- UINT64 Map_Mem;
-
- ///
- /// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
- /// UINT32 Direction, UINT64 mapped_addr);
- ///
- /// UNDI will pass the virtual and mapped addresses of a buffer.
- /// This call will un map the given address.
- ///
- /// This field can be set to zero if there is no unmapping service available.
- ///
- UINT64 UnMap_Mem;
-
- ///
- /// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,
- /// UINT32 size, UINT32 Direction, UINT64 mapped_addr);
- ///
- /// UNDI will pass the virtual and mapped addresses of a buffer.
- /// This call will synchronize the contents of both the virtual and mapped.
- /// buffers for the given Direction.
- ///
- /// This field can be set to zero if there is no service available.
- ///
- UINT64 Sync_Mem;
-
- ///
- /// protocol driver can provide anything for this Unique_ID, UNDI remembers
- /// that as just a 64bit value assocaited to the interface specified by
- /// the ifnum and gives it back as a parameter to all the call-back routines
- /// when calling for that interface!
- ///
- UINT64 Unique_ID;
- } PXE_CPB_START_31;
-
- #define TO_AND_FROM_DEVICE 0
- #define FROM_DEVICE 1
- #define TO_DEVICE 2
-
- #define PXE_DELAY_MILLISECOND 1000
- #define PXE_DELAY_SECOND 1000000
- #define PXE_IO_READ 0
- #define PXE_IO_WRITE 1
- #define PXE_MEM_READ 2
- #define PXE_MEM_WRITE 4
-
- typedef struct s_pxe_db_get_init_info {
- ///
- /// Minimum length of locked memory buffer that must be given to
- /// the Initialize command. Giving UNDI more memory will generally
- /// give better performance.
- ///
- /// If MemoryRequired is zero, the UNDI does not need and will not
- /// use system memory to receive and transmit packets.
- ///
- PXE_UINT32 MemoryRequired;
-
- ///
- /// Maximum frame data length for Tx/Rx excluding the media header.
- ///
- PXE_UINT32 FrameDataLen;
-
- ///
- /// Supported link speeds are in units of mega bits. Common ethernet
- /// values are 10, 100 and 1000. Unused LinkSpeeds[] entries are zero
- /// filled.
- ///
- PXE_UINT32 LinkSpeeds[4];
-
- ///
- /// Number of non-volatile storage items.
- ///
- PXE_UINT32 NvCount;
-
- ///
- /// Width of non-volatile storage item in bytes. 0, 1, 2 or 4
- ///
- PXE_UINT16 NvWidth;
-
- ///
- /// Media header length. This is the typical media header length for
- /// this UNDI. This information is needed when allocating receive
- /// and transmit buffers.
- ///
- PXE_UINT16 MediaHeaderLen;
-
- ///
- /// Number of bytes in the NIC hardware (MAC) address.
- ///
- PXE_UINT16 HWaddrLen;
-
- ///
- /// Maximum number of multicast MAC addresses in the multicast
- /// MAC address filter list.
- ///
- PXE_UINT16 MCastFilterCnt;
-
- ///
- /// Default number and size of transmit and receive buffers that will
- /// be allocated by the UNDI. If MemoryRequired is non-zero, this
- /// allocation will come out of the memory buffer given to the Initialize
- /// command. If MemoryRequired is zero, this allocation will come out of
- /// memory on the NIC.
- ///
- PXE_UINT16 TxBufCnt;
- PXE_UINT16 TxBufSize;
- PXE_UINT16 RxBufCnt;
- PXE_UINT16 RxBufSize;
-
- ///
- /// Hardware interface types defined in the Assigned Numbers RFC
- /// and used in DHCP and ARP packets.
- /// See the PXE_IFTYPE typedef and PXE_IFTYPE_xxx macros.
- ///
- PXE_UINT8 IFtype;
-
- ///
- /// Supported duplex. See PXE_DUPLEX_xxxxx #defines below.
- ///
- PXE_UINT8 SupportedDuplexModes;
-
- ///
- /// Supported loopback options. See PXE_LOOPBACK_xxxxx #defines below.
- ///
- PXE_UINT8 SupportedLoopBackModes;
- } PXE_DB_GET_INIT_INFO;
-
- #define PXE_MAX_TXRX_UNIT_ETHER 1500
-
- #define PXE_HWADDR_LEN_ETHER 0x0006
- #define PXE_MAC_HEADER_LEN_ETHER 0x000E
-
- #define PXE_DUPLEX_ENABLE_FULL_SUPPORTED 1
- #define PXE_DUPLEX_FORCE_FULL_SUPPORTED 2
-
- #define PXE_LOOPBACK_INTERNAL_SUPPORTED 1
- #define PXE_LOOPBACK_EXTERNAL_SUPPORTED 2
-
- typedef struct s_pxe_pci_config_info {
- ///
- /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
- /// For PCI bus devices, this field is set to PXE_BUSTYPE_PCI.
- ///
- UINT32 BusType;
-
- ///
- /// This identifies the PCI network device that this UNDI interface.
- /// is bound to.
- ///
- UINT16 Bus;
- UINT8 Device;
- UINT8 Function;
-
- ///
- /// This is a copy of the PCI configuration space for this
- /// network device.
- ///
- union {
- UINT8 Byte[256];
- UINT16 Word[128];
- UINT32 Dword[64];
- } Config;
- } PXE_PCI_CONFIG_INFO;
-
- typedef struct s_pxe_pcc_config_info {
- ///
- /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
- /// For PCC bus devices, this field is set to PXE_BUSTYPE_PCC.
- ///
- PXE_UINT32 BusType;
-
- ///
- /// This identifies the PCC network device that this UNDI interface
- /// is bound to.
- ///
- PXE_UINT16 Bus;
- PXE_UINT8 Device;
- PXE_UINT8 Function;
-
- ///
- /// This is a copy of the PCC configuration space for this
- /// network device.
- ///
- union {
- PXE_UINT8 Byte[256];
- PXE_UINT16 Word[128];
- PXE_UINT32 Dword[64];
- } Config;
- } PXE_PCC_CONFIG_INFO;
-
- typedef union u_pxe_db_get_config_info {
- PXE_PCI_CONFIG_INFO pci;
- PXE_PCC_CONFIG_INFO pcc;
- } PXE_DB_GET_CONFIG_INFO;
-
- typedef struct s_pxe_cpb_initialize {
- ///
- /// Address of first (lowest) byte of the memory buffer. This buffer must
- /// be in contiguous physical memory and cannot be swapped out. The UNDI
- /// will be using this for transmit and receive buffering.
- ///
- PXE_UINT64 MemoryAddr;
-
- ///
- /// MemoryLength must be greater than or equal to MemoryRequired
- /// returned by the Get Init Info command.
- ///
- PXE_UINT32 MemoryLength;
-
- ///
- /// Desired link speed in Mbit/sec. Common ethernet values are 10, 100
- /// and 1000. Setting a value of zero will auto-detect and/or use the
- /// default link speed (operation depends on UNDI/NIC functionality).
- ///
- PXE_UINT32 LinkSpeed;
-
- ///
- /// Suggested number and size of receive and transmit buffers to
- /// allocate. If MemoryAddr and MemoryLength are non-zero, this
- /// allocation comes out of the supplied memory buffer. If MemoryAddr
- /// and MemoryLength are zero, this allocation comes out of memory
- /// on the NIC.
- ///
- /// If these fields are set to zero, the UNDI will allocate buffer
- /// counts and sizes as it sees fit.
- ///
- PXE_UINT16 TxBufCnt;
- PXE_UINT16 TxBufSize;
- PXE_UINT16 RxBufCnt;
- PXE_UINT16 RxBufSize;
-
- ///
- /// The following configuration parameters are optional and must be zero
- /// to use the default values.
- ///
- PXE_UINT8 DuplexMode;
-
- PXE_UINT8 LoopBackMode;
- } PXE_CPB_INITIALIZE;
-
- #define PXE_DUPLEX_DEFAULT 0x00
- #define PXE_FORCE_FULL_DUPLEX 0x01
- #define PXE_ENABLE_FULL_DUPLEX 0x02
- #define PXE_FORCE_HALF_DUPLEX 0x04
- #define PXE_DISABLE_FULL_DUPLEX 0x08
-
- #define LOOPBACK_NORMAL 0
- #define LOOPBACK_INTERNAL 1
- #define LOOPBACK_EXTERNAL 2
-
- typedef struct s_pxe_db_initialize {
- ///
- /// Actual amount of memory used from the supplied memory buffer. This
- /// may be less that the amount of memory suppllied and may be zero if
- /// the UNDI and network device do not use external memory buffers.
- ///
- /// Memory used by the UNDI and network device is allocated from the
- /// lowest memory buffer address.
- ///
- PXE_UINT32 MemoryUsed;
-
- ///
- /// Actual number and size of receive and transmit buffers that were
- /// allocated.
- ///
- PXE_UINT16 TxBufCnt;
- PXE_UINT16 TxBufSize;
- PXE_UINT16 RxBufCnt;
- PXE_UINT16 RxBufSize;
- } PXE_DB_INITIALIZE;
-
- typedef struct s_pxe_cpb_receive_filters {
- ///
- /// List of multicast MAC addresses. This list, if present, will
- /// replace the existing multicast MAC address filter list.
- ///
- PXE_MAC_ADDR MCastList[MAX_MCAST_ADDRESS_CNT];
- } PXE_CPB_RECEIVE_FILTERS;
-
- typedef struct s_pxe_db_receive_filters {
- ///
- /// Filtered multicast MAC address list.
- ///
- PXE_MAC_ADDR MCastList[MAX_MCAST_ADDRESS_CNT];
- } PXE_DB_RECEIVE_FILTERS;
-
- typedef struct s_pxe_cpb_station_address {
- ///
- /// If supplied and supported, the current station MAC address
- /// will be changed.
- ///
- PXE_MAC_ADDR StationAddr;
- } PXE_CPB_STATION_ADDRESS;
-
- typedef struct s_pxe_dpb_station_address {
- ///
- /// Current station MAC address.
- ///
- PXE_MAC_ADDR StationAddr;
-
- ///
- /// Station broadcast MAC address.
- ///
- PXE_MAC_ADDR BroadcastAddr;
-
- ///
- /// Permanent station MAC address.
- ///
- PXE_MAC_ADDR PermanentAddr;
- } PXE_DB_STATION_ADDRESS;
-
- typedef struct s_pxe_db_statistics {
- ///
- /// Bit field identifying what statistic data is collected by the
- /// UNDI/NIC.
- /// If bit 0x00 is set, Data[0x00] is collected.
- /// If bit 0x01 is set, Data[0x01] is collected.
- /// If bit 0x20 is set, Data[0x20] is collected.
- /// If bit 0x21 is set, Data[0x21] is collected.
- /// Etc.
- ///
- PXE_UINT64 Supported;
-
- ///
- /// Statistic data.
- ///
- PXE_UINT64 Data[64];
- } PXE_DB_STATISTICS;
-
- ///
- /// Total number of frames received. Includes frames with errors and
- /// dropped frames.
- ///
- #define PXE_STATISTICS_RX_TOTAL_FRAMES 0x00
-
- ///
- /// Number of valid frames received and copied into receive buffers.
- ///
- #define PXE_STATISTICS_RX_GOOD_FRAMES 0x01
-
- ///
- /// Number of frames below the minimum length for the media.
- /// This would be <64 for ethernet.
- ///
- #define PXE_STATISTICS_RX_UNDERSIZE_FRAMES 0x02
-
- ///
- /// Number of frames longer than the maxminum length for the
- /// media. This would be >1500 for ethernet.
- ///
- #define PXE_STATISTICS_RX_OVERSIZE_FRAMES 0x03
-
- ///
- /// Valid frames that were dropped because receive buffers were full.
- ///
- #define PXE_STATISTICS_RX_DROPPED_FRAMES 0x04
-
- ///
- /// Number of valid unicast frames received and not dropped.
- ///
- #define PXE_STATISTICS_RX_UNICAST_FRAMES 0x05
-
- ///
- /// Number of valid broadcast frames received and not dropped.
- ///
- #define PXE_STATISTICS_RX_BROADCAST_FRAMES 0x06
-
- ///
- /// Number of valid mutlicast frames received and not dropped.
- ///
- #define PXE_STATISTICS_RX_MULTICAST_FRAMES 0x07
-
- ///
- /// Number of frames w/ CRC or alignment errors.
- ///
- #define PXE_STATISTICS_RX_CRC_ERROR_FRAMES 0x08
-
- ///
- /// Total number of bytes received. Includes frames with errors
- /// and dropped frames.
- ///
- #define PXE_STATISTICS_RX_TOTAL_BYTES 0x09
-
- ///
- /// Transmit statistics.
- ///
- #define PXE_STATISTICS_TX_TOTAL_FRAMES 0x0A
- #define PXE_STATISTICS_TX_GOOD_FRAMES 0x0B
- #define PXE_STATISTICS_TX_UNDERSIZE_FRAMES 0x0C
- #define PXE_STATISTICS_TX_OVERSIZE_FRAMES 0x0D
- #define PXE_STATISTICS_TX_DROPPED_FRAMES 0x0E
- #define PXE_STATISTICS_TX_UNICAST_FRAMES 0x0F
- #define PXE_STATISTICS_TX_BROADCAST_FRAMES 0x10
- #define PXE_STATISTICS_TX_MULTICAST_FRAMES 0x11
- #define PXE_STATISTICS_TX_CRC_ERROR_FRAMES 0x12
- #define PXE_STATISTICS_TX_TOTAL_BYTES 0x13
-
- ///
- /// Number of collisions detection on this subnet.
- ///
- #define PXE_STATISTICS_COLLISIONS 0x14
-
- ///
- /// Number of frames destined for unsupported protocol.
- ///
- #define PXE_STATISTICS_UNSUPPORTED_PROTOCOL 0x15
-
- typedef struct s_pxe_cpb_mcast_ip_to_mac {
- ///
- /// Multicast IP address to be converted to multicast MAC address.
- ///
- PXE_IP_ADDR IP;
- } PXE_CPB_MCAST_IP_TO_MAC;
-
- typedef struct s_pxe_db_mcast_ip_to_mac {
- ///
- /// Multicast MAC address.
- ///
- PXE_MAC_ADDR MAC;
- } PXE_DB_MCAST_IP_TO_MAC;
-
- typedef struct s_pxe_cpb_nvdata_sparse {
- ///
- /// NvData item list. Only items in this list will be updated.
- ///
- struct {
- ///
- /// Non-volatile storage address to be changed.
- ///
- PXE_UINT32 Addr;
-
- ///
- /// Data item to write into above storage address.
- ///
- union {
- PXE_UINT8 Byte;
- PXE_UINT16 Word;
- PXE_UINT32 Dword;
- } Data;
- } Item[MAX_EEPROM_LEN];
- } PXE_CPB_NVDATA_SPARSE;
-
- ///
- /// When using bulk update, the size of the CPB structure must be
- /// the same size as the non-volatile NIC storage.
- ///
- typedef union u_pxe_cpb_nvdata_bulk {
- ///
- /// Array of byte-wide data items.
- ///
- PXE_UINT8 Byte[MAX_EEPROM_LEN << 2];
-
- ///
- /// Array of word-wide data items.
- ///
- PXE_UINT16 Word[MAX_EEPROM_LEN << 1];
-
- ///
- /// Array of dword-wide data items.
- ///
- PXE_UINT32 Dword[MAX_EEPROM_LEN];
- } PXE_CPB_NVDATA_BULK;
-
- typedef struct s_pxe_db_nvdata {
- ///
- /// Arrays of data items from non-volatile storage.
- ///
- union {
- ///
- /// Array of byte-wide data items.
- ///
- PXE_UINT8 Byte[MAX_EEPROM_LEN << 2];
-
- ///
- /// Array of word-wide data items.
- ///
- PXE_UINT16 Word[MAX_EEPROM_LEN << 1];
-
- ///
- /// Array of dword-wide data items.
- ///
- PXE_UINT32 Dword[MAX_EEPROM_LEN];
- } Data;
- } PXE_DB_NVDATA;
-
- typedef struct s_pxe_db_get_status {
- ///
- /// Length of next receive frame (header + data). If this is zero,
- /// there is no next receive frame available.
- ///
- PXE_UINT32 RxFrameLen;
-
- ///
- /// Reserved, set to zero.
- ///
- PXE_UINT32 reserved;
-
- ///
- /// Addresses of transmitted buffers that need to be recycled.
- ///
- PXE_UINT64 TxBuffer[MAX_XMIT_BUFFERS];
- } PXE_DB_GET_STATUS;
-
- typedef struct s_pxe_cpb_fill_header {
- ///
- /// Source and destination MAC addresses. These will be copied into
- /// the media header without doing byte swapping.
- ///
- PXE_MAC_ADDR SrcAddr;
- PXE_MAC_ADDR DestAddr;
-
- ///
- /// Address of first byte of media header. The first byte of packet data
- /// follows the last byte of the media header.
- ///
- PXE_UINT64 MediaHeader;
-
- ///
- /// Length of packet data in bytes (not including the media header).
- ///
- PXE_UINT32 PacketLen;
-
- ///
- /// Protocol type. This will be copied into the media header without
- /// doing byte swapping. Protocol type numbers can be obtained from
- /// the Assigned Numbers RFC 1700.
- ///
- PXE_UINT16 Protocol;
-
- ///
- /// Length of the media header in bytes.
- ///
- PXE_UINT16 MediaHeaderLen;
- } PXE_CPB_FILL_HEADER;
-
- #define PXE_PROTOCOL_ETHERNET_IP 0x0800
- #define PXE_PROTOCOL_ETHERNET_ARP 0x0806
- #define MAX_XMIT_FRAGMENTS 16
-
- typedef struct s_pxe_cpb_fill_header_fragmented {
- ///
- /// Source and destination MAC addresses. These will be copied into
- /// the media header without doing byte swapping.
- ///
- PXE_MAC_ADDR SrcAddr;
- PXE_MAC_ADDR DestAddr;
-
- ///
- /// Length of packet data in bytes (not including the media header).
- ///
- PXE_UINT32 PacketLen;
-
- ///
- /// Protocol type. This will be copied into the media header without
- /// doing byte swapping. Protocol type numbers can be obtained from
- /// the Assigned Numbers RFC 1700.
- ///
- PXE_MEDIA_PROTOCOL Protocol;
-
- ///
- /// Length of the media header in bytes.
- ///
- PXE_UINT16 MediaHeaderLen;
-
- ///
- /// Number of packet fragment descriptors.
- ///
- PXE_UINT16 FragCnt;
-
- ///
- /// Reserved, must be set to zero.
- ///
- PXE_UINT16 reserved;
-
- ///
- /// Array of packet fragment descriptors. The first byte of the media
- /// header is the first byte of the first fragment.
- ///
- struct {
- ///
- /// Address of this packet fragment.
- ///
- PXE_UINT64 FragAddr;
-
- ///
- /// Length of this packet fragment.
- ///
- PXE_UINT32 FragLen;
-
- ///
- /// Reserved, must be set to zero.
- ///
- PXE_UINT32 reserved;
- } FragDesc[MAX_XMIT_FRAGMENTS];
- }
- PXE_CPB_FILL_HEADER_FRAGMENTED;
-
- typedef struct s_pxe_cpb_transmit {
- ///
- /// Address of first byte of frame buffer. This is also the first byte
- /// of the media header.
- ///
- PXE_UINT64 FrameAddr;
-
- ///
- /// Length of the data portion of the frame buffer in bytes. Do not
- /// include the length of the media header.
- ///
- PXE_UINT32 DataLen;
-
- ///
- /// Length of the media header in bytes.
- ///
- PXE_UINT16 MediaheaderLen;
-
- ///
- /// Reserved, must be zero.
- ///
- PXE_UINT16 reserved;
- } PXE_CPB_TRANSMIT;
-
- typedef struct s_pxe_cpb_transmit_fragments {
- ///
- /// Length of packet data in bytes (not including the media header).
- ///
- PXE_UINT32 FrameLen;
-
- ///
- /// Length of the media header in bytes.
- ///
- PXE_UINT16 MediaheaderLen;
-
- ///
- /// Number of packet fragment descriptors.
- ///
- PXE_UINT16 FragCnt;
-
- ///
- /// Array of frame fragment descriptors. The first byte of the first
- /// fragment is also the first byte of the media header.
- ///
- struct {
- ///
- /// Address of this frame fragment.
- ///
- PXE_UINT64 FragAddr;
-
- ///
- /// Length of this frame fragment.
- ///
- PXE_UINT32 FragLen;
-
- ///
- /// Reserved, must be set to zero.
- ///
- PXE_UINT32 reserved;
- } FragDesc[MAX_XMIT_FRAGMENTS];
- }
- PXE_CPB_TRANSMIT_FRAGMENTS;
-
- typedef struct s_pxe_cpb_receive {
- ///
- /// Address of first byte of receive buffer. This is also the first byte
- /// of the frame header.
- ///
- PXE_UINT64 BufferAddr;
-
- ///
- /// Length of receive buffer. This must be large enough to hold the
- /// received frame (media header + data). If the length of smaller than
- /// the received frame, data will be lost.
- ///
- PXE_UINT32 BufferLen;
-
- ///
- /// Reserved, must be set to zero.
- ///
- PXE_UINT32 reserved;
- } PXE_CPB_RECEIVE;
-
- typedef struct s_pxe_db_receive {
- ///
- /// Source and destination MAC addresses from media header.
- ///
- PXE_MAC_ADDR SrcAddr;
- PXE_MAC_ADDR DestAddr;
-
- ///
- /// Length of received frame. May be larger than receive buffer size.
- /// The receive buffer will not be overwritten. This is how to tell
- /// if data was lost because the receive buffer was too small.
- ///
- PXE_UINT32 FrameLen;
-
- ///
- /// Protocol type from media header.
- ///
- PXE_MEDIA_PROTOCOL Protocol;
-
- ///
- /// Length of media header in received frame.
- ///
- PXE_UINT16 MediaHeaderLen;
-
- ///
- /// Type of receive frame.
- ///
- PXE_FRAME_TYPE Type;
-
- ///
- /// Reserved, must be zero.
- ///
- PXE_UINT8 reserved[7];
-
- } PXE_DB_RECEIVE;
-
- #pragma pack()
-
- #endif
|