Logging and Telephony HID device #667

buildcomics · 2021-02-20T17:47:41Z

buildcomics
Feb 20, 2021

Hello,

I'm attempting to create a Telephony HID device to control skype/teams or other unified communications software. I want to have status LEDs for "in a call", mute/unmute. I also aim to have buttons for hang up, answer, mute/unmute.

I found the microsoft teams spec: https://docs.microsoft.com/en-us/skypeforbusiness/certification/test-spec
Specifying to use a telephony HID device.

I am using a raspberry pi pico, and I can succesfully emulate a normal keyboard. Then I tried to enable deub logging by either doing "make DEBUG=1" or even "make DEBUG=1 LOG=2". But I still do not get anything in the serial output of the pico apart from the debug messages I write myself.

I tried changing tusb_config.h to set "#define CFG_TUSB_DEBUG 1" , but that didn't help either.

Apart from that, I am struggling to understand the desc_hid_report. I copied the "keyboard" example, but I am a bit at a loss how this part is setup:

HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP     )                    ,\
            HID_USAGE      ( HID_USAGE_DESKTOP_KEYBOARD )                    ,\
            HID_COLLECTION ( HID_COLLECTION_APPLICATION )                    ,\
            /* Report ID if any */\
            HID_REPORT_ID(REPORT_ID_KEYBOARD) \
            /* 8 bits Modifier Keys (Shfit, Control, Alt) */ \
            HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD )                     ,\
            HID_USAGE_MIN    ( 224                                    )  ,\
            HID_USAGE_MAX    ( 231                                    )  ,\
            HID_LOGICAL_MIN  ( 0                                      )  ,\
            HID_LOGICAL_MAX  ( 1                                      )  ,\
            HID_REPORT_COUNT ( 8                                      )  ,\
            HID_REPORT_SIZE  ( 1                                      )  ,\
            HID_INPUT        ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE )  ,\
            /* 8 bit reserved */ \
            HID_REPORT_COUNT ( 1                                      )  ,\
            HID_REPORT_SIZE  ( 8                                      )  ,\
            HID_INPUT        ( HID_CONSTANT                           )  ,\
            /* 6-byte Keycodes */ \
            HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD )                     ,\
            HID_USAGE_MIN    ( 0                                   )     ,\
            HID_USAGE_MAX    ( 255                                 )     ,\
            HID_LOGICAL_MIN  ( 0                                   )     ,\
            HID_LOGICAL_MAX  ( 255                                 )     ,\
            HID_REPORT_COUNT ( 6                                   )     ,\
            HID_REPORT_SIZE  ( 8                                   )     ,\
            HID_INPUT        ( HID_DATA | HID_ARRAY | HID_ABSOLUTE )     ,\
            /* 5-bit LED Indicator Kana | Compose | ScrollLock | CapsLock | NumLock */ \
            HID_USAGE_PAGE  ( HID_USAGE_PAGE_LED                   )       ,\
            HID_USAGE_MIN    ( 1                                       ) ,\
            HID_USAGE_MAX    ( 5                                       ) ,\
            HID_REPORT_COUNT ( 5                                       ) ,\
            HID_REPORT_SIZE  ( 1                                       ) ,\
            HID_OUTPUT       ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE  ) ,\
            /* led padding */ \
            HID_REPORT_COUNT ( 1                                       ) ,\
            HID_REPORT_SIZE  ( 3                                       ) ,\
            HID_OUTPUT       ( HID_CONSTANT                            ) ,\
            HID_COLLECTION_END \

Is there any documentation available on what all this is? Such that I can change it to provide the teams HID specs that I need?

I put all the code that I got so far up here: https://github.com/buildcomics/MST_keyboard

chegewara · 2021-02-20T18:45:13Z

chegewara
Feb 20, 2021

https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf

2 replies

buildcomics Feb 20, 2021
Author

Thank you for the deeper insight in USB HID documentation. I am aware of this document, but I just know noticed the "Usage Examples" in the appendix, of which the format seems to match the format here. I'm gonna take a deeper look at the telephony example in here.

In the meantime however, I would like:

Get the debug output working to debug some "stranges" things. When I set the HID_USAGE_MAX to 24 it works fine. When I said HID_REPORT_COUNT to 25, it all of a sudden stops working on windows. The mouse keys don't always work under windows as well somehow.

chegewara Feb 20, 2021

https://eleccelerator.com/tutorial-about-usb-hid-report-descriptors/

HID_REPORT_COUNT its basically how many reported values and HID_REPORT_SIZE is how many bits is representing a single value.
Those looks similar, and will be sent as a single byte, but are not the same:

HID_REPORT_COUNT ( 8 )  ,\
HID_REPORT_SIZE  ( 1 )

and

HID_REPORT_COUNT (1)  ,\
HID_REPORT_SIZE  (8)

https://www.usb.org/sites/default/files/hid1_11.pdf

HID_USAGE_MAX is something different, it tells HID driver what is maximal possible value. Higher value will be ignored.

hathach · 2021-02-22T05:39:36Z

hathach
Feb 22, 2021
Maintainer

HID report descriptor is very difficult thing to come up by oneself. You should google around, or dump report descriptor from existing device to copy/follow it. For debug log, it will printed via UART in GPIO0, 1

5 replies

buildcomics Feb 22, 2021
Author

That is a good idea, I think I have a telephony HID device around here somewhere to test that with. If you have any thoughts on what to use (on linux) to get this HID report descriptor dump, please let me know 👍

As for the debugging, I have not yet seen anything coming out of UART apart from my own debug messages (with printf). And I can't figure out why.

hathach Feb 22, 2021
Maintainer

You could run follow command and replace cafe with your device vid

sudo usbhid-dump -d cafe | grep -v : | xxd -r -p | hidrd-convert -o spec

for uart you need a full clean, make sure you run make with this repo example and now from pico-sdk

buildcomics Feb 24, 2021
Author

