CCS C Software and Maintenance Offers
FAQFAQ   FAQForum Help   FAQOfficial CCS Support   SearchSearch  RegisterRegister 

ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

CCS does not monitor this forum on a regular basis.

Please do not post bug reports on this forum. Send them to CCS Technical Support

USB Descriptors for Composite Devices

 
Post new topic   Reply to topic    CCS Forum Index -> General CCS C Discussion
View previous topic :: View next topic  
Author Message
Tre



Joined: 03 Jun 2005
Posts: 21

View user's profile Send private message

USB Descriptors for Composite Devices
PostPosted: Tue Mar 28, 2006 10:06 pm     Reply with quote

I am trying to create a USB descriptor for a composite device. (www.zero-soft.com/HW/USB_NES when the hosting is actually working)

However, I am having a slight problem with the strings. I have defined all of my strings in the descriptor and I use the index of the strings I want to display in the interface descriptor for each of the two endpoints. During enumeration the correct names show up in the yellow balloons that windows has. However, when I go in and look at the devices in the control panel they both have the name of interface 1 (in this case "Controller A").

Anyone see anything that I am missing? Thanks!

PS: Sorry I can't figure out how to attach this, I guess i'll just have to paste it :<

Code:
#IFNDEF __USB_DESCRIPTORS__
#DEFINE __USB_DESCRIPTORS__

#include <usb.h>

   //////////////////////////////////////////////////////////////////
   ///
   ///  HID Report.  Tells HID driver how to handle and deal with
   ///  received data.  HID Reports can be extremely complex,
   ///  see HID specifcation for help on writing your own.
   ///
   ///  First it defines a block for the first interface for a mouse
   ///  protocol.  Second it defines a block for the second interface
   ///  for a keyboard protocol.
   ///
   //////////////////////////////////////////////////////////////////

   const char USB_CLASS_SPECIFIC_DESC[] = {
   // HID Descriptor for Interface 0 (Controller A)
   0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)        // 0,1
    0x09, 0x04,                    // USAGE (Joystick)               // 2,3
    0xa1, 0x01,                    // COLLECTION (Application)         // 4,5
    0x09, 0x01,                    //   USAGE (Pointer)               // 6,7
    0xa1, 0x00,                    //   COLLECTION (Physical)         // 8,9
    0x09, 0x30,                    //     USAGE (X)                  // 10,11
    0x09, 0x31,                    //     USAGE (Y)                  // 12, 13
    0x15, 0x81,                    //     LOGICAL_MINIMUM (-127)      // 14, 15
    0x25, 0x7f,                    //     LOGICAL_MAXIMUM (127)         // 16, 17
    0x75, 0x08,                    //     REPORT_SIZE (8)            // 18, 19
    0x95, 0x02,                    //     REPORT_COUNT (2)            // 20, 21
    0x81, 0x02,                    //     INPUT (Data,Var,Abs)         // 22, 23
    0x05, 0x09,                    //     USAGE_PAGE (Button)         // 24, 25
    0x19, 0x01,                    //     USAGE_MINIMUM (Button 1)      // 26, 27
    0x29, 0x08,                    //     USAGE_MAXIMUM (Button 8)      // 28, 29
    0x15, 0x00,                    //     LOGICAL_MINIMUM (0)         // 30, 31
    0x25, 0x01,                    //     LOGICAL_MAXIMUM (1)         // 32, 33
    0x75, 0x01,                    //     REPORT_SIZE (1)            // 34, 35
    0x95, 0x08,                    //     REPORT_COUNT (8)            // 36, 37
    0x81, 0x02,                    //     INPUT (Data,Var,Abs)         // 38, 39
    0xc0,                          //   END_COLLECTION               // 40
    0xc0                           // END_COLLECTION               // 41
   // HID Descriptor for Interface 1 (Controller B)
    0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)      // 42, 43
    0x09, 0x04,                    // USAGE (Joystick)               // 44, 45
    0xa1, 0x01,                    // COLLECTION (Application)         // 46, 47
    0x09, 0x01,                    //   USAGE (Pointer)               // 48, 49
    0xa1, 0x00,                    //   COLLECTION (Physical)         // 50, 51
    0x09, 0x30,                    //     USAGE (X)                  // 52, 53
    0x09, 0x31,                    //     USAGE (Y)                  // 54, 55
    0x15, 0x81,                    //     LOGICAL_MINIMUM (-127)      // 56, 57
    0x25, 0x7f,                    //     LOGICAL_MAXIMUM (127)         // 58, 59
    0x75, 0x08,                    //     REPORT_SIZE (8)            // 60, 61
    0x95, 0x02,                    //     REPORT_COUNT (2)            // 62, 63
    0x81, 0x02,                    //     INPUT (Data,Var,Abs)         // 64, 65
    0x05, 0x09,                    //     USAGE_PAGE (Button)         // 66, 67
    0x19, 0x01,                    //     USAGE_MINIMUM (Button 1)      // 68, 69
    0x29, 0x08,                    //     USAGE_MAXIMUM (Button 8)      // 70, 71
    0x15, 0x00,                    //     LOGICAL_MINIMUM (0)         // 72, 73
    0x25, 0x01,                    //     LOGICAL_MAXIMUM (1)         // 74, 75
    0x75, 0x01,                    //     REPORT_SIZE (1)            // 76, 77
    0x95, 0x08,                    //     REPORT_COUNT (8)            // 78, 79
    0x81, 0x02,                    //     INPUT (Data,Var,Abs)         // 80, 81
    0xc0,                          //   END_COLLECTION               // 82
    0xc0                           // END_COLLECTION               // 83
   };

   //if a class has an extra descriptor not part of the config descriptor,
   // this lookup table defines where to look for it in the const
   // USB_CLASS_SPECIFIC_DESC[] array.
   //first element is the config number (if your device has more than one config)
   //second element is which interface number
   //set element to 0xFFFF if this config/interface combo doesn't exist
   const int16 USB_CLASS_SPECIFIC_DESC_LOOKUP[USB_NUM_CONFIGURATIONS][2] =
   {
   //config 1
      //interface 0
         0,
      //interface 1
         42
   };

   //if a class has an extra descriptor not part of the config descriptor,
   // this lookup table defines the size of that descriptor.
   //first element is the config number (if your device has more than one config)
   //second element is which interface number
   //set element to 0xFFFF if this config/interface combo doesn't exist
   const int16 USB_CLASS_SPECIFIC_DESC_LOOKUP_SIZE[USB_NUM_CONFIGURATIONS][2] =
   {
   //config 1
      //interface 0
         42,
      //interface 1
         42
   };

