Make board specific and device peripheral specific drivers' file documentation copy...

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

diff --git a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
index d0840d3..1f11906 100644 (file)
--- a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
+++ b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -83,37 +83,41 @@ SCSI_Request_Sense_Response_t SenseData =
 /** Main routine to process the SCSI command located in the Command Block Wrapper read from the host. This dispatches\r
  *  to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns\r
  *  a command failure due to a ILLEGAL REQUEST.\r
 /** Main routine to process the SCSI command located in the Command Block Wrapper read from the host. This dispatches\r
  *  to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns\r
  *  a command failure due to a ILLEGAL REQUEST.\r

+ *\r
+ *  \return Boolean true if the command completed successfully, false otherwise\r

  */\r
  */\r

-void SCSI_DecodeSCSICommand(void)\r
+bool SCSI_DecodeSCSICommand(void)\r

 {\r
 {\r

-       bool CommandSuccess = false;\r
+       /* Set initial sense data, before the requested command is processed */\r
+       SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,\r
+                      SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
+                      SCSI_ASENSEQ_NO_QUALIFIER);\r

 \r
        /* Run the appropriate SCSI command hander function based on the passed command */\r
        switch (CommandBlock.SCSICommandData[0])\r
        {\r
                case SCSI_CMD_INQUIRY:\r
 \r
        /* Run the appropriate SCSI command hander function based on the passed command */\r
        switch (CommandBlock.SCSICommandData[0])\r
        {\r
                case SCSI_CMD_INQUIRY:\r

-                       CommandSuccess = SCSI_Command_Inquiry();                        \r
+                       SCSI_Command_Inquiry();                 \r

                        break;\r
                case SCSI_CMD_REQUEST_SENSE:\r
                        break;\r
                case SCSI_CMD_REQUEST_SENSE:\r

-                       CommandSuccess = SCSI_Command_Request_Sense();\r
+                       SCSI_Command_Request_Sense();\r

                        break;\r
                case SCSI_CMD_READ_CAPACITY_10:\r
                        break;\r
                case SCSI_CMD_READ_CAPACITY_10:\r

-                       CommandSuccess = SCSI_Command_Read_Capacity_10();                       \r
+                       SCSI_Command_Read_Capacity_10();                        \r

                        break;\r
                case SCSI_CMD_SEND_DIAGNOSTIC:\r
                        break;\r
                case SCSI_CMD_SEND_DIAGNOSTIC:\r

-                       CommandSuccess = SCSI_Command_Send_Diagnostic();\r
+                       SCSI_Command_Send_Diagnostic();\r

                        break;\r
                case SCSI_CMD_WRITE_10:\r
                        break;\r
                case SCSI_CMD_WRITE_10:\r

-                       CommandSuccess = SCSI_Command_ReadWrite_10(DATA_WRITE);\r
+                       SCSI_Command_ReadWrite_10(DATA_WRITE);\r

                        break;\r
                case SCSI_CMD_READ_10:\r
                        break;\r
                case SCSI_CMD_READ_10:\r

-                       CommandSuccess = SCSI_Command_ReadWrite_10(DATA_READ);\r
+                       SCSI_Command_ReadWrite_10(DATA_READ);\r

                        break;\r
                case SCSI_CMD_TEST_UNIT_READY:\r
                case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:\r
                case SCSI_CMD_VERIFY_10:\r
                        /* These commands should just succeed, no handling required */\r
                        break;\r
                case SCSI_CMD_TEST_UNIT_READY:\r
                case SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL:\r
                case SCSI_CMD_VERIFY_10:\r
                        /* These commands should just succeed, no handling required */\r

-                       CommandSuccess = true;\r

                        CommandBlock.DataTransferLength = 0;\r
                        break;\r
                default:\r
                        CommandBlock.DataTransferLength = 0;\r
                        break;\r
                default:\r


@@ -124,29 +128,13 @@ void SCSI_DecodeSCSICommand(void)
                        break;\r
        }\r
        \r
                        break;\r
        }\r
        \r

-       /* Check if command was successfully processed */\r
-       if (CommandSuccess)\r
-       {\r
-               /* Command succeeded - set the CSW status and update the SENSE key */\r
-               CommandStatus.Status = Command_Pass;\r
-               \r
-               SCSI_SET_SENSE(SCSI_SENSE_KEY_GOOD,\r
-                              SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
-                              SCSI_ASENSEQ_NO_QUALIFIER);                                         \r
-       }\r
-       else\r
-       {\r
-               /* Command failed - set the CSW status - failed command function updates the SENSE key */\r
-               CommandStatus.Status = Command_Fail;\r
-       }\r
+       return (SenseData.SenseKey == SCSI_SENSE_KEY_GOOD);\r

 }\r
 \r
 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features\r
  *  and capabilities to the host.\r
 }\r
 \r
 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features\r
  *  and capabilities to the host.\r

- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r

  */\r
  */\r

-static bool SCSI_Command_Inquiry(void)\r
+static void SCSI_Command_Inquiry(void)\r

 {\r
        uint16_t AllocationLength  = (((uint16_t)CommandBlock.SCSICommandData[3] << 8) |\r
                                                 CommandBlock.SCSICommandData[4]);\r
 {\r
        uint16_t AllocationLength  = (((uint16_t)CommandBlock.SCSICommandData[3] << 8) |\r
                                                 CommandBlock.SCSICommandData[4]);\r


@@ -162,7 +150,7 @@ static bool SCSI_Command_Inquiry(void)
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r

-               return false;\r
+               return;\r

        }\r
 \r
        /* Write the INQUIRY data to the endpoint */\r
        }\r
 \r
        /* Write the INQUIRY data to the endpoint */\r


