Add LICENSE, README

This commit is contained in:
David Hoppenbrouwers
2022-09-08 13:17:12 +02:00
parent 20909cdfd6
commit 2bf5a9979b
6 changed files with 49 additions and 10 deletions

View File

@ -2,7 +2,4 @@
name = "report_descriptor"
version = "0.1.0"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
license = "MIT"

View File

@ -0,0 +1,19 @@
# Report descriptor item parser
## Example
```rs
const QEMU_USB_TABLET: &[u8] = &[
0x05, 0x01, 0x09, 0x02, 0xa1, 0x01, 0x09, 0x01, 0xa1, 0x00, 0x05, 0x09, 0x19, 0x01, 0x29,
0x03, 0x15, 0x00, 0x25, 0x01, 0x95, 0x03, 0x75, 0x01, 0x81, 0x02, 0x95, 0x01, 0x75, 0x05,
0x81, 0x01, 0x05, 0x01, 0x09, 0x30, 0x09, 0x31, 0x15, 0x00, 0x26, 0xff, 0x7f, 0x35, 0x00,
0x46, 0xff, 0x7f, 0x75, 0x10, 0x95, 0x02, 0x81, 0x02, 0x05, 0x01, 0x09, 0x38, 0x15, 0x81,
0x25, 0x7f, 0x35, 0x00, 0x45, 0x00, 0x75, 0x08, 0x95, 0x01, 0x81, 0x06, 0xc0, 0xc0,
];
dbg!(usb_hid_report_descriptor::parse(QEMU_USB_TABLET).collect::<Vec<_>>());
```
## References
* <https://www.usb.org/sites/default/files/hid1_11.pdf>

View File

@ -1,7 +1,4 @@
//! ## References
//!
//! https://www.usb.org/sites/default/files/hid1_11.pdf
#![doc = include_str!("../README.md")]
#![cfg_attr(not(test), no_std)]
pub mod usage;

View File

@ -1,6 +1,6 @@
//! # References
//! ## References
//!
//! * https://www.usb.org/sites/default/files/hut1_3_0.pdf
//! * <https://www.usb.org/sites/default/files/hut1_3_0.pdf>
macro_rules! usage {
{ [$page:literal] $($i:literal $v:ident)* } => {