]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | \r | |
3 | This file provides a definition of the EFI IPv4 Configuration\r | |
4 | Protocol.\r | |
5 | \r | |
6 | Copyright (c) 2006 - 2008, Intel Corporation\r | |
7 | All rights reserved. This program and the accompanying materials\r | |
8 | are licensed and made available under the terms and conditions of the BSD License\r | |
9 | which accompanies this distribution. The full text of the license may be found at\r | |
10 | http://opensource.org/licenses/bsd-license.php\r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
14 | \r | |
15 | **/\r | |
16 | #ifndef __EFI_IP4CONFIG_PROTOCOL_H__\r | |
17 | #define __EFI_IP4CONFIG_PROTOCOL_H__\r | |
18 | \r | |
19 | #include <Protocol/Ip4.h>\r | |
20 | \r | |
21 | #define EFI_IP4_CONFIG_PROTOCOL_GUID \\r | |
22 | { \\r | |
23 | 0x3b95aa31, 0x3793, 0x434b, {0x86, 0x67, 0xc8, 0x07, 0x08, 0x92, 0xe0, 0x5e } \\r | |
24 | }\r | |
25 | \r | |
26 | typedef struct _EFI_IP4_CONFIG_PROTOCOL EFI_IP4_CONFIG_PROTOCOL;\r | |
27 | \r | |
28 | #define IP4_CONFIG_VARIABLE_ATTRIBUTES \\r | |
29 | (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | \\r | |
30 | EFI_VARIABLE_RUNTIME_ACCESS)\r | |
31 | \r | |
32 | typedef struct {\r | |
33 | ///\r | |
34 | /// Default station IP address, stored in network byte order.\r | |
35 | ///\r | |
36 | EFI_IPv4_ADDRESS StationAddress;\r | |
37 | ///\r | |
38 | /// Default subnet mask, stored in network byte order.\r | |
39 | ///\r | |
40 | EFI_IPv4_ADDRESS SubnetMask;\r | |
41 | ///\r | |
42 | /// Number of entries in the following RouteTable. May be zero.\r | |
43 | ///\r | |
44 | UINT32 RouteTableSize;\r | |
45 | ///\r | |
46 | /// Default routing table data (stored in network byte order).\r | |
47 | ///\r | |
48 | EFI_IP4_ROUTE_TABLE *RouteTable;\r | |
49 | } EFI_IP4_IPCONFIG_DATA;\r | |
50 | \r | |
51 | \r | |
52 | /**\r | |
53 | Starts running the configuration policy for the EFI IPv4 Protocol driver.\r | |
54 | \r | |
55 | @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r | |
56 | @param DoneEvent Event that will be signaled when the EFI IPv4 Protocol driver\r | |
57 | configuration policy completes execution. This event must be of\r | |
58 | type EVT_NOTIFY_SIGNAL.\r | |
59 | @param ReconfigEvent Event that will be signaled when the EFI IPv4 Protocol driver\r | |
60 | configuration needs to be updated. This event must be of type\r | |
61 | EVT_NOTIFY_SIGNAL.\r | |
62 | \r | |
63 | @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol driver is now\r | |
64 | running.\r | |
65 | @retval EFI_INVALID_PARAMETER This, DoneEvent, or ReconfigEvent is NULL.\r | |
66 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
67 | @retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol driver was\r | |
68 | already started.\r | |
69 | @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.\r | |
70 | @retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol driver\r | |
71 | configuration.\r | |
72 | \r | |
73 | **/\r | |
74 | typedef\r | |
75 | EFI_STATUS\r | |
76 | (EFIAPI *EFI_IP4_CONFIG_START)(\r | |
77 | IN EFI_IP4_CONFIG_PROTOCOL *This,\r | |
78 | IN EFI_EVENT DoneEvent,\r | |
79 | IN EFI_EVENT ReconfigEvent\r | |
80 | );\r | |
81 | \r | |
82 | /**\r | |
83 | Stops running the configuration policy for the EFI IPv4 Protocol driver.\r | |
84 | \r | |
85 | @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r | |
86 | \r | |
87 | @retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol driver has been stopped.\r | |
88 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
89 | @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol driver was not started.\r | |
90 | \r | |
91 | **/\r | |
92 | typedef\r | |
93 | EFI_STATUS\r | |
94 | (EFIAPI *EFI_IP4_CONFIG_STOP)(\r | |
95 | IN EFI_IP4_CONFIG_PROTOCOL *This\r | |
96 | );\r | |
97 | \r | |
98 | /**\r | |
99 | Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.\r | |
100 | \r | |
101 | @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r | |
102 | @param IpConfigDataSize On input, the size of the IpConfigData buffer.\r | |
103 | On output, the count of bytes that were written into the IpConfigData buffer.\r | |
104 | @param IpConfigData Pointer to the EFI IPv4 Configuration Protocol driver\r | |
105 | configuration data structure.\r | |
106 | \r | |
107 | @retval EFI_SUCCESS The EFI IPv4 Protocol driver configuration has been returned.\r | |
108 | @retval EFI_INVALID_PARAMETER This is NULL.\r | |
109 | @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol driver is not\r | |
110 | running.\r | |
111 | @retval EFI_NOT_READY EFI IPv4 Protocol driver configuration is still running.\r | |
112 | @retval EFI_ABORTED EFI IPv4 Protocol driver configuration could not complete.\r | |
113 | @retval EFI_BUFFER_TOO_SMALL *IpConfigDataSize is smaller than the configuration data\r | |
114 | buffer or IpConfigData is NULL.\r | |
115 | \r | |
116 | **/\r | |
117 | typedef\r | |
118 | EFI_STATUS\r | |
119 | (EFIAPI *EFI_IP4_CONFIG_GET_DATA)(\r | |
120 | IN EFI_IP4_CONFIG_PROTOCOL *This,\r | |
121 | IN OUT UINTN *IpConfigDataSize,\r | |
122 | OUT EFI_IP4_IPCONFIG_DATA *IpConfigData OPTIONAL\r | |
123 | );\r | |
124 | \r | |
125 | ///\r | |
126 | /// The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent \r | |
127 | /// configuration for the EFI IPv4 Protocol driver. \r | |
128 | ///\r | |
129 | struct _EFI_IP4_CONFIG_PROTOCOL {\r | |
130 | EFI_IP4_CONFIG_START Start;\r | |
131 | EFI_IP4_CONFIG_STOP Stop;\r | |
132 | EFI_IP4_CONFIG_GET_DATA GetData;\r | |
133 | };\r | |
134 | \r | |
135 | extern EFI_GUID gEfiIp4ConfigProtocolGuid;\r | |
136 | \r | |
137 | #endif\r |