setpci.man

   1 .TH setpci 8 "@TODAY@" "@VERSION@" "The PCI Utilities"
   2 .SH NAME
   3 setpci \- configure PCI devices
   4 .SH SYNOPSIS
   5 .B setpci
   6 .RB [ options ]
   7 .B devices
   8 .BR operations ...
   9
  10 .SH DESCRIPTION
  11 .PP
  12 .B setpci
  13 is a utility for querying and configuring PCI devices.
  14
  15 All numbers are entered in hexadecimal notation.
  16
  17 Root privileges are necessary for almost all operations, excluding reads
  18 of the standard header of the configuration space on some operating systems.
  19 Please see
  20 .BR lspci(8)
  21 for details on access rights.
  22
  23 .SH OPTIONS
  24
  25 .SS General options
  26 .TP
  27 .B -v
  28 Tells
  29 .I setpci
  30 to be verbose and display detailed information about configuration space accesses.
  31 .TP
  32 .B -f
  33 Tells
  34 .I setpci
  35 not to complain when there's nothing to do (when no devices are selected).
  36 This option is intended for use in widely-distributed configuration scripts
  37 where it's uncertain whether the device in question is present in the machine
  38 or not.
  39 .TP
  40 .B -D
  41 `Demo mode' -- don't write anything to the configuration registers.
  42 It's useful to try
  43 .B setpci -vD
  44 to verify that your complex sequence of
  45 .B setpci
  46 operations does what you think it should do.
  47 .TP
  48 .B -r
  49 Avoids bus scan if each operation selects a specific device (uses the
  50 .B -s
  51 selector with specific domain, bus, slot, and function). This is faster,
  52 but if the device does not exist, it fails instead of matching an empty
  53 set of devices.
  54 .TP
  55 .B --version
  56 Show
  57 .I setpci
  58 version. This option should be used stand-alone.
  59 .TP
  60 .B --help
  61 Show detailed help on available options. This option should be used stand-alone.
  62 .TP
  63 .B --dumpregs
  64 Show a list of all known PCI registers and capabilities. This option should be
  65 used stand-alone.
  66
  67 .SS PCI access options
  68 .PP
  69 The PCI utilities use the PCI library to talk to PCI devices (see
  70 \fBpcilib\fP(7) for details). You can use the following options to
  71 influence its behavior:
  72 .TP
  73 .B -A <method>
  74 The library supports a variety of methods to access the PCI hardware.
  75 By default, it uses the first access method available, but you can use
  76 this option to override this decision. See \fB-A help\fP for a list of
  77 available methods and their descriptions.
  78 .TP
  79 .B -O <param>=<value>
  80 The behavior of the library is controlled by several named parameters.
  81 This option allows one to set the value of any of the parameters. Use \fB-O help\fP
  82 for a list of known parameters and their default values.
  83 .TP
  84 .B -H1
  85 Use direct hardware access via Intel configuration mechanism 1.
  86 (This is a shorthand for \fB-A intel-conf1\fP.)
  87 .TP
  88 .B -H2
  89 Use direct hardware access via Intel configuration mechanism 2.
  90 (This is a shorthand for \fB-A intel-conf2\fP.)
  91 .TP
  92 .B -G
  93 Increase debug level of the library.
  94
  95 .SH DEVICE SELECTION
  96 .PP
  97 Before each sequence of operations you need to select which devices you wish that
  98 operation to affect.
  99 .TP
 100 .B -s [[[[<domain>]:]<bus>]:][<slot>][.[<func>]]
 101 Consider only devices in the specified domain (in case your machine has several host bridges,
 102 they can either share a common bus number space or each of them can address a PCI domain
 103 of its own; domains are numbered from 0 to ffff), bus (0 to ff), slot (0 to 1f) and function (0 to 7).
 104 Each component of the device address can be omitted or set to "*", both meaning "any value". All numbers are
 105 hexadecimal.  E.g., "0:" means all devices on bus 0, "0" means all functions of device 0
 106 on any bus, "0.3" selects third function of device 0 on all buses and ".4" matches only
 107 the fourth function of each device.
 108 .TP
 109 .B -d [<vendor>]:[<device>]
 110 Select devices with specified vendor and device ID. Both ID's are given in
 111 hexadecimal and may be omitted or given as "*", both meaning "any value".
 112 .PP
 113 When
 114 .B -s
 115 and
 116 .B -d
 117 are combined, only devices that match both criteria are selected. When multiple
 118 options of the same kind are specified, the rightmost one overrides the others.
 119
 120 .SH OPERATIONS
 121 .PP
 122 There are two kinds of operations: reads and writes. To read a register, just specify
 123 its name. Writes have the form
 124 .IR name = value , value ...\&
 125 where each
 126 .I value
 127 is either a hexadecimal number or an expression of type
 128 .IR data : mask
 129 where both
 130 .I data
 131 and
 132 .I mask
 133 are hexadecimal numbers. In the latter case, only the bits corresponding to binary
 134 ones in the \fImask\fP are changed (technically, this is a read-modify-write operation).
 135
 136 .PP
 137 There are several ways how to identity a register:
 138 .IP \(bu
 139 Tell its address in hexadecimal.
 140 .IP \(bu
 141 Spell its name. Setpci knows the names of all registers in the standard configuration
 142 headers. Use `\fBsetpci --dumpregs\fP' to get the complete list.
 143 See PCI bus specifications for the precise meaning of these registers or consult
 144 \fBheader.h\fP or \fB/usr/include/pci/pci.h\fP for a brief sketch.
 145 .IP \(bu
 146 If the register is a part of a PCI capability, you can specify the name of the
 147 capability to get the address of its first register. See the names starting with
 148 `CAP_' or `ECAP_' in the \fB--dumpregs\fP output.
 149 .IP \(bu
 150 If the name of the capability is not known to \fBsetpci\fP, you can refer to it
 151 by its number in the form CAP\fBid\fP or ECAP\fBid\fP, where \fBid\fP is the numeric
 152 identifier of the capability in hexadecimal.
 153 .IP \(bu
 154 Each of the previous formats can be followed by \fB+offset\fP to add an offset
 155 (a hex number) to the address. This feature can be useful for addressing of registers
 156 living within a capability, or to modify parts of standard registers.
 157 .IP \(bu
 158 To choose how many bytes (1, 2, or 4) should be transferred, you should append a width
 159 specifier \fB.B\fP, \fB.W\fP, or \fB.L\fP. The width can be omitted if you are
 160 referring to a register by its name and the width of the register is well known.
 161 .IP \(bu
 162 Finally, if a capability exists multiple times you can choose which one to target using
 163 \fB@number\fP. Indexing starts at 0.
 164
 165 .PP
 166 All names of registers and width specifiers are case-insensitive.
 167
 168 .SH
 169 EXAMPLES
 170
 171 .IP COMMAND
 172 asks for the word-sized command register.
 173 .IP 4.w
 174 is a numeric address of the same register.
 175 .IP COMMAND.l
 176 asks for a 32-bit word starting at the location of the command register,
 177 i.e., the command and status registers together.
 178 .IP VENDOR_ID+1.b
 179 specifies the upper byte of the vendor ID register (remember, PCI is little-endian).
 180 .IP CAP_PM+2.w
 181 corresponds to the second word of the power management capability.
 182 .IP ECAP108.l
 183 asks for the first 32-bit word of the extended capability with ID 0x108.
 184
 185 .SH SEE ALSO
 186 .BR lspci (8),
 187 .BR pcilib (7)
 188
 189 .SH AUTHOR
 190 The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.