Minor documentation adjustments to the demos, projects and bootloaders to ensure...
[pub/USBasp.git] / Demos / Device / ClassDriver / VirtualSerialMouse / Descriptors.c
index 72e89ef..9997121 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  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 
+  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 
+  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 disclaim all warranties with regard to this
@@ -30,9 +30,9 @@
 
 /** \file
  *
- *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special 
+ *  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.  
+ *  the device's capabilities and functions.
  */
 
 #include "Descriptors.h"
  *  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.
  */
-USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
+const USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
 {
-       0x05, 0x01,          /* Usage Page (Generic Desktop)             */
-       0x09, 0x02,          /* Usage (Mouse)                            */
-       0xA1, 0x01,          /* Collection (Application)                 */
-       0x09, 0x01,          /*   Usage (Pointer)                        */
-       0xA1, 0x00,          /*   Collection (Application)               */
-       0x95, 0x03,          /*     Report Count (3)                     */
-       0x75, 0x01,          /*     Report Size (1)                      */
-       0x05, 0x09,          /*     Usage Page (Button)                  */
-       0x19, 0x01,          /*     Usage Minimum (Button 1)             */
-       0x29, 0x03,          /*     Usage Maximum (Button 3)             */
-       0x15, 0x00,          /*     Logical Minimum (0)                  */
-       0x25, 0x01,          /*     Logical Maximum (1)                  */
-       0x81, 0x02,          /*     Input (Data, Variable, Absolute)     */
-       0x95, 0x01,          /*     Report Count (1)                     */
-       0x75, 0x05,          /*     Report Size (5)                      */
-       0x81, 0x01,          /*     Input (Constant)                     */
-       0x75, 0x08,          /*     Report Size (8)                      */
-       0x95, 0x02,          /*     Report Count (2)                     */
-       0x05, 0x01,          /*     Usage Page (Generic Desktop Control) */
-       0x09, 0x30,          /*     Usage X                              */
-       0x09, 0x31,          /*     Usage Y                              */
-       0x15, 0x81,          /*     Logical Minimum (-127)               */
-       0x25, 0x7F,          /*     Logical Maximum (127)                */
-       0x81, 0x06,          /*     Input (Data, Variable, Relative)     */
-       0xC0,                /*   End Collection                         */
-       0xC0                 /* End Collection                           */
+       /* Use the HID class driver's standard Mouse report.
+        *   Min X/Y Axis values: -1
+        *   Max X/Y Axis values:  1
+        *   Min physical X/Y Axis values (used to determine resolution): -1
+        *   Max physical X/Y Axis values (used to determine resolution):  1
+        *   Buttons: 3
+        *   Absolute screen coordinates: false
+        */
+       HID_DESCRIPTOR_MOUSE(-1, 1, -1, 1, 3, false)
 };
 
 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
@@ -90,25 +73,25 @@ USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  *  process begins.
  */
-USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
+const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
 {
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
-       
+
        .USBSpecification       = VERSION_BCD(01.10),
-       .Class                  = 0xEF,
-       .SubClass               = 0x02,
-       .Protocol               = 0x01,
-       
+       .Class                  = USB_CSCP_IADDeviceClass,
+       .SubClass               = USB_CSCP_IADDeviceSubclass,
+       .Protocol               = USB_CSCP_IADDeviceProtocol,
+
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
-       
+
        .VendorID               = 0x03EB,
        .ProductID              = 0x2062,
-       .ReleaseNumber          = 0x0000,
-       
+       .ReleaseNumber          = VERSION_BCD(00.01),
+
        .ManufacturerStrIndex   = 0x01,
        .ProductStrIndex        = 0x02,
        .SerialNumStrIndex      = USE_INTERNAL_SERIAL,
-       
+
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
 
@@ -117,141 +100,141 @@ USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  *  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.
  */
-USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
+const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 {
-       .Config = 
+       .Config =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 
                        .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
                        .TotalInterfaces        = 3,
-                       
+
                        .ConfigurationNumber    = 1,
                        .ConfigurationStrIndex  = NO_DESCRIPTOR,
-                       
-                       .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
-                       
+
+                       .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
+
                        .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
                },
 
-       .CDC_IAD = 
+       .CDC_IAD =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_Association_t), .Type = DTYPE_InterfaceAssociation},
 
                        .FirstInterfaceIndex    = 0,
                        .TotalInterfaces        = 2,
 
