LUFA/Drivers/USB/Class/Host/StillImage.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \ingroup Group_USBClassSI
  32  *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Host/StillImage.c
  37  *
  38  *  \section Module Description
  39  *  Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef __SI_CLASS_HOST_H__
  45 #define __SI_CLASS_HOST_H__
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/StillImage.h"
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Public Interface - May be used in end-application: */
  57                 /* Macros: */
  58                         /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */
  59                         #define SI_ERROR_LOGICAL_CMD_FAILED              0x80
  60
  61                 /* Type Defines: */
  62                         typedef struct
  63                         {
  64                                 const struct
  65                                 {
  66                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */
  67                                         bool     DataINPipeDoubleBank; /** Indicates if the Still Image interface's IN data pipe should use double banking */
  68
  69                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */
  70                                         bool     DataOUTPipeDoubleBank; /** Indicates if the Still Image interface's OUT data pipe should use double banking */
  71
  72                                         uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */
  73                                         bool     EventsPipeDoubleBank; /** Indicates if the Still Image interface's events data pipe should use double banking */
  74                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  75                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  76                                            */
  77                                 struct
  78                                 {
  79                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  80                                                         *   after \ref SImage_Host_ConfigurePipes() is called and the Host state machine is in the
  81                                                         *   Configured state
  82                                                         */
  83
  84                                         uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe */
  85                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Still Image interface's OUT data pipe */
  86                                         uint16_t EventsPipeSize;  /**< Size in bytes of the Still Image interface's IN events pipe */
  87
  88                                         bool IsSessionOpen; /**< Indicates if a PIMA session is currently open with the attached device */
  89                                         uint32_t TransactionID; /**< Transaction ID for the next transaction to send to the device */
  90                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  91                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  92                                                   *   the interface is enumerated.
  93                                                   */
  94                         } USB_ClassInfo_SI_Host_t;
  95
  96                 /* Enums: */
  97                         /** Enum for the possible error codes returned by the \ref SImage_Host_ConfigurePipes() function. */
  98                         enum SIHost_EnumerationFailure_ErrorCodes_t
  99                         {
 100                                 SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 101                                 SI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 102                                 SI_ENUMERROR_NoSIInterfaceFound         = 2, /**< A compatible Still Image interface was not found in the device's
 103                                                                              *   Configuration Descriptor
 104                                                                              */
 105                                 SI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Still Image data endpoints were not found in the
 106                                                                               *   device's Still Image interface
 107                                                                               */
 108                         };
 109
 110                 /* Function Prototypes: */
 111                         /** General management task for a given Still Image host class interface, required for the correct operation of the
 112                          *  interface. This should be called frequently in the main program loop, before the master USB management task
 113                          *  \ref USB_USBTask().
 114                          *
 115                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 116                          */
 117                         void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 118
 119
 120                         /** Host interface configuration routine, to configure a given Still Image host interface instance using the
 121                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
 122                          *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is
 123                          *  found within the device. This should be called once after the stack has enumerated the attached device, while
 124                          *  the host state machine is in the Addressed state.
 125                          *
 126                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 127                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 128                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 129                          *
 130                          *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
 131                          */
 132                         uint8_t SImage_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, uint16_t ConfigDescriptorSize,
 133                                                void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 134
 135                         /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
 136                          *  are issued to the device. Only one session can be open at the one time.
 137                          *
 138                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 139                          *
 140                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 141                          *          returned a logical command failure
 142                          */
 143                         uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 144
 145                         /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
 146                          *  PIMA commands have been issued to the device.
 147                          *
 148                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 149                          *
 150                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 151                          *          returned a logical command failure
 152                          */
 153                         uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 154
 155                         /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send
 156                          *  arbitrary PIMA blocks to the device with or without parameters.
 157                          *
 158                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 159                          *  \param[in] PIMAHeader  Pointer to a PIMA container structure that is to be sent
 160                          *
 161                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 162                          */
 163                         uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);
 164
 165                         /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with
 166                          *  or without parameters.
 167                          *
 168                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 169                          *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the received block is to be stored
 170                          *
 171                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 172                          */
 173                         uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);
 174
 175                         /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
 176                          *
 177                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 178                          *  \param[in] Operation  PIMA operation code to issue to the device
 179                          *  \param[in] TotalParams  Total number of 32-bit parameters to send to the device in the issued command block
 180                          *  \param[in] Params  Pointer to an array of 32-bit values containing the parameters to send in the command block
 181                          *
 182                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 183                          *          returned a logical command failure
 184                          */
 185                         uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, const uint16_t Operation,
 186                                                         const uint8_t TotalParams, uint32_t* Params) ATTR_NON_NULL_PTR_ARG(1);
 187
 188                         /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data
 189                          *  associated with the command has been transferred.
 190                          *
 191                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 192                          *
 193                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 194                          *          returned a logical command failure
 195                          */
 196                         uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 197
 198                         /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
 199                          *
 200                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 201                          *
 202                          *  \return Boolean true if an event is waiting to be read, false otherwise
 203                          */
 204                         bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 205
 206                         /** Receives an asynchronous event block from the device via the asynchronous events pipe.
 207                          *
 208                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 209                          *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the event should be stored
 210                          *
 211                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 212                          *          returned a logical command failure
 213                          */
 214                         uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 215                                                                    SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
 216                                                                ATTR_NON_NULL_PTR_ARG(2);
 217
 218                         /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data
 219                          *  transfer beyond the regular PIMA command block parameters.
 220                          *
 221                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 222                          *  \param[in] Buffer  Pointer to a buffer where the data to send has been stored
 223                          *  \param[in] Bytes  Length in bytes of the data in the buffer to send to the attached device
 224                          *
 225                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 226                          */
 227                         uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
 228                                                      const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 229
 230                         /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data
 231                          *  transfer beyond the regular PIMA command block parameters.
 232                          *
 233                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 234                          *  \param[out] Buffer  Pointer to a buffer where the received data is to be stored
 235                          *  \param[in] Bytes  Length in bytes of the data to read
 236                          *
 237                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 238                          */
 239                         uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
 240                                                      const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 241
 242         /* Private Interface - For use in library only: */
 243         #if !defined(__DOXYGEN__)
 244                 /* Macros: */
 245                         #define STILL_IMAGE_CLASS              0x06
 246                         #define STILL_IMAGE_SUBCLASS           0x01
 247                         #define STILL_IMAGE_PROTOCOL           0x01
 248
 249                         #define SI_FOUND_EVENTS_IN             (1 << 0)
 250                         #define SI_FOUND_DATAPIPE_IN           (1 << 1)
 251                         #define SI_FOUND_DATAPIPE_OUT          (1 << 2)
 252
 253                         #define COMMAND_DATA_TIMEOUT_MS        10000
 254
 255                 /* Function Prototypes: */
 256                         #if defined(INCLUDE_FROM_SI_CLASS_HOST_C)
 257                                 static uint8_t DComp_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 258                                 static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 259                         #endif
 260         #endif
 261
 262         /* Disable C linkage for C++ Compilers: */
 263                 #if defined(__cplusplus)
 264                         }
 265                 #endif
 266
 267 #endif
 268
 269 /** @} */