-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\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, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * Header file for MassStoreCommands.c.\r
- */\r
- \r
-#ifndef _MASS_STORE_COMMANDS_H_\r
-#define _MASS_STORE_COMMANDS_H_\r
-\r
- /* Includes: */\r
- #include <avr/io.h>\r
-\r
- #include "MassStorageHost.h"\r
- #include "SCSI_Codes.h"\r
-\r
- #include <LUFA/Drivers/USB/USB.h>\r
-\r
- /* Macros: */\r
- /** Class specific request to reset the Mass Storage interface of the attached device */\r
- #define REQ_MassStorageReset 0xFF\r
-\r
- /** Class specific request to retrieve the maximum Logical Unit Number (LUN) index of the attached device */\r
- #define REQ_GetMaxLUN 0xFE\r
-\r
- /** Command Block Wrapper signature byte, for verification of valid CBW blocks */\r
- #define CBW_SIGNATURE 0x43425355UL\r
-\r
- /** Command Static Wrapper signature byte, for verification of valid CSW blocks */\r
- #define CSW_SIGNATURE 0x53425355UL\r
- \r
- /** Data direction mask for the Flags field of a CBW, indicating Host-to-Device transfer direction */\r
- #define COMMAND_DIRECTION_DATA_OUT (0 << 7)\r
-\r
- /** Data direction mask for the Flags field of a CBW, indicating Device-to-Host transfer direction */\r
- #define COMMAND_DIRECTION_DATA_IN (1 << 7)\r
- \r
- /** Timeout period between the issuing of a CBW to a device, and the reception of the first packet */\r
- #define COMMAND_DATA_TIMEOUT_MS 10000\r
-\r
- /** Pipe number of the Mass Storage data IN pipe */\r
- #define MASS_STORE_DATA_IN_PIPE 1\r
-\r
- /** Pipe number of the Mass Storage data OUT pipe */\r
- #define MASS_STORE_DATA_OUT_PIPE 2\r
- \r
- /** Additional error code for Mass Storage functions when a device returns a logical command failure */\r
- #define MASS_STORE_SCSI_COMMAND_FAILED 0xC0\r
-\r
- /* Type defines: */\r
- /** Type define for a Mass Storage class Command Block Wrapper, used to wrap SCSI\r
- * commands for transport over the USB bulk endpoints to the device.\r
- */\r
- typedef struct\r
- {\r
- uint32_t Signature; /**< Command block signature, always equal to CBW_SIGNATURE */\r
- uint32_t Tag; /**< Current CBW tag, to positively associate a CBW with a CSW (filled automatically) */\r
- uint32_t DataTransferLength; /**< Length of data to transfer, following the CBW */\r
- uint8_t Flags; /**< Block flags, equal to one of the COMMAND_DIRECTION_DATA_* macros */\r
- uint8_t LUN; /**< Logical Unit Number the CBW is addressed to in the device */\r
- uint8_t SCSICommandLength; /**< Length of the SCSI command in the CBW */\r
- uint8_t SCSICommandData[16]; /**< SCSI command to issue to the device */\r
- } CommandBlockWrapper_t;\r
- \r
- /** Type define for a Mass Storage class Command Status Wrapper, used to wrap SCSI\r
- * responses for transport over the USB bulk endpoints from the device.\r
- */\r
- typedef struct\r
- {\r
- uint32_t Signature; /**< Command status signature, always equal to CSW_SIGNATURE */\r
- uint32_t Tag; /**< Current CBW tag, to positively associate a CBW with a CSW */\r
- uint32_t DataTransferResidue; /**< Length of data not transferred */\r
- uint8_t Status; /**< Command status, a value from the MassStorageHost_CommandStatusCodes_t enum */\r
- } CommandStatusWrapper_t;\r
- \r
- /** Type define for a SCSI Sense structure. Structures of this type are filled out by the\r
- * device via the MassStore_RequestSense() function, indicating the current sense data of the\r
- * device (giving explicit error codes for the last issued command). For details of the\r
- * structure contents, refer to the SCSI specifications.\r
- */\r
- typedef struct\r
- {\r
- uint8_t ResponseCode;\r
-\r
- uint8_t SegmentNumber;\r
- \r
- unsigned char SenseKey : 4;\r
- unsigned char _RESERVED1 : 1;\r
- unsigned char ILI : 1;\r
- unsigned char EOM : 1;\r
- unsigned char FileMark : 1;\r
- \r
- uint8_t Information[4];\r
- uint8_t AdditionalLength;\r
- uint8_t CmdSpecificInformation[4];\r
- uint8_t AdditionalSenseCode;\r
- uint8_t AdditionalSenseQualifier;\r
- uint8_t FieldReplaceableUnitCode;\r
- uint8_t SenseKeySpecific[3];\r
- } SCSI_Request_Sense_Response_t;\r
-\r
- /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the\r
- * device via the MassStore_Inquiry() function, retrieving the attached device's information.\r
- * For details of the structure contents, refer to the SCSI specifications.\r
- */\r
- typedef struct\r
- {\r
- unsigned char DeviceType : 5;\r
- unsigned char PeripheralQualifier : 3;\r
- \r
- unsigned char _RESERVED1 : 7;\r
- unsigned char Removable : 1;\r
- \r
- uint8_t Version;\r
- \r
- unsigned char ResponseDataFormat : 4;\r
- unsigned char _RESERVED2 : 1;\r
- unsigned char NormACA : 1;\r
- unsigned char TrmTsk : 1;\r
- unsigned char AERC : 1;\r
-\r
- uint8_t AdditionalLength;\r
- uint8_t _RESERVED3[2];\r
-\r
- unsigned char SoftReset : 1;\r
- unsigned char CmdQue : 1;\r
- unsigned char _RESERVED4 : 1;\r
- unsigned char Linked : 1;\r
- unsigned char Sync : 1;\r
- unsigned char WideBus16Bit : 1;\r
- unsigned char WideBus32Bit : 1;\r
- unsigned char RelAddr : 1;\r
- \r
- uint8_t VendorID[8];\r
- uint8_t ProductID[16];\r
- uint8_t RevisionID[4];\r
- } SCSI_Inquiry_Response_t;\r
- \r
- /** SCSI capacity structure, to hold the total capacity of the device in both the number\r
- * of blocks in the current LUN, and the size of each block. This structure is filled by\r
- * the device when the MassStore_ReadCapacity() function is called.\r
- */\r
- typedef struct\r
- {\r
- uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */\r
- uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */\r
- } SCSI_Capacity_t;\r
-\r
- /* Enums: */\r
- /** CSW status return codes, indicating the overall status of the issued CBW */\r
- enum MassStorageHost_CommandStatusCodes_t\r
- {\r
- Command_Pass = 0, /**< Command completed successfully */\r
- Command_Fail = 1, /**< Command failed to complete successfully */\r
- Phase_Error = 2 /**< Phase error while processing the issued command */\r
- };\r
- \r
- /* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_MASSSTORE_COMMANDS_C)\r
- static uint8_t MassStore_SendCommand(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);\r
- static uint8_t MassStore_WaitForDataReceived(void);\r
- static uint8_t MassStore_SendReceiveData(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr) ATTR_NON_NULL_PTR_ARG(1);\r
- static uint8_t MassStore_GetReturnedStatus(CommandStatusWrapper_t* SCSICommandStatus) ATTR_NON_NULL_PTR_ARG(1);\r
- #endif\r
- \r
- uint8_t MassStore_MassStorageReset(void);\r
- uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex);\r
- uint8_t MassStore_RequestSense(const uint8_t LUNIndex, SCSI_Request_Sense_Response_t* const SensePtr)\r
- ATTR_NON_NULL_PTR_ARG(2);\r
- uint8_t MassStore_Inquiry(const uint8_t LUNIndex, SCSI_Inquiry_Response_t* const InquiryPtr)\r
- ATTR_NON_NULL_PTR_ARG(2);\r
- uint8_t MassStore_ReadDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,\r
- const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr) ATTR_NON_NULL_PTR_ARG(5);\r
- uint8_t MassStore_WriteDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,\r
- const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr) ATTR_NON_NULL_PTR_ARG(5);\r
- uint8_t MassStore_ReadCapacity(const uint8_t LUNIndex, SCSI_Capacity_t* const CapacityPtr)\r
- ATTR_NON_NULL_PTR_ARG(2);\r
- uint8_t MassStore_TestUnitReady(const uint8_t LUNIndex);\r
- uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex, const bool PreventRemoval);\r
-\r
-#endif\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ *
+ * Header file for MassStoreCommands.c.
+ */
+
+#ifndef _MASS_STORE_COMMANDS_H_
+#define _MASS_STORE_COMMANDS_H_
+
+ /* Includes: */
+ #include <avr/io.h>
+
+ #include "MassStorageHost.h"
+ #include "SCSI_Codes.h"
+
+ #include <LUFA/Drivers/USB/USB.h>
+
+ /* Macros: */
+ /** Class specific request to reset the Mass Storage interface of the attached device */
+ #define REQ_MassStorageReset 0xFF
+
+ /** Class specific request to retrieve the maximum Logical Unit Number (LUN) index of the attached device */
+ #define REQ_GetMaxLUN 0xFE
+
+ /** Command Block Wrapper signature byte, for verification of valid CBW blocks */
+ #define CBW_SIGNATURE 0x43425355UL
+
+ /** Command Static Wrapper signature byte, for verification of valid CSW blocks */
+ #define CSW_SIGNATURE 0x53425355UL
+
+ /** Data direction mask for the Flags field of a CBW, indicating Host-to-Device transfer direction */
+ #define COMMAND_DIRECTION_DATA_OUT (0 << 7)
+
+ /** Data direction mask for the Flags field of a CBW, indicating Device-to-Host transfer direction */
+ #define COMMAND_DIRECTION_DATA_IN (1 << 7)
+
+ /** Timeout period between the issuing of a CBW to a device, and the reception of the first packet */
+ #define COMMAND_DATA_TIMEOUT_MS 10000
+
+ /** Pipe number of the Mass Storage data IN pipe */
+ #define MASS_STORE_DATA_IN_PIPE 1
+
+ /** Pipe number of the Mass Storage data OUT pipe */
+ #define MASS_STORE_DATA_OUT_PIPE 2
+
+ /** Additional error code for Mass Storage functions when a device returns a logical command failure */
+ #define MASS_STORE_SCSI_COMMAND_FAILED 0xC0
+
+ /* Type defines: */
+ /** Type define for a Mass Storage class Command Block Wrapper, used to wrap SCSI
+ * commands for transport over the USB bulk endpoints to the device.
+ */
+ typedef struct
+ {
+ uint32_t Signature; /**< Command block signature, always equal to CBW_SIGNATURE */
+ uint32_t Tag; /**< Current CBW tag, to positively associate a CBW with a CSW (filled automatically) */
+ uint32_t DataTransferLength; /**< Length of data to transfer, following the CBW */
+ uint8_t Flags; /**< Block flags, equal to one of the COMMAND_DIRECTION_DATA_* macros */
+ uint8_t LUN; /**< Logical Unit Number the CBW is addressed to in the device */
+ uint8_t SCSICommandLength; /**< Length of the SCSI command in the CBW */
+ uint8_t SCSICommandData[16]; /**< SCSI command to issue to the device */
+ } CommandBlockWrapper_t;
+
+ /** Type define for a Mass Storage class Command Status Wrapper, used to wrap SCSI
+ * responses for transport over the USB bulk endpoints from the device.
+ */
+ typedef struct
+ {
+ uint32_t Signature; /**< Command status signature, always equal to CSW_SIGNATURE */
+ uint32_t Tag; /**< Current CBW tag, to positively associate a CBW with a CSW */
+ uint32_t DataTransferResidue; /**< Length of data not transferred */
+ uint8_t Status; /**< Command status, a value from the MassStorageHost_CommandStatusCodes_t enum */
+ } CommandStatusWrapper_t;
+
+ /** Type define for a SCSI Sense structure. Structures of this type are filled out by the
+ * device via the MassStore_RequestSense() function, indicating the current sense data of the
+ * device (giving explicit error codes for the last issued command). For details of the
+ * structure contents, refer to the SCSI specifications.
+ */
+ typedef struct
+ {
+ uint8_t ResponseCode;
+
+ uint8_t SegmentNumber;
+
+ unsigned char SenseKey : 4;
+ unsigned char _RESERVED1 : 1;
+ unsigned char ILI : 1;
+ unsigned char EOM : 1;
+ unsigned char FileMark : 1;
+
+ uint8_t Information[4];
+ uint8_t AdditionalLength;
+ uint8_t CmdSpecificInformation[4];
+ uint8_t AdditionalSenseCode;
+ uint8_t AdditionalSenseQualifier;
+ uint8_t FieldReplaceableUnitCode;
+ uint8_t SenseKeySpecific[3];
+ } SCSI_Request_Sense_Response_t;
+
+ /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
+ * device via the MassStore_Inquiry() function, retrieving the attached device's information.
+ * For details of the structure contents, refer to the SCSI specifications.
+ */
+ typedef struct
+ {
+ unsigned char DeviceType : 5;
+ unsigned char PeripheralQualifier : 3;
+
+ unsigned char _RESERVED1 : 7;
+ unsigned char Removable : 1;
+
+ uint8_t Version;
+
+ unsigned char ResponseDataFormat : 4;
+ unsigned char _RESERVED2 : 1;
+ unsigned char NormACA : 1;
+ unsigned char TrmTsk : 1;
+ unsigned char AERC : 1;
+
+ uint8_t AdditionalLength;
+ uint8_t _RESERVED3[2];
+
+ unsigned char SoftReset : 1;
+ unsigned char CmdQue : 1;
+ unsigned char _RESERVED4 : 1;
+ unsigned char Linked : 1;
+ unsigned char Sync : 1;
+ unsigned char WideBus16Bit : 1;
+ unsigned char WideBus32Bit : 1;
+ unsigned char RelAddr : 1;
+
+ uint8_t VendorID[8];
+ uint8_t ProductID[16];
+ uint8_t RevisionID[4];
+ } SCSI_Inquiry_Response_t;
+
+ /** SCSI capacity structure, to hold the total capacity of the device in both the number
+ * of blocks in the current LUN, and the size of each block. This structure is filled by
+ * the device when the MassStore_ReadCapacity() function is called.
+ */
+ typedef struct
+ {
+ uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */
+ uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */
+ } SCSI_Capacity_t;
+
+ /* Enums: */
+ /** CSW status return codes, indicating the overall status of the issued CBW */
+ enum MassStorageHost_CommandStatusCodes_t
+ {
+ Command_Pass = 0, /**< Command completed successfully */
+ Command_Fail = 1, /**< Command failed to complete successfully */
+ Phase_Error = 2 /**< Phase error while processing the issued command */
+ };
+
+ /* Function Prototypes: */
+ #if defined(INCLUDE_FROM_MASSSTORE_COMMANDS_C)
+ static uint8_t MassStore_SendCommand(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);
+ static uint8_t MassStore_WaitForDataReceived(void);
+ static uint8_t MassStore_SendReceiveData(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr) ATTR_NON_NULL_PTR_ARG(1);
+ static uint8_t MassStore_GetReturnedStatus(CommandStatusWrapper_t* SCSICommandStatus) ATTR_NON_NULL_PTR_ARG(1);
+ #endif
+
+ uint8_t MassStore_MassStorageReset(void);
+ uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex);
+ uint8_t MassStore_RequestSense(const uint8_t LUNIndex, SCSI_Request_Sense_Response_t* const SensePtr)
+ ATTR_NON_NULL_PTR_ARG(2);
+ uint8_t MassStore_Inquiry(const uint8_t LUNIndex, SCSI_Inquiry_Response_t* const InquiryPtr)
+ ATTR_NON_NULL_PTR_ARG(2);
+ uint8_t MassStore_ReadDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,
+ const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr) ATTR_NON_NULL_PTR_ARG(5);
+ uint8_t MassStore_WriteDeviceBlock(const uint8_t LUNIndex, const uint32_t BlockAddress,
+ const uint8_t Blocks, const uint16_t BlockSize, void* BufferPtr) ATTR_NON_NULL_PTR_ARG(5);
+ uint8_t MassStore_ReadCapacity(const uint8_t LUNIndex, SCSI_Capacity_t* const CapacityPtr)
+ ATTR_NON_NULL_PTR_ARG(2);
+ uint8_t MassStore_TestUnitReady(const uint8_t LUNIndex);
+ uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex, const bool PreventRemoval);
+
+#endif
projects / pub / USBasp.git / blobdiff