Finish Still Image Host class driver.
authorDean Camera <dean@fourwalledcubicle.com>
Wed, 9 Sep 2009 04:18:37 +0000 (04:18 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Wed, 9 Sep 2009 04:18:37 +0000 (04:18 +0000)
Demos/Host/ClassDriver/StillImageHost/StillImageHost.c
LUFA/Drivers/USB/Class/Common/StillImage.h
LUFA/Drivers/USB/Class/Host/HIDParser.c
LUFA/Drivers/USB/Class/Host/StillImage.c
LUFA/Drivers/USB/Class/Host/StillImage.h

index ef073ab..2064856 100644 (file)
@@ -111,7 +111,15 @@ int main(void)
                                }\r
 \r
                                printf("Turning off Device...\r\n");\r
-                               SImage_Host_SendCommand(&DigitalCamera_SI_Interface, 0x1013, 0, 0, 0, 0, NULL);\r
+\r
+                               SImage_Host_SendCommand(&DigitalCamera_SI_Interface, 0x1013, 0, NULL);\r
+                               if (SImage_Host_ReceiveResponse(&DigitalCamera_SI_Interface))\r
+                               {\r
+                                       printf("Could not turn off device.\r\n");\r
+                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+                                       break;                                  \r
+                               }\r
+\r
                                printf("Device Off.\r\n");\r
 \r
                                printf("Closing Session...\r\n");\r
index 690b1bb..23fd79b 100644 (file)
                        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[3]; /**< Block parameters to be issued along with the block code (command blocks only) */\r
+                       uint32_t Params[5]; /**< 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
index accb8f3..5174b59 100644 (file)
@@ -37,7 +37,7 @@ uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID
 {\r
        HID_StateTable_t      StateTable[HID_STATETABLE_STACK_DEPTH];\r
        HID_StateTable_t*     CurrStateTable          = &StateTable[0];\r
-       HID_CollectionPath_t* CurrCollectionPath  = NULL;\r
+       HID_CollectionPath_t* CurrCollectionPath      = NULL;\r
        uint16_t              UsageStack[HID_USAGE_STACK_DEPTH];\r
        uint8_t               UsageStackSize          = 0;\r
        uint16_t              BitOffsetIn             = 0;\r
index ecaed3a..7e3be8a 100644 (file)
@@ -34,8 +34,6 @@
 #define INCLUDE_FROM_SI_CLASS_HOST_C\r
 #include "StillImage.h"\r
 \r
-#warning The Still Image Host mode Class driver is currently incomplete and is for preview purposes only.\r
-\r
 uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t ConfigDescriptorLength,\r
                               uint8_t* DeviceConfigDescriptor)\r
 {\r
@@ -238,7 +236,7 @@ static uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfa
        return PIPE_RWSTREAM_NoError;\r
 }\r
 \r
-static uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes)\r
+uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes)\r
 {\r
        uint8_t ErrorCode;\r
 \r
@@ -253,7 +251,7 @@ static uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, vo
        return ErrorCode;\r
 }\r
 \r
-static uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes)\r
+uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes)\r
 {\r
        uint8_t ErrorCode;\r
 \r
@@ -267,7 +265,7 @@ static uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, vo
        return ErrorCode;\r
 }\r
 \r
-static bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo)\r
+bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo)\r
 {\r
        bool IsEventReceived = false;\r
 \r
@@ -282,7 +280,7 @@ static bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo
        return IsEventReceived;\r
 }\r
 \r
-static uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, SI_PIMA_Container_t* PIMAHeader)\r
+uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, SI_PIMA_Container_t* PIMAHeader)\r
 {\r
        uint8_t ErrorCode;\r
 \r
@@ -318,6 +316,9 @@ uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo)
        if ((ErrorCode = SImage_Host_ReceiveBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)\r
          return ErrorCode;\r
          \r
+       if ((PIMABlock.Type != CType_ResponseBlock) || (PIMABlock.Code != 0x2001))\r
+         return SI_ERROR_LOGICAL_CMD_FAILED;\r
+         \r
        SIInterfaceInfo->State.TransactionID = 0;\r
        SIInterfaceInfo->State.IsSessionOpen = true;\r
 \r
@@ -353,8 +354,8 @@ uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo)
        return PIPE_RWSTREAM_NoError;\r
 }\r
 \r
-uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t Operation, uint8_t UsedParams,\r
-                                uint32_t Param1, uint32_t Param2, uint32_t Param3, void* DataBuff)\r
+uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t Operation,\r
+                                uint8_t TotalParams, uint32_t* Params)\r
 {\r
        if ((USB_HostState != HOST_STATE_Configured) || !(SIInterfaceInfo->State.IsActive))\r
          return HOST_SENDCONTROL_DeviceDisconnect;\r
@@ -363,21 +364,30 @@ uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16
 \r
        SI_PIMA_Container_t PIMABlock = (SI_PIMA_Container_t)\r
                                                        {\r
-                                                               .DataLength    = PIMA_COMMAND_SIZE(UsedParams),\r
+                                                               .DataLength    = PIMA_COMMAND_SIZE(TotalParams),\r
                                                                .Type          = CType_CommandBlock,\r
                                                                .Code          = Operation,\r
-                                                               .Params        = {Param1, Param2, Param3},\r
                                                        };\r
                                                        \r
+       memcpy(&PIMABlock.Params, Params, sizeof(uint32_t) * TotalParams);\r
+                                                       \r
        if ((ErrorCode = SImage_Host_SendBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)\r
          return ErrorCode;\r
-         \r
+\r
+       return PIPE_RWSTREAM_NoError;\r
+}\r
+\r
+uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* SIInterfaceInfo)\r
+{\r
+       uint8_t ErrorCode;\r
+       SI_PIMA_Container_t PIMABlock;\r
+\r
        if ((ErrorCode = SImage_Host_ReceiveBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)\r
          return ErrorCode;\r
 \r
        if ((PIMABlock.Type != CType_ResponseBlock) || (PIMABlock.Code != 0x2001))\r
          return SI_ERROR_LOGICAL_CMD_FAILED;\r
-\r
+         \r
        return PIPE_RWSTREAM_NoError;\r
 }\r
 \r
index 75f76eb..0e14469 100644 (file)
                        uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t ConfigDescriptorLength,\r
                                            uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
+                       /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands\r
+                        *  are issued to the device. Only one session can be open at the one time.\r
+                        *                       \r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
+                        *          returned a logical command failure\r
+                        */\r
                        uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);\r
