Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Class / Host / StillImage.h @ 978b99e5

History | View | Annotate | Download (17.4 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  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
 *  Host mode driver for the library USB Still Image Class driver.
35
 *
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.
38
 */
39

    
40
/** \ingroup Group_USBClassSI
41
 *  \defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
42
 *
43
 *  \section Sec_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/StillImage.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
46
 *
47
 *  \section Sec_ModDescription Module Description
48
 *  Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
49
 *
50
 *  @{
51
 */
52

    
53
#ifndef __SI_CLASS_HOST_H__
54
#define __SI_CLASS_HOST_H__
55

    
56
        /* Includes: */
57
                #include "../../USB.h"
58
                #include "../Common/StillImage.h"
59

    
60
        /* Enable C linkage for C++ Compilers: */
61
                #if defined(__cplusplus)
62
                        extern "C" {
63
                #endif
64

    
65
        /* Preprocessor Checks: */
66
                #if !defined(__INCLUDE_FROM_SI_DRIVER)
67
                        #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
68
                #endif
69

    
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
                        /** \brief Still Image Class Host Mode Configuration and State Structure.
77
                         *
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.
81
                         */
82
                        typedef struct
83
                        {
84
                                const struct
85
                                {
86
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe. */
87
                                        bool     DataINPipeDoubleBank; /**< Indicates if the Still Image interface's IN data pipe should use double banking. */
88

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

    
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
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section
95
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
96
                                           */
97
                                struct
98
                                {
99
                                        bool     IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
100
                                                            *   after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the
101
                                                            *   Configured state.
102
                                                            */
103
                                        uint8_t  InterfaceNumber; /**< Interface index of the Still Image interface within the attached device. */
104

    
105
                                        uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe. */
106
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the Still Image interface's OUT data pipe. */
107
                                        uint16_t EventsPipeSize;  /**< Size in bytes of the Still Image interface's IN events pipe. */
108

    
109
                                        bool IsSessionOpen; /**< Indicates if a PIMA session is currently open with the attached device. */
110
                                        uint32_t TransactionID; /**< Transaction ID for the next transaction to send to the device. */
111
                                } State; /**< State data for the USB class interface within the device. All elements in this section
112
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
113
                                                  *   the interface is enumerated.
114
                                                  */
115
                        } USB_ClassInfo_SI_Host_t;
116

    
117
                /* Enums: */
118
                        /** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */
119
                        enum SI_Host_EnumerationFailure_ErrorCodes_t
120
                        {
121
                                SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
122
                                SI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
123
                                SI_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Still Image interface was not found in the device's
124
                                                                              *   Configuration Descriptor.
125
                                                                              */
126
                                SI_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
127
                        };
128

    
129
                /* Function Prototypes: */
130
                        /** Host interface configuration routine, to configure a given Still Image host interface instance using the
131
                         *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
132
                         *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is
133
                         *  found within the device. This should be called once after the stack has enumerated the attached device, while
134
                         *  the host state machine is in the Addressed state.
135
                         *
136
                         *  \param[in,out] SIInterfaceInfo       Pointer to a structure containing a Still Image Class host configuration and state.
137
                         *  \param[in]     ConfigDescriptorSize  Length of the attached device's Configuration Descriptor.
138
                         *  \param[in]     ConfigDescriptorData  Pointer to a buffer containing the attached device's Configuration Descriptor.
139
                         *
140
                         *  \return A value from the \ref SI_Host_EnumerationFailure_ErrorCodes_t enum.
141
                         */
142
                        uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
143
                                                       uint16_t ConfigDescriptorSize,
144
                                                       void* ConfigDescriptorData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
145

    
146
                        /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands
147
                         *  are issued to the device. Only one session can be open at the one time.
148
                         *
149
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
150
                         *       call will fail.
151
                         *
152
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
153
                         *
154
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
155
                         *          returned a logical command failure.
156
                         */
157
                        uint8_t SI_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
158

    
159
                        /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated
160
                         *  PIMA commands have been issued to the device.
161
                         *
162
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
163
                         *       call will fail.
164
                         *
165
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
166
                         *
167
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
168
                         *          returned a logical command failure.
169
                         */
170
                        uint8_t SI_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
171

    
172
                        /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send
173
                         *  arbitrary PIMA blocks to the device with or without parameters.
174
                         *
175
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
176
                         *       call will fail.
177
                         *
178
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
179
                         *  \param[in]     PIMAHeader       Pointer to a PIMA container structure that is to be sent.
180
                         *
181
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
182
                         */
183
                        uint8_t SI_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
184
                                                        PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
185
                                                        ATTR_NON_NULL_PTR_ARG(2);
186

    
187
                        /** Receives a raw PIMA block header from the device. This can be used to receive arbitrary PIMA blocks from the device with
188
                         *  or without parameters.
189
                         *
190
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
191
                         *       call will fail.
192
                         *
193
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
194
                         *  \param[out]    PIMAHeader       Pointer to a PIMA container structure where the received block is to be stored.
195
                         *
196
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
197
                         */
198
                        uint8_t SI_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
199
                                                           PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
200
                                                           ATTR_NON_NULL_PTR_ARG(2);
201

    
202
                        /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
203
                         *
204
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
205
                         *       call will fail.
206
                         *
207
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
208
                         *  \param[in]     Operation        PIMA operation code to issue to the device.
209
                         *  \param[in]     TotalParams      Total number of 32-bit parameters to send to the device in the issued command block.
210
                         *  \param[in]     Params           Pointer to an array of 32-bit values containing the parameters to send in the command block.
211
                         *
212
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
213
                         *          returned a logical command failure.
214
                         */
215
                        uint8_t SI_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
216
                                                    const uint16_t Operation,
217
                                                    const uint8_t TotalParams,
218
                                                    uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1);
219

    
220
                        /** Receives and checks a response block from the attached Still Image device, once a command has been issued and all data
221
                         *  associated with the command has been transferred.
222
                         *
223
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
224
                         *       call will fail.
225
                         *
226
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
227
                         *
228
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
229
                         *          returned a logical command failure.
230
                         */
231
                        uint8_t SI_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
232

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

    
244
                        /** Receives an asynchronous event block from the device via the asynchronous events pipe.
245
                         *
246
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
247
                         *       call will fail.
248
                         *
249
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
250
                         *  \param[out]    PIMAHeader       Pointer to a PIMA container structure where the event should be stored.
251
                         *
252
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
253
                         *          returned a logical command failure.
254
                         */
255
                        uint8_t SI_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
256
                                                           PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
257
                                                           ATTR_NON_NULL_PTR_ARG(2);
258

    
259
                        /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data
260
                         *  transfer beyond the regular PIMA command block parameters.
261
                         *
262
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
263
                         *       call will fail.
264
                         *
265
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
266
                         *  \param[in]     Buffer           Pointer to a buffer where the data to send has been stored.
267
                         *  \param[in]     Bytes            Length in bytes of the data in the buffer to send to the attached device.
268
                         *
269
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
270
                         */
271
                        uint8_t SI_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
272
                                                 void* Buffer,
273
                                                 const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
274

    
275
                        /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data
276
                         *  transfer beyond the regular PIMA command block parameters.
277
                         *
278
                         *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
279
                         *       call will fail.
280
                         *
281
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
282
                         *  \param[out]    Buffer           Pointer to a buffer where the received data is to be stored.
283
                         *  \param[in]     Bytes            Length in bytes of the data to read.
284
                         *
285
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
286
                         */
287
                        uint8_t SI_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
288
                                                 void* Buffer,
289
                                                 const uint16_t Bytes) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
290

    
291
                /* Inline Functions: */
292
                        /** General management task for a given Still Image host class interface, required for the correct operation of the
293
                         *  interface. This should be called frequently in the main program loop, before the master USB management task
294
                         *  \ref USB_USBTask().
295
                         *
296
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
297
                         */
298
                        static inline void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
299
                        static inline void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
300
                        {
301
                                (void)SIInterfaceInfo;
302
                        }
303

    
304
        /* Private Interface - For use in library only: */
305
        #if !defined(__DOXYGEN__)
306
                /* Macros: */
307
                        #define SI_COMMAND_DATA_TIMEOUT_MS        10000
308

    
309
                /* Function Prototypes: */
310
                        #if defined(__INCLUDE_FROM_STILLIMAGE_HOST_C)
311
                                static uint8_t DCOMP_SI_Host_NextSIInterface(void* const CurrentDescriptor)
312
                                                                             ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
313
                                static uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor)
314
                                                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
315
                        #endif
316
        #endif
317

    
318
        /* Disable C linkage for C++ Compilers: */
319
                #if defined(__cplusplus)
320
                        }
321
                #endif
322

    
323
#endif
324

    
325
/** @} */
326