HPlogo HP-UX Reference > I

ioscan(1M)

HP-UX 11i Version 2: December 2007 Update
» 

Technical documentation

 » Table of Contents

 » Index

NAME

ioscan — scan I/O system

SYNOPSIS

/usr/sbin/ioscan [-k|-u] [-e] [-d driver|-C class] [-I instance] [-H hw_path] [-f[-n ]|-F[-n]] [devfile]

/usr/sbin/ioscan -M driver -H hw_path [-I instance]

/usr/sbin/ioscan -t

DESCRIPTION

ioscan scans system hardware, usable I/O system devices, or kernel I/O system data structures as appropriate, and lists the results. For each hardware module on the system, ioscan displays by default the hardware path to the hardware module, the class of the hardware module, and a brief description.

By default, ioscan scans the system and lists all reportable hardware found. The types of hardware reported include processors, memory, interface cards and I/O devices. Scanning the hardware may cause drivers to be unbound and others bound in their place in order to match actual system hardware. Entities that cannot be scanned are not listed.

In the second form shown, ioscan forces the specified software driver into the kernel I/O system at the given hardware path and forces software driver to be bound. This can be used to make the system recognize a device that cannot be recognized automatically; for example, because it has not yet been connected to the system, does not support autoconfiguration, or because diagnostics need to be run on a faulty device.

In the third form, ioscan displays the date and time at which system hardware was last scanned.

  • Note: The -t option cannot be used with any other options available for this command.

Generally, ioscan requires superuser privileges. A non root user may use the -k option, only to display the kernel hardware tree. Driver binding and actual hardware scanning is restricted to root.

Options

ioscan recognizes the following options:

-C class

Restrict the output listing to those devices belonging to the specified class. Cannot be used with -d.

-d driver

Restrict the output listing to those devices controlled by the specified driver. Cannot be used with -C.

-e

Display EFI (Extensible Firmware Interface) device paths when available.

-f

Generate a full listing, displaying the module's class, instance number, hardware path, driver, software state, hardware type, and a brief description.

-F

Produce a compact listing of fields (described below), separated by colons. This option overrides the -f option.

-H hw_path

Restrict the scan and output listing to those devices connected at the specified hardware path. The hardware path must be a bus path. Scanning below the bus level will not probe the hardware and may produce incorrect results. For example, specifying the path at the target level will always change the state of the device attached to it as NO_HW. The state of the device may be restored by retrying ioscan from a bus node above the NO_HW node. When used with -M, this option specifies the full hardware path at which to bind the software modules.

-I instance

Restrict the scan and output listing to the specified instance, when used with either -d or -C. When used with -M, specifies the desired instance number for binding.

-k

Scan kernel I/O system data structures instead of the actual hardware and list the results. No binding or unbinding of drivers is performed. The -d, -C, -I, and -H options can be used to restrict listings. Cannot be used with -u. This option does not require superuser privileges.

-M driver

Specify the software driver to bind at the hardware path given by the -H option. Must be used with the -H option.

-n

List device file names in the output. Only special files in the /dev directory and its subdirectories are listed.

-t

Display the date and time at which the system hardware was last scanned. The output of the ioscan command used with this option is as follows: Fri Nov 22 11:22:21 2002

-u

Scan and list usable I/O system devices instead of the actual hardware. Usable I/O devices are those having a driver in the kernel and an assigned instance number. The -d, -C, -I, and -H options can be used to restrict listings. The -u option cannot be used with -k.

The -d and -C options can be used to obtain listings of subsets of the I/O system, although the entire system is still scanned. Specifying -d or -C along with -I, or specifying -H or a devfile causes ioscan to restrict both the scan and the listing to the hardware subset indicated.

Fields

The -F option can be used to generate a compact listing of fields separated by colons (:), useful for producing custom listings with awk. Fields include the module's bus type, cdio, is_block, is_char, is_pseudo, block major number, character major number, minor number, class, driver, hardware path, identify bytes, instance number, module path, module name, software state, hardware type, a brief description, and card instance. If a field does not exist, consecutive colons hold the field's position. Fields are defined as follows:

class

A device category, defined in the files located in the directory /usr/conf/master.d and consistent with the listings output by lsdev (see lsdev(1M)). Examples are disk, printer, and tape.

instance

The instance number associated with the device or card. It is a unique number assigned to a card or device within a class. If no driver is available for the hardware component or an error occurs binding the driver, the kernel will not assign an instance number and a (-1), is listed.

hw path

A numerical string of hardware components, notated sequentially from the bus address to the device address. Typically, the initial number is appended by slash (/), to represent a bus converter (if required by your machine), and subsequent numbers are separated by periods (.). Each number represents the location of a hardware component on the path to the device.

driver

The name of the driver that controls the hardware component. If no driver is available to control the hardware component, a question mark (?) is displayed in the output.

software state

The result of software binding.

CLAIMED

software bound successfully

UNCLAIMED

no associated software found

SUSPENDED

associated software and hardware is in suspended state

DIFF_HW

software found does not match the associated software

NO_HW

the hardware at this address is no longer responding

ERROR

the hardware at this address is responding but is in an error state

SCAN

node locked, try again later

hardware type

Entity identifier for the hardware component. It is one of the following strings:

UNKNOWN

There is no hardware associated or the type of hardware is unknown

PROCESSOR

Hardware component is a processor

MEMORY

Hardware component is memory

BUS_NEXUS

Hardware component is bus converter or bus adapter

INTERFACE

Hardware component is an interface card

DEVICE

Hardware component is a device

bus type

Bus type associated with the node.

cdio

The name associated with the Context-Dependent I/O module.

is_block

A boolean value indicating whether a device block major number exists. A T or F is generated in this field.

is_char

A boolean value indicating whether a device character major number exists. A T or F is generated in this field.

is_pseudo

A boolean value indicating a pseudo driver. A T or F is generated in this field.

block major

The device block major number. A -1 indicates that a device block major number does not exist.

character major

The device character major number. A -1 indicates that a device character major number does not exist.

minor

The device minor number.

identify bytes

The identify bytes returned from a module or device.

module path

The software components separated by periods (.).

module name

The module name of the software component controlling the node.

description

A description of the device.

card instance

The instance number of the hardware interface card.

RETURN VALUE

ioscan returns 0 upon normal completion and 1 if an error occurred.

EXAMPLES

Scan the system hardware and list all the devices belonging to the disk device class.

ioscan -C disk

Forcibly bind driver tape2 at the hardware path 8.4.1.

ioscan -M tape2 -H 8.4.1

AUTHOR

ioscan was developed by HP.

FILES

/dev/config /dev/*