Seperated out OTG, Device and Host mode demos into seperate folders for clarity....
[pub/lufa.git] / Demos / Device / MassStorage / Descriptors.c
diff --git a/Demos/Device/MassStorage/Descriptors.c b/Demos/Device/MassStorage/Descriptors.c
new file mode 100644 (file)
index 0000000..a617315
--- /dev/null
@@ -0,0 +1,223 @@
+/*\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  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
+/** 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:              0x2045,\r
+       ReleaseNumber:          0x0000,\r
+               \r
+       ManufacturerStrIndex:   0x01,\r
+       ProductStrIndex:        0x02,\r
+       SerialNumStrIndex:      0x03,\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,\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:        0,\r
+                       AlternateSetting:       0,\r
+                       \r
+                       TotalEndpoints:         2,\r
+                               \r
+                       Class:                  0x08,\r
+                       SubClass:               0x06,\r
+                       Protocol:               0x50,\r
+                               \r
+                       InterfaceStrIndex:      NO_DESCRIPTOR\r
+               },\r
+\r
+       DataInEndpoint:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+\r
+                       EndpointAddress:        (ENDPOINT_DESCRIPTOR_DIR_IN | MASS_STORAGE_IN_EPNUM),\r
+                       Attributes:             EP_TYPE_BULK,\r
+                       EndpointSize:           MASS_STORAGE_IO_EPSIZE,\r
+                       PollingIntervalMS:      0x00\r
+               },\r
+\r
+       DataOutEndpoint:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+\r
+                       EndpointAddress:        (ENDPOINT_DESCRIPTOR_DIR_OUT | MASS_STORAGE_OUT_EPNUM),\r
+                       Attributes:             EP_TYPE_BULK,\r
+                       EndpointSize:           MASS_STORAGE_IO_EPSIZE,\r
+                       PollingIntervalMS:      0x00\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(11), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          L"Dean Camera"\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(22), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          L"LUFA Mass Storage Demo"\r
+};\r
+\r
+/** Serial number descriptor string. This is a Unicode string containing a string of HEX characters at least 12\r
+ *  digits in length to uniquely identify a device when concatenated with the device's Vendor and Product IDs. By\r
+ *  using the unique serial number string to identify a device, the device drivers do not need to be reinstalled\r
+ *  each time the device is inserted into a different USB port on the same system. <b>This should be unique between\r
+ *  devices, or conflicts will occur if two devices sharing the same serial number are inserted into the same system\r
+ *  at the same time.</b>\r
+ */\r
+USB_Descriptor_String_t PROGMEM SerialNumberString =\r
+{\r
+       Header:                 {Size: USB_STRING_LEN(12), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          L"000000000000"\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
+                               case 0x03:\r
+                                       Address = DESCRIPTOR_ADDRESS(SerialNumberString);\r
+                                       Size    = pgm_read_byte(&SerialNumberString.Header.Size);\r
+                                       break;\r
+                       }\r
+                       \r
+                       break;\r
+       }\r
+       \r
+       *DescriptorAddress = Address;\r
+       return Size;\r
+}\r