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
  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, uint16_t ConfigDescriptorSize,
 144                                                void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 145
 146                         /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
 147                          *  are issued to the device. Only one session can be open at the one time.
 148                          *
 149                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 150                          *        call will fail.
 151                          *
 152                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 153                          *
 154                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 155                          *          returned a logical command failure
 156                          */
 157                         uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 158
 159                         /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
 160                          *  PIMA commands have been issued to the device.
 161                          *
 162                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 163                          *        call will fail.
 164                          *
 165                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 166                          *
 167                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 168                          *          returned a logical command failure
 169                          */
 170                         uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 171
 172                         /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send
 173                          *  arbitrary PIMA blocks to the device with or without parameters.
 174                          *
 175                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 176                          *        call will fail.
 177                          *
 178                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 179                          *  \param[in] PIMAHeader  Pointer to a PIMA container structure that is to be sent
 180                          *
 181                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 182                          */
 183                         uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);
 184
 185                         /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with
 186                          *  or without parameters.
 187                          *
 188                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 189                          *        call will fail.
 190                          *
 191                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 192                          *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the received block is to be stored
 193                          *
 194                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 195                          */
 196                         uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);
 197
 198                         /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
 199                          *
 200                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 201                          *        call will fail.
 202                          *
 203                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 204                          *  \param[in] Operation  PIMA operation code to issue to the device
 205                          *  \param[in] TotalParams  Total number of 32-bit parameters to send to the device in the issued command block
 206                          *  \param[in] Params  Pointer to an array of 32-bit values containing the parameters to send in the command block
 207                          *
 208                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 209                          *          returned a logical command failure
 210                          */
 211                         uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, const uint16_t Operation,
 212                                                         const uint8_t TotalParams, uint32_t* Params) ATTR_NON_NULL_PTR_ARG(1);
 213
 214                         /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data
 215                          *  associated with the command has been transferred.
 216                          *
 217                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 218                          *        call will fail.
 219                          *
 220                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 221                          *
 222                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 223                          *          returned a logical command failure
 224                          */
 225                         uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 226
 227                         /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
 228                          *
 229                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 230                          *        call will fail.
 231                          *
 232                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 233                          *
 234                          *  \return Boolean true if an event is waiting to be read, false otherwise
 235                          */
 236                         bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 237
 238                         /** Receives an asynchronous event block from the device via the asynchronous events pipe.
 239                          *
 240                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 241                          *        call will fail.
 242                          *
 243                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 244                          *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the event should be stored
 245                          *
 246                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 247                          *          returned a logical command failure
 248                          */
 249                         uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 250                                                                    SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
 251                                                                ATTR_NON_NULL_PTR_ARG(2);
 252
 253                         /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data
 254                          *  transfer beyond the regular PIMA command block parameters.
 255                          *
 256                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 257                          *        call will fail.
 258                          *
 259                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 260                          *  \param[in] Buffer  Pointer to a buffer where the data to send has been stored
 261                          *  \param[in] Bytes  Length in bytes of the data in the buffer to send to the attached device
 262                          *
 263                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 264                          */
 265                         uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
 266                                                      const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 267
 268                         /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data
 269                          *  transfer beyond the regular PIMA command block parameters.
 270                          *
 271                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 272                          *        call will fail.
 273                          *
 274                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 275                          *  \param[out] Buffer  Pointer to a buffer where the received data is to be stored
 276                          *  \param[in] Bytes  Length in bytes of the data to read
 277                          *
 278                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 279                          */
 280                         uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
 281                                                      const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 282
 283                 /* Inline Functions: */
 284                         /** General management task for a given Still Image host class interface, required for the correct operation of the
 285                          *  interface. This should be called frequently in the main program loop, before the master USB management task
 286                          *  \ref USB_USBTask().
 287                          *
 288                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 289                          */
 290                         static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo);
 291                         static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
 292                         {
 293                                 (void)SIInterfaceInfo;
 294                         }
 295
 296         /* Private Interface - For use in library only: */
 297         #if !defined(__DOXYGEN__)
 298                 /* Macros: */
 299                         #define STILL_IMAGE_CLASS              0x06
 300                         #define STILL_IMAGE_SUBCLASS           0x01
 301                         #define STILL_IMAGE_PROTOCOL           0x01
 302
 303                         #define SI_FOUND_EVENTS_IN             (1 << 0)
 304                         #define SI_FOUND_DATAPIPE_IN           (1 << 1)
 305                         #define SI_FOUND_DATAPIPE_OUT          (1 << 2)
 306
 307                         #define COMMAND_DATA_TIMEOUT_MS        10000
 308
 309                 /* Function Prototypes: */
 310                         #if defined(__INCLUDE_FROM_SI_CLASS_HOST_C)
 311                                 static uint8_t DCOMP_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 312                                 static uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 313                         #endif
 314         #endif
 315
 316         /* Disable C linkage for C++ Compilers: */
 317                 #if defined(__cplusplus)
 318                         }
 319                 #endif
 320
 321 #endif
 322
 323 /** @} */