Thanks, that command worked a treat. I haven't yet laid hands on my USB HID presence light (that's still at the office..). I found a HID description from microsoft in called " Skype for Business Call Display Specification". I tested that descriptor (raw basically) after a lot of copy/pasting from the PDF (found in this zip file: https://download.microsoft.com/download/9/f/6/9f63c68d-817b-40ff-935c-9dd8b74cb07d/V4%20Release.zip ). My "keyboard" section still works, however on windows I get an error on the device: "Report Descriptor was not byte aligned". Not sure how to fix this, I'm gonna try to use the same descriptor, but "translate" it to the tinyusb HID_FUNCTIONS and see if that helps. Here is the descriptor I made so far:

uint8_t const desc_hid_report[] =
        {
            HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP     )                    ,\
            HID_USAGE      ( HID_USAGE_DESKTOP_KEYBOARD )                    ,\
            HID_COLLECTION ( HID_COLLECTION_APPLICATION )                    ,\
                /* Report ID if any */\
                HID_REPORT_ID(REPORT_ID_KEYBOARD) \
                /* 8 bits Modifier Keys (Shfit, Control, Alt) */ \
                HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD )                     ,\
                    HID_USAGE_MIN    ( 224                                    )  ,\
                    HID_USAGE_MAX    ( 231                                    )  ,\
                    HID_LOGICAL_MIN  ( 0                                      )  ,\
                    HID_LOGICAL_MAX  ( 1                                      )  ,\
                    HID_REPORT_COUNT ( 8                                      )  ,\
                    HID_REPORT_SIZE  ( 1                                      )  ,\
                    HID_INPUT        ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE )  ,\
                    /* 8 bit reserved */ \
                    HID_REPORT_COUNT ( 1                                      )  ,\
                    HID_REPORT_SIZE  ( 8                                      )  ,\
                    HID_INPUT        ( HID_CONSTANT                           )  ,\
                    /* 6-byte Keycodes */ \
                    HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD )                     ,\
                        HID_USAGE_MIN    ( 0                                   )     ,\
                        HID_USAGE_MAX    ( 255                                 )     ,\
                        HID_LOGICAL_MIN  ( 0                                   )     ,\
                        HID_LOGICAL_MAX  ( 255                                 )     ,\
                        HID_REPORT_COUNT ( 6                                   )     ,\
                        HID_REPORT_SIZE  ( 8                                   )     ,\
                        HID_INPUT        ( HID_DATA | HID_ARRAY | HID_ABSOLUTE )     ,\
                   HID_USAGE_PAGE  ( HID_USAGE_PAGE_LED                   )       , /*Attemptint to get led page until 24 that includes the telephony ones*/ \
                       HID_USAGE_MIN    ( 1                                       ) ,\
                       HID_USAGE_MAX    ( 24                                      ) ,\
                       HID_REPORT_COUNT ( 5                                       ) ,\
                       HID_REPORT_SIZE  ( 1                                       ) ,\
                       HID_OUTPUT       ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE  ) ,\
                       /* led padding */ \
                       HID_REPORT_COUNT ( 1                                       ) ,\
                       HID_REPORT_SIZE  ( 3                                       ) ,\
                       HID_OUTPUT       ( HID_CONSTANT                            ) ,\
            HID_COLLECTION_END                                                      ,\
            /*-------- LCD display ----------------------------------*/ \
            0x06, 0x99, 0xFF, /* USAGE_PAGE (Custom UC Display)  */ \
            0x09, 0x01,  /* USAGE (UC_DISPLAY) */ \
            0xA1, 0x01,  /* COLLECTION (Application) */ \
            /* ------------ Vendor Extension ------------------------*/ \
            0x0A, 0x00, 0xFF, /* USAGE (Vendor Extension) */ \
            0xa1, 0x02, /* COLLECTION (Logical) */ \
            0x85, 0x11, /* Report ID (11) */ \
            0x15, 0x00, /* Logical Minimum (0), */ \
            0x27, 0xFF, 0xFF, 0x00, 0x00, /* Logical Maximum (65535) */ \
            0x95, 0x01, /*  REPORT_COUNT (1) */ \
            0x75, 0x10, /* REPORT_SIZE (16) */ \
            0x0A, 0x01, 0xFF, /* USAGE (Vendor Id) */ \
            0xB1, 0x03, /* FEATURE (Cnst,Var,Abs) */ \
            0x26, 0xFF, 0x00, /* Logical Maximum (255) */ \
            0x95, 0x02, /* REPORT_COUNT (2) */ \
            0x75, 0x08, /*  REPORT_SIZE (8) */ \
            0x0A, 0x02, 0xFF, /* USAGE (Version) */ \
            0xB1, 0x03, /* FEATURE (Cnst,Var,Abs) */ \
            0xc0, /* END_COLLECTION*/ \
            /* ------------ Display Attributes ------------------------*/ \
            0x09, 0x20, /* USAGE (Display Attributes) */ \
            0xa1, 0x02, /* COLLECTION (Logical) */ \
            0x85, 0x12, /* Report ID (12) */
            0x09, 0x35, /*USAGE (Rows) */ \
            0x09, 0x36, /*USAGE (Columns) */ \
            0x15, 0x00, /*Logical Minimum (0), */ \
            0x26, 0xFF, 0x00, /*Logical Maximum (255) */ \
            0x95, 0x02, /*REPORT_COUNT (2) */ \
            0x75, 0x08, /* REPORT_SIZE (8) */ \
            0xB1, 0x03,/*FEATURE (Cnst,Var,Abs) */ \
            0x19, 0x81, /* USAGE_MINIMUM (first Display Property) */ \
            0x29, 0x8A, /* USAGE_MAXIMUM (last Display Property) */ \
            0x25, 0x01, /* Logical Maximum (1), */ \
            0x95, 0x0A, /* REPORT_COUNT (10) */ \
            0x75, 0x01, /* REPORT_SIZE (1) */ \
            0xB1, 0x03, /* FEATURE (Cnst,Var,Abs) */ \
            0x95, 0x01, /* REPORT_COUNT (1) */ \
            0x75, 0x06, /* REPORT_SIZE (6) */ \
            0xB1, 0x03, /* FEATURE (Const,Var,Abs) Pading 6 */ \
            0xc0,       /* END_COLLECTION */ \
            /* ------------ Display Control Report ------------------------*/ \
            0x09, 0x24,       /* USAGE (Display Control) */ \
            0xA1, 0x02,       /* COLLECTION(Logical) */ \
            0x85, 0x13,       /* Report ID (13) */ \
            0x09, 0x26,       /* USAGE (Enable Display) */ \
            0x09, 0x25,       /* USAGE (Clear Display) */ \
            0x0A, 0x10, 0xFF, /* USAGE (Back Light) */ \
            0x15, 0x00,       /* Logical Minimum (0), */ \
            0x25, 0x01,       /* Logical Maximum (1), */ \
            0x95, 0x03,       /* REPORT_COUNT (3) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x0A, 0x11, 0xFF, /* USAGE (Screen Select) */ \
            0x25, 0x0F,       /* Logical Maximum (15), */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs)  Pading 1*/ \
            0xc0,             /* END_COLLECTION */ \
            /* ------------ Character Attribute Report ------------------------*/ \
            0x09, 0x48,       /* USAGE (Character Attributes) */ \
            0xA1, 0x02,       /* COLLECTION(Logical) */ \
            0x85, 0x14,       /* Report ID (14) */ \
            0x19, 0x81,       /* USAGE_MINIMUM (Local User Name) */ \
            0x29, 0x8A,       /* USAGE_MAXIMUM (Number) */ \
            0x15, 0x01,       /* LOGICAL_MINIMUM (1) */ \
            0x25, 0x0A,       /* LOGICAL_MAXIMUM (10) */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x00,       /* OUTPUT (Data,Ary,Abs) */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) Pading 4 */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x05,       /* REPORT_SIZE (7) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) Pading 7 */ \
            0x0A, 0x22, 0xFF, /* USAGE (Text String Followed) */ \
            0x25, 0x01,       /* Logical Maximum (1), */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0xc0,             /*END_COLLECTION */ \
            /* ------------ Character Report ------------------------*/ \
            0x09, 0x2B,                   /* USAGE (Character Report) */ \
            0xA1, 0x02,                   /* COLLECTION(Logical) */ \
            0x85, 0x15,                   /* Report ID (15) */ \
            0x95, 0x01,                   /* REPORT_COUNT (1) */ \
            0x75, 0x07,                   /* REPORT_SIZE (7) */ \
            0x91, 0x03,                   /* OUTPUT (Const,Var,Abs)            //Pading 7 */ \
            0x0A, 0x24, 0xFF,             /* USAGE (Last Character Report) */ \
            0x15, 0x00,                   /* Logical Minimum (0), */ \
            0x25, 0x01,                   /* Logical Maximum (1), */ \
            0x95, 0x01,                   /* REPORT_COUNT (1) */ \
            0x75, 0x01,                   /* REPORT_SIZE (1) */ \
            0x91, 0x02,                   /* OUTPUT (Data,Var,Abs) */ \
            0x0A, 0x2C, 0xFF,             /* USAGE (Display Text Data) */ \
            0x27, 0xFF, 0xFF, 0x00, 0x00, /* Logical Maximum (65535) */ \
            0x95, 0x08,                   /* REPORT_COUNT (8)            // 8 unicode char */ \
            0x75, 0x10,                   /* REPORT_SIZE (16) */ \
            0x91, 0x02,                   /* OUTPUT (Data,Var,Abs) */ \
            0xc0,                         /*            END_COLLECTION */ \
            /*--------- Icons Report ------------------------------------ */ \
            0x0A, 0x17, 0xFF, /* USAGE (Icons Control) */ \
            0xA1, 0x02,       /* COLLECTION(Logical) */ \
            0x85, 0x16,       /* Report ID (16) */ \
            0x0A, 0x18, 0xFF, /* USAGE (Presence Icon) */ \
            0x15, 0x00,       /* Logical Minimum (0), */ \
            0x25, 0x0F,       /* Logical Maximum (15), */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) Pading 4 */ \
            0x0A, 0x1A, 0xFF, /* USAGE (Call Forward Icon) */ \
            0x0A, 0x1B, 0xFF, /* USAGE (Voicemail Icon) */ \
            0x0A, 0x1F, 0xFF, /* USAGE (Speaker Icon)??? */ \
            0x0A, 0x20, 0xFF, /* USAGE (Missed Call Icon)??? */ \
            0x25, 0x01,       /* Logical Maximum (1), */ \
            0x95, 0x04,       /* REPORT_COUNT (4) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x02,       /* REPORT_SIZE (2) */ \
            0x15, 0xff,       /* LOGICAL_MINIMUM (-1) */ \
            0x25, 0x01,       /* LOGICAL_MAXIMUM (1) */ \
            0x0A, 0x1C, 0xFF, /* USAGE (Mute Icon) */ \
            0x91, 0x26,       /* OUTPUT (Data, Variable, Relative, No Preferred) 2 bitsd --> output */ \
            0x75, 0x02,       /* REPORT_SIZE (2) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) //Pading 2 */ \
            0xc0,             /* END_COLLECTION */ \
            /*--------- Display Setup Info Report ------------------------------------ */ \
            0xA1, 0x02,                   /* COLLECTION(Logical)*/ \
            0x85, 0x17,                   /* Report ID (17)*/ \
            0x15, 0x00,                   /* Logical Minimum (0),*/ \
            0x27, 0xFF, 0xFF, 0x00, 0x00, /*Logical Maximum (65535)*/ \
            0x95, 0x01,                   /* REPORT_COUNT (1)*/ \
            0x75, 0x10,                   /* REPORT_SIZE (0x10, 16)*/ \
            0x09, 0x64,                   /* USAGE (Language ID Report)*/ \
            0xB1, 0x02,                   /* FEATURE (Data, Variable, Absolute)*/ \
            0x26, 0xFF, 0x00,             /* Logical Maximum (255)*/ \
            0x95, 0x02,                   /* REPORT_COUNT (2)*/ \
            0x75, 0x08,                   /* REPORT_SIZE (8)*/ \
            0x09, 0x65,                   /* USAGE (OC Version)*/ \
            0xB1, 0x02,                   /* FEATURE (Data, Variable, Absolute)*/ \
            0xc0,                         /* 0xc0 // END_COLLECTION*/  \
            0xc0                         /* 0xc0 // END_COLLECTION*/
        };

