Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / USB / Core / HostStandardReq.h @ 978b99e5

History | View | Annotate | Download (10 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 USB host standard request management.
33
 *
34
 *  This file contains the function prototypes necessary for the issuing of outgoing standard control requests
35
 *  when the library is in USB host mode.
36
 *
37
 *  \note This file should not be included directly. It is automatically included as needed by the USB driver
38
 *        dispatch header located in LUFA/Drivers/USB/USB.h.
39
 */
40

    
41
#ifndef __HOSTSTDREQ_H__
42
#define __HOSTSTDREQ_H__
43

    
44
        /* Includes: */
45
                #include "../../../Common/Common.h"
46
                #include "USBMode.h"
47
                #include "StdRequestType.h"
48
                #include "USBController.h"
49

    
50
        /* Enable C linkage for C++ Compilers: */
51
                #if defined(__cplusplus)
52
                        extern "C" {
53
                #endif
54

    
55
        /* Preprocessor Checks: */
56
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
57
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
58
                #endif
59

    
60
        /* Public Interface - May be used in end-application: */
61
                /* Macros: */
62
                        #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)
63
                                /** Constant for the maximum software timeout period of sent USB control transactions to an attached
64
                                 *  device. If a device fails to respond to a sent control request within this period, the
65
                                 *  library will return a timeout error code.
66
                                 *
67
                                 *  This value may be overridden in the user project makefile as the value of the
68
                                 *  \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
69
                                 */
70
                                #define USB_HOST_TIMEOUT_MS                1000
71
                        #endif
72
                        
73
                /* Enums: */
74
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error
75
                         *  if the transfer of the request is unsuccessful.
76
                         *
77
                         *  \ingroup Group_PipeControlReq
78
                         */
79
                        enum USB_Host_SendControlErrorCodes_t
80
                        {
81
                                HOST_SENDCONTROL_Successful         = 0, /**< No error occurred in the request transfer. */
82
                                HOST_SENDCONTROL_DeviceDisconnected = 1, /**< The attached device was disconnected during the
83
                                                                        *   request transfer.
84
                                                                        */
85
                                HOST_SENDCONTROL_PipeError          = 2, /**< An error occurred in the pipe while sending the request. */
86
                                HOST_SENDCONTROL_SetupStalled       = 3, /**< The attached device stalled the request, usually
87
                                                                        *   indicating that the request is unsupported on the device.
88
                                                                        */
89
                                HOST_SENDCONTROL_SoftwareTimeOut    = 4, /**< The request or data transfer timed out. */
90
                        };
91

    
92
                /* Global Variables: */
93
                        /** Indicates the currently set configuration number of the attached device. This indicates the currently
94
                         *  selected configuration value if one has been set sucessfully, or 0 if no configuration has been selected.
95
                         *
96
                         *  To set a device configuration, call the \ref USB_Host_SetDeviceConfiguration() function.
97
                         *
98
                         *  \note This variable should be treated as read-only in the user application, and never manually
99
                         *        changed in value.
100
                         *
101
                         *  \ingroup Group_Host
102
                         */
103
                        extern uint8_t USB_Host_ConfigurationNumber;
104
                        
105
                /* Function Prototypes: */
106
                        /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,
107
                         *  and transfers the data stored in the buffer to the device, or from the device to the buffer
108
                         *  as requested. The transfer is made on the currently selected pipe.
109
                         *
110
                         *  \ingroup Group_PipeControlReq
111
                         *
112
                         *  \param[in] BufferPtr  Pointer to the start of the data buffer if the request has a data stage, or
113
                         *                        \c NULL if the request transfers no data to or from the device.
114
                         *
115
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
116
                         */
117
                        uint8_t USB_Host_SendControlRequest(void* const BufferPtr);
118

    
119
                        /** Sends a SET CONFIGURATION standard request to the attached device, with the given configuration index.
120
                         *
121
                         *  This routine will automatically update the \ref USB_HostState and \ref USB_Host_ConfigurationNumber
122
                         *  state variables according to the given function parameters and the result of the request.
123
                         *
124
                         *  \note After this routine returns, the control pipe will be selected.
125
                         *
126
                         *  \ingroup Group_PipeControlReq
127
                         *
128
                         *  \param[in] ConfigNumber  Configuration index to send to the device.
129
                         *
130
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
131
                         */
132
                        uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);
133

    
134
                        /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the device descriptor.
135
                         *  This can be used to easily retrieve information about the device such as its VID, PID and power
136
                         *  requirements.
137
                         *
138
                         *  \note After this routine returns, the control pipe will be selected.
139
                         *
140
                         *  \ingroup Group_PipeControlReq
141
                         *
142
                         *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where
143
                         *                                   the read data is to be stored.
144
                         *
145
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
146
                         */
147
                        uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr) ATTR_NON_NULL_PTR_ARG(1);