+\r
+                       /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated\r
+                        *  PIMA commands have been issued to the device.\r
+                        *                       \r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
+                        *          returned a logical command failure\r
+                        */\r
                        uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);\r
 \r
-                       uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t Operation, uint8_t UsedParams,\r
-                                                       uint32_t Param1, uint32_t Param2, uint32_t Param3, void* DataBuff);\r
+                       /** Sends a given PIMA command to the attached device, filling out the PIMA command header automatically as required.\r
+                        *                       \r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *  \param[in] Operation  PIMA operation code to issue to the device\r
+                        *  \param[in] TotalParams  Total number of 32-bit parameters to send to the device in the issued command block\r
+                        *  \param[in] Params  Pointer to an array of 32-bit values containing the parameters to send in the command block\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
+                        *          returned a logical command failure\r
+                        */\r
+                       uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t Operation, uint8_t TotalParams,\r
+                                            uint32_t* Params);\r
+\r
+                       /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data\r
+                        *  associated with the command has been transferred.\r
+                        *                       \r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
+                        *          returned a logical command failure\r
+                        */\r
+                       uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);\r
+\r
+                       /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.\r
+                        *\r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *\r
+                        *  \return Boolean true if an event is waiting to be read, false otherwise\r
+                        */\r
+                       bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);\r
+\r
+                       /** Receives an asynchronous event block from the device via the asynchronous events pipe.\r
+                        *\r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *  \param[out] SI_PIMA_Container_t  Pointer to a PIMA container structure where the event should be stored\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device\r
+                        *          returned a logical command failure\r
+                        */\r
+                       uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,\r
+                                                                  SI_PIMA_Container_t* PIMAHeader);\r
+                       \r
+                       /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data\r
+                        *  transfer beyond the regular PIMA command block parameters.\r
+                        *\r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *  \param[in] Buffer  Pointer to a buffer where the data to send has been stored\r
+                        *  \param[in] Bytes  Length in bytes of the data in the buffer to send to the attached device\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);\r
+\r
+                       /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data\r
+                        *  transfer beyond the regular PIMA command block parameters.\r
+                        *\r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *  \param[out] Buffer  Pointer to a buffer where the received data is to be stored\r
+                        *  \param[in] Bytes  Length in bytes of the data to read\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);\r
                        \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                                                                           SI_PIMA_Container_t* PIMAHeader);\r
                                static uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,\r
                                                                              SI_PIMA_Container_t* PIMAHeader);\r
-                               static uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);\r
-                               static uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);\r
-                               static bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);\r
-                               static uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,\r
-                                                                             SI_PIMA_Container_t* PIMAHeader);\r
                        #endif\r
        #endif\r
        \r