hathach Feb 25, 2021
Maintainer

you need to change the report ID to be consecutive, 0x85, 0x11, /* Report ID (11) */ \ should be report id = 2, the rest should be adjusted as well.

buildcomics Feb 25, 2021
Author

I tried both making them consecutive (starting the keyboard at 0x10) and starting them all from as in the code below.
However, this all still resulted in the same error on windows (note: the keyboard part in linux is working fine...)

This device cannot start. (Code 10)
Report was not byte aligned.

int8_t const desc_hid_report[] =
        {
            HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP     )                    ,\
            HID_USAGE      ( HID_USAGE_DESKTOP_KEYBOARD )                    ,\
            HID_COLLECTION ( HID_COLLECTION_APPLICATION )                    ,\
                /* Report ID if any */\
                HID_REPORT_ID(REPORT_ID_KEYBOARD) \
                /* 8 bits Modifier Keys (Shfit, Control, Alt) */ \
                HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD )                     ,\
                    HID_USAGE_MIN    ( 224                                    )  ,\
                    HID_USAGE_MAX    ( 231                                    )  ,\
                    HID_LOGICAL_MIN  ( 0                                      )  ,\
                    HID_LOGICAL_MAX  ( 1                                      )  ,\
                    HID_REPORT_COUNT ( 8                                      )  ,\
                    HID_REPORT_SIZE  ( 1                                      )  ,\
                    HID_INPUT        ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE )  ,\
                    /* 8 bit reserved */ \
                    HID_REPORT_COUNT ( 1                                      )  ,\
                    HID_REPORT_SIZE  ( 8                                      )  ,\
                    HID_INPUT        ( HID_CONSTANT                           )  ,\
                    /* 6-byte Keycodes */ \
                    HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD )                     ,\
                        HID_USAGE_MIN    ( 0                                   )     ,\
                        HID_USAGE_MAX    ( 255                                 )     ,\
                        HID_LOGICAL_MIN  ( 0                                   )     ,\
                        HID_LOGICAL_MAX  ( 255                                 )     ,\
                        HID_REPORT_COUNT ( 6                                   )     ,\
                        HID_REPORT_SIZE  ( 8                                   )     ,\
                        HID_INPUT        ( HID_DATA | HID_ARRAY | HID_ABSOLUTE )     ,\
                   HID_USAGE_PAGE  ( HID_USAGE_PAGE_LED                   )       , /*Attemptint to get led page until 24 that includes the telephony ones*/ \
                       HID_USAGE_MIN    ( 1                                       ) ,\
                       HID_USAGE_MAX    ( 24                                      ) ,\
                       HID_REPORT_COUNT ( 5                                       ) ,\
                       HID_REPORT_SIZE  ( 1                                       ) ,\
                       HID_OUTPUT       ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE  ) ,\
                       /* led padding */ \
                       HID_REPORT_COUNT ( 1                                       ) ,\
                       HID_REPORT_SIZE  ( 3                                       ) ,\
                       HID_OUTPUT       ( HID_CONSTANT                            ) ,\
            HID_COLLECTION_END                                                      ,\
            /*-------- LCD display ----------------------------------*/ \
            0x06, 0x99, 0xFF, /* USAGE_PAGE (Custom UC Display)  */ \
            0x09, 0x01,  /* USAGE (UC_DISPLAY) */ \
            0xA1, 0x01,  /* COLLECTION (Application) */ \
            /* ------------ Vendor Extension ------------------------*/ \
            0x0A, 0x00, 0xFF, /* USAGE (Vendor Extension) */ \
            0xa1, 0x02, /* COLLECTION (Logical) */ \
            0x85, 0x02, /* Report ID (02) */ \
            0x15, 0x00, /* Logical Minimum (0), */ \
            0x27, 0xFF, 0xFF, 0x00, 0x00, /* Logical Maximum (65535) */ \
            0x95, 0x01, /*  REPORT_COUNT (1) */ \
            0x75, 0x10, /* REPORT_SIZE (16) */ \
            0x0A, 0x01, 0xFF, /* USAGE (Vendor Id) */ \
            0xB1, 0x03, /* FEATURE (Cnst,Var,Abs) */ \
            0x26, 0xFF, 0x00, /* Logical Maximum (255) */ \
            0x95, 0x02, /* REPORT_COUNT (2) */ \
            0x75, 0x08, /*  REPORT_SIZE (8) */ \
            0x0A, 0x02, 0xFF, /* USAGE (Version) */ \
            0xB1, 0x03, /* FEATURE (Cnst,Var,Abs) */ \
            0xc0, /* END_COLLECTION*/ \
            /* ------------ Display Attributes ------------------------*/ \
            0x09, 0x20, /* USAGE (Display Attributes) */ \
            0xa1, 0x02, /* COLLECTION (Logical) */ \
            0x85, 0x03, /* Report ID (03) */
            0x09, 0x35, /*USAGE (Rows) */ \
            0x09, 0x36, /*USAGE (Columns) */ \
            0x15, 0x00, /*Logical Minimum (0), */ \
            0x26, 0xFF, 0x00, /*Logical Maximum (255) */ \
            0x95, 0x02, /*REPORT_COUNT (2) */ \
            0x75, 0x08, /* REPORT_SIZE (8) */ \
            0xB1, 0x03,/*FEATURE (Cnst,Var,Abs) */ \
            0x19, 0x81, /* USAGE_MINIMUM (first Display Property) */ \
            0x29, 0x8A, /* USAGE_MAXIMUM (last Display Property) */ \
            0x25, 0x01, /* Logical Maximum (1), */ \
            0x95, 0x0A, /* REPORT_COUNT (10) */ \
            0x75, 0x01, /* REPORT_SIZE (1) */ \
            0xB1, 0x03, /* FEATURE (Cnst,Var,Abs) */ \
            0x95, 0x01, /* REPORT_COUNT (1) */ \
            0x75, 0x06, /* REPORT_SIZE (6) */ \
            0xB1, 0x03, /* FEATURE (Const,Var,Abs) Pading 6 */ \
            0xc0,       /* END_COLLECTION */ \
            /* ------------ Display Control Report ------------------------*/ \
            0x09, 0x24,       /* USAGE (Display Control) */ \
            0xA1, 0x02,       /* COLLECTION(Logical) */ \
            0x85, 0x04,       /* Report ID (04) */ \
            0x09, 0x26,       /* USAGE (Enable Display) */ \
            0x09, 0x25,       /* USAGE (Clear Display) */ \
            0x0A, 0x10, 0xFF, /* USAGE (Back Light) */ \
            0x15, 0x00,       /* Logical Minimum (0), */ \
            0x25, 0x01,       /* Logical Maximum (1), */ \
            0x95, 0x03,       /* REPORT_COUNT (3) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x0A, 0x11, 0xFF, /* USAGE (Screen Select) */ \
            0x25, 0x0F,       /* Logical Maximum (15), */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs)  Pading 1*/ \
            0xc0,             /* END_COLLECTION */ \
            /* ------------ Character Attribute Report ------------------------*/ \
            0x09, 0x48,       /* USAGE (Character Attributes) */ \
            0xA1, 0x02,       /* COLLECTION(Logical) */ \
            0x85, 0x05,       /* Report ID (05) */ \
            0x19, 0x81,       /* USAGE_MINIMUM (Local User Name) */ \
            0x29, 0x8A,       /* USAGE_MAXIMUM (Number) */ \
            0x15, 0x01,       /* LOGICAL_MINIMUM (1) */ \
            0x25, 0x0A,       /* LOGICAL_MAXIMUM (10) */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x00,       /* OUTPUT (Data,Ary,Abs) */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) Pading 4 */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x05,       /* REPORT_SIZE (7) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) Pading 7 */ \
            0x0A, 0x22, 0xFF, /* USAGE (Text String Followed) */ \
            0x25, 0x01,       /* Logical Maximum (1), */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0xc0,             /*END_COLLECTION */ \
            /* ------------ Character Report ------------------------*/ \
            0x09, 0x2B,                   /* USAGE (Character Report) */ \
            0xA1, 0x02,                   /* COLLECTION(Logical) */ \
            0x85, 0x06,                   /* Report ID (06) */ \
            0x95, 0x01,                   /* REPORT_COUNT (1) */ \
            0x75, 0x07,                   /* REPORT_SIZE (7) */ \
            0x91, 0x03,                   /* OUTPUT (Const,Var,Abs)            //Pading 7 */ \
            0x0A, 0x24, 0xFF,             /* USAGE (Last Character Report) */ \
            0x15, 0x00,                   /* Logical Minimum (0), */ \
            0x25, 0x01,                   /* Logical Maximum (1), */ \
            0x95, 0x01,                   /* REPORT_COUNT (1) */ \
            0x75, 0x01,                   /* REPORT_SIZE (1) */ \
            0x91, 0x02,                   /* OUTPUT (Data,Var,Abs) */ \
            0x0A, 0x2C, 0xFF,             /* USAGE (Display Text Data) */ \
            0x27, 0xFF, 0xFF, 0x00, 0x00, /* Logical Maximum (65535) */ \
            0x95, 0x08,                   /* REPORT_COUNT (8)            // 8 unicode char */ \
            0x75, 0x10,                   /* REPORT_SIZE (16) */ \
            0x91, 0x02,                   /* OUTPUT (Data,Var,Abs) */ \
            0xc0,                         /*            END_COLLECTION */ \
            /*--------- Icons Report ------------------------------------ */ \
            0x0A, 0x17, 0xFF, /* USAGE (Icons Control) */ \
            0xA1, 0x02,       /* COLLECTION(Logical) */ \
            0x85, 0x07,       /* Report ID (07) */ \
            0x0A, 0x18, 0xFF, /* USAGE (Presence Icon) */ \
            0x15, 0x00,       /* Logical Minimum (0), */ \
            0x25, 0x0F,       /* Logical Maximum (15), */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x75, 0x04,       /* REPORT_SIZE (4) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) Pading 4 */ \
            0x0A, 0x1A, 0xFF, /* USAGE (Call Forward Icon) */ \
            0x0A, 0x1B, 0xFF, /* USAGE (Voicemail Icon) */ \
            0x0A, 0x1F, 0xFF, /* USAGE (Speaker Icon)??? */ \
            0x0A, 0x20, 0xFF, /* USAGE (Missed Call Icon)??? */ \
            0x25, 0x01,       /* Logical Maximum (1), */ \
            0x95, 0x04,       /* REPORT_COUNT (4) */ \
            0x75, 0x01,       /* REPORT_SIZE (1) */ \
            0x91, 0x02,       /* OUTPUT (Data,Var,Abs) */ \
            0x95, 0x01,       /* REPORT_COUNT (1) */ \
            0x75, 0x02,       /* REPORT_SIZE (2) */ \
            0x15, 0xff,       /* LOGICAL_MINIMUM (-1) */ \
            0x25, 0x01,       /* LOGICAL_MAXIMUM (1) */ \
            0x0A, 0x1C, 0xFF, /* USAGE (Mute Icon) */ \
            0x91, 0x26,       /* OUTPUT (Data, Variable, Relative, No Preferred) 2 bitsd --> output */ \
            0x75, 0x02,       /* REPORT_SIZE (2) */ \
            0x91, 0x03,       /* OUTPUT (Const,Var,Abs) //Pading 2 */ \
            0xc0,             /* END_COLLECTION */ \
            /*--------- Display Setup Info Report ------------------------------------ */ \
            0xA1, 0x02,                   /* COLLECTION(Logical)*/ \
            0x85, 0x08,                   /* Report ID (08)*/ \
            0x15, 0x00,                   /* Logical Minimum (0),*/ \
            0x27, 0xFF, 0xFF, 0x00, 0x00, /*Logical Maximum (65535)*/ \
            0x95, 0x01,                   /* REPORT_COUNT (1)*/ \
            0x75, 0x10,                   /* REPORT_SIZE (0x10, 16)*/ \
            0x09, 0x64,                   /* USAGE (Language ID Report)*/ \
            0xB1, 0x02,                   /* FEATURE (Data, Variable, Absolute)*/ \
            0x26, 0xFF, 0x00,             /* Logical Maximum (255)*/ \
            0x95, 0x02,                   /* REPORT_COUNT (2)*/ \
            0x75, 0x08,                   /* REPORT_SIZE (8)*/ \
            0x09, 0x65,                   /* USAGE (OC Version)*/ \
            0xB1, 0x02,                   /* FEATURE (Data, Variable, Absolute)*/ \
            0xc0,                         /* 0xc0 // END_COLLECTION*/  \
            0xc0                         /* 0xc0 // END_COLLECTION*/
        };

