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