148

    
149
                        /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the string descriptor
150
                         *  of the specified index. This can be used to easily retrieve string descriptors from the device by
151
                         *  index, after the index is obtained from the Device or Configuration descriptors.
152
                         *
153
                         *  \note After this routine returns, the control pipe will be selected.
154
                         *
155
                         *  \ingroup Group_PipeControlReq
156
                         *
157
                         *  \param[in]  Index        Index of the string index to retrieve.
158
                         *  \param[out] Buffer       Pointer to the destination buffer where the retrieved string descriptor is
159
                         *                           to be stored.
160
                         *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer.
161
                         *
162
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
163
                         */
164
                        uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
165
                                                                   void* const Buffer,
166
                                                                   const uint8_t BufferLength) ATTR_NON_NULL_PTR_ARG(2);
167

    
168
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
169
                         *  retrieved feature status can then be examined by masking the retrieved value with the various
170
                         *  FEATURE_* masks for bus/self power information and remote wakeup support.
171
                         *
172
                         *  \note After this routine returns, the control pipe will be selected.
173
                         *
174
                         *  \ingroup Group_PipeControlReq
175
                         *
176
                         *  \param[out]  FeatureStatus  Location where the retrieved feature status should be stored.
177
                         *
178
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
179
                         */
180
                        uint8_t USB_Host_GetDeviceStatus(uint8_t* const FeatureStatus) ATTR_NON_NULL_PTR_ARG(1);
181

    
182
                        /** Clears a stall condition on the given pipe, via a CLEAR FEATURE standard request to the attached device.
183
                         *
184
                         *  \note After this routine returns, the control pipe will be selected.
185
                         *
186
                         *  \ingroup Group_PipeControlReq
187
                         *
188
                         *  \param[in] EndpointAddress  Address of the endpoint to clear, including the endpoint's direction.
189
                         *
190
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
191
                         */
192
                        uint8_t USB_Host_ClearEndpointStall(const uint8_t EndpointAddress);
193

    
194
                        /** Selects a given alternative setting for the specified interface, via a SET INTERFACE standard request to
195
                         *  the attached device.
196
                         *
197
                         *  \note After this routine returns, the control pipe will be selected.
198
                         *
199
                         *  \ingroup Group_PipeControlReq
200
                         *
201
                         *  \param[in] InterfaceIndex  Index of the interface whose alternative setting is to be altered.
202
                         *  \param[in] AltSetting      Index of the interface's alternative setting which is to be selected.
203
                         *
204
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
205
                         */
206
                        uint8_t USB_Host_SetInterfaceAltSetting(const uint8_t InterfaceIndex,
207
                                                                                                        const uint8_t AltSetting);
208

    
209
        /* Private Interface - For use in library only: */
210
        #if !defined(__DOXYGEN__)
211
                /* Enums: */
212
                        enum USB_WaitForTypes_t
213
                        {
214
                                USB_HOST_WAITFOR_SetupSent,
215
                                USB_HOST_WAITFOR_InReceived,
216
                                USB_HOST_WAITFOR_OutReady,
217
                        };
218

    
219
                /* Function Prototypes: */
220
                        #if defined(__INCLUDE_FROM_HOSTSTDREQ_C)
221
                                static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);
222
                        #endif
223
        #endif
224

    
225
        /* Disable C linkage for C++ Compilers: */
226
                #if defined(__cplusplus)
227
                        }
228
                #endif
229

    
230
#endif
231