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 /** \file
  32  *  \brief Host mode driver for the library USB Still Image Class driver.
  33  *
  34  *  Host mode driver for the library USB Still Image Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.
  38  */
  39
  40 /** \ingroup Group_USBClassSI
  41  *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Host/StillImage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Module Description
  48  *  Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __SI_CLASS_HOST_H__
  54 #define __SI_CLASS_HOST_H__
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/StillImage.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_SI_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Macros: */
  72                         /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error. */
  73                         #define SI_ERROR_LOGICAL_CMD_FAILED              0x80
  74
  75                 /* Type Defines: */
  76                         /** \brief Still Image Class Host Mode Configuration and State Structure.
  77                          *
  78                          *  Class state structure. An instance of this structure should be made within the user application,
  79                          *  and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This
  80                          *  stores each Still Image interface's configuration and state information.
  81                          */
  82                         typedef struct
  83                         {
  84                                 const struct
  85                                 {
  86                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe. */
  87                                         bool     DataINPipeDoubleBank; /**< Indicates if the Still Image interface's IN data pipe should use double banking. */
  88
  89                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe. */
  90                                         bool     DataOUTPipeDoubleBank; /**< Indicates if the Still Image interface's OUT data pipe should use double banking. */
  91
  92                                         uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used. */
  93                                         bool     EventsPipeDoubleBank; /**< Indicates if the Still Image interface's events data pipe should use double banking. */
  94                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  95                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  96                                            */
  97                                 struct
  98                                 {
  99                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
 100                                                         *   after \ref SImage_Host_ConfigurePipes() is called and the Host state machine is in the
 101                                                         *   Configured state.
 102                                                         */
 103
 104                                         uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe. */
 105                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Still Image interface's OUT data pipe. */
 106                                         uint16_t EventsPipeSize;  /**< Size in bytes of the Still Image interface's IN events pipe. */
 107
 108                                         bool IsSessionOpen; /**< Indicates if a PIMA session is currently open with the attached device. */
 109                                         uint32_t TransactionID; /**< Transaction ID for the next transaction to send to the device. */
 110                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 111                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 112                                                   *   the interface is enumerated.
 113                                                   */
 114                         } USB_ClassInfo_SI_Host_t;
 115
 116                 /* Enums: */
 117                         /** Enum for the possible error codes returned by the \ref SImage_Host_ConfigurePipes() function. */
 118                         enum SIHost_EnumerationFailure_ErrorCodes_t
 119                         {
 120                                 SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 121                                 SI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 122                                 SI_ENUMERROR_NoSIInterfaceFound         = 2, /**< A compatible Still Image interface was not found in the device's
 123                                                                               *   Configuration Descriptor.
 124                                                                               */
 125                                 SI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Still Image data endpoints were not found in the
 126                                                                               *   device's Still Image interface.
 127                                                                               */
 128                         };
 129
 130                 /* Function Prototypes: */
 131                         /** Host interface configuration routine, to configure a given Still Image host interface instance using the
 132                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
 133                          *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is
 134                          *  found within the device. This should be called once after the stack has enumerated the attached device, while
 135                          *  the host state machine is in the Addressed state.
 136                          *
 137                          *  \param[in,out] SIInterfaceInfo         Pointer to a structure containing a Still Image Class host configuration and state.
 138                          *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
 139                          *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
 140                          *
 141                          *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum.
 142                          */
 143                         uint8_t SImage_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 144                                                            uint16_t ConfigDescriptorSize,
 145                                                            void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 146
 147                         /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
 148                          *  are issued to the device. Only one session can be open at the one time.
 149                          *
 150                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 151                          *       call will fail.
 152                          *
 153                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 154                          *
 155                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 156                          *          returned a logical command failure.
 157                          */
 158                         uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 159
 160                         /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
 161                          *  PIMA commands have been issued to the device.
 162                          *
 163                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 164                          *       call will fail.
 165                          *
 166                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 167                          *
 168                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 169                          *          returned a logical command failure.
 170                          */
 171                         uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 172
 173                         /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send
 174                          *  arbitrary PIMA blocks to the device with or without parameters.
 175                          *
 176                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 177                          *       call will fail.
 178                          *
 179                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 180                          *  \param[in]     PIMAHeader       Pointer to a PIMA container structure that is to be sent.
 181                          *
 182                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 183                          */
 184                         uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 185                                                             SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
 186                                                             ATTR_NON_NULL_PTR_ARG(2);
 187
 188                         /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with
 189                          *  or without parameters.
 190                          *
 191                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 192                          *       call will fail.
 193                          *
 194                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 195                          *  \param[out]    PIMAHeader       Pointer to a PIMA container structure where the received block is to be stored.
 196                          *
 197                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 198                          */
 199                         uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 200                                                                SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
 201                                                                ATTR_NON_NULL_PTR_ARG(2);
 202
 203                         /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
 204                          *
 205                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 206                          *       call will fail.
 207                          *
 208                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 209                          *  \param[in]     Operation        PIMA operation code to issue to the device.
 210                          *  \param[in]     TotalParams      Total number of 32-bit parameters to send to the device in the issued command block.
 211                          *  \param[in]     Params           Pointer to an array of 32-bit values containing the parameters to send in the command block.
 212                          *
 213                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 214                          *          returned a logical command failure.
 215                          */
 216                         uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 217                                                         const uint16_t Operation,
 218                                                         const uint8_t TotalParams,
 219                                                         uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1);
 220
 221                         /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data
 222                          *  associated with the command has been transferred.
 223                          *
 224                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 225                          *       call will fail.
 226                          *
 227                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 228                          *
 229                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 230                          *          returned a logical command failure.
 231                          */
 232                         uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 233
 234                         /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
 235                          *
 236                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 237                          *       call will fail.
 238                          *
 239                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 240                          *
 241                          *  \return Boolean true if an event is waiting to be read, false otherwise.
 242                          */
 243                         bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 244
 245                         /** Receives an asynchronous event block from the device via the asynchronous events pipe.
 246                          *
 247                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 248                          *       call will fail.
 249                          *
 250                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 251                          *  \param[out]    PIMAHeader       Pointer to a PIMA container structure where the event should be stored.
 252                          *
 253                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 254                          *          returned a logical command failure.
 255                          */
 256                         uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 257                                                                SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
 258                                                                ATTR_NON_NULL_PTR_ARG(2);
 259
 260                         /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data
 261                          *  transfer beyond the regular PIMA command block parameters.
 262                          *
 263                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 264                          *       call will fail.
 265                          *
 266                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 267                          *  \param[in]     Buffer           Pointer to a buffer where the data to send has been stored.
 268                          *  \param[in]     Bytes            Length in bytes of the data in the buffer to send to the attached device.
 269                          *
 270                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 271                          */
 272                         uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 273                                                      void* Buffer,
 274                                                      const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 275
 276                         /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data
 277                          *  transfer beyond the regular PIMA command block parameters.
 278                          *
 279                          *  \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 280                          *       call will fail.
 281                          *
 282                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 283                          *  \param[out]    Buffer           Pointer to a buffer where the received data is to be stored.
 284                          *  \param[in]     Bytes            Length in bytes of the data to read.
 285                          *
 286                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 287                          */
 288                         uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 289                                                      void* Buffer,
 290                                                      const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 291
 292                 /* Inline Functions: */
 293                         /** General management task for a given Still Image host class interface, required for the correct operation of the
 294                          *  interface. This should be called frequently in the main program loop, before the master USB management task
 295                          *  \ref USB_USBTask().
 296                          *
 297                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 298                          */
 299                         static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 300                         static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
 301                         {
 302                                 (void)SIInterfaceInfo;
 303                         }
 304
 305         /* Private Interface - For use in library only: */
 306         #if !defined(__DOXYGEN__)
 307                 /* Macros: */
 308                         #define STILL_IMAGE_CLASS              0x06
 309                         #define STILL_IMAGE_SUBCLASS           0x01
 310                         #define STILL_IMAGE_PROTOCOL           0x01
 311
 312                         #define SI_FOUND_EVENTS_IN             (1 << 0)
 313                         #define SI_FOUND_DATAPIPE_IN           (1 << 1)
 314                         #define SI_FOUND_DATAPIPE_OUT          (1 << 2)
 315
 316                         #define COMMAND_DATA_TIMEOUT_MS        10000
 317
 318                 /* Function Prototypes: */
 319                         #if defined(__INCLUDE_FROM_SI_CLASS_HOST_C)
 320                                 static uint8_t DCOMP_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 321                                 static uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 322                         #endif
 323         #endif
 324
 325         /* Disable C linkage for C++ Compilers: */
 326                 #if defined(__cplusplus)
 327                         }
 328                 #endif
 329
 330 #endif
 331
 332 /** @} */