diff mbox series

[v3,2/2] docs/system/devices/canokey: Document limitations on usb-ehci

Message ID 20220624152940.11756-2-mkfssion@mkfssion.com (mailing list archive)
State New, archived
Headers show
Series [v3,1/2] hw: canokey: Remove HS support as not compliant to the spec | expand

Commit Message

MkfsSion June 24, 2022, 3:29 p.m. UTC
Suggested-by: Hongren (Zenithal) Zheng <i@zenithal.me>
Signed-off-by: YuanYang Meng <mkfssion@mkfssion.com>
---
 docs/system/devices/canokey.rst | 12 +++---------
 1 file changed, 3 insertions(+), 9 deletions(-)

Comments

Hongren Zheng June 24, 2022, 4:11 p.m. UTC | #1
On Fri, Jun 24, 2022 at 11:29:40PM +0800, MkfsSion wrote:
>  
> -Another limitation is that this device is not compatible with ``qemu-xhci``,
> -in that this device would hang when there are FIDO2 packets (traffic on
> -interrupt endpoints). If you do not use FIDO2 then it works as intended,
> -but for full functionality you should use old uhci/ehci bus and attach canokey
> -to it, for example
> -
> -.. parsed-literal::
> -
> -   |qemu_system| -device piix3-usb-uhci,id=uhci -device canokey,bus=uhci.0

Hi, the fix for the limitation on qemu-xhci has not been landed and should not
be removed by this patch.

> +Another limitation is that this device is not compatible with ``usb-ehci``
> +since we removed high-speed mode support. When a full-speed device attach
> +to a high-speed port, ``usb-ehci`` would complain about speed mismatch.

I think we could rephrase the limitation here. Instead of saying "we
removed the high-speed mode", how about saying "this device only
provides the full-speed mode".

Also you should list the changes between two PATCH versions
below the --- line just after your commit message
so the mailing list can track what happened.

Regards,

Hongren
diff mbox series

Patch

diff --git a/docs/system/devices/canokey.rst b/docs/system/devices/canokey.rst
index 169f99b8eb..650702ad8a 100644
--- a/docs/system/devices/canokey.rst
+++ b/docs/system/devices/canokey.rst
@@ -146,15 +146,9 @@  multiple CanoKey QEMU running, namely you can not
 Also, there is no lock on canokey-file, thus two CanoKey QEMU instance
 can not read one canokey-file at the same time.
 
-Another limitation is that this device is not compatible with ``qemu-xhci``,
-in that this device would hang when there are FIDO2 packets (traffic on
-interrupt endpoints). If you do not use FIDO2 then it works as intended,
-but for full functionality you should use old uhci/ehci bus and attach canokey
-to it, for example
-
-.. parsed-literal::
-
-   |qemu_system| -device piix3-usb-uhci,id=uhci -device canokey,bus=uhci.0
+Another limitation is that this device is not compatible with ``usb-ehci``
+since we removed high-speed mode support. When a full-speed device attach
+to a high-speed port, ``usb-ehci`` would complain about speed mismatch.
 
 References
 ==========