Commit 5e731905 authored by Dean Camera's avatar Dean Camera
Browse files

Start update of documentation to support possible multiple architectures in...

Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.
parent 1daa5e16
......@@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -54,8 +54,6 @@
#include "../../Core/StdDescriptors.h"
#include "HIDParser.h"
#include <string.h>
/* Preprocessor Checks: */
#if !defined(__INCLUDE_FROM_HID_DRIVER)
#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
......
......@@ -70,8 +70,6 @@
#include "HIDReportData.h"
#include "../Common/HID.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
......
......@@ -57,8 +57,6 @@
#include "../../Core/StdDescriptors.h"
#include "Audio.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -57,8 +57,6 @@
#include "../../Core/StdDescriptors.h"
#include "CDC.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -53,8 +53,6 @@
/* Includes: */
#include "../../Core/StdDescriptors.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/Audio.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -75,7 +75,6 @@
#include "../Common/CDC.h"
#include <stdio.h>
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
......
......@@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/HID.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/MIDI.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/MassStorage.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -57,8 +57,6 @@
#include "../../USB.h"
#include "../Common/RNDIS.h"
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -58,7 +58,6 @@
#include "../Common/CDC.h"
#include <stdio.h>
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
......
......@@ -58,9 +58,6 @@
#include "../../USB.h"
#include "../Common/RNDIS.h"
#include <stdio.h>
#include <string.h>
/* Enable C linkage for C++ Compilers: */
#if defined(__cplusplus)
extern "C" {
......
......@@ -29,9 +29,8 @@
*/
/** \file
* \brief USB device mode definitions (AVR8)
*
* This file contains structures, function prototypes and macros related to USB device mode.
* \brief USB Device definitions for the AVR8 microcontrollers.
* \copydetails Group_Device_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
......@@ -39,9 +38,9 @@
/** \ingroup Group_Device
* \defgroup Group_Device_AVR8 Device Management (AVR8)
* \brief USB Device definitions for the AVR8 microcontrollers.
*
* USB Device mode related macros and enums. This module contains macros and enums which are used when
* the USB controller is initialized in device mode.
* Architecture specific USB Device definitions for the Atmel 8-bit AVR microcontrollers.
*
* @{
*/
......@@ -55,17 +54,15 @@
#include "../USBInterrupt.h"
#include "../Endpoint.h"
#include <avr/boot.h>
/* Preprocessor Checks: */
#if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
#error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
#endif
#if !defined(__INCLUDE_FROM_USB_DRIVER)
#error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
#endif
#if (defined(USE_RAM_DESCRIPTORS) && defined(USE_EEPROM_DESCRIPTORS))
#error USE_RAM_DESCRIPTORS and USE_EEPROM_DESCRIPTORS are mutually exclusive.
#endif
/* Public Interface - May be used in end-application: */
/* Macros: */
/** \name USB Device Mode Option Masks */
......@@ -125,7 +122,7 @@
* the \ref USB_OPT_MANUAL_PLL option enabled, the user must ensure that the PLL is running
* before attempting to call this function.
*
* \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
* \see \ref Group_StdDescriptors for more information on the RMWAKEUP feature and device descriptors.
*/
void USB_Device_SendRemoteWakeup(void);
......@@ -192,40 +189,6 @@
}
#endif
/* Function Prototypes: */
/** Function to retrieve a given descriptor's size and memory location from the given descriptor type value,
* index and language ID. This function MUST be overridden in the user application (added with full, identical
* prototype and name so that the library can call it to retrieve descriptor data.
*
* \param[in] wValue The type of the descriptor to retrieve in the upper byte, and the index in the
* lower byte (when more than one descriptor of the given type exists, such as the
* case of string descriptors). The type may be one of the standard types defined
* in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
* \param[in] wIndex The language ID of the string to return if the \c wValue type indicates
* \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
* class-specific standards.
* \param[out] DescriptorAddress Pointer to the descriptor in memory. This should be set by the routine to
* the address of the descriptor.
* \param[out] MemoryAddressSpace A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
* space in which the descriptor is stored. This parameter does not exist when one
* of the \c USE_*_DESCRIPTORS compile time options is used.
*
* \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.
* If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
* allow the descriptors to be changed dynamically at runtime) either the \c USE_RAM_DESCRIPTORS or the
* \c USE_EEPROM_DESCRIPTORS tokens may be defined in the project makefile and passed to the compiler by the -D
* switch.
*
* \return Size in bytes of the descriptor if it exists, zero or \ref NO_DESCRIPTOR otherwise.
*/
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
const uint8_t wIndex,
const void** const DescriptorAddress
#if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
, uint8_t* MemoryAddressSpace
#endif
) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
/* Private Interface - For use in library only: */
#if !defined(__DOXYGEN__)
/* Inline Functions: */
......
......@@ -29,10 +29,8 @@
*/
/** \file
* \brief USB device endpoint management definitions.
*
* This file contains structures, function prototypes and macros related to the management of the device's
* data endpoints when the library is initialized in USB device mode.
* \brief USB Endpoint definitions for the AVR8 microcontrollers.
* \copydetails Group_EndpointManagement_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
......@@ -40,6 +38,7 @@
/** \ingroup Group_EndpointRW
* \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8)
* \brief USB Endpoint definitions for the AVR8 microcontrollers.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
*/
......
......@@ -29,9 +29,8 @@
*/
/** \file
* \brief USB host mode definitions (AVR8)
*
* This file contains structures, function prototypes and macros related to USB host mode.
* \brief USB Host definitions for the AVR8 microcontrollers.
* \copydetails Group_Host_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
......@@ -39,9 +38,9 @@
/** \ingroup Group_Host
* \defgroup Group_Host_AVR8 Host Management (AVR8)
* \brief USB Host definitions for the AVR8 microcontrollers.
*
* USB Host mode related macros and enums. This module contains macros and enums which are used when
* the USB controller is initialized in host mode.
* Architecture specific USB Host definitions for the Atmel 8-bit AVR microcontrollers.
*
* @{
*/
......
......@@ -29,10 +29,8 @@
*/
/** \file
* \brief USB OTG mode definitions (AVR8)
*
* This file contains structures, function prototypes and macros related to USB OTG mode, where two USB devices
* may be linked directly together and exchange host/device roles as needed.
* \brief USB OTG definitions for the AVR8 microcontrollers.
* \copydetails Group_OTG_AVR8
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
......@@ -40,10 +38,9 @@
/** \ingroup Group_OTG
* \defgroup Group_OTG_AVR8 USB On The Go (OTG) Management (AVR8)
* \brief USB OTG definitions for the AVR8 microcontrollers.
*
* This module contains macros for embedded USB hosts with dual role On The Go capabilities, for managing role
* exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host
* roles.
* Architecture specific USB OTG definitions for the Atmel 8-bit AVR microcontrollers.
*
* @{
*/
......
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