3 Copyright (C) Dean Camera, 2014.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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.
21 The author disclaims 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
32 * \brief Host mode driver for the library USB Still Image Class driver.
34 * Host mode driver for the library USB Still Image Class driver.
36 * \note This file should not be included directly. It is automatically included as needed by the USB module driver
37 * dispatch header located in LUFA/Drivers/USB.h.
40 /** \ingroup Group_USBClassSI
41 * \defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
43 * \section Sec_USBClassStillImageHost_Dependencies Module Source Dependencies
44 * The following files must be built with any user project that uses this module:
45 * - LUFA/Drivers/USB/Class/Host/StillImageClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
47 * \section Sec_USBClassStillImageHost_ModDescription Module Description
48 * Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
53 #ifndef __SI_CLASS_HOST_H__
54 #define __SI_CLASS_HOST_H__
57 #include "../../USB.h"
58 #include "../Common/StillImageClassCommon.h"
60 /* Enable C linkage for C++ Compilers: */
61 #if defined(__cplusplus)
65 /* Preprocessor Checks: */
66 #if !defined(__INCLUDE_FROM_SI_DRIVER)
67 #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
70 /* Public Interface - May be used in end-application: */
72 /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error. */
73 #define SI_ERROR_LOGICAL_CMD_FAILED 0x80
76 /** \brief Still Image Class Host Mode Configuration and State Structure.
78 * Class state structure. An instance of this structure should be made within the user application,
79 * and passed to each of the Still Image class driver functions as the \c SIInterfaceInfo parameter. This
80 * stores each Still Image interface's configuration and state information.
86 USB_Pipe_Table_t DataINPipe; /**< Data IN Pipe configuration table. */
87 USB_Pipe_Table_t DataOUTPipe; /**< Data OUT Pipe configuration table. */
88 USB_Pipe_Table_t EventsPipe; /**< Event notification IN Pipe configuration table. */
89 } Config; /**< Config data for the USB class interface within the device. All elements in this section
90 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
94 bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
95 * after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the
98 uint8_t InterfaceNumber; /**< Interface index of the Still Image interface within the attached device. */
100 bool IsSessionOpen; /**< Indicates if a PIMA session is currently open with the attached device. */
101 uint32_t TransactionID; /**< Transaction ID for the next transaction to send to the device. */
102 } State; /**< State data for the USB class interface within the device. All elements in this section
103 * <b>may</b> be set to initial values, but may also be ignored to default to sane values when
104 * the interface is enumerated.
106 } USB_ClassInfo_SI_Host_t;
109 /** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */
110 enum SI_Host_EnumerationFailure_ErrorCodes_t
112 SI_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully. */
113 SI_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor. */
114 SI_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Still Image interface was not found in the device's
115 * Configuration Descriptor.
117 SI_ENUMERROR_PipeConfigurationFailed = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
120 /* Function Prototypes: */
121 /** Host interface configuration routine, to configure a given Still Image host interface instance using the
122 * Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
123 * Image Host instance's state values and configures the pipes required to communicate with the interface if it is
124 * found within the device. This should be called once after the stack has enumerated the attached device, while
125 * the host state machine is in the Addressed state.
127 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
128 * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor.
129 * \param[in] ConfigDescriptorData Pointer to a buffer containing the attached device's Configuration Descriptor.
131 * \return A value from the \ref SI_Host_EnumerationFailure_ErrorCodes_t enum.
133 uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
134 uint16_t ConfigDescriptorSize,
135 void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
137 /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
138 * are issued to the device. Only one session can be open at the one time.
140 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
143 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
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.
148 uint8_t SI_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
150 /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
151 * PIMA commands have been issued to the device.
153 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
156 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
158 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
159 * returned a logical command failure.
161 uint8_t SI_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
163 /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send
164 * arbitrary PIMA blocks to the device with or without parameters.
166 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
169 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
170 * \param[in] PIMAHeader Pointer to a PIMA container structure that is to be sent.
172 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
174 uint8_t SI_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
175 PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
176 ATTR_NON_NULL_PTR_ARG(2);
178 /** Receives a raw PIMA block header from the device. This can be used to receive arbitrary PIMA blocks from the device with
179 * or without parameters.
181 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
184 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
185 * \param[out] PIMAHeader Pointer to a PIMA container structure where the received block is to be stored.
187 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
189 uint8_t SI_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
190 PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
191 ATTR_NON_NULL_PTR_ARG(2);
193 /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
195 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
198 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
199 * \param[in] Operation PIMA operation code to issue to the device.
200 * \param[in] TotalParams Total number of 32-bit parameters to send to the device in the issued command block.
201 * \param[in] Params Pointer to an array of 32-bit values containing the parameters to send in the command block.
203 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
204 * returned a logical command failure.
206 uint8_t SI_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
207 const uint16_t Operation,
208 const uint8_t TotalParams,
209 uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1);
211 /** Receives and checks a response block from the attached Still Image device, once a command has been issued and all data
212 * associated with the command has been transferred.
214 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
217 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
219 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
220 * returned a logical command failure.
222 uint8_t SI_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
224 /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
226 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
229 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
231 * \return Boolean \c true if an event is waiting to be read, \c false otherwise.
233 bool SI_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
235 /** Receives an asynchronous event block from the device via the asynchronous events pipe.
237 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
240 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
241 * \param[out] PIMAHeader Pointer to a PIMA container structure where the event should be stored.
243 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
244 * returned a logical command failure.
246 uint8_t SI_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
247 PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
248 ATTR_NON_NULL_PTR_ARG(2);
250 /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data
251 * transfer beyond the regular PIMA command block parameters.
253 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
256 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
257 * \param[in] Buffer Pointer to a buffer where the data to send has been stored.
258 * \param[in] Bytes Length in bytes of the data in the buffer to send to the attached device.
260 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
262 uint8_t SI_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
264 const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
266 /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data
267 * transfer beyond the regular PIMA command block parameters.
269 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
272 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
273 * \param[out] Buffer Pointer to a buffer where the received data is to be stored.
274 * \param[in] Bytes Length in bytes of the data to read.
276 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
278 uint8_t SI_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
280 const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
282 /* Inline Functions: */
283 /** General management task for a given Still Image host class interface, required for the correct operation of the
284 * interface. This should be called frequently in the main program loop, before the master USB management task
285 * \ref USB_USBTask().
287 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state.
289 static inline void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
290 static inline void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
292 (void)SIInterfaceInfo;
295 /* Private Interface - For use in library only: */
296 #if !defined(__DOXYGEN__)
298 #define SI_COMMAND_DATA_TIMEOUT_MS 10000
300 /* Function Prototypes: */
301 #if defined(__INCLUDE_FROM_STILLIMAGE_HOST_C)
302 static uint8_t DCOMP_SI_Host_NextSIInterface(void* const CurrentDescriptor)
303 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
304 static uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor)
305 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
309 /* Disable C linkage for C++ Compilers: */
310 #if defined(__cplusplus)