StillImage.h 17.3 KB
 Dean Camera committed May 08, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */ /** \file * \brief Host mode driver for the library USB Still Image Class driver. * * Host mode driver for the library USB Still Image Class driver. * * \note This file should not be included directly. It is automatically included as needed by the class driver * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h. */ /** \ingroup Group_USBClassSI * @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module:  Dean Camera committed Jul 19, 2010 45  * - LUFA/Drivers/USB/Class/Host/StillImage.c (Makefile source module name: LUFA_SRC_USBCLASS)  Dean Camera committed May 08, 2010 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71  * * \section Module Description * Host Mode USB Class driver framework interface, for the Still Image USB Class driver. * * @{ */ #ifndef __SI_CLASS_HOST_H__ #define __SI_CLASS_HOST_H__ /* Includes: */ #include "../../USB.h" #include "../Common/StillImage.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_SI_DRIVER) #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead. #endif /* Public Interface - May be used in end-application: */ /* Macros: */  Dean Camera committed Jun 03, 2010 72  /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error. */  Dean Camera committed May 08, 2010 73 74 75 76 77 78 79 80 81 82 83 84 85  #define SI_ERROR_LOGICAL_CMD_FAILED 0x80 /* Type Defines: */ /** \brief Still Image Class Host Mode Configuration and State Structure. * * Class state structure. An instance of this structure should be made within the user application, * and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This * stores each Still Image interface's configuration and state information. */ typedef struct { const struct {  Dean Camera committed Jun 17, 2010 86 87  uint8_t DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe. */ bool DataINPipeDoubleBank; /**< Indicates if the Still Image interface's IN data pipe should use double banking. */  Dean Camera committed May 08, 2010 88   Dean Camera committed Jun 17, 2010 89 90  uint8_t DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe. */ bool DataOUTPipeDoubleBank; /**< Indicates if the Still Image interface's OUT data pipe should use double banking. */  Dean Camera committed May 08, 2010 91   Dean Camera committed Jun 17, 2010 92 93  uint8_t EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used. */ bool EventsPipeDoubleBank; /**< Indicates if the Still Image interface's events data pipe should use double banking. */  Dean Camera committed May 08, 2010 94 95 96 97 98  } Config; /**< Config data for the USB class interface within the device. All elements in this section * must be set or the interface will fail to enumerate and operate correctly. */ struct {  Dean Camera committed Sep 30, 2010 99 100 101 102 103  bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid * after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the * Configured state. */ uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device. */  Dean Camera committed May 08, 2010 104   Dean Camera committed Jun 17, 2010 105 106 107  uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe. */ uint16_t DataOUTPipeSize; /**< Size in bytes of the Still Image interface's OUT data pipe. */ uint16_t EventsPipeSize; /**< Size in bytes of the Still Image interface's IN events pipe. */  Dean Camera committed May 08, 2010 108   Dean Camera committed Jun 17, 2010 109 110  bool IsSessionOpen; /**< Indicates if a PIMA session is currently open with the attached device. */ uint32_t TransactionID; /**< Transaction ID for the next transaction to send to the device. */  Dean Camera committed May 08, 2010 111 112 113 114 115 116 117  } State; /**< State data for the USB class interface within the device. All elements in this section * may be set to initial values, but may also be ignored to default to sane values when * the interface is enumerated. */ } USB_ClassInfo_SI_Host_t; /* Enums: */  118  /** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */  Dean Camera committed Sep 28, 2010 119  enum SI_Host_EnumerationFailure_ErrorCodes_t  Dean Camera committed May 08, 2010 120  {  Dean Camera committed Jun 17, 2010 121 122  SI_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully. */ SI_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor. */  Dean Camera committed Sep 30, 2010 123  SI_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Still Image interface was not found in the device's  Dean Camera committed Jun 17, 2010 124  * Configuration Descriptor.  125  */  Dean Camera committed May 08, 2010 126 127 128 129 130 131 132 133 134  }; /* Function Prototypes: */ /** Host interface configuration routine, to configure a given Still Image host interface instance using the * Configuration Descriptor read from an attached USB device. This function automatically updates the given Still * Image Host instance's state values and configures the pipes required to communicate with the interface if it is * found within the device. This should be called once after the stack has enumerated the attached device, while * the host state machine is in the Addressed state. *  Dean Camera committed Sep 30, 2010 135 136 137 138 139 140 141  * \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other * interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes * within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor. * \param[in] ConfigDescriptorData Pointer to a buffer containing the attached device's Configuration Descriptor.  Dean Camera committed May 08, 2010 142  *  Dean Camera committed Sep 28, 2010 143  * \return A value from the \ref SI_Host_EnumerationFailure_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 144  */  145 146  uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, uint16_t ConfigDescriptorSize,  Dean Camera committed Sep 30, 2010 147  void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);  Dean Camera committed May 08, 2010 148 149 150 151  /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands * are issued to the device. Only one session can be open at the one time. *  Dean Camera committed Jun 15, 2010 152 153  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 154  *  Dean Camera committed Jun 17, 2010 155  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.  Dean Camera committed May 08, 2010 156 157  * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device  Dean Camera committed Jun 17, 2010 158  * returned a logical command failure.  Dean Camera committed May 08, 2010 159  */  160  uint8_t SI_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 161 162 163 164  /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated * PIMA commands have been issued to the device. *  Dean Camera committed Jun 15, 2010 165 166  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 167  *  Dean Camera committed Jun 17, 2010 168  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.  Dean Camera committed May 08, 2010 169 170  * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device  Dean Camera committed Jun 17, 2010 171  * returned a logical command failure.  Dean Camera committed May 08, 2010 172  */  173  uint8_t SI_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 174 175 176 177  /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send * arbitrary PIMA blocks to the device with or without parameters. *  Dean Camera committed Jun 15, 2010 178 179  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 180  *  Dean Camera committed Jun 17, 2010 181 182  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * \param[in] PIMAHeader Pointer to a PIMA container structure that is to be sent.  Dean Camera committed May 08, 2010 183  *  Dean Camera committed Jun 17, 2010 184  * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 185  */  186 187 188  uint8_t SI_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  Dean Camera committed May 08, 2010 189 190 191 192  /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with * or without parameters. *  Dean Camera committed Jun 15, 2010 193 194  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 195  *  Dean Camera committed Jun 17, 2010 196 197  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * \param[out] PIMAHeader Pointer to a PIMA container structure where the received block is to be stored.  Dean Camera committed May 08, 2010 198  *  Dean Camera committed Jun 17, 2010 199  * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 200  */  201 202 203  uint8_t SI_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  Dean Camera committed May 08, 2010 204 205 206  /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically. *  Dean Camera committed Jun 15, 2010 207 208  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 209  *  Dean Camera committed Jun 17, 2010 210 211 212 213  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * \param[in] Operation PIMA operation code to issue to the device. * \param[in] TotalParams Total number of 32-bit parameters to send to the device in the issued command block. * \param[in] Params Pointer to an array of 32-bit values containing the parameters to send in the command block.  Dean Camera committed May 08, 2010 214 215  * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device  Dean Camera committed Jun 17, 2010 216  * returned a logical command failure.  Dean Camera committed May 08, 2010 217  */  218 219 220 221  uint8_t SI_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, const uint16_t Operation, const uint8_t TotalParams, uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 222 223 224  /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data * associated with the command has been transferred.  Dean Camera committed Jul 21, 2010 225  *  Dean Camera committed Jun 15, 2010 226 227  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 228  *  Dean Camera committed Jun 17, 2010 229  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.  Dean Camera committed May 08, 2010 230 231  * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device  Dean Camera committed Jun 17, 2010 232  * returned a logical command failure.  Dean Camera committed May 08, 2010 233  */  234  uint8_t SI_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 235 236 237  /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe. *  Dean Camera committed Jun 15, 2010 238 239  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 240  *  Dean Camera committed Jun 17, 2010 241  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.  Dean Camera committed May 08, 2010 242  *  Dean Camera committed Jun 17, 2010 243  * \return Boolean true if an event is waiting to be read, false otherwise.  Dean Camera committed May 08, 2010 244  */  245  bool SI_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 246 247 248  /** Receives an asynchronous event block from the device via the asynchronous events pipe. *  Dean Camera committed Jun 15, 2010 249 250  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 251  *  Dean Camera committed Jun 17, 2010 252 253  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * \param[out] PIMAHeader Pointer to a PIMA container structure where the event should be stored.  Dean Camera committed May 08, 2010 254 255  * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device  Dean Camera committed Jun 17, 2010 256  * returned a logical command failure.  Dean Camera committed May 08, 2010 257  */  258 259 260  uint8_t SI_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  Dean Camera committed May 08, 2010 261 262 263 264  /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data * transfer beyond the regular PIMA command block parameters. *  Dean Camera committed Jun 15, 2010 265 266  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 267  *  Dean Camera committed Jun 17, 2010 268 269 270  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * \param[in] Buffer Pointer to a buffer where the data to send has been stored. * \param[in] Bytes Length in bytes of the data in the buffer to send to the attached device.  Dean Camera committed May 08, 2010 271  *  Dean Camera committed Jun 17, 2010 272  * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 273  */  274 275 276  uint8_t SI_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer, const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  Dean Camera committed May 08, 2010 277 278 279 280  /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data * transfer beyond the regular PIMA command block parameters. *  Dean Camera committed Jun 15, 2010 281 282  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 283  *  Dean Camera committed Jun 17, 2010 284 285 286  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state. * \param[out] Buffer Pointer to a buffer where the received data is to be stored. * \param[in] Bytes Length in bytes of the data to read.  Dean Camera committed May 08, 2010 287  *  Dean Camera committed Jun 17, 2010 288  * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 289  */  290 291 292  uint8_t SI_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer, const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  Dean Camera committed May 08, 2010 293 294 295 296 297 298  /* Inline Functions: */ /** General management task for a given Still Image host class interface, required for the correct operation of the * interface. This should be called frequently in the main program loop, before the master USB management task * \ref USB_USBTask(). *  Dean Camera committed Jun 17, 2010 299  * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.  Dean Camera committed May 08, 2010 300  */  301 302  static inline void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); static inline void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)  Dean Camera committed May 08, 2010 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317  { (void)SIInterfaceInfo; } /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define STILL_IMAGE_CLASS 0x06 #define STILL_IMAGE_SUBCLASS 0x01 #define STILL_IMAGE_PROTOCOL 0x01 #define COMMAND_DATA_TIMEOUT_MS 10000 /* Function Prototypes: */ #if defined(__INCLUDE_FROM_SI_CLASS_HOST_C)  Dean Camera committed May 09, 2010 318 319  static uint8_t DCOMP_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 320 321 322 323 324 325 326 327 328 329 330  #endif #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */