\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
- #define SI_ERROR_LOGICAL_CMD_FAILED 0xC0\r
+ /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */\r
+ #define SI_ERROR_LOGICAL_CMD_FAILED 0x80\r
\r
/* Type Defines: */\r
typedef struct\r
*\r
* \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state\r
*/\r
- void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
\r
/** Host interface configuration routine, to configure a given Still Image host interface instance using the\r
* the host state machine is in the Addressed state.\r
*\r
* \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state\r
- * \param[in] ConfigDescriptorLength Length of the attached device's Configuration Descriptor\r
+ * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor\r
* \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor\r
*\r
* \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum\r
*/\r
- uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t ConfigDescriptorLength,\r
+ uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, uint16_t ConfigDescriptorSize,\r
uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
\r
- uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);\r
- uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);\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* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\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* const SIInterfaceInfo, const uint16_t Operation,\r
+ const uint8_t TotalParams, uint32_t* Params) ATTR_NON_NULL_PTR_ARG(1);\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
+ /** 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* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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] PIMAHeader 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* const SIInterfaceInfo,\r
+ SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1, 2);\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* const SIInterfaceInfo, void* Buffer,\r
+ const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1, 2);\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* const SIInterfaceInfo, void* Buffer,\r
+ const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1, 2);\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
projects / pub / USBasp.git / blobdiff