Minor documentation improvements.

[pub/USBasp.git] / Demos / Device / ClassDriver / Joystick / Descriptors.c

diff --git a/Demos/Device/ClassDriver/Joystick/Descriptors.c b/Demos/Device/ClassDriver/Joystick/Descriptors.c
index a9abb5d..8a6ef20 100644 (file)
--- a/Demos/Device/ClassDriver/Joystick/Descriptors.c
+++ b/Demos/Device/ClassDriver/Joystick/Descriptors.c
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2013.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  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
   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


@@ -42,14 +42,14 @@
  *  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.
  *  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 JoystickReport[] =
 {
        /* Use the HID class driver's standard Joystick report.
 const USB_Descriptor_HIDReport_Datatype_t PROGMEM JoystickReport[] =
 {
        /* Use the HID class driver's standard Joystick report.

-        *   Min X/Y Axis values: -100
-        *   Max X/Y Axis values:  100
-        *   Min physical X/Y Axis values (used to determine resolution): -1
-        *   Max physical X/Y Axis values (used to determine resolution):  1
+        *   Min X/Y/Z Axis values: -100
+        *   Max X/Y/Z Axis values:  100
+        *   Min physical X/Y/Z Axis values (used to determine resolution): -1
+        *   Max physical X/Y/Z Axis values (used to determine resolution):  1

         *   Buttons: 2
         */
        HID_DESCRIPTOR_JOYSTICK(-100, 100, -1, 1, 2)
         *   Buttons: 2
         */
        HID_DESCRIPTOR_JOYSTICK(-100, 100, -1, 1, 2)


@@ -75,8 +75,8 @@ const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
        .ProductID              = 0x2043,
        .ReleaseNumber          = VERSION_BCD(00.01),
 
        .ProductID              = 0x2043,
        .ReleaseNumber          = VERSION_BCD(00.01),
 

-       .ManufacturerStrIndex   = 0x01,
-       .ProductStrIndex        = 0x02,
+       .ManufacturerStrIndex   = STRING_ID_Manufacturer,
+       .ProductStrIndex        = STRING_ID_Product,

        .SerialNumStrIndex      = NO_DESCRIPTOR,
 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
        .SerialNumStrIndex      = NO_DESCRIPTOR,
 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS


@@ -99,7 +99,7 @@ const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
                        .ConfigurationNumber    = 1,
                        .ConfigurationStrIndex  = NO_DESCRIPTOR,
 
                        .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)
                },
 
                        .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
                },


@@ -135,10 +135,10 @@ const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 

-                       .EndpointAddress        = (ENDPOINT_DIR_IN | JOYSTICK_EPNUM),
+                       .EndpointAddress        = JOYSTICK_EPADDR,

                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = JOYSTICK_EPSIZE,
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = JOYSTICK_EPSIZE,

-                       .PollingIntervalMS      = 0x01
+                       .PollingIntervalMS      = 0x05

                }
 };
 
                }
 };
 


@@ -204,15 +204,15 @@ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                case DTYPE_String:
                        switch (DescriptorNumber)
                        {
                case DTYPE_String:
                        switch (DescriptorNumber)
                        {

-                               case 0x00:
+                               case STRING_ID_Language:

                                        Address = &LanguageString;
                                        Size    = pgm_read_byte(&LanguageString.Header.Size);
                                        break;
                                        Address = &LanguageString;
                                        Size    = pgm_read_byte(&LanguageString.Header.Size);
                                        break;

-                               case 0x01:
+                               case STRING_ID_Manufacturer:

                                        Address = &ManufacturerString;
                                        Size    = pgm_read_byte(&ManufacturerString.Header.Size);
                                        break;
                                        Address = &ManufacturerString;
                                        Size    = pgm_read_byte(&ManufacturerString.Header.Size);
                                        break;

-                               case 0x02:
+                               case STRING_ID_Product:

                                        Address = &ProductString;
                                        Size    = pgm_read_byte(&ProductString.Header.Size);
                                        break;
                                        Address = &ProductString;
                                        Size    = pgm_read_byte(&ProductString.Header.Size);
                                        break;