projects / pub / lufa.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Correct TeensyHID bootloader descriptors to use the correct revision code for the...
[pub/lufa.git] / LUFA / Drivers / USB / LowLevel / Host.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2009.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
7 */
8
9 /*
10 Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, and distribute this software
13 and its documentation for any purpose and without fee is hereby
14 granted, provided that the above copyright notice appear in all
15 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 /** \ingroup Group_USB
32 * @defgroup Group_Host Host Management
33 *
34 * USB Host mode related macros and enums. This module contains macros and enums which are used when
35 * the USB controller is initialized in host mode.
36 *
37 * @{
38 */
39
40 #ifndef __USBHOST_H__
41 #define __USBHOST_H__
42
43 /* Includes: */
44 #include <avr/io.h>
45 #include <stdbool.h>
46 #include <util/delay.h>
47
48 #include "../../../Common/Common.h"
49 #include "../HighLevel/USBInterrupt.h"
50 #include "../HighLevel/StdDescriptors.h"
51 #include "Pipe.h"
52
53 /* Enable C linkage for C++ Compilers: */
54 #if defined(__cplusplus)
55 extern "C" {
56 #endif
57
58 /* Public Interface - May be used in end-application: */
59 /* Macros: */
60 /** Indicates the fixed USB device address which any attached device is enumerated to when in
61 * host mode. As only one USB device may be attached to the AVR in host mode at any one time
62 * and that the address used is not important (other than the fact that it is non-zero), a
63 * fixed value is specified by the library.
64 */
65 #define USB_HOST_DEVICEADDRESS 1
66
67 #if !defined(USB_HOST_TIMEOUT_MS) || defined(__DOXYGEN__)
68 /** Constant for the maximum software timeout period of sent USB control transactions to an attached
69 * device. If a device fails to respond to a sent control request within this period, the
70 * library will return a timeout error code.
71 *
72 * This value may be overridden in the user project makefile as the value of the
73 * \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
74 */
75 #define USB_HOST_TIMEOUT_MS 1000
76 #endif
77
78 #if !defined(HOST_DEVICE_SETTLE_DELAY_MS) || defined(__DOXYGEN__)
79 /** Constant for the delay in milliseconds after a device is connected before the library
80 * will start the enumeration process. Some devices require a delay of up to 5 seconds
81 * after connection before the enumeration process can start or incorrect operation will
82 * occur.
83 *
84 * This value may be overridden in the user project makefile as the value of the
85 * HOST_DEVICE_SETTLE_DELAY_MS token, and passed to the compiler using the -D switch.
86 */
87 #define HOST_DEVICE_SETTLE_DELAY_MS 1500
88 #endif
89
90 /* Pseudo-Function Macros: */
91 #if defined(__DOXYGEN__)
92 /** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.
93 * USB bus resets leave the default control pipe configured (if already configured).
94 *
95 * If the USB bus has been suspended prior to issuing a bus reset, the attached device will be
96 * woken up automatically and the bus resumed after the reset has been correctly issued.
97 */
98 static inline void USB_Host_ResetBus(void);
99
100 /** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has
101 * completed.
102 *
103 * \return Boolean true if no bus reset is currently being sent, false otherwise.
104 */
105 static inline void USB_Host_IsBusResetComplete(void);
106
107 /** Resumes USB communications with an attached and enumerated device, by resuming the transmission
108 * of the 1MS Start Of Frame messages to the device. When resumed, USB communications between the
109 * host and attached device may occur.
110 */
111 static inline void USB_Host_ResumeBus(void);
112
113 /** Suspends the USB bus, preventing any communications from occurring between the host and attached
114 * device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame
115 * messages to the device.
116 */
117 static inline void USB_Host_SuspendBus(void);
118
119 /** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,
120 * false otherwise. While suspended, no USB communications can occur until the bus is resumed,
121 * except for the Remote Wakeup event from the device if supported.
122 *
123 * \return Boolean true if the bus is currently suspended, false otherwise
124 */
125 static inline bool USB_Host_IsBusSuspended(void);
126
127 /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
128 * false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
129 *
130 * \return Boolean true if the attached device is enumerated in Full Speed mode, false otherwise
131 */
132 static inline bool USB_Host_IsDeviceFullSpeed(void);
133
134 /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
135 * that the host resume the USB bus and wake up the device, false otherwise.
136 *
137 * \return Boolean true if the attached device has sent a Remote Wakeup request, false otherwise
138 */
139 static inline bool USB_Host_IsRemoteWakeupSent(void);
140
141 /** Clears the flag indicating that a Remote Wakeup request has been issued by an attached device. */
142 static inline void USB_Host_ClearRemoteWakeupSent(void);
143
144 /** Accepts a Remote Wakeup request from an attached device. This must be issued in response to
145 * a device's Remote Wakeup request within 2ms for the request to be accepted and the bus to
146 * be resumed.
147 */
148 static inline void USB_Host_ResumeFromWakeupRequest(void);
149
150 /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
151 * device.
152 *
153 * \return Boolean true if no resume request is currently being sent, false otherwise
154 */
155 static inline bool USB_Host_IsResumeFromWakeupRequestSent(void);
156 #else
157 #define USB_Host_ResetBus() MACROS{ UHCON |= (1 << RESET); }MACROE
158
159 #define USB_Host_IsBusResetComplete() ((UHCON & (1 << RESET)) ? false : true)
160
161 #define USB_Host_ResumeBus() MACROS{ UHCON |= (1 << SOFEN); }MACROE
162
163 #define USB_Host_SuspendBus() MACROS{ UHCON &= ~(1 << SOFEN); }MACROE
164
165 #define USB_Host_IsBusSuspended() ((UHCON & (1 << SOFEN)) ? false : true)
166
167 #define USB_Host_IsDeviceFullSpeed() ((USBSTA & (1 << SPEED)) ? true : false)
168
169 #define USB_Host_IsRemoteWakeupSent() ((UHINT & (1 << RXRSMI)) ? true : false)
170
171 #define USB_Host_ClearRemoteWakeupSent() MACROS{ UHINT &= ~(1 << RXRSMI); }MACROE
172
173 #define USB_Host_ResumeFromWakeupRequest() MACROS{ UHCON |= (1 << RESUME); }MACROE
174
175 #define USB_Host_IsResumeFromWakeupRequestSent() ((UHCON & (1 << RESUME)) ? false : true)
176 #endif
177
178 /* Function Prototypes: */
179 /** Convenience function. This routine sends a SetConfiguration standard request to the attached
180 * device, with the given configuration index. This can be used to easily set the device
181 * configuration without creating and sending the request manually.
182 *
183 * \note After this routine returns, the control pipe will be selected.
184 *
185 * \param[in] ConfigNumber Configuration index to send to the device
186 *
187 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
188 */
189 uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);
190
191 /** Convenience function. This routine sends a GetDescriptor standard request to the attached
192 * device, requesting the device descriptor. This can be used to easily retrieve information
193 * about the device such as its VID, PID and power requirements.
194 *
195 * \note After this routine returns, the control pipe will be selected.
196 *
197 * \param[out] DeviceDescriptorPtr Pointer to the destination device descriptor structure where
198 * the read data is to be stored
199 *
200 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
201 */
202 uint8_t USB_Host_GetDeviceDescriptor(void* const DeviceDescriptorPtr);
203
204 /** Convenience function. This routine sends a GetDescriptor standard request to the attached
205 * device, requesting the string descriptor of the specified index. This can be used to easily
206 * retrieve string descriptors from the device by index, after the index is obtained from the
207 * Device or Configuration descriptors.
208 *
209 * \note After this routine returns, the control pipe will be selected.
210 *
211 * \param[in] Index Index of the string index to retrieve
212 * \param[out] Buffer Pointer to the destination buffer where the retrieved string decriptor is
213 * to be stored
214 * \param[in] BufferLength Maximum size of the string descriptor which can be stored into the buffer
215 *
216 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
217 */
218 uint8_t USB_Host_GetDeviceStringDescriptor(uint8_t Index, void* const Buffer, uint8_t BufferLength);
219
220 /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.
221 *
222 * \note After this routine returns, the control pipe will be selected.
223 *
224 * \param[in] EndpointIndex Index of the endpoint to clear
225 *
226 * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
227 */
228 uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);
229
230 /* Enums: */
231 /** Enum for the various states of the USB Host state machine. Only some states are
232 * implemented in the LUFA library - other states are left to the user to implement.
233 *
234 * For information on each state, refer to the USB 2.0 specification. Some states have
235 *
236 * \see \ref USB_HostState, which stores the current host state machine state.
237 */
238 enum USB_Host_States_t
239 {
240 HOST_STATE_WaitForDeviceRemoval = 0, /**< Internally implemented by the library. This state can be
241 * used by the library to wait until the attached device is
242 * removed by the user - useful for when an error occurs or
243 * further communication with the device is not needed. This
244 * allows for other code to run while the state machine is
245 * effectively disabled.
246 */
247 HOST_STATE_WaitForDevice = 1, /**< Internally implemented by the library. This state indicates
248 * that the stack is waiting for an interval to elapse before
249 * continuing with the next step of the device enumeration
250 * process.
251 *
252 * \note Do not manually change to this state in the user code.
253 */
254 HOST_STATE_Unattached = 2, /**< Internally implemented by the library. This state indicates
255 * that the host state machine is waiting for a device to be
256 * attached so that it can start the enumeration process.
257 *
258 * \note Do not manually change to this state in the user code.
259 */
260 HOST_STATE_Powered = 3, /**< Internally implemented by the library. This state indicates
261 * that a device has been attached, and the library's internals
262 * are being configured to begin the enumeration process.
263 *
264 * \note Do not manually change to this state in the user code.
265 */
266 HOST_STATE_Powered_WaitForDeviceSettle = 4, /**< Internally implemented by the library. This state indicates
267 * that the stack is waiting for the initial settling period to
268 * elapse before beginning the enumeration process.
269 *
270 * \note Do not manually change to this state in the user code.
271 */
272 HOST_STATE_Powered_WaitForConnect = 5, /**< Internally implemented by the library. This state indicates
273 * that the stack is waiting for a connection event from the USB
274 * controller to indicate a valid USB device has been attached to
275 * the bus and is ready to be enumerated.
276 *
277 * \note Do not manually change to this state in the user code.
278 */
279 HOST_STATE_Powered_DoReset = 6, /**< Internally implemented by the library. This state indicates
280 * that a valid USB device has been attached, and that it is
281 * will now be reset to ensure it is ready for enumeration.
282 *
283 * \note Do not manually change to this state in the user code.
284 */
285 HOST_STATE_Powered_ConfigPipe = 7, /**< Internally implemented by the library. This state indicates
286 * that the attached device is currently powered and reset, and
287 * that the control pipe is now being configured by the stack.
288 *
289 * \note Do not manually change to this state in the user code.
290 */
291 HOST_STATE_Default = 8, /**< Internally implemented by the library. This state indicates
292 * that the stack is currently retrieving the control endpoint's
293 * size from the device, so that the control pipe can be altered
294 * to match.
295 *
296 * \note Do not manually change to this state in the user code.
297 */
298 HOST_STATE_Default_PostReset = 9, /**< Internally implemented by the library. This state indicates that
299 * the control pipe is being reconfigured to match the retrieved
300 * control endpoint size from the device, and the device's USB bus
301 * address is being set.
302 *
303 * \note Do not manually change to this state in the user code.
304 */
305 HOST_STATE_Default_PostAddressSet = 10, /**< Internally implemented by the library. This state indicates that
306 * the device's address has now been set, and the stack is has now
307 * completed the device enumeration process. This state causes the
308 * stack to change the current USB device address to that set for
309 * the connected device, before progressing to the user-implemented
310 * HOST_STATE_Addressed state for further communications.
311 *
312 * \note Do not manually change to this state in the user code.
313 */
314 HOST_STATE_Addressed = 11, /**< May be implemented by the user project. This state should
315 * set the device configuration before progressing to the
316 * HOST_STATE_Configured state. Other processing (such as the
317 * retrieval and processing of the device descriptor) should also
318 * be placed in this state.
319 */
320 HOST_STATE_Configured = 12, /**< May be implemented by the user project. This state should implement the
321 * actual work performed on the attached device and changed to the
322 * HOST_STATE_Suspended or HOST_STATE_WaitForDeviceRemoval states as needed.
323 */
324 HOST_STATE_Suspended = 15, /**< May be implemented by the user project. This state should be maintained
325 * while the bus is suspended, and changed to either the HOST_STATE_Configured
326 * (after resuming the bus with the USB_Host_ResumeBus() macro) or the
327 * HOST_STATE_WaitForDeviceRemoval states as needed.
328 */
329 };
330
331 /** Enum for the error codes for the \ref EVENT_USB_Host_HostError() event.
332 *
333 * \see \ref Group_Events for more information on this event.
334 */
335 enum USB_Host_ErrorCodes_t
336 {
337 HOST_ERROR_VBusVoltageDip = 0, /**< VBUS voltage dipped to an unacceptable level. This
338 * error may be the result of an attached device drawing
339 * too much current from the VBUS line, or due to the
340 * AVR's power source being unable to supply sufficient
341 * current.
342 */
343 };
344
345 /** Enum for the error codes for the \ref EVENT_USB_Host_DeviceEnumerationFailed() event.
346 *
347 * \see \ref Group_Events for more information on this event.
348 */
349 enum USB_Host_EnumerationErrorCodes_t
350 {
351 HOST_ENUMERROR_NoError = 0, /**< No error occurred. Used internally, this is not a valid
352 * ErrorCode parameter value for the \ref EVENT_USB_Host_DeviceEnumerationFailed()
353 * event.
354 */
355 HOST_ENUMERROR_WaitStage = 1, /**< One of the delays between enumeration steps failed
356 * to complete successfully, due to a timeout or other
357 * error.
358 */
359 HOST_ENUMERROR_NoDeviceDetected = 2, /**< No device was detected, despite the USB data lines
360 * indicating the attachment of a device.
361 */
362 HOST_ENUMERROR_ControlError = 3, /**< One of the enumeration control requests failed to
363 * complete successfully.
364 */
365 HOST_ENUMERROR_PipeConfigError = 4, /**< The default control pipe (address 0) failed to
366 * configure correctly.
367 */
368 };
369
370 /* Private Interface - For use in library only: */
371 #if !defined(__DOXYGEN__)
372 /* Macros: */
373 #define USB_Host_HostMode_On() MACROS{ USBCON |= (1 << HOST); }MACROE
374 #define USB_Host_HostMode_Off() MACROS{ USBCON &= ~(1 << HOST); }MACROE
375
376 #define USB_Host_VBUS_Auto_Enable() MACROS{ OTGCON &= ~(1 << VBUSHWC); UHWCON |= (1 << UVCONE); }MACROE
377 #define USB_Host_VBUS_Manual_Enable() MACROS{ OTGCON |= (1 << VBUSHWC); UHWCON &= ~(1 << UVCONE); DDRE |= (1 << 7); }MACROE
378
379 #define USB_Host_VBUS_Auto_On() MACROS{ OTGCON |= (1 << VBUSREQ); }MACROE
380 #define USB_Host_VBUS_Manual_On() MACROS{ PORTE |= (1 << 7); }MACROE
381
382 #define USB_Host_VBUS_Auto_Off() MACROS{ OTGCON |= (1 << VBUSRQC); }MACROE
383 #define USB_Host_VBUS_Manual_Off() MACROS{ PORTE &= ~(1 << 7); }MACROE
384
385 #define USB_Host_SetDeviceAddress(addr) MACROS{ UHADDR = ((addr) & 0x7F); }MACROE
386
387 /* Enums: */
388 enum USB_Host_WaitMSErrorCodes_t
389 {
390 HOST_WAITERROR_Successful = 0,
391 HOST_WAITERROR_DeviceDisconnect = 1,
392 HOST_WAITERROR_PipeError = 2,
393 HOST_WAITERROR_SetupStalled = 3,
394 };
395
396 /* Function Prototypes: */
397 void USB_Host_ProcessNextHostState(void);
398 uint8_t USB_Host_WaitMS(uint8_t MS);
399
400 #if defined(INCLUDE_FROM_HOST_C)
401 static void USB_Host_ResetDevice(void);
402 #endif
403 #endif
404
405 /* Disable C linkage for C++ Compilers: */
406 #if defined(__cplusplus)
407 }
408 #endif
409
410 #endif
411
412 /** @} */
Lightweight USB Framework for AVRs