OldMdePkg/Include/Protocol/EfiNetworkInterfaceIdentifier.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 // Forward reference for pure ANSI compatability
  32 //
  33 typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;
  34
  35 typedef enum {
  36   EfiNetworkInterfaceUndi = 1
  37 } EFI_NETWORK_PROTOCOL_TYPE;
  38
  39 struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {
  40
  41   UINT64  Revision;
  42   //
  43   // Revision of the network interface identifier protocol interface.
  44   //
  45   UINT64  ID;
  46   //
  47   // Address of the first byte of the identifying structure for this
  48   // network interface.  This is set to zero if there is no structure.
  49   //
  50   // For PXE/UNDI this is the first byte of the !PXE structure.
  51   //
  52   UINT64  ImageAddr;
  53   //
  54   // Address of the UNrelocated driver/ROM image.  This is set
  55   // to zero if there is no driver/ROM image.
  56   //
  57   // For 16-bit UNDI, this is the first byte of the option ROM in
  58   // upper memory.
  59   //
  60   // For 32/64-bit S/W UNDI, this is the first byte of the EFI ROM
  61   // image.
  62   //
  63   // For H/W UNDI, this is set to zero.
  64   //
  65   UINT32  ImageSize;
  66   //
  67   // Size of the UNrelocated driver/ROM image of this network interface.
  68   // This is set to zero if there is no driver/ROM image.
  69   //
  70   CHAR8   StringId[4];
  71   //
  72   // 4 char ASCII string to go in class identifier (option 60) in DHCP
  73   // and Boot Server discover packets.
  74   // For EfiNetworkInterfaceUndi this field is "UNDI".
  75   // For EfiNetworkInterfaceSnp this field is "SNPN".
  76   //
  77   UINT8   Type;
  78   UINT8   MajorVer;
  79   UINT8   MinorVer;
  80   //
  81   // Information to be placed into the PXE DHCP and Discover packets.
  82   // This is the network interface type and version number that will
  83   // be placed into DHCP option 94 (client network interface identifier).
  84   //
  85   BOOLEAN Ipv6Supported;
  86   UINT8   IfNum;  // interface number to be used with pxeid structure
  87 };
  88
  89 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;
  90 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid_31;
  91
  92 #endif // _EFI_NII_H