History log of /freebsd-current/usr.sbin/usbconfig/usbconfig.8
Revision Date Author Comments
# b2c76c41 16-Aug-2023 Warner Losh <imp@FreeBSD.org>

Remove $FreeBSD$: one-line nroff pattern

Remove /^\.\\"\s*\$FreeBSD\$$\n/


# 75a86e93 29-Jan-2022 Mateusz Piotrowski <0mp@FreeBSD.org>

usbconfig.8: Sort flags according to style(9)

MFC after: 2 weeks


# 5eafaf9e 29-Jan-2022 Mateusz Piotrowski <0mp@FreeBSD.org>

usbconfig.8: Improve style and fix examples

- Use Ar macros for arguments
- Stylize the argument synopsis to the -d flag
- Change the width of the list to one of the actual tags in the list
- Stylize "ugen" and "/dev/ugen" with Cm as those are constant strings,
which are usually treated as command modifiers.
- Break long lines to reduce the number of warnings from linters
- Fix examples; the -d flag is now required when specifying the unit and
the address with the "dot notation".

MFC after: 2 weeks


# d69b9cc2 20-Dec-2021 Joerg Wunsch <joerg@FreeBSD.org>

usbconfig: implement a -v option

Implement a -v option to usbconfig(8), as a shortcut for the most
frequently needed commands dump_device_desc, dump_curr_config_desc,
and show_ifdrv.

While here, implement a real -h option that has been promised by the
man page.

Use <sysexits.h> to declare the utility return codes.

Reviewed by: hselasky
Differential Revision: https://reviews.freebsd.org/D33586
MFC after: 2 weeks


# cae1884d 20-Dec-2021 Joerg Wunsch <joerg@FreeBSD.org>

usbconfig: documentation fixes, mainly for -i option

* in usage(), clearly mark -i interface as optional
* both, -u busnum and -a devaddr are optional as well
* various minor man page fixes
* clearly mark those two commands that actually use -i ifaceidx
* remove unused bitfield tag got_iface
* fix indentation level according to review comment

Differential Revision: https://reviews.freebsd.org/D33579/
Reviewed by: hselasky
MFC after: 2 weeks


# ae450e6d 19-Dec-2021 Joerg Wunsch <joerg@FreeBSD.org>

usbconfig: use getopt(3) for option handling

This makes option handling consistent with other utilities as well as
Posix rules. By that, it's no longer important whether option name and
its argument are separated by a space or not, so -d5.3 works the same
as -d 5.3.

Also, recognize either /dev/ugen or ugen as prefix to the -d argument.

Note that this removes the undocumented feature that allowed to
specify multiple -d n.m options interleaved with commands referring to
that particular device in a single run.


# fa6d8b65 27-Dec-2019 Hans Petter Selasky <hselasky@FreeBSD.org>

Implement dump_stats command for usbconfig(8).

This command is useful when debugging USB device issues.

MFC after: 1 week
Sponsored by: Mellanox Technologies


# 49366f62 16-Aug-2019 Hans Petter Selasky <hselasky@FreeBSD.org>

Implement detach_kernel_driver command in usbconfig(8).

Submitted by: Kevin Zheng <kevinz5000@gmail.com>
PR: 239916
MFC after: 1 week


# 41adbaa5 29-Apr-2018 Edward Tomasz Napierala <trasz@FreeBSD.org>

Clean up the EXAMPLES section of usbconfig(8). This removes parts that
become redundant after documenting all the subcommands, and switches
to the new syntax, without the '-d'.

Reviewed by: hselasky@
MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation


# 912280b4 17-Apr-2018 Edward Tomasz Napierala <trasz@FreeBSD.org>

Make it possible to pass the ugenX.Y to usbconfig(8) without using "-d",
eg "usbconfig ugen1.2 dump_all_desc".

Reviewed by: hselasky@
MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation


# cd1fd29c 13-Mar-2018 Edward Tomasz Napierala <trasz@FreeBSD.org>

Add "usbconfig dump_all_desc", a subcommand to dump all device and config
descriptors.

Reviewed by: hselasky@
MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation


# 49f05397 03-Jan-2018 Edward Tomasz Napierala <trasz@FreeBSD.org>

Fix warnings from "mandoc -Tlint -Wwarning".

Reported by: Yuri Pankov <yuripv at gmx.com>
MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation


# 2e07d451 29-Dec-2017 Edward Tomasz Napierala <trasz@FreeBSD.org>

Improve usbconfig(8) manual page by adding descriptions for subcommands.

Reviewed by: hselasky
MFC after: 2 weeks
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D13445


# 0ea0127a 10-Nov-2010 Nick Hibma <n_hibma@FreeBSD.org>

Add a man page for usb_quirk module, plus references in other man pages,
and updated comments in the usb_quirk.h header file.

The main purpose of this is to expose the quirks for ejecting 3G
modules. usb_modeswitch in Linux does a great job of collecting
information on these, and with the quirks module people can try out the
modeswitch config file entries on FreeBSD, hence the SCSI strings in the
man page.