//////////////////////////////////////////////////////////////////
///
///   start config descriptor
///   right now we only support one configuration descriptor.
///   the config, interface, class, and endpoint goes into this array.
///
//////////////////////////////////////////////////////////////////

   #DEFINE USB_TOTAL_CONFIG_LEN      59 //config+interface+class+endpoint

   const char USB_CONFIG_DESC[] = {
   //IN ORDER TO COMPLY WITH WINDOWS HOSTS, THE ORDER OF THIS ARRAY MUST BE:
      //    config(s)
      //    interface(s)
      //    class(es)
      //    endpoint(s)

   //config_descriptor for config index 1
         USB_DESC_CONFIG_LEN, //length of descriptor size          ==0
         USB_DESC_CONFIG_TYPE, //constant CONFIGURATION (CONFIGURATION 0x02)     ==1
         USB_TOTAL_CONFIG_LEN,0, //size of all data returned for this config      ==2,3
         2, //number of interfaces this device supports       ==4
         0x01, //identifier for this configuration.  (IF we had more than one configurations)      ==5
         0x00, //index of string descriptor for this configuration      ==6
         0xC0, //bit 6=1 if self powered, bit 5=1 if supports remote wakeup (we don't), bits 0-4 unused and bit7=1         ==7
         0x32, //maximum bus power required (maximum milliamperes/2)  (0x32 = 100mA)   //8

   //interface descriptor 1 (NES Controller A)
         USB_DESC_INTERFACE_LEN, //length of descriptor      =9
         USB_DESC_INTERFACE_TYPE, //constant INTERFACE (INTERFACE 0x04)       =10
         0x00, //number defining this interface (IF we had more than one interface)    ==11
         0x00, //alternate setting     ==12
         1, //number of endpoints for this interface  //13
         0x03, //class code, 03 = HID     ==14
         0x01, //subclass code //boot     ==15
         0x02, //protocol code            ==16
         0x02, //index of string descriptor for interface      ==17

   //class descriptor 1  (HID)
         USB_DESC_CLASS_LEN, //length of descriptor    ==18
         USB_DESC_CLASS_TYPE, //dscriptor type (0x21 == HID)      ==19
         0x00,0x01, //hid class release number (1.0) (try 1.10)      ==20,21
         0x00, //localized country code (0 = none)       ==22
         0x01, //number of hid class descrptors that follow (1)      ==23
         0x22, //report descriptor type (0x22 == HID)                ==24
         USB_CLASS_SPECIFIC_DESC_LOOKUP_SIZE[0][0], 0x00, //length of report descriptor            ==25,26

   //endpoint descriptor 1
         USB_DESC_ENDPOINT_LEN, //length of descriptor                   ==27
         USB_DESC_ENDPOINT_TYPE, //constant ENDPOINT (ENDPOINT 0x05)          ==28
         0x81, //endpoint number and direction (0x81 = EP1 IN)       ==29
         USB_ENDPOINT_TYPE_INTERRUPT, //transfer type supported (0x03 is interrupt)         ==30
         USB_EP1_TX_SIZE,0x00, //maximum packet size supported                  ==31,32
         10,  //polling interval, in ms.  (cant be smaller than 10 for slow speed devices)     ==33

   //interface descriptor 2 (NES Controller B)
         USB_DESC_INTERFACE_LEN, //length of descriptor      =34
         USB_DESC_INTERFACE_TYPE, //constant INTERFACE (INTERFACE 0x04)       =35
         0x01, //number defining this interface (IF we had more than one interface)    ==36
         0x00, //alternate setting     ==37
         1, //number of endpoints for this interface  //38
         0x03, //class code, 03 = HID     ==39
         0x01, //subclass code //boot     ==40
         0x02, //protocol code (keyboard)      ==41
         0x03, //index of string descriptor for interface      ==42

   //class descriptor 2
         USB_DESC_CLASS_LEN, //length of descriptor    ==43
         USB_DESC_CLASS_TYPE, //dscriptor type (0x21 == HID)      ==44
         0x00,0x01, //hid class release number (1.0) (try 1.10)      ==45,46
         0x00, //localized country code (0 = none)       ==47
         0x01, //number of hid class descrptors that follow (1)      ==48
         0x22, //report descriptor type (0x22 == HID)                ==49
         USB_CLASS_SPECIFIC_DESC_LOOKUP_SIZE[0][1], 0x00, //length of report descriptor            ==50,51

   //endpoint descriptor 2 IN
         USB_DESC_ENDPOINT_LEN, //length of descriptor                   ==52
         USB_DESC_ENDPOINT_TYPE, //constant ENDPOINT (ENDPOINT 0x05)          ==53
         0x82, //endpoint number and direction (0x81 = EP1 IN)       ==54
         USB_ENDPOINT_TYPE_INTERRUPT, //transfer type supported (0x03 is interrupt)         ==55
         USB_EP2_TX_SIZE,0x00, //maximum packet size supported                  ==56,57
         10  //polling interval, in ms.  (cant be smaller than 10 for slow speed devices)     ==58
   };


   //****** BEGIN CONFIG DESCRIPTOR LOOKUP TABLES ********
   //since we can't make pointers to constants in certain pic16s, this is an offset table to find
   //  a specific descriptor in the above table.

   //NOTE: DO TO A LIMITATION OF THE CCS CODE, ALL HID INTERFACES MUST START AT 0 AND BE SEQUENTIAL
   //      FOR EXAMPLE, IF YOU HAVE 2 HID INTERFACES THEY MUST BE INTERFACE 0 AND INTERFACE 1
   #define USB_NUM_HID_INTERFACES   2

   //the maximum number of interfaces seen on any config
   //for example, if config 1 has 1 interface and config 2 has 2 interfaces you must define this as 2
   #define USB_MAX_NUM_INTERFACES   2

   //define how many interfaces there are per config.  [0] is the first config, etc.
   const char USB_NUM_INTERFACES[USB_NUM_CONFIGURATIONS]={2};

   //define where to find class descriptors
   //first dimension is the config number
   //second dimension specifies which interface
   //last dimension specifies which class in this interface to get, but most will only have 1 class per interface
   //if a class descriptor is not valid, set the value to 0xFFFF
   const int16 USB_CLASS_DESCRIPTORS[USB_NUM_CONFIGURATIONS][2][1]=
   {
   //config 1
      //interface 0
         //class 1
         18,
      //interface 1
         //class 1
         43
   };

   //****** END CONFIG DESCRIPTOR LOOKUP TABLES ********

   #if (sizeof(USB_CONFIG_DESC) != USB_TOTAL_CONFIG_LEN)
      #error USB_TOTAL_CONFIG_LEN not defined correctly
   #endif


