/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting \r
+ documentation, and that the name of the author not be used in \r
+ advertising or publicity pertaining to distribution of the \r
software without specific, written prior permission.\r
\r
The author disclaim all warranties with regard to this\r
*/\r
\r
/** \ingroup Group_USB\r
- * @defgroup Group_OTGManagement USB On The Go (OTG) Management\r
+ * @defgroup Group_OTG USB On The Go (OTG) Management\r
*\r
* This module contains macros for embedded USB hosts with dual role On The Go capabilities, for managing role\r
* exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host\r
/** Initiate a Host Negotiation Protocol request. This indicates to the other connected device\r
* that the device wishes to change device/host roles.\r
*/\r
- static inline void USB_OTG_DEV_Request_HNP(void);\r
+ static inline void USB_OTG_Device_RequestHNP(void);\r
\r
/** Cancel a Host Negotiation Protocol request. This stops a pending HNP request to the other\r
* connected device.\r
*/\r
- static inline void USB_OTG_DEV_Cancel_HNP_Request(void);\r
+ static inline void USB_OTG_Device_CancelHNPRequest(void);\r
\r
/** Determines if the device is currently sending a HNP to an attached host.\r
*\r
* \return Boolean true if currently sending a HNP to the other connected device, false otherwise\r
*/\r
- static inline bool USB_OTG_DEV_IsSendingHNP(void);\r
+ static inline bool USB_OTG_Device_IsSendingHNP(void);\r
\r
/** Accepts a HNP from a connected device, indicating that both devices should exchange\r
* device/host roles.\r
*/\r
- static inline void USB_OTG_HOST_Accept_HNP(void);\r
+ static inline void USB_OTG_Host_AcceptHNP(void);\r
\r
/** Rejects a HNP from a connected device, indicating that both devices should remain in their\r
* current device/host roles.\r
*/\r
- static inline void USB_OTG_HOST_Reject_HNP(void);\r
+ static inline void USB_OTG_Host_RejectHNP(void);\r
\r
/** Indicates if the connected device is not currently sending a HNP request.\r
*\r
* \return Boolean true if a HNP is currently being issued by the connected device, false otherwise.\r
*/\r
- static inline bool USB_OTG_HOST_IsHNPReceived(void);\r
+ static inline bool USB_OTG_Host_IsHNPReceived(void);\r
\r
/** Initiates a Session Request Protocol request. Most OTG devices turn off VBUS when the USB\r
* interface is not in use, to conserve power. Sending a SRP to a USB OTG device running in\r
* There are two different methods of sending a SRP - either pulses on the VBUS line, or by\r
* pulsing the Data + line via the internal pull-up resistor.\r
*\r
- * \param SRPTypeMask Mask indicating the type of SRP to use, either \ref USB_OTG_SRP_VBUS or \ref USB_OTG_STP_DATA.\r
+ * \param[in] SRPTypeMask Mask indicating the type of SRP to use, either \ref USB_OTG_SRP_VBUS or \ref USB_OTG_STP_DATA.\r
*/\r
- static inline void USB_OTG_DEV_Initiate_SRP(uint8_t SRPTypeMask);\r
+ static inline void USB_OTG_Dev_InitiateSRP(uint8_t SRPTypeMask);\r
#else\r
+ #define USB_OTG_Device_RequestHNP() MACROS{ OTGCON |= (1 << HNPREQ); }MACROE\r
\r
- #define USB_OTG_DEV_Request_HNP() MACROS{ OTGCON |= (1 << HNPREQ); }MACROE\r
+ #define USB_OTG_Device_CancelHNPRequest() MACROS{ OTGCON &= ~(1 << HNPREQ); }MACROE\r
\r
- #define USB_OTG_DEV_Cancel_HNP_Request() MACROS{ OTGCON &= ~(1 << HNPREQ); }MACROE\r
-\r
- #define USB_OTG_DEV_IsSendingHNP() ((OTGCON & (1 << HNPREQ)) ? true : false)\r
+ #define USB_OTG_Device_IsSendingHNP() ((OTGCON & (1 << HNPREQ)) ? true : false)\r
\r
- #define USB_OTG_HOST_Accept_HNP() MACROS{ OTGCON |= (1 << HNPREQ); }MACROE\r
+ #define USB_OTG_Host_AcceptHNP() MACROS{ OTGCON |= (1 << HNPREQ); }MACROE\r
\r
- #define USB_OTG_HOST_Reject_HNP() MACROS{ OTGCON &= ~(1 << HNPREQ); }MACROE\r
+ #define USB_OTG_Host_RejectHNP() MACROS{ OTGCON &= ~(1 << HNPREQ); }MACROE\r
\r
- #define USB_OTG_HOST_IsHNPReceived() ((OTGCON & (1 << HNPREQ)) ? true : false)\r
+ #define USB_OTG_Host_IsHNPReceived() ((OTGCON & (1 << HNPREQ)) ? true : false)\r
\r
- #define USB_OTG_DEV_Initiate_SRP(type) MACROS{ OTGCON = ((OTGCON & ~(1 << SRPSEL)) | (type | (1 << SRPREQ))); }MACROE\r
+ #define USB_OTG_Device_InitiateSRP(type) MACROS{ OTGCON = ((OTGCON & ~(1 << SRPSEL)) | ((type) | (1 << SRPREQ))); }MACROE\r
#endif\r
\r
#endif\r