]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
Committing changes to the comments, to improve code documentation.
[mirror_edk2.git] / MdeModulePkg / Include / Guid / NicIp4ConfigNvData.h
CommitLineData
63886849 1/** @file\r
2 This file defines NIC_IP4_CONFIG_INFO structure.\r
3 \r
4Copyright (c) 2009, Intel Corporation\r
5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef __NIC_IP4_CONFIG_NVDATA_H__\r
16#define __NIC_IP4_CONFIG_NVDATA_H__\r
17\r
18#include <Protocol/Ip4Config.h>\r
19\r
20#define EFI_NIC_IP4_CONFIG_VARIABLE_GUID \\r
21 { \\r
22 0xd8944553, 0xc4dd, 0x41f4, { 0x9b, 0x30, 0xe1, 0x39, 0x7c, 0xfb, 0x26, 0x7b } \\r
23 }\r
24\r
25#define EFI_NIC_IP4_CONFIG_VARIABLE L"EfiNicIp4ConfigVariable"\r
26\r
27typedef enum {\r
28 //\r
29 // Config source: dhcp or static\r
30 //\r
31 IP4_CONFIG_SOURCE_DHCP = 0,\r
32 IP4_CONFIG_SOURCE_STATIC,\r
33 IP4_CONFIG_SOURCE_MAX,\r
34\r
35 IP4_NIC_NAME_LENGTH = 64,\r
36 MAX_IP4_CONFIG_IN_VARIABLE = 16\r
37} IP4_CONFIG_TYPE;\r
38\r
39//\r
40// The following structures are used by drivers/applications other\r
e9b67286 41// than EFI_IP4_PROTOCOL, such as the ifconfig shell application, to\r
42// communicate the IP configuration information to the EFI_IP4_CONFIG_PROTOCOL.\r
43// The EFI_IP4_PROTOCOL uses the EFI_IP4_CONFIG_PROTOCOL to get\r
44// the default IP4 configuration.\r
63886849 45//\r
46\r
47///\r
48/// NIC_ADDR contains the interface's type and MAC address to identify\r
49/// a specific NIC.\r
50///\r
51typedef struct {\r
52 UINT16 Type; ///< Interface type\r
53 UINT8 Len; ///< Length of MAC address\r
54 EFI_MAC_ADDRESS MacAddr; ///< MAC address of interface\r
55} NIC_ADDR;\r
56\r
57///\r
58/// NIC_IP4_CONFIG_INFO contains the IP4 configure\r
59/// parameters for that NIC. NIC_IP4_CONFIG_INFO is\r
60/// of variable length.\r
61///\r
62typedef struct {\r
63 NIC_ADDR NicAddr; ///< Link layer address to identify the NIC\r
64 UINT32 Source; ///< Static or DHCP\r
65 BOOLEAN Perment; ///< Survive the reboot or not\r
66 EFI_IP4_IPCONFIG_DATA Ip4Info; ///< IP addresses\r
67} NIC_IP4_CONFIG_INFO;\r
68\r
69extern EFI_GUID gEfiNicIp4ConfigVariableGuid;\r
70\r
71#endif\r