//////////////////////////////////////////////////////////////////
///
///   start device descriptors
///
//////////////////////////////////////////////////////////////////

   const char USB_DEVICE_DESC[] = {
      //starts of with device configuration. only one possible
         USB_DESC_DEVICE_LEN, //the length of this report   ==1
         0x01, //the constant DEVICE (DEVICE 0x01)  ==2
         0x10,0x01, //usb version in bcd (pic167xx is 1.1) ==3,4
         0x00, //class code ==5
         0x00, //subclass code ==6
         0x00, //protocol code ==7
         USB_MAX_EP0_PACKET_LENGTH, //max packet size for endpoint 0. (SLOW SPEED SPECIFIES 8) ==8
         0x61,0x04, //vendor id (0x04D8 is Microchip, or is it 0x0461 ??)
         0x4C,0x00, //product id   ==11,12  //don't use ffff says usb-by-example guy.  oops
         0x00,0x01, //device release number  ==13,14
         0x01, //index of string description of manufacturer. therefore we point to string_1 array (see below)  ==15
         0x01, //index of string descriptor of the product  ==16
         0x00, //index of string descriptor of serial number  ==17
         USB_NUM_CONFIGURATIONS  //number of possible configurations  ==18
   };

   #if (sizeof(USB_DEVICE_DESC) != USB_DESC_DEVICE_LEN)
      #error USB_DESC_DEVICE_LEN not defined correctly
   #endif


