Added documentation for the constants and enums of the new StillImage Host Class...

diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h
index 804b312..84dee71 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Common/StillImage.h
@@ -45,7 +45,7 @@
                #include "../../USB.h"\r
 \r
                #include <string.h>\r
-\r
+               \r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
@@ -55,11 +55,10 @@
                /** Length in bytes of a given Unicode string's character length\r
                 *\r
                 *  \param[in] chars  Total number of Unicode characters in the string\r
+                *\r
+                *  \return Number of bytes of the given unicode string\r
                 */\r
                #define UNICODE_STRING_LENGTH(chars)   (chars << 1)\r
-\r
-               /** Timeout period between the issuing of a command to a device, and the reception of the first packet */\r
-               #define COMMAND_DATA_TIMEOUT_MS        5000\r
                \r
                /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for\r
                 *  a command container.\r
@@ -67,28 +66,16 @@
                 *  \param[in] params  Number of parameters which are to be sent in the Param field of the container\r
                 */\r
                #define PIMA_COMMAND_SIZE(params)      ((sizeof(SI_PIMA_Container_t) - sizeof(((SI_PIMA_Container_t*)NULL)->Params)) + \\r
-                                                       (params * sizeof(((SI_PIMA_Container_t*)NULL)->Params[0])))\r
+                                                       (params * sizeof(uint32_t)))\r
 \r
                /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for\r
                 *  a data container.\r
                 *\r
                 *  \param[in] datalen  Length in bytes of the data in the container\r
                 */\r
-               #define PIMA_DATA_SIZE(datalen)        ((sizeof(SI_PIMA_Container_t) - sizeof(((SI_PIMA_Container_t*)NULL)->Params)) + datalen)\r
+               #define PIMA_DATA_SIZE(datalen)        ((sizeof(SI_PIMA_Container_t) - sizeof(((SI_PIMA_Container_t*)NULL)->Params)) + \\r
+                                                       datalen)\r
 \r
-       /* Type defines: */\r
-               /** Type define for a PIMA container, use to send commands and receive responses to and from an\r
-                *  attached Still Image device.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint32_t DataLength; /**< Length of the container and data, in bytes */\r
-                       uint16_t Type; /**< Container type, a value from the PIMA_Container_Types_t enum */\r
-                       uint16_t Code; /**< Command, event or response code of the container */\r
-                       uint32_t TransactionID; /**< Unique container ID to link blocks together */\r
-                       uint32_t Params[4]; /**< Block parameters to be issued along with the block code (command blocks only) */\r
-               } SI_PIMA_Container_t;\r
-       \r
        /* Enums: */\r
                /** Enum for the possible PIMA contains types. */\r
                enum SI_PIMA_Container_Types_t\r
@@ -101,19 +88,38 @@
                };      \r
                \r
        /* Enums: */\r
+               /** Enums for the possible status codes of a returned Response Block from an attached PIMA compliant Still Image device. */\r
                enum SI_PIMA_ResponseCodes_t\r
                {\r
-                       PIMA_RESPONSE_OK                     = 1,\r
-                       PIMA_RESPONSE_GeneralError           = 2,\r
-                       PIMA_RESPONSE_SessionNotOpen         = 3,\r
-                       PIMA_RESPONSE_InvalidTransaction     = 4,\r
-                       PIMA_RESPONSE_OperationNotSupported  = 5,\r
-                       PIMA_RESPONSE_ParameterNotSupported  = 6,\r
+                       PIMA_RESPONSE_OK                     = 1, /**< Response code indicating no error in the issued command */\r
+                       PIMA_RESPONSE_GeneralError           = 2, /**< Response code indicating a general error while processing the\r
+                                                                   *  issued command\r
+                                                                   */\r
+                       PIMA_RESPONSE_SessionNotOpen         = 3, /**< Response code indicating that the sent command requires an open\r
+                                                                  *   session before being issued\r
+                                                                  */\r
+                       PIMA_RESPONSE_InvalidTransaction     = 4, /**< Response code indicating an invalid transaction occurred */\r
+                       PIMA_RESPONSE_OperationNotSupported  = 5, /**< Response code indicating that the issued command is not supported\r
+                                                                  *   by the attached device\r
+                                                                  */\r
+                       PIMA_RESPONSE_ParameterNotSupported  = 6, /**< Response code indicating that one or more of the issued command's\r
+                                                                  *   parameters are not supported by the device\r
+                                                                  */\r
                };\r
        \r
        /* Type Defines: */\r
-       \r
-       \r
+               /** Type define for a PIMA container, use to send commands and receive responses to and from an\r
+                *  attached Still Image device.\r
+                */\r
+               typedef struct\r
+               {\r
+                       uint32_t DataLength; /**< Length of the container and data, in bytes */\r
+                       uint16_t Type; /**< Container type, a value from the PIMA_Container_Types_t enum */\r
+                       uint16_t Code; /**< Command, event or response code of the container */\r
+                       uint32_t TransactionID; /**< Unique container ID to link blocks together */\r
+                       uint32_t Params[4]; /**< Block parameters to be issued along with the block code (command blocks only) */\r
+               } SI_PIMA_Container_t;\r
+               \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.c b/LUFA/Drivers/USB/Class/Host/StillImage.c
index 10759f6..40ef4f2 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/StillImage.c
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.c
@@ -222,6 +222,8 @@ uint8_t SImage_Host_RecieveBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,
                  Pipe_Read_Stream_LE(&PIMAHeader->Params, ParamBytes, NO_STREAM_CALLBACK);\r
                \r
                Pipe_ClearIN();\r
+               \r
+               PIMAHeader->Code &= 0x0000000F;\r
        }\r
        \r
        Pipe_Freeze();\r

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h
index f4d1bb1..4d37796 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -138,6 +138,8 @@
                        #define SI_FOUND_DATAPIPE_IN           (1 << 1)\r
                        #define SI_FOUND_DATAPIPE_OUT          (1 << 2)\r
 \r
+                       #define COMMAND_DATA_TIMEOUT_MS        5000\r
+               \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_SI_CLASS_HOST_C)\r
                                static uint8_t DComp_SI_Host_NextSIInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r