share/man/man4/pci.4

   1 .\"
   2 .\" Copyright (c) 1999 Kenneth D. Merry.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\"     $FreeBSD: src/share/man/man4/pci.4,v 1.3.2.5 2001/08/17 13:08:39 ru Exp $
  26 .\"     $DragonFly: src/share/man/man4/pci.4,v 1.3 2006/05/26 19:39:39 swildner Exp $
  27 .\"
  28 .Dd October 24, 1999
  29 .Dt PCI 4
  30 .Os
  31 .Sh NAME
  32 .Nm pci
  33 .Nd generic PCI driver
  34 .Sh SYNOPSIS
  35 .Cd device pci
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 driver provides a way for userland programs to read and write
  40 .Tn PCI
  41 configuration registers.  It also provides a way for userland programs to
  42 get a list of all
  43 .Tn PCI
  44 devices, or all
  45 .Tn PCI
  46 devices that match various patterns.
  47 .Pp
  48 Since the
  49 .Nm
  50 driver provides a write interface for
  51 .Tn PCI
  52 configuration registers, system administrators should exercise caution when
  53 granting access to the
  54 .Nm
  55 device.  If used improperly, this driver can allow userland applications to
  56 crash a machine or cause data loss.
  57 .Sh KERNEL CONFIGURATION
  58 It is only necessary to specify one
  59 .Nm
  60 controller in the kernel.  Additional
  61 .Tn PCI
  62 busses are handled automatically as they are encountered.
  63 .Sh IOCTLS
  64 The following
  65 .Xr ioctl 2
  66 calls are supported by the
  67 .Nm
  68 driver.  They are defined in the header file
  69 .In sys/pciio.h .
  70 .Bl -tag -width 012345678901234
  71 .Pp
  72 .It PCIOCGETCONF
  73 This
  74 .Xr ioctl 2
  75 takes a
  76 .Va pci_conf_io
  77 structure.  It allows the user to retrieve information on all
  78 .Tn PCI
  79 devices in the system, or on
  80 .Tn PCI
  81 devices matching patterns supplied by the user.
  82 The
  83 .Va pci_conf_io
  84 structure consists of a number of fields:
  85 .Bl -tag -width match_buf_len
  86 .It pat_buf_len
  87 The length, in bytes, of the buffer filled with user-supplied patterns.
  88 .It num_patterns
  89 The number of user-supplied patterns.
  90 .It patterns
  91 Pointer to a buffer filled with user-supplied patterns.
  92 .Va patterns
  93 is a pointer to
  94 .Va num_patterns
  95 .Va pci_match_conf
  96 structures.  The
  97 .Va pci_match_conf
  98 structure consists of the following elements:
  99 .Bl -tag -width pd_vendor
 100 .It pc_sel
 101 .Tn PCI
 102 bus, slot and function.
 103 .It pd_name
 104 .Tn PCI
 105 device driver name.
 106 .It pd_unit
 107 .Tn PCI
 108 device driver unit number.
 109 .It pc_vendor
 110 .Tn PCI
 111 vendor ID.
 112 .It pc_device
 113 .Tn PCI
 114 device ID.
 115 .It pc_class
 116 .Tn PCI
 117 device class.
 118 .It flags
 119 The flags describe which of the fields the kernel should match against.
 120 A device must match all specified fields in order to be returned.  The
 121 match flags are enumerated in the
 122 .Va pci_getconf_flags
 123 structure.
 124 Hopefully the flag values are obvious enough that they don't need to
 125 described in detail.
 126 .El
 127 .It match_buf_len
 128 Length of the
 129 .Va matches
 130 buffer allocated by the user to hold the results of the
 131 .Dv PCIOCGETCONF
 132 query.
 133 .It num_matches
 134 Number of matches returned by the kernel.
 135 .It matches
 136 Buffer containing matching devices returned by the kernel.  The items in
 137 this buffer are of type
 138 .Va pci_conf ,
 139 which consists of the following items:
 140 .Bl -tag -width pc_subvendor
 141 .It pc_sel
 142 .Tn PCI
 143 bus, slot and function.
 144 .It pc_hdr
 145 .Tn PCI
 146 header type.
 147 .It pc_subvendor
 148 .Tn PCI
 149 subvendor ID.
 150 .It pc_subdevice
 151 .Tn PCI
 152 subdevice ID.
 153 .It pc_vendor
 154 .Tn PCI
 155 vendor ID.
 156 .It pc_device
 157 .Tn PCI
 158 device ID.
 159 .It pc_class
 160 .Tn PCI
 161 device class.
 162 .It pc_subclass
 163 .Tn PCI
 164 device subclass.
 165 .It pc_progif
 166 .Tn PCI
 167 device programming interface.
 168 .It pc_revid
 169 .Tn PCI
 170 revision ID.
 171 .It pd_name
 172 Driver name.
 173 .It pd_unit
 174 Driver unit number.
 175 .El
 176 .It offset
 177 The offset is passed in by the user to tell the kernel where it should
 178 start traversing the device list.  The value passed out by the kernel
 179 points to the record immediately after the last one returned.  The user may
 180 pass the value returned by the kernel in subsequent calls to the
 181 .Dv PCIOCGETCONF
 182 ioctl.  If the user does not intend to use the offset, it must be set to
 183 zero.
 184 .It generation
 185 .Tn PCI
 186 configuration generation.  This value only needs to be set if the offset is
 187 set.  The kernel will compare the current generation number of its internal
 188 device list to the generation passed in by the user to determine whether
 189 its device list has changed since the user last called the
 190 .Dv PCIOCGETCONF
 191 ioctl.  If the device list has changed, a status of
 192 .Va PCI_GETCONF_LIST_CHANGED
 193 will be passed back.
 194 .It status
 195 The status tells the user the disposition of his request for a device list.
 196 The possible status values are:
 197 .Bl -ohang
 198 .It PCI_GETCONF_LAST_DEVICE
 199 This means that there are no more devices in the PCI device list after the
 200 ones returned in the
 201 .Va matches
 202 buffer.
 203 .It PCI_GETCONF_LIST_CHANGED
 204 This status tells the user that the
 205 .Tn PCI
 206 device list has changed since his last call to the
 207 .Dv PCIOCGETCONF
 208 ioctl and he must reset the
 209 .Va offset
 210 and
 211 .Va generation
 212 to zero to start over at the beginning of the list.
 213 .It PCI_GETCONF_MORE_DEVS
 214 This tells the user that his buffer was not large enough to hold all of the
 215 remaining devices in the device list that possibly match his criteria.  It
 216 is possible for this status to be returned, even when none of the remaining
 217 devices in the list would match the user's criteria.
 218 .It PCI_GETCONF_ERROR
 219 This indicates a general error while servicing the user's request.  A more
 220 specific indication of the problem may or may not be printed in the kernel
 221 message buffer (and by implication, the system console).
 222 .El
 223 .El
 224 .It PCIOCREAD
 225 This
 226 .Xr ioctl 2
 227 reads the
 228 .Tn PCI
 229 configuration registers specified by the passed-in
 230 .Va pci_io
 231 structure.  The
 232 .Va pci_io
 233 structure consists of the following fields:
 234 .Bl -tag -width pi_width
 235 .It pi_sel
 236 A
 237 .Va pcisel
 238 structure which specifies the bus, slot and function the user would like to
 239 query.
 240 .It pi_reg
 241 The
 242 .Tn PCI
 243 configuration register the user would like to access.
 244 .It pi_width
 245 The width, in bytes, of the data the user would like to read.  This value
 246 may be either 1, 2, or 4.  3-byte reads and reads larger than 4 bytes are
 247 not supported.
 248 .It pi_data
 249 The data returned by the kernel.
 250 .El
 251 .It PCIOCWRITE
 252 This
 253 .Xr ioctl 2
 254 allows users to write to the
 255 .Tn PCI
 256 specified in the passed-in
 257 .Va pci_io
 258 structure.  The
 259 .Va pci_io
 260 structure is described above.  The limitations on data width described for
 261 reading registers, above, also apply to writing
 262 .Tn PCI
 263 configuration registers.
 264 .El
 265 .Sh FILES
 266 .Bl -tag -width /dev/pci -compact
 267 .It Pa /dev/pci
 268 Character device for the
 269 .Nm
 270 driver.
 271 .El
 272 .Sh DIAGNOSTICS
 273 None.
 274 .Sh SEE ALSO
 275 .Xr pciconf 8
 276 .Sh HISTORY
 277 The
 278 .Nm
 279 driver (not the kernel's
 280 .Tn PCI
 281 support code) first appeared in
 282 .Fx 2.2 ,
 283 and was written by Stefan Esser and Garrett Wollman.
 284 Support for device listing and matching was re-implemented by
 285 Kenneth Merry, and first appeared in
 286 .Fx 3.0 .
 287 .Sh AUTHORS
 288 .An Kenneth Merry Aq ken@FreeBSD.org
 289 .Sh BUGS
 290 It isn't possible for users to specify an accurate offset into the device
 291 list without calling the
 292 .Dv PCIOCGETCONF
 293 at least once, since they have no way of knowing the current generation
 294 number otherwise.  This probably isn't a serious problem, though, since
 295 users can easily narrow their search by specifying a pattern or patterns
 296 for the kernel to match against.