StillImage.h 17 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  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 
19
20
21
22
23
24
25
26
27
28
29
30
  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.
*/

31
32
33
/** \file
 *  \brief Host mode driver for the library USB Still Image Class driver.
 *
34
35
 *  Host mode driver for the library USB Still Image Class driver.
 *
36
37
38
39
 *  \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.
 */

40
/** \ingroup Group_USBClassSI
41
42
 *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
 *
43
44
45
46
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - LUFA/Drivers/USB/Class/Host/StillImage.c
 *
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 *  \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

65
66
67
68
69
	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_SI_DRIVER)
			#error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.
		#endif
		
70
	/* Public Interface - May be used in end-application: */
71
		/* Macros: */
72
			/** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */
73
			#define SI_ERROR_LOGICAL_CMD_FAILED              0x80
74

75
		/* Type Defines: */
76
77
78
79
80
81
			/** \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.
			 */
82
83
84
85
86
			typedef struct
			{
				const struct
				{
					uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */
87
88
					bool     DataINPipeDoubleBank; /** Indicates if the Still Image interface's IN data pipe should use double banking */

89
					uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */
90
91
					bool     DataOUTPipeDoubleBank; /** Indicates if the Still Image interface's OUT data pipe should use double banking */

92
					uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */			
93
					bool     EventsPipeDoubleBank; /** Indicates if the Still Image interface's events data pipe should use double banking */
94
95
96
97
98
				} Config; /**< Config data for the USB class interface within the device. All elements in this section
				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
				           */
				struct
				{
99
					bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
Dean Camera's avatar
Dean Camera committed
100
					                *   after \ref SImage_Host_ConfigurePipes() is called and the Host state machine is in the
101
102
					                *   Configured state
					                */
103
104
105
106

					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 */
107
108
109
					
					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 */
110
111
112
113
114
115
116
				} State; /**< State data for the USB class interface within the device. All elements in this section
						  *   <b>may</b> 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: */
Dean Camera's avatar
Dean Camera committed
117
			/** Enum for the possible error codes returned by the \ref SImage_Host_ConfigurePipes() function. */
118
119
120
121
122
123
124
125
126
127
128
129
			enum SIHost_EnumerationFailure_ErrorCodes_t
			{
				SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
				SI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
				SI_ENUMERROR_NoSIInterfaceFound         = 2, /**< A compatible Still Image interface was not found in the device's
				                                             *   Configuration Descriptor
				                                             */
				SI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Still Image data endpoints were not found in the
				                                              *   device's Still Image interface
				                                              */
			};

130
		/* Function Prototypes: */
131
132
133
134
135
136
137
			/** 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.
			 *
			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
138
			 *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
139
140
141
142
			 *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
			 *
			 *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
			 */
143
144
			uint8_t SImage_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, uint16_t ConfigDescriptorSize,
                                               void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
145

146
147
			/** 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.
148
149
150
151
			 *	
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
152
153
154
155
156
			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
			 *          returned a logical command failure
			 */
157
			uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
158
159
160

			/** 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.
161
162
163
164
			 *
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
165
166
167
168
169
			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
			 *          returned a logical command failure
			 */
170
			uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
171

172
173
174
			/** 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.
			 *
175
176
177
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
178
179
180
181
182
183
184
185
186
187
			 *  \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
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
			 */
			uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);
			
			/** 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.
			 *
188
189
190
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
191
192
193
194
195
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
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
			 */
			uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, SI_PIMA_Container_t* const PIMAHeader);

198
			/** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
199
200
201
202
			 *	
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
203
204
205
206
207
208
209
210
			 *  \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
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
			 *          returned a logical command failure
			 */
211
212
			uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, const uint16_t Operation,
			                                const uint8_t TotalParams, uint32_t* Params) ATTR_NON_NULL_PTR_ARG(1);
213
214
215

			/** 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.
216
217
218
219
			 *	
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
220
221
222
223
224
			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
			 *          returned a logical command failure
			 */
225
			uint8_t SImage_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
226
227

			/** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
228
229
230
			 *
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
231
232
233
234
235
			 *
			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
			 *
			 *  \return Boolean true if an event is waiting to be read, false otherwise
			 */
236
			bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
237
238

			/** Receives an asynchronous event block from the device via the asynchronous events pipe.
239
240
241
			 *
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
242
243
			 *
			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
244
			 *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the event should be stored
245
246
247
248
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
			 *          returned a logical command failure
			 */
249
			uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
250
251
				                                   SI_PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
			                                       ATTR_NON_NULL_PTR_ARG(2);
252
253
254
255
			
			/** 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.
			 *
256
257
258
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
259
260
261
262
263
264
			 *  \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
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
			 */
265
			uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
266
			                             const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
267
268
269
270

			/** 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.
			 *
271
272
273
			 *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
			 *        call will fail.
			 *
274
275
276
277
278
279
			 *  \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
			 *
			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
			 */
280
			uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo, void* Buffer,
281
			                             const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
282
283
284
285
286
287
288
289
290
291
292
293
294
295
		
		/* 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().
			 *
			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
			 */
			static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo);
			static inline void SImage_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
			{
				(void)SIInterfaceInfo;
			}		

296
297
298
299
300
301
302
303
304
305
306
	/* 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 SI_FOUND_EVENTS_IN             (1 << 0)
			#define SI_FOUND_DATAPIPE_IN           (1 << 1)
			#define SI_FOUND_DATAPIPE_OUT          (1 << 2)

307
			#define COMMAND_DATA_TIMEOUT_MS        10000
308
		
309
		/* Function Prototypes: */
310
			#if defined(__INCLUDE_FROM_SI_CLASS_HOST_C)
311
312
				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);
313
314
315
			#endif
	#endif
	
316
317
318
319
320
321
322
323
	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif

#endif

/** @} */