manpages.info - online man pages   

SunOS man pages : cfgadm_pci (1)

Maintenance Commands                               cfgadm_pci(1M)

NAME

cfgadm_pci - PCI Hotplug hardware specific commands for cfgadm

SYNOPSIS

/usr/sbin/cfgadm [ -f ] [ -y | -n ] [ -v ] [ -o hardware_options ] -c function ap_id [ ap_id ] /usr/sbin/cfgadm [ -f ] [ -y | -n ] [ -v ] [ -o hardware_options ] -x hardware_function ap_id [ ap_id ] /usr/sbin/cfgadm [ -v ] [ -s listing_options ] [ -o hardware_options ] [ -l [ ap_id | ap_type ] ] /usr/sbin/cfgadm [ -v ] [ -o harware_options ] -t ap_id [ ap_id ] /usr/sbin/cfgadm [ -v ] [ -o hardware_function ] -h [ ap_id| ap_type ]

DESCRIPTION

The PCI hardware specific library /usr/lib/cfgadm/pci.so.1 provides the support for hot plugging pci adapter cards into pci hot pluggible slots in a system that is hot plug capa- ble, through cfgadm(1M). See cfgadm(1M). For PCI Hot Plug, each hot plug slot on a specific PCI bus is represented by an attachment point of that specific PCI bus. An attachment point consist of two parts: a receptacle and an occupant. The receptacle under PCI hot plug is usually referred to as the physical ho tpluggible slot; and the occupant is usually referred to as the PCI adapter card that plugs into the slot. Attachment points are named through ap_ids. There are two types of ap_ids: logical and physical. The physical ap_id is based on the physical pathname, that is, /devices/pci@1/hpc0_slot3, whereas the logical ap_id is a shorter, and more user-friendly name. For PCI hot pluggible slots, the logical ap_id is usually the corresponding hot plug controller driver name plus the logical slot number, that is, pci0:hpc0slot1; pci nexus driver, with hot plug controller driver named hpc and slot number 1. The ap_type for Hot plug PCI is pci. See the System Administration Guide, Volume I for a detailed description of the hot plug procedure.

OPTIONS

SunOS 5.8 Last change: 10 Nov 1999 1 Maintenance Commands cfgadm_pci(1M) The following options are supported: -c function The following functions are supported for PCI hot pluggible slots: configure Configure the PCI device in the slot to be used by Solaris. connect Connect the slot to PCI bus. disconnect Disconnect the slot from the PCI bus. insert Perform operations required to allow manual insertion of a PCI device. remove Perform operations required to allow manual removal of a PCI device. unconfigure Logically remove the PCI device's resources from the system. -f Not supported. -h ap_id | ap_type" 6 Print out PCI hot plug specific help message. -l list List the values of PCI Hot Plug slots. -o hardware_options No hardware specific options are currently defined. -s listing_options Same as the generic cfgadm(1M).. -t ap_id This command is only supported on platform which supports testing capability on the slot. -v Execute in verbose mode. SunOS 5.8 Last change: 10 Nov 1999 2 Maintenance Commands cfgadm_pci(1M) When -v is used with -l option the cfgadm command outputs information about the attachment point. For PCI Hot Plug, the Information field will be the slot's system label. This string will be obtained from the slot-name property of the slot's bus node. The occupant Type field will describe the contents of the slot. There are 2 possible values: NULL The slot is empty subclass,board The card in the slot is either a single- function or multi-function device. subclass is a string representing the sub- class code of the device, for example, SCSI, ethernet, pci-isa, and so forth. If the card is a multi-functional device, MULT will get printed instead. board is a string representing the board type of the device, for example, HP for PCI Hot Plug adapter, HS for Hot Swap Board, NHS for Non-Hot Swap cPCI Board, BHS for Basic Hot Swap cPCI Board, FHS for Full Hot Swap cPCI Board. -x hardware_function Perform hardware specific function. These hardware specific functions should not normally change the state of a receptacle or occupant. The following hardware_functions are supported: enable_slot | disable_slot Change the state of the slot and preserve the state of slot across reboot. Not all platforms support this feature. enable_slot enables the addition of hardware to this slot for hot plugging and at boot time. disable_slot disables the addition of hardware to this slot for hot plugging and at boot time. enable_autoconfig | disable_autoconfig Change the ability to autoconfigure the occupant of the slot. Only platforms that support auto configuration support this feature. SunOS 5.8 Last change: 10 Nov 1999 3 Maintenance Commands cfgadm_pci(1M) enable_autoconfig enables the ability to auto- configure the slot. diable_autoconfig disables the ability to auto- configure the slot. led=[led_sub_arg],mode=[mode_sub_arg] Without sub-arguments, print a list of the current LED settings. With sub-arguments, set the mode of a specific LED for a slot. Specify led_sub_arg as fault, power, att, or active. Specify mode_sub_arg as on, off or blink. Changing the state of the LED does not change the state of the receptacle or occupant. Nor- mally, the LEDs are controlled by the hot plug controller, no user intervention is necessary. Use this command for testing purposes. Caution: Changing the state of the LED can misrepresent the state of occupant or receptacle. The following command prints the values of LEDs: example# cfgadm -x led pci0:hpc0_slot1 Ap_Id Led pci0:hpc0_slot1 power=on,fault=off,active=off,attn=off The following command turns on the Fault LED: example# cfgadm -x led=fault,mode=on pci0:hpc0_slot1 The following command turns off the Power LED: example# cfgadm -x led=power,mode=off pci0:hpc0_slot0 The following command sets the active LED to blink to indicate the location of the slot: SunOS 5.8 Last change: 10 Nov 1999 4 Maintenance Commands cfgadm_pci(1M) example# cfgadm -x led=active,mode=on pci0:hpc0_slot3