@@ -178,16 +166,12 @@ static bool SCSI_Command_Inquiry(void)
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength -= BytesTransferred;\r
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength -= BytesTransferred;\r

-       \r
-       return true;\r

 }\r
 \r
 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,\r
  *  including the error code and additional error information so that the host can determine why a command failed to complete.\r
 }\r
 \r
 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,\r
  *  including the error code and additional error information so that the host can determine why a command failed to complete.\r

- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r

  */\r
  */\r

-static bool SCSI_Command_Request_Sense(void)\r
+static void SCSI_Command_Request_Sense(void)\r

 {\r
        uint8_t  AllocationLength = CommandBlock.SCSICommandData[4];\r
        uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);\r
 {\r
        uint8_t  AllocationLength = CommandBlock.SCSICommandData[4];\r
        uint8_t  BytesTransferred = (AllocationLength < sizeof(SenseData))? AllocationLength : sizeof(SenseData);\r


@@ -205,16 +189,12 @@ static bool SCSI_Command_Request_Sense(void)
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength -= BytesTransferred;\r
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength -= BytesTransferred;\r

-\r
-       return true;\r

 }\r
 \r
 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity\r
  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.\r
 }\r
 \r
 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity\r
  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.\r

- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r

  */\r
  */\r

-static bool SCSI_Command_Read_Capacity_10(void)\r
+static void SCSI_Command_Read_Capacity_10(void)\r

 {\r
        /* Send the total number of logical blocks in the current LUN */\r
        Endpoint_Write_DWord_BE(LUN_MEDIA_BLOCKS - 1);\r
 {\r
        /* Send the total number of logical blocks in the current LUN */\r
        Endpoint_Write_DWord_BE(LUN_MEDIA_BLOCKS - 1);\r


@@ -224,26 +204,20 @@ static bool SCSI_Command_Read_Capacity_10(void)
 \r
        /* Check if the current command is being aborted by the host */\r
        if (IsMassStoreReset)\r
 \r
        /* Check if the current command is being aborted by the host */\r
        if (IsMassStoreReset)\r

-         return false;\r
+         return;\r

 \r
        /* Send the endpoint data packet to the host */\r
        Endpoint_ClearIN();\r
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength -= 8;\r
 \r
        /* Send the endpoint data packet to the host */\r
        Endpoint_ClearIN();\r
 \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength -= 8;\r

-       \r
-       return true;\r

 }\r
 \r
 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the\r
  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is\r
  *  supported.\r
 }\r
 \r
 /** Command processing for an issued SCSI SEND DIAGNOSTIC command. This command performs a quick check of the Dataflash ICs on the\r
  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is\r
  *  supported.\r

- *\r
- *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r

  */\r
  */\r

-static bool SCSI_Command_Send_Diagnostic(void)\r
+static void SCSI_Command_Send_Diagnostic(void)\r

 {\r
        /* Check to see if the SELF TEST bit is not set */\r
        if (!(CommandBlock.SCSICommandData[1] & (1 << 2)))\r
 {\r
        /* Check to see if the SELF TEST bit is not set */\r
        if (!(CommandBlock.SCSICommandData[1] & (1 << 2)))\r


@@ -253,7 +227,7 @@ static bool SCSI_Command_Send_Diagnostic(void)
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r
                               SCSI_ASENSE_INVALID_FIELD_IN_CDB,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r

-               return false;\r
+               return;\r

        }\r
        \r
        /* Check to see if all attached Dataflash ICs are functional */\r
        }\r
        \r
        /* Check to see if all attached Dataflash ICs are functional */\r


@@ -264,13 +238,11 @@ static bool SCSI_Command_Send_Diagnostic(void)
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);      \r
        \r
                               SCSI_ASENSE_NO_ADDITIONAL_INFORMATION,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);      \r
        \r

-               return false;\r
+               return;\r

        }\r
        \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength = 0;\r
        }\r
        \r
        /* Succeed the command and update the bytes transferred counter */\r
        CommandBlock.DataTransferLength = 0;\r

-       \r
-       return true;\r

 }\r
 \r
 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address\r
 }\r
 \r
 /** Command processing for an issued SCSI READ (10) or WRITE (10) command. This command reads in the block start address\r


@@ -278,10 +250,8 @@ static bool SCSI_Command_Send_Diagnostic(void)
  *  reading and writing of the data.\r
  *\r
  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)\r
  *  reading and writing of the data.\r
  *\r
  *  \param[in] IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)\r

- *\r
- *  \return Boolean true if the command completed successfully, false otherwise.\r

  */\r
  */\r

-static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)\r
+static void SCSI_Command_ReadWrite_10(const bool IsDataRead)\r

 {\r
        uint32_t BlockAddress;\r
        uint16_t TotalBlocks;\r
 {\r
        uint32_t BlockAddress;\r
        uint16_t TotalBlocks;\r


@@ -304,7 +274,7 @@ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)
                               SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r
                               SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE,\r
                               SCSI_ASENSEQ_NO_QUALIFIER);\r
 \r

-               return false;\r
+               return;\r

        }\r
 \r
        #if (TOTAL_LUNS > 1)\r
        }\r
 \r
        #if (TOTAL_LUNS > 1)\r


@@ -320,6 +290,4 @@ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead)
 \r
        /* Update the bytes transferred counter and succeed the command */\r
        CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);\r
 \r
        /* Update the bytes transferred counter and succeed the command */\r
        CommandBlock.DataTransferLength -= ((uint32_t)TotalBlocks * VIRTUAL_MEMORY_BLOCK_SIZE);\r

-       \r
-       return true;\r

 }\r
 }\r