freebsd-skq/share/man/man4/en.4

.\" $FreeBSD$
.\"
.Dd July 16, 2005
.Dt EN 4
.Os
.Sh NAME
.Nm en
.Nd "device driver for Midway-based ATM interfaces"
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device en"
.Cd "device atm"
.Cd "device utopia"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
if_en_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
device driver supports Midway-based ATM interfaces including the
Efficient Networks, Inc.\& ENI-155 and Adaptec ANA-59x0.
Midway is an AAL5 SAR (Segmentation and Reassembly) chip.
.Pp
For configuring the card for IP see
.Xr natmip 4 .
.Pp
The following sysctls are recognized by the driver additionally to those
handled by
.Xr utopia 4 :
.Bl -tag -width indent
.It Va hw.atm.enX.istats
Contains an array of
.Vt uint32_t
with internal driver statistics.
.It Va hw.atm.enX.debug
This is a bit map of debugging options.
This variable is only available when the driver is compiled with debugging
support.
.El
.Pp
The driver supports the media options
.Cm sdh ,
.Cm noscramb
and
.Cm unassigned
(see
.Xr utopia 4 ) .
.Sh DIAGNOSTICS
.Bd -literal
en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16
en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM
en0: maximum DMA burst length = 64 bytes
en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated
.Ed
.Sh SEE ALSO
.Xr natm 4 ,
.Xr natmip 4 ,
.Xr utopia 4 ,
.Xr ifconfig 8 ,
.Xr route 8
.Sh AUTHORS
.An Chuck Cranor
of Washington University implemented
.Nm
driver in 1996 for
.Nx .
.Sh CAVEATS
The driver extensively uses DMA on PCI.
The first
generation PCI chipsets do not work or exhibit poor performance.
Add $FreeBSD$ lines to man pages that are missing them to make it easier for translation teams. PR: docs/13418 Submitted by: Alexey Zelkin <phantom@cris.net> 1999-08-28 23:23:38 +00:00			`.\" $FreeBSD$`
			`.\"`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Dd July 16, 2005`
The midway driver has been busdmaified and is not i386-specific anymore. Repo-copy it from the i386 specific man4 section to the common one. Remove the i386 keyword from the man page header. Document the sysctl interface to the driver. Fix a spelling error (ALL -> AAL). 2003-06-03 07:58:39 +00:00			`.Dt EN 4`
mdoc(7) police: eliminate warnings. 2000-11-17 15:40:57 +00:00			`.Os`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Sh NAME`
			`.Nm en`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Nd "device driver for Midway-based ATM interfaces"`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Sh SYNOPSIS`
Work around an apparent mdoc(7) bug. Spotted by: marius Discussed with: ru 2005-10-07 02:32:16 +00:00			`To compile this driver into the kernel,`
			`place the following lines in your`
Break long lines and kill a few instances of EOL whitespace. Noticed by: ru 2005-07-21 05:02:39 +00:00			`kernel configuration file:`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Bd -ragged -offset indent`
Third round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 17:00:18 +00:00			`.Cd "device en"`
pseudo-device -> device in kernel config lines. Removed whitespace at EOL. Reviewed by: joerg, dd 2001-05-01 09:15:30 +00:00			`.Cd "device atm"`
Make the midway driver use the new ATM phy driver. This allows one to toggle several media options (sonet/sdh, for example) with ifconfig and to see the carrier state in ifconfig's output. It gives also read/write access (given the right privilegs) to the S/Uni registers to user space programs. 2003-06-13 12:08:09 +00:00			`.Cd "device utopia"`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Ed`
			`.Pp`
Work around an apparent mdoc(7) bug. Spotted by: marius Discussed with: ru 2005-10-07 02:32:16 +00:00			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer 2005-07-19 00:26:30 +00:00			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
			`if_en_load="YES"`
			`.Ed`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Sh DESCRIPTION`
pseudo-device -> device in kernel config lines. Removed whitespace at EOL. Reviewed by: joerg, dd 2001-05-01 09:15:30 +00:00			`The`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Nm`
			`device driver supports Midway-based ATM interfaces including the`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`Efficient Networks, Inc.\& ENI-155 and Adaptec ANA-59x0.`
The midway driver has been busdmaified and is not i386-specific anymore. Repo-copy it from the i386 specific man4 section to the common one. Remove the i386 keyword from the man page header. Document the sysctl interface to the driver. Fix a spelling error (ALL -> AAL). 2003-06-03 07:58:39 +00:00			`Midway is an AAL5 SAR (Segmentation and Reassembly) chip.`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Pp`
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script. 2003-06-13 12:33:33 +00:00			`For configuring the card for IP see`
Reference the new natmip(4) man page. 2003-06-16 15:51:55 +00:00			`.Xr natmip 4 .`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Pp`
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script. 2003-06-13 12:33:33 +00:00			`The following sysctls are recognized by the driver additionally to those`
			`handled by`