-                       .Class                  = 0x02,
-                       .SubClass               = 0x02,
-                       .Protocol               = 0x01,
+                       .Class                  = CDC_CSCP_CDCClass,
+                       .SubClass               = CDC_CSCP_ACMSubclass,
+                       .Protocol               = CDC_CSCP_ATCommandProtocol,
 
                        .IADStrIndex            = NO_DESCRIPTOR
                },
-               
-       .CDC_CCI_Interface = 
+
+       .CDC_CCI_Interface =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber        = 0,
                        .AlternateSetting       = 0,
-                       
+
                        .TotalEndpoints         = 1,
-                       
-                       .Class                  = 0x02,
-                       .SubClass               = 0x02,
-                       .Protocol               = 0x01,
-                       
+
+                       .Class                  = CDC_CSCP_CDCClass,
+                       .SubClass               = CDC_CSCP_ACMSubclass,
+                       .Protocol               = CDC_CSCP_ATCommandProtocol,
+
                        .InterfaceStrIndex      = NO_DESCRIPTOR
                },
 
-       .CDC_Functional_Header = 
+       .CDC_Functional_Header =
                {
                        .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalHeader_t), .Type = DTYPE_CSInterface},
                        .Subtype                = CDC_DSUBTYPE_CSInterface_Header,
-                       
+
                        .CDCSpecification       = VERSION_BCD(01.10),
                },
 
-       .CDC_Functional_ACM = 
+       .CDC_Functional_ACM =
                {
                        .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalACM_t), .Type = DTYPE_CSInterface},
                        .Subtype                = CDC_DSUBTYPE_CSInterface_ACM,
-                       
+
                        .Capabilities           = 0x06,
                },
-               
-       .CDC_Functional_Union = 
+
+       .CDC_Functional_Union =
                {
                        .Header                 = {.Size = sizeof(USB_CDC_Descriptor_FunctionalUnion_t), .Type = DTYPE_CSInterface},
                        .Subtype                = CDC_DSUBTYPE_CSInterface_Union,
-                       
+
                        .MasterInterfaceNumber  = 0,
                        .SlaveInterfaceNumber   = 1,
                },
 
-       .CDC_NotificationEndpoint = 
+       .CDC_NotificationEndpoint =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
-                       
-                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),
+
+                       .EndpointAddress        = CDC_NOTIFICATION_EPADDR,
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = CDC_NOTIFICATION_EPSIZE,
                        .PollingIntervalMS      = 0xFF
                },
 
-       .CDC_DCI_Interface = 
+       .CDC_DCI_Interface =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber        = 1,
                        .AlternateSetting       = 0,
-                       
+
                        .TotalEndpoints         = 2,
-                               
-                       .Class                  = 0x0A,
-                       .SubClass               = 0x00,
-                       .Protocol               = 0x00,
-                               
+
+                       .Class                  = CDC_CSCP_CDCDataClass,
+                       .SubClass               = CDC_CSCP_NoDataSubclass,
+                       .Protocol               = CDC_CSCP_NoDataProtocol,
+
                        .InterfaceStrIndex      = NO_DESCRIPTOR
                },
 
-       .CDC_DataOutEndpoint = 
+       .CDC_DataOutEndpoint =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
-                       
-                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),
+
+                       .EndpointAddress        = CDC_RX_EPADDR,
                        .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = CDC_TXRX_EPSIZE,
-                       .PollingIntervalMS      = 0x00
+                       .PollingIntervalMS      = 0x05
                },
