xref: /openbsd-src/share/man/man4/pci.4 (revision 8445c53715e7030056b779e8ab40efb7820981f2)
1.\"	$OpenBSD: pci.4,v 1.44 2001/09/05 09:14:51 deraadt Exp $
2.\"	$NetBSD: pci.4,v 1.29 2000/04/01 00:32:23 tsarna Exp $
3.\"
4.\" Copyright (c) 2000 Theo de Raadt.  All rights reserved.
5.\" Copyright (c) 1997 Jason R. Thorpe.  All rights reserved.
6.\" Copyright (c) 1997 Jonathan Stone
7.\" All rights reserved.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgements:
19.\"      This product includes software developed by Jonathan Stone
20.\" 4. The name of the author may not be used to endorse or promote products
21.\"    derived from this software without specific prior written permission
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33.\"
34.Dd April 3, 2000
35.Dt PCI 4
36.Os
37.Sh NAME
38.Nm pci
39.Nd introduction to PCI bus support
40.Sh SYNOPSIS
41.Cd "pci* at mainbus? bus ?"
42.Cd "pci* at pchb? bus ?"
43.Cd "pci* at ppb? bus ?"
44.Pp
45Other
46.Nm pci
47attachments are machine-dependent and depend on the bus topology and
48.Tn PCI
49bus interface of your system.
50See
51.Xr intro 4
52for your system for details.
53.Sh DESCRIPTION
54The system includes a machine-independent
55.Tn PCI
56bus subsystem and
57several machine-independent
58.Tn PCI
59device drivers.
60.Pp
61Your system may support additional
62.Tn PCI
63devices.
64Drivers for
65.Tn PCI
66devices not listed here are machine-dependent.
67Consult your system's
68.Xr intro 4
69for additional information.
70.Pp
71.Ss Details specific to the i386
72Note that interrupt mappings on the i386 may require that you configure
73your BIOS to reserve sufficient interrupts as "PCI/ISAPnP" so that there
74are sufficient interrupts remaining to configure the discovered PCI
75devices.  For more information, see
76.Xr pcibios 4 .
77.Sh SUPPORTED DEVICES
78The system includes machine-independent
79.Tn PCI
80drivers, sorted by device type and driver name:
81.Ss SCSI host adapters
82.Bl -tag -width 10n -offset ind
83.It Xr adw 4 , Xr adv 4
84AdvanSys PCI
85.Tn SCSI
86interfaces.
87.It Xr ahc 4
88Adaptec 27xx, 29xx, 39xx, 29160, and other AIC-7xxx-based
89.Tn SCSI
90interfaces.
91.It Xr bt 4
92Buslogic BT-9xx
93.Tn SCSI
94interfaces.
95.It Xr isp 4
96QLogic ISP-1020, ISP-1040, and ISP-2100
97.Tn SCSI
98and
99.Tn FibreChannel
100interfaces.
101.It Xr iha 4
102Initio INIC-940 and INIC-950 based
103.Tn SCSI
104interfaces.
105.It Xr ncr 4 , Xr siop 4
106LSI/Symbios Logic/NCR 53c8xx and 53c1010-family
107.Tn SCSI
108interfaces.
109.It Xr pcscp 4
110AMD Am53c974 PCscsi-PCI
111.Tn SCSI
112interfaces.
113.El
114.Ss RAID and cache controllers
115.Bl -tag -width 10n -offset ind
116.It Xr aac 4
117Adaptec "FSA" family (Adaptec AAC, Dell PERC, HP NetRaid)
118.Tn RAID
119controllers.
120.It Xr ami 4
121American Megatrends Inc. MegaRAID family
122.Tn RAID
123controllers.
124.It Xr cac 4
125Compaq Smart ARRAY
126.Tn RAID
127controllers.
128.It Xr dpt 4
129DPT SmartCache/SmartRAID III and IV
130.Tn SCSI
131controllers.
132.It Xr gdt 4
133ICP-Vortex GDT
134.Tn RAID
135controllers.
136.It Xr iop 4
137Generic
138.Tn I2O
139specification
140.Tn RAID
141controllers.
142.It Xr twe 4
1433ware Escalade
144.Tn RAID
145controllers.
146.El
147.Ss Network interfaces
148.Bl -tag -width 10n -offset ind
149.It Xr an 4
150Aironet Communications 4500/4800 IEEE 802.11DS wireless network adapter.
151.It Xr dc 4
152Various Tulip-like Ethernet
153interfaces such as the DEC/Intel 21143;
154Macronix 98713, 98713A, 98715, 98715A, 98725, 98727, and 98732;
155Davicom DM9100, DM9102, and DM9102A;
156ASIX Electronics AX88140A and AX88141;
157ADMtek AL981 Comet and AN983 Centaur-P;
158Lite-On 82c168 and 82c169 PNIC;
159and
160Lite-On/Macronix 82c115 PNIC II.
161.It Xr de 4
162.Tn DEC
163DC21x4x (Tulip) based Ethernet
164interfaces, including the DE435, DE450, DE500;
165Znyx ZX3xx;
166SMC 8432, 9332, 9334;
167Cogent/Adaptec EM100FX and EM440TX;
168and Asante single- and multi-port
169Ethernet interfaces.
170Multi-port interfaces are typically configured as
171.Tn PCI Ns \- Ns Tn PCI
172bridges with multiple
173.Xr de 4
174instances on the
175.Tn PCI
176bus on the other side of the bridge.
177.It Xr en 4
178Midway-based Efficient Networks Inc. and Adaptec ATM interfaces.
179.It Xr ep 4
1803Com 3c590 and 3c595 Ethernet interfaces.
181.It Xr fpa 4
182.Tn DEC
183DEFPA
184.Tn FDDI
185interfaces.
186.It Xr fxp 4
187Intel EtherExpress PRO 10+/100B Ethernet interfaces.
188.It Xr le 4
189PCNet-PCI Ethernet interfaces.
190.It Xr lge 4
191Level 1 LXT1001 NetCellerator PCI Gigabit Ethernet.
192.It Xr lmc 4
193Lan Media Corporation
194.Tn SSI/DS1/HSSI/DS3
195interfaces.
196.It Xr ne 4
197NE2000-compatible Ethernet interfaces.
198.It Xr nge 4
199National Semiconductor DP83820 and DP83821 based Gigabit Ethernet.
200.It Xr rl 4
201RealTek 8129/8139 Ethernet interfaces.
202.It Xr sf 4
203Adaptec AIC-6915 "Starfire" Ethernet interfaces.
204.It Xr sis 4
205SiS 900, SiS 7016, and NS DP83815 Ethernet interfaces.
206.It Xr sk 4
207SysKonnect SK-984x Gigabit Ethernet interfaces.
208.It Xr ste 4
209Sundance Technologies ST201 Ethernet interfaces.
210.It Xr ti 4
211Alteon Networks Tigon I and Tigon II Gigabit Ethernet interfaces.
212.It Xr tl 4
213Texas Instruments ThunderLAN-based Ethernet interfaces.
214.It Xr tx 4
215SMC 9432 10/100 Mbps Ethernet interfaces.
216.It Xr txp 4
2173Com 3XP Typhoon/Sidewinder (3C990) 10/100 Mbps Ethernet interfaces.
218.It Xr vr 4
219VIA Technologies VT3043 and VT86C100A Ethernet interfaces.
220.It Xr wb 4
221Winbond W89C840F Ethernet interfaces.
222.It Xr wx 4
223Intel Gigabit Ethernet interfaces.
224.It Xr xl 4
2253Com 3c555, 3c556, 3c900, 3c905, 3c980, and 3cSOHO Ethernet interfaces.
226.El
227.Ss Cryptography accelerators
228.Bl -tag -width 10n -offset ind
229.It Xr hifn 4
230Hi/fn 7751
231Symmetric Encryption Accelerator.
232.It Xr ubsec 4
233Broadcom Bluesteelnet uBsec 5501, 5601, 5805, and 5820.
234.It Xr ises 4
235Pijnenburg PCC-ISES hardware crypto accelerator.
236.El
237.Ss Serial interfaces
238.Bl -tag -width 10n -offset ind
239.It Xr cy 4
240Cyclades Cyclom-4Y, -8Y, and -16Y asynchronous serial communications devices.
241.El
242.Ss Display adapters
243.Bl -tag -width 10n -offset ind
244.It Xr vga 4
245VGA graphics cards.
246.El
247.Ss Audio devices
248.Bl -tag -width 10n -offset ind
249.It Xr eap 4
250Ensoniq AudioPCI sound devices.
251.It Xr eso 4
252ESS Solo-1 PCI AudioDrive sound devices.
253.It Xr maestro 4
254ESS Maestro 1, 2 and 2E sound devices.
255.It Xr sv 4
256S3 SonicVibes sound devices.
257.It Xr neo 4
258NeoMagic 256AV/ZX sound devices.
259.It Xr fms 4
260Forte Media FM801 sound devices.
261.It Xr auvia 4
262Integrated AC97 audio controller of the VIA Technologies
263VT82C686A Southbridge.
264.It Xr cmpci 4
265C-Media CMI8x38 sound devices.
266.It Xr auich 4
267Intel 82801AA/AB and 440MX sound devices.
268.It Xr clcs 4
269Cirrus Logic CrystalClear CS4280 sound devices.
270.It Xr clct 4
271Cirrus Logic CrystalClear CS4281 sound devices.
272.It Xr yds 4
273Yamaha DS-XG sound devices.
274.El
275.Ss Miscellaneous devices
276.Bl -tag -width 10n -offset ind
277.It Xr bktr 4
278Brooktree Bt848
279.Tn PCI
280video capture boards.
281.It Xr cbb 4
282.Tn PCI
283Yenta compatible
284.Tn CardBus
285bridges.
286.It Xr ohci 4
287USB OHCI host controller.
288.It Xr pcic 4
289.Tn PCI
290.Tn PCMCIA
291controllers, including the Cirrus Logic GD6729.
292.It Xr ppb 4
293Generic
294.Tn PCI Ns \- Ns Tn PCI
295bridges, including
296.Tn PCI
297expansion backplanes.
298.It Xr puc 4
299PCI
300.Dq universal
301communications cards, containing
302.Xr com 4
303and
304.Xr lpt 4
305communications ports.
306.It Xr uhci 4
307USB UHCI host controller.
308.It Xr wdt 4
309ICS PCI-WDT500/501 watchdog timer devices.
310.El
311.Sh IOCTLS
312If the kernel is compiled with the
313.Cd option USER_PCICONF
314kernel option, the following
315.Xr ioctl 2
316calls are supported by the
317.Nm
318driver.  They are defined in the header file
319.Aq Pa sys/pciio.h .
320.Bl -tag -width 012345678901234
321.Pp
322.It PCIOCREAD
323This
324.Xr ioctl 2
325reads the
326.Tn PCI
327configuration registers specified by the passed-in
328.Va pci_io
329structure.  The
330.Va pci_io
331structure consists of the following fields:
332.Bl -tag -width pi_width
333.It pi_sel
334A
335.Va pcisel
336structure which specifies the bus, slot and function the user would like to
337query.
338.It pi_reg
339The
340.Tn PCI
341configuration register the user would like to access.
342.It pi_width
343The width, in bytes, of the data the user would like to read.  This value
344may be either 1, 2, or 4.  3-byte reads and reads larger than 4 bytes are
345not supported.
346.It pi_data
347The data returned by the kernel.
348.El
349.It PCIOCWRITE
350This
351.Xr ioctl 2
352allows users to write to the
353.Tn PCI
354specified in the passed-in
355.Va pci_io
356structure.  The
357.Va pci_io
358structure is described above.  The limitations on data width described for
359reading registers, above, also apply to writing
360.Tn PCI
361configuration registers.
362.El
363.Sh FILES
364.Bl -tag -width /dev/pci -compact
365.It Pa /dev/pci
366Character device for the
367.Nm
368driver.
369.El
370.Sh SEE ALSO
371.Xr cardbus 4 ,
372.Xr intro 4 ,
373.Xr isa 4 ,
374.Xr isapnp 4 ,
375.Xr options 4 ,
376.Xr pchb 4 ,
377.Xr pcmcia 4 ,
378.Xr usb 4
379.Sh HISTORY
380The machine-independent
381.Tn PCI
382subsystem appeared in
383.Ox 2.0 .
384Support for device listing and matching was re-implemented by
385Kenneth Merry, and first appeared in
386.Fx 3.0 .
387