hailey
/
qmk_firmware
mirror of https://github.com/hailey/qmk_firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.

Browse Source
Dean Camera 13 years ago
parent 5561524a8f
commit e406140f11
32 changed files with 134 additions and 158 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 4
      LUFA/Common/Common.h
  2. 2
      LUFA/DoxygenPages/CompileTimeTokens.txt
  3. 1
      LUFA/DoxygenPages/LUFAPoweredProjects.txt
  4. 4
      LUFA/Drivers/Misc/RingBuffer.h
  5. 8
      LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
  6. 2
      LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h
  7. 4
      LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
  8. 15
      LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
  9. 2
      LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h
  10. 2
      LUFA/Drivers/USB/Class/Host/CDCClassHost.h
  11. 7
      LUFA/Drivers/USB/Class/Host/HIDClassHost.h
  12. 12
      LUFA/Drivers/USB/Core/AVR8/Device_AVR8.h
  13. 18
      LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
  14. 6
      LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
  15. 8
      LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h
  16. 7
      LUFA/Drivers/USB/Core/AVR8/USBController_AVR8.h
  17. 5
      LUFA/Drivers/USB/Core/DeviceStandardReq.h
  18. 12
      LUFA/Drivers/USB/Core/Events.h
  19. 2
      LUFA/Drivers/USB/Core/HostStandardReq.h
  20. 7
      LUFA/Drivers/USB/Core/UC3/Device_UC3.h
  21. 14
      LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
  22. 4
      LUFA/Drivers/USB/Core/UC3/Host_UC3.h
  23. 5
      LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h
  24. 7
      LUFA/Drivers/USB/Core/UC3/USBController_UC3.h
  25. 8
      LUFA/Drivers/USB/Core/USBTask.h
  26. 8
      LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h
  27. 11
      LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
  28. 7
      LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h
  29. 6
      LUFA/Drivers/USB/USB.h
  30. 2
      LUFA/Platform/UC3/ClockManagement.h
  31. 2
      LUFA/Platform/XMEGA/ClockManagement.h
  32. 2
      LUFA/Scheduler/Scheduler.h

4
LUFA/Common/Common.h
Unescape View File

