Minor documentation enhancements.

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

diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h
index 4453bbf..bf3c138 100644 (file)
--- a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h
+++ b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h
@@ -52,18 +52,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. */
@@ -73,14 +73,15 @@
                #define DEVICE_TYPE_CDROM   0x05
                
        /* Function Prototypes: */
-               bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);
+               bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
                
                #if defined(INCLUDE_FROM_SCSI_C)
-                       static void SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);
-                       static void SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);
-                       static void SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);
-                       static void SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* MSInterfaceInfo);
-                       static void SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* MSInterfaceInfo, const bool IsDataRead);
+                       static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
+                       static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
+                       static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
+                       static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
+                       static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
+                                                             const bool IsDataRead);
                #endif
                
 #endif