projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Demos / Device / LowLevel / Keyboard / Descriptors.c
diff --git a/Demos/Device/LowLevel/Keyboard/Descriptors.c b/Demos/Device/LowLevel/Keyboard/Descriptors.c
index 598616a..9f29da8 100644 (file)
--- a/Demos/Device/LowLevel/Keyboard/Descriptors.c
+++ b/Demos/Device/LowLevel/Keyboard/Descriptors.c
@@ -1,22 +1,22 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
   Copyright 2010  Denver Gingerich (denver [at] ossguy [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
   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
   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
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -31,9 +31,9 @@
 
 /** \file
  *
 
 /** \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
  *  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"
  */
 
 #include "Descriptors.h"
@@ -44,40 +44,40 @@
  *  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.
  */
  *  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 KeyboardReport[] =
+const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
 {
 {
-       0x05, 0x01,          /* Usage Page (Generic Desktop)                    */
-       0x09, 0x06,          /* Usage (Keyboard)                                */
-       0xa1, 0x01,          /* Collection (Application)                        */
-       0x75, 0x01,          /*   Report Size (1)                               */
-       0x95, 0x08,          /*   Report Count (8)                              */
-       0x05, 0x07,          /*   Usage Page (Key Codes)                        */
-       0x19, 0xe0,          /*   Usage Minimum (Keyboard LeftControl)          */
-       0x29, 0xe7,          /*   Usage Maximum (Keyboard Right GUI)            */
-       0x15, 0x00,          /*   Logical Minimum (0)                           */
-       0x25, 0x01,          /*   Logical Maximum (1)                           */
-       0x81, 0x02,          /*   Input (Data, Variable, Absolute)              */
-       0x95, 0x01,          /*   Report Count (1)                              */
-       0x75, 0x08,          /*   Report Size (8)                               */
-       0x81, 0x03,          /*   Input (Const, Variable, Absolute)             */
-       0x95, 0x05,          /*   Report Count (5)                              */
-       0x75, 0x01,          /*   Report Size (1)                               */
-       0x05, 0x08,          /*   Usage Page (LEDs)                             */
-       0x19, 0x01,          /*   Usage Minimum (Num Lock)                      */
-       0x29, 0x05,          /*   Usage Maximum (Kana)                          */
-       0x91, 0x02,          /*   Output (Data, Variable, Absolute)             */
-       0x95, 0x01,          /*   Report Count (1)                              */
-       0x75, 0x03,          /*   Report Size (3)                               */
-       0x91, 0x03,          /*   Output (Const, Variable, Absolute)            */
-       0x95, 0x06,          /*   Report Count (6)                              */
-       0x75, 0x08,          /*   Report Size (8)                               */
-       0x15, 0x00,          /*   Logical Minimum (0)                           */
-       0x25, 0x65,          /*   Logical Maximum (101)                         */
-       0x05, 0x07,          /*   Usage Page (Keyboard)                         */
-       0x19, 0x00,          /*   Usage Minimum (Reserved (no event indicated)) */
-       0x29, 0x65,          /*   Usage Maximum (Keyboard Application)          */
-       0x81, 0x00,          /*   Input (Data, Array, Absolute)                 */
-       0xc0                 /* End Collection                                  */
+       HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
+       HID_RI_USAGE(8, 0x06), /* Keyboard */
+       HID_RI_COLLECTION(8, 0x01), /* Application */
+           HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
+           HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
+           HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
+           HID_RI_LOGICAL_MINIMUM(8, 0x00),
+           HID_RI_LOGICAL_MAXIMUM(8, 0x01),
+           HID_RI_REPORT_SIZE(8, 0x01),
+           HID_RI_REPORT_COUNT(8, 0x08),
+           HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
+           HID_RI_REPORT_COUNT(8, 0x01),
+           HID_RI_REPORT_SIZE(8, 0x08),
+           HID_RI_INPUT(8, HID_IOF_CONSTANT),
+           HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
+           HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
+           HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
+           HID_RI_REPORT_COUNT(8, 0x05),
+           HID_RI_REPORT_SIZE(8, 0x01),
+           HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
+           HID_RI_REPORT_COUNT(8, 0x01),
+           HID_RI_REPORT_SIZE(8, 0x03),
+           HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
+           HID_RI_LOGICAL_MINIMUM(8, 0x00),
+           HID_RI_LOGICAL_MAXIMUM(8, 0x65),
+           HID_RI_USAGE_PAGE(8, 0x07), /* Keyboard */
+           HID_RI_USAGE_MINIMUM(8, 0x00), /* Reserved (no event indicated) */
+           HID_RI_USAGE_MAXIMUM(8, 0x65), /* Keyboard Application */
+           HID_RI_REPORT_COUNT(8, 0x06),
+           HID_RI_REPORT_SIZE(8, 0x08),
+           HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
+       HID_RI_END_COLLECTION(0),
 };
 
 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
 };
 
 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
@@ -85,25 +85,25 @@ USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  *  process begins.
  */
  *  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},
 {
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
-               
+
        .USBSpecification       = VERSION_BCD(01.10),
        .USBSpecification       = VERSION_BCD(01.10),
-       .Class                  = 0x00,
-       .SubClass               = 0x00,
-       .Protocol               = 0x00,
-                               
+       .Class                  = USB_CSCP_NoDeviceClass,
+       .SubClass               = USB_CSCP_NoDeviceSubclass,
+       .Protocol               = USB_CSCP_NoDeviceProtocol,
+
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
-               
+
        .VendorID               = 0x03EB,
        .ProductID              = 0x2042,
        .VendorID               = 0x03EB,
        .ProductID              = 0x2042,
-       .ReleaseNumber          = 0x0000,
-               
+       .ReleaseNumber          = VERSION_BCD(00.01),
+
        .ManufacturerStrIndex   = 0x01,
        .ProductStrIndex        = 0x02,
        .SerialNumStrIndex      = NO_DESCRIPTOR,
        .ManufacturerStrIndex   = 0x01,
        .ProductStrIndex        = 0x02,
        .SerialNumStrIndex      = NO_DESCRIPTOR,
-               
+
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
 
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
 
@@ -112,68 +112,68 @@ 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.
  */
  *  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        = 1,
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 
                        .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
                        .TotalInterfaces        = 1,
-                               
+
                        .ConfigurationNumber    = 1,
                        .ConfigurationStrIndex  = NO_DESCRIPTOR,
                        .ConfigurationNumber    = 1,
                        .ConfigurationStrIndex  = NO_DESCRIPTOR,
-                               
+
                        .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
                        .ConfigAttributes       = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
-                       
+
                        .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
                },
                        .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
                },