@ -153,7 +153,7 @@
/** Convenience macro to determine the larger of two values.
*
* \note This macro should only be used with operands that do not have side effects from being evaluated
* \attention This macro should only be used with operands that do not have side effects from being evaluated
* multiple times.
*
* \param[in] x First value to compare
@ -167,7 +167,7 @@
/** Convenience macro to determine the smaller of two values.
*
* \note This macro should only be used with operands that do not have side effects from being evaluated
* \attention This macro should only be used with operands that do not have side effects from being evaluated
* multiple times.
*
* \param[in] x First value to compare

2
LUFA/DoxygenPages/CompileTimeTokens.txt
Unescape View File

@ -210,7 +210,7 @@
* If enabled, this will indicate that the USB target VBUS line polarity is inverted; i.e. it should be pulled low to enable VBUS to the
* target, and pulled high to stop the target VBUS generation.
*
* \note On AVR8 architecture devices, this compile time option requires \c NO_AUTO_VBUS_MANAGEMENT to be set.
* \attention On AVR8 architecture devices, this compile time option requires \c NO_AUTO_VBUS_MANAGEMENT to be set.
*
* - <b>NO_AUTO_VBUS_MANAGEMENT</b> - (\ref Group_Host) - <i>All Architectures</i> \n
* Disables the automatic management of VBUS to the target, i.e. automatic shut down in the even of an overcurrent situation. When enabled, VBUS

1
LUFA/DoxygenPages/LUFAPoweredProjects.txt
Unescape View File

@ -89,6 +89,7 @@
* - PSGroove, a Playstation 3 Homebrew dongle: http://github.com/psgroove
* - PS/2 to USB adapter: https://github.com/makestuff/p2ukbd
* - Reprap with LUFA, a LUFA powered 3D printer: http://code.google.com/p/at90usb1287-code-for-arduino-and-eclipse/
* - RFPirate, a RF experimentation platform: https://github.com/ebuller/RF-Pirate
* - RF Transciever using the MRF49XA: http://alternet.us.com/?page_id=1494
* - SD Card reader: http://elasticsheep.com/2010/04/teensy2-usb-mass-storage-with-an-sd-card/
* - SDR1, a Software Defined Radio firmware: https://code.google.com/p/sdr-mk1/

4
LUFA/Drivers/Misc/RingBuffer.h
Unescape View File

@ -225,7 +225,7 @@
/** Inserts an element into the ring buffer.
*
* \note Only one execution thread (main program thread or an ISR) may insert into a single buffer
* \warning Only one execution thread (main program thread or an ISR) may insert into a single buffer
* otherwise data corruption may occur. Insertion and removal may occur from different execution
* threads.
*
@ -252,7 +252,7 @@
/** Removes an element from the ring buffer.
*
* \note Only one execution thread (main program thread or an ISR) may remove from a single buffer
* \warning Only one execution thread (main program thread or an ISR) may remove from a single buffer
* otherwise data corruption may occur. Insertion and removal may occur from different execution
* threads.
*

8
LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
Unescape View File

@ -253,7 +253,7 @@
/** Retrieves the ADC MUX mask for the given ADC channel number.
*
* \note This macro will only work correctly on channel numbers that are compile-time
* \attention This macro will only work correctly on channel numbers that are compile-time
* constants defined by the preprocessor.
*
* \param[in] Channel Index of the ADC channel whose MUX mask is to be retrieved.
@ -268,9 +268,8 @@
*
* \note This must only be called for ADC channels with are connected to a physical port
* pin of the AVR, denoted by its special alternative function ADCx.
* \n\n
*
* \note The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
* \warning The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
*
* \param[in] ChannelIndex ADC channel number to set up for conversions.
*/
@ -311,9 +310,8 @@
*
* \note This must only be called for ADC channels with are connected to a physical port
* pin of the AVR, denoted by its special alternative function ADCx.
* \n\n
*
* \note The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
* \warning The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
*
* \param[in] ChannelIndex ADC channel number to set up for conversions.
*/

2
LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h
Unescape View File

@ -196,7 +196,7 @@
*
* The generated SCL frequency will be according to the formula <pre>F_CPU / (16 + 2 * BitLength + 4 ^ Prescale)</pre>.
*
* \note The value of the \c BitLength parameter should not be set below 10 or invalid bus conditions may
* \attention The value of the \c BitLength parameter should not be set below 10 or invalid bus conditions may
* occur, as indicated in the AVR8 microcontroller datasheet.
*
* \param[in] Prescale Prescaler to use when determining the bus frequency, a \c TWI_BIT_PRESCALE_* value.

4
LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
Unescape View File

@ -583,7 +583,7 @@
* about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
* in the device's audio streams. See the USB Audio specification for more details.
*
* \note This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
* \attention This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
* the continuous or discrete sample frequencies.
*
* \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
@ -630,7 +630,7 @@
* about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
* in the device's audio streams. See the USB Audio specification for more details.
*
* \note This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
* \attention This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
* or discrete sample frequencies.
*
* \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific

15
LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
Unescape View File