usb descriptors.h:

enum {
    REPORT_ID_KEYBOARD = 1
};

buildcomics · 2021-02-25T21:17:56Z

buildcomics
Feb 25, 2021
Author

I fixed the report not aligned error, somewhere in the PDF there is a line that says:
0x75, 0x05, // REPORT_SIZE (7)

Which does not match, the REPORT_SIZE should be 7, so 0x07 and not 0x05. I pushed my new code to github.

I also changed my vendor id to microsoft as per the document:
“Vendor Id” returns the ID of the vendor whose vendor-specific Alphanumeric Display usage page is supported by the device. This must be set to 0x045e (Microsoft) and is not configurable.

Unfortunately, I am getting absolutely zero reports in from teams or skype for presence icons as I expected. I get in my num/caps lock reports (which I can see through the debug print function I built in, log and debug still not working on the pico despite a rm * -rf in the build folder, and a "clean" cmake .. and make LOG=2 DEBUG=1 command).

So no cigar yet. I am thinking somewhere in this text is the clue to why it's not working:
Skype for Business display functionality is a Microsoft proprietary protocol and cannot be implemented using only the usages defined in the industry standard version 2 of the Alphanumeric Display usage page. Skype for Business will send an appropriate HID Report Descriptors upon receiving an UCQ string descriptor from the device. Devices supporting display functionality must implement a partner specific page, FF99, in addition to the usages described below.

