Fix typos and abuses of the markup system.

Submitted by: ru, gshapiro
This commit is contained in:
Warner Losh 2001-08-28 02:51:15 +00:00
parent d93d282620
commit 4323c1b50c
2 changed files with 86 additions and 70 deletions

View File

@ -26,7 +26,7 @@
.\"
.Dd August 25, 2001
.Dt PCIC 4
.Os FreeBSD
.Os
.Sh NAME
.Nm pcic
.Nd pccard bridge driver
@ -36,20 +36,20 @@
.Sh DESCRIPTION
The
.Nm
driver controls the pccard subssytem.
driver controls the pccard subsystem.
The
.Nm
driver supports most
.Tn ExCA
devices attach to either
devices attached to either
.Tn ISA
or
.Tn PCI
bus.
The
.Nm
driver does not support the so called TCIC controllers made by
databook.
driver does not support the so-called TCIC controllers made by
Databook.
Nor does it support the MECIA chipset found in some early PC98
NOTE PC machines.
The mecia driver now supports that bridge.
@ -57,15 +57,16 @@ The mecia driver now supports that bridge.
The following
.Tn ISA
devices, or true clones, are supported in the current code.
.Bl -tag -width "Intel i82365SL Step A" -compact
.Pp
.Bl -tag -width "Intel i82365SL Step A" -compact
.It Intel i82365SL Step A
.It Intel i82365SL Step B
.It Intel i82365SL Step C
.Tn Intel's
.Tn Intel Ns 's
original 16-bit pccard controller.
.It Intel i82365SL-DF
.Tn Intel's last version of this device.
.Tn Intel Ns 's
last version of this device.
3.3V support was added.
.It VLSI 82C146
An older VLSI part with some issues on some machines.
@ -73,28 +74,27 @@ An older VLSI part with some issues on some machines.
.It Cirrus Logic PD-6720
.It Cirrus Logic PD-6722
Cirrus Logic's pcic controller.
Compatible with the i82365sl STEP C with the addition of a different
Compatible with the i82365SL Step C with the addition of a different
3.3V control.
.It Ricoh RF5C296
.It Ricoh RF5C396
Ricoh's pccard bridge chips.
These are compatible with the i82365sl step C, but with yet another
These are compatible with the i82365SL Step C, but with yet another
different 3.3V control.
.It Vadem 365
.It Vadem 465
Compatible with i82365sl step c.
Compatible with i82365SL Step C.
.It Vadem 468
.It Vadem 469
Like the earlier Vadem models, but with Vadem's own, incompatible, 3.3V
control system.
.It IBM PCIC
.Tn IBM
clone of the original i82365sl part, with its own id register value.
clone of the original i82365SL part, with its own ID register value.
Has no 3.3V ability.
.It IBM KING
.Tn IBM
A strange clone of i82365sl.
This part has many restrictions not found in the i82365sl, plus some
A strange clone of i82365SL.
This part has many restrictions not found in the i82365SL, plus some
strange power control.
It has not been tested in ages, but is believed to work.
Its use is believed to be confined to model of ISA card, available
@ -105,8 +105,8 @@ Many other vendors made parts in this arena, but most of them were
compatible with one of the above chipsets.
.Pp
The following PCI cardbus and pcmcia bridges are supported:
.Bl -tag -width "Intel i82365SL Step A" -compact
.Pp
.Bl -tag -width "Intel i82365SL Step A" -compact
.It Cirrus Logic PD6729
.It Cirrus Logic PD6730
These two might be broken at the moment.
@ -147,10 +147,10 @@ have good access to machines with one of these bridges in it.
.Pp
.It Toshiba ToPIC95
.It Toshiba ToPIC97
.It Toshiba ToPIC100
.Sh
.It Toshiba ToPIC100
.El
.Sh FILES
.Bl -tag -width /dev/card0 -compact
.Bl -tag -width ".Pa /dev/card0" -compact
.It Pa /dev/card0
Character device for the
.Nm
@ -170,56 +170,64 @@ them.
PCI interrupt routing is the default for PCI devices.
Some older laptops require ISA interrupt routing to work properly.
To enable ISA interrupt routing, you must set the tunable
hw.pcic.intr_path=1 in /boot/loader.conf.
.Li hw.pcic.intr_path=1
in
.Pa /boot/loader.conf .
For the present, unless you have a one slot machine, you should set
hw.pcic.irq=0 to force polling mode.
.Li hw.pcic.irq=0
to force polling mode.
Two slot machines have minor issues with using an ISA interrupt for the
CSC interrupt.
.Sh TUNABLES
.Bl -tag -width 0123456789 -compact
.It hw.pcic.ignore_function_1
Needed for some, improperly manufacturered pci cards made by orinoco.
.Bl -tag -width indent
.It Va hw.pcic.ignore_function_1
Needed for some, improperly manufactured PCI cards made by Orinoco.
It disables function 1 completely.
Set to 0 to enable function 1.
Set to 1 to disable function 1.
This tunable generally should not be needed on laptops.
The default is 0.
.It hw.pcic.init_routing
.It Va hw.pcic.init_routing
Some machines can tolerate interrupt routing selection at the cardbus
bridge level.
Others fail when you mess with these registers.
Set to 1 to force the chipset to route via parallel pci interrupts (as
Set to 1 to force the chipset to route via parallel PCI interrupts (as
well as a few other little things).
Set to 0, the default, forces the code to leave these registers as the
Setting to 0, the default, forces the code to leave these registers as the
code finds them.
Most laptops will not need to set this tunable.
Many pci cards with cardbus chips on them are believed to need this
Many PCI cards with cardbus chips on them are believed to need this
tunable set to 1.
The default is 0.
.It hw.pcic.intr_path
Should pci pcic devices route interrupts via ISA or PCI.
.It Va hw.pcic.intr_path
Should PCI pcic devices route interrupts via ISA or PCI.
A value of 1 means route via ISA.
A value of 2 means route via PCI.
This is ignored for the ISA device.
Many older laptops do not have PCI BIOS implementaitons that
Many older laptops do not have PCI BIOS implementations that
.Fx
can use to route interrupts properly.
These laptops may need to set this to 1 and hw.pcic.irq to a value
These laptops may need to set this to 1 and
.Va hw.pcic.irq
to a value
(or 0 for polling).
The default is 2.
.It hw.pcic.irq
.It Va hw.pcic.irq
Overrides the IRQ to use for ISA interrupt routing of the CSC or
management interrupt.
If you are using the ISA device, you can set this tunable, or use the
irq N clause in config file.
.Cd "irq N"
clause in config file.
If you are using a PCI device in ISA interrupt mode (see
hw.pcic.intr_path), then you must set the interrupt with this
.Va hw.pcic.intr_path ) ,
then you must set the interrupt with this
sysctl, or polling mode will be used.
Due to limitations in the tunable system, only one interrupt can be selected
for all cards.
Systems with multiple PCI bridges that need to use ISA routing are encouraged
to use polling mode on each of the cards.
The default is 0.
.El
.Sh HISTORY
Too long to detail in the man page.
.Sh BUGS

