MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h

   1 /** @file
   2   EFI Network Interface Identifier Protocol
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13
  14 **/
  15
  16 #ifndef __EFI_NETWORK_INTERFACE_IDENTIFER_H__
  17 #define __EFI_NETWORK_INTERFACE_IDENTIFER_H__
  18
  19
  20 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID \
  21   { \
  22     0xE18541CD, 0xF755, 0x4f73, {0x92, 0x8D, 0x64, 0x3C, 0x8A, 0x79, 0xB2, 0x29 } \
  23   }
  24
  25 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION    0x00010000
  26
  27 //
  28 // Revision defined in EFI1.1.
  29 //
  30 #define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION
  31
  32 //
  33 // Forward reference for pure ANSI compatability
  34 //
  35 typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;
  36
  37 //
  38 // Protocol defined in EFI1.1.
  39 //
  40 typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL   EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE;
  41
  42 typedef enum {
  43   EfiNetworkInterfaceUndi = 1
  44 } EFI_NETWORK_PROTOCOL_TYPE;
  45
  46 struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {
  47
  48   UINT64  Revision;
  49   //
  50   // Revision of the network interface identifier protocol interface.
  51   //
  52   UINT64  ID;
  53   //
  54   // Address of the first byte of the identifying structure for this
  55   // network interface.  This is set to zero if there is no structure.
  56   //
  57   // For PXE/UNDI this is the first byte of the !PXE structure.
  58   //
  59   UINT64  ImageAddr;
  60   //
  61   // Address of the UNrelocated driver/ROM image.  This is set
  62   // to zero if there is no driver/ROM image.
  63   //
  64   // For 16-bit UNDI, this is the first byte of the option ROM in
  65   // upper memory.
  66   //
  67   // For 32/64-bit S/W UNDI, this is the first byte of the EFI ROM
  68   // image.
  69   //
  70   // For H/W UNDI, this is set to zero.
  71   //
  72   UINT32  ImageSize;
  73   //
  74   // Size of the UNrelocated driver/ROM image of this network interface.
  75   // This is set to zero if there is no driver/ROM image.
  76   //
  77   CHAR8   StringId[4];
  78   //
  79   // 4 char ASCII string to go in class identifier (option 60) in DHCP
  80   // and Boot Server discover packets.
  81   // For EfiNetworkInterfaceUndi this field is "UNDI".
  82   // For EfiNetworkInterfaceSnp this field is "SNPN".
  83   //
  84   UINT8   Type;
  85   UINT8   MajorVer;
  86   UINT8   MinorVer;
  87   //
  88   // Information to be placed into the PXE DHCP and Discover packets.
  89   // This is the network interface type and version number that will
  90   // be placed into DHCP option 94 (client network interface identifier).
  91   //
  92   BOOLEAN Ipv6Supported;
  93   UINT8   IfNum;  // interface number to be used with pxeid structure
  94 };
  95
  96 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;
  97 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;
  98
  99 #endif // _EFI_NII_H