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