Skip to content

hid: fix system control array descriptor so system sleep key works#831

Merged
HaoboGu merged 1 commit into
HaoboGu:mainfrom
jpds:fix/system-control-hid-descriptor
May 5, 2026
Merged

hid: fix system control array descriptor so system sleep key works#831
HaoboGu merged 1 commit into
HaoboGu:mainfrom
jpds:fix/system-control-hid-descriptor

Conversation

@jpds
Copy link
Copy Markdown
Contributor

@jpds jpds commented May 4, 2026

I noticed that pressing the system sleep key on my keymap did nothing. The HID system control descriptor had usage_min = 0x81 with logical_min = 1, which caused the host to resolve the sleep usage ID to an out-of-range value and discard it.

Fix is a one-byte descriptor change: usage_min = 0x01. No behaviour change for any other report type.

Tested with a Linux desktop.

@jpds
hid: fix system control array descriptor so system sleep key works
1e9a987 
The HID CompositeReport descriptor had usage_min = 0x81 paired with
logical_min = 1. For array-type inputs, the host resolves a received
value N to a usage as:

    usage = usage_min + (N - logical_min)

With those values, sending 0x82 (Sleep) resolves to
0x81 + (0x82 - 1) = 0x102 -- outside the declared usage range and
silently ignored by the host.

Fix: set usage_min = 0x01 to match logical_min = 1, so the formula
collapses to usage = N and the raw usage ID passes through correctly.

The descriptor byte count is unchanged, so the BLE report_map size
assumption in ble_server.rs is unaffected.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 4, 2026

Size Report

Example main PR Diff .text .data .bss
use_config/nrf52832_ble 354.6 KiB 354.6 KiB +0.00% ⬆️ +12 0 0
use_config/nrf52840_ble 404.4 KiB 404.4 KiB +0.00% ⬆️ +12 0 0
use_config/nrf52840_ble_split (central) 480.0 KiB 480.0 KiB +0.00% ⬆️ +12 0 0
use_config/nrf52840_ble_split (peripheral) 307.7 KiB 307.7 KiB +0.00% 0 0 0
use_config/pi_pico_w_ble 638.1 KiB 638.1 KiB +0.00% ⬇️ -48 0 0
use_config/rp2040 144.8 KiB 144.8 KiB +0.00% ⬇️ -4 0 0
use_config/rp2040_split (central) 156.6 KiB 156.6 KiB +0.00% ⬆️ +4 0 0
use_config/rp2040_split (peripheral) 25.9 KiB 25.9 KiB +0.00% 0 0 0
use_config/stm32f1 62.2 KiB 62.2 KiB +0.00% 0 0 0
use_config/stm32h7 97.8 KiB 97.8 KiB +0.00% ⬆️ +4 0 0
use_rust/nrf52832_ble 343.7 KiB 343.7 KiB +0.00% ⬆️ +8 0 0
use_rust/nrf52840_ble 399.5 KiB 399.5 KiB +0.00% ⬆️ +8 0 0
use_rust/nrf52840_ble_split (central) 488.0 KiB 488.0 KiB +0.00% ⬆️ +8 0 0
use_rust/nrf52840_ble_split (peripheral) 304.4 KiB 304.4 KiB +0.00% ⬇️ -8 0 0
use_rust/pi_pico_w_ble 638.6 KiB 638.5 KiB +0.00% ⬇️ -20 0 0
use_rust/rp2040 144.5 KiB 144.5 KiB +0.00% 0 0 0
use_rust/rp2040_split (central) 155.9 KiB 155.9 KiB +0.00% ⬆️ +4 0 0
use_rust/rp2040_split (peripheral) 26.4 KiB 26.4 KiB -0.01% ⬇️ -4 0 0
use_rust/stm32f1 61.7 KiB 61.7 KiB +0.00% 0 0 0
use_rust/stm32h7 119.5 KiB 119.5 KiB +0.00% 0 0 0
use_config/nrf52832_ble — 354.6 KiB → 354.6 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 324632	   5192	  33320	 363144	  58a88	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 324620	   5192	  33320	 363132	  58a7c	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +208  [ = ]       0    .debug_str
  +0.0%     +64  [ = ]       0    .debug_ranges
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +25  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.2%     +16  [ = ]       0    .debug_abbrev
  +0.0%     +12  +0.0%     +12    .text
  +0.0%      +8  [ = ]       0    .debug_aranges
 -21.3%     -13  [ = ]       0    [Unmapped]
  -0.1%    -261  [ = ]       0    .debug_line
  -0.2% -1.02Ki  [ = ]       0    .debug_loc
  -0.2% -2.96Ki  [ = ]       0    .debug_info
  -0.1% -3.87Ki  +0.0%     +12    TOTAL
