Remove type definitions of the keyboard and mouse boot protocol report layouts from...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / StillImage.h

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h
index 0e14469..037ae6c 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -55,7 +55,8 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
 \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
                /* Type Defines: */\r
                        typedef struct\r


@@ -134,7 +135,7 @@
                         *  \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
                         *  \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
 \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


@@ -144,7 +145,7 @@
                         *  \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
                         *  \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
 \r
                        /** Sends a given PIMA command to the attached device, filling out the PIMA command header automatically as required.\r
                         *                       \r


@@ -157,7 +158,7 @@
                         *          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
                         *          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
 \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


@@ -167,7 +168,7 @@
                         *  \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
                         *  \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
                        /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.\r
                         *\r


@@ -175,18 +176,18 @@
                         *\r
                         *  \return Boolean true if an event is waiting to be read, false otherwise\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
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\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
+                        *  \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* SIInterfaceInfo,\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
+                                                                  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
                        /** 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


@@ -197,7 +198,7 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
                         */\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
                        /** 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


@@ -208,7 +209,7 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
                         */\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
                        \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r