mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-15 10:17:20 +00:00
add the man page for pnp... also add activate it in the makefile
This commit is contained in:
John-Mark Gurney
parent
1ccbcf70f7
commit
27495372d1
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=29245
@ -1,9 +1,9 @@
|
||||
# $Id: Makefile,v 1.64 1997/05/23 12:07:33 peter Exp $
|
||||
# $Id: Makefile,v 1.65 1997/08/10 08:09:00 joerg Exp $
|
||||
|
||||
MAN4= aha.4 ahb.4 ahc.4 aic.4 apm.4 ar.4 asc.4 bt.4 cx.4 cy.4 de.4 dgb.4 \
|
||||
ed.4 eg.4 el.4 ep.4 ex.4 gsc.4 fdc.4 fe.4 fxp.4 ie.4 io.4 \
|
||||
joy.4 keyboard.4 labpc.4 le.4 lnc.4 lp.4 lpt.4 matcd.4 mcd.4 mem.4 \
|
||||
meteor.4 mse.4 mtio.4 nca.4 ncr.4 npx.4 pcvt.4 perfmon.4 psm.4 \
|
||||
meteor.4 mse.4 mtio.4 nca.4 ncr.4 npx.4 pcvt.4 perfmon.4 pnp.4 psm.4 \
|
||||
qcam.4 scd.4 screen.4 sb.4 sea.4 si.4 sio.4 \
|
||||
spkr.4 sr.4 sysmouse.4 tw.4 uha.4 vx.4 wd.4 wl.4 wt.4 ze.4 zp.4
|
||||
|
||||
@ -48,6 +48,7 @@ MLINKS+= ncr.4 ../ncr.4
|
||||
MLINKS+= npx.4 ../npx.4
|
||||
MLINKS+= pcvt.4 vt.4 pcvt.4 ../pcvt.4 pcvt.4 ../vt.4
|
||||
MLINKS+= perfmon.4 ../perfmon.4
|
||||
MLINKS+= pnp.4 ../pnp.4
|
||||
MLINKS+= psm.4 ../psm.4
|
||||
MLINKS+= qcam.4 ../qcam.4
|
||||
MLINKS+= sb.4 ../sb.4
|
||||
|
||||
179
share/man/man4/man4.i386/pnp.4
Normal file
179
share/man/man4/man4.i386/pnp.4
Normal file
@ -0,0 +1,179 @@
|
||||
.\" pnp(4) - manual page for the scanner device driver `asc'
|
||||
.\"
|
||||
.\"
|
||||
.\" Copyright (c) 1997 Luigi Rizzo
|
||||
.\"
|
||||
.\" 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 acknowledgements:
|
||||
.\" This product includes software developed by Luigi Rizzo.
|
||||
.\" 4. The name of the author may not be used to endorse or promote products
|
||||
.\" derived from this software without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
|
||||
.\"
|
||||
.\" $Id$
|
||||
.\"
|
||||
.Dd September 7, 1997
|
||||
.Dt PNP 4 i386
|
||||
.Os FreeBSD
|
||||
.Sh NAME
|
||||
.Nm pnp
|
||||
.Nd support for PnP devices
|
||||
.Sh SYNOPSIS
|
||||
.Cd controller pnp0
|
||||
.Sh DESCRIPTION
|
||||
Support for PnP devices in FreeBSD allows the user to override the
|
||||
configuration of PnP cards, and device drivers to fetch/modify
|
||||
parameters in the card's configuration space.
|
||||
.Pp
|
||||
The manual override mechanism requires the kernel to be compiled with
|
||||
.Cd options USERCONFIG.
|
||||
In this case, the kernel keeps a table of fixed size (20 entries as a
|
||||
default) where configuration data are held for PnP devices. Each
|
||||
PnP card can contain several independent devices (5 or 6 is not
|
||||
unusual).
|
||||
.Pp
|
||||
By booting the kernel with the
|
||||
.Dq Fl c
|
||||
flag, commands are available to
|
||||
modify the configuration of PnP cards. Commands start with the
|
||||
sequence:
|
||||
.Dl pnp CSN LDN
|
||||
where CSN and LDN are the Card Select Number and Logical Device Number
|
||||
associated to the device. Following this sequence any combination of
|
||||
the following commands can be used:
|
||||
|
||||
.Bl -tag -width "mmmmmmmmmm""
|
||||
.It Dv irqN line
|
||||
Sets the irq line for interrupt 0 or 1 on the card. Line=0 means the line
|
||||
is unused.
|
||||
.It Dv drqN n
|
||||
Sets the drq channel used for DMA 0 or 1 on the card. Channel=4 means
|
||||
the channel is unused.
|
||||
.It Dv portN address
|
||||
Sets the base address for the N-th port's range (N=0..7). address=0
|
||||
means that the port is not used.
|
||||
.It Dv memN address
|
||||
Sets the base address for the N-th memory's range (N=0..3). address=0
|
||||
means that the memory range is not used.
|
||||
.It Dv bios
|
||||
Makes the PnP device use the configuration set by the BIOS. This
|
||||
is the default, and is generally ok if your BIOS has PnP support.
|
||||
If BIOS is used, then other parameters are ignored except "flags".
|
||||
.It Dv os
|
||||
Makes the PnP device to use the configuration specified in this entry.
|
||||
.It Dv enable
|
||||
Enables the PnP device.
|
||||
.It Dv disable
|
||||
Disables the PnP device.
|
||||
.It Dv delete
|
||||
Frees the entry used for the device, so that it can be used for
|
||||
another device with a different CSN/LDN pair.
|
||||
.It Dv flags
|
||||
Sets the value of a 32-bit flags entry which is passed to the device
|
||||
driver. This can be used to set special operation modes (e.g. SB vs. WSS
|
||||
emulation on some sound cards, etc.).
|
||||
.El
|
||||
.Pp
|
||||
The current content of the table can be printed using the
|
||||
.Ic ls
|
||||
command in userconfig. In addition to modifications done by the user,
|
||||
the table contains an entry for
|
||||
all logical devices accessed by a PnP device driver.
|
||||
.Pp
|
||||
Modifications to
|
||||
the table will be saved to the boot image on the filesystem by the
|
||||
.Xr dset 8
|
||||
command.
|
||||
.Pp
|
||||
.Sh DEVICE DRIVER SUPPORT FOR PnP
|
||||
PnP devices are automatically recognized and configured by the kernel.
|
||||
A PnP device is identified by the following data structure:
|
||||
.Bd -literal
|
||||
struct pnp_device {
|
||||
char *pd_name;
|
||||
char *(*pd_probe ) (u_long csn, u_long vendor_id);
|
||||
void (*pd_attach ) (u_long csn, u_long vend_id, char * name,
|
||||
struct isa_device *dev);
|
||||
u_long *pd_count;
|
||||
u_int *imask;
|
||||
struct isa_device dev;
|
||||
};
|
||||
.Ed
|
||||
.Pp
|
||||
The probe routine must check that the vendor_id passed is a
|
||||
recognized one, that any necessary devices on the card are enabled,
|
||||
and returns a NULL value in case of failure or a non-NULL value
|
||||
(generally a pointer to the device name) unpon success. In the probe
|
||||
routine, the function
|
||||
.Fn read_pnp_parms
|
||||
can be used to check that the logical devices are enabled.
|
||||
.Pp
|
||||
The attach routine should do all the necessary initialization, enable
|
||||
the PnP card to ISA accesses, fetch the configuration, and call the ISA
|
||||
driver for the device.
|
||||
.Pp
|
||||
The following routines and data structures can be used:
|
||||
.Bl -tag -width "xxxxxxxxxx"
|
||||
.It Dv struct pnp_cinfo
|
||||
This data structure (defined in /sys/i386/isa/pnp.h) contains all
|
||||
informations related to a PnP logical device.
|
||||
.It Fn read_pnp_parms "struct pnp_cinfo *d" "int ldn"
|
||||
This function returns the configuration of the requested
|
||||
logical device. It is not possible to specify a CSN since this function
|
||||
is only meant to be used during probe and attach routines
|
||||
.It Fn write_pnp_parms "struct pnp_cinfo *d" "int ldn"
|
||||
This function sets the parameters of the requested logical device. At
|
||||
the same time, it updates the entry in the kernel override table.
|
||||
Device drivers in general should
|
||||
.Em not
|
||||
modify the configuration of a device, since either the BIOS or the user
|
||||
(through userconfig) should know better what to do. In particular,
|
||||
device driver
|
||||
.Em should not enable
|
||||
a logical device which has
|
||||
been found disabled,
|
||||
since this would defeat the override mechanism in userconfig.
|
||||
Device
|
||||
drivers may disable a logical device, or a port range, etc, but should
|
||||
do so only that particular device or parameter is known to cause
|
||||
troubles.
|
||||
.It Fn enable_pnp_card void
|
||||
This function
|
||||
.Em must
|
||||
be used in the attach routine
|
||||
.Em only ,
|
||||
before accessing the card's ISA ports/memory address ranges.
|
||||
.El
|
||||
.Pp
|
||||
.Sh SEE ALSO
|
||||
.Xr dset 8
|
||||
.Sh BUGS
|
||||
There is no support for visual configuration of PnP devices.
|
||||
It would be nice to have commands in userconfig to fetch the
|
||||
configuration of PnP devices.
|
||||
.Sh AUTHOR
|
||||
PnP support was written by Luigi Rizzo, based on initial work done by
|
||||
Sujal Patel.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
driver first appeared in
|
||||
.Fx 2.2.5 .
|
||||
Loading…
Reference in New Issue
Block a user