Add uftdi(4) man page.

Update usb(4) man page to be closer to reality.
This commit is contained in:
augustss 2000-04-14 14:55:18 +00:00
parent 633209364f
commit 23de687384
3 changed files with 105 additions and 15 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: ucom.4,v 1.2 2000/03/30 18:14:46 augustss Exp $
.\" $NetBSD: ucom.4,v 1.3 2000/04/14 14:55:18 augustss Exp $
.\"
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -42,6 +42,7 @@
.Nd USB tty support
.Sh SYNOPSIS
.\"Cd "ucom* at uetekcom? portno ?"
.Cd "ucom* at uftdi?"
.Cd "ucom* at umodem? portno ?"
.Cd "ucom* at uvisor?"
.Pp
@ -71,6 +72,7 @@ multiple external ports.
.Sh SEE ALSO
.Xr tty 4 ,
.\"Xr uetekcom 4 ,
.Xr uftdi 4 ,
.Xr umodem 4 ,
.Xr uvisor 4 ,
.Xr usb 4

73
share/man/man4/uftdi.4 Normal file
View File

@ -0,0 +1,73 @@
.\" $NetBSD: uftdi.4,v 1.1 2000/04/14 14:55:18 augustss Exp $
.\"
.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Lennart Augustsson.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 13, 2000
.Dt UFTDI 4
.Os
.Sh NAME
.Nm uftdi
.Nd USB support for serial adapters based on the FT8U100AX
.Sh SYNOPSIS
.Cd "uftdi* at uhub?"
.Cd "ucom* at uftdi?"
.Sh HARDWARE
The
.Nm
driver supports the following adapters:
.Pp
.Bl -tag -width -offset indent -compact
.It Tn XXX
.El
.Sh DESCRIPTION
The
.Nm
driver provides support for various serial adapters based on the FTDI chip
FT8U100AX.
.Pp
The device is accessed through the
.Xr ucom 4
driver which makes it behave like a
.Xr tty 4 .
.Sh SEE ALSO
.Xr tty 4 ,
.Xr ucom 4 ,
.Xr usb 4
.Sh HISTORY
The
.Nm
driver
appeared in
.Nx 1.5 .

View File

@ -1,4 +1,4 @@
.\" $NetBSD: usb.4,v 1.24 2000/03/30 17:53:56 augustss Exp $
.\" $NetBSD: usb.4,v 1.25 2000/04/14 14:55:18 augustss Exp $
.\"
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -123,6 +123,8 @@ driver for CATC USB-EL1201A USB Ethernet.
driver for Kawasaki LSI KL5KUSB101B USB Ethernet.
.It uaudio
driver for audio devices.
.It uftdi
driver for FTDI based serial adapters.
.It ugen
generic driver for
.Tn USB
@ -130,7 +132,7 @@ devices.
.It uhid
generic driver for Human Interface Devices.
.It ukbd
keyboard driver
keyboard driver.
.It ulpt
printer driver.
.It umass
@ -138,9 +140,13 @@ driver for mass storage devices, such as disks.
.It umodem
driver for communication devices that use the Abstract Control Model.
.It ums
mouse driver
mouse driver.
.It upl
driver for
.Tn Prolific
host-to-host adapter.
.It uvisor
Handspring Visor driver
Handspring Visor driver.
.El
.Sh INTRODUCTION TO USB
@ -262,16 +268,24 @@ be filled by information about the device on that address.
Should no such device exist an error is reported.
.Bd -literal
struct usb_device_info {
uByte addr; /* device address */
char product[USB_MAX_STRING_LEN];
char vendor[USB_MAX_STRING_LEN];
char release[8];
uByte class;
uByte config;
uByte lowspeed;
int power;
int nports;
uByte ports[16];
u_int8_t bus;
u_int8_t addr;
usb_event_cookie_t cookie;
char product[USB_MAX_STRING_LEN];
char vendor[USB_MAX_STRING_LEN];
char release[8];
u_int16_t productNo;
u_int16_t vendorNo;
u_int16_t releaseNo;
u_int8_t class;
u_int8_t subclass;
u_int8_t protocol;
u_int8_t config;
u_int8_t lowspeed;
int power;
int nports;
char devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
u_int8_t ports[16];
#define USB_PORT_ENABLED 0xff
#define USB_PORT_SUSPENDED 0xfe
#define USB_PORT_POWERED 0xfd
@ -380,6 +394,7 @@ specifications can be found at
.Xr ulpt 4 ,
.Xr umass 4 ,
.Xr ums 4 ,
.Xr upl 4 ,
.Xr uvisor 4 ,
.Xr usb 3 ,
.Xr usbdevs 8