2 .\" Copyright (c) 2005 Bruce M Simpson <bms@FreeBSD.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .Dd September 30, 2007
34 .Nm pci_write_config ,
35 .Nm pci_enable_busmaster ,
36 .Nm pci_disable_busmaster ,
39 .Nm pci_set_powerstate ,
40 .Nm pci_get_powerstate ,
49 .In machine/pci_cfgreg.h
51 .Fn pci_write_config "device_t dev" "int reg" "uint32_t val" "int width"
53 .Fn pci_enable_busmaster "device_t dev"
55 .Fn pci_disable_busmaster "device_t dev"
57 .Fn pci_enable_io "device_t dev" "int space"
59 .Fn pci_disable_io "device_t dev" "int space"
61 .Fn pci_set_powerstate "device_t dev" "int state"
63 .Fn pci_get_powerstate "device_t dev"
65 .Fn pci_read_config "device_t dev" "int reg" "int width"
67 .Fn pci_find_bsf "uint8_t bus" "uint8_t slot" "uint8_t func"
69 .Fn pci_find_dbsf "uint32_t domain" "uint8_t bus" "uint8_t slot" "uint8_t func"
71 .Fn pci_find_device "uint16_t vendor" "uint16_t device"
75 set of functions are used for managing PCI devices.
79 function is used to read data from the PCI configuration
86 specifying the size of the access.
90 function is used to write the value
92 to the PCI configuration
99 specifying the size of the access.
102 .Fn pci_enable_busmaster
103 function enables PCI bus mastering for the device
106 .Dv PCIM_CMD_BUSMASTEREN
111 .Fn pci_disable_busmaster
112 function clears this bit.
116 function enables memory or I/O port address decoding for the device
124 register appropriately.
127 function clears the appropriate bit.
130 argument specifies which resource is affected; this can be either
137 These functions should be used in preference to manually manipulating
138 the configuration space.
141 .Fn pci_get_powerstate
142 function returns the current ACPI power state of the device
144 If the device does not support power management capabilities, then the default
146 .Dv PCI_POWERSTATE_D0
148 The following power states are defined by ACPI:
149 .Bl -hang -width ".Dv PCI_POWERSTATE_UNKNOWN"
150 .It Dv PCI_POWERSTATE_D0
151 State in which device is on and running.
152 It is receiving full power from the system and delivering
153 full functionality to the user.
154 .It Dv PCI_POWERSTATE_D1
155 Class-specific low-power state in which device context may or
157 Busses in this state cannot do anything to the bus, to
158 force devices to lose context.
159 .It Dv PCI_POWERSTATE_D2
160 Class-specific low-power state in which device context may or
162 Attains greater power savings than
163 .Dv PCI_POWERSTATE_D1 .
164 Busses in this state can cause devices to lose some context.
167 be prepared for the bus to be in this state or higher.
168 .It Dv PCI_POWERSTATE_D3
169 State in which the device is off and not running.
170 Device context is lost, and power from the device can
172 .It Dv PCI_POWERSTATE_UNKNOWN
173 State of the device is unknown.
177 .Fn pci_set_powerstate
178 function is used to transition the device
180 to the ACPI power state
182 It checks to see if the device is PCI 2.2 compliant.
184 capabilities pointer to determine which power states the device supports.
185 If the device does not have power management capabilities, the default state
187 .Dv PCI_POWERSTATE_D0
192 function looks up the
194 of a PCI device, given its
201 number actually refers to the number of the device on the bus,
202 which does not necessarily indicate its geographic location
203 in terms of a physical slot.
204 Note that in case the system has multiple PCI domains,
207 function only searches the first one.
208 Actually, it is equivalent to:
209 .Bd -literal -offset indent
210 pci_find_dbsf(0, bus, slot, func);
215 function looks up the
217 of a PCI device, given its
225 number actually refers to the number of the device on the bus,
226 which does not necessarily indicate its geographic location
227 in terms of a physical slot.
231 function looks up the
233 of a PCI device, given its
238 Note that there can be multiple matches for this search; this function
239 only returns the first matching device.
240 .Sh IMPLEMENTATION NOTES
243 type varies according to the size of the PCI bus address
244 space on the target architecture.
248 .Xr bus_alloc_resource 9 ,
250 .Xr bus_release_resource 9 ,
251 .Xr bus_setup_intr 9 ,
252 .Xr bus_teardown_intr 9 ,
258 .%B FreeBSD Developers' Handbook
260 .%O http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
265 .%B PCI System Architecture
268 .%O ISBN 0-201-30974-2
271 This manual page was written by
272 .An Bruce M Simpson Aq bms@FreeBSD.org .
274 The kernel PCI code has a number of references to
276 These do not refer to the geographic location of PCI devices,
277 but to the device number assigned by the combination of the PCI IDSEL
278 mechanism and the platform firmware.
279 This should be taken note of when working with the kernel PCI code.