-               
-       .HID_Interface = 
+
+       .HID_Interface =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber        = 0x00,
                        .AlternateSetting       = 0x00,
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber        = 0x00,
                        .AlternateSetting       = 0x00,
-                       
+
                        .TotalEndpoints         = 2,
                        .TotalEndpoints         = 2,
-                               
-                       .Class                  = 0x03,
-                       .SubClass               = 0x01,
-                       .Protocol               = 0x01,
-                               
+
+                       .Class                  = HID_CSCP_HIDClass,
+                       .SubClass               = HID_CSCP_BootSubclass,
+                       .Protocol               = HID_CSCP_KeyboardBootProtocol,
+
                        .InterfaceStrIndex      = NO_DESCRIPTOR
                },
 
                        .InterfaceStrIndex      = NO_DESCRIPTOR
                },
 
-       .HID_KeyboardHID = 
-               {  
-                       .Header                 = {.Size = sizeof(USB_Descriptor_HID_t), .Type = DTYPE_HID},
-                       
+       .HID_KeyboardHID =
+               {
+                       .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
+
                        .HIDSpec                = VERSION_BCD(01.11),
                        .CountryCode            = 0x00,
                        .TotalReportDescriptors = 1,
                        .HIDSpec                = VERSION_BCD(01.11),
                        .CountryCode            = 0x00,
                        .TotalReportDescriptors = 1,
-                       .HIDReportType          = DTYPE_Report,
+                       .HIDReportType          = HID_DTYPE_Report,
                        .HIDReportLength        = sizeof(KeyboardReport)
                },
                        .HIDReportLength        = sizeof(KeyboardReport)
                },
-               
-       .HID_ReportINEndpoint = 
+
+       .HID_ReportINEndpoint =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 
-                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_EPNUM),
+                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_IN_EPNUM),
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = KEYBOARD_EPSIZE,
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = KEYBOARD_EPSIZE,
-                       .PollingIntervalMS      = 0x0A
+                       .PollingIntervalMS      = 0x01
                },
 
                },
 
-       .HID_ReportOUTEndpoint = 
+       .HID_ReportOUTEndpoint =
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 
                {
                        .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 
-                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | KEYBOARD_LEDS_EPNUM),
+                       .EndpointAddress        = (ENDPOINT_DESCRIPTOR_DIR_OUT | KEYBOARD_OUT_EPNUM),
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = KEYBOARD_EPSIZE,
                        .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
                        .EndpointSize           = KEYBOARD_EPSIZE,
