How to control Caps Lock / Num Lock / Scroll Lock LEDs in HID Keyboard Driver?

[Unais_Kn]

Hi everyone,

I’m working on an HID keyboard using an NXP MCU and the USB HID keyboard driver.
I would like to control the keyboard LEDs (Caps Lock, Num Lock, and Scroll Lock).

Specifically, I’m trying to understand:

1. How the host sends LED status (Caps Lock / Num Lock / Scroll Lock) to the device

2. Which HID report or callback in the NXP HID keyboard driver receives this LED information

3. How to correctly parse the LED output report and map it to GPIOs to turn the keyboard LEDs ON/OFF

I’m using the NXP USB HID stack, and the keyboard enumeration is working correctly. Key press reports are sent successfully, but I’m not sure where or how to handle the LED output report from the host.

If possible, sample code or references to the relevant driver files/functions would be very helpful.

Thanks in advance!

[Unais_Kn]

The USB_HostHidSetReport() function is working correctly. However, the implementation requires that USB_HostHidGetReport() be called after every SetReport operation to ensure proper behavior. Is there a specific reason why a GetReport call is required after each SetReport?

Below is the current implementation:

USB_HostHidSetReport(
    g_HostHidKeyboard.classHandle,   /* HID class instance */
    HID_NO_REPORT_ID,                /* Report ID = 0 */
    HID_REPORT_TYPE_OUTPUT,          /* Output report */
    &buffer,                         /* 1-byte LED report */
    sizeof(buffer),
    NULL,                            /* Completion callback */
    NULL
);

USB_HostHidGetReport(
    g_HostHidKeyboard.classHandle,
    HID_NO_REPORT_ID,
    HID_REPORT_TYPE_OUTPUT,          /* Report type */
    &ReportGet,
    1,
    NULL,
    NULL
);

• Report ID: 0x00

• Report Type: 0x02

The following function demonstrates the full sequence:

static void Keyboard_SetReport(uint8_t buffer)
{
    usb_status_t status;
    uint8_t ReportGet;

    vTaskDelay(50 / portTICK_PERIOD_MS);
    usb_echo("Keyboard_SetReport - %d\r\n", buffer);

    status = USB_HostHidSetReport(
        g_HostHidKeyboard.classHandle,   /* HID class instance */
        HID_NO_REPORT_ID,                /* Report ID = 0 */
        HID_REPORT_TYPE_OUTPUT,          /* Output report */
        &buffer,                         /* 1-byte LED report */
        sizeof(buffer),
        NULL,                            /* Completion callback */
        NULL
    );

    vTaskDelay(10 / portTICK_PERIOD_MS);

    status = USB_HostHidGetReport(
        g_HostHidKeyboard.classHandle,
        HID_NO_REPORT_ID,
        HID_REPORT_TYPE_OUTPUT,
        &ReportGet,
        1,
        NULL,
        NULL
    );

    if (status != kStatus_USB_Success)
    {
        usb_echo("Error in USB_HostHidSetReport call - %d\r\n", status);
        /* Handle error */
    }
}

[Bio_TICFSL]

Hello,

Control keyboard LEDs (Caps/Num/Scroll Lock) on an NXP MCU

by implementing an HID Output Report handler within your USB stack to receive 1-byte status updates from the host (bit 0: Num, bit 1: Caps, bit 2: Scroll). Update GPIO pins based on this byte in the USB_DeviceHidKeyboardAction or equivalent callback. 

Key Implementation Details

• Report Structure: The host sends a 1-byte output report where bits represent the lock states:
  • Bit 0: Num Lock
  • Bit 1: Caps Lock
  • Bit 2: Scroll Lock
• NXP Implementation: In NXP SDK examples, this is typically handled by modifying the USB_DeviceHidKeyboardAction function or setting up the endpoint 0 callback to process USB_DEV_EVENT_SET_REPORT.
• Callback Routine: When the host sends the report, the USB stack triggers a callback. You must parse the received data and update the GPIOs controlling the LEDs.
• Example Code Snippet:
  c

  // Inside your USB HID callback
  if (event == USB_DEV_EVENT_SET_REPORT) {
      uint8_t *led_report = (uint8_t *)param;
      if (led_report[0] & 0x01) { /* Turn on NumLock LED */ }
      if (led_report[0] & 0x02) { /* Turn on CapsLock LED */ }
      if (led_report[0] & 0x04) { /* Turn on ScrollLock LED */ }
  }
  

   

Ensure your HID report descriptor properly defines an Output report for the LED indicators (usage page 0x08, LEDs

Regards

[Unais_Kn]

I am unable to locate the USB_DeviceHidKeyboardAction function in the NXP SDK HID keyboard example.

Is it possible to use the USB_HostHidSetReport and USB_HostHidGetReport APIs to configure and manage HID reports instead? If so, could you please provide an example function demonstrating how to use these APIs for report handling?

Additionally, how can we verify that the HID report descriptor correctly defines an Output Report for keyboard LED indicators (such as Num Lock, Caps Lock, and Scroll Lock)?