View File

@ -26,7 +26,7 @@
.\"
.Dd August 25, 2001
.Dt PCIC 4
.Os FreeBSD
.Os
.Sh NAME
.Nm pcic
.Nd pccard bridge driver
@ -36,20 +36,20 @@
.Sh DESCRIPTION
The
.Nm
driver controls the pccard subssytem.
driver controls the pccard subsystem.
The
.Nm
driver supports most
.Tn ExCA
devices attach to either
devices attached to either
.Tn ISA
or
.Tn PCI
bus.
The
.Nm
driver does not support the so called TCIC controllers made by
databook.
driver does not support the so-called TCIC controllers made by
Databook.
Nor does it support the MECIA chipset found in some early PC98
NOTE PC machines.
The mecia driver now supports that bridge.
@ -57,15 +57,16 @@ The mecia driver now supports that bridge.
The following
.Tn ISA
devices, or true clones, are supported in the current code.
.Bl -tag -width "Intel i82365SL Step A" -compact
.Pp
.Bl -tag -width "Intel i82365SL Step A" -compact
.It Intel i82365SL Step A
.It Intel i82365SL Step B
.It Intel i82365SL Step C
.Tn Intel's
.Tn Intel Ns 's
original 16-bit pccard controller.
.It Intel i82365SL-DF
.Tn Intel's last version of this device.
.Tn Intel Ns 's
last version of this device.
3.3V support was added.
.It VLSI 82C146
An older VLSI part with some issues on some machines.
@ -73,28 +74,27 @@ An older VLSI part with some issues on some machines.
.It Cirrus Logic PD-6720
.It Cirrus Logic PD-6722
Cirrus Logic's pcic controller.
Compatible with the i82365sl STEP C with the addition of a different
Compatible with the i82365SL Step C with the addition of a different
3.3V control.
.It Ricoh RF5C296
.It Ricoh RF5C396
Ricoh's pccard bridge chips.
These are compatible with the i82365sl step C, but with yet another
These are compatible with the i82365SL Step C, but with yet another
different 3.3V control.
.It Vadem 365
.It Vadem 465
Compatible with i82365sl step c.
Compatible with i82365SL Step C.
.It Vadem 468
.It Vadem 469
Like the earlier Vadem models, but with Vadem's own, incompatible, 3.3V
control system.
.It IBM PCIC
.Tn IBM
clone of the original i82365sl part, with its own id register value.
clone of the original i82365SL part, with its own ID register value.
Has no 3.3V ability.
.It IBM KING
.Tn IBM
A strange clone of i82365sl.
This part has many restrictions not found in the i82365sl, plus some
A strange clone of i82365SL.
This part has many restrictions not found in the i82365SL, plus some
strange power control.
It has not been tested in ages, but is believed to work.
Its use is believed to be confined to model of ISA card, available
@ -105,8 +105,8 @@ Many other vendors made parts in this arena, but most of them were
compatible with one of the above chipsets.
.Pp
The following PCI cardbus and pcmcia bridges are supported:
.Bl -tag -width "Intel i82365SL Step A" -compact
.Pp
.Bl -tag -width "Intel i82365SL Step A" -compact
.It Cirrus Logic PD6729
.It Cirrus Logic PD6730
These two might be broken at the moment.
@ -147,10 +147,10 @@ have good access to machines with one of these bridges in it.
.Pp
.It Toshiba ToPIC95
.It Toshiba ToPIC97
.It Toshiba ToPIC100
.Sh
.It Toshiba ToPIC100
.El
.Sh FILES
.Bl -tag -width /dev/card0 -compact
.Bl -tag -width ".Pa /dev/card0" -compact
.It Pa /dev/card0
Character device for the
.Nm
@ -170,56 +170,64 @@ them.
PCI interrupt routing is the default for PCI devices.
Some older laptops require ISA interrupt routing to work properly.
To enable ISA interrupt routing, you must set the tunable
hw.pcic.intr_path=1 in /boot/loader.conf.
.Li hw.pcic.intr_path=1
in
.Pa /boot/loader.conf .
For the present, unless you have a one slot machine, you should set
hw.pcic.irq=0 to force polling mode.
.Li hw.pcic.irq=0
to force polling mode.
Two slot machines have minor issues with using an ISA interrupt for the
CSC interrupt.
.Sh TUNABLES
.Bl -tag -width 0123456789 -compact
.It hw.pcic.ignore_function_1
Needed for some, improperly manufacturered pci cards made by orinoco.
.Bl -tag -width indent
.It Va hw.pcic.ignore_function_1
Needed for some, improperly manufactured PCI cards made by Orinoco.
It disables function 1 completely.
Set to 0 to enable function 1.
Set to 1 to disable function 1.
This tunable generally should not be needed on laptops.
The default is 0.
.It hw.pcic.init_routing
.It Va hw.pcic.init_routing
Some machines can tolerate interrupt routing selection at the cardbus
bridge level.
Others fail when you mess with these registers.
Set to 1 to force the chipset to route via parallel pci interrupts (as
Set to 1 to force the chipset to route via parallel PCI interrupts (as
well as a few other little things).
Set to 0, the default, forces the code to leave these registers as the
Setting to 0, the default, forces the code to leave these registers as the
code finds them.
Most laptops will not need to set this tunable.
Many pci cards with cardbus chips on them are believed to need this
Many PCI cards with cardbus chips on them are believed to need this
tunable set to 1.
The default is 0.
.It hw.pcic.intr_path
Should pci pcic devices route interrupts via ISA or PCI.
.It Va hw.pcic.intr_path
Should PCI pcic devices route interrupts via ISA or PCI.
A value of 1 means route via ISA.
A value of 2 means route via PCI.
This is ignored for the ISA device.
Many older laptops do not have PCI BIOS implementaitons that
Many older laptops do not have PCI BIOS implementations that
.Fx
can use to route interrupts properly.
These laptops may need to set this to 1 and hw.pcic.irq to a value
These laptops may need to set this to 1 and
.Va hw.pcic.irq
to a value
(or 0 for polling).
The default is 2.
.It hw.pcic.irq
.It Va hw.pcic.irq
Overrides the IRQ to use for ISA interrupt routing of the CSC or
management interrupt.
If you are using the ISA device, you can set this tunable, or use the
irq N clause in config file.
.Cd "irq N"
clause in config file.
If you are using a PCI device in ISA interrupt mode (see
hw.pcic.intr_path), then you must set the interrupt with this
.Va hw.pcic.intr_path ) ,
then you must set the interrupt with this
sysctl, or polling mode will be used.
Due to limitations in the tunable system, only one interrupt can be selected
for all cards.
Systems with multiple PCI bridges that need to use ISA routing are encouraged
to use polling mode on each of the cards.
The default is 0.
.El
.Sh HISTORY
Too long to detail in the man page.
.Sh BUGS