More improvements to the incomplete BluetoothHost demo - add Disconnection Event...

[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 75f76eb..4a5ccfa 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Host mode driver for the library USB Still Image Class driver.\r
+ *\r
+ *  Host mode driver for the library USB Still Image Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassSI\r
  *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassSI\r
  *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver\r
  *\r


@@ -53,25 +62,42 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_SI_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.\r
+               #endif\r
+               \r

        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\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
 \r
                /* Type Defines: */\r

+                       /** \brief Still Image Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r
+                        *  and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This\r
+                        *  stores each Still Image interface's configuration and state information.\r
+                        */\r

                        typedef struct\r
                        {\r
                                const struct\r
                                {\r
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */\r
                        typedef struct\r
                        {\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 +114,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


@@ -102,15 +128,6 @@
                        };\r
 \r
                /* Function Prototypes: */\r
                        };\r
 \r
                /* Function Prototypes: */\r

-                       /** General management task for a given Still Image host class interface, required for the correct operation of the\r
-                        *  interface. This should be called frequently in the main program loop, before the master USB management task\r
-                        *  \ref USB_USBTask().\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
-\r
-\r

                        /** Host interface configuration routine, to configure a given Still Image host interface instance using the\r
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still\r
                         *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is\r
                        /** Host interface configuration routine, to configure a given Still Image host interface instance using the\r
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still\r
                         *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is\r


@@ -118,20 +135,164 @@
                         *  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
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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 raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send\r
+                        *  arbitrary PIMA blocks to the device with or without parameters.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        *  \param[in] PIMAHeader  Pointer to a PIMA container structure that is to be sent\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);\r
+                       \r
+                       /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with\r
+                        *  or without parameters.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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 received block is to be stored\r
+                        *\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);\r

 \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
+                       /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.\r
+                        *      \r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
 \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
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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)\r
+                                                              ATTR_NON_NULL_PTR_ARG(2);\r

                        \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
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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) 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
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\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) ATTR_NON_NULL_PTR_ARG(2);\r
+               \r
+               /* Inline Functions: */\r
+                       /** General management task for a given Still Image host class interface, required for the correct operation of the\r
+                        *  interface. This should be called frequently in the main program loop, before the master USB management task\r
+                        *  \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state\r
+                        */\r
+                       static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo);\r
+                       static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)\r
+                       {\r
+                               (void)SIInterfaceInfo;\r
+                       }               \r
+\r

        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r


@@ -143,22 +304,12 @@
                        #define SI_FOUND_DATAPIPE_IN           (1 << 1)\r
                        #define SI_FOUND_DATAPIPE_OUT          (1 << 2)\r
 \r
                        #define SI_FOUND_DATAPIPE_IN           (1 << 1)\r
                        #define SI_FOUND_DATAPIPE_OUT          (1 << 2)\r
 \r

-                       #define COMMAND_DATA_TIMEOUT_MS        5000\r
+                       #define COMMAND_DATA_TIMEOUT_MS        10000\r

                \r
                /* Function Prototypes: */\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
-\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_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
+                       #if defined(__INCLUDE_FROM_SI_CLASS_HOST_C)\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

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