But I'll be damned if I know what I should add to the descriptor to get this puppy to work...

0 replies

buildcomics · 2021-03-05T23:04:33Z

buildcomics
Mar 5, 2021
Author

OK, New plan. Hope you can help me with this one. I "copied" a HID descriptor from a Kuando Busylight. I did some usb captures, and by going through them, the data seems to be transferred using " URB_INTERRUPT out" according to wireshark:

65	17.086549	host	1.12.1	USB	91	URB_INTERRUPT out

Frame 65: 91 bytes on wire (728 bits), 91 bytes captured (728 bits)
    Encapsulation type: USB packets with USBPcap header (152)
    Arrival Time: Mar  5, 2021 10:54:30.146412000 CET
    [Time shift for this packet: 0.000000000 seconds]
    Epoch Time: 1614938070.146412000 seconds
    [Time delta from previous captured frame: 1.022837000 seconds]
    [Time delta from previous displayed frame: 1.022837000 seconds]
    [Time since reference or first frame: 17.086549000 seconds]
    Frame Number: 65
    Frame Length: 91 bytes (728 bits)
    Capture Length: 91 bytes (728 bits)
    [Frame is marked: False]
    [Frame is ignored: False]
    [Protocols in frame: usb:usbhid]
USB URB
    [Source: host]
    [Destination: 1.12.1]
    USBPcap pseudoheader length: 27
    IRP ID: 0xffff9987d74b6860
    IRP USBD_STATUS: USBD_STATUS_SUCCESS (0x00000000)
    URB Function: URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER (0x0009)
    IRP information: 0x00, Direction: FDO -> PDO
        0000 000. = Reserved: 0x00
        .... ...0 = Direction: FDO -> PDO (0x0)
    URB bus id: 1
    Device address: 12
    Endpoint: 0x01, Direction: OUT
        0... .... = Direction: OUT (0)
        .... 0001 = Endpoint number: 1
    URB transfer type: URB_INTERRUPT (0x01)
    Packet Data Length: 64
    [Response in: 66]
    [bInterfaceClass: HID (0x03)]
