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