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


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