HID Data: 8f0000000000000000000000000000000000000000000000000000000000000000000000…
    Vendor Data: 8f0000000000000000000000000000000000000000000000000000000000000000000000…

But using my current callbacks:
tud_mount_cb
tud_umount_cb
tud_suspend_cb
tud_resume_cb
tud_hid_get_report_cb
tud_hid_set_report_cb

I do not see this data coming in anywhere.

So my question to you is, how can I capture and answer this "HID Data"?

3 replies

hathach Mar 7, 2021
Maintainer

Try to build the stack with debug log to see how the data is transferred,
https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md#debug

or if you are more serious with USB. buy an hardware analyzer to see the actual data on the bus.

buildcomics Mar 9, 2021
Author

I tried doing that, but my make setup does not seem to tag along. I took the make setup from raspberry pi pico (which includes tinyusb). However, I see nothing in my makefile to setup the flags correctly.

I added the two lines in my CMakeLists.txt file to hopefully make this happen:

cmake_minimum_required(VERSION 3.13)

include(pico_sdk_import.cmake)

project(main)

pico_sdk_init()

add_executable(main
        main.c
        usb_descriptors.c
        )

pico_enable_stdio_uart(main 1)

pico_add_extra_outputs(main)

target_include_directories(main PRIVATE ${CMAKE_CURRENT_LIST_DIR})

target_link_libraries(main PRIVATE pico_stdlib tinyusb_device tinyusb_board)

set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Og -DCFG_TUSB_DEBUG=1")
set(CMAKE_DEFSYM "${CMAKE_DEFSYM} -DLOG=2")

But to no avail, here are the "makefiles" that it spits out:
https://gist.github.com/buildcomics/1382c27b2a71d1ba470ca7cc9184d2f8

hathach Mar 10, 2021
Maintainer

I am not expert on using cmake with pico-sdk as well, but you could try. You need to do a clean and re-build, you will need deubg = 2 to see the transfer, debug=1 will only output fatal error.

target_compile_definitions(${PROJECT} PUBLIC CFG_TUSB_DEBUG=2)

For further cmake, I am afraid you have to ask rpi folks for help.

buildcomics · 2021-03-13T21:27:06Z

buildcomics
Mar 13, 2021
Author

Cool, I got it to work (uploaded my changes to github) with debug, Had set it to one, setting it to "2" fixed it. It said "1" on https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md#debug , I guess that it is why I had set it to "1".

