diff options
Diffstat (limited to 'LUFA/Drivers/USB/Core/UC3')
| -rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Device_UC3.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h | 22 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Host_UC3.h | 4 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Core/UC3/USBController_UC3.h | 11 |
5 files changed, 22 insertions, 29 deletions
diff --git a/LUFA/Drivers/USB/Core/UC3/Device_UC3.h b/LUFA/Drivers/USB/Core/UC3/Device_UC3.h index 0781d43d0..36c452f0b 100644 --- a/LUFA/Drivers/USB/Core/UC3/Device_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Device_UC3.h @@ -73,7 +73,7 @@ * USB interface should be initialized in low speed (1.5Mb/s) mode. * * \note Restrictions apply on the number, size and type of endpoints which can be used - * when running in low speed mode - refer to the USB 2.0 specification. + * when running in low speed mode - please refer to the USB 2.0 specification. */ #define USB_DEVICE_OPT_LOWSPEED (1 << 0) @@ -127,12 +127,11 @@ * Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the * host computer when the host has suspended all USB devices to enter a low power state. * - * \note This macro should only be used if the device has indicated to the host that it + * \note This function should only be used if the device has indicated to the host that it * supports the Remote Wakeup feature in the device descriptors, and should only be * issued if the host is currently allowing remote wakeup events from the device (i.e., * the \ref USB_Device_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP - * compile time option is used, this macro is unavailable. - * \n\n + * compile time option is used, this function is unavailable. * * \note The USB clock must be running for this function to operate. If the stack is initialized with * the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running diff --git a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h index 2c151babc..c919effa7 100644 --- a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h @@ -199,8 +199,8 @@ /** Retrieves the maximum bank size in bytes of a given endpoint. * - * \note This macro will only work correctly on endpoint indexes that are compile-time constants - * defined by the preprocessor. + * \attention This macro will only work correctly on endpoint indexes that are compile-time constants + * defined by the preprocessor. * * \param[in] EPIndex Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1) */ @@ -208,8 +208,8 @@ /** Retrieves the total number of banks supported by the given endpoint. * - * \note This macro will only work correctly on endpoint indexes that are compile-time constants - * defined by the preprocessor. + * \attention This macro will only work correctly on endpoint indexes that are compile-time constants + * defined by the preprocessor. * * \param[in] EPIndex Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1) */ @@ -273,9 +273,8 @@ * More banks uses more USB DPRAM, but offers better performance. Isochronous type * endpoints <b>must</b> have at least two banks. * - * \note When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in - * ascending order, or bank corruption will occur. - * \n\n + * \attention When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in + * ascending order, or bank corruption will occur. * * \note Different endpoints may have different maximum packet sizes based on the endpoint's index - refer to * the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint. @@ -310,9 +309,6 @@ /** Indicates the number of bytes currently stored in the current endpoint's selected bank. * - * \note The return width of this function may differ, depending on the maximum endpoint bank size - * of the selected AVR model. - * * \ingroup Group_EndpointRW_UC3 * * \return Total number of bytes in the currently selected Endpoint's FIFO buffer. @@ -831,8 +827,8 @@ * \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token * be used in the device descriptors to ensure this. * - * \note This variable should be treated as read-only in the user application, and never manually - * changed in value. + * \attention This variable should be treated as read-only in the user application, and never manually + * changed in value. */ #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__)) extern uint8_t USB_Device_ControlEndpointSize; @@ -844,6 +840,8 @@ /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically, * with respect to the data direction. This is a convenience function which can be used to * simplify user control request handling. + * + * \note This routine should not be called on non CONTROL type endpoints. */ void Endpoint_ClearStatusStage(void); diff --git a/LUFA/Drivers/USB/Core/UC3/Host_UC3.h b/LUFA/Drivers/USB/Core/UC3/Host_UC3.h index 5f998379a..a1655b609 100644 --- a/LUFA/Drivers/USB/Core/UC3/Host_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Host_UC3.h @@ -143,7 +143,7 @@ * \ref EVENT_USB_Host_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus, * at the start of each USB frame when a device is enumerated while in host mode. * - * \note Not available when the \c NO_SOF_EVENTS compile time token is defined. + * \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined. */ static inline void USB_Host_EnableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_EnableSOFEvents(void) @@ -154,7 +154,7 @@ /** Disables the host mode Start Of Frame events. When disabled, this stops the firing of the * \ref EVENT_USB_Host_StartOfFrame() event when enumerated in host mode. * - * \note Not available when the NO_SOF_EVENTS compile time token is defined. + * \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined. */ static inline void USB_Host_DisableSOFEvents(void) ATTR_ALWAYS_INLINE; static inline void USB_Host_DisableSOFEvents(void) diff --git a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h index 1433d8ca2..f17fa5376 100644 --- a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h @@ -214,9 +214,6 @@ /* Inline Functions: */ /** Indicates the number of bytes currently stored in the current pipes's selected bank. * - * \note The return width of this function may differ, depending on the maximum pipe bank size - * of the selected AVR model. - * * \ingroup Group_PipeRW_UC3 * * \return Total number of bytes in the currently selected pipe's FIFO buffer. @@ -818,8 +815,8 @@ * descriptor once the USB interface is initialized into host mode and a device is attached * to the USB bus. * - * \note This variable should be treated as read-only in the user application, and never manually - * changed in value. + * \attention This variable should be treated as read-only in the user application, and never manually + * changed in value. */ extern uint8_t USB_Host_ControlPipeSize; diff --git a/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h b/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h index 0d25ebebe..92e245ca2 100644 --- a/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/USBController_UC3.h @@ -184,7 +184,7 @@ * function prototype. * \n\n * - * \note To reduce the FLASH requirements of the library if only fixed settings are are required, + * \note To reduce the FLASH requirements of the library if only fixed settings are required, * the options may be set statically in the same manner as the mode (see the Mode parameter of * this function). To statically set the USB options, pass in the \c USE_STATIC_OPTIONS token, * defined to the appropriate options masks. When the options are statically set, this @@ -224,9 +224,8 @@ /** Indicates the mode that the USB interface is currently initialized to, a value from the * \ref USB_Modes_t enum. * - * \note This variable should be treated as read-only in the user application, and never manually - * changed in value. - * \n\n + * \attention This variable should be treated as read-only in the user application, and never manually + * changed in value. * * \note When the controller is initialized into UID auto-detection mode, this variable will hold the * currently selected USB mode (i.e. \ref USB_MODE_Device or \ref USB_MODE_Host). If the controller @@ -246,8 +245,8 @@ /** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init() * was called. This value will be one of the \c USB_MODE_* masks defined elsewhere in this module. * - * \note This variable should be treated as read-only in the user application, and never manually - * changed in value. + * \attention This variable should be treated as read-only in the user application, and never manually + * changed in value. */ extern volatile uint8_t USB_Options; #elif defined(USE_STATIC_OPTIONS) |