Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
ioscan(1M)							    ioscan(1M)

       ioscan -	scan I/O system

       driver|class] instance] hw_path]	]|[devfile]


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

       By  default,  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, 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	autoconfigura-
       tion, or	because	diagnostics need to be run on a	faulty device.

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

       recognizes the following	options:

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

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

	      Generate a full listing, displaying the module's class,
				instance number, hardware path,	driver,	 soft-
				ware  state,  hardware	type,  and a brief de-

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

	      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	incor-
				rect results. For example, specifying the path
				at the target level  will  always  change  the
				state  of  the device attached to it as	NO_HW.
				When used with this option specifies the  full
				hardware  path	at  which to bind the software

	      Restrict the scan	and output listing to the specified instance,
				when used with either or When used with	speci-
				fies the desired instance number for binding.

	      Scan kernel	I/O  system data structures instead of the ac-
				tual hardware and list the results.  No	 bind-
				ing or unbinding of drivers is performed.  The
				and options can	be used	to restrict  listings.
				Cannot	be  used with This option does not re-
				quire superuser	privileges.

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

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

	      Scan and list usable
				I/O system devices instead of the actual hard-
				ware.	Usable	I/O devices are	those having a
				driver in the kernel and an assigned  instance
				number.	  The  and  options can	be used	to re-
				strict listings.  The option  cannot  be  used

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

       The option can be used to generate a compact listing  of	 fields	 sepa-
       rated  by  colons (:), useful for producing custom listings with	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 and consistent with the listings
			     output by (see lsdev(1M)).	 Examples are and

	      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	avail-
			     able for the hardware component or	an  error  oc-
			     curs  binding the driver, the kernel will not as-
			     sign an instance number and a is listed.

	      hw path	     A numerical string	of  hardware  components,  no-
			     tated  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 rep-
			     resents 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 dis-
			     played in the output.

	      software state The result	of software binding.

			     software bound successfully

			     no	associated software found

			     software found  does  not	match  the  associated

			     the  hardware  at	this  address is no longer re-

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

			     node locked, try again later

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

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

			     Hardware component	is a processor

			     Hardware component	is memory

			     Hardware	component  is  bus  converter  or  bus

			     Hardware component	is an interface	card

			     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 or is  generated  in  this

	      is_char	     A boolean value indicating	whether	a device char-
			     acter major number	exists.	A or is	 generated  in
			     this field.

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

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

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

	      minor	     The device	minor number.

	      identify bytes The  identify bytes returned from a module	or de-

	      module path    The software components separated by periods (.).

	      module name    The module	name of	the  software  component  con-
			     trolling the node.

	      description    A description of the device.

	      card instance  The  instance  number  of	the hardware interface

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

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

       Forcibly	bind driver at the hardware path

       was developed by	HP.

       config(1M), lsdev(1M), ioconfig(4).



Want to link to this manual page? Use this URL:

home | help