I uploaded the wireshark capture of the pico (and the USB Device I'm trying to mimic). They are all in my repo, and I updated the description in the readme as to how I filtered out the data: https://github.com/buildcomics/MST_keyboard
I put the last put of debug output below.

I am still looking for that "HID Data" that was sent. For the actual USB device it is showing up as an "URB_INTERRUPT in". The pico shows something simular, but now it is a "USBHID" "SET_REPORT Request"

It seems to come in as a "USBD Setup", "HID control request" as far as I can see below.

Now my question is, how do I capture this HID control request, the data attached to it and "answer" it.

Is there a callback function for the USBD Setup and/or HID Control request?

USBD Setup Received 80 06 00 02 00 00 22 00 
  Get Descriptor Configuration[0]
DEBUG: tud_descriptor_configuration_cb triggered
index: 0
  Queue EP 80 with 34 bytes
USBD Xfer Complete on EP 80 with 34 bytes
  Queue EP 00 with zlp Status
USBD Xfer Complete on EP 00 with 0 bytes

USBD Setup Received 00 01 01 00 00 00 00 00 
  Clear Feature
  Queue EP 80 with zlp Status
USBD Xfer Complete on EP 80 with 0 bytes

USBD Setup Received 21 0A 00 00 00 00 00 00 
  HID control request
  Queue EP 80 with zlp Status
USBD Xfer Complete on EP 80 with 0 bytes

USBD Setup Received 00 01 01 00 00 00 00 00 
  Clear Feature
  Queue EP 80 with zlp Status
USBD Xfer Complete on EP 80 with 0 bytes

USBD Setup Received 21 0A 00 00 00 00 00 00 
  HID control request
  Queue EP 80 with zlp Status
USBD Xfer Complete on EP 80 with 0 bytes

0 replies

buildcomics · 2021-03-13T22:21:26Z

buildcomics
Mar 13, 2021
Author

I have a suspicion of the cause, when looking at the code in hid_device.c, I noticed the comparison of the bm REquest type with TUSB_REQ_TYPE_CLASS.:

// Invoked when class request DATA stage is finished.
// return false to stall control endpoint (e.g Host send non-sense DATA)
bool hidd_control_complete(uint8_t rhport, tusb_control_request_t const * p_request)
{
  (void) rhport;

  uint8_t const hid_itf = get_index_by_itfnum((uint8_t) p_request->wIndex);
  TU_VERIFY(hid_itf < CFG_TUD_HID);

  hidd_interface_t* p_hid = &_hidd_itf[hid_itf];

  if (p_request->bmRequestType_bit.type == TUSB_REQ_TYPE_CLASS &&
      p_request->bRequest == HID_REQ_CONTROL_SET_REPORT)
  {
    // wValue = Report Type | Report ID
    uint8_t const report_type = tu_u16_high(p_request->wValue);
    uint8_t const report_id   = tu_u16_low(p_request->wValue);

    tud_hid_set_report_cb(
        #if CFG_TUD_HID > 1 
        hid_itf, // TODO for backward compatible callback, remove later when appropriate
        #endif
        report_id, (hid_report_type_t) report_type, p_hid->epout_buf, p_request->wLength
    );  
  }

  return true;
}

Looking at my pcaps, this value is 0x21

Looking at the code, the defined value in the code below is 2

typedef enum
{
  TUSB_REQ_TYPE_STANDARD = 0,
  TUSB_REQ_TYPE_CLASS,
  TUSB_REQ_TYPE_VENDOR,
  TUSB_REQ_TYPE_INVALID
} tusb_request_type_t;

So is this HID action "illegal"? According to https://www.beyondlogic.org/usbnutshell/usb6.shtml
this request type is "reserved", so do I need to modify tiny usb source code to work with this request type?

3 replies

hathach Mar 14, 2021
Maintainer

0x21 is class request to interface, 0x0A is set idle. What is your problem with hid control that you are dealing with ? I didn't see any abnormal in the log

buildcomics Mar 14, 2021
Author

I would have expected a line that triggered one of my _cb functions, particularly something like tud_hid_set_report_cb

I put a DEBUG: ... <function name> triggered in every _cb function in my main.c

However, after DEBUG: tud_descriptor_configuration_cb triggered I see no more DEBUG statements from these functions.

What I want to achieve is to "answer" the below request, but I don't know how yet. I see the request in the usb pcaptures, and in the debug output of tusb, but not yet in my own debug output. Here is the PCAP section i am trying to answer:

Setup Data
    bmRequestType: 0x21
    bRequest: SET_REPORT (0x09)
    wValue: 0x0200
    wIndex: 0
    wLength: 64
    bRequest: 9
    wValue: 0x0200
    wIndex: 0 (0x0000)
    wLength: 64
    Data Fragment: 8f0000000000000000000000000000000000000000000000000000000000000000000000…

//Edit:

I think I didn't look right, and you are correct, the _cb function is triggered :-) :

USBD Setup Received 21 09 00 02 00 00 40 00 
  HID control request
  Queue EP 00 with 64 bytes
USBD Xfer Complete on EP 00 with 64 bytes
  HID control complete
DEBUG: tud_hid_set_report_cb triggered
DEBUG: report_id: 0
DEBUG: report_type: 2
DEBUG: bufsize: 64
DEBUG: buffer content:
8F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 04 55 FF FF FF 03 EB  - End 
  Queue EP 80 with zlp Status
USBD Xfer Complete on EP 80 with 0 bytes

Now I have only one question remaining, how do I "answer" this tud_hid_set_report_cb ?
The actual device is sending the folowing:

Frame 4263: 91 bytes on wire (728 bits), 91 bytes captured (728 bits)
USB URB
    [Source: 2.11.1]
    [Destination: host]
    USBPcap pseudoheader length: 27
    IRP ID: 0xffffab8a2726b4b0
    IRP USBD_STATUS: USBD_STATUS_SUCCESS (0x00000000)
    URB Function: URB_FUNCTION_BULK_OR_INTERRUPT_TRANSFER (0x0009)
    IRP information: 0x01, Direction: PDO -> FDO
    URB bus id: 2
    Device address: 11
    Endpoint: 0x81, Direction: IN
    URB transfer type: URB_INTERRUPT (0x01)
    Packet Data Length: 64
    [Request in: 4254]
    [Time from request: 0.065855000 seconds]
    [bInterfaceClass: HID (0x03)]
HID Data: 30303031504c454e4f4d3030303030313030303030303031444153414e30303032303135…
    Vendor Data: 30303031504c454e4f4d3030303030313030303030303031444153414e30303032303135…

hathach Mar 14, 2021
Maintainer

physically, there is eitherr ACK, or stall the control. The report data is presented by the callback already. In USB, device doesn't answer until the host ask. Everything at stack level is already implemented, it is up to you to implement the hid profile.

buildcomics · 2021-03-14T12:04:14Z

buildcomics
Mar 14, 2021
Author

Allright, I figured it out. I used the tid_hid_report function to "answer". Code snippet below, full code on github
hathach and chegewara: thank you very much for answering my questions! The (final) result off my Microsoft Teams Keyboard will hopefully be finished soon and posted on my website and/or socials/youtube.

const char setup_request_string[] = {
        0x8f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x06, 0x04, 0x55, 0xff, 0xff, 0xff, 0x03, 0xeb
    };

    if (strcmp(buffer, setup_request_string) == 0) {
        printf("DEBUG: Matching setup request string, answering\n");
        const char setup_request_return[] = {
            0x30, 0x30, 0x30, 0x31, 0x50, 0x4c, 0x45, 0x4e,
            0x4f, 0x4d, 0x30, 0x30, 0x30, 0x30, 0x30, 0x31,
            0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x31,
            0x44, 0x41, 0x53, 0x41, 0x4e, 0x30, 0x30, 0x30,
            0x32, 0x30, 0x31, 0x35, 0x30, 0x35, 0x32, 0x38,
            0x30, 0x32, 0x31, 0x30, 0x30, 0x30, 0x30, 0x30,
            0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
            0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30
        };
        tud_hid_report(0, &setup_request_return, sizeof(setup_request_return));
    }

1 reply

hathach Mar 14, 2021
Maintainer

I am glad you figured it out. Yeah, it makes sense that host would expect the “answer” in the next report.

buildcomics · 2021-03-17T20:15:11Z

buildcomics
Mar 17, 2021
Author

I'm afraid I'm not quite there yet. I wanted to "add" keyboard functionality to my device, so I updated the HID descriptor as per below. Unfortunately, now things stop working somehow... I do not get the program to send me it's normal HID reports for some reason. I am afraid I messed up my HID descriptor. Even though the below is not working, it also is not working as soon as I add the HID_REPORT_ID to the descriptor. Is there any reason this all of a sudden can change things?

uint8_t const desc_hid_report[] =
        {
        0x06, 0x00, 0xFF, /* USAGE_PAGE (0xFF00)  */ \
        HID_USAGE      ( HID_USAGE_DESKTOP_KEYBOARD )                    ,\
            HID_COLLECTION ( HID_COLLECTION_APPLICATION )                    ,\
                HID_REPORT_ID(0x01)                                                \
                HID_USAGE_MIN    ( 0x40                                    )  ,\
                HID_USAGE_MAX    ( 0x40                                    )  ,\
                HID_LOGICAL_MIN  ( 0                                      )  ,\
                0x26, 0xFF, 0x00, /* Logical Maximum (255) */ \
                HID_REPORT_SIZE  ( 8                                      )  ,\
                HID_REPORT_COUNT ( 64                                      )  ,\
                HID_INPUT        ( HID_DATA)  ,\
                HID_USAGE_MIN    ( 0x40                                    )  ,\
                HID_USAGE_MAX    ( 0x40                                    )  ,\
                HID_OUTPUT       ( HID_DATA ) ,\
            HID_COLLECTION_END, \
            TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(0x02) )
        };