@ -53,16 +53,17 @@
*
* One major issue with CDC-ACM is that it requires two Interface descriptors,
* which will upset most hosts when part of a multi-function "Composite" USB
* device, as each interface will be loaded into a separate driver instance. To
* combat this, you should use the "Interface Association Descriptor" addendum to
* the USB standard which is available on most OSes when creating Composite devices.
* device. This is because each interface will be loaded into a separate driver
* instance, causing the two interfaces be become unlinked. To prevent this, you
* should use the "Interface Association Descriptor" addendum to the USB 2.0 standard
* which is available on most OSes when creating Composite devices.
*
* Another major oversight is that there is no mechanism for the host to notify the
* device that there is a data sink on the host side ready to accept data. This
* means that the device may try to send data while the host isn't listening, causing
* lengthy blocking timeouts in the transmission routines. To combat this, it is
* recommended that the virtual serial line DTR (Data Terminal Ready) be used where
* possible to determine if a host application is ready for data.
* lengthy blocking timeouts in the transmission routines. It is thus highly recommended
* that the virtual serial line DTR (Data Terminal Ready) signal be used where possible
* to determine if a host application is ready for data.
*
* @{
*/
@ -299,7 +300,7 @@
* be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
* line buffering.
*
* \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
* \note The created stream can be given as \c stdout if desired to direct the standard output from all <stdio.h> functions
* to the given CDC interface.
* \n\n
*

2
LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h
Unescape View File

@ -263,7 +263,7 @@
* be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
* line buffering.
*
* \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions
* \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions
* to the given AOA interface.
* \n\n
*

2
LUFA/Drivers/USB/Class/Host/CDCClassHost.h
Unescape View File

@ -289,7 +289,7 @@
* be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
* line buffering.
*
* \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions
* \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions
* to the given CDC interface.
* \n\n
*

7
LUFA/Drivers/USB/Class/Host/HIDClassHost.h
Unescape View File

@ -148,7 +148,7 @@
* device. This should be called once after the stack has enumerated the attached device, while the host state
* machine is in the Addressed state.
*
* \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
* \attention Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
* to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.
@ -167,7 +167,7 @@
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
* call will fail.
*
* \note The destination buffer should be large enough to accommodate the largest report that the attached device
* \attention The destination buffer should be large enough to accommodate the largest report that the attached device
* can generate.
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.
@ -267,9 +267,8 @@
/** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves
* and parses the device's HID report descriptor, so that the size of each report can be determined in advance.
*
* \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID
* \attention Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID
* Report Parser this function references <b>must</b> be implemented in the user code.
* \n\n
*
* \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
*

12
LUFA/Drivers/USB/Core/AVR8/Device_AVR8.h
Unescape View File

@ -89,7 +89,7 @@
* \n
*
* \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)
#endif
@ -138,14 +138,14 @@
* 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
* \attention 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.
* compile time option is used, this function is unavailable.
* \n\n
*
* \note The USB clock must be running for this function to operate. If the stack is initialized with
* \attention 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
* before attempting to call this function.
*
@ -170,7 +170,7 @@
* \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
* at the start of each USB frame when enumerated in device 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_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
static inline void USB_Device_EnableSOFEvents(void)
@ -181,7 +181,7 @@
/** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
* \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device 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_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
static inline void USB_Device_DisableSOFEvents(void)

18
LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
Unescape View File

@ -171,7 +171,7 @@
/** 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
* \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)
@ -180,7 +180,7 @@
/** 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
* \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)
@ -245,12 +245,11 @@
* 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
* \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.
* \n\n
*
* \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.
* \note Different endpoints may have different maximum packet sizes based on the endpoint's index - please
* refer to the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
* \n\n
*
* \note The default control endpoint should not be manually configured by the user application, as
@ -278,9 +277,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_AVR8
*
@ -835,7 +831,7 @@
* \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
* \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__))
@ -848,6 +844,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);

6
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
Unescape View File

@ -146,7 +146,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)
@ -157,7 +157,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)
@ -203,7 +203,7 @@
* device until the bus has been resumed. This stops the transmission of the 1MS Start Of Frame
* messages to the device.
*
* \note While the USB bus is suspended, all USB interrupt sources are also disabled; this means that
* \attention While the USB bus is suspended, all USB interrupt sources are also disabled; this means that
* some events (such as device disconnections) will not fire until the bus is resumed.
*/
static inline void USB_Host_SuspendBus(void) ATTR_ALWAYS_INLINE;

8
LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h
Unescape View File

@ -192,9 +192,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_AVR8
*
@ -807,7 +804,7 @@
* 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
* \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;
@ -842,9 +839,8 @@
* uses more USB DPRAM, but offers better performance. Isochronous type pipes <b>must</b>
* have at least two banks.
*
* \note When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order,
* \attention When the \c ORDERED_EP_CONFIG compile time option is used, Pipes <b>must</b> be configured in ascending order,
* or bank corruption will occur.
* \n\n
*
* \note Certain microcontroller model's pipes may have different maximum packet sizes based on the pipe's
* index - refer to the chosen microcontroller's datasheet to determine the maximum bank size for each pipe.

7
LUFA/Drivers/USB/Core/AVR8/USBController_AVR8.h
Unescape View File

@ -227,7 +227,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
@ -271,9 +271,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
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value.
* \n\n
*
* \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
@ -293,7 +292,7 @@
/** 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
* \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;

5
LUFA/Drivers/USB/Core/DeviceStandardReq.h
Unescape View File

@ -86,7 +86,7 @@
* different configurations which the host can select between; this indicates the currently selected
* value, or 0 if no configuration has been selected.
*
* \note This variable should be treated as read-only in the user application, and never manually
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value.
*
* \ingroup Group_Device
@ -97,9 +97,8 @@
/** Indicates if the host is currently allowing the device to issue remote wakeup events. If this
* flag is cleared, the device should not issue remote wakeup events to the host.
*
* \note This variable should be treated as read-only in the user application, and never manually
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value.
* \n\n
*
* \note To reduce FLASH usage of the compiled applications where Remote Wakeup is not supported,
* this global and the underlying management code can be disabled by defining the

12
LUFA/Drivers/USB/Core/Events.h
Unescape View File

@ -183,6 +183,9 @@
* This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
* two seconds) will prevent the device from enumerating correctly.
*
* \attention This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
* if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
*
* \note For the microcontrollers with limited USB controller functionality, VBUS sensing is not available.
* this means that the current connection state is derived from the bus suspension and wake up events by default,
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state
@ -191,9 +194,6 @@
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
* \n\n
*
* \note This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
* if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
*
* \see \ref Group_USBManagement for more information on the USB management task and reducing CPU usage.
*/
void EVENT_USB_Device_Connect(void);
@ -201,6 +201,9 @@
/** Event for USB device disconnection. This event fires when the microcontroller is in USB Device mode and the device is
* disconnected from a host, measured by a falling level on the microcontroller's VBUS sense pin.
*
* \attention This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
* if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
*
* \note For the microcontrollers with limited USB controllers, VBUS sense is not available to the USB controller.
* this means that the current connection state is derived from the bus suspension and wake up events by default,
* which is not always accurate (host may suspend the bus while still connected). If the actual connection state
@ -209,9 +212,6 @@
* and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
* \n\n
*
* \note This event may fire multiple times during device enumeration on the microcontrollers with limited USB controllers
* if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
*
* \see \ref Group_USBManagement for more information on the USB management task and reducing CPU usage.
*/
void EVENT_USB_Device_Disconnect(void);

2
LUFA/Drivers/USB/Core/HostStandardReq.h
Unescape View File

@ -95,7 +95,7 @@
*
* To set a device configuration, call the \ref USB_Host_SetDeviceConfiguration() function.
*
* \note This variable should be treated as read-only in the user application, and never manually
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value.
*
* \ingroup Group_Host

7
LUFA/Drivers/USB/Core/UC3/Device_UC3.h
Unescape View File

@ -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

14
LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
Unescape View File

@ -199,7 +199,7 @@
/** 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
* \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,7 +208,7 @@
/** 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
* \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
* \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.
* \n\n
*
* \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.
@ -309,9 +308,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
*
@ -831,7 +827,7 @@
* \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
* \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__))
@ -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);

4
LUFA/Drivers/USB/Core/UC3/Host_UC3.h
Unescape View File

@ -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)

5
LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h
Unescape View File

@ -213,9 +213,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
*
@ -818,7 +815,7 @@
* 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
* \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;

7
LUFA/Drivers/USB/Core/UC3/USBController_UC3.h
Unescape View File

@ -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
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value.
* \n\n
*
* \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,7 +245,7 @@
/** 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
* \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;

8
LUFA/Drivers/USB/Core/USBTask.h
Unescape View File

@ -73,7 +73,7 @@
* or device (i.e. if \ref USB_Init() has been run). If this is false, all other library globals related
* to the USB driver are invalid.
*
* \note This variable should be treated as read-only in the user application, and never manually
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value.
*
* \ingroup Group_USBManagement
@ -133,12 +133,12 @@
* the compiler via the -D switch. When defined, the corresponding GPIOR register should not be used
* in the user application except implicitly via the library APIs.
*
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value except in the circumstances outlined above.
*
* \note This global is only present if the user application can be a USB device.
* \n\n
*
* \note This variable should be treated as read-only in the user application, and never manually
* changed in value except in the circumstances outlined above.
*
* \see \ref USB_Device_States_t for a list of possible device states.
*
* \ingroup Group_Device

8
LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h
Unescape View File

@ -133,11 +133,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.
* compile time option is used, this function is unavailable.
* \n\n
*
* \note The USB clock must be running for this function to operate. If the stack is initialized with
@ -165,7 +165,7 @@
* \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
* at the start of each USB frame when enumerated in device 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_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
static inline void USB_Device_EnableSOFEvents(void)
@ -176,7 +176,7 @@
/** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
* \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device 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_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
static inline void USB_Device_DisableSOFEvents(void)

11
LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
Unescape View File

@ -170,7 +170,7 @@
/** 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
* \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)
@ -179,7 +179,7 @@
/** 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
* \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)
@ -315,9 +315,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_XMEGA
*
@ -793,7 +790,7 @@
* \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
* \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__))
@ -806,6 +803,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);

7
LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h
Unescape View File

@ -192,7 +192,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
@ -236,9 +236,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
* \attention This variable should be treated as read-only in the user application, and never manually
* changed in value.
* \n\n
*
* \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
@ -256,7 +255,7 @@
/** 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
* \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;

6
LUFA/Drivers/USB/USB.h
Unescape View File

@ -158,9 +158,6 @@
* before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters
* for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.
*
* \note The \c State section of the \c USB_ClassInfo_* structures are designed to be controlled by the Class Drivers only
* for maintaining the Class Driver instance's state, and should not normally be altered by the user application.
*
* The following is an example of a properly initialized instance of the Audio Class Driver structure:
*
* \code
@ -258,9 +255,6 @@
* before the class driver is used. Each Device mode Class driver typically contains a set of configuration parameters
* for the endpoint size/number of the associated logical USB interface, plus any class-specific configuration parameters.
*
* \note The \c State section of the \c USB_ClassInfo_* structures are designed to be controlled by the Class Drivers only
* for maintaining the Class Driver instance's state, and should not normally be altered by the user application.
*
* The following is an example of a properly initialized instance of the MIDI Host Class Driver structure:
*
* \code

2
LUFA/Platform/UC3/ClockManagement.h
Unescape View File

@ -162,7 +162,7 @@
/** Starts the given PLL of the UC3 microcontroller, with the given options. This routine blocks until the PLL is ready for use.
*
* \note The output frequency must be equal to or greater than the source frequency.
* \attention The output frequency must be equal to or greater than the source frequency.
*
* \param[in] Channel Index of the PLL to start.
* \param[in] Source Clock source for the PLL, a value from \ref UC3_System_ClockSource_t.

2
LUFA/Platform/XMEGA/ClockManagement.h
Unescape View File

@ -200,7 +200,7 @@
/** Starts the PLL of the XMEGA microcontroller, with the given options. This routine blocks until the PLL is ready for use.
*
* \note The output frequency must be equal to or greater than the source frequency.
* \attention The output frequency must be equal to or greater than the source frequency.
*
* \param[in] Source Clock source for the PLL, a value from \ref XMEGA_System_ClockSource_t.
* \param[in] SourceFreq Frequency of the PLL's clock source, in Hz.

2
LUFA/Scheduler/Scheduler.h
Unescape View File

@ -199,7 +199,7 @@
/** Contains the total number of tasks in the task list, irrespective of if the task's status is set to
* \ref TASK_RUN or \ref TASK_STOP.
*
* \note This value should be treated as read-only, and never altered in user-code.
* \warning This value should be treated as read-only, and never altered in user-application code.
*/
extern volatile uint_least8_t Scheduler_TotalTasks;

Write Preview
Loading…
Cancel
Save