Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add elanpar(4) and elanpex(4) manual pages. Cross-reference from 

elansc(4).  Updates to the Makefile and the distribution set lists
are coming.
This commit is contained in:
dyoung 2008-01-21 08:07:20 +00:00
parent 42bde7e9fa
commit 88b0f67d74
3 changed files with 211 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
share/man/man4/man4.i386/elanpar.4 Normal file
View File

@ -0,0 +1,102 @@
.\" $NetBSD: elanpar.4,v 1.1 2008/01/21 08:07:20 dyoung Exp $
.\"
.\"
.\" Copyright (c) 2008 David Young. All rights reserved.
.\"
.\" Written by David Young.
.\"
.\" 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. David Young's name may not be used to endorse or promote
.\" products derived from this software without specific prior
.\" written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``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 DAVID
.\" YOUNG 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 January 10, 2008
.Dt elanpar 4 i386
.Os
.Sh NAME
.Nm elanpar
.Nd AMD Elan SC520 Programmable Address Regions
.Sh SYNOPSIS
.Cd "elansc* at pci? dev ? function ?"
.Cd "elanpar* at elansc?"
.Sh DESCRIPTION
The
.Nm
driver supports the write-protect feature of the AMD
Elan SC520 microcontroller's integrated Programmable Address Regions.
Currently,
.Nm
protects the kernel text from being overwritten by the CPU or errant DMA.
.Sh DIAGNOSTICS
.Bl -diag
.It elanpar0: cpu violated write-protect window %u
.It elanpar0: gp violated write-protect window %u
.It elanpar0: pci violated write-protect window %u
.El
.Pp
A Programmable Address Region stopped
either the CPU, the general-purpose bus
.Pq gp ,
or a PCI bus master from writing to the indicated window of
write-protected memory.
.Bl -diag
.It elanpar0: %u bytes of kernel text are unprotected
.El
.Pp
.Nm
has not write-protected
.Em %u
bytes of the kernel text.
.Sh SEE ALSO
.Xr dmesg 8 ,
.Xr elanopt 4 ,
.Xr elanpex 4 ,
.Xr elansc 4 ,
.Xr syslogd 8 .
.Sh BUGS
.Pp
.Nm
leaves as many as 65535 bytes unprotected at the beginning and
end of kernel text.
Also,
.Nm
is not compatible with setting breakpoints
using
.Xr ddb 4 .
Disable
.Nm
using
.Ic drvctl Fl d Ar elanpar0
before setting a breakpoint with
.Xr ddb 4 .
.Sh HISTORY
The
.Nm
device first appeared in
.Nx 5.0 .
.Sh AUTHORS
The
.Nm
driver was written by
.An David Young Aq dyoung@NetBSD.org .

105
share/man/man4/man4.i386/elanpex.4 Normal file
View File

@ -0,0 +1,105 @@
.\" $NetBSD: elanpex.4,v 1.1 2008/01/21 08:07:20 dyoung Exp $
.\"
.\"
.\" Copyright (c) 2008 David Young. All rights reserved.
.\"
.\" Written by David Young.
.\"
.\" 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. David Young's name may not be used to endorse or promote
.\" products derived from this software without specific prior
.\" written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``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 DAVID
.\" YOUNG 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 January 10, 2008
.Dt elanpex 4 i386
.Os
.Sh NAME
.Nm elanpex
.Nd AMD Elan SC520 PCI Exception Instrumentation
.Sh SYNOPSIS
.Cd "elansc* at pci? dev ? function ?"
.Cd "elanpex* at elansc?"
.Sh DESCRIPTION
The
.Nm
driver supports the PCI exception-reporting facilities of the AMD
Elan SC520 microcontroller's integrated PCI host controller.
.Sh DIAGNOSTICS
.Bl -ohang
.It Em PCI master exceptions
.Pp
The host controller may originate a transaction of type
.Em %s
on bus address
.Em %x
that fails for the following reasons:
.Bl -diag
.It elanpex0: %s %x master retry timeout
.It elanpex0: %s %x master target abort
.It elanpex0: %s %x master abort
.It elanpex0: %s %x master system error
.It elanpex0: %s %x master received parity error
.It elanpex0: %s %x master detected parity error
.El
.Pp
Transaction types include
.Bl -diag
.It i/o read
.It i/o write
.It memory rd
.It memory wr
.It cfg rd
.It cfg wr
.El
.It Em PCI target exceptions
.Pp
The host controller may be the target of a failed transaction of type
.Em %s
at bus address
.Em %x .
Failures may occur for the following reasons:
.Bl -diag
.It elanpex0: %s %x target delayed txn timeout
.It elanpex0: %s %x target address parity
.It elanpex0: %s %x target data parity
.El
.Pp
Transaction types are alike to failed master exceptions.
.El
.Sh SEE ALSO
.Xr dmesg 8 ,
.Xr elanopt 4 ,
.Xr elanpar 4 ,
.Xr elansc 4 ,
.Xr syslogd 8 .
.Sh HISTORY
The
.Nm
device first appeared in
.Nx 5.0 .
.Sh AUTHORS
The
.Nm
driver was written by
.An David Young Aq dyoung@NetBSD.org .

5
share/man/man4/man4.i386/elansc.4
View File

@ -1,4 +1,4 @@
.\" $NetBSD: elansc.4,v 1.6 2005/10/10 20:57:43 wiz Exp $
.\" $NetBSD: elansc.4,v 1.7 2008/01/21 08:07:20 dyoung Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
@ -79,6 +79,9 @@ The
program allows easy manipulation of pins from userland.
.El
.Sh SEE ALSO
.Xr elanopt 4 ,
.Xr elanpar 4 ,
.Xr elanpex 4 ,
.Xr gpio 4 ,
.Xr gpioctl 8 ,
.Xr wdogctl 8