Git-Mirrors/tillitis-key
1
0
Fork 0
mirror of https://github.com/tillitis/tillitis-key1.git synced 2025-05-30 03:11:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

fw/ch552: Document new dynamic endpoint functionality

Browse source 
The CH552 firmware has an added functionality to control the USB
controller dynamically, turning on and off endpoints with a small
protocol.

Since most of the documentation for the already lives in the ordinary
firmware README, add this documentation there, too.
This commit is contained in:
Michael Cardell Widerkrantz 2025-04-04 11:48:05 +02:00
parent 7eca72c2c3
commit d0c049cdba
No known key found for this signature in database
GPG key ID: D3DB3DDF57E704E5
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
hw/application_fpga/fw/README.md
View file

@ -65,9 +65,26 @@ The different endpoints:
| *Name* | *Value* | *Comment* |
|--------|---------|----------------------------------------------------------------------|
| DEBUG | 0x20 | A USB HID special debug pipe. Useful for debug prints. |
| CH552 | 0x10 | USB controller control |
| CDC | 0x40 | USB CDC-ACM, a serial port on the client. |
| FIDO | 0x80 | A USB FIDO security token device, useful for FIDO-type applications. |
You can turn on and off different endpoints dynamically by sending
commands to the `CH552` control endpoint. When the TKey starts only
the `CH552` and the `CDC` endpoints are active. To change this, send a
command to `CH552` in this form:
| *Name* | *Size* | *Comment* |
|---------|--------|-------------------------------|
| Command | 1B | Command to the CH552 firmware |
| Payload | 1B | Data for the command |
Commands:
| *Name* | *Value* | *Argument* |
|------------------|---------|----------------------|
| Enable endpoints | 0x01 | Bitmask of endpoints |
On top of the USB Mode Protocol is [the TKey Framing
Protocol](https://dev.tillitis.se/protocol/) which is described in the
Developer Handbook.