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                 /* Type Defines: */
  58                         typedef struct
  59                         {
  60                                 const struct
  61                                 {
  62                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */
  63                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */
  64                                         uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */
  65                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  66                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  67                                            */
  68                                 struct
  69                                 {
  70                                         bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid
  71                                                       *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
  72                                                       *   Configured state
  73                                                       */
  74
  75                                         uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe */
  76                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Still Image interface's OUT data pipe */
  77                                         uint16_t EventsPipeSize;  /**< Size in bytes of the Still Image interface's IN events pipe */
  78                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  79                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  80                                                   *   the interface is enumerated.
  81                                                   */
  82                         } USB_ClassInfo_SI_Host_t;
  83
  84                 /* Enums: */
  85                         /** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */
  86                         enum SIHost_EnumerationFailure_ErrorCodes_t
  87                         {
  88                                 SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
  89                                 SI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
  90                                 SI_ENUMERROR_NoSIInterfaceFound         = 2, /**< A compatible Still Image interface was not found in the device's
  91                                                                              *   Configuration Descriptor
  92                                                                              */
  93                                 SI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Still Image data endpoints were not found in the
  94                                                                               *   device's Still Image interface
  95                                                                               */
  96                         };
  97
  98                 /* Function Prototypes: */
  99                         /** General management task for a given Still Image host class interface, required for the correct operation of the
 100                          *  interface. This should be called frequently in the main program loop, before the master USB management task
 101                          *  \ref USB_USBTask().
 102                          *
 103                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 104                          */
 105                         void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 106
 107
 108                         /** Host interface configuration routine, to configure a given Still Image host interface instance using the
 109                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
 110                          *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is
 111                          *  found within the device. This should be called once after the stack has enumerated the attached device, while
 112                          *  the host state machine is in the Addressed state.
 113                          *
 114                          *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
 115                          *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor
 116                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 117                          *
 118                          *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
 119                          */
 120                         uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t ConfigDescriptorLength,
 121                                            uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
 122
 123                         void SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, SI_PIMA_Container_t* PIMAHeader);
 124                         uint8_t SImage_Host_RecieveBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, SI_PIMA_Container_t* PIMAHeader);
 125                         uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);
 126                         uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);
 127                         bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
 128                         uint8_t SImage_Host_RecieveEventHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, SI_PIMA_Container_t* PIMAHeader);
 129
 130         /* Private Interface - For use in library only: */
 131         #if !defined(__DOXYGEN__)
 132                 /* Macros: */
 133                         #define STILL_IMAGE_CLASS              0x06
 134                         #define STILL_IMAGE_SUBCLASS           0x01
 135                         #define STILL_IMAGE_PROTOCOL           0x01
 136
 137                         #define SI_FOUND_EVENTS_IN             (1 << 0)
 138                         #define SI_FOUND_DATAPIPE_IN           (1 << 1)
 139                         #define SI_FOUND_DATAPIPE_OUT          (1 << 2)
 140
 141                         #define COMMAND_DATA_TIMEOUT_MS        5000
 142
 143                 /* Function Prototypes: */
 144                         #if defined(INCLUDE_FROM_SI_CLASS_HOST_C)
 145                                 static uint8_t DComp_SI_Host_NextSIInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 146                                 static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 147                         #endif
 148         #endif
 149
 150         /* Disable C linkage for C++ Compilers: */
 151                 #if defined(__cplusplus)
 152                         }
 153                 #endif
 154
 155 #endif
 156
 157 /** @} */