-                       .PollingIntervalMS      = 0x0A
+                       .PollingIntervalMS      = 0x01
                }
 };
 
                }
 };
 
@@ -181,10 +181,10 @@ 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.
  */
  *  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},
 {
        .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
-               
+
        .UnicodeString          = {LANGUAGE_ID_ENG}
 };
 
        .UnicodeString          = {LANGUAGE_ID_ENG}
 };
 
@@ -192,21 +192,21 @@ 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.
  */
  *  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(16), .Type = DTYPE_String},
-               
-       .UnicodeString          = L"Denver Gingerich"
+       .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
+
+       .UnicodeString          = L"Dean Camera"
 };
 
 /** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
 };
 
 /** Product descriptor string. This is a Unicode string containing the product's details in human readable 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 ProductString =
+const USB_Descriptor_String_t PROGMEM ProductString =
 {
        .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
 {
        .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
-               
+
        .UnicodeString          = L"LUFA Keyboard Demo"
 };
 
        .UnicodeString          = L"LUFA Keyboard Demo"
 };
 
@@ -216,52 +216,55 @@ USB_Descriptor_String_t PROGMEM ProductString =
  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  *  USB host.
  */
  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  *  USB host.
  */
-uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
+uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+                                    const uint8_t wIndex,
+                                    const void** const DescriptorAddress)
 {
        const uint8_t  DescriptorType   = (wValue >> 8);
        const uint8_t  DescriptorNumber = (wValue & 0xFF);
 
 {
        const uint8_t  DescriptorType   = (wValue >> 8);
        const uint8_t  DescriptorNumber = (wValue & 0xFF);
 
-       void*    Address = NULL;
-       uint16_t Size    = NO_DESCRIPTOR;
+       const void* Address = NULL;
+       uint16_t    Size    = NO_DESCRIPTOR;
 
        switch (DescriptorType)
        {
 
        switch (DescriptorType)
        {
-               case DTYPE_Device: 
-                       Address = (void*)&DeviceDescriptor;
+               case DTYPE_Device:
+                       Address = &DeviceDescriptor;
                        Size    = sizeof(USB_Descriptor_Device_t);
                        break;
                        Size    = sizeof(USB_Descriptor_Device_t);
                        break;
-               case DTYPE_Configuration: 
-                       Address = (void*)&ConfigurationDescriptor;
+               case DTYPE_Configuration:
+                       Address = &ConfigurationDescriptor;
                        Size    = sizeof(USB_Descriptor_Configuration_t);
                        break;
                        Size    = sizeof(USB_Descriptor_Configuration_t);
                        break;
-               case DTYPE_String: 
+               case DTYPE_String:
                        switch (DescriptorNumber)
                        {
                        switch (DescriptorNumber)
                        {
-                               case 0x00: 
-                                       Address = (void*)&LanguageString;
+                               case 0x00:
+                                       Address = &LanguageString;
                                        Size    = pgm_read_byte(&LanguageString.Header.Size);
                                        break;
                                        Size    = pgm_read_byte(&LanguageString.Header.Size);
                                        break;
-                               case 0x01: 
-                                       Address = (void*)&ManufacturerString;
+                               case 0x01:
+                                       Address = &ManufacturerString;
                                        Size    = pgm_read_byte(&ManufacturerString.Header.Size);
                                        break;
                                        Size    = pgm_read_byte(&ManufacturerString.Header.Size);
                                        break;
-                               case 0x02: 
-                                       Address = (void*)&ProductString;
+                               case 0x02:
+                                       Address = &ProductString;
                                        Size    = pgm_read_byte(&ProductString.Header.Size);
                                        break;
                        }
                                        Size    = pgm_read_byte(&ProductString.Header.Size);
                                        break;
                        }
-                       
+
                        break;
                        break;
-               case DTYPE_HID: 
-                       Address = (void*)&ConfigurationDescriptor.HID_KeyboardHID;
-                       Size    = sizeof(USB_Descriptor_HID_t);
+               case HID_DTYPE_HID:
+                       Address = &ConfigurationDescriptor.HID_KeyboardHID;
+                       Size    = sizeof(USB_HID_Descriptor_HID_t);
                        break;
                        break;
-               case DTYPE_Report: 
-                       Address = (void*)&KeyboardReport;
+               case HID_DTYPE_Report:
+                       Address = &KeyboardReport;
                        Size    = sizeof(KeyboardReport);
                        break;
        }
                        Size    = sizeof(KeyboardReport);
                        break;
        }
-       
+
        *DescriptorAddress = Address;
        return Size;
 }
        *DescriptorAddress = Address;
        return Size;
 }
+
USB isp AVR programmer