MFC after: 2 weeks


# a7d5f7eb 19-Oct-2010 Jamie Gritton <jamie@FreeBSD.org>

A new jail(8) with a configuration file, to replace the work currently done
by /etc/rc.d/jail.


# fe0506d7 09-Mar-2010 Marcel Moolenaar <marcel@FreeBSD.org>

Create the altix project branch. The altix project will add support
for the SGI Altix 350 to FreeBSD/ia64. The hardware used for porting
is a two-module system, consisting of a base compute module and a
CPU expansion module. SGI's NUMAFlex architecture can be an excellent
platform to test CPU affinity and NUMA-aware features in FreeBSD.


# c38eb921 17-Jan-2010 Andrew Thompson <thompsa@FreeBSD.org>

MFC r201705

Sync to p4
- Add new quirks commands and the '-d' option optionally to specify the ugen device.


# cf109686 06-Jan-2010 Andrew Thompson <thompsa@FreeBSD.org>

Sync to p4
- Add new quirks commands and the '-d' option optionally to specify the ugen device.

Submitted by: Hans Petter Selasky


# 92eb005c 07-Nov-2009 Christian Brueffer <brueffer@FreeBSD.org>

MFC: r198750

Expand DESCRIPTION and add a basic EXAMPLES section.


# 94b7ebd7 01-Nov-2009 Christian Brueffer <brueffer@FreeBSD.org>

Expand DESCRIPTION and a basic EXAMPLES section.

PR: 139605
Submitted by: Warren Block <wblock@wonkity.com>
MFC after: 1 week


# 9d3086c7 27-May-2009 Andrew Thompson <thompsa@FreeBSD.org>

Fix xref name.


# eabe30fc 03-Nov-2008 Alfred Perlstein <alfred@FreeBSD.org>

Bring in USB4BSD, Hans Petter Selasky rework of the USB stack
that includes significant features and SMP safety.

This commit includes a more or less complete rewrite of the *BSD USB
stack, including Host Controller and Device Controller drivers and
updating all existing USB drivers to use the new USB API:

1) A brief feature list:

- A new and mutex enabled USB API.

- Many USB drivers are now running Giant free.

- Linux USB kernel compatibility layer.

- New UGEN backend and libusb library, finally solves the "driver
unloading" problem. The new BSD licensed libusb20 library is fully
compatible with libusb-0.1.12 from sourceforge.

- New "usbconfig" utility, for easy configuration of USB.

- Full support for Split transactions, which means you can use your
full speed USB audio device on a high speed USB HUB.

- Full support for HS ISOC transactions, which makes writing drivers
for various HS webcams possible, for example.

- Full support for USB on embedded platforms, mostly cache flushing
and buffer invalidating stuff.

- Safer parsing of USB descriptors.

- Autodetect of annoying USB install disks.

- Support for USB device side mode, also called USB gadget mode,
using the same API like the USB host side. In other words the new
USB stack is symmetric with regard to host and device side.

- Support for USB transfers like I/O vectors, means more throughput
and less interrupts.

- ... see the FreeBSD quarterly status reports under "USB project"

2) To enable the driver in the default kernel build:

2.a) Remove all existing USB device options from your kernel config
file.

2.b) Add the following USB device options to your kernel configuration
file:

# USB core support
device usb2_core

# USB controller support
device usb2_controller
device usb2_controller_ehci
device usb2_controller_ohci
device usb2_controller_uhci

# USB mass storage support
device usb2_storage
device usb2_storage_mass

# USB ethernet support, requires miibus
device usb2_ethernet
device usb2_ethernet_aue
device usb2_ethernet_axe
device usb2_ethernet_cdce
device usb2_ethernet_cue
device usb2_ethernet_kue
device usb2_ethernet_rue
device usb2_ethernet_dav

# USB wireless LAN support
device usb2_wlan
device usb2_wlan_rum
device usb2_wlan_ral
device usb2_wlan_zyd

# USB serial device support
device usb2_serial
device usb2_serial_ark
device usb2_serial_bsa
device usb2_serial_bser
device usb2_serial_chcom
device usb2_serial_cycom
device usb2_serial_foma
device usb2_serial_ftdi
device usb2_serial_gensa
device usb2_serial_ipaq
device usb2_serial_lpt
device usb2_serial_mct
device usb2_serial_modem
device usb2_serial_moscom
device usb2_serial_plcom
device usb2_serial_visor
device usb2_serial_vscom

# USB bluetooth support
device usb2_bluetooth
device usb2_bluetooth_ng

# USB input device support
device usb2_input
device usb2_input_hid
device usb2_input_kbd
device usb2_input_ms

# USB sound and MIDI device support
device usb2_sound

2) To enable the driver at runtime:

2.a) Unload all existing USB modules. If USB is compiled into the
kernel then you might have to build a new kernel.

2.b) Load the "usb2_xxx.ko" modules under /boot/kernel having the same
base name like the kernel device option.

Submitted by: Hans Petter Selasky hselasky at c2i dot net
Reviewed by: imp, alfred