xref: /openbsd-src/share/man/man4/pci.4 (revision d1df930ffab53da22f3324c32bed7ac5709915e6)
1.\"	$OpenBSD: pci.4,v 1.366 2018/10/01 22:37:18 jmatthew 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 $Mdocdate: October 1 2018 $
35.Dt PCI 4
36.Os
37.Sh NAME
38.Nm pci
39.Nd introduction to PCI bus support
40.Sh SYNOPSIS
41.Cd "# alpha"
42.Cd "pci* at apecs?"
43.Cd "pci* at cia?"
44.Cd "pci* at irongate?"
45.Cd "pci* at lca?"
46.Cd "pci* at tsp?"
47.Cd "pci* at mcpcia?"
48.Pp
49.Cd "# amd64, i386"
50.Cd "pci* at mainbus0"
51.Pp
52.Cd "# arm64"
53.Cd "pci* at acpipci?"
54.Cd "pci* at dwpcie?"
55.Cd "pci* at pciecam?"
56.Cd "pci* at rkpcie?"
57.Pp
58.Cd "# armv7"
59.Cd "pci* at mvpcie?"
60.Cd "pci* at pciecam?"
61.Pp
62.Cd "# hppa"
63.Cd "pci* at dino?"
64.Cd "pci* at elroy?"
65.Pp
66.Cd "# landisk"
67.Cd "pci* at shpcic?"
68.Pp
69.Cd "# loongson"
70.Cd "pci* at bonito?"
71.Cd "pci* at htb?"
72.Pp
73.Cd "# macppc"
74.Cd "pci* at mpcpcibr?"
75.Cd "pci* at ht?"
76.Cd "pci* at hpb?"
77.Pp
78.Cd "# sgi"
79.Cd "pci* at macepcibr?"
80.Cd "pci* at xbridge?"
81.Pp
82.Cd "# sparc64"
83.Cd "pci* at psycho?"
84.Cd "pci* at schizo?"
85.Cd "pci* at pyro?"
86.Cd "pci* at vpci?"
87.Pp
88.Cd "# all architectures"
89.Cd "pci* at pchb?"
90.Cd "pci* at ppb?"
91.Sh DESCRIPTION
92The system includes a machine-independent
93.Tn PCI
94bus subsystem and
95several machine-independent
96.Tn PCI
97device drivers.
98.Pp
99Note that interrupt mappings on the i386 may require that you configure
100your BIOS to reserve sufficient interrupts as "PCI/ISAPnP" so that there
101are sufficient interrupts remaining to configure the discovered PCI
102devices.
103For more information, see
104.Xr pcibios 4 .
105.Pp
106.Ox
107provides support for the following devices.
108Note that not all architectures support all devices.
109.Ss SCSI host adapters
110.Bl -tag -width 10n -offset ind -compact
111.It Xr adv 4 , Xr adw 4
112AdvanSys PCI SCSI interface
113.It Xr ahc 4
114Adaptec VL/EISA/PCI SCSI interface
115.It Xr ahd 4
116Adaptec PCI/PCI-X AIC79xx-based Ultra320 SCSI interface
117.It Xr iha 4
118Initio INIC-940/950 based PCI SCSI interface
119.It Xr mpi 4
120LSI Logic Fusion-MPT Message Passing Interface
121.It Xr mpii 4
122LSI Logic Fusion-MPT Message Passing Interface II
123.It Xr nvme 4
124Non-Volatile Memory Host Controller Interface
125.It Xr pcscp 4
126Advanced Micro Devices Am53c974 PCscsi-PCI SCSI interface
127.It Xr qla 4
128QLogic ISP2100/2200/2300 Fibre Channel controller
129.It Xr qle 4
130QLogic ISP2400/2500 Fibre Channel controller
131.It Xr qlw 4
132QLogic ISP1000/1020/1x40/1x80/1x160 SCSI controller
133.It Xr siop 4
134LSI/Symbios Logic/NCR 53c8xx SCSI interface
135.It Xr sli 4
136Emulex LightPulse Fibre Channel SCSI interface
137.It Xr trm 4
138TRM-S1040 based PCI SCSI interface
139.It Xr vmwpvs 4
140VMware Paravirtual SCSI
141.El
142.Ss IDE disk controllers
143.Bl -tag -width 10n -offset ind -compact
144.It Xr ahci 4
145Advanced Host Controller Interface for Serial ATA
146.It Xr jmb 4
147JMicron JMB36x SATA II and PATA Host Controller
148.It Xr pciide 4
149PCI IDE controller driver
150.It Xr sili 4
151Silicon Image 3124/3132/3531 SATA controller
152.El
153.Ss RAID and cache controllers
154.Bl -tag -width 10n -offset ind -compact
155.It Xr aac 4
156Adaptec SAS/SATA/SCSI RAID controller
157.It Xr ami 4
158American Megatrends Inc. MegaRAID PATA/SATA/SCSI RAID controller
159.It Xr arc 4
160Areca Technology Corporation SAS/SATA RAID controller
161.It Xr cac 4
162Compaq Smart Array 2/3/4 SCSI RAID controller
163.It Xr ciss 4
164Compaq Smart Array SAS/SATA/SCSI RAID controller
165.It Xr dpt 4
166DPT EATA SCSI RAID controller
167.It Xr gdt 4
168ICP-Vortex and Intel GDT SATA/SCSI RAID controller
169.It Xr ips 4
170IBM SATA/SCSI ServeRAID controller
171.It Xr mfi 4
172LSI Logic & Dell MegaRAID SAS RAID controller
173.It Xr mfii 4
174LSI Logic MegaRAID SAS Fusion RAID controller
175.It Xr twe 4
1763ware 5000/6000/7000/8000 series PATA/SATA RAID controller
177.El
178.Ss Wired network interfaces
179.Bl -tag -width 10n -offset ind -compact
180.It Xr age 4
181Attansic L1 10/100/Gigabit Ethernet device
182.It Xr alc 4
183Atheros AR813x/AR815x 10/100/Gigabit Ethernet device
184.It Xr ale 4
185Atheros AR8121/AR8113/AR8114 10/100/Gigabit Ethernet device
186.It Xr bce 4
187Broadcom BCM4401 10/100 Ethernet device
188.It Xr bge 4
189Broadcom BCM57xx/BCM590x 10/100/Gigabit Ethernet device
190.It Xr bnx 4
191Broadcom NetXtreme II 10/100/Gigabit Ethernet device
192.It Xr bnxt 4
193Broadcom NetXtreme-C/E 10/25/40/50Gb Ethernet device
194.It Xr cas 4
195Sun Cassini 10/100/Gigabit Ethernet device
196.It Xr dc 4
197DEC/Intel 21140/21142/21143/21145 and clones 10/100 Ethernet device
198.It Xr de 4
199DEC DC21x4x (Tulip) 10/100 Ethernet device
200.It Xr em 4
201Intel PRO/1000 10/100/Gigabit Ethernet device
202.\" .It Xr en 4
203.\" Midway-based Efficient Networks Inc.\&
204.\" and Adaptec ATM interfaces
205.It Xr ep 4
2063Com EtherLink III and Fast EtherLink III 10/100 Ethernet device
207.It Xr epic 4
208SMC 83C170 (EPIC/100) 10/100 Ethernet device
209.It Xr et 4
210Agere/LSI ET1310 10/100/Gigabit Ethernet device
211.It Xr fxp 4
212Intel EtherExpress PRO/100 10/100 Ethernet device
213.It Xr gem 4
214GEM 10/100/Gigabit Ethernet device
215.It Xr hme 4
216Sun Happy Meal 10/100 Ethernet device
217.It Xr ix 4
218Intel 82598/82599/X540/X550 PCI Express 10Gb Ethernet device
219.It Xr ixgb 4
220Intel PRO/10GbE 10Gb Ethernet device
221.It Xr jme 4
222JMicron JMC25x/JMC26x 10/100/Gigabit Ethernet device
223.It Xr lge 4
224Level 1 LXT1001 NetCellerator PCI Gigabit Ethernet device
225.It Xr lii 4
226Attansic L2 10/100 Ethernet device
227.It Xr msk 4
228Marvell Yukon-2 10/100/Gigabit Ethernet device
229.It Xr mtd 4
230Myson Technology MTD800/MTD803/MTD891 10/100/Gigabit Ethernet device
231.It Xr myx 4
232Myricom Myri-10G PCI Express 10Gb Ethernet device
233.It Xr ne 4
234NE2000 and compatible 10/100 Ethernet device
235.It Xr nep 4
236Sun Neptune 10Gb Ethernet device
237.It Xr nfe 4
238NVIDIA nForce MCP 10/100/Gigabit Ethernet device
239.It Xr nge 4
240National Semiconductor PCI 10/100/Gigabit Ethernet device
241.It Xr oce 4
242Emulex OneConnect 10Gb Ethernet device
243.It Xr pcn 4
244AMD PCnet-PCI 10/100 Ethernet device
245.It Xr re 4
246Realtek 8139C+/8169/816xS/811xS/8168/810xE 10/100/Gigabit Ethernet device
247.It Xr rl 4
248Realtek 8129/8139 10/100 Ethernet device
249.It Xr se 4
250SiS 190/191 10/100/Gigabit Ethernet device
251.It Xr sf 4
252Adaptec AIC-6915 "Starfire" PCI 10/100 Ethernet device
253.It Xr sis 4
254SiS 900, SiS 7016, and NS DP83815/6 10/100 Ethernet device
255.It Xr sk 4
256SysKonnect XMAC II and Marvell Yukon 10/100/Gigabit Ethernet device
257.It Xr ste 4
258Sundance Technologies ST201 10/100 Ethernet device
259.It Xr stge 4
260Sundance/Tamarack TC9021 Gigabit Ethernet device
261.It Xr tht 4
262Tehuti Networks 10Gb Ethernet device
263.It Xr ti 4
264Alteon Networks Tigon I and II Gigabit Ethernet device
265.It Xr tl 4
266Texas Instruments ThunderLAN 10/100 Ethernet device
267.It Xr txp 4
2683Com 3XP Typhoon/Sidewinder (3CR990) 10/100 Ethernet device
269.It Xr vge 4
270VIA Velocity 10/100/Gigabit Ethernet device
271.It Xr vic 4
272VMware VMXnet Virtual Interface Controller device
273.It Xr vmx 4
274VMware VMXNET3 Virtual Interface Controller device
275.It Xr vr 4
276VIA Rhine I/II/III 10/100 Ethernet device
277.It Xr vte 4
278RDC R6040 10/100 Ethernet device
279.It Xr wb 4
280Winbond W89C840F 10/100 Ethernet device
281.It Xr xge 4
282Neterion Xframe/Xframe II 10Gb Ethernet device
283.It Xr xl 4
2843Com EtherLink XL and Fast EtherLink XL 10/100 Ethernet device
285.El
286.Ss Wireless network interfaces
287.Bl -tag -width 10n -offset ind -compact
288.It Xr acx 4
289TI ACX100/ACX111 IEEE 802.11a/b/g wireless network device
290.It Xr an 4
291Aironet Communications 4500/4800 IEEE 802.11FH/b wireless network device
292.It Xr ath 4
293Atheros IEEE 802.11a/b/g wireless network device with GPIO
294.It Xr athn 4
295Atheros IEEE 802.11a/b/g/n wireless network device
296.It Xr atw 4
297ADMtek ADM8211 IEEE 802.11b wireless network device
298.It Xr bwfm 4
299Broadcom and Cypress IEEE 802.11a/ac/b/g/n wireless network device
300.It Xr bwi 4
301Broadcom AirForce IEEE 802.11b/g wireless network device
302.It Xr ipw 4
303Intel PRO/Wireless 2100 IEEE 802.11b wireless network device
304.It Xr iwi 4
305Intel
306PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11a/b/g wireless network device
307.It Xr iwn 4
308Intel WiFi Link and Centrino IEEE 802.11a/b/g/n wireless network devices
309.It Xr iwm 4
310Intel 7000/8000 IEEE 802.11a/ac/b/g/n wireless network devices
311.It Xr malo 4
312Marvell Libertas IEEE 802.11b/g wireless network device
313.It Xr pgt 4
314Conexant/Intersil Prism GT Full-MAC IEEE 802.11a/b/g wireless network device
315.It Xr ral 4
316Ralink Technology/MediaTek IEEE 802.11a/b/g/n wireless network device
317.It Xr rtw 4
318Realtek RTL8180L IEEE 802.11b wireless network device
319.It Xr rtwn 4
320Realtek RTL8188CE/RTL8188EE/RTL8192CE/RTL8723AE PCIe IEEE 802.11b/g/n wireless
321network device
322.It Xr wi 4
323WaveLAN/IEEE, PRISM 2-3, and Spectrum24 IEEE 802.11b wireless network
324device
325.It Xr wpi 4
326Intel PRO/Wireless 3945ABG IEEE 802.11a/b/g wireless network device
327.El
328.Ss Cryptography accelerators
329.Bl -tag -width 10n -offset ind -compact
330.It Xr ccp 4
331AMD Cryptographic Co-processor
332.It Xr glxsb 4
333Geode LX Security Block crypto accelerator
334.It Xr hifn 4
335Hifn 7751/7811/7951/7955/7956/9751 crypto accelerator
336.It Xr safe 4
337SafeNet crypto accelerator
338.It Xr ubsec 4
339Broadcom and BlueSteel uBsec 5x0x crypto accelerator
340.El
341.Ss Serial interfaces
342.Bl -tag -width 10n -offset ind -compact
343.It Xr cy 4
344Cyclades Cyclom-4Y, -8Y, and -16Y asynchronous serial communications devices
345.It Xr cz 4
346Cyclades-Z series multi-port serial adapter device
347.It Xr puc 4
348PCI
349.Dq universal
350communications card driver
351.El
352.Ss Display adapters
353.Bl -tag -width 10n -offset ind -compact
354.It Xr sti 4
355HP Standard Text Interface
356.It Xr tga 4
357DECchip 21030 (TGA) graphics driver
358.It Xr vga 4
359VGA graphics cards
360.El
361.Ss Audio devices
362.Bl -tag -width 10n -offset ind -compact
363.It Xr auacer 4
364Acer Labs I/O Controller Hub integrated AC'97 audio device
365.It Xr auglx 4
366AMD Geode LX CS5536 integrated AC'97 audio device
367.It Xr auich 4
368Intel ICH integrated AC'97 audio device
369.It Xr auixp 4
370ATI SB200/SB300/SB400/SB600 integrated AC'97 audio device
371.It Xr autri 4
372Trident 4DWAVE-DX/NX, SiS 7018, ALi M5451 audio device
373.It Xr auvia 4
374VIA VT82C686A/VT8233/VT8235/VT8237 integrated AC'97 audio device
375.It Xr azalia 4
376generic High Definition Audio device
377.It Xr clcs 4
378Cirrus Logic CS4280/CS4610/CS4615 audio device
379.It Xr clct 4
380Cirrus Logic CS4281 audio device
381.It Xr cmpci 4
382C-Media CMI8338/CMI8738/CMI8768 PCI audio device
383.It Xr eap 4
384Ensoniq AudioPCI audio device
385.It Xr emu 4
386Creative Labs SBLive!, PCI 512, and Audigy audio device
387.It Xr envy 4
388VIA Envy24 audio device
389.It Xr esa 4
390ESS Technology Allegro-1/Maestro-3 family audio device
391.It Xr eso 4
392ESS Technology Solo-1 PCI AudioDrive audio device
393.It Xr fms 4
394Forte Media FM801 audio device
395.It Xr maestro 4
396ESS Maestro 1 and 2 audio device
397.It Xr neo 4
398NeoMagic 256AV/ZX audio device
399.It Xr sv 4
400S3 SonicVibes audio device
401.It Xr yds 4
402Yamaha DS-XG audio device
403.El
404.Ss Time receiver devices
405.Bl -tag -width 10n -offset ind -compact
406.It Xr mbg 4
407Meinberg Funkuhren timedelta sensor
408.El
409.Ss Radio receiver devices
410.Bl -tag -width 10n -offset ind -compact
411.It Xr fms 4
412Forte Media FM801 audio device
413.El
414.Ss Hardware Sensors
415.Bl -tag -width 10n -offset ind -compact
416.It Xr berkwdt 4
417Berkshire Products watchdog timer device
418.It Xr elansc 4
419AMD Elan SC520 System Controller with watchdog timer and GPIO
420.It Xr geodesc 4
421Geode SC1100/SCx200 IAOC watchdog timer device
422.It Xr ichwdt 4
423Intel 6300ESB ICH watchdog timer device
424.It Xr itherm 4
425Intel 3400 temperature sensor
426.It Xr kate 4
427AMD K8 temperature sensor
428.It Xr km 4
429AMD K10 temperature sensor
430.It Xr pchtemp 4
431Intel PCH temperature sensor
432.It Xr pwdog 4
433Quancom PWDOG1 watchdog timer device
434.It Xr viapm 4
435VIA SMBus controller and VIA VT82C686A/VT8231 hardware monitor
436.It Xr wdt 4
437ICS PCI-WDT500/501 watchdog timer device
438.El
439.Ss Miscellaneous devices
440.Bl -tag -width "piixpcib(4)" -offset ind -compact
441.It Xr alipm 4
442Acer Labs M7101 SMBus controller
443.It Xr amas 4
444AMD memory address map
445.It Xr amdiic 4
446AMD-8111 SMBus controller
447.It Xr amdpcib 4
448AMD-8111 series LPC bridge and timecounter
449.It Xr amdpm 4
450AMD-756/766/768/8111 Power Management and SMBus controller
451.It Xr bktr 4
452Brooktree Bt848/849/878/879
453.Tn PCI
454TV tuners and video capture boards
455.It Xr cbb 4
456.Tn PCI
457Yenta compatible
458.Tn CardBus
459bridges
460.It Xr ehci 4
461USB Enhanced Host Controller Interface
462.It Xr gcu 4
463Intel EP80579 Global Configuration Unit
464.It Xr glxpcib 4
465CS5536 PCI-ISA Bridge with timecounter, watchdog timer, and GPIO
466.It Xr gscpcib 4
467National Semiconductor Geode SC1100 PCI-ISA bridge with GPIO
468.It Xr hpb 4
469.Tn HyperTransport Ns \- Ns Tn PCI bridge
470.It Xr ichiic 4
471Intel ICH SMBus controller
472.It Xr nviic 4
473NVIDIA nForce2/3/4 SMBus controller
474.It Xr ohci 4
475USB Open Host Controller Interface
476.It Xr pcib 4
477PCI-ISA bridge
478.It Xr pcic 4
479.Tn PCI
480.Tn PCMCIA
481controllers, including the Cirrus Logic GD6729
482.It Xr piixpcib 4
483Intel PIIX4 ISA bridges
484.It Xr piixpm 4
485Intel PIIX SMBus controller
486.It Xr ppb 4
487.Tn PCI Ns \- Ns Tn PCI bridge
488.It Xr rtsx 4
489Realtek SD card reader
490.It Xr sdhc 4
491SD Host Controller
492.It Xr ssio 4
493National Semiconductor PC87560 Legacy IO
494.It Xr tcpcib 4
495Intel Atom E600 series LPC bridge and watchdog timer
496.It Xr uhci 4
497USB Universal Host Controller Interface
498.It Xr viapm 4
499VIA SMBus controller
500.It Xr virtio 4
501VirtIO support driver
502.El
503.Sh IOCTLS
504If the kernel is compiled with the
505.Va USER_PCICONF
506kernel option, the following
507.Xr ioctl 2
508calls are supported by the
509.Nm
510driver.
511They are defined in the header file
512.In sys/pciio.h .
513.Bl -tag -width Ds
514.It PCIOCREAD Fa "struct pci_io *"
515This
516.Xr ioctl 2
517reads the
518.Tn PCI
519configuration registers specified by the passed-in
520.Va pci_io
521structure.
522The
523.Va pci_io
524structure consists of the following fields:
525.Bl -tag -width pi_width
526.It pi_sel
527A
528.Va pcisel
529structure which specifies the bus, slot and function the user would like to
530query.
531.It pi_reg
532The
533.Tn PCI
534configuration register the user would like to access.
535.It pi_width
536The width, in bytes, of the data the user would like to read.
537This value can be only 4.
538.It pi_data
539The data returned by the kernel.
540.El
541.It PCIOCWRITE Fa "struct pci_io *"
542This
543.Xr ioctl 2
544allows users to write to the
545.Tn PCI
546device specified in the passed-in
547.Va pci_io
548structure.
549The
550.Va pci_io
551structure is described above.
552The limitations on data width described for
553reading registers, above, also apply to writing
554.Tn PCI
555configuration registers.
556.It PCIOCGETROM Fa "struct pci_rom *"
557This
558.Xr ioctl 2
559allows users to read the contents of the
560.Tn PCI
561ROM specified in the passed-in
562.Va pci_rom
563structure.
564The
565.Va pci_rom
566structure consists of the following fields:
567.Bl -tag -width pr_romlen
568.It pr_sel
569A
570.Va pcisel
571structure which specifies the bus, slot and function the user would like to
572query.
573.It pr_romlen
574Size of the buffer to store the contents of the ROM.
575Upon return, this field will contain the size of the ROM
576.It pr_rom
577The address of the buffer to store the contents of the ROM.
578.El
579.Pp
580If the ROM is larger than the specified buffer size,
581.Dv ENOMEM
582will be returned.
583.El
584.Sh FILES
585.Bl -tag -width /dev/pci* -compact
586.It Pa /dev/pci*
587Character device for the
588.Nm
589driver.
590.El
591.Sh SEE ALSO
592.Xr intro 4 ,
593.Xr pcidump 8
594.Sh HISTORY
595The machine-independent
596.Tn PCI
597subsystem appeared in
598.Ox 1.2 .
599