Implement keyboard service by kurtjd · Pull Request #510 · OpenDevicePartnership/embedded-services

kurtjd · 2025-10-10T23:26:21Z

Provides a HID over i2c keyboard service as well as a configurable GPIO HID-aware keyboard.

The provided GPIO keyboard uses keyberon for scanning and special key handling. It uses a basic report descriptor supporting 6 keys per report. Next is to support output reports for things like LEDs, Fn key handling, and consumer reports. In the time being users can use the HidKeyboard trait for more custom behavior if the provided implementation doesn't suit their needs.

The hid backend takes a generic HidKeyboard type and handles listening for i2c commands from the host and processing commands. It also handles asserting interrupts whenever a new key report is available instructing the host to perform a read to retrieve the report.

There is still more work to be done to make this all more flexible and configurable. This serves as a v0.1.0 so developers at least have keyboard support in the meantime.

Also plan to look more into ways to make buffer sizes more configurable and see if there are ways to prevent copying input reports multiple times as they move through the queue.

github-actions · 2025-10-10T23:27:10Z

Cargo Vet Audit Passed

cargo vet has passed in this PR. No new unvetted dependencies were found.

kurtjd · 2025-10-10T23:38:52Z

Cargo Vet Audit Failed

cargo vet has failed in this PR. Please run cargo vet --locked locally to check for new or updated unvetted dependencies. Details about the vetting process can be found in supply-chain/README.md

If the unvetted dependencies are not needed

Please modify Cargo.toml file to avoid including the dependencies.

If the unvetted dependencies are needed

Post a new comment with the questionnaire below to the PR to help the auditors vet the dependencies. After the auditors have vetted the dependencies, the PR will need to be rebased to pick up the new audits and pass this check.

Copy and paste the questionnaire as a new comment and provide your answers:

1. What crates (with version) need to be audited?

2. How many of the crates are version updates vs new dependencies?

3. To confirm none of the already included crates serve your needs, please provide a brief description of the purpose of the new crates.

4. Any extra notes to the auditors to help with their audits.

Unfortunately keyberon does not feature gate certain unused dependencies like usb-device. Ultimately keyberon feels pretty restricting in a few ways. May decide to fork or write a custom library.

jerrysxie

@kurtjd Looks good for a first vertical slice, is there a way to separate the HID report generation from the key scanner implementation?

Is there an example that shows the keyboard service in action?

kurtjd · 2025-10-15T22:19:54Z

@kurtjd Looks good for a first vertical slice, is there a way to separate the HID report generation from the key scanner implementation?

Is there an example that shows the keyboard service in action?

Thanks! Yeah I'm thinking of doing something along the lines of what Felipe suggested above, where the scan function returns only an array/slice of keys pressed (though still represented by the HID usage code for each key), then the hid backend can convert it into an input report for HID over i2c. This would also in turn make it decoupled from a future hid over espi backend (in case we decide the input report format for espi should be different than the i2c spec).

kurtjd · 2025-10-17T19:47:13Z

Currently have a PR in for keyberon to not pull in the usb-device dependency to make auditing a little bit easier: TeXitoi/keyberon#140

jerrysxie · 2025-10-17T22:42:28Z

Cargo Vet Audit Failed

cargo vet has failed in this PR. Please run cargo vet --locked locally to check for new or updated unvetted dependencies. Details about the vetting process can be found in supply-chain/README.md

If the unvetted dependencies are not needed

Please modify Cargo.toml file to avoid including the dependencies.

If the unvetted dependencies are needed

Post a new comment with the questionnaire below to the PR to help the auditors vet the dependencies. After the auditors have vetted the dependencies, the PR will need to be rebased to pick up the new audits and pass this check.

Copy and paste the questionnaire as a new comment and provide your answers:

1. What crates (with version) need to be audited?
2. How many of the crates are version updates vs new dependencies?
3. To confirm none of the already included crates serve your needs, please provide a brief description of the purpose of the new crates.
4. Any extra notes to the auditors to help with their audits.

Unfortunately keyberon does not feature gate certain unused dependencies like usb-device. Ultimately keyberon feels pretty restricting in a few ways. May decide to fork or write a custom library.

@kurtjd finished cargo vet audit and pushed commit to repo

kurtjd · 2025-10-17T23:15:33Z

Cargo Vet Audit Failed

cargo vet has failed in this PR. Please run cargo vet --locked locally to check for new or updated unvetted dependencies. Details about the vetting process can be found in supply-chain/README.md

If the unvetted dependencies are not needed

Please modify Cargo.toml file to avoid including the dependencies.

If the unvetted dependencies are needed

Post a new comment with the questionnaire below to the PR to help the auditors vet the dependencies. After the auditors have vetted the dependencies, the PR will need to be rebased to pick up the new audits and pass this check.

Copy and paste the questionnaire as a new comment and provide your answers:

1. What crates (with version) need to be audited?
2. How many of the crates are version updates vs new dependencies?
3. To confirm none of the already included crates serve your needs, please provide a brief description of the purpose of the new crates.
4. Any extra notes to the auditors to help with their audits.