//////////////////////////////////////////////////////////////////
///
///   start string descriptors
///   String 0 is a special language string, and must be defined.  People in U.S.A. can leave this alone.
///
//////////////////////////////////////////////////////////////////

//the offset of the starting location of each string.  offset[0] is the start of string 0, offset[1] is the start of string 1, etc.
const char USB_STRING_DESC_OFFSET[]={0,4,24,78};

//number of strings you have, including string 0.
#define USB_STRING_DESC_COUNT sizeof(USB_STRING_DESC_OFFSET)

char const USB_STRING_DESC[]={
   //string 0
         4, //length of string index
         USB_DESC_STRING_TYPE, //descriptor type 0x03 (STRING)
         0x09,0x04,   //Microsoft Defined for US-English
   //string 1
         20, //length of string index
         USB_DESC_STRING_TYPE, //descriptor type 0x03 (STRING)
         'Z',0,
         'e',0,
         'r',0,
         'o',0,
         '-',0,
         'S',0,
         'o',0,
         'f',0,
         't',0,                                             
   //string 2
         54, //length of string index
         USB_DESC_STRING_TYPE, //descriptor type 0x03 (STRING)
         'Z',0,
         'e',0,
         'r',0,
         'o',0,
         '-',0,
         'S',0,
         'o',0,
         'f',0,
         't',0,
         ' ',0,
         'N',0,
         'E',0,
         'S',0,
         ' ',0,
         'C',0,
         'o',0,
         'n',0,
         't',0,
         'r',0,
         'o',0,
         'l',0,
         'l',0,
         'e',0,
         'r',0,
         ' ',0,
         'A',0,
   //string 3
         54, //length of string index
         USB_DESC_STRING_TYPE, //descriptor type 0x03 (STRING)
         'Z',0,
         'e',0,
         'r',0,
         'o',0,
         '-',0,
         'S',0,
         'o',0,
         'f',0,
         't',0,
         ' ',0,
         'N',0,
         'E',0,
         'S',0,
         ' ',0,
         'C',0,
         'o',0,
         'n',0,
         't',0,
         'r',0,
         'o',0,
         'l',0,
         'l',0,
         'e',0,
         'r',0,
         ' ',0,
         'B',0
};
Tre



Joined: 03 Jun 2005
Posts: 21

View user's profile Send private message

Class Descriptors
PostPosted: Tue Mar 28, 2006 11:24 pm     Reply with quote

After looking at it again (and again, and again...) I think that I may have found an error in the mouse/keyboard code.

Code:
//define where to find class descriptors
   //first dimension is the config number
   //second dimension specifies which interface
   //last dimension specifies which class in this interface to get, but most will only have 1 class per interface
   //if a class descriptor is not valid, set the value to 0xFFFF
   const int16 USB_CLASS_DESCRIPTORS[USB_NUM_CONFIGURATIONS][USB_NUM_HID_INTERFACES][2]=
   {
   //config 1
      //interface 0
         //class 1
         18,
   //interface 1
         //class 1
         44
   };


This doesn't seem to be correct if you have more than one class for an interface which the keyboard/mouse and my code do....

Anyone else care to comment on this?
Display posts from previous:   
Post new topic   Reply to topic    CCS Forum Index -> General CCS C Discussion All times are GMT - 6 Hours
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group