Oops - fix broken SPI driver due to missing bit inversion on a port mask.

[pub/USBasp.git] / Demos / Host / LowLevel / MassStorageHost / Lib / MassStoreCommands.h

diff --git a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h
index baa36da..8fcffe4 100644 (file)
--- a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h
+++ b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h
@@ -1,7 +1,7 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

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


@@ -9,13 +9,13 @@
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   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 
+  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 without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -32,7 +32,7 @@
  *
  *  Header file for MassStoreCommands.c.
  */
  *
  *  Header file for MassStoreCommands.c.
  */

- 
+

 #ifndef _MASS_STORE_COMMANDS_H_
 #define _MASS_STORE_COMMANDS_H_
 
 #ifndef _MASS_STORE_COMMANDS_H_
 #define _MASS_STORE_COMMANDS_H_
 


@@ -56,26 +56,20 @@
 
                /** Command Static Wrapper signature byte, for verification of valid CSW blocks. */
                #define CSW_SIGNATURE                       0x53425355UL
 
                /** 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)
                /** 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
 
                /** 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
 
                /** 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 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.
                 */
                /** 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.
                 */


@@ -89,7 +83,7 @@
                        uint8_t  SCSICommandLength; /**< Length of the SCSI command in the CBW */
                        uint8_t  SCSICommandData[16]; /**< SCSI command to issue to the device */
                } CommandBlockWrapper_t;
                        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.
                 */
                /** 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.
                 */


@@ -100,9 +94,9 @@
                        uint32_t DataTransferResidue; /**< Length of data not transferred */
                        uint8_t  Status; /**< Command status, a value from the MassStorageHost_CommandStatusCodes_t enum */
                } CommandStatusWrapper_t;
                        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
                /** 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 via the \ref 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.
                 */
                 *  device (giving explicit error codes for the last issued command). For details of the
                 *  structure contents, refer to the SCSI specifications.
                 */


@@ -111,13 +105,13 @@
                        uint8_t       ResponseCode;
 
                        uint8_t       SegmentNumber;
                        uint8_t       ResponseCode;
 
                        uint8_t       SegmentNumber;

-                       
+

                        unsigned char SenseKey            : 4;
                        unsigned char SenseKey            : 4;

-                       unsigned char _RESERVED1          : 1;
+                       unsigned char Reserved            : 1;

                        unsigned char ILI                 : 1;
                        unsigned char EOM                 : 1;
                        unsigned char FileMark            : 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      Information[4];
                        uint8_t      AdditionalLength;
                        uint8_t      CmdSpecificInformation[4];


@@ -128,45 +122,45 @@
                } SCSI_Request_Sense_Response_t;
 
                /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
                } 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.
+                *  device via the \ref 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;
                 *  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 Reserved            : 7;

                        unsigned char Removable           : 1;
                        unsigned char Removable           : 1;

-                       
+

                        uint8_t      Version;
                        uint8_t      Version;

-                       
+

                        unsigned char ResponseDataFormat  : 4;
                        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;
                        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 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;
                        unsigned char WideBus32Bit        : 1;
                        unsigned char RelAddr             : 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;
                        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
                /** 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.
+                *  the device when the \ref MassStore_ReadCapacity() function is called.

                 */
                typedef struct
                {
                 */
                typedef struct
                {


@@ -182,28 +176,38 @@
                        Command_Fail = 1, /**< Command failed to complete successfully */
                        Phase_Error  = 2 /**< Phase error while processing the issued command */
                };
                        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)
        /* Function Prototypes: */
                #if defined(INCLUDE_FROM_MASSSTORE_COMMANDS_C)

-                       static uint8_t MassStore_SendCommand(CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);
+                       static uint8_t MassStore_SendCommand(CommandBlockWrapper_t* const SCSICommandBlock,
+                                                            void* BufferPtr);

                        static uint8_t MassStore_WaitForDataReceived(void);
                        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);
+                       static uint8_t MassStore_SendReceiveData(CommandBlockWrapper_t* const SCSICommandBlock,
+                                                                void* BufferPtr) ATTR_NON_NULL_PTR_ARG(1);
+                       static uint8_t MassStore_GetReturnedStatus(CommandStatusWrapper_t* const SCSICommandStatus) ATTR_NON_NULL_PTR_ARG(1);

                #endif
                #endif

-               
+

                uint8_t MassStore_MassStorageReset(void);
                uint8_t MassStore_GetMaxLUN(uint8_t* const MaxLUNIndex);
                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_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_TestUnitReady(const uint8_t LUNIndex);

-               uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex, const bool PreventRemoval);
+               uint8_t MassStore_PreventAllowMediumRemoval(const uint8_t LUNIndex,
+                                                           const bool PreventRemoval);

 
 #endif
 
 #endif

+