Differential D55773 Diff 173520 usr.sbin/pciconf/pciconf.8

Changeset View

Standalone View

usr.sbin/pciconf/pciconf.8

	Show All 17 Lines
	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL			.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS			.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.Dd May 19, 2025			.Dd March 10, 2026
	.Dt PCICONF 8			.Dt PCICONF 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm pciconf			.Nm pciconf
	.Nd diagnostic utility for the PCI bus			.Nd diagnostic utility for the PCI bus
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Fl l Oo Fl BbceVv Oc Op Ar device			.Fl l Oo Fl BbceVv Oc Op Ar device
	Show All 12 Lines
	.Xr pci 4			.Xr pci 4
	.Xr ioctl 2			.Xr ioctl 2
	interface.			interface.
	As such, some of the functions are only available to users with write			As such, some of the functions are only available to users with write
	access to			access to
	.Pa /dev/pci ,			.Pa /dev/pci ,
	normally only the super-user.			normally only the super-user.
	.Pp			.Pp
				A
				.Ar device
				can be identified either by a device name if the device is
				attached to a driver or by a selector.
				Selectors identify a PCI device by its address in PCI config space and
				can take one of the following forms:
				.Pp
				.Bl -bullet -offset indent -compact
				.It
				.Li pci Ns Va domain Ns \&: Ns Va bus Ns \&: Ns Va device Ns \&: \
				Ns Va function Ns
				.It
				.Li pci Ns Va bus Ns \&: Ns Va device Ns \&: Ns Va function Ns
				.It
				.Li pci Ns Va bus Ns \&: Ns Va device Ns
				.El
				.Pp
				In the case of an abridged form, omitted selector components are assumed to be 0.
				An optional leading device name followed by @ and an optional final colon
				will be ignored; this is so that the first column in the output of
				.Nm
				.Fl l
				can be used without modification.
				All numbers are base 10.
				.Ss List Mode
	With the			With the
	.Fl l			.Fl l
	option,			option,
	.Nm			.Nm
	lists PCI devices in the following format:			lists PCI devices in the following format:
	.Bd -literal			.Bd -literal
	foo0@pci0:0:4:0: class=0x010000 rev=0x01 hdr=0x00 vendor=0x1000 device=0x000f \			foo0@pci0:0:4:0: class=0x010000 rev=0x01 hdr=0x00 vendor=0x1000 device=0x000f \
	subvendor=0x0000 subdevice=0x0000			subvendor=0x0000 subdevice=0x0000
	▲ Show 20 Lines • Show All 192 Lines • ▼ Show 20 Lines
	.Pp			.Pp
	If the optional			If the optional
	.Ar device			.Ar device
	argument is given with the			argument is given with the
	.Fl l			.Fl l
	flag,			flag,
	.Nm			.Nm
	will only list details about a single device instead of all devices.			will only list details about a single device instead of all devices.
	.Pp			.Ss Device Information Modes
	All invocations of
	.Nm
	except for
	.Fl l
	require a
	.Ar device .
	The device can be identified either by a device name if the device is
	attached to a driver or by a selector.
	Selectors identify a PCI device by its address in PCI config space and
	can take one of the following forms:
	.Pp
	.Bl -bullet -offset indent -compact
	.It
	.Li pci Ns Va domain Ns \&: Ns Va bus Ns \&: Ns Va device Ns \&: \
	Ns Va function Ns
	.It
	.Li pci Ns Va bus Ns \&: Ns Va device Ns \&: Ns Va function Ns
	.It
	.Li pci Ns Va bus Ns \&: Ns Va device Ns
	.El
	.Pp
	In the case of an abridged form, omitted selector components are assumed to be 0.
	An optional leading device name followed by @ and an optional final colon
	will be ignored; this is so that the first column in the output of
	.Nm
	.Fl l
	can be used without modification.
	All numbers are base 10.
	.Pp
	With the			With the
	.Fl a			.Fl a
	flag,			flag,
	.Nm			.Nm
	determines whether any driver has been assigned to the device			determines whether any driver has been assigned to the device
	identified by			identified by
	.Ar selector .			.Ar selector .
	An exit status of zero indicates that the device has a driver;			An exit status of zero indicates that the device has a driver;
	▲ Show 20 Lines • Show All 112 Lines • Show Last 20 Lines