

System Administration Commands                     cfgadm_fw(1M)


NAME
     cfgadm_fw - cfgadm commands for ACPI based system devices on x86 plaform

SYNOPSIS
     cfgadm  -l [-a] <apid>

     cfgadm  -c  <function> [-f] [-y | -n] [-v]  <apid>

SYNOPSIS

     The cfgadm_fw plugin provides dynamic reconfiguration func-
     tionality  for  connecting,  configuring, unconfiguring, and
     disconnecting class fw system devices. It also  enables  you
     to  connect or disconnect a system device from a running sys-
     tem without having to reboot the system.

     The cfgadm command resides in /usr/sbin. See cfgadm(1M). The
     cfgadm_fw plugin resides /usr/platform/i86pc/lib/cfgadm.

     Each dynamically reconfigurable device appears as a single
     attachment point in  the device  tree. Each component
     appears as a dynamic attachment point. You can view the type,
     state, and condition  of  each component,  and  the
     states and condition of each device slot
     by using the -a option.

     The cfgadm options  perform  differently  depending  on  the
     platform. Additionally, the form of the attachment points is
     different depending on the platform. See the Platform  Notes
     section for more information.

 Device Conditions
     The following are the names and  descriptions  of  the  device
     conditions:
     failed     The component failed testing.
     ok         The component is operational.
     unknown    The component has not been tested.

  Device States

     The following are the names and descriptions of the recepta-
     cle states for devices:

     empty         Device is not present.

     connected     The device is powered on and connected  to  the
                   system  bus.  You can view the components on a
                   device only after it is in the connected state.


     disconnected  The device is disconnected from the system bus.


     Caution: Removing a device that is in the connected state can
     crash the operating system and can result in permanent damage
     to the system.

     The occupant state of a disconnected device is always  uncon-
     figured.   The   following  table  contains  the  names  and
     descriptions of the occupant states for devices:

     configured    At least one component on the device is config-
                   ured.

     unconfigured  All of the components on the device are  uncon-
                   figured.

  State Change Functions
     Functions that change the state of a device or a com-
     ponent  on  the device can be issued concurrently against any
     attachment point. Only one state changing operation is  per-
     mitted  at  a given time. A Y in the Busy field in the state
     changing information indicates an operation is in progress.

     The following list contains the functions  that  change  the
     state:

         o    configure
         o    unconfigure
         o    connect
         o    disconnect

  Platform-Specific Options
     You can specify platform-specific options  that  follow  the
     options   interpreted   by  the  system  device  plugin.  All
     platform-specific options must be preceded by  the  platform
     keyword.  The  following example contains the general format
     of a command with platform-specific options:

     command -o fwoptions,platform=platformoptions

OPTIONS
     This man page does not include the -v, -a, -s, or -h options
     for  the  cfgadm command. See cfgadm(1M) for descriptions of
     those options.  The following options are supported  by  the
     cfgadm_fw plugin:

     -c <function> Performs a state change function. You  can  use
                  the following functions:

                  unconfigure  Changes  the  occupant  state   to
                               unconfigured.     This    function
                               applies to system device slots  and
                               to  all  of  the components on the
                               system device.

                               The unconfigure  function  removes
                               the  CPUs  from  the  CPU list and
                               deletes the physical  memory  from
                               the  system  memory  pool.  If any
                               device is still in use, the cfgadm
                               command   fails  and  reports  the
                               failure to the user. You can retry
                               the  command as soon as the device
                               is no longer busy. If a CPU is  in
                               use,  you  must  ensure that it is
                               off line before you  proceed.  See
                               pbind(1M),      psradm(1M)     and
                               psrinfo(1M).

                               The unconfigure function moves the
                               physical  memory to another system
                               device before it deletes the memory
                               from  the device you want to uncon-
                               figure. Depending of the  type  of
                               memory  being  moved,  the command
                               fails if  it  cannot  find  enough
                               memory  on  another device or if it
                               cannot find an appropriate  physi-
                               cal memory range.

                               For permanent memory, the  operat-
                               ing system must be suspended (that
                               is, quiesced) while the memory  is
                               moved  and  the memory controllers
                               are reprogrammed. If the operating
                               system must be suspended, you will
                               be prompted to  proceed  with  the
                               operation.  You  can use the -y or
                               -n options to always answer yes or
                               no respectively.

                               Moving  memory  can  take  several
                               minutes  to complete, depending on
                               the amount of memory and the  sys-
                               tem load. You can monitor the pro-
                               gress of the operation by  issuing
                               a   status   command  against  the
                               memory attachment point.  You  can
                               also  interrupt  the memory opera-
                               tion by stopping the  cfgadm  com-
                               mand.   The   deleted   memory  is
                               returned  to  the  system   memory
                               pool.

                  disconnect   Changes the  receptacle  state  to
                               disconnected.     This    function
                               applies  only  to   system   device
                               slots.

                               If the occupant state  is  config-
                               ured,   the   disconnect  function
                               attempts to unconfigure the  occu-
                               pant.  It then powers off the sys-
                               tem  device.  At  this  point,  the
                               device  can  be  removed  from  the
                               slot.

                  configure    Changes the occupant state to con-
                               figured.  This function applies to
                               system device slots and to any com-
                               ponents on the system device.

                               If the receptacle state is discon-
                               nected,   the  configure  function
                               attempts to connect  the  recepta-
                               cle.  It  then  walks  the tree of
                               devices that  is  created  by  the
                               connect function, and attaches the
                               devices if necessary. Running this
                               function  configures  all  of  the
                               components on  the  device,  except
                               those  that have already been con-
                               figured.

                               For CPUs, the  configure  function
                               adds the CPUs to the CPU list. For
                               memory,  the  configure   function
                               ensures  that  the  memory is ini-
                               tialized then adds the  memory  to
                               the  system  memory pool. The CPUs
                               and the memory are ready  for  use
                               after  the  configure function has
                               been completed successfully.

                               For I/O devices, you must use  the
                               mount  and  the  ifconfig commands
                               before the devices  can  be  used.
                               See ifconfig(1M) and mount(1M).

                  connect      Changes the  receptacle  state  to
                               connected.  This  function applies
                               only to system device slots.

                               If the device slot is not  assigned
                               to  the  domain, the connect func-
                               tion attempts to assign  the  slot
                               to  the domain. Next, it powers on
                               and tests the device, then it  con-
                               nects  the device electronically to
                               the system bus and probes the com-
                               ponents.

                               After the connect function is com-
                               pleted  successfully,  you can use
                               the -a option to view  the  status
                               of  the  components  on the device.
                               The connect function leaves all of
                               the components in the unconfigured
                               state.

                               The assignment step  applies  only
                               to  platforms that support dynamic
                               system domains.


     -f           Overrides software state changing constraints.

                  The  -f  option  never  overrides   fundamental
                  safety  and  availability  constraints  of  the
                  hardware and operating system.

     -l           Lists the state  and  condition  of  attachment
                  points  specified  in  the format controlled by
                  the -s, -v, and  -a  options  as  specified  in
                  cfgadm(1M).   

SEE ALSO
     cfgadm(1M),    devfsadm(1M),    ifconfig(1M),     mount(1M),
     pbind(1M),  psradm(1M),  psrinfo(1M), config_admin(3CFGADM),
     attributes(5)
