LUFADescriptors.h File Reference

#include <avr/pgmspace.h>
#include <LUFA/Drivers/USB/USB.h>

Go to the source code of this file.

Classes
struct	USB_Descriptor_Configuration_t

Macros
#define	CDC_NOTIFICATION_EPADDR   (ENDPOINT_DIR_IN | 2)
#define	CDC_TX_EPADDR   (ENDPOINT_DIR_IN | 3)
#define	CDC_RX_EPADDR   (ENDPOINT_DIR_OUT | 4)
#define	CDC_NOTIFICATION_EPSIZE   8
#define	CDC_TXRX_EPSIZE   16

Functions
uint16_t	CALLBACK_USB_GetDescriptor (const uint16_t wValue, const uint8_t wIndex, const void **const DescriptorAddress) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3)

Detailed Description

Header file for Descriptors.c.

Macro Definition Documentation

CDC_NOTIFICATION_EPADDR

#define CDC_NOTIFICATION_EPADDR   (ENDPOINT_DIR_IN | 2)

Endpoint address of the CDC device-to-host notification IN endpoint.

CDC_TX_EPADDR

#define CDC_TX_EPADDR   (ENDPOINT_DIR_IN | 3)

Endpoint address of the CDC device-to-host data IN endpoint.

CDC_RX_EPADDR

#define CDC_RX_EPADDR   (ENDPOINT_DIR_OUT | 4)

Endpoint address of the CDC host-to-device data OUT endpoint.

CDC_NOTIFICATION_EPSIZE

#define CDC_NOTIFICATION_EPSIZE   8

Size in bytes of the CDC device-to-host notification IN endpoint.

CDC_TXRX_EPSIZE

#define CDC_TXRX_EPSIZE   16

Size in bytes of the CDC data IN and OUT endpoints.

Function Documentation

CALLBACK_USB_GetDescriptor()

uint16_t CALLBACK_USB_GetDescriptor	(	const uint16_t	wValue,
		const uint8_t	wIndex,
		const void **const	DescriptorAddress
	)

This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors" documentation) by the application code so that the address and size of a requested descriptor can be given to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the USB host.