diff options
Diffstat (limited to 'lib/lufa/Demos/Device/LowLevel/BulkVendor/Descriptors.h')
| -rw-r--r-- | lib/lufa/Demos/Device/LowLevel/BulkVendor/Descriptors.h | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/lib/lufa/Demos/Device/LowLevel/BulkVendor/Descriptors.h b/lib/lufa/Demos/Device/LowLevel/BulkVendor/Descriptors.h new file mode 100644 index 0000000000..939717ea3f --- /dev/null +++ b/lib/lufa/Demos/Device/LowLevel/BulkVendor/Descriptors.h @@ -0,0 +1,96 @@ +/* + LUFA Library + Copyright (C) Dean Camera, 2017. + + dean [at] fourwalledcubicle [dot] com + www.lufa-lib.org +*/ + +/* + Copyright 2017 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 disclaims 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. +*/ + +/** \file + * + * Header file for Descriptors.c. + */ + +#ifndef _DESCRIPTORS_H_ +#define _DESCRIPTORS_H_ + + /* Includes: */ + #include <LUFA/Drivers/USB/USB.h> + + #include <avr/pgmspace.h> + + /* Macros: */ + /** Endpoint address of the Bulk Vendor device-to-host data IN endpoint. */ + #define VENDOR_IN_EPADDR (ENDPOINT_DIR_IN | 3) + + /** Endpoint address of the Bulk Vendor host-to-device data OUT endpoint. */ + #define VENDOR_OUT_EPADDR (ENDPOINT_DIR_OUT | 4) + + /** Size in bytes of the Bulk Vendor data endpoints. */ + #define VENDOR_IO_EPSIZE 64 + + /* Type Defines: */ + /** Type define for the device configuration descriptor structure. This must be defined in the + * application code, as the configuration descriptor contains several sub-descriptors which + * vary between devices, and which describe the device's usage to the host. + */ + typedef struct + { + USB_Descriptor_Configuration_Header_t Config; + + // Vendor Interface + USB_Descriptor_Interface_t Vendor_Interface; + USB_Descriptor_Endpoint_t Vendor_DataInEndpoint; + USB_Descriptor_Endpoint_t Vendor_DataOutEndpoint; + } USB_Descriptor_Configuration_t; + + /** Enum for the device interface descriptor IDs within the device. Each interface descriptor + * should have a unique ID index associated with it, which can be used to refer to the + * interface from other descriptors. + */ + enum InterfaceDescriptors_t + { + INTERFACE_ID_Vendor = 0, /**< Vendor interface descriptor ID */ + }; + + /** Enum for the device string descriptor IDs within the device. Each string descriptor should + * have a unique ID index associated with it, which can be used to refer to the string from + * other descriptors. + */ + enum StringDescriptors_t + { + STRING_ID_Language = 0, /**< Supported Languages string descriptor ID (must be zero) */ + STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */ + STRING_ID_Product = 2, /**< Product string ID */ + }; + + /* Function Prototypes: */ + uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, + const uint16_t wIndex, + const void** const DescriptorAddress) + ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3); + +#endif + |