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