aboutsummaryrefslogtreecommitdiff
path: root/src/hid.rs
blob: 4f1d506ed3054c286dd0cbb6f416256af66ad1a6 (plain)
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
// Copyright 2019 Robin Krahl <robin.krahl@ireas.org>
// SPDX-License-Identifier: GPL-3.0-or-later

use core::marker::PhantomData;

use usb_device::bus::{InterfaceNumber, StringIndex, UsbBus, UsbBusAllocator};
use usb_device::class::{ControlIn, ControlOut, UsbClass};
use usb_device::descriptor::DescriptorWriter;
use usb_device::endpoint::EndpointAddress;
use usb_device::Result;

const INTERFACE_CLASS_HID: u8 = 0x03;

#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(u8)]
pub enum Subclass {
    None = 0x00,
    BootInterface = 0x01,
}

impl From<Subclass> for u8 {
    fn from(subclass: Subclass) -> u8 {
        subclass as u8
    }
}

#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(u8)]
pub enum Protocol {
    None = 0x00,
    Keyboard = 0x01,
    Mouse = 0x02,
}

impl From<Protocol> for u8 {
    fn from(protocol: Protocol) -> u8 {
        protocol as u8
    }
}

pub struct HidClass<'a, B: UsbBus> {
    interface: InterfaceNumber,
    subclass: Subclass,
    protocol: Protocol,
    marker: PhantomData<&'a B>,
}

impl<B: UsbBus> HidClass<'_, B> {
    pub fn new(
        alloc: &UsbBusAllocator<B>,
        subclass: Subclass,
        protocol: Protocol,
    ) -> HidClass<'_, B> {
        HidClass {
            interface: alloc.interface(),
            subclass,
            protocol,
            marker: PhantomData,
        }
    }
}

impl<B: UsbBus> UsbClass<B> for HidClass<'_, B> {
    fn poll(&mut self) {}

    fn reset(&mut self) {}

    fn get_configuration_descriptors(&self, writer: &mut DescriptorWriter) -> Result<()> {
        writer.interface(
            self.interface,
            INTERFACE_CLASS_HID,
            self.subclass.into(),
            self.protocol.into(),
        )
    }

    fn get_string(&self, _index: StringIndex, _lang_id: u16) -> Option<&str> {
        None
    }

    fn endpoint_in_complete(&mut self, _addr: EndpointAddress) {}

    fn endpoint_out(&mut self, _addr: EndpointAddress) {}

    fn control_in(&mut self, _xfer: ControlIn<B>) {}

    fn control_out(&mut self, _xfer: ControlOut<B>) {}
}