EXAMPLES

Example 1: Printing out the value of each slot The following command prints out the values of each slot: example# cfgadm -l Ap_Id Type Receptacle Occupant Condition pci1:hpc0_slot0 unknown empty unconfigured unknown pci1:hpc0_slot1 unknown empty unconfigured unknown pci1:hpc0_slot2 unknown empty unconfigured unknown pci1:hpc0_slot3 HP/SCSI connected configured ok pci1:hpc0_slot4 unknown empty unconfigured unknown Example 2: Printing out PCI hot plug specific commands The following command prints out PCI hot plug specific com- mands: example# cfgadm -h pci Uage: cfgadm [-f] [-y|-n] [-v] [-o hardware_opts ] -c function ap_id [ap_id...] cfgadm [-f] [-y|-n] [-v] [-o hardware_opts ] -x function ap_id [ap_id...] cfgadm [-v] [-s listing_options ] [-o hardware_opts ] [-a] [-l [ap_id|ap_type...]] cfgadm [-v] [-o hardware_opts ] -t ap_id [ap_id...] cfgadm [-v] [-o hardware_opts ] -h [ap_id|ap_type...] PCI hotplug specific commands: -c [connect|disconnect|configure|unconfigure|insert|remove] ap_id [ap_id...] -x enable_slot ap_id [ap_id...] -x disable_slot ap_id [ap_id...] -x enable_autoconfig ap_id [ap_id...] -x disable_autoconfig ap_id [ap_id...] -x led[=[fault|power|active|attn],mode=[on|off|blink]] ap_id [ap_id...]

FILES

/usr/lib/cfgadm/libpci.so.1 Hardware specific library for PCI hot plugging.

ATTRIBUTES

SunOS 5.8 Last change: 10 Nov 1999 5 Maintenance Commands cfgadm_pci(1M) See attributes(5) for descriptions of the following attri- butes: ____________________________________________________________ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |_____________________________|_____________________________| | Availability | SUNWkvm.u | |_____________________________|_____________________________|

SEE ALSO

cfgadm(1M), config_admin(3CFGADM), libcfgadm(4)attributes(5) System Administration Guide, Volume 1 SunOS 5.8 Last change: 10 Nov 1999 6