diff options
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/RNDIS.h | 14 | ||||
| -rw-r--r-- | LUFA/ManPages/DirectorySummaries.txt | 48 | ||||
| -rw-r--r-- | LUFA/ManPages/MigrationInformation.txt | 2 |
3 files changed, 32 insertions, 32 deletions
diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 138466b1a..41b235bdf 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -150,7 +150,7 @@ * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state. * - * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_COMMAND_FAILED if the device returned a + * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the device returned a * logical command failure. */ uint8_t RNDIS_Host_SendKeepAlive(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -160,8 +160,8 @@ * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state. * - * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_COMMAND_FAILED if the device returned a - * logical command failure. + * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the + * device returned a logical command failure. */ uint8_t RNDIS_Host_InitializeDevice(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -172,8 +172,8 @@ * \param[in] Buffer Pointer to where the property data is to be sourced from. * \param[in] Length Length in bytes of the property data to sent to the device. * - * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_COMMAND_FAILED if the device returned a - * logical command failure. + * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the + * device returned a logical command failure. */ uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, const uint32_t Oid, @@ -187,8 +187,8 @@ * \param[in] Buffer Pointer to where the property data is to be written to. * \param[in] MaxLength Length in bytes of the destination buffer size. * - * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_COMMAND_FAILED if the device returned a - * logical command failure. + * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum or \ref RNDIS_ERROR_LOGICAL_CMD_FAILED if the + * device returned a logical command failure. */ uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, const uint32_t Oid, diff --git a/LUFA/ManPages/DirectorySummaries.txt b/LUFA/ManPages/DirectorySummaries.txt index 504742bf5..9873ec5af 100644 --- a/LUFA/ManPages/DirectorySummaries.txt +++ b/LUFA/ManPages/DirectorySummaries.txt @@ -63,167 +63,167 @@ * the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of * hardware placed on supported boards. * - * \dir LUFA/Drivers/Board/ADAFRUITU4 + * \dir LUFA/Drivers/Board/AVR8/ADAFRUITU4 * \brief ADAFRUITU4 board hardware driver files. * * This folder contains drivers for hardware on the Adafruit U4 breakout board (http://ladyada.net/products/atmega32u4breakout). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. - * \dir LUFA/Drivers/Board/ATAVRUSBRF01 + * \dir LUFA/Drivers/Board/AVR8/ATAVRUSBRF01 * \brief ATAVRUSBRF01 board hardware driver files. * * This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo kits. The header * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in * the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/BENITO + * \dir LUFA/Drivers/Board/AVR8/BENITO * \brief BENITO board hardware driver files. * * This folder contains drivers for hardware on the Benito boards (http://dorkbotpdx.org/wiki/benito). The header files in this * folder should not be included directly in user applications; the similarly named dispatch header files located in the parent * Board directory should be included instead. * - * \dir LUFA/Drivers/Board/BUMBLEB + * \dir LUFA/Drivers/Board/AVR8/BUMBLEB * \brief BUMBLEB board hardware driver files. * * This folder contains drivers for hardware on the Fletchtronics Bumble-B board (http://fletchtronics.net/bumble-b). The header * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in * the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/BUI + * \dir LUFA/Drivers/Board/AVR8/BUI * \brief BUI board hardware driver files. * * This folder contains drivers for hardware on the Busware BUI (http://www.busware.de/tiki-index.php?page=BUI). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/BLACKCAT + * \dir LUFA/Drivers/Board/AVR8/BLACKCAT * \brief BLACKCAT board hardware driver files. * * This folder contains drivers for hardware on the TCNISO Blackcat USB JTAG (http://www.embeddedcomputers.net/products/BlackcatUSB/. * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/CULV3 + * \dir LUFA/Drivers/Board/AVR8/CULV3 * \brief CULV3 board hardware driver files. * * This folder contains drivers for hardware on the Busware CUL V3 (http://busware.de/tiki-index.php?page=CUL). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/EVK527 + * \dir LUFA/Drivers/Board/AVR8/EVK527 * \brief XPLAIN board hardware driver files. * * This folder contains drivers for hardware on the Atmel EVK527 development board. The header files in this folder should * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory * should be included instead. * - * \dir LUFA/Drivers/Board/JMDBU2 + * \dir LUFA/Drivers/Board/AVR8/JMDBU2 * \brief JM-DB-U2 board hardware driver files. * * This folder contains drivers for hardware on the JM-DB-U2 boards (http://u2.mattair.net/). The header files in this folder * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board * directory should be included instead. * - * \dir LUFA/Drivers/Board/MAXIMUS + * \dir LUFA/Drivers/Board/AVR8/MAXIMUS * \brief MAXIMUS board hardware driver files. * * This folder contains drivers for hardware on the Maximus boards (http://www.avrusb.com/). The header files in this folder * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board * directory should be included instead. * - * \dir LUFA/Drivers/Board/MICROSIN162 + * \dir LUFA/Drivers/Board/AVR8/MICROSIN162 * \brief MICROSIN162 board hardware driver files. * * This folder contains drivers for hardware on the Microsin AVR-USB162 board (http://microsin.ru/content/view/685/44/). The * header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/MINIMUS + * \dir LUFA/Drivers/Board/AVR8/MINIMUS * \brief MINIMUS board hardware driver files. * * This folder contains drivers for hardware on the Minimus boards (http://www.minimususb.com/). The header files in this folder * should not be included directly in user applications; the similarly named dispatch header files located in the parent Board * directory should be included instead. * - * \dir LUFA/Drivers/Board/OLIMEX162 + * \dir LUFA/Drivers/Board/AVR8/OLIMEX162 * \brief Olimex USB-STK-162 board hardware driver files. * * This folder contains drivers for hardware on the Olimex AVR-USB-162 boards (http://www.olimex.com/dev/avr-usb-162.html). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/RZUSBSTICK + * \dir LUFA/Drivers/Board/AVR8/RZUSBSTICK * \brief RZUSBSTICK board hardware driver files. * * This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header * files in this folder should not be included directly in user applications; the similarly named dispatch header files located in * the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/SPARKFUN8U2 + * \dir LUFA/Drivers/Board/AVR8/SPARKFUN8U2 * \brief SPARKFUN8U2 board hardware driver files. * * This folder contains drivers for hardware on the Sparkfun ATMEGA8U2 breakout board (http://www.sparkfun.com/products/10277). The * header files in this folder should not be included directly in user applications; the similarly named dispatch header files located * in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/STK525 + * \dir LUFA/Drivers/Board/AVR8/STK525 * \brief STK525 board hardware driver files. * * This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory * should be included instead. * - * \dir LUFA/Drivers/Board/STK526 + * \dir LUFA/Drivers/Board/AVR8/STK526 * \brief STK526 board hardware driver files. * * This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory * should be included instead. * - * \dir LUFA/Drivers/Board/TEENSY + * \dir LUFA/Drivers/Board/AVR8/TEENSY * \brief TEENSY board hardware driver files. * * This folder contains drivers for hardware on all revisions of the PJRC Teensy boards (http://www.pjrc.com/teensy/). The header * files in this folder should not be included directly in user applications; the similarly named dispatch header files located * in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/UDIP + * \dir LUFA/Drivers/Board/AVR8/UDIP * \brief UDIP board hardware driver files. * * This folder contains drivers for hardware on the Linnix UDIP boards (http://linnix.com/udip/). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/UNO + * \dir LUFA/Drivers/Board/AVR8/UNO * \brief UNO board hardware driver files. * * This folder contains drivers for hardware on the Arduino Uno boards (http://www.arduino.cc). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/USBFOO + * \dir LUFA/Drivers/Board/AVR8/USBFOO * \brief USBFOO board hardware driver files. * * This folder contains drivers for hardware on the USBFOO boards (http://shop.kernelconcepts.de/product_info.php?products_id=102). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/USBKEY + * \dir LUFA/Drivers/Board/AVR8/USBKEY * \brief USBKEY board hardware driver files. * * This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory * should be included instead. * - * \dir LUFA/Drivers/Board/USBTINYMKII + * \dir LUFA/Drivers/Board/AVR8/USBTINYMKII * \brief USBTINY-MKII board hardware driver files. * * This folder contains drivers for hardware on all revisions of the USBTINY-MKII boards (http://tom-itx.dyndns.org:81/~webpage/). * The header files in this folder should not be included directly in user applications; the similarly named dispatch header files * located in the parent Board directory should be included instead. * - * \dir LUFA/Drivers/Board/XPLAIN + * \dir LUFA/Drivers/Board/AVR8/XPLAIN * \brief XPLAIN board hardware driver files. * * This folder contains drivers for hardware on the Atmel XPLAIN board (all hardware revisions). The header files in this folder diff --git a/LUFA/ManPages/MigrationInformation.txt b/LUFA/ManPages/MigrationInformation.txt index d3782d317..796e7235a 100644 --- a/LUFA/ManPages/MigrationInformation.txt +++ b/LUFA/ManPages/MigrationInformation.txt @@ -53,7 +53,7 @@ * code using these functions should replace the previous function names with the new function names. * - The Device mode RNDIS class driver no longer stores the incoming and outgoing packets in the class driver instance; the user is * now expected to manually define a storage location for the packet data. Packets must now be sent and received manually via a call - * to \ref RNDIS_Device_ReadPacket() and/or \ref RNDIS_Device_WritePacket(). + * to \ref RNDIS_Device_ReadPacket() and/or \ref RNDIS_Device_SendPacket(). * * <b>Host Mode</b> * - The Pipe stream functions now all require a \c BytesProcessed parameter instead of the previous callback parameter. |