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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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                         #define SI_ERROR_LOGICAL_CMD_FAILED              0xC0
  59
  60                 /* Type Defines: */
  61                         typedef struct
  62                         {
  63                                 const struct
  64                                 {
  65                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */
  66                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */
  67                                         uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */
  68                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  69                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  70                                            */
  71                                 struct
  72                                 {
  73                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  74                                                         *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
  75                                                         *   Configured state
  76                                                         */
  77
  78                                         uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe */
  79                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Still Image interface's OUT data pipe */
  80                                         uint16_t EventsPipeSize;  /**< Size in bytes of the Still Image interface's IN events pipe */
  81
  82                                         bool IsSessionOpen; /**< Indicates if a PIMA session is currently open with the attached device */
  83                                         uint32_t TransactionID; /**< Transaction ID for the next transaction to send to the device */
  84                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  85                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  86                                                   *   the interface is enumerated.
  87                                                   */
  88                         } USB_ClassInfo_SI_Host_t;
  89
  90                 /* Enums: */
  91                         /** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */
  92                         enum SIHost_EnumerationFailure_ErrorCodes_t
  93                         {
  94                                 SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
  95                                 SI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
  96                                 SI_ENUMERROR_NoSIInterfaceFound         = 2, /**< A compatible Still Image interface was not found in the device's
  97                                                                              *   Configuration Descriptor
  98                                                                              */
  99                                 SI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Still Image data endpoints were not found in the
 100                                                                               *   device's Still Image interface
 101                                                                               */
 102                         };
 103
 104                 /* Function Prototypes: */
 105                         /** General management task for a given Still Image host class interface, required for the correct operation of the
 106                          *  interface. This should be called frequently in the main program loop, before the master USB management task
 107                          *  \ref USB_USBTask().
 108                          *
 109                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 110                          */
 111                         void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 112
 113
 114                         /** Host interface configuration routine, to configure a given Still Image host interface instance using the
 115                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
 116                          *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is
 117                          *  found within the device. This should be called once after the stack has enumerated the attached device, while
 118                          *  the host state machine is in the Addressed state.
 119                          *
 120                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 121                          *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor
 122                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 123                          *
 124                          *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
 125                          */
 126                         uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t ConfigDescriptorLength,
 127                                            uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
 128
 129                         /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
 130                          *  are issued to the device. Only one session can be open at the one time.
 131                          *
 132                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 133                          *
 134                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 135                          *          returned a logical command failure
 136                          */
 137                         uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
 138
 139                         /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
 140                          *  PIMA commands have been issued to the device.
 141                          *
 142                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 143                          *
 144                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 145                          *          returned a logical command failure
 146                          */
 147                         uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
 148
 149                         /** Sends a given PIMA command to the attached device, filling out the PIMA command header automatically as required.
 150                          *
 151                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 152                          *  \param[in] Operation  PIMA operation code to issue to the device
 153                          *  \param[in] TotalParams  Total number of 32-bit parameters to send to the device in the issued command block
 154                          *  \param[in] Params  Pointer to an array of 32-bit values containing the parameters to send in the command block
 155                          *
 156                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 157                          *          returned a logical command failure
 158                          */
 159                         uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t Operation, uint8_t TotalParams,
 160                                             uint32_t* Params);
 161
 162                         /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data
 163                          *  associated with the command has been transferred.
 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_ReceiveResponse(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
 171
 172                         /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
 173                          *
 174                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 175                          *
 176                          *  \return Boolean true if an event is waiting to be read, false otherwise
 177                          */
 178                         bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
 179
 180                         /** Receives an asynchronous event block from the device via the asynchronous events pipe.
 181                          *
 182                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 183                          *  \param[out] SI_PIMA_Container_t  Pointer to a PIMA container structure where the event should be stored
 184                          *
 185                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
 186                          *          returned a logical command failure
 187                          */
 188                         uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,
 189                                                                    SI_PIMA_Container_t* PIMAHeader);
 190
 191                         /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data
 192                          *  transfer beyond the regular PIMA command block parameters.
 193                          *
 194                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 195                          *  \param[in] Buffer  Pointer to a buffer where the data to send has been stored
 196                          *  \param[in] Bytes  Length in bytes of the data in the buffer to send to the attached device
 197                          *
 198                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 199                          */
 200                         uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);
 201
 202                         /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data
 203                          *  transfer beyond the regular PIMA command block parameters.
 204                          *
 205                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 206                          *  \param[out] Buffer  Pointer to a buffer where the received data is to be stored
 207                          *  \param[in] Bytes  Length in bytes of the data to read
 208                          *
 209                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 210                          */
 211                         uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);
 212
 213         /* Private Interface - For use in library only: */
 214         #if !defined(__DOXYGEN__)
 215                 /* Macros: */
 216                         #define STILL_IMAGE_CLASS              0x06
 217                         #define STILL_IMAGE_SUBCLASS           0x01
 218                         #define STILL_IMAGE_PROTOCOL           0x01
 219
 220                         #define SI_FOUND_EVENTS_IN             (1 << 0)
 221                         #define SI_FOUND_DATAPIPE_IN           (1 << 1)
 222                         #define SI_FOUND_DATAPIPE_OUT          (1 << 2)
 223
 224                         #define COMMAND_DATA_TIMEOUT_MS        5000
 225
 226                 /* Function Prototypes: */
 227                         #if defined(INCLUDE_FROM_SI_CLASS_HOST_C)
 228                                 static uint8_t DComp_SI_Host_NextSIInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 229                                 static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 230
 231                                 static uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,
 232                                                                            SI_PIMA_Container_t* PIMAHeader);
 233                                 static uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,
 234                                                                               SI_PIMA_Container_t* PIMAHeader);
 235                         #endif
 236         #endif
 237
 238         /* Disable C linkage for C++ Compilers: */
 239                 #if defined(__cplusplus)
 240                         }
 241                 #endif
 242
 243 #endif
 244
 245 /** @} */