Make the midway driver use the new ATM phy driver. This allows one to toggle several media options (sonet/sdh, for example) with ifconfig and to see the carrier state in ifconfig's output. It gives also read/write access (given the right privilegs) to the S/Uni registers to user space programs. 2003-06-13 12:08:09 +00:00			`.Xr utopia 4 :`
Assorted markup, spelling, and grammar fixes. 2004-06-17 19:51:17 +00:00			`.Bl -tag -width indent`
			`.It Va hw.atm.enX.istats`
The midway driver has been busdmaified and is not i386-specific anymore. Repo-copy it from the i386 specific man4 section to the common one. Remove the i386 keyword from the man page header. Document the sysctl interface to the driver. Fix a spelling error (ALL -> AAL). 2003-06-03 07:58:39 +00:00			`Contains an array of`
			`.Vt uint32_t`
			`with internal driver statistics.`
Assorted markup, spelling, and grammar fixes. 2004-06-17 19:51:17 +00:00			`.It Va hw.atm.enX.debug`
The midway driver has been busdmaified and is not i386-specific anymore. Repo-copy it from the i386 specific man4 section to the common one. Remove the i386 keyword from the man page header. Document the sysctl interface to the driver. Fix a spelling error (ALL -> AAL). 2003-06-03 07:58:39 +00:00			`This is a bit map of debugging options.`
			`This variable is only available when the driver is compiled with debugging`
			`support.`
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script. 2003-06-13 12:33:33 +00:00			`.El`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Pp`
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script. 2003-06-13 12:33:33 +00:00			`The driver supports the media options`
Assorted markup, spelling, and grammar fixes. 2004-06-17 19:51:17 +00:00			`.Cm sdh ,`
			`.Cm noscramb`
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script. 2003-06-13 12:33:33 +00:00			`and`
Assorted markup, spelling, and grammar fixes. 2004-06-17 19:51:17 +00:00			`.Cm unassigned`
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script. 2003-06-13 12:33:33 +00:00			`(see`
Assorted markup, spelling, and grammar fixes. 2004-06-17 19:51:17 +00:00			`.Xr utopia 4 ) .`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Sh DIAGNOSTICS`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Bd -literal`
			`en0 <Efficient Networks ENI-155p> rev 0 int a irq 5 on pci0:16`
			`en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM`
			`en0: maximum DMA burst length = 64 bytes`
			`en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated`
			`.Ed`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Sh SEE ALSO`
Factor out the description of how to configure a CLIP into its own man page. This will be more scaleable as more driver man pages hit the tree. Add also a description on how to do this configuration in the rc.conf script. 2003-06-13 12:33:33 +00:00			`.Xr natm 4 ,`
			`.Xr natmip 4 ,`
Make the midway driver use the new ATM phy driver. This allows one to toggle several media options (sonet/sdh, for example) with ifconfig and to see the carrier state in ifconfig's output. It gives also read/write access (given the right privilegs) to the S/Uni registers to user space programs. 2003-06-13 12:08:09 +00:00			`.Xr utopia 4 ,`
pseudo-device -> device in kernel config lines. Removed whitespace at EOL. Reviewed by: joerg, dd 2001-05-01 09:15:30 +00:00			`.Xr ifconfig 8 ,`
Sort cross references. 1998-08-31 16:41:09 +00:00			`.Xr route 8`
add en ATM driver manual. 1998-07-29 05:42:20 +00:00			`.Sh AUTHORS`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.An Chuck Cranor`
Assorted markup, spelling, and grammar fixes. 2004-06-17 19:51:17 +00:00			`of Washington University implemented`
			`.Nm`
			`driver in 1996 for`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Nx .`
mdoc: move CAVEATS, BUGS and SECURITY CONSIDERATIONS sections to the bottom of the manpages and order them consistently. GNU groff doesn't care about the ordering, and doesn't even mention CAVEATS and SECURITY CONSIDERATIONS as common sections and where to put them. Found by: mdocml lint run Reviewed by: ru 2010-05-13 12:07:55 +00:00			`.Sh CAVEATS`
			`The driver extensively uses DMA on PCI.`
			`The first`
			`generation PCI chipsets do not work or exhibit poor performance.`