]> git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/Protocol/DevicePath.h
Update Protocol for backward-compatible with EFI1.1.
[mirror_edk2.git] / MdePkg / Include / Protocol / DevicePath.h
1 /** @file
2 The device path protocol as defined in EFI 1.0.
3
4 The device path represents a programatic path to a device. It's the view
5 from a software point of view. It also must persist from boot to boot, so
6 it can not contain things like PCI bus numbers that change from boot to boot.
7
8 Copyright (c) 2006, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
13
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16
17 Module Name: DevicePath.h
18
19 **/
20
21 #ifndef __EFI_DEVICE_PATH_PROTOCOL_H__
22 #define __EFI_DEVICE_PATH_PROTOCOL_H__
23
24 //
25 // Device Path protocol
26 //
27 #define EFI_DEVICE_PATH_PROTOCOL_GUID \
28 { \
29 0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
30 }
31
32 //
33 // Protocol GUID defined in EFI1.1.
34 //
35
36 //
37 // Device Path information
38 //
39 #define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID
40
41 #pragma pack(1)
42
43 typedef struct {
44 UINT8 Type;
45 UINT8 SubType;
46 UINT8 Length[2];
47 } EFI_DEVICE_PATH_PROTOCOL;
48
49 //
50 // For backward-compatible with EFI1.1.
51 //
52 typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH;
53
54 //
55 // Hardware Device Paths
56 //
57 #define HARDWARE_DEVICE_PATH 0x01
58
59 #define HW_PCI_DP 0x01
60 typedef struct {
61 EFI_DEVICE_PATH_PROTOCOL Header;
62 UINT8 Function;
63 UINT8 Device;
64 } PCI_DEVICE_PATH;
65
66 #define HW_PCCARD_DP 0x02
67 typedef struct {
68 EFI_DEVICE_PATH_PROTOCOL Header;
69 UINT8 FunctionNumber;
70 } PCCARD_DEVICE_PATH;
71
72 #define HW_MEMMAP_DP 0x03
73 typedef struct {
74 EFI_DEVICE_PATH_PROTOCOL Header;
75 UINT32 MemoryType;
76 EFI_PHYSICAL_ADDRESS StartingAddress;
77 EFI_PHYSICAL_ADDRESS EndingAddress;
78 } MEMMAP_DEVICE_PATH;
79
80 #define HW_VENDOR_DP 0x04
81 typedef struct {
82 EFI_DEVICE_PATH_PROTOCOL Header;
83 EFI_GUID Guid;
84 } VENDOR_DEVICE_PATH;
85
86 #define HW_CONTROLLER_DP 0x05
87 typedef struct {
88 EFI_DEVICE_PATH_PROTOCOL Header;
89 UINT32 ControllerNumber;
90 } CONTROLLER_DEVICE_PATH;
91
92 //
93 // ACPI Device Paths
94 //
95 #define ACPI_DEVICE_PATH 0x02
96
97 #define ACPI_DP 0x01
98 typedef struct {
99 EFI_DEVICE_PATH_PROTOCOL Header;
100 UINT32 HID;
101 UINT32 UID;
102 } ACPI_HID_DEVICE_PATH;
103
104 #define ACPI_EXTENDED_DP 0x02
105 typedef struct {
106 EFI_DEVICE_PATH_PROTOCOL Header;
107 UINT32 HID;
108 UINT32 UID;
109 UINT32 CID;
110 //
111 // Optional variable length _HIDSTR
112 // Optional variable length _UIDSTR
113 //
114 } ACPI_EXTENDED_HID_DEVICE_PATH;
115
116 //
117 // EISA ID Macro
118 // EISA ID Definition 32-bits
119 // bits[15:0] - three character compressed ASCII EISA ID.
120 // bits[31:16] - binary number
121 // Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
122 //
123 #define PNP_EISA_ID_CONST 0x41d0
124 #define EISA_ID(_Name, _Num) ((UINT32) ((_Name) | (_Num) << 16))
125 #define EISA_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
126 #define EFI_PNP_ID(_PNPId) (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
127
128 #define PNP_EISA_ID_MASK 0xffff
129 #define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)
130
131
132 #define ACPI_ADR_DP 0x03
133 typedef struct {
134 EFI_DEVICE_PATH_PROTOCOL Header;
135 UINT32 ADR;
136 } ACPI_ADR_DEVICE_PATH;
137
138
139 //
140 // Messaging Device Paths
141 //
142 #define MESSAGING_DEVICE_PATH 0x03
143
144 #define MSG_ATAPI_DP 0x01
145 typedef struct {
146 EFI_DEVICE_PATH_PROTOCOL Header;
147 UINT8 PrimarySecondary;
148 UINT8 SlaveMaster;
149 UINT16 Lun;
150 } ATAPI_DEVICE_PATH;
151
152 #define MSG_SCSI_DP 0x02
153 typedef struct {
154 EFI_DEVICE_PATH_PROTOCOL Header;
155 UINT16 Pun;
156 UINT16 Lun;
157 } SCSI_DEVICE_PATH;
158
159 #define MSG_FIBRECHANNEL_DP 0x03
160 typedef struct {
161 EFI_DEVICE_PATH_PROTOCOL Header;
162 UINT32 Reserved;
163 UINT64 WWN;
164 UINT64 Lun;
165 } FIBRECHANNEL_DEVICE_PATH;
166
167 #define MSG_1394_DP 0x04
168 typedef struct {
169 EFI_DEVICE_PATH_PROTOCOL Header;
170 UINT32 Reserved;
171 UINT64 Guid;
172 } F1394_DEVICE_PATH;
173
174 #define MSG_USB_DP 0x05
175 typedef struct {
176 EFI_DEVICE_PATH_PROTOCOL Header;
177 UINT8 ParentPortNumber;
178 UINT8 InterfaceNumber;
179 } USB_DEVICE_PATH;
180
181 #define MSG_USB_CLASS_DP 0x0f
182 typedef struct {
183 EFI_DEVICE_PATH_PROTOCOL Header;
184 UINT16 VendorId;
185 UINT16 ProductId;
186 UINT8 DeviceClass;
187 UINT8 DeviceSubClass;
188 UINT8 DeviceProtocol;
189 } USB_CLASS_DEVICE_PATH;
190
191 #define MSG_USB_WWID_DP 0x10
192 typedef struct {
193 EFI_DEVICE_PATH_PROTOCOL Header;
194 UINT16 InterfaceNumber;
195 UINT16 VendorId;
196 UINT16 ProductId;
197 // CHAR16 SerialNumber[...];
198 } USB_WWID_DEVICE_PATH;
199
200
201 #define MSG_DEVICE_LOGICAL_UNIT_DP 0x11
202 typedef struct {
203 EFI_DEVICE_PATH_PROTOCOL Header;
204 UINT8 Lun;
205 } DEVICE_LOGICAL_UNIT_DEVICE_PATH;
206
207 #define MSG_SATA_DP 0x12
208 typedef struct {
209 EFI_DEVICE_PATH_PROTOCOL Header;
210 UINT16 HbaPortNumber;
211 UINT16 PortMultiplierPort;
212 UINT16 LogicalUnitNumber;
213 } SATA_DEVICE_PATH;
214
215 #define MSG_I2O_DP 0x06
216 typedef struct {
217 EFI_DEVICE_PATH_PROTOCOL Header;
218 UINT32 Tid;
219 } I2O_DEVICE_PATH;
220
221 #define MSG_MAC_ADDR_DP 0x0b
222 typedef struct {
223 EFI_DEVICE_PATH_PROTOCOL Header;
224 EFI_MAC_ADDRESS MacAddress;
225 UINT8 IfType;
226 } MAC_ADDR_DEVICE_PATH;
227
228 #define MSG_IPv4_DP 0x0c
229 typedef struct {
230 EFI_DEVICE_PATH_PROTOCOL Header;
231 EFI_IPv4_ADDRESS LocalIpAddress;
232 EFI_IPv4_ADDRESS RemoteIpAddress;
233 UINT16 LocalPort;
234 UINT16 RemotePort;
235 UINT16 Protocol;
236 BOOLEAN StaticIpAddress;
237 } IPv4_DEVICE_PATH;
238
239 #define MSG_IPv6_DP 0x0d
240 typedef struct {
241 EFI_DEVICE_PATH_PROTOCOL Header;
242 EFI_IPv6_ADDRESS LocalIpAddress;
243 EFI_IPv6_ADDRESS RemoteIpAddress;
244 UINT16 LocalPort;
245 UINT16 RemotePort;
246 UINT16 Protocol;
247 BOOLEAN StaticIpAddress;
248 } IPv6_DEVICE_PATH;
249
250 #define MSG_INFINIBAND_DP 0x09
251 typedef struct {
252 EFI_DEVICE_PATH_PROTOCOL Header;
253 UINT32 ResourceFlags;
254 UINT8 PortGid[16];
255 UINT64 ServiceId;
256 UINT64 TargetPortId;
257 UINT64 DeviceId;
258 } INFINIBAND_DEVICE_PATH;
259
260 #define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE 0x01
261 #define INFINIBAND_RESOURCE_FLAG_EXTENDED_BOOT_ENVIRONMENT 0x02
262 #define INFINIBAND_RESOURCE_FLAG_CONSOLE_PROTOCOL 0x04
263 #define INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL 0x08
264 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10
265
266 #define MSG_UART_DP 0x0e
267 typedef struct {
268 EFI_DEVICE_PATH_PROTOCOL Header;
269 UINT32 Reserved;
270 UINT64 BaudRate;
271 UINT8 DataBits;
272 UINT8 Parity;
273 UINT8 StopBits;
274 } UART_DEVICE_PATH;
275
276 //
277 // Use VENDOR_DEVICE_PATH struct
278 //
279 #define MSG_VENDOR_DP 0x0a
280 typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH;
281
282 #define DEVICE_PATH_MESSAGING_PC_ANSI EFI_PC_ANSI_GUID
283 #define DEVICE_PATH_MESSAGING_VT_100 EFI_VT_100_GUID
284 #define DEVICE_PATH_MESSAGING_VT_100_PLUS EFI_VT_100_PLUS_GUID
285 #define DEVICE_PATH_MESSAGING_VT_UTF8 EFI_VT_UTF8_GUID
286
287 #define DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL EFI_UART_DEVICE_PATH_GUID
288
289 typedef struct {
290 EFI_DEVICE_PATH_PROTOCOL Header;
291 EFI_GUID Guid;
292 UINT32 FlowControlMap;
293 } UART_FLOW_CONTROL_DEVICE_PATH;
294
295 #define DEVICE_PATH_MESSAGING_SAS EFI_SAS_DEVICE_PATH_GUID
296
297 typedef struct {
298 EFI_DEVICE_PATH_PROTOCOL Header;
299 EFI_GUID Guid;
300 UINT32 Reserved;
301 UINT64 SasAddress;
302 UINT64 Lun;
303 UINT16 DeviceTopology;
304 UINT16 RelativeTargetPort;
305 } SAS_DEVICE_PATH;
306
307 #define MSG_ISCSI_DP 0x13
308 typedef struct {
309 EFI_DEVICE_PATH_PROTOCOL Header;
310 UINT16 NetworkProtocol;
311 UINT16 LoginOption;
312 UINT16 Reserved;
313 UINT16 TargetPortalGroupTag;
314 UINT64 LUN;
315 // CHAR8 iSCSI Target Name
316 } ISCSI_DEVICE_PATH;
317
318 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000
319 #define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C 0x0002
320 #define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST 0x0000
321 #define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C 0x0008
322 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP 0x0000
323 #define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON 0x1000
324 #define ISCSI_LOGIN_OPTION_CHAP_BI 0x0000
325 #define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000
326
327 //
328 // Media Device Path
329 //
330 #define MEDIA_DEVICE_PATH 0x04
331
332 #define MEDIA_HARDDRIVE_DP 0x01
333 typedef struct {
334 EFI_DEVICE_PATH_PROTOCOL Header;
335 UINT32 PartitionNumber;
336 UINT64 PartitionStart;
337 UINT64 PartitionSize;
338 UINT8 Signature[16];
339 UINT8 MBRType;
340 UINT8 SignatureType;
341 } HARDDRIVE_DEVICE_PATH;
342
343 #define MBR_TYPE_PCAT 0x01
344 #define MBR_TYPE_EFI_PARTITION_TABLE_HEADER 0x02
345
346 #define SIGNATURE_TYPE_MBR 0x01
347 #define SIGNATURE_TYPE_GUID 0x02
348
349 #define MEDIA_CDROM_DP 0x02
350 typedef struct {
351 EFI_DEVICE_PATH_PROTOCOL Header;
352 UINT32 BootEntry;
353 UINT64 PartitionStart;
354 UINT64 PartitionSize;
355 } CDROM_DEVICE_PATH;
356
357 //
358 // Use VENDOR_DEVICE_PATH struct
359 //
360 #define MEDIA_VENDOR_DP 0x03
361
362 #define MEDIA_FILEPATH_DP 0x04
363 typedef struct {
364 EFI_DEVICE_PATH_PROTOCOL Header;
365 CHAR16 PathName[1];
366 } FILEPATH_DEVICE_PATH;
367
368 #define SIZE_OF_FILEPATH_DEVICE_PATH EFI_FIELD_OFFSET(FILEPATH_DEVICE_PATH,PathName)
369
370 #define MEDIA_PROTOCOL_DP 0x05
371 typedef struct {
372 EFI_DEVICE_PATH_PROTOCOL Header;
373 EFI_GUID Protocol;
374 } MEDIA_PROTOCOL_DEVICE_PATH;
375
376
377 #define MEDIA_PIWG_FW_VOL_DP 0x6
378 typedef MEDIA_PROTOCOL_DEVICE_PATH MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;
379
380
381 #define MEDIA_PIWG_FW_FILE_DP 0x7
382 typedef MEDIA_PROTOCOL_DEVICE_PATH MEDIA_FW_VOL_DEVICE_PATH;
383
384 //
385 // BBS Device Path
386 //
387 #define BBS_DEVICE_PATH 0x05
388 #define BBS_BBS_DP 0x01
389 typedef struct {
390 EFI_DEVICE_PATH_PROTOCOL Header;
391 UINT16 DeviceType;
392 UINT16 StatusFlag;
393 CHAR8 String[1];
394 } BBS_BBS_DEVICE_PATH;
395
396 //
397 // DeviceType definitions - from BBS specification
398 //
399 #define BBS_TYPE_FLOPPY 0x01
400 #define BBS_TYPE_HARDDRIVE 0x02
401 #define BBS_TYPE_CDROM 0x03
402 #define BBS_TYPE_PCMCIA 0x04
403 #define BBS_TYPE_USB 0x05
404 #define BBS_TYPE_EMBEDDED_NETWORK 0x06
405 #define BBS_TYPE_BEV 0x80
406 #define BBS_TYPE_UNKNOWN 0xFF
407
408
409 //
410 // Union of all possible Device Paths and pointers to Device Paths
411 //
412
413 typedef union {
414 EFI_DEVICE_PATH_PROTOCOL DevPath;
415 PCI_DEVICE_PATH Pci;
416 PCCARD_DEVICE_PATH PcCard;
417 MEMMAP_DEVICE_PATH MemMap;
418 VENDOR_DEVICE_PATH Vendor;
419
420 CONTROLLER_DEVICE_PATH Controller;
421 ACPI_HID_DEVICE_PATH Acpi;
422
423 ATAPI_DEVICE_PATH Atapi;
424 SCSI_DEVICE_PATH Scsi;
425 FIBRECHANNEL_DEVICE_PATH FibreChannel;
426
427 F1394_DEVICE_PATH F1394;
428 USB_DEVICE_PATH Usb;
429 SATA_DEVICE_PATH Sata;
430 USB_CLASS_DEVICE_PATH UsbClass;
431 I2O_DEVICE_PATH I2O;
432 MAC_ADDR_DEVICE_PATH MacAddr;
433 IPv4_DEVICE_PATH Ipv4;
434 IPv6_DEVICE_PATH Ipv6;
435 INFINIBAND_DEVICE_PATH InfiniBand;
436 UART_DEVICE_PATH Uart;
437
438 HARDDRIVE_DEVICE_PATH HardDrive;
439 CDROM_DEVICE_PATH CD;
440
441 FILEPATH_DEVICE_PATH FilePath;
442 MEDIA_PROTOCOL_DEVICE_PATH MediaProtocol;
443
444 BBS_BBS_DEVICE_PATH Bbs;
445 } EFI_DEV_PATH;
446
447
448
449 typedef union {
450 EFI_DEVICE_PATH_PROTOCOL *DevPath;
451 PCI_DEVICE_PATH *Pci;
452 PCCARD_DEVICE_PATH *PcCard;
453 MEMMAP_DEVICE_PATH *MemMap;
454 VENDOR_DEVICE_PATH *Vendor;
455
456 CONTROLLER_DEVICE_PATH *Controller;
457 ACPI_HID_DEVICE_PATH *Acpi;
458 ACPI_EXTENDED_HID_DEVICE_PATH *ExtendedAcpi;
459
460 ATAPI_DEVICE_PATH *Atapi;
461 SCSI_DEVICE_PATH *Scsi;
462 FIBRECHANNEL_DEVICE_PATH *FibreChannel;
463
464 F1394_DEVICE_PATH *F1394;
465 USB_DEVICE_PATH *Usb;
466 SATA_DEVICE_PATH *Sata;
467 USB_CLASS_DEVICE_PATH *UsbClass;
468 I2O_DEVICE_PATH *I2O;
469 MAC_ADDR_DEVICE_PATH *MacAddr;
470 IPv4_DEVICE_PATH *Ipv4;
471 IPv6_DEVICE_PATH *Ipv6;
472 INFINIBAND_DEVICE_PATH *InfiniBand;
473 UART_DEVICE_PATH *Uart;
474
475 HARDDRIVE_DEVICE_PATH *HardDrive;
476 CDROM_DEVICE_PATH *CD;
477
478 FILEPATH_DEVICE_PATH *FilePath;
479 MEDIA_PROTOCOL_DEVICE_PATH *MediaProtocol;
480
481 BBS_BBS_DEVICE_PATH *Bbs;
482 UINT8 *Raw;
483 } EFI_DEV_PATH_PTR;
484
485 #pragma pack()
486
487 #define EFI_DP_TYPE_MASK 0x7F
488 #define EFI_DP_TYPE_UNPACKED 0x80
489 #define END_DEVICE_PATH_TYPE 0x7f
490
491 #define EFI_END_ENTIRE_DEVICE_PATH 0xff
492 #define EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE 0xff
493 #define EFI_END_INSTANCE_DEVICE_PATH 0x01
494 #define END_ENTIRE_DEVICE_PATH_SUBTYPE EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE
495 #define END_INSTANCE_DEVICE_PATH_SUBTYPE EFI_END_INSTANCE_DEVICE_PATH
496
497 #define EFI_END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))
498 #define END_DEVICE_PATH_LENGTH EFI_END_DEVICE_PATH_LENGTH
499
500 #define DP_IS_END_TYPE(a)
501 #define DP_IS_END_SUBTYPE(a) (((a)->SubType == END_ENTIRE_DEVICE_PATH_SUBTYPE)
502 #define DevicePathSubType(a) ((a)->SubType)
503 #define IsDevicePathUnpacked(a) ((a)->Type & EFI_DP_TYPE_UNPACKED)
504
505 #define EfiDevicePathNodeLength(a) (((a)->Length[0]) | ((a)->Length[1] << 8))
506 #define DevicePathNodeLength(a) (EfiDevicePathNodeLength(a))
507 #define EfiNextDevicePathNode(a) ((EFI_DEVICE_PATH_PROTOCOL *) (((UINT8 *) (a)) + EfiDevicePathNodeLength (a)))
508 #define NextDevicePathNode(a) (EfiNextDevicePathNode(a))
509
510 #define EfiDevicePathType(a) (((a)->Type) & EFI_DP_TYPE_MASK)
511 #define DevicePathType(a) (EfiDevicePathType(a))
512 #define EfiIsDevicePathEndType(a) (EfiDevicePathType (a) == END_DEVICE_PATH_TYPE)
513 #define IsDevicePathEndType(a) (EfiIsDevicePathEndType(a))
514
515
516 #define EfiIsDevicePathEndSubType(a) ((a)->SubType == EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE)
517 #define IsDevicePathEndSubType(a) (EfiIsDevicePathEndSubType(a))
518 #define EfiIsDevicePathEndInstanceSubType(a) ((a)->SubType == EFI_END_INSTANCE_DEVICE_PATH)
519
520 #define EfiIsDevicePathEnd(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndSubType (a))
521 #define IsDevicePathEnd(a) (EfiIsDevicePathEnd(a))
522 #define EfiIsDevicePathEndInstance(a) (EfiIsDevicePathEndType (a) && EfiIsDevicePathEndInstanceSubType (a))
523
524
525 #define SetDevicePathNodeLength(a,l) { \
526 (a)->Length[0] = (UINT8) (l); \
527 (a)->Length[1] = (UINT8) ((l) >> 8); \
528 }
529
530 #define SetDevicePathEndNode(a) { \
531 (a)->Type = END_DEVICE_PATH_TYPE; \
532 (a)->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; \
533 (a)->Length[0] = sizeof(EFI_DEVICE_PATH_PROTOCOL); \
534 (a)->Length[1] = 0; \
535 }
536
537 extern EFI_GUID gEfiDevicePathProtocolGuid;
538
539 #endif