#
# Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved.
#

name="ipmi" parent="pseudo" instance=0;

# WARNING: Please note that changes made to this file can be OVERWRITTEN by
# system updates. Review /etc/driver/drv/README.driver in order to determine
# the supported procedure for setting properties in driver.conf files.

# There are two choices of BMC/IPMI drivers. The first choice is the original
# BMC driver (bmc) which supplies the proprietary SUN API.
# The second choice is a driver pair (sbmc/ipmi) which supplies both
# proprietary SUN API and OpenIPMI compliant driver API at the same time.
#
# NOTE: You can not enable both the original Sun driver (bmc) and the
# new driver pair (ipmi/sbmc) at the same time.
#
# If you want the original bmc driver to be enabled you need to
# set the following driver properties in the related files:
#        FILE            PROPERTY
# ----------------------------------
#      bmc.conf          bmc-enable=1
#     sbmc.conf          sbmc-enable=0
#     ipmi.conf          ipmi-enable=0
#
# If you want the new driver pair (Supplying simultaneous OpenIPMI and
# legacy SUN API's) to be enabled you need to set the following
# properties in the related files:
#        FILE            PROPERTY
# ----------------------------------
#      bmc.conf          bmc-enable=0
#     sbmc.conf          sbmc-enable=1
#     ipmi.conf          ipmi-enable=1
#
# NOTE: After changes the system then needs to be restarted since once
# loaded these modules can not get unloaded.

ipmi-enable=0;

# The next two properties are part of the Watch-dog feature of the BMC
# hardware. The watch-dog is a hardware assisted automatic "hung" system
# recovery system. The watch-dog is setup in the BMC device with a time out value.
# Once set this time out starts to count down toward zero. If it reaches zero
# the BMC will do a hard reset of the system, effectively restarting it. The IPMI
# driver periodically updates this time out back to its initial value and the count
# down starts over.
#
# There are two values that can effect the performance of the watch-dog. The
# first is the number of seconds before the watch-dog timer times-out. The second
# is the update time that specifies how frequently we refresh the watch-dog
# back to its initial value (preventing it from reaching zero). If you set
# the update time to be longer then the watch-dog time, then the system will
# continually comeup till the IPMI driver is loaded and then reset. So the
# update time most be a significantly shorter time then the watch-dog time.
# This is to guarantee that, even on a very busy system, there is enough time
# to refresh the timer before it reaches zero.
#
# Note that the watch-dog timer can be disabled by simply setting either 
# of the two following properties to zero.

#
# This is the watch-dog time out value in seconds. The default for this is 
# 90 seconds. To over-ride this uncomment the following.
#
#ipmi-wdtime=90;

#
# This is the update period in seconds. It specifies how frequently the
# watch-dog timer is set back to its inital value. The default value is 
# 30 seconds. It is recommended that this be set no larger then one third
# of the value for the wdtime.
#
#ipmi-wdupdate=30;

#
# This is the time between polls for asyncronous events in milliseconds.
# Since we do not yet support interrupts and since most systems HW do not
# support interrupts. We need a work around to handle async. messages
# from the BMC. We do periodic polls for new messages. Note that this
# is a trade-off in that the more often you do this the faster you get
# these events. But you then wast much time looking when nothing it there.
# The default for this is one second. If it is set to zero then polling
# is disabled
#ipmi-polltime=1000;

#####################################################################
# All the following properties are related to back-end plugin drivers.
#####################################################################

#----------------------------------------------------------------------
# The Following properties are used by the KCS back-end driver plugin
# which exists on X86 machines which contain a Service Processor.
#----------------------------------------------------------------------

# The following, if set to 0, will disable the X86 KCS back-end plugin.
# This defaults to 1 (enabled) if not defined.
#kcs-enable=1;

#----------------------------------------------------------------------
# The Following properties are used by the "standard system" SPARC VLDC
# back-end driver plugin which exists on all none ATCA SPARC boxes
# which contain a Service Processor.
#----------------------------------------------------------------------

# The following, if set to 0, will disable the SPARC VC back-end plugin.
# This should be enabled on all systems with the exception of Netra ATCA
# ones. This defaults to 1 (enabled) if not defined.
#vc-enable=1;

#----------------------------------------------------------------------
# The following properties are used by the SPARC ATCA back-end driver
# plugin which only exists on the Netra ATCA systems. This is a serial
# virtual channel interface. This talks to a special Service Processor,
# a Pigeon Point shelf processor called BMR-H8S-ATCA. This device is a
# slower interface and should not be enabled unless it is present on the
# system.
#----------------------------------------------------------------------

# The following, if set to 1, will enable the LDC virtual serial interface.
# This defaults to 0 if not set. It is not recommended that this is set
# to 1 unless you are running on a system which contains this device!
#ldcserial-enable=0;

# The following, if uncommented, will select the virtual channel device
# node in /devices instead of the default ones:
# /devices/virtual-devices@100/channel-devices@200/virtual-channel@3:ipmi
# or
# /devices/virtual-devices@100/ipmi@f:glvc
#
# Note that this property is for internal testing and it is not recommended
# that it be uncommented!
#ldcserial-dev="/devices/virtual-devices@100/channel-devices@200/virtual-channel@3:ipmi";

#----------------------------------------------------------------------
# The following properties are used by the direct attach serial ATCA back-end
# driver plugin which only exists on the Netra ATCA systems. This is a serial
# direct interface. This talks to a special Service Processor,
# a Pigeon Point shelf processor called BMR-H8S-ATCA. This device is a
# slower interface and should not be enabled unless it is present on the
# system.
#----------------------------------------------------------------------

# The following, if set to 0, will disable the serial back-end plugin.
# This defaults to 0 (disabled) if not defined.
#serial-enable=0;

# The following, if uncommentated, will select the serial device.
# The right device name should be provided to run the serial back-end plugin.
# Warning: make sure that the serial-dev is set correctly. if not, the drive
# may hang and never return.
#serial-dev="/dev/tty00";

# This is an alternate way to set baud rate.
# Note that this defaults to 9600.
#serial-baud=9600;

# This is to set the parity: even or odd or none.
# Note that this defaults to "none".
#serial-parity="none";

# This is to set the handshaking type: soft or hard or none.
# Note that this defaults to "none".
#serial-handshake="none";