-               
-       .CDC_DataInEndpoint = 
+
+       .CDC_DataInEndpoint =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
-                       
-                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),
+
+                       .EndpointAddress        = CDC_TX_EPADDR,
                        .Attributes             = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = CDC_TXRX_EPSIZE,
-                       .PollingIntervalMS      = 0x00
+                       .PollingIntervalMS      = 0x05
                },
 
-       .HID_Interface = 
+       .HID_Interface =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber        = 2,
                        .AlternateSetting       = 0,
-                       
+
                        .TotalEndpoints         = 1,
-                               
-                       .Class                  = 0x03,
-                       .SubClass               = 0x01,
-                       .Protocol               = HID_BOOTP_MouseBootProtocol,
-                               
+
+                       .Class                  = HID_CSCP_HIDClass,
+                       .SubClass               = HID_CSCP_BootSubclass,
+                       .Protocol               = HID_CSCP_MouseBootProtocol,
+
                        .InterfaceStrIndex      = NO_DESCRIPTOR
                },
 
-       .HID_MouseHID = 
+       .HID_MouseHID =
                {
                        .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 
@@ -262,14 +245,14 @@ USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
                        .HIDReportLength        = sizeof(MouseReport)
                },
 
-       .HID_ReportINEndpoint = 
+       .HID_ReportINEndpoint =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 
-                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | MOUSE_EPNUM),
+                       .EndpointAddress        = MOUSE_EPADDR,
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = MOUSE_EPSIZE,
-                       .PollingIntervalMS      = 0x0A
+                       .PollingIntervalMS      = 0x05
                }
 };
 
@@ -277,7 +260,7 @@ USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  *  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.
  */
-USB_Descriptor_String_t PROGMEM LanguageString =
+const USB_Descriptor_String_t PROGMEM LanguageString =
 {
        .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 
@@ -288,7 +271,7 @@ USB_Descriptor_String_t PROGMEM LanguageString =
  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-USB_Descriptor_String_t PROGMEM ManufacturerString =
+const USB_Descriptor_String_t PROGMEM ManufacturerString =
 {
        .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
 
@@ -299,7 +282,7 @@ USB_Descriptor_String_t PROGMEM ManufacturerString =
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-USB_Descriptor_String_t PROGMEM ProductString =
+const USB_Descriptor_String_t PROGMEM ProductString =
 {
        .Header                 = {.Size = USB_STRING_LEN(23), .Type = DTYPE_String},
 
@@ -328,38 +311,39 @@ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                        Address = &DeviceDescriptor;
                        Size    = sizeof(USB_Descriptor_Device_t);
                        break;
-               case DTYPE_Configuration: 
+               case DTYPE_Configuration:
                        Address = &ConfigurationDescriptor;
                        Size    = sizeof(USB_Descriptor_Configuration_t);
                        break;
-               case DTYPE_String: 
+               case DTYPE_String:
                        switch (DescriptorNumber)
                        {
-                               case 0x00: 
+                               case 0x00:
                                        Address = &LanguageString;
                                        Size    = pgm_read_byte(&LanguageString.Header.Size);
                                        break;
-                               case 0x01: 
+                               case 0x01:
                                        Address = &ManufacturerString;
                                        Size    = pgm_read_byte(&ManufacturerString.Header.Size);
                                        break;
-                               case 0x02: 
+                               case 0x02:
                                        Address = &ProductString;
                                        Size    = pgm_read_byte(&ProductString.Header.Size);
                                        break;
                        }
-                       
+
                        break;
-               case HID_DTYPE_HID: 
+               case HID_DTYPE_HID:
                        Address = &ConfigurationDescriptor.HID_MouseHID;
                        Size    = sizeof(USB_HID_Descriptor_HID_t);
                        break;
-               case HID_DTYPE_Report: 
+               case HID_DTYPE_Report:
                        Address = &MouseReport;
                        Size    = sizeof(MouseReport);
                        break;
        }
-       
+
        *DescriptorAddress = Address;
        return Size;
 }
+