projects / pub / USBasp.git / blob
? search:


8a37144984fbfeaf2d9291e1d63f7b3b11594d51
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / StillImage.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2010.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
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.
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 /** \file
32 * \brief Host mode driver for the library USB Still Image Class driver.
33 *
34 * \note This file should not be included directly. It is automatically included as needed by the class driver
35 * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.
36 */
37
38 /** \ingroup Group_USBClassSI
39 * @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
40 *
41 * \section Sec_Dependencies Module Source Dependencies
42 * The following files must be built with any user project that uses this module:
43 * - LUFA/Drivers/USB/Class/Host/StillImage.c
44 *
45 * \section Module Description
46 * Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
47 *
48 * @{
49 */
50
51 #ifndef __SI_CLASS_HOST_H__
52 #define __SI_CLASS_HOST_H__
53
54 /* Includes: */
55 #include "../../USB.h"
56 #include "../Common/StillImage.h"
57
58 /* Enable C linkage for C++ Compilers: */
59 #if defined(__cplusplus)
60 extern "C" {
61 #endif
62
63 /* Preprocessor Checks: */
64 #if !defined(__INCLUDE_FROM_SI_DRIVER)
65 #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.
66 #endif
67
68 /* Public Interface - May be used in end-application: */
69 /* Macros: */
70 /** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */
71 #define SI_ERROR_LOGICAL_CMD_FAILED 0x80
72
73 /* Type Defines: */
74 typedef struct
75 {
76 const struct
77 {
78 uint8_t DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */
79 bool DataINPipeDoubleBank; /** Indicates if the Still Image interface's IN data pipe should use double banking */
80
81 uint8_t DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */
82 bool DataOUTPipeDoubleBank; /** Indicates if the Still Image interface's OUT data pipe should use double banking */
83
84 uint8_t EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */
85 bool EventsPipeDoubleBank; /** Indicates if the Still Image interface's events data pipe should use double banking */
86 } Config; /**< Config data for the USB class interface within the device. All elements in this section
87 * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
88 */
89 struct
90 {
91 bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
92 * after \ref SImage_Host_ConfigurePipes() is called and the Host state machine is in the
93 * Configured state
94 */
95
96 uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe */
97 uint16_t DataOUTPipeSize; /**< Size in bytes of the Still Image interface's OUT data pipe */
98 uint16_t EventsPipeSize; /**< Size in bytes of the Still Image interface's IN events pipe */
99
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.
105 */
106 } USB_ClassInfo_SI_Host_t;
107
108 /* Enums: */
109 /** Enum for the possible error codes returned by the \ref SImage_Host_ConfigurePipes() function. */
110 enum SIHost_EnumerationFailure_ErrorCodes_t
111 {
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_NoSIInterfaceFound = 2, /**< A compatible Still Image interface was not found in the device's
115 * Configuration Descriptor
116 */
117 SI_ENUMERROR_EndpointsNotFound = 3, /**< Compatible Still Image data endpoints were not found in the
118 * device's Still Image interface
119 */
120 };
121
122 /* Function Prototypes: */
123 /** Host interface configuration routine, to configure a given Still Image host interface instance using the
124 * Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
125 * Image Host instance's state values and configures the pipes required to communicate with the interface if it is
126 * found within the device. This should be called once after the stack has enumerated the attached device, while
127 * the host state machine is in the Addressed state.
128 *
129 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
130 * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor
131 * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor
132 *
133 * \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
134 */
135 uint8_t SImage_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, uint16_t ConfigDescriptorSize,
136 void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
137
138 /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
139 * are issued to the device. Only one session can be open at the one time.
140 *
141 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
142 * call will fail.
143 *
144 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
145 *
146 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
147 * returned a logical command failure
148 */
149 uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
150
151 /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
152 * PIMA commands have been issued to the device.
153 *
154 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
155 * call will fail.
156 *
157 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
158 *
159 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
160 * returned a logical command failure
161 */
162 uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
163
164 /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send
165 * arbitrary PIMA blocks to the device with or without parameters.
166 *
167 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
168 * call will fail.
169 *
170 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
171 * \param[in] PIMAHeader Pointer to a PIMA container structure that is to be sent
172 *
173 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
174 */
175 uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);
176
177 /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with
178 * or without parameters.
179 *
180 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
181 * call will fail.
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 received block is to be stored
185 *
186 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
187 */
188 uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);
189
190 /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
191 *
192 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
193 * call will fail.
194 *
195 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
196 * \param[in] Operation PIMA operation code to issue to the device
197 * \param[in] TotalParams Total number of 32-bit parameters to send to the device in the issued command block
198 * \param[in] Params Pointer to an array of 32-bit values containing the parameters to send in the command block
199 *
200 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
201 * returned a logical command failure
202 */
203 uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, const uint16_t Operation,
204 const uint8_t TotalParams, uint32_t* Params) ATTR_NON_NULL_PTR_ARG(1);
205
206 /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data
207 * associated with the command has been transferred.
208 *
209 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
210 * call will fail.
211 *
212 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
213 *
214 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
215 * returned a logical command failure
216 */
217 uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
218
219 /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
220 *
221 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
222 * call will fail.
223 *
224 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
225 *
226 * \return Boolean true if an event is waiting to be read, false otherwise
227 */
228 bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
229
230 /** Receives an asynchronous event block from the device via the asynchronous events pipe.
231 *
232 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
233 * call will fail.
234 *
235 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
236 * \param[out] PIMAHeader Pointer to a PIMA container structure where the event should be stored
237 *
238 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
239 * returned a logical command failure
240 */
241 uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
242 SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
243 ATTR_NON_NULL_PTR_ARG(2);
244
245 /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data
246 * transfer beyond the regular PIMA command block parameters.
247 *
248 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
249 * call will fail.
250 *
251 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
252 * \param[in] Buffer Pointer to a buffer where the data to send has been stored
253 * \param[in] Bytes Length in bytes of the data in the buffer to send to the attached device
254 *
255 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
256 */
257 uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
258 const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
259
260 /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data
261 * transfer beyond the regular PIMA command block parameters.
262 *
263 * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
264 * call will fail.
265 *
266 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
267 * \param[out] Buffer Pointer to a buffer where the received data is to be stored
268 * \param[in] Bytes Length in bytes of the data to read
269 *
270 * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
271 */
272 uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
273 const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
274
275 /* Inline Functions: */
276 /** General management task for a given Still Image host class interface, required for the correct operation of the
277 * interface. This should be called frequently in the main program loop, before the master USB management task
278 * \ref USB_USBTask().
279 *
280 * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state
281 */
282 static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo);
283 static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
284 {
285 (void)SIInterfaceInfo;
286 }
287
288 /* Private Interface - For use in library only: */
289 #if !defined(__DOXYGEN__)
290 /* Macros: */
291 #define STILL_IMAGE_CLASS 0x06
292 #define STILL_IMAGE_SUBCLASS 0x01
293 #define STILL_IMAGE_PROTOCOL 0x01
294
295 #define SI_FOUND_EVENTS_IN (1 << 0)
296 #define SI_FOUND_DATAPIPE_IN (1 << 1)
297 #define SI_FOUND_DATAPIPE_OUT (1 << 2)
298
299 #define COMMAND_DATA_TIMEOUT_MS 10000
300
301 /* Function Prototypes: */
302 #if defined(__INCLUDE_FROM_SI_CLASS_HOST_C)
303 static uint8_t DComp_SI_Host_NextSIInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
304 static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
305 #endif
306 #endif
307
308 /* Disable C linkage for C++ Compilers: */
309 #if defined(__cplusplus)
310 }
311 #endif
312
313 #endif
314
315 /** @} */
USB isp AVR programmer