d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ppc.4 moved from man4 to man4.i386: parallel port chipset driver manpage

Browse Source 
pcf.4 added: Philips I2C/isa interface manpage
This commit is contained in:
Nicolas Souchu 1998-10-28 00:51:40 +00:00
parent 71023a74d1
commit 1284f2b273
5 changed files with 292 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
share/man/man4/Makefile
View File

@ -4,7 +4,7 @@ MAN4= bpf.4 ccd.4 cd.4 ch.4 da.4 ddb.4 divert.4 drum.4 fd.4 fpa.4 \
icmp.4 ifmib.4 iic.4 iicbb.4 iicbus.4 iicsmb.4 \
imm.4 inet.4 intro.4 ip.4 ipfirewall.4 \
lkm.4 lo.4 lpbb.4 natm.4 netintro.4 \
null.4 od.4 pass.4 plip.4 ppbus.4 ppc.4 ppi.4 ppp.4 pt.4 pty.4 \
null.4 od.4 pass.4 plip.4 ppbus.4 ppi.4 ppp.4 pt.4 pty.4 \
route.4 sa.4 scsi.4 \
sd.4 sl.4 smb.4 smbus.4 smp.4 snp.4 sppp.4 ssc.4 st.4 su.4 tcp.4 \
ttcp.4 termios.4 tty.4 tun.4 udp.4 uk.4 update.4 unix.4 vinum.4 vn.4 \

5
share/man/man4/man4.i386/Makefile
View File

@ -1,11 +1,11 @@
# $Id: Makefile,v 1.82 1998/10/16 21:12:07 ken Exp $
# $Id: Makefile,v 1.83 1998/10/16 22:00:55 ken Exp $
MAN4= adv.4 adw.4 aha.4 ahb.4 ahc.4 aic.4 alog.4 apm.4 ar.4 asc.4 bktr.4 \
bt.4 cs.4 cx.4 cy.4 de.4 \
dgb.4 dpt.4 ed.4 eg.4 el.4 en.4 ep.4 ex.4 fdc.4 fe.4 fxp.4 gsc.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 mouse.4 mse.4 mtio.4 nca.4 ncr.4 npx.4 \
pcm.4 pcvt.4 perfmon.4 pnp.4 psm.4 \
ppc.4 pcf.4 pcm.4 pcvt.4 perfmon.4 pnp.4 psm.4 \
sb.4 scd.4 screen.4 sea.4 si.4 sio.4 \
spkr.4 sr.4 sysmouse.4 tl.4 tw.4 tx.4 uha.4 vx.4 \
wd.4 wfd.4 wl.4 wt.4 xl.4 ze.4 zp.4
@ -58,6 +58,7 @@ MLINKS+= nca.4 ../nca.4
MLINKS+= ncr.4 ../ncr.4
MLINKS+= npx.4 ../npx.4
MLINKS+= pcm.4 ../pcm.4
MLINKS+= pcf.4 ../pcf.4
MLINKS+= pcvt.4 vt.4 pcvt.4 ../pcvt.4 pcvt.4 ../vt.4
MLINKS+= perfmon.4 ../perfmon.4
MLINKS+= pnp.4 ../pnp.4

64
share/man/man4/man4.i386/pcf.4 Normal file
View File

@ -0,0 +1,64 @@
.\" Copyright (c) 1998, Nicolas Souchu
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 August 6, 1998
.Dt PCF 4
.Os FreeBSD
.Sh NAME
.Nm pcf
.Nd
Philips I2C bus controller
.Sh SYNOPSIS
.Cd "controller pcf0 at isa? port? irq 5 vector pcfintr"
.Pp
For one or more iicbus busses:
.Cd "controller iicbus0"
.Sh DESCRIPTION
The
.Em pcf
driver provides support to the Philips PCF8584 I2C controller for the
.Xr iicbus 4
system.
.Pp
The PCF8584 is an integrated circuit designed in CMOS technology which serves
as an interface between most standard parallel-bus
microcontrollers/microprocessors and the serial I2C-bus. The PCF8584
provides both master and slave functions. Communication with I2C-bus is
carried out on a byte-wise basis using interrupt or polled handshake. It
controls all the I2C-bus specific sequences, protocol, arbitration and timing.
The PCF8584 allows parallel-bus systems to communicate bidirectionally with
the I2C-bus.
.Pp
.Sh SEE ALSO
.Xr iicbus 4
.Sh HISTORY
The
.Nm
manual page first appeared in
.Fx 3.0 .
.Sh AUTHOR
This
manual page was written by
.An Nicolas Souchu .

112
share/man/man4/man4.i386/ppc.4 Normal file
View File

