\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
+ /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */\r
#define SI_ERROR_LOGICAL_CMD_FAILED 0xC0\r
\r
/* Type Defines: */\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
+ uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* 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
* \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
+ uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* 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
* 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
+ uint32_t* Params) ATTR_NON_NULL_PTR_ARG(1);\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
* \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
+ uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* 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
*\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
+ bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Receives an asynchronous event block from the device via the asynchronous events pipe.\r
*\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
+ SI_PIMA_Container_t* 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
* \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
+ uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, 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
* \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
+ uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r