Minor documentation enhancements.

[pub/USBasp.git] / Demos / Device / LowLevel / MassStorage / Lib / SCSI.h

diff --git a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h
index b4b6158..0fc99b6 100644 (file)
--- a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h
+++ b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h
@@ -54,18 +54,18 @@
                 *  is for convenience, as it allows for all three sense values (returned upon request to the host to give information about
                 *  the last command failure) in a quick and easy manner.
                 *
-                *  \param[in] key    New SCSI sense key to set the sense code to
-                *  \param[in] acode  New SCSI additional sense key to set the additional sense code to
-                *  \param[in] aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to
+                *  \param[in] Key    New SCSI sense key to set the sense code to
+                *  \param[in] Acode  New SCSI additional sense key to set the additional sense code to
+                *  \param[in] Aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to
                 */
-               #define SCSI_SET_SENSE(key, acode, aqual)  MACROS{ SenseData.SenseKey = (key);              \
-                                                                  SenseData.AdditionalSenseCode = (acode); \
-                                                                  SenseData.AdditionalSenseQualifier = (aqual); }MACROE
+               #define SCSI_SET_SENSE(Key, Acode, Aqual)  MACROS{ SenseData.SenseKey                 = (Key);   \
+                                                                  SenseData.AdditionalSenseCode      = (Acode); \
+                                                                  SenseData.AdditionalSenseQualifier = (Aqual); }MACROE
 
-               /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */
+               /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */
                #define DATA_READ           true
 
-               /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */
+               /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */
                #define DATA_WRITE          false
 
                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
@@ -83,23 +83,23 @@
                        unsigned char DeviceType          : 5;
                        unsigned char PeripheralQualifier : 3;
                        
-                       unsigned char _RESERVED1          : 7;
+                       unsigned char Reserved            : 7;
                        unsigned char Removable           : 1;
                        
                        uint8_t       Version;
                        
                        unsigned char ResponseDataFormat  : 4;
-                       unsigned char _RESERVED2          : 1;
+                       unsigned char Reserved2           : 1;
                        unsigned char NormACA             : 1;
                        unsigned char TrmTsk              : 1;
                        unsigned char AERC                : 1;
 
                        uint8_t       AdditionalLength;
-                       uint8_t       _RESERVED3[2];
+                       uint8_t       Reserved3[2];
 
                        unsigned char SoftReset           : 1;
                        unsigned char CmdQue              : 1;
-                       unsigned char _RESERVED4          : 1;
+                       unsigned char Reserved4           : 1;
                        unsigned char Linked              : 1;
                        unsigned char Sync                : 1;
                        unsigned char WideBus16Bit        : 1;
@@ -121,7 +121,7 @@
                        uint8_t       SegmentNumber;
                        
                        unsigned char SenseKey            : 4;
-                       unsigned char _RESERVED1          : 1;
+                       unsigned char Reserved            : 1;
                        unsigned char ILI                 : 1;
                        unsigned char EOM                 : 1;
                        unsigned char FileMark            : 1;
@@ -139,11 +139,11 @@
                bool SCSI_DecodeSCSICommand(void);
                
                #if defined(INCLUDE_FROM_SCSI_C)
-                       static void SCSI_Command_Inquiry(void);
-                       static void SCSI_Command_Request_Sense(void);
-                       static void SCSI_Command_Read_Capacity_10(void);
-                       static void SCSI_Command_Send_Diagnostic(void);
-                       static void SCSI_Command_ReadWrite_10(const bool IsDataRead);
+                       static bool SCSI_Command_Inquiry(void);
+                       static bool SCSI_Command_Request_Sense(void);
+                       static bool SCSI_Command_Read_Capacity_10(void);
+                       static bool SCSI_Command_Send_Diagnostic(void);
+                       static bool SCSI_Command_ReadWrite_10(const bool IsDataRead);
                #endif
                
 #endif