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