]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/DevicePath.h
Grammatical and disclaimer changes (does not follow internal C coding stds.)
[mirror_edk2.git] / MdePkg / Include / Protocol / DevicePath.h
index 1968f48b8d5f4159f5bb5513dd6b9bb38969e6d0..dee780c35f8f340eba05020ff0007f551612e356 100644 (file)
@@ -5,14 +5,14 @@
   from a software point of view. The path must persist from boot to boot, so \r
   it can not contain things like PCI bus numbers that change from boot to boot.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.              \r
 \r
 **/\r
 \r
@@ -22,7 +22,7 @@
 #include <Guid/PcAnsi.h>\r
 \r
 ///\r
-/// Device Path protocol\r
+/// Device Path protocol.\r
 ///\r
 #define EFI_DEVICE_PATH_PROTOCOL_GUID \\r
   { \\r
   that make up the Device Path.\r
 **/\r
 typedef struct {\r
-  UINT8 Type;       ///< 0x01 Hardware Device Path\r
-                    ///< 0x02 ACPI Device Path\r
-                    ///< 0x03 Messaging Device Path\r
-                    ///< 0x04 Media Device Path\r
-                    ///< 0x05 BIOS Boot Specification Device Path\r
-                    ///< 0x7F End of Hardware Device Path\r
+  UINT8 Type;       ///< 0x01 Hardware Device Path.\r
+                    ///< 0x02 ACPI Device Path.\r
+                    ///< 0x03 Messaging Device Path.\r
+                    ///< 0x04 Media Device Path.\r
+                    ///< 0x05 BIOS Boot Specification Device Path.\r
+                    ///< 0x7F End of Hardware Device Path.\r
                     \r
   UINT8 SubType;    ///< Varies by Type\r
                     ///< 0xFF End Entire Device Path, or\r
                     ///< 0x01 End This Instance of a Device Path and start a new\r
-                    ///< Device Path\r
+                    ///< Device Path.\r
                     \r
   UINT8 Length[2];  ///< Specific Device Path data. Type and Sub-Type define\r
                     ///< type of data. Size of data is included in Length.\r
@@ -68,53 +68,53 @@ typedef struct {
 typedef EFI_DEVICE_PATH_PROTOCOL  EFI_DEVICE_PATH;\r
 \r
 ///\r
-/// Hardware Device Paths\r
+/// Hardware Device Paths.\r
 ///\r
 #define HARDWARE_DEVICE_PATH      0x01\r
 \r
 ///\r
-/// PCI Device Path SubType\r
+/// PCI Device Path SubType.\r
 ///\r
 #define HW_PCI_DP                 0x01\r
 \r
 ///\r
-/// PCI Device Path\r
+/// PCI Device Path.\r
 ///\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// PCI Function Number\r
+  /// PCI Function Number.\r
   ///\r
   UINT8                           Function;\r
   ///\r
-  /// PCI Device Number\r
+  /// PCI Device Number.\r
   ///\r
   UINT8                           Device;\r
 } PCI_DEVICE_PATH;\r
 \r
 ///\r
-/// PCCARD Device Path SubType\r
+/// PCCARD Device Path SubType.\r
 ///\r
 #define HW_PCCARD_DP              0x02\r
 \r
 ///\r
-/// PCCARD Device Path\r
+/// PCCARD Device Path.\r
 ///\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// Function Number (0 = First Function)\r
+  /// Function Number (0 = First Function).\r
   ///\r
   UINT8                           FunctionNumber;\r
 } PCCARD_DEVICE_PATH;\r
 \r
 ///\r
-/// Memory Mapped Device Path SubType\r
+/// Memory Mapped Device Path SubType.\r
 ///\r
 #define HW_MEMMAP_DP              0x03\r
 \r
 ///\r
-/// Memory Mapped Device Path\r
+/// Memory Mapped Device Path.\r
 ///\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
@@ -127,13 +127,13 @@ typedef struct {
   ///\r
   EFI_PHYSICAL_ADDRESS            StartingAddress;\r
   ///\r
-  /// Ending Memory Address\r
+  /// Ending Memory Address.\r
   ///\r
   EFI_PHYSICAL_ADDRESS            EndingAddress;\r
 } MEMMAP_DEVICE_PATH;\r
 \r
 ///\r
-/// Hardware Vendor Device Path SubType\r
+/// Hardware Vendor Device Path SubType.\r
 ///\r
 #define HW_VENDOR_DP              0x04\r
 \r
@@ -154,12 +154,12 @@ typedef struct {
 } VENDOR_DEVICE_PATH;\r
 \r
 ///\r
-/// Controller Device Path SubType\r
+/// Controller Device Path SubType.\r
 ///\r
 #define HW_CONTROLLER_DP          0x05\r
 \r
 ///\r
-/// Controller Device Path\r
+/// Controller Device Path.\r
 ///\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
@@ -170,12 +170,12 @@ typedef struct {
 } CONTROLLER_DEVICE_PATH;\r
 \r
 ///\r
-/// ACPI Device Paths \r
+/// ACPI Device Paths.\r
 ///\r
 #define ACPI_DEVICE_PATH          0x02\r
 \r
 ///\r
-/// ACPI Device Path SubType\r
+/// ACPI Device Path SubType.\r
 ///\r
 #define ACPI_DP                   0x01\r
 typedef struct {\r
@@ -190,14 +190,14 @@ typedef struct {
   /// Unique ID that is required by ACPI if two devices have the\r
   /// same _HID. This value must also match the corresponding\r
   /// _UID/_HID pair in the ACPI name space. Only the 32-bit\r
-  /// numeric value type of _UID is supported; thus strings must\r
+  /// numeric value type of _UID is supported. Thus, strings must\r
   /// not be used for the _UID in the ACPI name space.\r
   ///\r
   UINT32                          UID;\r
 } ACPI_HID_DEVICE_PATH;\r
 \r
 ///\r
-/// Expanded ACPI Device Path SubType\r
+/// Expanded ACPI Device Path SubType.\r
 ///\r
 #define ACPI_EXTENDED_DP          0x02\r
 typedef struct {\r
@@ -222,9 +222,9 @@ typedef struct {
   ///\r
   UINT32                          CID;\r
   ///\r
-  /// Optional variable length _HIDSTR\r
-  /// Optional variable length _UIDSTR\r
-  /// Optional variable length _CIDSTR\r
+  /// Optional variable length _HIDSTR.\r
+  /// Optional variable length _UIDSTR.\r
+  /// Optional variable length _CIDSTR.\r
   ///\r
 } ACPI_EXTENDED_HID_DEVICE_PATH;\r
 \r
@@ -244,7 +244,7 @@ typedef struct {
 #define EISA_ID_TO_NUM(_Id)       ((_Id) >> 16)\r
 \r
 ///\r
-/// ACPI _ADR Device Path SubType\r
+/// ACPI _ADR Device Path SubType.\r
 ///\r
 #define ACPI_ADR_DP               0x03\r
 \r
@@ -257,7 +257,7 @@ typedef struct {
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
   /// _ADR value. For video output devices the value of this\r
-  /// field comes from Table B-2 ACPI 3.0 specification. At\r
+  /// field comes from Table B-2 of the ACPI 3.0 specification. At\r
   /// least one _ADR value is required.\r
   ///\r
   UINT32                          ADR;\r
@@ -283,7 +283,7 @@ typedef struct {
                        ((_Index)          & 0xf) ))\r
 \r
 ///\r
-/// Messaging Device Paths\r
+/// Messaging Device Paths.\r
 /// This Device Path is used to describe the connection of devices outside the resource domain of the\r
 /// system. This Device Path can describe physical messaging information like SCSI ID, or abstract\r
 /// information like networking protocol IP addresses.\r
@@ -297,37 +297,37 @@ typedef struct {
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// Set to zero for primary or one for secondary\r
+  /// Set to zero for primary, or one for secondary.\r
   ///\r
   UINT8                           PrimarySecondary;\r
   ///\r
-  /// Set to zero for master or one for slave mode\r
+  /// Set to zero for master, or one for slave mode.\r
   ///\r
   UINT8                           SlaveMaster;\r
   ///\r
-  /// Logical Unit Number\r
+  /// Logical Unit Number.\r
   ///\r
   UINT16                          Lun;\r
 } ATAPI_DEVICE_PATH;\r
 \r
 ///\r
-/// SCSI Device Path SubType\r
+/// SCSI Device Path SubType.\r
 ///\r
 #define MSG_SCSI_DP               0x02\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// Target ID on the SCSI bus (PUN)\r
+  /// Target ID on the SCSI bus (PUN).\r
   ///\r
   UINT16                          Pun;\r
   ///\r
-  /// Logical Unit Number (LUN)\r
+  /// Logical Unit Number (LUN).\r
   ///\r
   UINT16                          Lun;\r
 } SCSI_DEVICE_PATH;\r
 \r
 ///\r
-/// Fibre Channel SubType\r
+/// Fibre Channel SubType.\r
 ///\r
 #define MSG_FIBRECHANNEL_DP       0x03\r
 typedef struct {\r
@@ -363,23 +363,23 @@ typedef struct {
 } F1394_DEVICE_PATH;\r
 \r
 ///\r
-/// USB Device Path SubType\r
+/// USB Device Path SubType.\r
 ///\r
 #define MSG_USB_DP                0x05\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL      Header;\r
   ///\r
-  /// USB Parent Port Number\r
+  /// USB Parent Port Number.\r
   ///\r
   UINT8                         ParentPortNumber;\r
   ///\r
-  /// USB Interface Number\r
+  /// USB Interface Number.\r
   ///\r
   UINT8                         InterfaceNumber;\r
 } USB_DEVICE_PATH;\r
 \r
 ///\r
-/// USB Class Device Path SubType\r
+/// USB Class Device Path SubType.\r
 ///\r
 #define MSG_USB_CLASS_DP          0x0f\r
 typedef struct {\r
@@ -412,7 +412,7 @@ typedef struct {
 } USB_CLASS_DEVICE_PATH;\r
 \r
 ///\r
-/// USB WWID Device Path SubType\r
+/// USB WWID Device Path SubType.\r
 ///\r
 #define MSG_USB_WWID_DP           0x10\r
 \r
@@ -422,15 +422,15 @@ typedef struct {
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL      Header;\r
   ///\r
-  /// USB interface number\r
+  /// USB interface number.\r
   ///\r
   UINT16                        InterfaceNumber;\r
   ///\r
-  /// USB vendor id of the device\r
+  /// USB vendor id of the device.\r
   ///\r
   UINT16                        VendorId;\r
   ///\r
-  /// USB product id of the device\r
+  /// USB product id of the device.\r
   ///\r
   UINT16                        ProductId;\r
   ///\r
@@ -443,19 +443,19 @@ typedef struct {
 } USB_WWID_DEVICE_PATH;\r
 \r
 ///\r
-/// Device Logical Unit SubType\r
+/// Device Logical Unit SubType.\r
 ///\r
 #define MSG_DEVICE_LOGICAL_UNIT_DP  0x11\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL      Header;\r
   ///\r
-  /// Logical Unit Number for the interface\r
+  /// Logical Unit Number for the interface.\r
   ///\r
   UINT8                         Lun;\r
 } DEVICE_LOGICAL_UNIT_DEVICE_PATH;\r
 \r
 ///\r
-/// SATA Device Path SubType\r
+/// SATA Device Path SubType.\r
 ///\r
 #define MSG_SATA_DP               0x12\r
 typedef struct {\r
@@ -483,25 +483,25 @@ typedef struct {
 #define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000\r
 \r
 ///\r
-/// I2O Device Path SubType\r
+/// I2O Device Path SubType.\r
 ///\r
 #define MSG_I2O_DP                0x06\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// Target ID (TID) for a device\r
+  /// Target ID (TID) for a device.\r
   ///\r
   UINT32                          Tid;\r
 } I2O_DEVICE_PATH;\r
 \r
 ///\r
-/// MAC Address Device Path SubType\r
+/// MAC Address Device Path SubType.\r
 ///\r
 #define MSG_MAC_ADDR_DP           0x0b\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// The MAC address for a network interface padded with 0s\r
+  /// The MAC address for a network interface padded with 0s.\r
   ///\r
   EFI_MAC_ADDRESS                 MacAddress;\r
   ///\r
@@ -517,19 +517,19 @@ typedef struct {
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// The local IPv4 address\r
+  /// The local IPv4 address.\r
   ///\r
   EFI_IPv4_ADDRESS                LocalIpAddress;\r
   ///\r
-  /// The remote IPv4 address\r
+  /// The remote IPv4 address.\r
   ///\r
   EFI_IPv4_ADDRESS                RemoteIpAddress;\r
   ///\r
-  /// The local port number\r
+  /// The local port number.\r
   ///\r
   UINT16                          LocalPort;\r
   ///\r
-  /// The remote port number\r
+  /// The remote port number.\r
   ///\r
   UINT16                          RemotePort;\r
   ///\r
@@ -537,32 +537,32 @@ typedef struct {
   ///\r
   UINT16                          Protocol;\r
   ///\r
-  /// 0x00 - The Source IP Address was assigned though DHCP\r
-  /// 0x01 - The Source IP Address is statically bound\r
+  /// 0x00 - The Source IP Address was assigned though DHCP.\r
+  /// 0x01 - The Source IP Address is statically bound.\r
   ///\r
   BOOLEAN                         StaticIpAddress;\r
 } IPv4_DEVICE_PATH;\r
 \r
 ///\r
-/// IPv6 Device Path SubType\r
+/// IPv6 Device Path SubType.\r
 ///\r
 #define MSG_IPv6_DP               0x0d\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// The local IPv6 address\r
+  /// The local IPv6 address.\r
   ///\r
   EFI_IPv6_ADDRESS                LocalIpAddress;\r
   ///\r
-  /// The remote IPv6 address\r
+  /// The remote IPv6 address.\r
   ///\r
   EFI_IPv6_ADDRESS                RemoteIpAddress;\r
   ///\r
-  /// The local port number\r
+  /// The local port number.\r
   ///\r
   UINT16                          LocalPort;\r
   ///\r
-  /// The remote port number\r
+  /// The remote port number.\r
   ///\r
   UINT16                          RemotePort;\r
   ///\r
@@ -570,43 +570,43 @@ typedef struct {
   ///\r
   UINT16                          Protocol;\r
   ///\r
-  /// 0x00 - The Source IP Address was assigned though DHCP\r
-  /// 0x01 - The Source IP Address is statically bound\r
+  /// 0x00 - The Source IP Address was assigned though DHCP.\r
+  /// 0x01 - The Source IP Address is statically bound.\r
   ///\r
   BOOLEAN                         StaticIpAddress;\r
 } IPv6_DEVICE_PATH;\r
 \r
 ///\r
-/// InfiniBand Device Path SubType\r
+/// InfiniBand Device Path SubType.\r
 ///\r
 #define MSG_INFINIBAND_DP         0x09\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
   /// Flags to help identify/manage InfiniBand device path elements:\r
-  /// Bit 0 - IOC/Service (0b = IOC, 1b = Service)\r
-  /// Bit 1 - Extend Boot Environment\r
-  /// Bit 2 - Console Protocol\r
-  /// Bit 3 - Storage Protocol\r
-  /// Bit 4 - Network Protocol\r
+  /// Bit 0 - IOC/Service (0b = IOC, 1b = Service).\r
+  /// Bit 1 - Extend Boot Environment.\r
+  /// Bit 2 - Console Protocol.\r
+  /// Bit 3 - Storage Protocol.\r
+  /// Bit 4 - Network Protocol.\r
   /// All other bits are reserved.\r
   ///\r
   UINT32                          ResourceFlags;\r
   ///\r
-  /// 128-bit Global Identifier for remote fabric port\r
+  /// 128-bit Global Identifier for remote fabric port.\r
   ///\r
   UINT8                           PortGid[16];\r
   ///\r
   /// 64-bit unique identifier to remote IOC or server process.\r
-  /// Interpretation of field specified by Resource Flags (bit 0)\r
+  /// Interpretation of field specified by Resource Flags (bit 0).\r
   ///\r
   UINT64                          ServiceId;\r
   ///\r
-  /// 64-bit persistent ID of remote IOC port\r
+  /// 64-bit persistent ID of remote IOC port.\r
   ///\r
   UINT64                          TargetPortId;\r
   ///\r
-  /// 64-bit persistent ID of remote device\r
+  /// 64-bit persistent ID of remote device.\r
   ///\r
   UINT64                          DeviceId;\r
 } INFINIBAND_DEVICE_PATH;\r
@@ -618,13 +618,13 @@ typedef struct {
 #define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL           0x10\r
 \r
 ///\r
-/// UART Device Path SubType\r
+/// UART Device Path SubType.\r
 ///\r
 #define MSG_UART_DP               0x0e\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// Reserved\r
+  /// Reserved.\r
   ///\r
   UINT32                          Reserved;\r
   ///\r
@@ -639,20 +639,20 @@ typedef struct {
   UINT8                           DataBits;\r
   ///\r
   /// The parity setting for the UART style device.\r
-  /// Parity 0x00 - Default Parity\r
-  /// Parity 0x01 - No Parity\r
-  /// Parity 0x02 - Even Parity\r
-  /// Parity 0x03 - Odd Parity\r
-  /// Parity 0x04 - Mark Parity\r
-  /// Parity 0x05 - Space Parity\r
+  /// Parity 0x00 - Default Parity.\r
+  /// Parity 0x01 - No Parity.\r
+  /// Parity 0x02 - Even Parity.\r
+  /// Parity 0x03 - Odd Parity.\r
+  /// Parity 0x04 - Mark Parity.\r
+  /// Parity 0x05 - Space Parity.\r
   ///\r
   UINT8                           Parity;\r
   ///\r
   /// The number of stop bits for the UART style device.\r
-  /// Stop Bits 0x00 - Default Stop Bits\r
-  /// Stop Bits 0x01 - 1 Stop Bit\r
-  /// Stop Bits 0x02 - 1.5 Stop Bits\r
-  /// Stop Bits 0x03 - 2 Stop Bits\r
+  /// Stop Bits 0x00 - Default Stop Bits.\r
+  /// Stop Bits 0x01 - 1 Stop Bit.\r
+  /// Stop Bits 0x02 - 1.5 Stop Bits.\r
+  /// Stop Bits 0x03 - 2 Stop Bits.\r
   ///\r
   UINT8                           StopBits;\r
 } UART_DEVICE_PATH;\r
@@ -675,7 +675,7 @@ typedef VENDOR_DEVICE_PATH        VENDOR_DEFINED_DEVICE_PATH;
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID\r
+  /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID.\r
   ///\r
   EFI_GUID                        Guid;\r
   ///\r
@@ -694,7 +694,7 @@ typedef struct {
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// DEVICE_PATH_MESSAGING_SAS GUID\r
+  /// DEVICE_PATH_MESSAGING_SAS GUID.\r
   ///\r
   EFI_GUID                        Guid;\r
   ///\r
@@ -710,11 +710,11 @@ typedef struct {
   ///\r
   UINT64                          Lun;\r
   ///\r
-  /// More Information about the device and its interconnect\r
+  /// More Information about the device and its interconnect.\r
   ///\r
   UINT16                          DeviceTopology;\r
   ///\r
-  /// Relative Target Port (RTP)\r
+  /// Relative Target Port (RTP).\r
   ///\r
   UINT16                          RelativeTargetPort;\r
 } SAS_DEVICE_PATH;\r
@@ -726,15 +726,15 @@ typedef struct {
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// Network Protocol (0 = TCP, 1+ = reserved)\r
+  /// Network Protocol (0 = TCP, 1+ = reserved).\r
   ///\r
   UINT16                          NetworkProtocol;\r
   ///\r
-  /// iSCSI Login Options\r
+  /// iSCSI Login Options.\r
   ///\r
   UINT16                          LoginOption;\r
   ///\r
-  /// iSCSI Logical Unit Number\r
+  /// iSCSI Logical Unit Number.\r
   ///\r
   UINT64                          Lun;\r
   ///\r
@@ -746,7 +746,7 @@ typedef struct {
   /// iSCSI NodeTarget Name. The length of the name\r
   /// is determined by subtracting the offset of this field from Length.\r
   ///\r
-  /// CHAR8                        iSCSI Target Name\r
+  /// CHAR8                        iSCSI Target Name.\r
 } ISCSI_DEVICE_PATH;\r
 \r
 #define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST             0x0000\r
@@ -759,13 +759,13 @@ typedef struct {
 #define ISCSI_LOGIN_OPTION_CHAP_UNI                     0x2000\r
 \r
 ///\r
-/// VLAN Device Path SubType\r
+/// VLAN Device Path SubType.\r
 ///\r
 #define MSG_VLAN_DP               0x14\r
 typedef struct {\r
   EFI_DEVICE_PATH_PROTOCOL        Header;\r
   ///\r
-  /// VLAN identifier (0-4094)\r
+  /// VLAN identifier (0-4094).\r
   ///\r
   UINT16                          VlanId;\r
 } VLAN_DEVICE_PATH;\r
@@ -776,7 +776,7 @@ typedef struct {
 #define MEDIA_DEVICE_PATH         0x04\r
 \r
 ///\r
-/// Hard Drive Media Device Path SubType\r
+/// Hard Drive Media Device Path SubType.\r
 ///\r
 #define MEDIA_HARDDRIVE_DP        0x01\r
 \r
@@ -793,11 +793,11 @@ typedef struct {
   ///\r
   UINT32                          PartitionNumber;\r
   ///\r
-  /// Starting LBA of the partition on the hard drive\r
+  /// Starting LBA of the partition on the hard drive.\r
   ///\r
   UINT64                          PartitionStart;\r
   ///\r
-  /// Size of the partition in units of Logical Blocks\r
+  /// Size of the partition in units of Logical Blocks.\r
   ///\r
   UINT64                          PartitionSize;\r
   ///\r
@@ -809,13 +809,13 @@ typedef struct {
   ///\r
   UINT8                           Signature[16];\r
   ///\r
-  /// Partition Format: (Unused values reserved)\r
-  /// 0x01 - PC-AT compatible legacy MBR\r
-  /// 0x02 - GUID Partition Table\r
+  /// Partition Format: (Unused values reserved).\r
+  /// 0x01 - PC-AT compatible legacy MBR.\r
+  /// 0x02 - GUID Partition Table.\r
   ///\r
   UINT8                           MBRType;\r
   ///\r
-  /// Type of Disk Signature: (Unused values reserved)\r
+  /// Type of Disk Signature: (Unused values reserved).\r
   /// 0x00 - No Disk Signature.\r
   /// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.\r
   /// 0x02 - GUID signature.\r
@@ -831,7 +831,7 @@ typedef struct {
 #define SIGNATURE_TYPE_GUID       0x02\r
 \r
 ///\r
-/// CD-ROM Media Device Path SubType\r
+/// CD-ROM Media Device Path SubType.\r
 ///\r
 #define MEDIA_CDROM_DP            0x02\r
 \r
@@ -857,7 +857,7 @@ typedef struct {
 //\r
 // Use VENDOR_DEVICE_PATH struct\r
 //\r
-#define MEDIA_VENDOR_DP           0x03  ///< Media vendor device path subtype\r
+#define MEDIA_VENDOR_DP           0x03  ///< Media vendor device path subtype.\r
 \r
 ///\r
 /// File Path Media Device Path SubType\r
@@ -874,7 +874,7 @@ typedef struct {
 #define SIZE_OF_FILEPATH_DEVICE_PATH  OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)\r
 \r
 ///\r
-/// Media Protocol Device Path SubType\r
+/// Media Protocol Device Path SubType.\r
 ///\r
 #define MEDIA_PROTOCOL_DP         0x05\r
 \r
@@ -892,7 +892,7 @@ typedef struct {
 } MEDIA_PROTOCOL_DEVICE_PATH;\r
 \r
 ///\r
-/// PIWG Firmware Volume Device Path SubType\r
+/// PIWG Firmware Volume Device Path SubType.\r
 ///\r
 #define MEDIA_PIWG_FW_FILE_DP     0x06\r
 \r
@@ -908,7 +908,7 @@ typedef struct {
 } MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;\r
 \r
 ///\r
-/// PIWG Firmware Volume Device Path SubType\r
+/// PIWG Firmware Volume Device Path SubType.\r
 ///\r
 #define MEDIA_PIWG_FW_VOL_DP      0x07\r
 \r
@@ -924,7 +924,7 @@ typedef struct {
 } MEDIA_FW_VOL_DEVICE_PATH;\r
 \r
 ///\r
-/// Media relative offset range device path\r
+/// Media relative offset range device path.\r
 ///\r
 #define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08\r
 \r
@@ -939,12 +939,12 @@ typedef struct {
 } MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH;\r
 \r
 ///\r
-/// BIOS Boot Specification Device Path\r
+/// BIOS Boot Specification Device Path.\r
 ///\r
 #define BBS_DEVICE_PATH           0x05\r
 \r
 ///\r
-/// BIOS Boot Specification Device Path SubType\r
+/// BIOS Boot Specification Device Path SubType.\r
 ///\r
 #define BBS_BBS_DP                0x01\r
 \r
@@ -958,7 +958,7 @@ typedef struct {
   ///\r
   UINT16                          DeviceType;\r
   ///\r
-  /// Status Flags as defined by the BIOS Boot Specification\r
+  /// Status Flags as defined by the BIOS Boot Specification.\r
   ///\r
   UINT16                          StatusFlag;\r
   ///\r
@@ -981,7 +981,7 @@ typedef struct {
 \r
 \r
 ///\r
-/// Union of all possible Device Paths and pointers to Device Paths\r
+/// Union of all possible Device Paths and pointers to Device Paths.\r
 ///\r
 typedef union {\r
   EFI_DEVICE_PATH_PROTOCOL             DevPath;\r