Fix newly renamed VirtualSerial demos' include filename references so that they compile.

[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..4478931 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


@@ -63,15 +64,20 @@
                                const struct\r
                                {\r
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */\r
                                const struct\r
                                {\r
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */\r

+                                       bool     DataINPipeDoubleBank; /** Indicates if the Still Image interface's IN data pipe should use double banking */\r
+\r

                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */\r
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */\r

+                                       bool     DataOUTPipeDoubleBank; /** Indicates if the Still Image interface's OUT data pipe should use double banking */\r
+\r

                                        uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */                       \r
                                        uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */                       \r

+                                       bool     EventsPipeDoubleBank; /** Indicates if the Still Image interface's events data pipe should use double banking */\r

                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r
                                struct\r
                                {\r
                                        bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid\r
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r
                                struct\r
                                {\r
                                        bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid\r

-                                                       *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the\r
+                                                       *   after \ref SImage_Host_ConfigurePipes() is called and the Host state machine is in the\r

                                                        *   Configured state\r
                                                        */\r
 \r
                                                        *   Configured state\r
                                                        */\r
 \r


@@ -88,7 +94,7 @@
                        } USB_ClassInfo_SI_Host_t;\r
        \r
                /* Enums: */\r
                        } USB_ClassInfo_SI_Host_t;\r
        \r
                /* Enums: */\r

-                       /** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */\r
+                       /** Enum for the possible error codes returned by the \ref SImage_Host_ConfigurePipes() function. */\r

                        enum SIHost_EnumerationFailure_ErrorCodes_t\r
                        {\r
                                SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                        enum SIHost_EnumerationFailure_ErrorCodes_t\r
                        {\r
                                SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r


@@ -108,7 +114,7 @@
                         *\r
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
                         */\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 SImage_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
 \r
 \r
                        /** Host interface configuration routine, to configure a given Still Image host interface instance using the\r


@@ -118,13 +124,13 @@
                         *  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
                         *  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
                         *  \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* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                       uint8_t SImage_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, uint16_t ConfigDescriptorSize,\r
+                                               void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(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
                        /** 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


@@ -134,7 +140,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* 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
                        /** 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,9 +150,9 @@
                         *  \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* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

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


@@ -156,8 +162,8 @@
                         *  \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_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t Operation, uint8_t TotalParams,\r
-                                            uint32_t* Params);\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
                        /** 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 +173,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* 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
 \r
                        /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.\r
                         *\r


@@ -175,18 +181,19 @@
                         *\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* 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
 \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
                         *\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
+                       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)\r
+                                                              ATTR_NON_NULL_PTR_ARG(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 +204,8 @@
                         *\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* const SIInterfaceInfo, void* Buffer,\r
+                                                    const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(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 +216,8 @@
                         *\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* const SIInterfaceInfo, void* Buffer,\r
+                                                    const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(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


@@ -225,13 +234,13 @@
                \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_SI_CLASS_HOST_C)\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
-                               static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-                               static uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,\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_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,\r
+                                                                          SI_PIMA_Container_t* const PIMAHeader);\r
+                               static uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,\r
+                                                                             SI_PIMA_Container_t* const PIMAHeader);\r

                        #endif\r
        #endif\r
        \r
                        #endif\r
        #endif\r
        \r