MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h

   1 /** @file
   2   Revision history:
   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   Module name:
  14
  15   EfiNetworkInterfaceIdentifier.h
  16
  17 **/
  18
  19 #ifndef __EFI_NETWORK_INTERFACE_IDENTIFER_H__
  20 #define __EFI_NETWORK_INTERFACE_IDENTIFER_H__
  21
  22
  23 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_GUID \
  24   { \
  25     0xE18541CD, 0xF755, 0x4f73, {0x92, 0x8D, 0x64, 0x3C, 0x8A, 0x79, 0xB2, 0x29 } \
  26   }
  27
  28 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION    0x00010000
  29
  30 //
  31 // Revision defined in EFI1.1.
  32 //
  33 #define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION
  34
  35 //
  36 // Forward reference for pure ANSI compatability
  37 //
  38 typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;
  39
  40 //
  41 // Protocol defined in EFI1.1.
  42 //
  43 typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL   EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE;
  44
  45 typedef enum {
  46   EfiNetworkInterfaceUndi = 1
  47 } EFI_NETWORK_PROTOCOL_TYPE;
  48
  49 struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {
  50
  51   UINT64  Revision;
  52   //
  53   // Revision of the network interface identifier protocol interface.
  54   //
  55   UINT64  ID;
  56   //
  57   // Address of the first byte of the identifying structure for this
  58   // network interface.  This is set to zero if there is no structure.
  59   //
  60   // For PXE/UNDI this is the first byte of the !PXE structure.
  61   //
  62   UINT64  ImageAddr;
  63   //
  64   // Address of the UNrelocated driver/ROM image.  This is set
  65   // to zero if there is no driver/ROM image.
  66   //
  67   // For 16-bit UNDI, this is the first byte of the option ROM in
  68   // upper memory.
  69   //
  70   // For 32/64-bit S/W UNDI, this is the first byte of the EFI ROM
  71   // image.
  72   //
  73   // For H/W UNDI, this is set to zero.
  74   //
  75   UINT32  ImageSize;
  76   //
  77   // Size of the UNrelocated driver/ROM image of this network interface.
  78   // This is set to zero if there is no driver/ROM image.
  79   //
  80   CHAR8   StringId[4];
  81   //
  82   // 4 char ASCII string to go in class identifier (option 60) in DHCP
  83   // and Boot Server discover packets.
  84   // For EfiNetworkInterfaceUndi this field is "UNDI".
  85   // For EfiNetworkInterfaceSnp this field is "SNPN".
  86   //
  87   UINT8   Type;
  88   UINT8   MajorVer;
  89   UINT8   MinorVer;
  90   //
  91   // Information to be placed into the PXE DHCP and Discover packets.
  92   // This is the network interface type and version number that will
  93   // be placed into DHCP option 94 (client network interface identifier).
  94   //
  95   BOOLEAN Ipv6Supported;
  96   UINT8   IfNum;  // interface number to be used with pxeid structure
  97 };
  98
  99 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;
 100 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;
 101
 102 #endif // _EFI_NII_H