diff options
Diffstat (limited to 'Projects/TempDataLogger/Descriptors.c')
| -rw-r--r-- | Projects/TempDataLogger/Descriptors.c | 257 | 
1 files changed, 257 insertions, 0 deletions
| diff --git a/Projects/TempDataLogger/Descriptors.c b/Projects/TempDataLogger/Descriptors.c new file mode 100644 index 0000000000..c07a588782 --- /dev/null +++ b/Projects/TempDataLogger/Descriptors.c @@ -0,0 +1,257 @@ +/* +             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 + * + *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special + *  computer-readable structures which the host requests upon device enumeration, to determine + *  the device's capabilities and functions. + */ + +#include "Descriptors.h" + + +/** HID class report descriptor. This is a special descriptor constructed with values from the + *  USBIF HID class specification to describe the reports and capabilities of the HID device. This + *  descriptor is parsed by the host and its contents used to determine what data (and in what encoding) + *  the device will send, and what it may be sent back from the host. Refer to the HID specification for + *  more details on HID report descriptors. + */ +const USB_Descriptor_HIDReport_Datatype_t PROGMEM GenericReport[] = +{ +	/* Use the HID class driver's standard Vendor HID report. +	 *  Vendor Usage Page: 1 +	 *  Vendor Collection Usage: 1 +	 *  Vendor Report IN Usage: 2 +	 *  Vendor Report OUT Usage: 3 +	 *  Vendor Report Size: GENERIC_REPORT_SIZE +	 */ +	HID_DESCRIPTOR_VENDOR(0x00, 0x01, 0x02, 0x03, GENERIC_REPORT_SIZE) +}; + +/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall + *  device characteristics, including the supported USB version, control endpoint size and the + *  number of device configurations. The descriptor is read out by the USB host when the enumeration + *  process begins. + */ +const USB_Descriptor_Device_t PROGMEM DeviceDescriptor = +{ +	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device}, + +	.USBSpecification       = VERSION_BCD(1,1,0), +	.Class                  = USB_CSCP_NoDeviceClass, +	.SubClass               = USB_CSCP_NoDeviceSubclass, +	.Protocol               = USB_CSCP_NoDeviceProtocol, + +	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE, + +	.VendorID               = 0x03EB, +	.ProductID              = 0x2063, +	.ReleaseNumber          = VERSION_BCD(0,0,1), + +	.ManufacturerStrIndex   = STRING_ID_Manufacturer, +	.ProductStrIndex        = STRING_ID_Product, +	.SerialNumStrIndex      = USE_INTERNAL_SERIAL, + +	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS +}; + +/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage + *  of the device in one of its supported configurations, including information about any device interfaces + *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting + *  a configuration so that the host may correctly communicate with the USB device. + */ +const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor = +{ +	.Config = +		{ +			.Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration}, + +			.TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t), +			.TotalInterfaces        = 2, + +			.ConfigurationNumber    = 1, +			.ConfigurationStrIndex  = NO_DESCRIPTOR, + +			.ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED), + +			.MaxPowerConsumption    = USB_CONFIG_POWER_MA(100) +		}, + +	.MS_Interface = +		{ +			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface}, + +			.InterfaceNumber        = INTERFACE_ID_MassStorage, +			.AlternateSetting       = 0, + +			.TotalEndpoints         = 2, + +			.Class                  = MS_CSCP_MassStorageClass, +			.SubClass               = MS_CSCP_SCSITransparentSubclass, +			.Protocol               = MS_CSCP_BulkOnlyTransportProtocol, + +			.InterfaceStrIndex      = NO_DESCRIPTOR +		}, + +	.MS_DataInEndpoint = +		{ +			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint}, + +			.EndpointAddress        = MASS_STORAGE_IN_EPADDR, +			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), +			.EndpointSize           = MASS_STORAGE_IO_EPSIZE, +			.PollingIntervalMS      = 0x05 +		}, + +	.MS_DataOutEndpoint = +		{ +			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint}, + +			.EndpointAddress        = MASS_STORAGE_OUT_EPADDR, +			.Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), +			.EndpointSize           = MASS_STORAGE_IO_EPSIZE, +			.PollingIntervalMS      = 0x05 +		}, + +	.HID_Interface = +		{ +			.Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface}, + +			.InterfaceNumber        = INTERFACE_ID_HID, +			.AlternateSetting       = 0, + +			.TotalEndpoints         = 1, + +			.Class                  = HID_CSCP_HIDClass, +			.SubClass               = HID_CSCP_NonBootSubclass, +			.Protocol               = HID_CSCP_NonBootProtocol, + +			.InterfaceStrIndex      = NO_DESCRIPTOR +		}, + +	.HID_GenericHID = +		{ +			.Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID}, + +			.HIDSpec                = VERSION_BCD(1,1,1), +			.CountryCode            = 0x00, +			.TotalReportDescriptors = 1, +			.HIDReportType          = HID_DTYPE_Report, +			.HIDReportLength        = sizeof(GenericReport) +		}, + +	.HID_ReportINEndpoint = +		{ +			.Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint}, + +			.EndpointAddress        = GENERIC_IN_EPADDR, +			.Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), +			.EndpointSize           = GENERIC_EPSIZE, +			.PollingIntervalMS      = 0x05 +		}, +}; + +/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests + *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate + *  via the language ID table available at USB.org what languages the device supports for its string descriptors. + */ +const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG); + +/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable + *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device + *  Descriptor. + */ +const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera"); + +/** Product descriptor string. This is a Unicode string containing the product's details in human readable form, + *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device + *  Descriptor. + */ +const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"Temperature Datalogger"); + +/** 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. + */ +uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, +                                    const uint16_t wIndex, +                                    const void** const DescriptorAddress) +{ +	const uint8_t  DescriptorType   = (wValue >> 8); +	const uint8_t  DescriptorNumber = (wValue & 0xFF); + +	const void* Address = NULL; +	uint16_t    Size    = NO_DESCRIPTOR; + +	switch (DescriptorType) +	{ +		case DTYPE_Device: +			Address = &DeviceDescriptor; +			Size    = sizeof(USB_Descriptor_Device_t); +			break; +		case DTYPE_Configuration: +			Address = &ConfigurationDescriptor; +			Size    = sizeof(USB_Descriptor_Configuration_t); +			break; +		case DTYPE_String: +			switch (DescriptorNumber) +			{ +				case STRING_ID_Language: +					Address = &LanguageString; +					Size    = pgm_read_byte(&LanguageString.Header.Size); +					break; +				case STRING_ID_Manufacturer: +					Address = &ManufacturerString; +					Size    = pgm_read_byte(&ManufacturerString.Header.Size); +					break; +				case STRING_ID_Product: +					Address = &ProductString; +					Size    = pgm_read_byte(&ProductString.Header.Size); +					break; +			} + +			break; +		case HID_DTYPE_HID: +			Address = &ConfigurationDescriptor.HID_GenericHID; +			Size    = sizeof(USB_HID_Descriptor_HID_t); +			break; +		case HID_DTYPE_Report: +			Address = &GenericReport; +			Size    = sizeof(GenericReport); +			break; +	} + +	*DescriptorAddress = Address; +	return Size; +} + | 
