]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | EFI_DEVICE_PATH_UTILITIES_PROTOCOL as defined in UEFI 2.0. \r | |
3 | Use to create and manipulate device paths and device nodes.\r | |
4 | \r | |
5 | Copyright (c) 2006, Intel Corporation \r | |
6 | All rights reserved. This program and the accompanying materials \r | |
7 | are licensed and made available under the terms and conditions of the BSD License \r | |
8 | which accompanies this distribution. The full text of the license may be found at \r | |
9 | http://opensource.org/licenses/bsd-license.php \r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
13 | \r | |
14 | Module Name: DevicePathUtilities.h\r | |
15 | \r | |
16 | **/\r | |
17 | \r | |
18 | #ifndef __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r | |
19 | #define __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r | |
20 | \r | |
21 | //\r | |
22 | // Device Path Utilities protocol\r | |
23 | //\r | |
24 | #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \\r | |
25 | { \\r | |
26 | 0x379be4e, 0xd706, 0x437d, {0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4 } \\r | |
27 | }\r | |
28 | \r | |
29 | /**\r | |
30 | Returns the size of the device path, in bytes.\r | |
31 | \r | |
32 | @param DevicePath Points to the start of the EFI device path.\r | |
33 | \r | |
34 | @revtal Size Size of the specified device path, in bytes, including the end-of-path tag.\r | |
35 | \r | |
36 | **/\r | |
37 | typedef\r | |
38 | UINTN\r | |
39 | (EFIAPI *EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE) (\r | |
40 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
41 | )\r | |
42 | ; \r | |
43 | \r | |
44 | \r | |
45 | /**\r | |
46 | Create a duplicate of the specified path.\r | |
47 | \r | |
48 | @param DevicePath Points to the source EFI device path.\r | |
49 | \r | |
50 | @retval Pointer A pointer to the duplicate device path.\r | |
51 | @retval NULL insufficient memory\r | |
52 | \r | |
53 | **/\r | |
54 | typedef\r | |
55 | EFI_DEVICE_PATH_PROTOCOL*\r | |
56 | (EFIAPI *EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH) (\r | |
57 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
58 | )\r | |
59 | ; \r | |
60 | \r | |
61 | /**\r | |
62 | Create a new path by appending the second device path to the first.\r | |
63 | \r | |
64 | @param Src1 Points to the first device path. If NULL, then it is ignored.\r | |
65 | @param Src2 Points to the second device path. If NULL, then it is ignored.\r | |
66 | \r | |
67 | @retval Pointer A pointer to the newly created device path.\r | |
68 | @retval NULL Memory could not be allocated\r | |
69 | or either DevicePath or DeviceNode is NULL.\r | |
70 | \r | |
71 | **/\r | |
72 | typedef\r | |
73 | EFI_DEVICE_PATH_PROTOCOL*\r | |
74 | (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_PATH) (\r | |
75 | IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1,\r | |
76 | IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2\r | |
77 | )\r | |
78 | ; \r | |
79 | \r | |
80 | /**\r | |
81 | Creates a new path by appending the device node to the device path.\r | |
82 | \r | |
83 | @param DevicePath Points to the device path.\r | |
84 | @param DeviceNode Points to the device node.\r | |
85 | \r | |
86 | @retval Pointer A pointer to the allocated device node.\r | |
87 | @retval NULL Memory could not be allocated\r | |
88 | or either DevicePath or DeviceNode is NULL.\r | |
89 | \r | |
90 | **/\r | |
91 | typedef\r | |
92 | EFI_DEVICE_PATH_PROTOCOL*\r | |
93 | (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_NODE) (\r | |
94 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
95 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode\r | |
96 | )\r | |
97 | ;\r | |
98 | \r | |
99 | /**\r | |
100 | Creates a new path by appending the specified device path instance to the specified device path.\r | |
101 | \r | |
102 | @param DevicePath Points to the device path. If NULL, then ignored.\r | |
103 | @param DevicePathInstance Points to the device path instance.\r | |
104 | \r | |
105 | @retval Pointer A pointer to the newly created device path\r | |
106 | @retval NULL Memory could not be allocated or DevicePathInstance is NULL.\r | |
107 | \r | |
108 | **/\r | |
109 | typedef\r | |
110 | EFI_DEVICE_PATH_PROTOCOL*\r | |
111 | (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE) (\r | |
112 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
113 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance\r | |
114 | )\r | |
115 | ; \r | |
116 | \r | |
117 | /**\r | |
118 | Creates a copy of the current device path instance and returns a pointer to the next device path\r | |
119 | instance.\r | |
120 | \r | |
121 | @param DevicePathInstance On input, this holds the pointer to the current device path\r | |
122 | instance. On output, this holds the pointer to the next\r | |
123 | device path instance or NULL if there are no more device\r | |
124 | path instances in the device path. \r | |
125 | @param DevicePathInstanceSize On output, this holds the size of the device path instance,\r | |
126 | in bytes or zero, if DevicePathInstance is zero.\r | |
127 | \r | |
128 | @retval Pointer A pointer to the copy of the current device path instance.\r | |
129 | @retval NULL DevicePathInstace was NULL on entry or there was insufficient memory.\r | |
130 | \r | |
131 | **/\r | |
132 | typedef\r | |
133 | EFI_DEVICE_PATH_PROTOCOL*\r | |
134 | (EFIAPI *EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE) (\r | |
135 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePathInstance,\r | |
136 | OUT UINTN *DevicePathInstanceSize\r | |
137 | )\r | |
138 | ; \r | |
139 | \r | |
140 | /**\r | |
141 | Creates a device node\r | |
142 | \r | |
143 | @param NodeType NodeType is the device node type (EFI_DEVICE_PATH.Type) for\r | |
144 | the new device node.\r | |
145 | @param NodeSubType NodeSubType is the device node sub-type\r | |
146 | EFI_DEVICE_PATH.SubType) for the new device node.\r | |
147 | @param NodeLength NodeLength is the length of the device node\r | |
148 | (EFI_DEVICE_PATH.Length) for the new device node.\r | |
149 | \r | |
150 | @retval Pointer A pointer to the newly created device node.\r | |
151 | @retval NULL NodeLength is less than\r | |
152 | the size of the header or there was insufficient memory.\r | |
153 | \r | |
154 | **/\r | |
155 | typedef\r | |
156 | EFI_DEVICE_PATH_PROTOCOL*\r | |
157 | (EFIAPI *EFI_DEVICE_PATH_CREATE_NODE) (\r | |
158 | IN UINT8 NodeType,\r | |
159 | IN UINT8 NodeSubType,\r | |
160 | IN UINT16 NodeLength\r | |
161 | )\r | |
162 | ; \r | |
163 | \r | |
164 | /**\r | |
165 | Returns whether a device path is multi-instance.\r | |
166 | \r | |
167 | @param DevicePath Points to the device path. If NULL, then ignored.\r | |
168 | \r | |
169 | @retval TRUE The device path has more than one instance\r | |
170 | @retval FALSE The device path is empty or contains only a single instance.\r | |
171 | \r | |
172 | **/\r | |
173 | typedef\r | |
174 | BOOLEAN\r | |
175 | (EFIAPI *EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE) (\r | |
176 | IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
177 | )\r | |
178 | ; \r | |
179 | \r | |
180 | \r | |
181 | typedef struct {\r | |
182 | EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE GetDevicePathSize;\r | |
183 | EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH DuplicateDevicePath;\r | |
184 | EFI_DEVICE_PATH_UTILS_APPEND_PATH AppendDevicePath;\r | |
185 | EFI_DEVICE_PATH_UTILS_APPEND_NODE AppendDeviceNode;\r | |
186 | EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE AppendDevicePathInstance;\r | |
187 | EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE GetNextDevicePathInstance;\r | |
188 | EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE IsDevicePathMultiInstance;\r | |
189 | EFI_DEVICE_PATH_CREATE_NODE CreateDeviceNode;\r | |
190 | } EFI_DEVICE_PATH_UTILITIES_PROTOCOL;\r | |
191 | \r | |
192 | extern EFI_GUID gEfiDevicePathUtilitiesProtocolGuid; \r | |
193 | \r | |
194 | #endif\r |