Commit 7dffa15c authored by Dean Camera's avatar Dean Camera
Browse files

Massive corrections to the project documentation and code comments, thanks to...

Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru.
parent 0210fa56
This diff is collapsed.
...@@ -124,7 +124,7 @@ ...@@ -124,7 +124,7 @@
* are deselected. * are deselected.
* *
* \param[in] PageAddress Address of the page to manipulate, ranging from * \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/ */
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{ {
...@@ -166,7 +166,7 @@ ...@@ -166,7 +166,7 @@
} }
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address. * dataflash commands which require a complete 24-bit address.
* *
* \param[in] PageAddress Page address within the selected dataflash IC * \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer * \param[in] BufferByte Address within the dataflash's buffer
......
...@@ -29,7 +29,7 @@ ...@@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Board specific joystick driver header for the Fletchtronics BUMLEB. * \brief Board specific joystick driver header for the Fletchtronics BUMBLEB.
* \copydetails Group_Joystick_BUMBLEB * \copydetails Group_Joystick_BUMBLEB
* *
* \note This file should not be included directly. It is automatically included as needed by the joystick driver * \note This file should not be included directly. It is automatically included as needed by the joystick driver
...@@ -38,7 +38,7 @@ ...@@ -38,7 +38,7 @@
/** \ingroup Group_Joystick /** \ingroup Group_Joystick
* \defgroup Group_Joystick_BUMBLEB BUMBLEB * \defgroup Group_Joystick_BUMBLEB BUMBLEB
* \brief Board specific joystick driver header for the Fletchtronics BUMLEB. * \brief Board specific joystick driver header for the Fletchtronics BUMBLEB.
* *
* Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB * Board specific joystick driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
* third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral * third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral
......
...@@ -32,15 +32,15 @@ ...@@ -32,15 +32,15 @@
* \brief Board specific LED driver header for the Busware CULV3. * \brief Board specific LED driver header for the Busware CULV3.
* \copydetails Group_LEDs_CULV3 * \copydetails Group_LEDs_CULV3
* *
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver * \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h. * dispatch header located in LUFA/Drivers/Board/LEDs.h.
*/ */
/** \ingroup Group_LEDs /** \ingroup Group_Buttons
* \defgroup Group_LEDs_CULV3 CULV3 * \defgroup Group_Buttons_CULV3 CULV3
* \brief Board specific LED driver header for the Busware CULV3. * \brief Board specific Buttons driver header for the Busware CULV3.
* *
* Board specific LED driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL). * Board specific Buttons driver header for the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL).
* *
* @{ * @{
*/ */
......
...@@ -128,7 +128,7 @@ ...@@ -128,7 +128,7 @@
* are deselected. * are deselected.
* *
* \param[in] PageAddress Address of the page to manipulate, ranging from * \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/ */
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{ {
...@@ -163,7 +163,7 @@ ...@@ -163,7 +163,7 @@
} }
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address. * dataflash commands which require a complete 24-bit address.
* *
* \param[in] PageAddress Page address within the selected dataflash IC * \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer * \param[in] BufferByte Address within the dataflash's buffer
......
...@@ -128,7 +128,7 @@ ...@@ -128,7 +128,7 @@
* are deselected. * are deselected.
* *
* \param[in] PageAddress Address of the page to manipulate, ranging from * \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/ */
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{ {
...@@ -163,7 +163,7 @@ ...@@ -163,7 +163,7 @@
} }
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address. * dataflash commands which require a complete 24-bit address.
* *
* \param[in] PageAddress Page address within the selected dataflash IC * \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer * \param[in] BufferByte Address within the dataflash's buffer
......
...@@ -128,7 +128,7 @@ ...@@ -128,7 +128,7 @@
* are deselected. * are deselected.
* *
* \param[in] PageAddress Address of the page to manipulate, ranging from * \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/ */
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{ {
...@@ -163,7 +163,7 @@ ...@@ -163,7 +163,7 @@
} }
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address. * dataflash commands which require a complete 24-bit address.
* *
* \param[in] PageAddress Page address within the selected dataflash IC * \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer * \param[in] BufferByte Address within the dataflash's buffer
......
...@@ -131,7 +131,7 @@ ...@@ -131,7 +131,7 @@
* are deselected. * are deselected.
* *
* \param[in] PageAddress Address of the page to manipulate, ranging from * \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/ */
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{ {
...@@ -169,7 +169,7 @@ ...@@ -169,7 +169,7 @@
} }
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address. * dataflash commands which require a complete 24-bit address.
* *
* \param[in] PageAddress Page address within the selected dataflash IC * \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer * \param[in] BufferByte Address within the dataflash's buffer
......
...@@ -134,7 +134,7 @@ ...@@ -134,7 +134,7 @@
* are deselected. * are deselected.
* *
* \param[in] PageAddress Address of the page to manipulate, ranging from * \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/ */
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
{ {
...@@ -169,7 +169,7 @@ ...@@ -169,7 +169,7 @@
} }
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address. * dataflash commands which require a complete 24-bit address.
* *
* \param[in] PageAddress Page address within the selected dataflash IC * \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer * \param[in] BufferByte Address within the dataflash's buffer
......
...@@ -56,7 +56,7 @@ ...@@ -56,7 +56,7 @@
* It provides a way to easily configure and check the status of all the buttons on the board so that appropriate * It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
* actions can be taken. * actions can be taken.
* *
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file. * directory. Otherwise, it will include the appropriate built in board driver header file.
* *
* For possible \c BOARD makefile values, see \ref Group_BoardTypes. * For possible \c BOARD makefile values, see \ref Group_BoardTypes.
......
...@@ -176,7 +176,7 @@ ...@@ -176,7 +176,7 @@
* are deselected. * are deselected.
* *
* \param[in] PageAddress Address of the page to manipulate, ranging from * \param[in] PageAddress Address of the page to manipulate, ranging from
* ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
*/ */
static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress); static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress);
...@@ -191,7 +191,7 @@ ...@@ -191,7 +191,7 @@
static inline void Dataflash_WaitWhileBusy(void); static inline void Dataflash_WaitWhileBusy(void);
/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
* dataflash commands which require a complete 24-byte address. * dataflash commands which require a complete 24-bit address.
* *
* \param[in] PageAddress Page address within the selected dataflash IC * \param[in] PageAddress Page address within the selected dataflash IC
* \param[in] BufferByte Address within the dataflash's buffer * \param[in] BufferByte Address within the dataflash's buffer
......
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
* Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
* located on many boards. * located on many boards.
* *
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file. * directory. Otherwise, it will include the appropriate built in board driver header file.
* *
* For possible \c BOARD makefile values, see \ref Group_BoardTypes. * For possible \c BOARD makefile values, see \ref Group_BoardTypes.
......
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
* Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It * Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
* provides an interface to configure, test and change the status of all the board LEDs. * provides an interface to configure, test and change the status of all the board LEDs.
* *
* If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/LEDs.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file. If the BOARD value * directory. Otherwise, it will include the appropriate built in board driver header file. If the BOARD value
* is set to \c BOARD_NONE, this driver is silently disabled. * is set to \c BOARD_NONE, this driver is silently disabled.
* *
......
...@@ -145,7 +145,7 @@ ...@@ -145,7 +145,7 @@
/** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out MSB first. */ /** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out MSB first. */
#define SPI_ORDER_MSB_FIRST (0 << DORD) #define SPI_ORDER_MSB_FIRST (0 << DORD)
/** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out MSB first. */ /** SPI data order mask for \c SPI_Init(). Indicates that data should be shifted out LSB first. */
#define SPI_ORDER_LSB_FIRST (1 << DORD) #define SPI_ORDER_LSB_FIRST (1 << DORD)
//@} //@}
......
/* /*
LUFA Library
Copyright (C) Dean Camera, 2011. Copyright (C) Dean Camera, 2011.
dean [at] fourwalledcubicle [dot] com dean [at] fourwalledcubicle [dot] com
www.lufa-lib.org www.lufa-lib.org
*/ */
/*
Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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
software, including all implied warranties of merchantability
and fitness. In no event shall the author be liable for any
special, indirect or consequential damages or any damages
whatsoever resulting from loss of use, data or profits, whether
in an action of contract, negligence or other tortious action,
arising out of or in connection with the use or performance of
this software.
*/
#define __INCLUDE_FROM_TWI_C #define __INCLUDE_FROM_TWI_C
#include "../TWI.h" #include "../TWI.h"
......
...@@ -477,7 +477,7 @@ ...@@ -477,7 +477,7 @@
uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device. */ uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device. */
uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit. */ uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit. */
uint8_t ControlSize; /**< Size of each element in the \c ChanelControlls array. */ uint8_t ControlSize; /**< Size of each element in the \c ChannelControls array. */
uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */ uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
...@@ -506,7 +506,7 @@ ...@@ -506,7 +506,7 @@
uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */ uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */
uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */ uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */
uint8_t bControlSize; /**< Size of each element in the \c ChanelControlls array. */ uint8_t bControlSize; /**< Size of each element in the \c ChannelControls array. */
uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */ uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */
uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */ uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */
......
...@@ -132,7 +132,7 @@ ...@@ -132,7 +132,7 @@
/** SCSI Sense Code to indicate an error whilst accessing the medium. */ /** SCSI Sense Code to indicate an error whilst accessing the medium. */
#define SCSI_SENSE_KEY_MEDIUM_ERROR 0x03 #define SCSI_SENSE_KEY_MEDIUM_ERROR 0x03
/** SCSI Sense Code to indicate a hardware has occurred. */ /** SCSI Sense Code to indicate a hardware error has occurred. */
#define SCSI_SENSE_KEY_HARDWARE_ERROR 0x04 #define SCSI_SENSE_KEY_HARDWARE_ERROR 0x04
/** SCSI Sense Code to indicate that an illegal request has been issued. */ /** SCSI Sense Code to indicate that an illegal request has been issued. */
......
...@@ -218,7 +218,7 @@ ...@@ -218,7 +218,7 @@
/** Reads the next 8-bit audio sample from the current audio interface. /** Reads the next 8-bit audio sample from the current audio interface.
* *
* \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure
* ensure the correct endpoint is selected and ready for data. * that the correct endpoint is selected and ready for data.
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
* *
......
...@@ -81,13 +81,13 @@ ...@@ -81,13 +81,13 @@
{ {
uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */ uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */
uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused). */ uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI IN data, if available (zero if unused). */
uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused). */ uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI IN data endpoint, if available (zero if unused). */
bool DataINEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */ bool DataINEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */
uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused). */ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI OUT data, if available (zero if unused). */
uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused). */ uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI OUT data endpoint, if available (zero if unused). */
bool DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */ bool DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's OUT data endpoint should use double banking. */
} Config; /**< Config data for the USB class interface within the device. All elements in this section } Config; /**< Config data for the USB class interface within the device. All elements in this section
* <b>must</b> be set or the interface will fail to enumerate and operate correctly. * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
*/ */
......
...@@ -79,23 +79,23 @@ ...@@ -79,23 +79,23 @@
{ {
const struct const struct
{ {
uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device. */ uint8_t ControlInterfaceNumber; /**< Interface number of the RNDIS control interface within the device. */
uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint. */ uint8_t DataINEndpointNumber; /**< Endpoint number of the RNDIS interface's IN data endpoint. */
uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint. */ uint16_t DataINEndpointSize; /**< Size in bytes of the RNDIS interface's IN data endpoint. */
bool DataINEndpointDoubleBank; /**< Indicates if the RNDIS interface's IN data endpoint should use double banking. */ bool DataINEndpointDoubleBank; /**< Indicates if the RNDIS interface's IN data endpoint should use double banking. */
uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint. */ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the RNDIS interface's OUT data endpoint. */
uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint. */ uint16_t DataOUTEndpointSize; /**< Size in bytes of the RNDIS interface's OUT data endpoint. */
bool DataOUTEndpointDoubleBank; /**< Indicates if the RNDIS interface's OUT data endpoint should use double banking. */ bool DataOUTEndpointDoubleBank; /**< Indicates if the RNDIS interface's OUT data endpoint should use double banking. */
uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used. */ uint8_t NotificationEndpointNumber; /**< Endpoint number of the RNDIS interface's IN notification endpoint, if used. */
uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used. */ uint16_t NotificationEndpointSize; /**< Size in bytes of the RNDIS interface's IN notification endpoint, if used. */
bool NotificationEndpointDoubleBank; /**< Indicates if the RNDIS interface's notification endpoint should use double banking. */ bool NotificationEndpointDoubleBank; /**< Indicates if the RNDIS interface's notification endpoint should use double banking. */
char* AdapterVendorDescription; /**< String description of the adapter vendor. */ char* AdapterVendorDescription; /**< String description of the adapter vendor. */
MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter. */ MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter. */
} Config; /**< Config data for the USB class interface within the device. All elements in this section. } Config; /**< Config data for the USB class interface within the device. All elements in this section
* <b>must</b> be set or the interface will fail to enumerate and operate correctly. * <b>must</b> be set or the interface will fail to enumerate and operate correctly.
*/ */
struct struct
...@@ -114,7 +114,7 @@ ...@@ -114,7 +114,7 @@
/* Function Prototypes: */ /* Function Prototypes: */
/** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
* containing the given HID interface is selected. * 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 * \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 * interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
...@@ -133,7 +133,7 @@ ...@@ -133,7 +133,7 @@
*/ */
void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
/** General management task for a given HID class interface, required for the correct operation of the interface. This should /** General management task for a given RNDIS class interface, required for the correct operation of the interface. This should
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
* *
* \param[in,out] RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state. * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment