xref: /openbsd-src/share/man/man4/pci.4 (revision 3a3fbb3f2e2521ab7c4a56b7ff7462ebd9095ec5)
1.\"	$OpenBSD: pci.4,v 1.55 2001/12/07 11:27:07 mickey 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
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.Ss Details specific to the i386
71Note that interrupt mappings on the i386 may require that you configure
72your BIOS to reserve sufficient interrupts as "PCI/ISAPnP" so that there
73are sufficient interrupts remaining to configure the discovered PCI
74devices.
75For 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.
122MegaRAID family
123.Tn RAID
124controllers.
125.It Xr cac 4
126Compaq Smart ARRAY
127.Tn RAID
128controllers.
129.It Xr dpt 4
130DPT SmartCache/SmartRAID III and IV
131.Tn SCSI
132controllers.
133.It Xr gdt 4
134ICP-Vortex GDT
135.Tn RAID
136controllers.
137.It Xr iop 4
138Generic
139.Tn I2O
140specification
141.Tn RAID
142controllers.
143.It Xr twe 4
1443ware Escalade
145.Tn RAID
146controllers.
147.El
148.Ss Network interfaces
149.Bl -tag -width 10n -offset ind
150.It Xr an 4
151Aironet Communications 4500/4800 IEEE 802.11DS wireless network adapter.
152.It Xr bge 4
153Broadcom BCM570x PCI gigabit ethernet.
154.It Xr dc 4
155Various Tulip-like Ethernet
156interfaces such as the DEC/Intel 21143;
157Macronix 98713, 98713A, 98715, 98715A, 98725, 98727, and 98732;
158Davicom DM9100, DM9102, and DM9102A;
159ASIX Electronics AX88140A and AX88141;
160ADMtek AL981 Comet and AN983 Centaur-P;
161Lite-On 82c168 and 82c169 PNIC;
162and
163Lite-On/Macronix 82c115 PNIC II.
164.It Xr de 4
165.Tn DEC
166DC21x4x (Tulip) based Ethernet
167interfaces, including the DE435, DE450, DE500;
168Znyx ZX3xx;
169SMC 8432, 9332, 9334;
170Cogent/Adaptec EM100FX and EM440TX;
171and Asante single- and multi-port
172Ethernet interfaces.
173Multi-port interfaces are typically configured as
174.Tn PCI Ns \- Ns Tn PCI
175bridges with multiple
176.Xr de 4
177instances on the
178.Tn PCI
179bus on the other side of the bridge.
180.It Xr en 4
181Midway-based Efficient Networks Inc.
182and Adaptec ATM interfaces.
183.It Xr ep 4
1843Com 3c590 and 3c595 Ethernet interfaces.
185.It Xr fpa 4
186.Tn DEC
187DEFPA
188.Tn FDDI
189interfaces.
190.It Xr fxp 4
191Intel EtherExpress PRO 10+/100B Ethernet interfaces.
192.It Xr le 4
193PCNet-PCI Ethernet interfaces.
194.It Xr lge 4
195Level 1 LXT1001 NetCellerator PCI Gigabit Ethernet.
196.It Xr lmc 4
197Lan Media Corporation
198.Tn SSI/DS1/HSSI/DS3
199interfaces.
200.It Xr ne 4
201NE2000-compatible Ethernet interfaces.
202.It Xr nge 4
203National Semiconductor DP83820 and DP83821 based Gigabit Ethernet.
204.It Xr rl 4
205RealTek 8129/8139 Ethernet interfaces.
206.It Xr sf 4
207Adaptec AIC-6915 "Starfire" Ethernet interfaces.
208.It Xr sis 4
209SiS 900, SiS 7016, and NS DP83815 Ethernet interfaces.
210.It Xr sk 4
211SysKonnect SK-984x Gigabit Ethernet interfaces.
212.It Xr ste 4
213Sundance Technologies ST201 Ethernet interfaces.
214.It Xr stge 4
215Sundance/Tamarack TC9021 Gigabit Ethernet driver
216.It Xr ti 4
217Alteon Networks Tigon I and Tigon II Gigabit Ethernet interfaces.
218.It Xr tl 4
219Texas Instruments ThunderLAN-based Ethernet interfaces.
220.It Xr tx 4
221SMC 9432 10/100 Mbps Ethernet interfaces.
222.It Xr txp 4
2233Com 3XP Typhoon/Sidewinder (3C990) 10/100 Mbps Ethernet interfaces.
224.It Xr vr 4
225VIA Technologies VT3043 and VT86C100A Ethernet interfaces.
226.It Xr wb 4
227Winbond W89C840F Ethernet interfaces.
228.It Xr wi 4
229WaveLAN/IEEE and PRISM-II 802.11DS wireless network interfaces behind
230a PLX 905x-based dumb PCMCIA->PCI bridge.
231.It Xr wx 4
232Intel Gigabit Ethernet interfaces.
233.It Xr xl 4
2343Com 3c555, 3c556, 3c900, 3c905, 3c980, and 3cSOHO Ethernet interfaces.
235.El
236.Ss Cryptography accelerators
237.Bl -tag -width 10n -offset ind
238.It Xr hifn 4
239Hi/fn 7751
240Symmetric Encryption Accelerator.
241.It Xr ubsec 4
242Broadcom Bluesteelnet uBsec 5501, 5601, 5805, and 5820.
243.It Xr ises 4
244Pijnenburg PCC-ISES hardware crypto accelerator.
245.El
246.Ss Serial interfaces
247.Bl -tag -width 10n -offset ind
248.It Xr cy 4
249Cyclades Cyclom-4Y, -8Y, and -16Y asynchronous serial communications devices.
250.It Xr cz 4
251Cyclades-Z series multi-port serial adapter device driver.
252.El
253.Ss Display adapters
254.Bl -tag -width 10n -offset ind
255.It Xr vga 4
256VGA graphics cards.
257.El
258.Ss Audio devices
259.Bl -tag -width 10n -offset ind
260.It Xr auich 4
261Integrated Intel 82801AA/AB/BA/CA and 440MX sound devices.
262.It Xr autri 4
263Trident 4DWAVE-DX/NX, SiS 7018, ALi M5451 audio devices.
264.It Xr auvia 4
265Integrated AC97 audio controller of the VIA Technologies
266VT82C686A Southbridge.
267.It Xr clcs 4
268Cirrus Logic CrystalClear CS4280 sound devices.
269.It Xr clct 4
270Cirrus Logic CrystalClear CS4281 sound devices.
271.It Xr cmpci 4
272C-Media CMI8x38 sound devices.
273.It Xr eap 4
274Ensoniq AudioPCI sound devices.
275.It Xr emu 4
276Creative Labs SBLive! and PCI 512 audio device driver.
277.It Xr eso 4
278ESS Solo-1 PCI AudioDrive sound devices.
279.It Xr fms 4
280Forte Media FM801 sound devices.
281.It Xr maestro 4
282ESS Maestro 1, 2 and 2E sound devices.
283.It Xr neo 4
284NeoMagic 256AV/ZX sound devices.
285.It Xr sv 4
286S3 SonicVibes sound devices.
287.It Xr yds 4
288Yamaha DS-XG sound devices.
289.El
290.Ss Radio receiver devices
291.Bl -tag -width 10n -offset ind
292.It Xr mr 4
293Guillemot Maxi Radio FM 2000 FM radio device driver.
294.It Xr sf4r 4
295SoundForte RadioLink SF64-PCR FM radio device driver.
296.El
297.Ss Miscellaneous devices
298.Bl -tag -width 10n -offset ind
299.It Xr bktr 4
300Brooktree Bt848
301.Tn PCI
302TV tuners and video capture boards.
303.It Xr cbb 4
304.Tn PCI
305Yenta compatible
306.Tn CardBus
307bridges.
308.It Xr ohci 4
309USB OHCI host controller.
310.It Xr pcic 4
311.Tn PCI
312.Tn PCMCIA
313controllers, including the Cirrus Logic GD6729.
314.It Xr ppb 4
315Generic
316.Tn PCI Ns \- Ns Tn PCI
317bridges, including
318.Tn PCI
319expansion backplanes.
320.It Xr puc 4
321PCI
322.Dq universal
323communications cards, containing
324.Xr com 4
325and
326.Xr lpt 4
327communications ports.
328.It Xr uhci 4
329USB UHCI host controller.
330.It Xr wdt 4
331ICS PCI-WDT500/501 watchdog timer devices.
332.El
333.Sh IOCTLS
334If the kernel is compiled with the
335.Cd option USER_PCICONF
336kernel option, the following
337.Xr ioctl 2
338calls are supported by the
339.Nm
340driver.
341They are defined in the header file
342.Aq Pa sys/pciio.h .
343.Bl -tag -width 012345678901234
344.Pp
345.It PCIOCREAD
346This
347.Xr ioctl 2
348reads the
349.Tn PCI
350configuration registers specified by the passed-in
351.Va pci_io
352structure.
353The
354.Va pci_io
355structure consists of the following fields:
356.Bl -tag -width pi_width
357.It pi_sel
358A
359.Va pcisel
360structure which specifies the bus, slot and function the user would like to
361query.
362.It pi_reg
363The
364.Tn PCI
365configuration register the user would like to access.
366.It pi_width
367The width, in bytes, of the data the user would like to read.
368This value may be either 1, 2, or 4.  3-byte reads and reads larger than
3694 bytes are not supported.
370.It pi_data
371The data returned by the kernel.
372.El
373.It PCIOCWRITE
374This
375.Xr ioctl 2
376allows users to write to the
377.Tn PCI
378specified in the passed-in
379.Va pci_io
380structure.
381The
382.Va pci_io
383structure is described above.
384The limitations on data width described for
385reading registers, above, also apply to writing
386.Tn PCI
387configuration registers.
388.El
389.Sh FILES
390.Bl -tag -width /dev/pci -compact
391.It Pa /dev/pci
392Character device for the
393.Nm
394driver.
395.El
396.Sh SEE ALSO
397.Xr cardbus 4 ,
398.Xr intro 4 ,
399.Xr isa 4 ,
400.Xr isapnp 4 ,
401.Xr options 4 ,
402.Xr pchb 4 ,
403.Xr pcmcia 4 ,
404.Xr usb 4
405.Sh HISTORY
406The machine-independent
407.Tn PCI
408subsystem appeared in
409.Ox 2.0 .
410Support for device listing and matching was re-implemented by
411Kenneth Merry, and first appeared in
412.Fx 3.0 .
413