Unfortunately keyberon does not feature gate certain unused dependencies like usb-device. Ultimately keyberon feels pretty restricting in a few ways. May decide to fork or write a custom library.

@kurtjd finished cargo vet audit and pushed commit to repo

Thank you! Was hoping my keyberon PR could get in so there'd be one less crate for you to audit, but you're too quick. Really appreciate it!

kurtjd · 2025-10-20T21:50:03Z

@felipebalbi When you get a chance could you take another look?

* add audits for proc-macro-error and usb-device * set audit-as-crates-io as false for keyberon * prune the imports.lock

felipebalbi

👍

tullom

And Kurtis said "Let there be keyboard support", and there was keyboard support.

kurtjd self-assigned this Oct 10, 2025

kurtjd added this to ODP Backlog Oct 10, 2025

kurtjd requested a review from a team as a code owner October 10, 2025 23:26

kurtjd added the enhancement New feature or request label Oct 10, 2025

kurtjd requested review from JamesHuard, felipebalbi, jerrysxie and madeleyneVaca October 10, 2025 23:26

kurtjd moved this to In review in ODP Backlog Oct 10, 2025

github-actions Bot added the cargo vet PRs pending auditor review label Oct 10, 2025

kurtjd force-pushed the keyboard-service branch from 49711dd to 8e4276b Compare October 10, 2025 23:36

kurtjd force-pushed the keyboard-service branch from 8e4276b to e63da32 Compare October 13, 2025 16:20

felipebalbi reviewed Oct 13, 2025

View reviewed changes

Comment thread keyboard-service/src/gpio_kb.rs Outdated

Comment thread keyboard-service/src/gpio_kb.rs

Comment thread keyboard-service/src/lib.rs

Comment thread keyboard-service/src/lib.rs Outdated

Comment thread keyboard-service/src/hid_kb.rs

kurtjd commented Oct 13, 2025

View reviewed changes

Comment thread keyboard-service/src/gpio_kb.rs Outdated

kurtjd force-pushed the keyboard-service branch 2 times, most recently from 5213714 to 01c74c0 Compare October 14, 2025 22:17

jerrysxie requested changes Oct 15, 2025

View reviewed changes

Comment thread keyboard-service/src/hid_kb.rs

kurtjd force-pushed the keyboard-service branch 2 times, most recently from a6b23db to db7d51f Compare October 15, 2025 20:13

jerrysxie reviewed Oct 15, 2025

View reviewed changes

kurtjd force-pushed the keyboard-service branch 3 times, most recently from 3a687f0 to a2d0456 Compare October 17, 2025 18:32

jerrysxie requested a review from a team as a code owner October 17, 2025 22:40

jerrysxie requested review from jeffglaum and jerrysxie October 17, 2025 22:40

jerrysxie requested a review from felipebalbi October 18, 2025 12:33

jerrysxie previously approved these changes Oct 18, 2025

View reviewed changes

tullom reviewed Oct 21, 2025

View reviewed changes

Comment thread keyboard-service/src/lib.rs Outdated

Implement keyboard service

bbb2998

kurtjd dismissed jerrysxie’s stale review via bbb2998 October 21, 2025 16:36

kurtjd force-pushed the keyboard-service branch from bc96cd0 to bbb2998 Compare October 21, 2025 16:36

cargo-vet audit update:

3f0b6be

* add audits for proc-macro-error and usb-device * set audit-as-crates-io as false for keyberon * prune the imports.lock

felipebalbi approved these changes Oct 21, 2025

View reviewed changes

tullom approved these changes Oct 22, 2025

View reviewed changes

kurtjd merged commit 33fcb3b into OpenDevicePartnership:main Oct 22, 2025
14 checks passed

github-project-automation Bot moved this from In review to Done in ODP Backlog Oct 22, 2025

kurtjd mentioned this pull request Oct 22, 2025

keyboard-service: Add support for key scanning and HID communications #495

Closed

kurtjd deleted the keyboard-service branch January 23, 2026 17:18

Uh oh!

Conversation

kurtjd commented Oct 10, 2025

Uh oh!

github-actions Bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Cargo Vet Audit Passed

Uh oh!

kurtjd commented Oct 10, 2025

Cargo Vet Audit Failed

If the unvetted dependencies are not needed

If the unvetted dependencies are needed

Copy and paste the questionnaire as a new comment and provide your answers:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jerrysxie left a comment

Choose a reason for hiding this comment

Uh oh!

kurtjd commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kurtjd commented Oct 17, 2025

Uh oh!

jerrysxie commented Oct 17, 2025

Cargo Vet Audit Failed

If the unvetted dependencies are not needed

If the unvetted dependencies are needed

Copy and paste the questionnaire as a new comment and provide your answers:

Uh oh!

kurtjd commented Oct 17, 2025

Cargo Vet Audit Failed

If the unvetted dependencies are not needed

If the unvetted dependencies are needed

Copy and paste the questionnaire as a new comment and provide your answers:

Uh oh!

kurtjd commented Oct 20, 2025

Uh oh!

Uh oh!

felipebalbi left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tullom left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Oct 10, 2025 •

edited

Loading

kurtjd commented Oct 15, 2025 •

edited

Loading

felipebalbi left a comment •

edited

Loading