[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY pciutils-download-http "&kernel-dl;/software/utils/pciutils/pciutils-&pciutils-version;.tar.xz">
|
---|
[303d9be] | 8 | <!ENTITY pciutils-download-ftp " ">
|
---|
[1c37eb5] | 9 | <!ENTITY pciutils-md5sum "72ba4ca1eed8b2972a785ee5aac0b138">
|
---|
| 10 | <!ENTITY pciutils-size "401 KB">
|
---|
| 11 | <!ENTITY pciutils-buildsize "4.7 MB">
|
---|
[049ffc5] | 12 | <!ENTITY pciutils-time "less than 0.1 SBU">
|
---|
[52d29f7] | 13 | ]>
|
---|
| 14 |
|
---|
[4890200] | 15 | <sect1 id="pciutils" xreflabel="pciutils-&pciutils-version;">
|
---|
[a9a6837e] | 16 | <?dbhtml filename="pciutils.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
[4890200] | 22 | <title>pciutils-&pciutils-version;</title>
|
---|
[a9a6837e] | 23 |
|
---|
| 24 | <indexterm zone="pciutils">
|
---|
[4890200] | 25 | <primary sortas="a-pciutils">pciutils</primary>
|
---|
[a9a6837e] | 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
[564851b] | 29 | <title>Introduction to PCI Utils</title>
|
---|
[a9a6837e] | 30 |
|
---|
[564851b] | 31 | <para>
|
---|
| 32 | The <application>PCI Utils</application> package contains
|
---|
| 33 | a set of programs for listing PCI devices, inspecting
|
---|
| 34 | their status and setting their configuration registers.
|
---|
| 35 | </para>
|
---|
[a9a6837e] | 36 |
|
---|
[48cb482] | 37 | &lfs112_checked;
|
---|
[fd91fea] | 38 |
|
---|
[a9a6837e] | 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[564851b] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&pciutils-download-http;"/>
|
---|
| 44 | </para>
|
---|
[2a05c87] | 45 | </listitem>
|
---|
[a9a6837e] | 46 | <listitem>
|
---|
[564851b] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&pciutils-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[a9a6837e] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[564851b] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &pciutils-md5sum;
|
---|
| 54 | </para>
|
---|
[a9a6837e] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[564851b] | 57 | <para>
|
---|
| 58 | Download size: &pciutils-size;
|
---|
| 59 | </para>
|
---|
[a9a6837e] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[564851b] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &pciutils-buildsize;
|
---|
| 64 | </para>
|
---|
[a9a6837e] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[564851b] | 67 | <para>
|
---|
| 68 | Estimated build time: &pciutils-time;
|
---|
| 69 | </para>
|
---|
[a9a6837e] | 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
[eae7f55] | 72 | <!-- Needed to update the pci-ids. systemd has a unit and timer for this,
|
---|
| 73 | but for anyone who updates this file on either platform, it's needed
|
---|
| 74 | to download the pci.ids file. -->
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect3">pciutils Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 79 | <para role="recommended">
|
---|
| 80 | <xref linkend="curl"/>,
|
---|
[cac7f93] | 81 | <xref linkend="wget"/>, or
|
---|
| 82 | <xref linkend="lynx"/>
|
---|
[eae7f55] | 83 | (for the update-pciids script to function correctly).
|
---|
| 84 | </para>
|
---|
[a9a6837e] | 85 |
|
---|
[1039de3] | 86 | <para condition="html" role="usernotes">User Notes:
|
---|
[564851b] | 87 | <ulink url="&blfs-wiki;/pciutils"/>
|
---|
| 88 | </para>
|
---|
[2969aa8] | 89 | </sect2>
|
---|
| 90 |
|
---|
[143ed74] | 91 | <sect2 role="installation">
|
---|
[564851b] | 92 | <title>Installation of PCI Utils</title>
|
---|
[143ed74] | 93 |
|
---|
[c503fad7] | 94 | <para>
|
---|
[564851b] | 95 | Install <application>PCI Utils</application> by
|
---|
[c503fad7] | 96 | running the following commands:
|
---|
| 97 | </para>
|
---|
[a9a6837e] | 98 |
|
---|
[94f93146] | 99 | <screen><userinput>make PREFIX=/usr \
|
---|
| 100 | SHAREDIR=/usr/share/hwdata \
|
---|
[857e2fb] | 101 | SHARED=yes</userinput></screen>
|
---|
[a9a6837e] | 102 |
|
---|
[c503fad7] | 103 | <para>
|
---|
| 104 | This package does not come with a test suite.
|
---|
| 105 | </para>
|
---|
[f6f06932] | 106 |
|
---|
[c503fad7] | 107 | <para>
|
---|
| 108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 109 | </para>
|
---|
[a9a6837e] | 110 |
|
---|
[7089c646] | 111 | <screen role="root"><userinput>make PREFIX=/usr \
|
---|
[94f93146] | 112 | SHAREDIR=/usr/share/hwdata \
|
---|
| 113 | SHARED=yes \
|
---|
| 114 | install install-lib &&
|
---|
[5f26d66f] | 115 |
|
---|
[857e2fb] | 116 | chmod -v 755 /usr/lib/libpci.so</userinput></screen>
|
---|
[fd91fea] | 117 |
|
---|
[a9a6837e] | 118 | </sect2>
|
---|
| 119 |
|
---|
[0829916] | 120 | <sect2 role="commands">
|
---|
| 121 | <title>Command Explanations</title>
|
---|
| 122 |
|
---|
[c503fad7] | 123 | <para>
|
---|
| 124 | <parameter>SHARED=yes</parameter>: This parameter enables building of
|
---|
[d900e405] | 125 | the shared library instead of the static one.
|
---|
[c503fad7] | 126 | </para>
|
---|
[2a05c87] | 127 |
|
---|
[c503fad7] | 128 | <para>
|
---|
[857e2fb] | 129 | <option>ZLIB=no</option>: This option prevents compression of
|
---|
[564851b] | 130 | the <filename>pci.ids</filename> file.
|
---|
[c503fad7] | 131 | </para>
|
---|
[2a05c87] | 132 |
|
---|
[0829916] | 133 | </sect2>
|
---|
| 134 |
|
---|
[c0913c4] | 135 | <sect2 role="configuration">
|
---|
[564851b] | 136 | <title>Configuring PCI Utils</title>
|
---|
| 137 |
|
---|
| 138 | <para>
|
---|
| 139 | The <filename>pci.ids</filename> data file is constantly being
|
---|
| 140 | updated. To get a current version of this file, run
|
---|
| 141 | <command>update-pciids</command> as the <systemitem
|
---|
| 142 | class="username">root</systemitem> user. This program requires the
|
---|
| 143 | <xref linkend="which"/> script or program to find <xref linkend="curl"/>,
|
---|
[1c37eb5] | 144 | <xref linkend="lynx"/>, or <xref linkend="wget"/> which are used to
|
---|
[564851b] | 145 | download the most current file, and then replace the existing file in
|
---|
[7b6d7cd] | 146 | <filename class="directory">/usr/share/hwdata</filename>.
|
---|
[564851b] | 147 | </para>
|
---|
| 148 |
|
---|
[b471f6a] | 149 | <para>
|
---|
[ac8c7d4] | 150 | You should update the <filename>/usr/share/hwdata/pci.ids</filename> file
|
---|
[b471f6a] | 151 | periodically. <phrase revision="sysv">If you've installed
|
---|
| 152 | <xref linkend="fcron"/> and completed the section on periodic jobs,
|
---|
| 153 | execute</phrase><phrase revision="systemd">Execute</phrase> the following
|
---|
| 154 | commands, as the <systemitem class="username">root</systemitem> user,
|
---|
| 155 | to create a <phrase revision="sysv">weekly cron job:</phrase>
|
---|
| 156 | <phrase revision="systemd">systemd timer to update it weekly on Sundays
|
---|
| 157 | at 2:30 A.M. (local time):</phrase>
|
---|
[ac8c7d4] | 158 | </para>
|
---|
| 159 |
|
---|
[914dd13] | 160 | <screen role="nodump" revision="sysv"><userinput>cat > /etc/cron.weekly/update-pciids.sh << "EOF" &&
|
---|
[b471f6a] | 161 | <literal>#!/bin/bash
|
---|
| 162 | /usr/sbin/update-pciids</literal>
|
---|
| 163 | EOF
|
---|
[02e3bbc8] | 164 | chmod 754 /etc/cron.weekly/update-pciids.sh</userinput></screen>
|
---|
[b471f6a] | 165 |
|
---|
[d0d2c85a] | 166 | <screen role="root" revision="systemd"><userinput>cat > /usr/lib/systemd/system/update-pciids.service << "EOF" &&
|
---|
[ac8c7d4] | 167 | <literal>[Unit]
|
---|
| 168 | Description=Update pci.ids file
|
---|
| 169 | Documentation=man:update-pciids(8)
|
---|
| 170 | DefaultDependencies=no
|
---|
[a5b9f1e] | 171 | After=local-fs.target network-online.target
|
---|
[ac8c7d4] | 172 | Before=shutdown.target
|
---|
| 173 |
|
---|
| 174 | [Service]
|
---|
| 175 | Type=oneshot
|
---|
| 176 | RemainAfterExit=yes
|
---|
| 177 | ExecStart=/usr/sbin/update-pciids</literal>
|
---|
| 178 | EOF
|
---|
[d0d2c85a] | 179 | cat > /usr/lib/systemd/system/update-pciids.timer << "EOF" &&
|
---|
[ac8c7d4] | 180 | <literal>[Unit]
|
---|
| 181 | Description=Update pci.ids file weekly
|
---|
| 182 |
|
---|
| 183 | [Timer]
|
---|
| 184 | OnCalendar=Sun 02:30:00
|
---|
| 185 | Persistent=true
|
---|
| 186 |
|
---|
| 187 | [Install]
|
---|
| 188 | WantedBy=timers.target</literal>
|
---|
| 189 | EOF
|
---|
[df9499b] | 190 | systemctl enable update-pciids.timer</userinput></screen>
|
---|
[ac8c7d4] | 191 |
|
---|
| 192 |
|
---|
[c0913c4] | 193 | </sect2>
|
---|
| 194 |
|
---|
[a9a6837e] | 195 | <sect2 role="content">
|
---|
| 196 | <title>Contents</title>
|
---|
| 197 |
|
---|
| 198 | <segmentedlist>
|
---|
| 199 | <segtitle>Installed Programs</segtitle>
|
---|
[1ed12e2d] | 200 | <segtitle>Installed Library</segtitle>
|
---|
| 201 | <segtitle>Installed Directory</segtitle>
|
---|
[a9a6837e] | 202 |
|
---|
| 203 | <seglistitem>
|
---|
[564851b] | 204 | <seg>
|
---|
[29efd929] | 205 | lspci, setpci, and update-pciids
|
---|
[564851b] | 206 | </seg>
|
---|
| 207 | <seg>
|
---|
| 208 | libpci.so
|
---|
| 209 | </seg>
|
---|
| 210 | <seg>
|
---|
[29efd929] | 211 | /usr/include/pci and /usr/share/hwdata
|
---|
[564851b] | 212 | </seg>
|
---|
[a9a6837e] | 213 | </seglistitem>
|
---|
| 214 | </segmentedlist>
|
---|
| 215 |
|
---|
| 216 | <variablelist>
|
---|
| 217 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 218 | <?dbfo list-presentation="list"?>
|
---|
| 219 | <?dbhtml list-presentation="table"?>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="lspci">
|
---|
| 222 | <term><command>lspci</command></term>
|
---|
| 223 | <listitem>
|
---|
[564851b] | 224 | <para>
|
---|
[73fe507] | 225 | is a utility for displaying information about all PCI buses
|
---|
[4c24eb0a] | 226 | in the system and all devices connected to them
|
---|
[564851b] | 227 | </para>
|
---|
[a9a6837e] | 228 | <indexterm zone="pciutils lspci">
|
---|
| 229 | <primary sortas="b-lspci">lspci</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
| 233 |
|
---|
| 234 | <varlistentry id="setpci">
|
---|
| 235 | <term><command>setpci</command></term>
|
---|
| 236 | <listitem>
|
---|
[564851b] | 237 | <para>
|
---|
[4c24eb0a] | 238 | is a utility for querying and configuring PCI devices
|
---|
[564851b] | 239 | </para>
|
---|
[a9a6837e] | 240 | <indexterm zone="pciutils setpci">
|
---|
| 241 | <primary sortas="b-setpci">setpci</primary>
|
---|
| 242 | </indexterm>
|
---|
| 243 | </listitem>
|
---|
| 244 | </varlistentry>
|
---|
| 245 |
|
---|
| 246 | <varlistentry id="update-pciids">
|
---|
| 247 | <term><command>update-pciids</command></term>
|
---|
| 248 | <listitem>
|
---|
[564851b] | 249 | <para>
|
---|
[eae7f55] | 250 | fetches the current version of the PCI ID list. <!-- Requires
|
---|
[564851b] | 251 | <xref linkend="curl"/>, <xref linkend="lynx"/> or
|
---|
| 252 | <xref linkend="wget"/>.
|
---|
[eae7f55] | 253 | -->
|
---|
[564851b] | 254 | </para>
|
---|
[a9a6837e] | 255 | <indexterm zone="pciutils update-pciids">
|
---|
| 256 | <primary sortas="b-update-pciids">update-pciids</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 |
|
---|
[38ec4bf] | 261 | <varlistentry id="libpci">
|
---|
[4890200] | 262 | <term><filename class="libraryfile">libpci.so</filename></term>
|
---|
[38ec4bf] | 263 | <listitem>
|
---|
[564851b] | 264 | <para>
|
---|
| 265 | is library that allows applications to access the PCI
|
---|
[4c24eb0a] | 266 | subsystem
|
---|
[564851b] | 267 | </para>
|
---|
[38ec4bf] | 268 | <indexterm zone="pciutils libpci">
|
---|
[2a05c87] | 269 | <primary sortas="c-libpci">libpci.so</primary>
|
---|
[38ec4bf] | 270 | </indexterm>
|
---|
| 271 | </listitem>
|
---|
| 272 | </varlistentry>
|
---|
| 273 |
|
---|
[a9a6837e] | 274 | </variablelist>
|
---|
| 275 |
|
---|
| 276 | </sect2>
|
---|
[f45b1953] | 277 |
|
---|
| 278 | </sect1>
|
---|