]> mj.ucw.cz Git - pciutils.git/blob - setpci.man
Fixed the "dist" target.
[pciutils.git] / setpci.man
1 .TH setpci 8 "@TODAY@" "@VERSION@" "Linux PCI Utilities"
2 .IX setpci
3 .SH NAME
4 setpci \- configure PCI devices
5 .SH SYNOPSIS
6 .B setpci
7 .RB [ options ]
8 .B devices
9 .BR operations ...
10
11 .SH DESCRIPTION
12 .PP
13 .B setpci
14 is a utility for querying and configuring PCI devices.
15
16 To make use of all the features of this program, you need to have Linux kernel
17 2.1.82 or newer which supports the /proc/bus/pci interface. With older kernels,
18 the PCI utilities have to use direct hardware access which is available
19 only to root and it suffers from numerous race conditions and other problems.
20
21 All numbers are entered in hexadecimal notation.
22
23 .SH OPTIONS
24 .TP
25 .B -v
26 Tells
27 .I setpci
28 to be verbose and display detailed information about configuration space accesses.
29 .TP
30 .B -f
31 Tells
32 .I setpci
33 not to complain when there's nothing to do (when no devices are selected).
34 This option is intended for use in widely-distributed configuration scripts
35 where it's uncertain whether the device in question is present in the machine
36 or not.
37 .TP
38 .B -D
39 `Demo mode' -- simulate configuration space accesses instead of really doing them.
40 It's useful to try
41 .B setpci -vD
42 to see what your complex sequence of
43 .B setpci
44 operations does before you actually execute it.
45 .TP
46 .B --version
47 Shows
48 .I setpci
49 version. This option should be used standalone.
50
51
52 .SH DEVICE SELECTION
53 .PP
54 Before each sequence of operations you need to select which devices you wish that
55 operation to affect.
56 .TP
57 .B -s [[<bus>]:][<slot>][.[<func>]]
58 Select devices in specified bus, slot and function. Each component of the device
59 address can be omitted or set as "*" meaning "any value". All numbers are
60 hexadecimal.  E.g., "0:" means all devices on bus 0, "0" means all functions of device 0
61 on any bus, "0.3" selects third function of device 0 on all busses and ".4" selects only
62 fourth function of each device.
63 .TP
64 .B -d [<vendor>]:[<device>]
65 Select devices with specified vendor and device ID. Both ID's are given in
66 hexadecimal and may be omitted or given as "*" meaning "any value".
67
68 .SH OPERATIONS
69 .PP
70 To query value of a configuration register, just name it (either by typing its name or
71 by typing register address with optional
72 .BR .B ,
73 .B .W
74 or
75 .B .L
76 suffix specifying register width as byte, word or longword).
77 .PP
78 To set a register, write
79 .BR reg = values
80 where
81 .B reg
82 is the same you would use to query the register and
83 .B values
84 is a comma-separated list of values you want to write starting with the given
85 address.
86
87 .SH REGISTER NAMES
88 .PP
89 .B setpci
90 knows the following configuration register names. See PCI bus specs for their precise
91 meaning or consult
92 .B /usr/include/linux/pci.h
93 for few comments.
94 .PP
95 .nf
96 VENDOR_ID
97 DEVICE_ID
98 COMMAND
99 STATUS
100 REVISION
101 CLASS_PROG
102 CLASS_DEVICE
103 CACHE_LINE_SIZE
104 LATENCY_TIMER
105 HEADER_TYPE
106 BIST
107 BASE_ADDRESS_0
108 BASE_ADDRESS_1
109 BASE_ADDRESS_2
110 BASE_ADDRESS_3
111 BASE_ADDRESS_4
112 BASE_ADDRESS_5
113 CARDBUS_CIS
114 SUBSYSTEM_VENDOR_ID
115 SUBSYSTEM_ID
116 ROM_ADDRESS
117 INTERRUPT_LINE
118 INTERRUPT_PIN
119 MIN_GNT
120 MAX_LAT
121 PRIMARY_BUS
122 SECONDARY_BUS
123 SUBORDINATE_BUS
124 SEC_LATENCY_TIMER
125 IO_BASE
126 IO_LIMIT
127 SEC_STATUS
128 MEMORY_BASE
129 MEMORY_LIMIT
130 PREF_MEMORY_BASE
131 PREF_MEMORY_LIMIT
132 PREF_BASE_UPPER32
133 PREF_LIMIT_UPPER32
134 IO_BASE_UPPER16
135 IO_LIMIT_UPPER16
136 BRIDGE_ROM_ADDRESS
137 BRIDGE_CONTROL
138 CB_CARDBUS_BASE
139 CB_CAPABILITIES
140 CB_SEC_STATUS
141 CB_BUS_NUMBER
142 CB_CARDBUS_NUMBER
143 CB_SUBORDINATE_BUS
144 CB_CARDBUS_LATENCY
145 CB_MEMORY_BASE_0
146 CB_MEMORY_LIMIT_0
147 CB_MEMORY_BASE_1
148 CB_MEMORY_LIMIT_1
149 CB_IO_BASE_0
150 CB_IO_BASE_0_HI
151 CB_IO_LIMIT_0
152 CB_IO_LIMIT_0_HI
153 CB_IO_BASE_1
154 CB_IO_BASE_1_HI
155 CB_IO_LIMIT_1
156 CB_IO_LIMIT_1_HI
157 CB_SUBSYSTEM_VENDOR_ID
158 CB_SUBSYSTEM_ID
159 CB_LEGACY_MODE_BASE
160
161 .SH PCILIB OPTIONS
162 The PCI utilities use PCILIB (a portable library providing platform-independent
163 functions for PCI configuration space access) to talk to the PCI cards. The following
164 options control parameters of the library, especially what access method it uses.
165 By default, PCILIB uses the first available access method and displays no debugging
166 messages. Each switch is accompanied by a list of hardware/software configurations
167 it's supported in.
168
169 .TP
170 .B -P <dir>
171 Use Linux 2.1 style configuration access to directory
172 .B <dir>
173 instead of /proc/bus/pci. (Linux 2.1 or newer only)
174 .TP
175 .B -H1
176 Use direct hardware access via Intel configuration mechanism 1. (i386 and compatible only)
177 .TP
178 .B -H2
179 Use direct hardware access via Intel configuration mechanism 2. Warning: This method
180 is able to address only first 16 devices on any bus and it seems to be very
181 unrealiable in many cases. (i386 and compatible only)
182 .TP
183 .B -S
184 Use PCI access syscalls. (Linux on Alpha and UltraSparc only)
185 .TP
186 .B -F <file>
187 Extract all information from given file containing output of lspci -x. This is very
188 useful for analysis of user-supplied bug reports, because you can display the
189 hardware configuration in any way you want without disturbing the user with
190 requests for more dumps. (All systems)
191 .TP
192 .B -G
193 Increase debug level of the library. (All systems)
194
195 .SH EXAMPLES
196 .PP
197 `setpci -d *:* latency_timer=40' sets the latency timer to 64 (40 hexadecimal).
198 .PP
199 `setpci -s 0 device_id vendor_id' lists ID's of devices in slot 0 in all busses.
200 .PP
201 `setpci -s 12:3.4 3c.l=1,2,3' writes longword 1 to register 3c, 2 to register 3d
202 and 3 to register 3e of device at bus 12, slot 3, function 4.
203
204 .SH SEE ALSO
205 .BR lspci (8)
206
207 .SH AUTHOR
208 The Linux PCI Utilities are maintained by Martin Mares <mj@ucw.cz>.