2 replies

FFY00 Apr 3, 2021

Can you post the full report descriptor?

buildcomics Apr 4, 2021
Author

It is the one I posted in my previous post:

uint8_t const desc_hid_report[] =
        {
        0x06, 0x00, 0xFF, /* USAGE_PAGE (0xFF00)  */ \
        HID_USAGE      ( HID_USAGE_DESKTOP_KEYBOARD )                    ,\
            HID_COLLECTION ( HID_COLLECTION_APPLICATION )                    ,\
                HID_REPORT_ID(0x01)                                                \
                HID_USAGE_MIN    ( 0x40                                    )  ,\
                HID_USAGE_MAX    ( 0x40                                    )  ,\
                HID_LOGICAL_MIN  ( 0                                      )  ,\
                0x26, 0xFF, 0x00, /* Logical Maximum (255) */ \
                HID_REPORT_SIZE  ( 8                                      )  ,\
                HID_REPORT_COUNT ( 64                                      )  ,\
                HID_INPUT        ( HID_DATA)  ,\
                HID_USAGE_MIN    ( 0x40                                    )  ,\
                HID_USAGE_MAX    ( 0x40                                    )  ,\
                HID_OUTPUT       ( HID_DATA ) ,\
            HID_COLLECTION_END, \
            TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(0x02) )
        };

The only difference with the working one is the addition of HID_REPORT_ID(0x01) and TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(0x02) )

The full description of HID_REPORT_DESC_KEYBOARD comes from the tinyusb HID library itself and can be found here: https://github.com/hathach/tinyusb/blob/master/src/class/hid/hid_device.h

For reference, this one will work:

uint8_t const desc_hid_report[] =
        {
            0x06, 0x00, 0xFF, /* USAGE_PAGE (Custom UC Display)  */ \
            HID_USAGE      ( 0x01 )                    ,\
            HID_COLLECTION ( HID_COLLECTION_APPLICATION )                    ,\
                /* Report ID if any */\
                HID_USAGE_MIN    ( 0x40                                    )  ,\
                HID_USAGE_MAX    ( 0x40                                    )  ,\
                HID_LOGICAL_MIN  ( 0                                      )  ,\
                0x26, 0xFF, 0x00, /* Logical Maximum (255) */ \
                HID_REPORT_SIZE  ( 8                                      )  ,\
                HID_REPORT_COUNT ( 64                                      )  ,\
                HID_INPUT        ( HID_DATA)  ,\
                HID_USAGE_MIN    ( 0x40                                    )  ,\
                HID_USAGE_MAX    ( 0x40                                    )  ,\
                HID_OUTPUT       ( HID_DATA ) ,\
            HID_COLLECTION_END                                                      ,\
};

But obviously is missing the possibility to combine a keyboard together with this device because it does not have the report ID and the actual keyboard HID description.

ryborg · 2021-04-21T19:23:20Z

ryborg
Apr 21, 2021

Related: I started building the very same thing, but my approach was to build a chrome extension that interacts with the web version of Teams to run functions and read data. Hint: you have to load React.js in debug mode, then you have proper scope to access all the functions and variables. That's where I was able to get the call status, camera toggles etc.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Logging and Telephony HID device #667

{{title}}

Replies: 9 comments 16 replies

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Logging and Telephony HID device #667

buildcomics Feb 20, 2021

Replies: 9 comments · 16 replies

chegewara Feb 20, 2021

buildcomics Feb 20, 2021 Author

chegewara Feb 20, 2021

hathach Feb 22, 2021 Maintainer

buildcomics Feb 22, 2021 Author

hathach Feb 22, 2021 Maintainer

buildcomics Feb 24, 2021 Author

hathach Feb 25, 2021 Maintainer

buildcomics Feb 25, 2021 Author

buildcomics Feb 25, 2021 Author

buildcomics Mar 5, 2021 Author

hathach Mar 7, 2021 Maintainer

buildcomics Mar 9, 2021 Author

hathach Mar 10, 2021 Maintainer

buildcomics Mar 13, 2021 Author

buildcomics Mar 13, 2021 Author

hathach Mar 14, 2021 Maintainer

buildcomics Mar 14, 2021 Author

hathach Mar 14, 2021 Maintainer

buildcomics Mar 14, 2021 Author

hathach Mar 14, 2021 Maintainer

buildcomics Mar 17, 2021 Author

FFY00 Apr 3, 2021

buildcomics Apr 4, 2021 Author

ryborg Apr 21, 2021

buildcomics
Feb 20, 2021

Replies: 9 comments 16 replies

chegewara
Feb 20, 2021

buildcomics Feb 20, 2021
Author

hathach
Feb 22, 2021
Maintainer

buildcomics Feb 22, 2021
Author

hathach Feb 22, 2021
Maintainer

buildcomics Feb 24, 2021
Author

hathach Feb 25, 2021
Maintainer

buildcomics Feb 25, 2021
Author

buildcomics
Feb 25, 2021
Author

buildcomics
Mar 5, 2021
Author

hathach Mar 7, 2021
Maintainer

buildcomics Mar 9, 2021
Author

hathach Mar 10, 2021
Maintainer

buildcomics
Mar 13, 2021
Author

buildcomics
Mar 13, 2021
Author

hathach Mar 14, 2021
Maintainer

buildcomics Mar 14, 2021
Author

hathach Mar 14, 2021
Maintainer

buildcomics
Mar 14, 2021
Author

hathach Mar 14, 2021
Maintainer

buildcomics
Mar 17, 2021
Author

buildcomics Apr 4, 2021
Author

ryborg
Apr 21, 2021