ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove warnings in the documentation for the library class drivers about sequential pipe/endpoint allocation, as by default this is no longer as issue (unless ORDERED_EP_CONFIG is specified).

Browse source
This commit is contained in:
Dean Camera 2011-06-08 01:32:44 +00:00
parent e572ee7ff2
commit 34164a5550
15 changed files with 11 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

4
LUFA/Drivers/USB/Class/Device/Audio.h
View file

@ -114,10 +114,6 @@
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the
* given Audio interface is selected.
*
* \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
* interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
* within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
*
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
*
* \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.

4
LUFA/Drivers/USB/Class/Device/CDC.h
View file

@ -141,10 +141,6 @@
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
* the given CDC interface is selected.
*
* \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
* interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
* within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
*
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state.
*
* \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.

4
LUFA/Drivers/USB/Class/Device/HID.h
View file

@ -126,10 +126,6 @@
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
* containing the given HID interface is selected.
*
* \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
* interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
* within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.
*
* \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.

4
LUFA/Drivers/USB/Class/Device/MIDI.h
View file

@ -105,10 +105,6 @@
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
* containing the given MIDI interface is selected.
*
* \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
* interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
* within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
*
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
*
* \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.

4
LUFA/Drivers/USB/Class/Device/MassStorage.h
View file

@ -114,10 +114,6 @@
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
* containing the given Mass Storage interface is selected.
*
* \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
* interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
* within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
*
* \param[in,out] MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.
*
* \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.

4
LUFA/Drivers/USB/Class/Device/RNDIS.h
View file

@ -116,10 +116,6 @@
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
* containing the given RNDIS interface is selected.
*
* \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
* interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
* within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
*
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.
*
* \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.