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


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