Add missing AVRISPDescriptors.c/.h files to the XPLAINBridge project.
authorDean Camera <dean@fourwalledcubicle.com>
Mon, 25 Jan 2010 13:07:54 +0000 (13:07 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Mon, 25 Jan 2010 13:07:54 +0000 (13:07 +0000)
Projects/XPLAINBridge/AVRISPDescriptors.c [new file with mode: 0644]
Projects/XPLAINBridge/AVRISPDescriptors.h [new file with mode: 0644]

diff --git a/Projects/XPLAINBridge/AVRISPDescriptors.c b/Projects/XPLAINBridge/AVRISPDescriptors.c
new file mode 100644 (file)
index 0000000..2f9db6a
--- /dev/null
@@ -0,0 +1,219 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2010.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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 "AVRISPDescriptors.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 AVRISP_DeviceDescriptor =\r
+{\r
+       .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},\r
+               \r
+       .USBSpecification       = VERSION_BCD(01.10),\r
+       .Class                  = 0xFF,\r
+       .SubClass               = 0x00,\r
+       .Protocol               = 0x00,\r
+                               \r
+       .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,\r
+               \r
+       .VendorID               = 0x03EB,\r
+       .ProductID              = 0x2104,\r
+       .ReleaseNumber          = VERSION_BCD(02.00),\r
+               \r
+       .ManufacturerStrIndex   = 0x01,\r
+       .ProductStrIndex        = 0x02,\r
+       .SerialNumStrIndex      = 0x03,\r
+               \r
+       .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS\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
+AVRISP_USB_Descriptor_Configuration_t PROGMEM AVRISP_ConfigurationDescriptor =\r
+{\r
+       .Config = \r
+               {\r
+                       .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},\r
+\r
+                       .TotalConfigurationSize = sizeof(AVRISP_USB_Descriptor_Configuration_t),\r
+                       .TotalInterfaces        = 1,\r
+                               \r
+                       .ConfigurationNumber    = 1,\r
+                       .ConfigurationStrIndex  = NO_DESCRIPTOR,\r
+                               \r
+                       .ConfigAttributes       = USB_CONFIG_ATTR_SELFPOWERED,\r
+                       \r
+                       .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)\r
+               },\r
+\r
+       .AVRISPInterface = \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                  = 0xFF,\r
+                       .SubClass               = 0x00,\r
+                       .Protocol               = 0x00,\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 | AVRISP_DATA_EPNUM),\r
+                       .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),\r
+                       .EndpointSize           = AVRISP_DATA_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 | AVRISP_DATA_EPNUM),\r
+                       .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),\r
+                       .EndpointSize           = AVRISP_DATA_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 AVRISP_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 AVRISP_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 AVRISP_ProductString =\r
+{\r
+       .Header                 = {.Size = USB_STRING_LEN(22), .Type = DTYPE_String},\r
+               \r
+       .UnicodeString          = L"LUFA AVRISP MkII Clone"\r
+};\r
+\r
+/** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a\r
+ *  series of uppercase hexadecimal digits.\r
+ */\r
+USB_Descriptor_String_t PROGMEM AVRISP_SerialString =\r
+{\r
+       .Header                 = {.Size = USB_STRING_LEN(13), .Type = DTYPE_String},\r
+               \r
+       .UnicodeString          = L"0000A00128255"\r
+};\r
+\r
+/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"\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 receives 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 AVRISP_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 = (void*)&AVRISP_DeviceDescriptor;\r
+                       Size    = sizeof(USB_Descriptor_Device_t);\r
+                       break;\r
+               case DTYPE_Configuration: \r
+                       Address = (void*)&AVRISP_ConfigurationDescriptor;\r
+                       Size    = sizeof(AVRISP_USB_Descriptor_Configuration_t);\r
+                       break;\r
+               case DTYPE_String: \r
+                       switch (DescriptorNumber)\r
+                       {\r
+                               case 0x00: \r
+                                       Address = (void*)&AVRISP_LanguageString;\r
+                                       Size    = pgm_read_byte(&AVRISP_LanguageString.Header.Size);\r
+                                       break;\r
+                               case 0x01: \r
+                                       Address = (void*)&AVRISP_ManufacturerString;\r
+                                       Size    = pgm_read_byte(&AVRISP_ManufacturerString.Header.Size);\r
+                                       break;\r
+                               case 0x02: \r
+                                       Address = (void*)&AVRISP_ProductString;\r
+                                       Size    = pgm_read_byte(&AVRISP_ProductString.Header.Size);\r
+                                       break;\r
+                               case 0x03:\r
+                                       Address = (void*)&AVRISP_SerialString;\r
+                                       Size    = pgm_read_byte(&AVRISP_SerialString.Header.Size);\r
+                                       break;                                  \r
+                       }\r
+                       \r
+                       break;\r
+       }\r
+       \r
+       *DescriptorAddress = Address;\r
+       return Size;\r
+}\r
diff --git a/Projects/XPLAINBridge/AVRISPDescriptors.h b/Projects/XPLAINBridge/AVRISPDescriptors.h
new file mode 100644 (file)
index 0000000..dfd5315
--- /dev/null
@@ -0,0 +1,67 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2010.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all 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
+ *  Header file for AVRISPDescriptors.c.\r
+ */\r
\r
+#ifndef _AVRISP_DESCRIPTORS_H_\r
+#define _AVRISP_DESCRIPTORS_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/pgmspace.h>\r
+\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+\r
+       /* Macros: */\r
+               /** Endpoint number of the AVRISP bidirectional data endpoint. */\r
+               #define AVRISP_DATA_EPNUM              2\r
+\r
+               /** Size in bytes of the AVRISP data endpoint. */\r
+               #define AVRISP_DATA_EPSIZE             64       \r
+\r
+       /* Type Defines: */\r
+               /** Type define for the device configuration descriptor structure. This must be defined in the\r
+                *  application code, as the configuration descriptor contains several sub-descriptors which\r
+                *  vary between devices, and which describe the device's usage to the host.\r
+                */\r
+               typedef struct\r
+               {\r
+                       USB_Descriptor_Configuration_Header_t    Config;\r
+                       USB_Descriptor_Interface_t               AVRISPInterface;\r
+                       USB_Descriptor_Endpoint_t                DataInEndpoint;\r
+                       USB_Descriptor_Endpoint_t                DataOutEndpoint;\r
+               } AVRISP_USB_Descriptor_Configuration_t;\r
+\r
+       /* Function Prototypes: */\r
+               uint16_t AVRISP_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress);\r
+\r
+#endif\r