nusb: fix documentation, cleanup, remove /sys/src/cmd/usb

2 files changed, 0 insertions, 761 deletions

diff --git a/sys/man/4/usb b/sys/man/4/usb
deleted file mode 100644
index fa20e3a5d..000000000
--- a/sys/man/4/usb
+++ /dev/null
@@ -1,516 +0,0 @@
-.TH USB 4
-.SH NAME
-audio,
-ccid,
-disk,
-ether,
-kb,
-print,
-probe,
-serial,
-usbeject,
-usbfat:
-\- Universal Serial Bus device drivers
-.SH SYNOPSIS
-.B usb/kb
-[
-.B -dkm
-] [
-.B -a
-.I accel
-] [
-.I dev ...
-]
-.PP
-.B usb/disk
-[
-.B -Dd
-] [
-.B -m
-.I mnt
-] [
-.B -s
-.I srv
-] [
-.I dev ...
-]
-.PP
-.B usbfat:
-[
-.I disk ...
-]
-.PP
-.B usbeject
-[
-.I disk ...
-]
-.PP
-.B usb/audio
-[
-.B -dpV
-] [
-.B -m
-.I mnt
-] [
-.B -s
-.I srv
-] [
-.B -v
-.I vol
-] [
-.I dev
-]
-.PP
-.B usb/ether
-[
-.B -Dd
-] [
-.B -m
-.I mnt
-] [
-.B -s
-.I srv
-] [
-.I dev ...
-]
-.PP
-.B usb/serial
-[
-.B -Dd
-] [
-.B -m
-.I mnt
-] [
-.B -s
-.I srv
-] [
-.I dev ...
-]
-.PP
-.B usb/print
-[
-.B -d
-] [
-.I dev ...
-]
-.PP
-.B usb/ccid
-[
-.B -d
-]
-.ig
-.PP
-.B usb/ibuddy
-[
-.B -Dd
-] [
-.B -m
-.I mnt
-] [
-.B -s
-.I srv
-] [
-.I dev ...
-]
-..
-.B usb/probe
-.SH DESCRIPTION
-These programs drive USB devices of specific classes via
-.IR usb (3).
-Usually they are started by
-.IR usbd (4)
-upon attachment of the device to the bus.
-Less often, users start them manually, depending on
-.IR usbd (4)'s
-configuration.
-Usually,
-.I kb
-and
-.I disk
-are started by
-.I usbd
-and other programs are started by hand.
-.PP
-Without arguments, the drivers handle all the devices (of
-the appropriate USB class) found on the bus.
-To make a driver handle only certain devices, supply as arguments
-the paths for the directories of the devices
-(actually of their zero endpoints).
-.PP
-Drivers that provide file systems accept options
-.B -s
-and
-.B -m
-to instruct them to post a 9P connection at
-.IR srv (3)
-with the given name and/or to mount themselves at
-.IR mnt .
-When embedded into
-.IR usbd
-these options may not be used.
-In this case,
-the file tree supplied by the device driver is
-available through the file system provided by
-.IR usbd ,
-usually mounted at
-.B /dev
-and reachable through the 9P connection posted at
-.BR /srv/usb .
-.PP
-Options
-.B -d
-and
-.B -D
-present on most drivers trigger debug diagnostics and
-file system debugging diagnostics.
-Repeating any one of these may increase verbosity.
-.PP
-To help locate devices of interest,
-.I probe
-lists all the USB devices available,
-including those with no driver started.
-.SS Keyboards and mice
-.I Kb
-supports USB keyboards and mice either as separate USB devices
-or as a single combined USB device.
-Scan codes from the keyboard are sent to
-.B /dev/kbin
-to let
-.IR kbdfs (8)
-process them.
-Mouse events are sent to
-.B /dev/mousein
-in the same way.
-.PP
-The following options are understood:
-.TF -k
-.TP
-.B \-a
-Accelerate the mouse to level
-.I n
-(similar to the kernel mouse driver acceleration).
-.TP
-.B \-k
-Serve just the keyboard (and not the mouse).
-.TP
-.B \-m
-Serve just the mouse (and not the keyboard).
-.SS Disks
-.I Disk
-configures and manages USB mass storage devices. It
-provides a file system (usually seen at
-.BR /dev )
-that includes one directory per storage device, named
-.BI sdU N . M
-in correspondence with the usb device number and the storage
-unit number (or LUN).
-For example, LUN number 2 on
-.B /dev/usb/ep3.0
-can be accessed through
-.BR /dev/sdU3.2 .
-.PP
-The storage device directory contains the usual files
-served by
-.IR sd (3):
-.BR data ,
-.BR raw ,
-and
-.BR ctl .
-.PP
-The
-.B ctl
-file supplies the device
-geometry when read.
-.PP
-The script
-.B usbfat:
-mounts the FAT file systems in the DOS partitions of the named
-.IR disk s;
-if none, it mounts those file systems found at
-.BR /dev/sdU*.*/data .
-When more than one partition is found, a suffix is appended to
-the disk name to identify the partition number.
-The script
-.B usbeject
-undoes the effect. If no argument is given, it unmounts all USB
-disks. An argument
-.BI sdU N
-unmounts all partitions from disk with USB target
-.IR N .
-.ig
-An argument
-.BI sdU N . M
-or
-.BI sdU N . M . P
-.\" TODO: fill in missing words
-..
-.SS Printers
-.I Print
-provides a single file can be written to print on a USB printer.
-Options are similar to those of
-.IR disk .
-The file is also bound at
-.B /dev/lp
-as is customary.
-.SS Ethernet adapters
-.I Ether
-provides a file interface similar to that of
-.IR ether (3)
-for each USB Ethernet adapter found.
-The name of an Ethernet device is
-.BI etherU N
-where
-.I N
-is the device name.
-When started manually, the file interface is mounted at
-.B /net
-as is customary.
-.
-.SS Serial and JTAG ports
-.I Serial
-provides a file system (usually mounted at
-.BR /dev )
-that includes one directory per USB serial port, named
-.BI eiaU N
-or
-.BI eiaU N . M.
-In this directory there are two files,
-.BR eiaU ,
-similar to
-.BI eia N
-in
-.IR uart (3),
-and
-.BR eiaUctl ,
-which admits writes in the same format as
-.BI eia N ctl
-in
-.IR uart (3).
-Reading from
-.B eiaUctl
-gives the serial port's settings in the same format as
-.BI eia N status
-in
-.IR uart (3).
-Options are similar to those of
-.IR disk .
-.PP
-JTAG ports are similar
-but the files are named
-.B jtag
-and
-.BR jtagctl .
-.
-.SS Audio devices
-.I Usbaudio
-configures and manages a USB audio device.
-It implements a file system,
-normally mounted on
-.BI /dev ,
-but this can be changed with
-.BR \-m ,
-containing files
-.BR volume ,
-.BR audioctl ,
-.BR audio ,
-and
-.BR audioin .
-The names
-.B volume
-and
-.B audio
-maintain backward compatibility with the Soundblaster driver.
-.PP
-The
-.B \-V
-option (verbose)
-causes
-.I audio
-to print information about the device on startup.
-The
-.B \-s
-option specifies a name for a file descriptor to be posted in
-.BR /srv .
-The
-.B \-v
-options sets initial
-.IR volume .
-.PP
-Reading
-.B volume
-or
-.B audioctl
-yields the device's settings.
-The data format of
-.B volume
-is compatible with the Soundblaster and produces output in this
-format:
-.IP
-.EX
-audio out 65
-treb out 0
-bass out 0
-speed out 44100
-.EE
-.PP
-This file can be written using the same syntax.
-The keyword
-.L out
-may be omitted.
-Settings are given as percentages of the range,
-except for speed which is in Hz.
-.PP
-The file
-.B audioctl
-provides more information, using up to 6 columns of 12 characters each.
-From left to right, the fields are:
-.IR "control name" ,
-.I in
-or
-.IR out ,
-.IR "current value" ,
-.IR "minimum value" ,
-.IR maximum ,
-and
-.IR resolution .
-There are 3, 5, or 6 columns present.
-Maxima and resolution are omitted when they are not available or not applicable.
-The resolution for
-.I speed
-is reported as 1 (one) if the sampling frequency is continuously variable.
-It is absent if it is settable at a fixed number of discrete values only.
-.PP
-When all values from
-.B audioctl
-have been read, a zero-length buffer is returned
-(the usual end-of-file indication).
-A new
-.I read
-will then block until one of the settings changes,
-then report its new value.
-.PP
-The file
-.B audioctl
-can be written like
-.BR volume .
-.PP
-Audio data is written to
-.B audio
-and read from
-.BR audioin .
-The data format is little-endian,
-samples ordered primarily by time and
-secondarily by channel.
-Samples occupy the minimum integral number of bytes.
-Read and write operations of arbitrary size are allowed.
-.
-.SS Ccid
-.I Ccid
-discovers and configures SIM or SAM cards using the CCID standard.
-It provides a file system (usually mounted at
-.BR /dev )
-that includes three files,
-.BI ctl ,
-.B raw
-and
-.BI rpc .
-Reading from
-.B ctl
-a description of the smartcard reader capabilities is printed.
-.B raw
-is just intended for debugging.
-Reads and writes to the
-raw file send and receive raw CCID packets.
-Smart cards identify themselves by giving out an ATR,
-an array of characters describing the card uniquely.
-Users of the driver write the ATR to the
-.B rpc
-file and are blocked until a card with that ATR is seen.
-From then on they can do ICC RPCs using whatever
-language the smart card speaks. A small write cancels
-an outstanding RPC.
-.PP
-The driver takes care of powering the card adequately, based
-on its ATR, and tunnelling the RPCs through the USB device.
-Only slot 0 is supported.
-.PP
-When the smartcard disappears,
-all reads and write fail until the file is reopened and
-a new ATR is written to it.
-.
-.ig
-.SS Ibuddy
-.PP
-Ibuddy supports a USB I-buddy toy, a little winged-demon.
-The driver provides one directory per attached toy with a single
-.BR ctl
-file to control the device.
-Directories are named
-.BR ibuddyN ,
-being
-.I N
-the corresponding usb device number.
-When read, the
-.BR ctl
-file provides the state of the device in this form:
-.IP
-.EX
-hips right|left
-wings open|close
-red on|off
-green on|off
-blue on|off
-heart on|off
-.EE
-.PP
-Each line describes the status of one feature.
-.IR  Red ,
-.IR  blue ,
-and
-.IR  green
-are the different leds in the head of
-the toy.
-.IR  Heart
-represents the red led in the chest of
-the toy.
-.IR  Wings
-represents the status of the wings, which
-can be closed or open.
-.IR  Hips
-represents the orientation
-of the toy (left or right, from the figure's point of view).
-.PP
-Lines can be written to the
-.BR ctl
-file to command the device.
-Multiple lines (six at most) can be written
-at once, with one action per line.
-..
-.SH SOURCE
-.B /sys/src/cmd/usb
-.SH "SEE ALSO"
-.IR mouse (3),
-.IR sd (3),
-.IR uart (3),
-.IR usb (3),
-.IR usbd (4),
-.IR partfs (8),
-.IR kbdfs (8)
-.SH BUGS
-The various device drivers are generic USB drivers and
-may work only for certain devices on each class.
-.PP
-USB ATA storage devices are not supported.
-.PP
-The Ethernet device works only for certain ASIX-based cards and for CDC devices.
-Both the Ethernet and printer drivers have not
-been tested and it is likely they will fail.
-.PP
-The serial driver works only for the Prolific chip and Ftdi,
-and control of the
-.B dcd
-and
-.B dsr
-signals and some of the extra features are unimplemented.
-For Ftdi, only the Sheevaplug and Guruplug have been tried.
-There is support for the EHCI debug port, but it loses bytes.
diff --git a/sys/man/4/usbd b/sys/man/4/usbd
deleted file mode 100644
index c0d3ca6cd..000000000
--- a/sys/man/4/usbd
+++ /dev/null
@@ -1,245 +0,0 @@
-.TH USBD 4
-.SH NAME
-usbd \- Universal Serial Bus daemon
-.SH SYNOPSIS
-.B usbd
-[
-.B -Dd
-]
-[
-.B -s
-.I srv
-]
-[
-.B -m
-.I mnt
-]
-[
-.I hub...
-]
-.SH DESCRIPTION
-.I Usbd
-complements
-.IR usb (3)
-to provide USB I/O for device drivers.
-It enumerates the bus, polling
-hub ports to detect device attachments and detachments, performs
-initial configuration of setup endpoints, and writes extra information into
-.IR usb (3)
-endpoint control files, to ease device location.
-.PP
-By default,
-.I usbd
-opens all setup endpoints found at
-.B #u/usb
-(which correspond to built-in hubs initialized by the kernel during boot).
-Paths to directories representing setup endpoints for hubs can be given
-as arguments to restrict
-.I usbd
-operation to such hubs.
-.PP
-When a device is attached,
-depending upon a configuration file compiled into
-.I usbd ,
-the appropriate device driver may be started without
-user intervention.
-This mechanism can be used to statically link some USB device drivers into
-.I usbd
-itself.
-Initial configuration for setup endpoints is performed independently
-of this configuration.
-.PP
-.I Usbd
-provides a file interface used to change debugging flags, and also used by
-USB device drivers statically linked into
-.IR usbd .
-By default, the file system is mounted (after) at
-.B /dev
-and a 9P connection is posted at
-.BR /srv/usb .
-.PP
-Besides files provided by device drivers, the file
-.B usbdctl
-is always present in the file interface.
-It accepts these control requests:
-.TF "fsdebug\fI n
-.TP
-.BI debug " n"
-Sets the debugging level to
-.IR n .
-.TP
-.BI fsdebug " n"
-Sets the file system debugging level to
-.IR n .
-.TP
-.B dump
-Prints the list of devices and file systems known by
-.IR usbd .
-.PD
-.PP
-.I Usbd
-recognizes the following options:
-.TF "-m\fI mnt
-.TP
-.B -d
-Print debugging diagnostics.
-Repeating the option increases verbosity.
-.TP
-.B -D
-Print debugging diagnostics for the file system interface.
-.TP
-.BI -m " mnt"
-Mount the served file system at
-.IR mnt .
-.TP
-.BI -s " srv"
-Post a 9P connection at
-.BI #s/ srv.
-.PD
-.SS Configuration
-.PP
-.I Usbd
-can be configured to start drivers for devices matching one or more CSPs
-(hex representation of USB class, subclass and protocol), class,
-subclass, protocol, vendor id, or device id.
-When a new device is attached,
-.I usbd
-scans the configuration and, if an entry matches the device descriptor, starts
-the driver.
-If no driver is configured, the setup endpoint for the device is left
-configured to let the user start the driver by hand.
-.PP
-Configuration is via compilation
-because one of the options is to embed (link) the driver into the
-.I usbd
-binary.
-If the driver is embedded,
-.I usbd
-creates a process for it and calls its main entry point.
-Otherwise,
-.I usbd
-tries to locate the driver binary in
-.B /bin/usb
-and creates a process to execute it.
-.PP
-The configuration file,
-.BR usbdb ,
-has two sections:
-.B embed
-and
-.BR auto .
-Each section includes lines to configure particular drivers.
-A driver may have more than one line if necessary.
-Each line includes the name of the
-driver (the base name of the binary) and one or more attributes of the form
-.IP
-.IR name = value
-.PP
-The following attributes exist:
-.TF subclass
-.TP
-.B class
-.I Value
-may be the name of the class
-or a number identifying the device class (using C syntax).
-The following class names are known:
-.BR audio ,
-.BR comms ,
-.BR hid ,
-.BR printer ,
-.BR storage ,
-.BR hub ,
-and
-.BR data .
-.TP
-.B subclass
-.I Value
-is the number of the device subclass.
-.TP
-.B proto
-.I Value
-is the number of the device protocol.
-.TP
-.B csp
-.I Value
-is the hexadecimal number describing the CSP for the device.
-.TP
-.B vid
-.I Value
-is the vendor id.
-.TP
-.B did
-.I Value
-is the device id.
-.TP
-.B args
-This must be the last field.
-The value is the rest of the line,
-and is supplied as arguments to the driver process.
-.PD
-.LP
-Several environment variables can be used to alter the behaviour of
-.IR usbd ,
-for example, for use in
-.IR plan9.ini (8).
-.B usbdebug
-sets a debug level (zero for no diagnostics and positive
-values for increasing verbosity).
-.B kbargs
-overrides the keyboard arguments as specified by the configuration file.
-.B diskargs
-overrides the disk arguments in the same way.
-.SH EXAMPLE
-This configuration file links
-.B usb/kb
-into
-.I usbd
-when it is compiled.
-It arranges for the driver's entry point,
-.B kbmain
-in this case,
-to be called for any device with CSPs matching either
-.B 0x010103
-or
-.BR 0x020103 .
-Option
-.B -d
-will be supplied as command line arguments for
-.BR kbmain .
-This configuration also arranges for
-.B /bin/usb/disk
-to start (with no arguments) whenever a device of class
-.B storage
-is attached.
-.IP
-.EX
-embed
-	kb	csp=0x010103 csp=0x020103	args=-d
-auto
-	disk	class=storage	args=
-.EE
-.SH FILES
-.TF /srv/usb
-.TP
-.B /srv/usb
-9P connection to the driver file system.
-.TP
-.B /dev
-mount point for the driver file system.
-.TP
-.B /sys/src/cmd/usb/usbd/usbdb
-Configuration file deciding which devices are included into
-.I usbd
-and which ones are started automatically.
-.SH SOURCE
-.B /sys/src/cmd/usb/usbd
-.SH "SEE ALSO"
-.IR usb (2),
-.IR usb (3),
-.IR usb (4)
-.SH BUGS
-.I Usbd
-is not supposed to be restarted.
-This is arguable.
-.PP
-Not heavily exercised yet.