use_config/nrf52840_ble — 404.4 KiB → 404.4 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 358772	   5200	  50096	 414068	  65174	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 358760	   5200	  50096	 414056	  65168	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .debug_ranges
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +25  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.0%     +12  +0.0%     +12    .text
  +0.0%      +8  [ = ]       0    .debug_aranges
 -20.0%     -11  [ = ]       0    [Unmapped]
  -0.1%    -228  [ = ]       0    .debug_line
  -0.0%    -882  [ = ]       0    .debug_str
  -0.2% -1.03Ki  [ = ]       0    .debug_loc
  -0.1% -2.85Ki  [ = ]       0    .debug_info
  -0.1% -4.85Ki  +0.0%     +12    TOTAL
use_config/nrf52840_ble_split (central) — 480.0 KiB → 480.0 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 439068	   6524	  45904	 491496	  77fe8	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 439056	   6524	  45904	 491484	  77fdc	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .debug_ranges
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +25  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.0%     +12  +0.0%     +12    .text
  +0.0%      +8  [ = ]       0    .debug_aranges
 -19.4%     -13  [ = ]       0    [Unmapped]
  -0.1%    -224  [ = ]       0    .debug_line
  -0.0%    -454  [ = ]       0    .debug_str
  -0.1% -1.03Ki  [ = ]       0    .debug_loc
  -0.1% -2.66Ki  [ = ]       0    .debug_info
  -0.1% -4.24Ki  +0.0%     +12    TOTAL
use_config/nrf52840_ble_split (peripheral) — 307.7 KiB → 307.7 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 282704	   5888	  26520	 315112	  4cee8	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 282704	   5888	  26520	 315112	  4cee8	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1% +1.28Ki  [ = ]       0    .debug_str
  +0.0%    +549  [ = ]       0    .debug_info
  +0.0%     +32  [ = ]       0    .debug_loc
  +3.1%      +2  [ = ]       0    [Unmapped]
  +0.0% +1.85Ki  [ = ]       0    TOTAL
use_config/pi_pico_w_ble — 638.1 KiB → 638.1 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 598884	      0	  54488	 653372	  9f83c	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 598932	      0	  54488	 653420	  9f86c	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -0.0%      -8  [ = ]       0    .debug_aranges
 -27.1%     -16  [ = ]       0    [Unmapped]
  -0.1%     -28  [ = ]       0    .debug_frame
  -0.0%     -32  [ = ]       0    .symtab
  -0.0%     -48  -0.0%     -48    .text
  -0.0%    -103  [ = ]       0    .debug_line
  -0.1%    -112  [ = ]       0    .debug_ranges
  -0.1%    -150  [ = ]       0    .strtab
  -0.0%    -463  [ = ]       0    .debug_str
  -0.0%    -897  [ = ]       0    .debug_info
  -0.1% -1.03Ki  [ = ]       0    .debug_loc
  -0.0% -2.85Ki  -0.0%     -48    TOTAL
use_config/rp2040 — 144.8 KiB → 144.8 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 133192	      0	  15092	 148284	  2433c	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 133196	      0	  15092	 148288	  24340	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +499  [ = ]       0    .debug_str
  +0.0%    +475  [ = ]       0    .debug_info
  +0.0%     +32  [ = ]       0    .debug_loc
  +2.6%      +1  [ = ]       0    [Unmapped]
  -0.0%      -4  -0.0%      -4    .text
  -0.1%    -111  [ = ]       0    .debug_line
  +0.0%    +892  -0.0%      -4    TOTAL
use_config/rp2040_split (central) — 156.6 KiB → 156.6 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 144500	      0	  15864	 160364	  2726c	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 144496	      0	  15864	 160360	  27268	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .debug_loc
  +0.0%      +4  +0.0%      +4    .text
  -9.5%      -6  [ = ]       0    [Unmapped]
  -0.0%     -67  [ = ]       0    .debug_line
  -0.0%    -272  [ = ]       0    .debug_info
  -0.0%    -399  [ = ]       0    .debug_str
  -0.0%    -708  +0.0%      +4    TOTAL
