Bug 264125 - usbdump(8) output does not match man page
Summary: usbdump(8) output does not match man page
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-usb (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-05-21 12:05 UTC by Christian Weisgerber
Modified: 2024-12-05 06:03 UTC (History)
6 users (show)

See Also:

Attachments
USB default dump format description update (83.98 KB, image/png)
2024-10-18 00:37 UTC, Jim B. 		no flags Details
Describe usbdump(8) default format. (2.16 KB, patch)
2024-10-18 16:46 UTC, Jim B. 		no flags Details | Diff
Fixec markup on include file (near end) (2.17 KB, patch)
2024-10-18 16:55 UTC, Jim B. 		no flags Details | Diff
Show Obsolete (1) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Christian Weisgerber freebsd_committer freebsd_triage 2022-05-21 12:05:51 UTC 
The usbdump(8) output format does not match the description in the man page.

An example of actual output:
13:58:52.572788 usbus0.2 SUBM-INTR-EP=00000004,SPD=FULL,NFR=1,SLEN=64,IVAL=2
13:58:52.572794 usbus0.2 SUBM-INTR-EP=00000084,SPD=FULL,NFR=1,SLEN=0,IVAL=2
13:58:52.573164 usbus0.2 DONE-INTR-EP=00000004,SPD=FULL,NFR=1,SLEN=0,IVAL=2,ERR=0
13:58:52.574168 usbus0.2 DONE-INTR-EP=00000084,SPD=FULL,NFR=1,SLEN=64,IVAL=2,ERR=0

Apparently the output format was changed in revision 220301 (git 31a116918647) and the man page was never updated.
Comment 1 Hans Petter Selasky freebsd_committer freebsd_triage 2022-05-21 18:27:37 UTC 
Feel free to submit a patch!
Comment 2 Mark Linimon freebsd_committer freebsd_triage 2023-07-25 19:43:29 UTC 
bugmeister would like to thank Hans Petter for his years of ports maintenance
and his work on FreeBSD in general. May he rest in peace.

An in-memoriam can be read at
https://lists.freebsd.org/archives/freebsd-announce/2023-July/000076.html

With hat:	bugmeister
Comment 3 Jim B. 2024-10-18 00:37:49 UTC 
Created attachment 254320 [details]
USB default dump format description update

I've taken a stab at putting together the description of the default format.  I used the code in usbdump.c and the dev/usb/usb*.h files as reference.

However, I've not developed any code using USB, so I'd like someone to verify these descriptions.

See attached screenshot.

Thanks!
Comment 4 Jim B. 2024-10-18 16:46:39 UTC 
Created attachment 254338 [details]
Describe usbdump(8) default format.

Attaching diff.  Will upload to Phabricator shortly.
Comment 5 Jim B. 2024-10-18 16:55:20 UTC 
Created attachment 254340 [details]
Fixec markup on include file (near end)

Fixed markup on include file (near end).