--- /dev/null
+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2009.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2009 Denver Gingerich (denver [at] ossguy [dot] com)\r
+ Based on code by Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, and distribute this software\r
+ and its documentation for any purpose and without fee is hereby\r
+ granted, provided that the above copyright notice appear in all\r
+ copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting\r
+ documentation, and that the name of the author not be used in\r
+ advertising or publicity pertaining to distribution of the\r
+ software without specific, written prior permission.\r
+\r
+ The author disclaim all warranties with regard to this\r
+ software, including all implied warranties of merchantability\r
+ and fitness. In no event shall the author be liable for any\r
+ special, indirect or consequential damages or any damages\r
+ whatsoever resulting from loss of use, data or profits, whether\r
+ in an action of contract, negligence or other tortious action,\r
+ arising out of or in connection with the use or performance of\r
+ this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ * USB Device Descriptors, for library use when in USB device mode. Descriptors are special \r
+ * computer-readable structures which the host requests upon device enumeration, to determine\r
+ * the device's capabilities and functions. \r
+ */\r
+ \r
+#include "Descriptors.h"\r
+\r
+/** HID class report descriptor. This is a special descriptor constructed with values from the\r
+ * USBIF HID class specification to describe the reports and capabilities of the HID device. This\r
+ * descriptor is parsed by the host and its contents used to determine what data (and in what encoding)\r
+ * the device will send, and what it may be sent back from the host. Refer to the HID specification for\r
+ * more details on HID report descriptors.\r
+ */\r
+USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =\r
+{\r
+ 0x05, 0x01, /* Usage Page (Generic Desktop) */\r
+ 0x09, 0x06, /* Usage (Keyboard) */\r
+ 0xa1, 0x01, /* Collection (Application) */\r
+ 0x75, 0x01, /* Report Size (1) */\r
+ 0x95, 0x08, /* Report Count (8) */\r
+ 0x05, 0x07, /* Usage Page (Key Codes) */\r
+ 0x19, 0xe0, /* Usage Minimum (Keyboard LeftControl) */\r
+ 0x29, 0xe7, /* Usage Maximum (Keyboard Right GUI) */\r
+ 0x15, 0x00, /* Logical Minimum (0) */\r
+ 0x25, 0x01, /* Logical Maximum (1) */\r
+ 0x81, 0x02, /* Input (Data, Variable, Absolute) */\r
+ 0x95, 0x01, /* Report Count (1) */\r
+ 0x75, 0x08, /* Report Size (8) */\r
+ 0x81, 0x03, /* Input (Const, Variable, Absolute) */\r
+ 0x95, 0x05, /* Report Count (5) */\r
+ 0x75, 0x01, /* Report Size (1) */\r
+ 0x05, 0x08, /* Usage Page (LEDs) */\r
+ 0x19, 0x01, /* Usage Minimum (Num Lock) */\r
+ 0x29, 0x05, /* Usage Maximum (Kana) */\r
+ 0x91, 0x02, /* Output (Data, Variable, Absolute) */\r
+ 0x95, 0x01, /* Report Count (1) */\r
+ 0x75, 0x03, /* Report Size (3) */\r
+ 0x91, 0x03, /* Output (Const, Variable, Absolute) */\r
+ 0x95, 0x06, /* Report Count (6) */\r
+ 0x75, 0x08, /* Report Size (8) */\r
+ 0x15, 0x00, /* Logical Minimum (0) */\r
+ 0x25, 0x65, /* Logical Maximum (101) */\r
+ 0x05, 0x07, /* Usage Page (Keyboard) */\r
+ 0x19, 0x00, /* Usage Minimum (Reserved (no event indicated)) */\r
+ 0x29, 0x65, /* Usage Maximum (Keyboard Application) */\r
+ 0x81, 0x00, /* Input (Data, Array, Absolute) */\r
+ 0xc0 /* End Collection */\r
+};\r
+\r
+/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall\r
+ * device characteristics, including the supported USB version, control endpoint size and the\r
+ * number of device configurations. The descriptor is read out by the USB host when the enumeration\r
+ * process begins.\r
+ */\r
+USB_Descriptor_Device_t PROGMEM DeviceDescriptor =\r
+{\r
+ Header: {Size: sizeof(USB_Descriptor_Device_t), Type: DTYPE_Device},\r
+ \r
+ USBSpecification: VERSION_BCD(01.10),\r
+ Class: 0x00,\r
+ SubClass: 0x00, \r
+ Protocol: 0x00,\r
+ \r
+ Endpoint0Size: 8,\r
+ \r
+ VendorID: 0x03EB,\r
+ ProductID: 0x2042,\r
+ ReleaseNumber: 0x0000,\r
+ \r
+ ManufacturerStrIndex: 0x01,\r
+ ProductStrIndex: 0x02,\r
+ SerialNumStrIndex: NO_DESCRIPTOR,\r
+ \r
+ NumberOfConfigurations: 1\r
+};\r
+\r
+/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage\r
+ * of the device in one of its supported configurations, including information about any device interfaces\r
+ * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting\r
+ * a configuration so that the host may correctly communicate with the USB device.\r
+ */\r
+USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =\r
+{\r
+ Config:\r
+ {\r
+ Header: {Size: sizeof(USB_Descriptor_Configuration_Header_t), Type: DTYPE_Configuration},\r
+\r
+ TotalConfigurationSize: sizeof(USB_Descriptor_Configuration_t),\r
+ TotalInterfaces: 1,\r
+ \r
+ ConfigurationNumber: 1,\r
+ ConfigurationStrIndex: NO_DESCRIPTOR,\r
+ \r
+ ConfigAttributes: (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),\r
+ \r
+ MaxPowerConsumption: USB_CONFIG_POWER_MA(100)\r
+ },\r
+ \r
+ Interface:\r
+ {\r
+ Header: {Size: sizeof(USB_Descriptor_Interface_t), Type: DTYPE_Interface},\r
+\r
+ InterfaceNumber: 0x00,\r
+ AlternateSetting: 0x00,\r
+ \r
+ TotalEndpoints: 2,\r
+ \r
+ Class: 0x03,\r
+ SubClass: 0x01,\r
+ Protocol: 0x01,\r
+ \r
+ InterfaceStrIndex: NO_DESCRIPTOR\r
+ },\r
+\r
+ KeyboardHID:\r
+ { \r
+ Header: {Size: sizeof(USB_Descriptor_HID_t), Type: DTYPE_HID},\r
+ \r
+ HIDSpec: VERSION_BCD(01.11),\r
+ CountryCode: 0x00,\r
+ TotalHIDReports: 0x01,\r
+ HIDReportType: DTYPE_Report,\r
+ HIDReportLength: sizeof(KeyboardReport) \r
+ },\r
+ \r
+ KeyboardEndpoint:\r
+ {\r
+ Header: {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+\r
+ EndpointAddress: (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_EPNUM),\r
+ Attributes: EP_TYPE_INTERRUPT,\r
+ EndpointSize: KEYBOARD_EPSIZE,\r
+ PollingIntervalMS: 0x02\r
+ },\r
+\r
+ KeyboardLEDsEndpoint:\r
+ {\r
+ Header: {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+\r
+ EndpointAddress: (ENDPOINT_DESCRIPTOR_DIR_OUT | KEYBOARD_LEDS_EPNUM),\r
+ Attributes: EP_TYPE_INTERRUPT,\r
+ EndpointSize: KEYBOARD_EPSIZE,\r
+ PollingIntervalMS: 0x02\r
+ }\r
+};\r
+\r
+/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests\r
+ * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate\r
+ * via the language ID table available at USB.org what languages the device supports for its string descriptors.\r
+ */\r
+USB_Descriptor_String_t PROGMEM LanguageString =\r
+{\r
+ Header: {Size: USB_STRING_LEN(1), Type: DTYPE_String},\r
+ \r
+ UnicodeString: {LANGUAGE_ID_ENG}\r
+};\r
+\r
+/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable\r
+ * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device\r
+ * Descriptor.\r
+ */\r
+USB_Descriptor_String_t PROGMEM ManufacturerString =\r
+{\r
+ Header: {Size: USB_STRING_LEN(16), Type: DTYPE_String},\r
+ \r
+ UnicodeString: L"Denver Gingerich"\r
+};\r
+\r
+/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,\r
+ * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device\r
+ * Descriptor.\r
+ */\r
+USB_Descriptor_String_t PROGMEM ProductString =\r
+{\r
+ Header: {Size: USB_STRING_LEN(18), Type: DTYPE_String},\r
+ \r
+ UnicodeString: L"LUFA Keyboard Demo"\r
+};\r
+\r
+/** This function is called by the library when in device mode, and must be overridden (see StdDescriptors.h\r
+ * documentation) by the application code so that the address and size of a requested descriptor can be given\r
+ * to the USB library. When the device recieves a Get Descriptor request on the control endpoint, this function\r
+ * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the\r
+ * USB host.\r
+ */\r
+uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
+{\r
+ const uint8_t DescriptorType = (wValue >> 8);\r
+ const uint8_t DescriptorNumber = (wValue & 0xFF);\r
+\r
+ void* Address = NULL;\r
+ uint16_t Size = NO_DESCRIPTOR;\r
+\r
+ switch (DescriptorType)\r
+ {\r
+ case DTYPE_Device:\r
+ Address = DESCRIPTOR_ADDRESS(DeviceDescriptor);\r
+ Size = sizeof(USB_Descriptor_Device_t);\r
+ break;\r
+ case DTYPE_Configuration:\r
+ Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor);\r
+ Size = sizeof(USB_Descriptor_Configuration_t);\r
+ break;\r
+ case DTYPE_String:\r
+ switch (DescriptorNumber)\r
+ {\r
+ case 0x00:\r
+ Address = DESCRIPTOR_ADDRESS(LanguageString);\r
+ Size = pgm_read_byte(&LanguageString.Header.Size);\r
+ break;\r
+ case 0x01:\r
+ Address = DESCRIPTOR_ADDRESS(ManufacturerString);\r
+ Size = pgm_read_byte(&ManufacturerString.Header.Size);\r
+ break;\r
+ case 0x02:\r
+ Address = DESCRIPTOR_ADDRESS(ProductString);\r
+ Size = pgm_read_byte(&ProductString.Header.Size);\r
+ break;\r
+ }\r
+ \r
+ break;\r
+ case DTYPE_HID:\r
+ Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor.KeyboardHID);\r
+ Size = sizeof(USB_Descriptor_HID_t);\r
+ break;\r
+ case DTYPE_Report:\r
+ Address = DESCRIPTOR_ADDRESS(KeyboardReport);\r
+ Size = sizeof(KeyboardReport);\r
+ break;\r
+ }\r
+ \r
+ *DescriptorAddress = Address;\r
+ return Size;\r
+}\r
projects / pub / lufa.git / blobdiff