pcitool.1m revision d5ace9454616652a717c9831d949dffa319381f9
CDDL HEADER START

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]

CDDL HEADER END

Copyright 2009 Sun Microsystems, Inc. All rights reserved.
Use is subject to license terms.
pcitool 1M
"NAME"
pcitool - interrupt routing tool
"SYNOPSIS"

/usr/sbin/pcitool PCI_nexus_node -i ino=ino [ -r [ -c ] | -w cpu=CPU [ -g ] ] [ -v ] [ -q ] /usr/sbin/pcitool [ -h ]

"DESCRIPTION"

PCItool is a low-level tool which provides a facility for getting and setting interrupt routing information.

Interrupt Routing
The pcitool -i command displays device and CPU routing information for all inos on a given nexus, and allows rerouting of a given ino or ino group to a specific CPU. Required privileges The user must have all privileges in order to access interrupt information. A regular user can access interrupt information when su(1M) to root or granted the "Maintenance and Repair" rights profile in the user_attr file. See user_attr(4) and rbac(5). Commandline options -r [ -c ] Display device and CPU routing information for inos on a given nexus. The device path and instance number of each device for each displayed ino will be shown. On some platforms (e.g. Fire) interrupts dedicated to the root complex are indicated with "(Internal)" appended to their pathname. Dump interrupt controller information with -c. If neither -r nor -w are provided on the commandline, -r is assumed. The command for showing all inos on /pci@8,700000 is: # pcitool /pci@8,700000 -i The command for showing ino 0x23 on the same root nexus, along with sample output, is: # pcitool /pci@8,700000 -i ino=23 ino 23 on ctlr 0 mapped to cpu 0 Device: /pci@8,700000/ebus@5/i2c@1,30 Driver: pcf8584, instance 1 Device: /pci@8,700000/ebus@5/i2c@1,2e Driver: pcf8584, instance 0 -w cpu=hex_CPU [ -g ] Route the given ino to the given CPU. Display the new and original routing information. The ino must be specified. Successful rerouting ino 23 above from cpu 0 to cpu 1 gives the following output: # pcitool /pci@8,700000 -i ino=23 -w cpu=1 Interrupts on ino 23 reassigned: Old cpu:0, New cpu:1 On some platforms (such as X86) multiple MSI interrupts of a single function need to be rerouted together. Use -g to do this. -g works only on supported platforms and only for groups of MSI interrupts. (A "group" of 1 is accepted.) When -g is used, the vector provided must be the lowest-numbered vector of the group. The size of the group is determined internally. Successful rerouting a group of inos starting at 60 from cpu 0 to cpu 1 gives the following output: # pcitool /pci@0,0 -i ino=60 -w cpu=1 -g Interrupts on ino group starting at ino 60 reassigned: Old cpu:0, New cpu:1 -v Verbose output. -q No errors reported as messages. Unix error status still returned by program, however.
EXIT STATUS
The following error statuses are returned to the shell:

0 No error

EINVAL Out-of-range, misaligned or otherwise invalid argument has been passed in.

ETIME Timeout waiting for pending interrupt to settle before changing interrupts to a new CPU.

EIO An IO error occurred.

FILES
/usr/sbin/pcitool
"ATTRIBUTES"

See attributes(5) for descriptions of the following attributes: _________________________________________________________ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |______________________|__________________________________| | Architecture | PCI-based systems | |______________________|__________________________________| | Availability | SUNWio-tools | |______________________|__________________________________| | Interface Stability | Volatile | |______________________|__________________________________|

SEE ALSO
pci(4), su(1M), user_attr(4), rbac(5)
NOTES
All values are entered in hex. Not all commands are applicable to all platforms. REFERENCES PCI specification (available from www.pcisig.org)