aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2019-02-18 10:56:30 +0000
committerRobin Krahl <robin.krahl@ireas.org>2019-02-18 15:30:10 +0100
commit7da90438dd7851f66abfa81eba2eeb36ff9c9c25 (patch)
tree400bd0f6ab5e15899bd3fc1d8df55b57acfd1cf8 /README.md
parenta3f0fb062048c52c3f04e907f0107e1db9b6141c (diff)
downloadntw-7da90438dd7851f66abfa81eba2eeb36ff9c9c25.tar.gz
ntw-7da90438dd7851f66abfa81eba2eeb36ff9c9c25.tar.bz2
Add USB stack and simple HID implementation
This patch adds the usb-device and stm32f103xx-usb crates that provide a USB stack. It introduces the HidClass struct, a basic implementation of the Human Interface Device (HID) USB class. Devices with that class are recognized as HID devices with the specified vendor and product ID, but do not provide the endpoints required for interaction.
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index d026801..7570d2e 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,9 @@ SPDX-License-Identifier: CC0-1.0
# ntw
`ntw` is an experimental firmware for the Nitrokey Pro. It is in very early
-development and currently does not support any commands.
+development and supports:
+
+- connecting as a USB device with the Nitrokey Pro’s product and vendor ID
## Resources
@@ -21,6 +23,15 @@ development and currently does not support any commands.
[STM32F103RB-ds]: https://www.st.com/resource/en/datasheet/stm32f103rb.pdf
[STM32F103RB-rm]: https://www.st.com/content/ccc/resource/technical/document/reference_manual/59/b9/ba/7f/11/af/43/d5/CD00171190.pdf/files/CD00171190.pdf/jcr:content/translations/en.CD00171190.pdf
+### Protocols
+
+- [Universal Serial Bus Specification][usb], Revision 1.1
+- [Universal Serial Bus: Device Class Definition for Human Interface Devices
+ (HID)][hid], Firmware Specification, Version 1.11
+
+[usb]: http://esd.cs.ucr.edu/webres/usb11.pdf
+[hid]: https://www.usb.org/sites/default/files/documents/hid1_11.pdf
+
## Contact
For bug reports, patches, feature requests or other messages, please send a