use_config/rp2040_split (peripheral) — 25.9 KiB → 25.9 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  24016	     56	   2412	  26484	   6774	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  24016	     56	   2412	  26484	   6774	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  -2.6%      -1  [ = ]       0    [Unmapped]
  -0.0%      -3  [ = ]       0    .debug_str
  -0.0%      -4  [ = ]       0    TOTAL
use_config/stm32f1 — 62.2 KiB → 62.2 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  56272	     28	   7416	  63716	   f8e4	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  56272	     28	   7416	  63716	   f8e4	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +5  [ = ]       0    .debug_line
  +2.9%      +2  [ = ]       0    [Unmapped]
  +0.0%      +1  [ = ]       0    .debug_info
  -0.0%      -8  [ = ]       0    .debug_str
  [ = ]       0  [ = ]       0    TOTAL
use_config/stm32h7 — 97.8 KiB → 97.8 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  90428	    268	   9464	 100160	  18740	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  90424	    268	   9464	 100156	  1873c	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +557  [ = ]       0    .debug_str
  +0.0%      +4  +0.0%      +4    .text
  -8.7%      -4  [ = ]       0    [Unmapped]
  -0.1%    -161  [ = ]       0    .debug_line
  -0.0%    -344  [ = ]       0    .debug_info
  +0.0%     +52  +0.0%      +4    TOTAL
use_rust/nrf52832_ble — 343.7 KiB → 343.7 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 314408	   5200	  32304	 351912	  55ea8	rmk-nrf52832

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 314400	   5200	  32304	 351904	  55ea0	rmk-nrf52832

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%     +64  [ = ]       0    .symtab
  +0.0%     +50  [ = ]       0    .strtab
  +0.1%     +36  [ = ]       0    .debug_frame
  +0.0%     +16  [ = ]       0    .debug_aranges
  +0.0%      +8  +0.0%      +8    .text
 -18.5%     -12  [ = ]       0    [Unmapped]
  -0.6%     -50  [ = ]       0    .debug_abbrev
  -0.1%    -136  [ = ]       0    .debug_ranges
  -0.1%    -300  [ = ]       0    .debug_line
  -0.0%    -368  [ = ]       0    .debug_str
  -0.2% -1.27Ki  [ = ]       0    .debug_loc
  -0.2% -3.12Ki  [ = ]       0    .debug_info
  -0.1% -5.06Ki  +0.0%      +8    TOTAL
use_rust/nrf52840_ble — 399.5 KiB → 399.5 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 358296	   5200	  45584	 409080	  63df8	rmk-nrf52840

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 358288	   5200	  45584	 409072	  63df0	rmk-nrf52840

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .debug_ranges
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +25  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.0%      +8  [ = ]       0    .debug_aranges
  +0.0%      +8  +0.0%      +8    .text
 -23.5%     -12  [ = ]       0    [Unmapped]
  -0.1%    -224  [ = ]       0    .debug_line
  -0.0%    -299  [ = ]       0    .debug_str
  -0.2% -1.04Ki  [ = ]       0    .debug_loc
  -0.1% -2.87Ki  [ = ]       0    .debug_info
  -0.1% -4.31Ki  +0.0%      +8    TOTAL
use_rust/nrf52840_ble_split (central) — 488.0 KiB → 488.0 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 441532	   6524	  51648	 499704	  79ff8	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 441524	   6524	  51648	 499696	  79ff0	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +32  [ = ]       0    .debug_ranges
  +0.0%     +32  [ = ]       0    .symtab
  +0.0%     +25  [ = ]       0    .strtab
  +0.0%     +20  [ = ]       0    .debug_frame
  +0.0%      +8  [ = ]       0    .debug_aranges
  +0.0%      +8  +0.0%      +8    .text
  -9.5%      -6  [ = ]       0    [Unmapped]
  -0.1%    -255  [ = ]       0    .debug_line
  -0.0%    -505  [ = ]       0    .debug_str
  -0.1% -1.02Ki  [ = ]       0    .debug_loc
  -0.1% -2.59Ki  [ = ]       0    .debug_info
  -0.1% -4.24Ki  +0.0%      +8    TOTAL