@ -0,0 +1,112 @@
.\" Copyright (c) 1998, Nicolas Souchu
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 March 5, 1998
.Dt PPC 4
.Os FreeBSD
.Sh NAME
.Nm ppc
.Nd
Parallel port chipset driver
.Sh SYNOPSIS
.Cd "controller ppc0 at isa? port? tty irq 7 vector ppcintr"
.Pp
For one or more PPBUS busses:
.Cd "controller ppbus at ppc0"
.Sh DESCRIPTION
The
.Em ppc
driver provides low level support to various parallel port chipsets for the
.Xr ppbus 4
system.
.Pp
During the probe phasis, ppc detects parallel port chipsets and initialize
private data according to their operating mode: COMPATIBLE,
NIBBLE, PS/2, EPP, ECP and other mixed modes. If a mode is provided at startup
throw the flags variable of the boot interface, the operating mode of the
chipset is forced according to 'flags' and its available modes.
.Pp
During attach phasis, ppc allocates a ppbus structure, initializes it and
calls ppbus attach function.
.Ss Supported flags
.Bl -item -offset indent
.It
bits 0-4: chipset forced mode(s)
.Bd -literal
PPB_COMPATIBLE 0x0 /* Centronics compatible mode */
PPB_NIBBLE 0x1 /* reverse 4 bit mode */
PPB_PS2 0x2 /* PS/2 byte mode */
PPB_EPP 0x4 /* EPP mode, 32 bit */
PPB_ECP 0x8 /* ECP mode */
.Ed
.Pp
And any mixed values.
.It
bit 5: EPP protocol (0 EPP 1.9, 1 EPP 1.7)
.It
bit 6: activate IRQ (1 IRQ disabled, 0 IRQ enabled)
.El
.Ss Supported chipsets
Some parallel port chipsets are explicitly supported by ppc: detection and
initialisation code has been written according to specs datasheets.
.Bl -bullet -offset indent
.It
SMC FDC37C665GT and FDC37C666GT chipsets
.It
Natsemi PC873xx-family (PC87332 and PC87306)
.It
Winbond W83877xx-family (W83877F and W83877AF)
.It
SMC-like chipsets with mixed modes (see
.Xr ppbus 4 )
.El
.Ss Adding support to a new chipset
You may want to add support for the newest chipset your last motherboard was
sold with? For the ISA bus, just retrieve the specs of the chipset and
write the corresponding
.Fn ppc_mychipset_detect ""
function.
Then add an entry to the general purpose
.Fn ppc_detect ""
function.
.Pp
Your
.Fn ppc_mychipset_detect ""
function should ensure that: if the mode field of the
.Va flags
boot variable is not null, then the operating
mode is forced to the given mode and no other mode is available and
ppb->ppb_avm field contains the available modes of the chipset
.Sh SEE ALSO
.Xr ppbus 4
.Sh HISTORY
The
.Nm
manual page first appeared in
.Fx 3.0 .
.Sh AUTHOR
This
manual page was written by
.An Nicolas Souchu .

112
share/man/man4/ppc.4 Normal file
View File

@ -0,0 +1,112 @@
.\" Copyright (c) 1998, Nicolas Souchu
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 March 5, 1998
.Dt PPC 4
.Os FreeBSD
.Sh NAME
.Nm ppc
.Nd
Parallel port chipset driver
.Sh SYNOPSIS
.Cd "controller ppc0 at isa? port? tty irq 7 vector ppcintr"
.Pp
For one or more PPBUS busses:
.Cd "controller ppbus at ppc0"
.Sh DESCRIPTION
The
.Em ppc
driver provides low level support to various parallel port chipsets for the
.Xr ppbus 4
system.
.Pp
During the probe phasis, ppc detects parallel port chipsets and initialize
private data according to their operating mode: COMPATIBLE,
NIBBLE, PS/2, EPP, ECP and other mixed modes. If a mode is provided at startup
throw the flags variable of the boot interface, the operating mode of the
chipset is forced according to 'flags' and its available modes.
.Pp
During attach phasis, ppc allocates a ppbus structure, initializes it and
calls ppbus attach function.
.Ss Supported flags
.Bl -item -offset indent
.It
bits 0-4: chipset forced mode(s)
.Bd -literal
PPB_COMPATIBLE 0x0 /* Centronics compatible mode */
PPB_NIBBLE 0x1 /* reverse 4 bit mode */
PPB_PS2 0x2 /* PS/2 byte mode */
PPB_EPP 0x4 /* EPP mode, 32 bit */
PPB_ECP 0x8 /* ECP mode */
.Ed
.Pp
And any mixed values.
.It
bit 5: EPP protocol (0 EPP 1.9, 1 EPP 1.7)
.It
bit 6: activate IRQ (1 IRQ disabled, 0 IRQ enabled)
.El
.Ss Supported chipsets
Some parallel port chipsets are explicitly supported by ppc: detection and
initialisation code has been written according to specs datasheets.
.Bl -bullet -offset indent
.It
SMC FDC37C665GT and FDC37C666GT chipsets
.It
Natsemi PC873xx-family (PC87332 and PC87306)
.It
Winbond W83877xx-family (W83877F and W83877AF)
.It
SMC-like chipsets with mixed modes (see
.Xr ppbus 4 )
.El
.Ss Adding support to a new chipset
You may want to add support for the newest chipset your last motherboard was
sold with? For the ISA bus, just retrieve the specs of the chipset and
write the corresponding
.Fn ppc_mychipset_detect ""
function.
Then add an entry to the general purpose
.Fn ppc_detect ""
function.
.Pp
Your
.Fn ppc_mychipset_detect ""
function should ensure that: if the mode field of the
.Va flags
boot variable is not null, then the operating
mode is forced to the given mode and no other mode is available and
ppb->ppb_avm field contains the available modes of the chipset
.Sh SEE ALSO
.Xr ppbus 4
.Sh HISTORY
The
.Nm
manual page first appeared in
.Fx 3.0 .
.Sh AUTHOR
This
manual page was written by
.An Nicolas Souchu .