1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
// Copyright 2021-2022 Jacob Alexander
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
#![no_std]
mod descriptor;
mod test;
#[cfg(feature = "defmt")]
use defmt::*;
#[cfg(not(feature = "defmt"))]
use log::*;
pub use crate::descriptor::{
HidioReport, KeyboardNkroReport, MouseReport, SysCtrlConsumerCtrlReport,
};
use heapless::spsc::{Consumer, Producer};
use usb_device::bus::{UsbBus, UsbBusAllocator};
use usb_device::class::UsbClass;
use usbd_hid::descriptor::generator_prelude::*;
use usbd_hid::descriptor::KeyboardReport;
use usbd_hid::hid_class::{HIDClass, HidClassSettings, HidProtocol, HidSubClass};
pub use usbd_hid::hid_class::{HidCountryCode, HidProtocolMode, ProtocolModeConfig};
use usbd_hid::UsbError;
#[cfg(feature = "hidio")]
use heapless::Vec;
#[cfg(feature = "hidio")]
use kiibohd_hid_io::{CommandInterface, KiibohdCommandInterface};
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum KeyState {
/// Press the given USB HID Keyboard code
Press(u8),
/// Release the given USB HID Keyboard code
Release(u8),
/// Clear all currently pressed USB HID Keyboard codes
Clear,
/// Unknown state, used for errors
Unknown,
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum MouseState {
/// Press the given mouse button (1->8)
Press(u8),
/// Release the given mouse button (1->8)
Release(u8),
/// Position update
Position { x: i16, y: i16 },
/// Vertical Wheel Increment
VertWheel(i8),
/// Horizontal Wheel Increment
HorzWheel(i8),
/// Clear all mouse state
Clear,
/// Unknown state, used for errors
Unknown,
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum CtrlState {
/// Press the given USB HID System Ctrl code
SystemCtrlPress(u8),
/// Release the given USB HID System Ctrl code
SystemCtrlRelease(u8),
/// Press the given USB HID Consumer Ctrl code
ConsumerCtrlPress(u16),
/// Release the given USB HID Consumer Ctrl code
ConsumerCtrlRelease(u16),
/// Clear all the currently pressed consumer and system control HID codes
Clear,
/// Unknown state, used for errors
Unknown,
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum LedState {
/// HID Lock LED Activates
Activate(u8),
/// HID Lock LED Deactivates
Deactivate(u8),
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum UsbState {
/// HID Lock LED Activates
Activate(u8),
/// HID Lock LED Deactivates
Deactivate(u8),
}
/// USB HID Combination Interface
///
/// Handles creation and management of multiple USB HID interfaces through SPSC queues.
/// Maintains state for you so you only need to send state changes and poll events.
///
/// Typical Usage
/// - Queue up changes using SPSC queues
/// - Call push to send the current states of all the queues
/// (queues are not processed until push() is called)
///
/// HID-IO
/// - Queue up changes, or receive changes using hidio_rx and hidio_tx spsc queues
/// - Call poll to process queues in both directions (or push, which will call poll for you)
/// Will attempt to push and pull as many packets as possible in case the USB device supports
/// larger buffers (e.g. double buffering)
///
/// Example Usage (atsam4s)
/// ```rust,ignore
/// use heapless::spsc::Queue;
/// use usbd_hid::hid_class::{HidCountryCode, HidProtocolMode, ProtocolModeConfig};
///
/// // These define the maximum pending items in each queue
/// const KBD_QUEUE_SIZE: usize = 10; // This would limit NKRO mode to 10KRO
/// const KBD_LED_QUEUE_SIZE: usize = 3;
/// const MOUSE_QUEUE_SIZE: usize = 5;
/// const CTRL_QUEUE_SIZE: usize = 2;
///
/// type HidInterface =
/// kiibohd_usb::HidInterface<'static, UdpBus, KBD_QUEUE_SIZE, MOUSE_QUEUE_SIZE, CTRL_QUEUE_SIZE>;
///
/// pub struct HidioInterface<const H: usize> {}
///
/// impl<const H: usize> HidioInterface<H> {
/// fn new() -> Self {
/// Self {}
/// }
/// }
///
/// impl<const H: usize> KiibohdCommandInterface<H> for HidioInterface<H> {
/// fn h0001_device_name(&self) -> Option<&str> {
/// Some("Input Club Keystone - TKL")
/// }
///
/// fn h0001_firmware_name(&self) -> Option<&str> {
/// Some("kiibohd-firmware")
/// }
/// }
///
/// // Setup the queues used to generate the input reports (ctrl, keyboard and mouse)
/// let ctrl_queue: Queue<kiibohd_usb::CtrlState, CTRL_QUEUE_SIZE> = Queue::new();
/// let kbd_queue: Queue<kiibohd_usb::KeyState, KBD_QUEUE_SIZE> = Queue::new();
/// let kbd_led_queue: Queue<kiibohd_usb::LedState, KBD_LED_QUEUE_SIZE> = Queue::new();
/// let mouse_queue: Queue<kiibohd_usb::MouseState, MOUSE_QUEUE_SIZE> = Queue::new();
/// let (kbd_producer, kbd_consumer) = kbd_queue.split();
/// let (mouse_producer, mouse_consumer) = mouse_queue.split();
/// let (ctrl_producer, ctrl_consumer) = ctrl_queue.split();
///
/// // Setup the interface
/// // NOTE: Ignoring usb_bus setup in this example, use a compliant usb-device UsbBus interface
/// let usb_hid = HidInterface::new(
/// usb_bus,
/// HidCountryCode::NotSupported,
/// kbd_consumer,
/// kbd_led_producer,
/// mouse_consumer,
/// ctrl_consumer,
/// );
///
/// // Basic CommandInterface
/// let hidio_intf = CommandInterface::<
/// HidioInterface<MESSAGE_LEN>,
/// TX_BUF,
/// RX_BUF,
/// BUF_CHUNK,
/// MESSAGE_LEN,
/// SERIALIZATION_LEN,
/// ID_LEN,
/// >::new(
/// &[
/// HidIoCommandId::SupportedIds,
/// HidIoCommandId::GetInfo,
/// HidIoCommandId::TestPacket,
/// ],
/// HidioInterface::<MESSAGE_LEN>::new(),
/// )
/// .unwrap();
///
/// // To push keyboard key report, first push to the queue, then process all queues
/// kbd_producer.enqueue(kiibohd_usb::KeyState::Press(0x04)); // Press the A key
/// usb_hid.push();
/// // To retrieve lock leds (and enqueue events)
/// usb_hid.pull();
///
/// // In the USB interrupt (or similar), usb_hid will also need to be handled (Ctrl EP requests)
/// fn usb_irq() {
/// let usb_dev = some_global_mechanism.usb_dev;
/// let usb_hid = some_global_mechanism.usb_hid;
/// let hidio_intf = some_global_mechanism.hidio_intf;
/// if usb_dev.poll(&mut usb_hid.interfaces()) {
/// // poll is only available with the hidio feature
/// usb_hid.poll(hidio_intf);
/// }
/// }
/// ```
pub struct HidInterface<
'a,
B: UsbBus,
const KBD_SIZE: usize,
const KBD_LED_SIZE: usize,
const MOUSE_SIZE: usize,
const CTRL_SIZE: usize,
> {
kbd_6kro: HIDClass<'a, B>,
kbd_6kro_report: KeyboardReport,
kbd_nkro: HIDClass<'a, B>,
kbd_nkro_report: KeyboardNkroReport,
kbd_consumer: Consumer<'a, KeyState, KBD_SIZE>,
kbd_updated: bool,
kbd_led_producer: Producer<'a, LedState, KBD_LED_SIZE>,
kbd_led_state: u8,
ctrl: HIDClass<'a, B>,
ctrl_consumer: Consumer<'a, CtrlState, CTRL_SIZE>,
ctrl_report: SysCtrlConsumerCtrlReport,
ctrl_updated: bool,
#[cfg(feature = "mouse")]
mouse: HIDClass<'a, B>,
#[cfg(feature = "mouse")]
mouse_consumer: Consumer<'a, MouseState, MOUSE_SIZE>,
#[cfg(feature = "mouse")]
mouse_report: MouseReport,
#[cfg(feature = "mouse")]
mouse_updated: bool,
#[cfg(feature = "hidio")]
hidio: HIDClass<'a, B>,
}
impl<
B: UsbBus,
const KBD_SIZE: usize,
const KBD_LED_SIZE: usize,
const MOUSE_SIZE: usize,
const CTRL_SIZE: usize,
> HidInterface<'_, B, KBD_SIZE, KBD_LED_SIZE, MOUSE_SIZE, CTRL_SIZE>
{
pub fn new<'a>(
alloc: &'a UsbBusAllocator<B>,
locale: HidCountryCode,
kbd_consumer: Consumer<'a, KeyState, KBD_SIZE>,
kbd_led_producer: Producer<'a, LedState, KBD_LED_SIZE>,
#[cfg(feature = "mouse")] mouse_consumer: Consumer<'a, MouseState, MOUSE_SIZE>,
ctrl_consumer: Consumer<'a, CtrlState, CTRL_SIZE>,
) -> HidInterface<'a, B, KBD_SIZE, KBD_LED_SIZE, MOUSE_SIZE, CTRL_SIZE> {
let kbd_6kro = HIDClass::new_ep_in_with_settings(
alloc,
KeyboardReport::desc(),
10,
HidClassSettings {
subclass: HidSubClass::Boot,
protocol: HidProtocol::Keyboard,
config: ProtocolModeConfig::DefaultBehavior,
locale,
},
);
let kbd_nkro = HIDClass::new_ep_in_with_settings(
alloc,
KeyboardNkroReport::desc(),
10,
HidClassSettings {
subclass: HidSubClass::NoSubClass,
protocol: HidProtocol::Keyboard,
config: ProtocolModeConfig::DefaultBehavior,
locale,
},
);
let ctrl = HIDClass::new_ep_in(alloc, SysCtrlConsumerCtrlReport::desc(), 10);
#[cfg(feature = "mouse")]
let mouse = HIDClass::new_ep_in(alloc, MouseReport::desc(), 10);
#[cfg(feature = "hidio")]
let hidio = HIDClass::new(alloc, HidioReport::desc(), 10);
HidInterface {
kbd_6kro,
kbd_6kro_report: KeyboardReport {
modifier: 0,
reserved: 0,
leds: 0,
keycodes: [0; 6],
},
kbd_nkro,
kbd_nkro_report: KeyboardNkroReport {
leds: 0,
keybitmap: [0; 29],
},
kbd_consumer,
kbd_updated: true,
kbd_led_producer,
kbd_led_state: 0,
ctrl,
ctrl_consumer,
ctrl_report: SysCtrlConsumerCtrlReport {
consumer_ctrl: 0,
system_ctrl: 0,
},
ctrl_updated: true,
#[cfg(feature = "mouse")]
mouse,
#[cfg(feature = "mouse")]
mouse_consumer,
#[cfg(feature = "mouse")]
mouse_report: MouseReport {
buttons: 0,
x: 0,
y: 0,
vert_wheel: 0,
horz_wheel: 0,
},
#[cfg(feature = "mouse")]
mouse_updated: true,
#[cfg(feature = "hidio")]
hidio,
}
}
/// Dynamically update the keyboard protocol mode (and behavior)
/// Used to force NKRO or 6KRO regardless of what the host configures
pub fn set_kbd_protocol_mode(&mut self, mode: HidProtocolMode, config: ProtocolModeConfig) {
trace!(
"HidInterface::set_kbd_protocol_mode({:?}, {:?})",
mode,
config
);
self.kbd_6kro.set_protocol_mode(mode, config).ok();
self.kbd_nkro.set_protocol_mode(mode, config).ok();
}
/// Retrieves the current protocol mode
/// Uses the 6kro keyboard (both HID Classes should return the same value)
pub fn get_kbd_protocol_mode(&self) -> HidProtocolMode {
self.kbd_6kro.get_protocol_mode().unwrap()
}
/// Used to pass all of the interfaces to usb_dev.poll()
#[cfg(all(feature = "mouse", feature = "hidio"))]
pub fn interfaces(&mut self) -> [&'_ mut dyn UsbClass<B>; 5] {
[
&mut self.kbd_6kro,
&mut self.kbd_nkro,
&mut self.ctrl,
&mut self.mouse,
&mut self.hidio,
]
}
/// Used to pass all of the interfaces to usb_dev.poll()
#[cfg(all(feature = "mouse", not(feature = "hidio")))]
pub fn interfaces(&mut self) -> [&'_ mut dyn UsbClass<B>; 4] {
[
&mut self.kbd_6kro,
&mut self.kbd_nkro,
&mut self.ctrl,
&mut self.mouse,
]
}
/// Used to pass all of the interfaces to usb_dev.poll()
#[cfg(all(not(feature = "mouse"), feature = "hidio"))]
pub fn interfaces(&mut self) -> [&'_ mut dyn UsbClass<B>; 4] {
[
&mut self.kbd_6kro,
&mut self.kbd_nkro,
&mut self.ctrl,
&mut self.hidio,
]
}
/// Used to pass all of the interfaces to usb_dev.poll()
#[cfg(all(not(feature = "mouse"), not(feature = "hidio")))]
pub fn interfaces(&mut self) -> [&'_ mut dyn UsbClass<B>; 3] {
[&mut self.kbd_6kro, &mut self.kbd_nkro, &mut self.ctrl]
}
/// Modifies the nkro report bitmask
fn nkro_bit(&mut self, key: u8, press: bool) {
// NOTE: The indexing actually starts from 1 (not 0), so position 0 represents 1
// 0 in USB HID represents no keys pressed, so it's meaningless in a bitmask
// Ignore any keys over 231/0xE7
if key == 0 || key > 0xE7 {
warn!("Invalid key for nkro_bit({}, {}), ignored.", key, press);
return;
}
let key = key - 1;
// Determine position
let byte: usize = (key / 8).into();
let bit: usize = (key % 8).into();
// Set/Unset
if press {
self.kbd_nkro_report.keybitmap[byte] |= 1 << bit;
} else {
self.kbd_nkro_report.keybitmap[byte] &= !(1 << bit);
}
}
fn update_kbd(&mut self) {
// Empty kbd queue
loop {
match self.kbd_consumer.dequeue() {
Some(state) => {
self.kbd_updated = true;
debug!("kbd: {:?}", state);
match state {
KeyState::Press(key) => {
// Ignore 0
// - 6KRO -
// Modifiers
if key & 0xE0 == 0xE0 {
self.kbd_6kro_report.modifier |= 1 << (key ^ 0xE0);
// Left shift 1 by key XOR 0xE0
}
// Keys
for pos in self.kbd_6kro_report.keycodes.iter_mut() {
// Check to see if key is already presed
if *pos == key {
break;
}
// Set the key if we encounter a 0 (no key set)
if *pos == 0 {
*pos = key;
break;
}
}
// - NKRO -
self.nkro_bit(key, true);
}
KeyState::Release(key) => {
// - 6KRO -
// Modifiers
if key & 0xE0 == 0xE0 {
self.kbd_6kro_report.modifier |= 1 << (key ^ 0xE0);
// Left shift 1 by key XOR 0xE0
}
// Keys
if key != 0 {
// Check to see if key is pressed
if let Some(index) =
self.kbd_6kro_report.keycodes.iter().position(|&k| k == key)
{
// Rotate in all the keys
// OSs will skip all the keys after the first 0 is found in
// the array.
self.kbd_6kro_report.keycodes[index..].rotate_left(1);
// Clear the last index
self.kbd_6kro_report.keycodes
[self.kbd_6kro_report.keycodes.len() - 1] = 0;
}
}
// - NKRO -
self.nkro_bit(key, false);
}
KeyState::Clear => {
self.kbd_updated = true;
// - 6KRO -
self.kbd_6kro_report.modifier = 0;
self.kbd_6kro_report.keycodes = [0; 6];
// - NKRO -
self.kbd_nkro_report.keybitmap = [0; 29];
}
KeyState::Unknown => {}
}
}
None => {
return;
}
}
}
}
fn push_6kro_kbd(&mut self) -> Result<(), UsbError> {
if let Err(val) = self.kbd_6kro.push_input(&self.kbd_6kro_report) {
trace!("6KRO Buffer Overflow: {:?}", val);
Err(val)
} else {
Ok(())
}
}
fn push_nkro_kbd(&mut self) -> Result<(), UsbError> {
if let Err(val) = self.kbd_nkro.push_input(&self.kbd_nkro_report) {
trace!("NKRO Buffer Overflow: {:?}", val);
Err(val)
} else {
Ok(())
}
}
/// Updates self.mouse_report and indicates if there are any changes
/// Changes are used to determine if USB Resume is necessary before pushing
/// the next packet.
#[cfg(feature = "mouse")]
fn update_mouse(&mut self) {
// Empty mouse queue
while let Some(state) = self.mouse_consumer.dequeue() {
self.mouse_updated = true;
debug!("mouse: {:?}", state);
match state {
MouseState::Press(key) => {
self.mouse_button_bit(key, true);
}
MouseState::Release(key) => {
self.mouse_button_bit(key, false);
}
MouseState::Position { x, y } => {
self.mouse_report.x = x;
self.mouse_report.y = y;
}
MouseState::VertWheel(pos) => {
self.mouse_report.vert_wheel = pos;
}
MouseState::HorzWheel(pos) => {
self.mouse_report.horz_wheel = pos;
}
MouseState::Clear => {
self.mouse_report.buttons = 0;
}
MouseState::Unknown => {}
}
}
}
#[cfg(feature = "mouse")]
fn mouse_button_bit(&mut self, button: u8, press: bool) {
// Ignore keys outside of 1 to 8
if let 1..=8 = button {
let button = button - 1;
// Determine position
let bit: usize = (button % 8).into();
// Set/Unset
if press {
self.mouse_report.buttons |= 1 << bit;
} else {
self.mouse_report.buttons &= !(1 << bit);
}
}
}
#[cfg(feature = "mouse")]
fn push_mouse(&mut self) -> Result<(), UsbError> {
// Push report
if let Err(val) = self.mouse.push_input(&self.mouse_report) {
trace!("Mouse Buffer Overflow: {:?}", val);
return Err(val);
}
// Clear relative fields
self.mouse_report.x = 0;
self.mouse_report.y = 0;
self.mouse_report.vert_wheel = 0;
self.mouse_report.horz_wheel = 0;
Ok(())
}
/// Update self.ctrl_report and indicates if there are any changes
/// Changes are used to determine if USB Resume is necessary before pushing
/// the next packet.
fn update_ctrl(&mut self) {
// Empty ctrl queue
while let Some(state) = self.ctrl_consumer.dequeue() {
self.ctrl_updated = true;
debug!("ctrl/cons: {:?}", state);
match state {
CtrlState::SystemCtrlPress(key) => {
self.ctrl_report.system_ctrl = key;
}
CtrlState::SystemCtrlRelease(_key) => {
self.ctrl_report.system_ctrl = 0;
}
CtrlState::ConsumerCtrlPress(key) => {
self.ctrl_report.consumer_ctrl = key;
}
CtrlState::ConsumerCtrlRelease(_key) => {
self.ctrl_report.consumer_ctrl = 0;
}
CtrlState::Clear => {
self.ctrl_report.consumer_ctrl = 0;
self.ctrl_report.system_ctrl = 0;
}
CtrlState::Unknown => {}
}
}
}
fn push_ctrl(&mut self) -> Result<(), UsbError> {
// Push report
if let Err(val) = self.ctrl.push_input(&self.ctrl_report) {
trace!("Ctrl Buffer Overflow: {:?}", val);
Err(val)
} else {
Ok(())
}
}
/// Update buffers to be ready to push over USB
/// This is useful for remote wakeup where we only want to send a remote wakeup if an event has
/// occurred. But before sending the data to the USB buffer registers.
///
/// Returns true if any descriptor was updated
pub fn update(&mut self) -> bool {
// Update descriptors
self.update_kbd();
self.update_ctrl();
#[cfg(feature = "mouse")]
self.update_mouse();
// Collect all report statuses
#[cfg(feature = "mouse")]
{
self.kbd_updated || self.ctrl_updated || self.mouse_updated
}
#[cfg(not(feature = "mouse"))]
{
self.kbd_updated || self.ctrl_updated
}
}
/// Processes each of the spsc queues and pushes data over USB
/// This is primarily for keyboard, mouse and ctrl interfaces.
/// HID-IO is handled with poll()
///
/// This function automatically handles USB Resume if required.
///
/// NOTE: You must call update() first before calling push().
///
/// Returns possibly returns UsbError::WouldBlock in which case the
/// USB buffer is full and you should call push before queuing up more
/// keypresses. Normally it's safe to add more events; however, it's possible
/// you may lose an event (very slim chance).
pub fn push(&mut self) -> Result<(), UsbError> {
// Send keyboard report
if self.kbd_updated {
// Check protocol mode to decide nkro vs. 6kro (boot)
match self.get_kbd_protocol_mode() {
HidProtocolMode::Report => {
trace!("NKRO Push");
self.push_nkro_kbd()?;
}
HidProtocolMode::Boot => {
trace!("6KRO Push");
self.push_6kro_kbd()?;
}
}
self.kbd_updated = false;
}
// Push consumer and system control reports
if self.ctrl_updated {
trace!("Ctrl/Cons Push");
self.push_ctrl()?;
self.ctrl_updated = false;
}
// Push mouse reports
#[cfg(feature = "mouse")]
if self.mouse_updated {
trace!("Mouse Push");
self.push_mouse()?;
self.mouse_updated = false;
}
Ok(())
}
/// Query HID lock LED state
/// The state used depends on which protocol mode is selected
/// (there are different lock LEDs for the 6KRO/Boot and NKRO keyboard
/// descriptors.
pub fn pull(&mut self) {
let mut buf: [u8; 1] = [0];
let res = match self.get_kbd_protocol_mode() {
HidProtocolMode::Report => self.kbd_nkro.pull_raw_report(&mut buf),
HidProtocolMode::Boot => self.kbd_6kro.pull_raw_report(&mut buf),
};
match res {
Ok(info) => {
// Inferface / report_id
// 0 -> Boot
// 1 -> Report
// However, we are only keeping track of "events" so there's no
// risk of double countings. There's actually a risk of missing a report
// in some cases, so having two chances at it increases the chances
// of seeing the event (if there's a quick succession of SET_REPORTs
// before calling this function, the previous buffer will be lost).
trace!("set_report: {:?} {:?}", info, buf);
// Compare new state with previous
// Each bit represents an id of kll_hid::LedIndicator
let mut cur = buf[0];
let mut prev = self.kbd_led_state;
for id in 1..=5 {
// Compare current vs. previous event bits
if (cur & 0x1) != (prev & 0x1) {
// Enqueue event
if cur & 0x1 == 1 {
self.kbd_led_producer
.enqueue(LedState::Activate(id))
.unwrap();
} else {
self.kbd_led_producer
.enqueue(LedState::Deactivate(id))
.unwrap();
}
}
// Shift bits
cur <<= 1;
prev <<= 1;
}
// Update state for the next comparison
self.kbd_led_state = buf[0];
}
Err(UsbError::WouldBlock) => {}
Err(err) => {
error!("Bad SET_REPORT: {:?}", err);
}
}
}
/// Pull the HID-IO interface (RX)
#[cfg(feature = "hidio")]
pub fn pull_hidio<
KINTF: KiibohdCommandInterface<H>,
const TX: usize,
const RX: usize,
const N: usize,
const H: usize,
const S: usize,
const ID: usize,
>(
&mut self,
interface: &mut CommandInterface<KINTF, TX, RX, N, H, S, ID>,
) {
// Check for any incoming packets
while !interface.rx_bytebuf.is_full() {
let mut packet = Vec::new();
packet.resize_default(N).unwrap();
match self.hidio.pull_raw_output(&mut packet) {
Ok(size) => {
packet.truncate(size);
trace!("rx packet: {:?}", packet);
interface.rx_bytebuf.enqueue(packet).unwrap();
}
Err(UsbError::WouldBlock) => {
// No pending data
break;
}
Err(e) => {
warn!(
"Failed to add packet to hidio rx buffer: {:?} -> {:?}",
e, packet
);
break;
}
}
}
// Process rx buffer
if let Err(e) = interface.process_rx(0) {
warn!("process_rx failed -> {:?}", e);
}
}
/// Push the HID-IO interface (TX)
#[cfg(feature = "hidio")]
pub fn push_hidio<
KINTF: KiibohdCommandInterface<H>,
const TX: usize,
const RX: usize,
const N: usize,
const H: usize,
const S: usize,
const ID: usize,
>(
&mut self,
interface: &mut CommandInterface<KINTF, TX, RX, N, H, S, ID>,
) {
// Push as many packets as possible
while !interface.tx_bytebuf.is_empty() {
// Don't dequeue yet, we might not be able to send
let packet = interface.tx_bytebuf.peek().unwrap();
trace!("tx packet: {:?}", packet);
// Attempt to push
match self.hidio.push_raw_input(packet) {
Ok(_size) => {
// Dequeue
interface.tx_bytebuf.dequeue().unwrap();
}
Err(UsbError::WouldBlock) => {
// USB Endpoint buffer is likely full
break;
}
Err(e) => {
warn!("Failed to push hidio tx packet: {:?} -> {:?}", e, packet);
break;
}
}
}
}
}
#[cfg(feature = "kll-core")]
pub fn enqueue_keyboard_event<const KBD_SIZE: usize>(
cap_run: kll_core::CapabilityRun,
kbd_producer: &mut Producer<KeyState, KBD_SIZE>,
) -> Result<(), KeyState> {
match cap_run {
kll_core::CapabilityRun::HidKeyboard { state, id } => match state {
kll_core::CapabilityEvent::Initial => kbd_producer.enqueue(KeyState::Press(id as u8)),
kll_core::CapabilityEvent::Last => kbd_producer.enqueue(KeyState::Release(id as u8)),
_ => Ok(()),
},
kll_core::CapabilityRun::HidKeyboardState {
state,
id,
key_state,
} => match state {
kll_core::CapabilityEvent::Initial => kbd_producer.enqueue(match key_state {
kll_core::hid::State::Active => KeyState::Press(id as u8),
kll_core::hid::State::Inactive => KeyState::Release(id as u8),
}),
_ => Ok(()),
},
_ => {
error!("Unknown CapabilityRun for Keyboard: {:?}", cap_run);
Err(KeyState::Unknown)
}
}
}
#[cfg(feature = "kll-core")]
pub fn enqueue_ctrl_event<const CTRL_SIZE: usize>(
cap_run: kll_core::CapabilityRun,
ctrl_producer: &mut Producer<CtrlState, CTRL_SIZE>,
) -> Result<(), CtrlState> {
match cap_run {
kll_core::CapabilityRun::HidConsumerControl { state, id } => match state {
kll_core::CapabilityEvent::Initial => {
ctrl_producer.enqueue(CtrlState::ConsumerCtrlPress(id as u16))
}
kll_core::CapabilityEvent::Last => {
ctrl_producer.enqueue(CtrlState::ConsumerCtrlRelease(id as u16))
}
_ => Ok(()),
},
kll_core::CapabilityRun::HidSystemControl { state, id } => match state {
kll_core::CapabilityEvent::Initial => {
ctrl_producer.enqueue(CtrlState::SystemCtrlPress(id as u8))
}
kll_core::CapabilityEvent::Last => {
ctrl_producer.enqueue(CtrlState::SystemCtrlRelease(id as u8))
}
_ => Ok(()),
},
_ => {
error!(
"Unknown CapabilityRun for Consumer/System Control: {:?}",
cap_run
);
Err(CtrlState::Unknown)
}
}
}
#[cfg(feature = "kll-core")]
pub fn enqueue_mouse_event<const MOUSE_SIZE: usize>(
_cap_run: kll_core::CapabilityRun,
_mouse_producer: &mut Producer<MouseState, MOUSE_SIZE>,
) -> Result<(), MouseState> {
// TODO
Err(MouseState::Unknown)
}
#[cfg(feature = "kll-core")]
impl LedState {
pub fn trigger_event(&self) -> kll_core::TriggerEvent {
match self {
LedState::Activate(id) => kll_core::TriggerEvent::HidLed {
state: kll_core::trigger::Aodo::Activate,
index: *id,
last_state: 0,
},
LedState::Deactivate(id) => kll_core::TriggerEvent::HidLed {
state: kll_core::trigger::Aodo::Deactivate,
index: *id,
last_state: 0,
},
}
}
}