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