use_rust/nrf52840_ble_split (peripheral) — 304.4 KiB → 304.4 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 281128	   5328	  25288	 311744	  4c1c0	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 281136	   5328	  25288	 311752	  4c1c8	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +345  [ = ]       0    .debug_str
  +0.0%     +85  [ = ]       0    .debug_info
  +0.0%      +9  [ = ]       0    .debug_loc
   +17%      +9  [ = ]       0    [Unmapped]
  -0.0%      -8  -0.0%      -8    .text
  +0.0%    +440  -0.0%      -8    TOTAL
use_rust/pi_pico_w_ble — 638.6 KiB → 638.5 KiB (+0.00% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 599224	      0	  54632	 653856	  9fa20	rmk-pi-pico-w

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 599244	      0	  54632	 653876	  9fa34	rmk-pi-pico-w

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%     +69  [ = ]       0    .debug_line
 -19.1%     -13  [ = ]       0    [Unmapped]
  -0.0%     -20  -0.0%     -20    .text
  -0.0%    -104  [ = ]       0    .debug_ranges
  -0.0%    -463  [ = ]       0    .debug_str
  -0.0%    -649  [ = ]       0    .debug_info
  -0.1%    -856  [ = ]       0    .debug_loc
  -0.0% -1.99Ki  -0.0%     -20    TOTAL
use_rust/rp2040 — 144.5 KiB → 144.5 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 132992	      0	  14972	 147964	  241fc	rmk-rp2040

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 132992	      0	  14972	 147964	  241fc	rmk-rp2040

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +6.4%      +3  [ = ]       0    [Unmapped]
  +0.0%      +1  [ = ]       0    .debug_line
  -0.0%    -308  [ = ]       0    .debug_str
  -0.0%    -304  [ = ]       0    TOTAL
use_rust/rp2040_split (central) — 155.9 KiB → 155.9 KiB (+0.00% ⬆️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 144028	      0	  15644	 159672	  26fb8	central

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 144024	      0	  15644	 159668	  26fb4	central

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%      +4  +0.0%      +4    .text
  -7.0%      -4  [ = ]       0    [Unmapped]
  -0.0%     -10  [ = ]       0    .debug_loc
  -0.0%     -62  [ = ]       0    .debug_line
  -0.0%    -170  [ = ]       0    .debug_info
  -0.0%    -186  [ = ]       0    .debug_str
  -0.0%    -428  +0.0%      +4    TOTAL
use_rust/rp2040_split (peripheral) — 26.4 KiB → 26.4 KiB (-0.01% ⬇️)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  24316	     56	   2676	  27048	   69a8	peripheral

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  24320	     56	   2676	  27052	   69ac	peripheral

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +6.8%      +4  [ = ]       0    [Unmapped]
  -0.1%      -4  -0.1%      -4    .rodata
  [ = ]       0  -0.0%      -4    TOTAL
use_rust/stm32f1 — 61.7 KiB → 61.7 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
  55792	     28	   7392	  63212	   f6ec	rmk-stm32f1

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
  55792	     28	   7392	  63212	   f6ec	rmk-stm32f1

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.0%    +268  [ = ]       0    .debug_str
  +0.0%    +149  [ = ]       0    .debug_info
  +2.9%      +2  [ = ]       0    [Unmapped]
  -0.0%     -15  [ = ]       0    .debug_line
  +0.0%    +404  [ = ]       0    TOTAL
use_rust/stm32h7 — 119.5 KiB → 119.5 KiB (+0.00%)

cargo size (PR):

   text	   data	    bss	    dec	    hex	filename
 106708	    324	  15308	 122340	  1dde4	rmk-stm32h7

cargo size (main):

   text	   data	    bss	    dec	    hex	filename
 106708	    324	  15308	 122340	  1dde4	rmk-stm32h7

Bloaty diff (PR vs main):

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  +0.1%    +201  [ = ]       0    .debug_line
  +0.0%    +183  [ = ]       0    .debug_info
  -5.2%      -3  [ = ]       0    [Unmapped]
  -0.0%    -201  [ = ]       0    .debug_str
  +0.0%    +180  [ = ]       0    TOTAL

HaoboGu
HaoboGu approved these changes May 5, 2026
View reviewed changes
Copy link
Copy Markdown
Owner

@HaoboGu HaoboGu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Thanks!

@HaoboGu HaoboGu merged commit 68533ab into HaoboGu:main May 5, 2026
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@HaoboGu HaoboGu HaoboGu approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jpds @HaoboGu