Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Atapi.h

diff --git a/MdePkg/Include/IndustryStandard/Atapi.h b/MdePkg/Include/IndustryStandard/Atapi.h
index 276d364e674442f037bec426c62195dc10e35541..4c4588042a1fafe1d7a75ce36869fd8718357ed8 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Atapi.h
+++ b/MdePkg/Include/IndustryStandard/Atapi.h
@@ -2,13 +2,13 @@
   This file contains just some basic definitions that are needed by drivers\r
   that dealing with ATA/ATAPI interface.\r
 \r
-Copyright (c) 2007 - 2010, 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
+Copyright (c) 2007 - 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
@@ -19,16 +19,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #pragma pack(1)\r
 \r
 ///\r
-/// ATA5_IDENTIFY_DATA is defined in ATA-5\r
-/// (This structure is provided here mainly for backward-compatibility support.\r
-/// Old drivers may reference some field that is marked "obsolete" in \r
-/// ATA_IDENTIFY_DATA, which current conforms to ATA-8) \r
+/// ATA5_IDENTIFY_DATA is defined in ATA-5.\r
+/// (This structure is provided mainly for backward-compatibility support.\r
+/// Old drivers may reference fields that are marked "obsolete" in \r
+/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.) \r
 ///\r
 typedef struct {    \r
-  UINT16  config;             ///< General Configuration \r
-  UINT16  cylinders;          ///< Number of Cylinders \r
+  UINT16  config;             ///< General Configuration.\r
+  UINT16  cylinders;          ///< Number of Cylinders.\r
   UINT16  reserved_2; \r
-  UINT16  heads;              ///< Number of logical heads \r
+  UINT16  heads;              ///< Number of logical heads. \r
   UINT16  vendor_data1; \r
   UINT16  vendor_data2; \r
   UINT16  sectors_per_track; \r
@@ -77,14 +77,14 @@ typedef struct {
 } ATA5_IDENTIFY_DATA;\r
 \r
 ///\r
-/// ATA_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec\r
+/// ATA_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
 /// to define the data returned by an ATA device upon successful\r
-/// completion of the ATA IDENTIFY_DEVICE command\r
+/// completion of the ATA IDENTIFY_DEVICE command.\r
 ///\r
 typedef struct {\r
-  UINT16  config;                                  ///< General Configuration\r
+  UINT16  config;                                  ///< General Configuration.\r
   UINT16  obsolete_1;\r
-  UINT16  specific_config;                         ///< Specific Configuration\r
+  UINT16  specific_config;                         ///< Specific Configuration.\r
   UINT16  obsolete_3;\r
   UINT16  retired_4_5[2]; \r
   UINT16  obsolete_6;\r
@@ -114,7 +114,7 @@ typedef struct {
   UINT16  min_pio_cycle_time_with_flow_control; \r
   UINT16  reserved_69_74[6]; \r
   UINT16  queue_depth;     \r
-  UINT16  reserved_76_79[4];                       ///< reserved for Serial ATA\r
+  UINT16  reserved_76_79[4];                       ///< Reserved for Serial ATA.\r
   UINT16  major_version_no; \r
   UINT16  minor_version_no; \r
   UINT16  command_set_supported_82;                ///< word 82\r
@@ -176,14 +176,14 @@ typedef struct {
 } ATA_IDENTIFY_DATA;\r
 \r
 ///\r
-/// ATAPI_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec\r
+/// ATAPI_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
 /// to define the data returned by an ATAPI device upon successful\r
-/// completion of the ATA IDENTIFY_PACKET_DEVICE command\r
+/// completion of the ATA IDENTIFY_PACKET_DEVICE command.\r
 ///\r
 typedef struct {\r
-  UINT16  config;                                  ///< General Configuration\r
+  UINT16  config;                                  ///< General Configuration.\r
   UINT16  reserved_1;\r
-  UINT16  specific_config;                         ///< Specific Configuration\r
+  UINT16  specific_config;                         ///< Specific Configuration.\r
   UINT16  reserved_3_9[7];\r
   CHAR8   SerialNo[20];                            ///< word 10~19\r
   UINT16  reserved_20_22[3];\r
@@ -239,14 +239,14 @@ typedef struct {
 \r
 \r
 ///\r
-/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 peripheral_type;\r
   UINT8 RMB;\r
   UINT8 version;\r
   UINT8 response_data_format;\r
-  UINT8 addnl_length;     ///< n - 4, Numbers of bytes following this one\r
+  UINT8 addnl_length;     ///< n - 4, Numbers of bytes following this one.\r
   UINT8 reserved_5;\r
   UINT8 reserved_6;\r
   UINT8 reserved_7;\r
@@ -256,14 +256,14 @@ typedef struct {
   UINT8 vendor_specific_36_55[55 - 36 + 1];\r
   UINT8 reserved_56_95[95 - 56 + 1];\r
   ///\r
-  /// Vendor specific parameters fields, the sizeof (ATAPI_INQUIRY_DATA) is 254\r
+  /// Vendor-specific parameters fields. The sizeof (ATAPI_INQUIRY_DATA) is 254\r
   /// since allocation_length is one byte in ATAPI_INQUIRY_CMD.\r
   ///\r
   UINT8 vendor_specific_96_253[253 - 96 + 1];\r
 } ATAPI_INQUIRY_DATA;\r
 \r
 ///\r
-/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 error_code : 7;\r
@@ -291,7 +291,7 @@ typedef struct {
 } ATAPI_REQUEST_SENSE_DATA;\r
 \r
 ///\r
-/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 LastLba3;\r
@@ -306,7 +306,7 @@ typedef struct {
 \r
 ///\r
 /// Capacity List Header + Current/Maximum Capacity Descriptor,\r
-/// defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 reserved_0;\r
@@ -325,7 +325,7 @@ typedef struct {
 } ATAPI_READ_FORMAT_CAPACITY_DATA;\r
 \r
 ///\r
-/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -343,7 +343,7 @@ typedef struct {
 } ATAPI_TEST_UNIT_READY_CMD;\r
 \r
 ///\r
-/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -362,7 +362,7 @@ typedef struct {
 } ATAPI_INQUIRY_CMD;\r
 \r
 ///\r
-/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -381,7 +381,7 @@ typedef struct {
 } ATAPI_REQUEST_SENSE_CMD;\r
 \r
 ///\r
-/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -400,7 +400,7 @@ typedef struct {
 } ATAPI_READ10_CMD;\r
 \r
 ///\r
-/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -419,7 +419,7 @@ typedef struct {
 } ATAPI_READ_FORMAT_CAP_CMD;\r
 \r
 ///\r
-/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
 ///\r
 typedef struct {\r
   UINT8 opcode;\r
@@ -439,8 +439,8 @@ typedef struct {
 } ATAPI_MODE_SENSE_CMD;\r
 \r
 ///\r
-/// ATAPI_PACKET_COMMAND is not defined in ATA specification.\r
-/// We add it here for the convenience for ATA/ATAPI module writer. \r
+/// ATAPI_PACKET_COMMAND is not defined in the ATA specification.\r
+/// We add it here for the convenience of ATA/ATAPI module writers. \r
 ///\r
 typedef union {\r
   UINT16                    Data16[6];\r
@@ -547,13 +547,13 @@ typedef union {
 #define ATA_CMD_WRITE_DMA_EXT         0x35   ///< defined from ATA-6\r
         \r
 ///\r
-/// default content of device control register, disable INT,\r
+/// Default content of device control register, disable INT,\r
 /// Bit3 is set to 1 according ATA-1\r
 ///\r
 #define ATA_DEFAULT_CTL           (0x0a)  \r
 ///\r
-/// default context of Device/Head Register,\r
-/// Bit7 and Bit5 are set to 1 for back-compatibilities\r
+/// Default context of Device/Head Register,\r
+/// Bit7 and Bit5 are set to 1 for back-compatibilities.\r
 ///\r
 #define ATA_DEFAULT_CMD           (0xa0)\r
 \r
@@ -598,7 +598,7 @@ typedef union {
 #define ATA_ASC_INVALID_FIELD               (0x24)\r
 #define ATA_ASC_WRITE_PROTECTED             (0x27)\r
 #define ATA_ASC_MEDIA_CHANGE                (0x28)\r
-#define ATA_ASC_RESET                       (0x29)  ///< Power On Reset or Bus Reset occurred\r
+#define ATA_ASC_RESET                       (0x29)  ///< Power On Reset or Bus Reset occurred.\r
 #define ATA_ASC_ILLEGAL_FIELD               (0x26)\r
 #define ATA_ASC_NO_MEDIA                    (0x3A)\r
 #define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)\r
@@ -636,8 +636,8 @@ typedef union {
 //\r
 // Device Control Register\r
 //\r
-#define ATA_CTLREG_SRST  BIT2  ///< Software Reset\r
-#define ATA_CTLREG_IEN_L BIT1  ///< Interrupt Enable #\r
+#define ATA_CTLREG_SRST  BIT2  ///< Software Reset.\r
+#define ATA_CTLREG_IEN_L BIT1  ///< Interrupt Enable #.\r
 \r
 #endif\r
 \r