(c) Copyright 2018 Intel Corp. All rights reserved.version_number=3.09.1.0001

******************************************************************************************
BMC LINUX TEST MODULE              V3.10.1.0001                      06/01/2018
******************************************************************************************

1. lxBMC

1.1. Overview

Version:	3.10.1.0001
Released:	06/01/2018

Purpose
This test module sends IPMI Commands to Baseboard Management Controller (BMC) on server or blade systems with IMB driver installed. It is used to perform System Event Log (SEL) operations (get SEL information, get SEL records, check for errors in SEL, clear SEL repository), check sensors (check threshold for analog sensors, check state for discrete sensors), check firmware checksum, test Watchdog timer, check self test result and etc.

Runtime Environment
The Intel(R) Modular Test Architecture Test Executive for Linux. IMB driver must be installed in the Linux Operating System. For blade systems, IMB driver version 1.02 & above must be installed.

License Agreement
All code is under the Intel(R) software License which can be found at http://legal.intel.com. A copy of this agreement must be included if code is released outside Intel.

Hardware Description
This test requires the presence of BMC controller on the UUT.



1.2. Version Info



06/20/2016   	3.01.1.0001   	LVS   Merged Manufacturing and Validation. New sensor tests array parameter support.

02/23/2017      3.03.1.0001     Fancy fixed ColdReset function
                                      updated copyright to 2017
				                      CheckDiscreteSensor function for tracker 1504403815
				                      
03/15/2017      3.04.1.0001     Fancy fixed SEL MASK issure for tracker 1209616295
                                      corrected some print info
                                      
03/15/2017      3.05.1.0001     Fancy added timer in GetFanSpeed() timer to fix long time pending in Autoconfigure() when some fans work not properly.
                                      added MonteVista() subtest for the Montes Vista PCIe card on WCP.						 								      

12/19/2017      3.06.1.0001     Fancy a. exchanged case 0 and case 3 for the SEL display and error check to keep the same test numbering as the 32 bit module 
                                      b. added OOB driver to support no host platform and new parameter OOB/INBAND in snx file
                                      c.  fixed Cnt and gFanCnt number mismatch in GetFanSpeed()
                                      d. added human-readable prints in CheckSELErrors() when error occurs
                                      e. added new functions:
                                         WRGCheckMasterBoard() - checking the WRG master board, only master board could control Fan PWM
                                         FPSwitchs() - checking the Chassis Intrusion & FP buttons
                                         InteractivePrompting() - enabling three types of prompting
                                         LEDs() - checking the LEDs using the SET SM SIGNALS cmd
									  f. opened IPMI CMD print for debugging
									  g. removed error msg when GetSMSignal failed
									  h. opened subtest case 11 FirmwareChecksum(0)
									  i. updated lxBMCx64.snx to keep the same parameters as lxBMC.snx
									  j. skip CheckWatchdogTimer subtest on WRG platform in Autoconfigure()
12/22/2017      3.07.1.0001     Fancy added liboob.h

12/29/2017      3.08.1.0001     Fancy modified error print for the DisplaySEL()
                                      updated copyright to 2018.
									  
01/12/2017      3.09.1.0001     Fancy removed get sdr process in CheckAnalogSensor() due to recid could be reassigned.
                                      added "sensor type" column in getanalogsensor() during autoconfigure.  

06/01/2018      3.10.1.0001     Fancy added NewBuildVer parameter to change the BMC FW print according to Purley.
                                      The value in snx should be 1 for Purley.
                                      added Redundancy BMC FW in display.cfg.

09/19/2018      3.11.1.0001     Fancy changed snx file for SEL mask.
                                      fixed Redundancy BMC FW display issue.	 									  
1.3. Installation

Files needed to run this module:
	
File		Description
lxBMCx64		Executable image.
lxBMCx64.snx		Configuration file.
lxBMC.txt		Text only help file.
lxBMC.chm		Smart help file.



1.4. Sub-Tests

 
Test 0	AutoConfigure
Test 1	CheckSELErrors
Test 2	ClearSEL
Test 3	DisplaySELEvents
Test 4	DisplaySELInfo
Test 5	CheckDeviceID
Test 6	DisplayDeviceID
Test 7  GetSelAllocInfoCmd
Test 8	sel_monitor(MONITOR)  //VSS 
Test 9	CheckDiscreteSensors
Test 10	SelfTestResult
Test 11	FirmwareChecksum
Test 12	CheckWatchdogTimer
Test 13	ColdResetCmd
Test 15	CheckFanSpeed
Test 16	CheckAnalogSensors
Test 17	sel_monitor(READ)     //VSS 
Test 18 FPSwitchs(swPOWER)
Test 19 FPSwitchs(swIdentify)
Test 20 LEDs (ledPOWERF,0)
Test 21 LEDs (ledIDENTIFY,0)
Test 99	AddSelEntry()
Test 100 RestoreSDRRecord(0xFF)  //Shipping
Test 101 RestoreSDRRecord(0x1)   //FCT
Test 102 MonteVista()


1.4.1. Test 0 - AutoConfigure

Overview
This test sets up configuration parameters for each subtest, as indicated by the particular system configuration. It will also remove specific tests that are not supported in the configuration. If SEL commands are not supported, it will prompt user to decide whether to remove SEL related subtests or not. It also prompt user to decide whether to remove sensor related subtests or not if both Get SDR Info and Get Device SDR commands are not supported.

Parameter(s)
The following parameters are written by this test. XX will be a sequential number beginning at 00.

AnalogSensors
ExcludeAnalogSensor
AnalogSensor_Count
BootLocation
DiscreteSensors
ExcludeDiscreteSensor
DiscreteStateXX
DiscreteSensor_Count
FanSensors
OpChecksum
OpLocation
PostSensor
PreTimeoutInterrupt
SMDeviceID
SMDeviceRev
SMFWRev
SMIPMIVer
SMAddDevSupport
SMManfID
SMProductID
SMBootRev
SMPIARev

Error Messages
No error. If BMC is not detected in the UUT or IMB driver is not installed in the OS, the entire module will be removed.

Test Execution Time
Test time varies, depending on the number of sensors in the system and location of the Boot Code and Op Code header in BMC firmware.

Dependencies/Limitations
BMC must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully.

Debug Hints
Check if the IMB driver is installed.



1.4.2. Test 1 - CheckSELErrors

Overview
This test gets the SEL Info, reads SEL records and checks the SEL records for errors (unexpected SEL events). Expected SEL events can be masked with EVMMaskXX paramater. 

Parameter(s)
EVMMaskXX

Test Execution Time
Test time depends on the number of events and errors in SEL.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully.

Debug Hints
Check if the expected SEL records are masked with EVMMaskXX parameters. If this test is run after the CheckAnalogSensors subtest or the SEL repository is not cleared for long period of time, run ClearSEL utility to clear the SEL repository and retry this test.



1.4.3. Test 2 - ClearSEL

Overview
This utility clears all SEL events in the SEL area.

Parameter(s)
None.

Test Execution Time
Test time depends on the number of events in SEL.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully. BMC on UUT must support Delete SEL functionality.

Debug Hints
Check if BMC on UUT supports Delete SEL functionality.



1.4.4. Test 3 - DisplaySELEvents

Overview
This utility gets the SEL Info and SEL events, and displays each of the SEL events. The format of the displayed SEL event is as follows:

    Byte	Field
    1-2  	[Next Record ID]
    3-4  	[Record ID]
    5      	[Record Type]
    6-9   	[Timestamp]
    10-11	[Generator ID]
    12     	[EvM Rev]
    13     	[Sensor Type]
    14     	[Sensor Number]
    15     	[Event Dir | Event Type]
    16-18	[Event Data]

Parameter(s)
None.

Test Execution Time
Test time depends on the number of events in SEL.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully. BMC on UUT must support SEL functionality.

Debug Hints
Check if Get SEL Entry command is supported.


1.4.5. Test 4 - DisplaySELInfo

Overview
This utility gets the SEL Info and display the info.

Parameter(s)
None.

Test Execution Time
This test takes approximately 3 seconds to execute.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully. BMC on UUT must support SEL functionality.

Debug Hints
Check if BMC on UUT supports SEL functionality.



1.4.6. Test 5 - CheckDeviceID

Overview
This test verifies that the device ID information of the BMC controller is correct.

Parameter(s)
SMDeviceID
SMDeviceRev
SMFWRev
SMIPMIVer
SMAddDevSupport
SMManfID
SMProductID
SMBootRev
SMPIARev

Test Execution Time
This test takes approximately 3 seconds to execute.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully.

Debug Hints
Check the BMC controller version on UUT and BMC firmware version.



1.4.7. Test 6 - DisplayDeviceID

Overview
This utility displays the device ID information.

Parameter(s)
None.

Test Execution Time
This test takes approximately 3 seconds to execute.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully.

Debug Hints
N/A.




1.4.9. Test 8 - CheckAnalogSensors

Overview
This test verifies that the analog sensor is operating in the normal region defined by its thresholds. It verifies that the thresholds can be reset, and whether the error tripping mechanism works for each enabled threshold for that sensor. It can also verify that the tripping mechanism generates a correctly formatted Event Message. Either FanSensor00 or AnalogSensor00 parameter is required to run this subtest.

Parameter(s)
ExcludeAnalogSensor
AnalogSensor
AnalogSensorXX_Name
AnalogSensorXX_Reading

Test Execution Time
Test time varies with the number of sensors under test and selected sensor test mode as specified by the SensorTestMode parameter.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully. This test is dependent on the correct SDR records are loaded in the system, and the sensors are operating within the threshold boundaries set in their SDR records.

On blade systems, only two sensor test modes i.e. SENTHR and THRTRIP are supported. On MPCBL0010 blade, only SENTHR sensor test mode is supported.

Debug Hints
Check to see that correct SDR version is loaded and the sensor record for the failing sensor is loaded correctly.



1.4.10. Test 9 - CheckDiscreteSensors

Overview
This test verifies that the discrete sensor is operating in the normal region defined by its configuration. It verifies that the sensor has no error conditions, and is in the correct state. This test does not test that any of the fault conditions are handled correctly. DiscreteSensor00 parameter is required for this subtest.

Array Parameter(s)
    DiscreteSensor
    ExcludeDiscreteSensor

    Note: Ignore_DiscreteSensorXX is a parameter to allow user to set specific sensor to be ignore in this subtest 
	  maximun 4 sensors allow to be ignore only example below: 
		Ignore_DiscreteSensor00 = 0x03 (sensor number 3)
		Ignore_DiscreteSensor01 = 0x07 (sensor number 7)
		Ignore_DiscreteSensor02 = 0xE1 (sensor number E1)
		Ignore_DiscreteSensor03 = 0xE2 (sensor number E2)
	  
Default setting for Ignore_DiscreteSensor00 = NULL.


Test Execution Time
Test time varies with the number of sensors under test and selected sensor test mode as specified by the SensorTestMode parameter.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully. This test is dependent on the correct SDR records are loaded in the system.

Debug Hints
Check to see that correct SDR version is loaded and the sensor record for the failing sensor is loaded correctly.



1.4.11. Test 10 - SelfTestResult

Overview
This test requests the BMC to return its self test result, if any. BMC self test is passed if the returned value is 55h; all other value indicates error condition. 

Parameter(s)
None.

Test Execution Time
This test takes approximately 3 seconds to execute.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully. 

Debug Hints
If this test failed, details error description as returned by BMC will be displayed.






1.4.13. Test 12 - CheckWatchdogTimer

Overview
This test validates operation of the BMC Watchdog Timer and associated interrupt flags. Watchdog Timer has a timeout and pre-timeout setting, as well as settings that indicates timeout action. This test will check to make sure these settings work, and test the timer's ability to pre-timeout and countdown.

Parameter(s)
 PreTimeoutInterrupt

Test Execution Time
This test takes approximately 7 seconds to execute.

Dependencies/Limitations
Baseboard Management Controller must exist in the UUT and IMB driver must be installed in OS for this test to execute successfully. 

Debug Hints
 N/A.




1.5. Parameters

  
There are several configuration parameters that are used by this test module. Each parameter is described in detail in this help file.
  
ALLOW_BMC_NOT_0x20 
AnalogSensorXX
AnalogSensorXX_Name
AnalogSensorXX_Reading
ATCA_SLOT_XX
BootChecksum
BootLocation
BypassSensorRearm
CPCI_SLOT_XX
CPUPresentXX
CPUSensorXX
CPUSensorXX_Name
DiscreteSensorXX
DiscreteSensorXX_Name
DiscreteStateXX
Enable_Firmware_Checksum
EVMMask_Count
EVMMaskXX
EVMMaskXX_Name
FanRetry
FanSensorXX
FanSensorXX_Name
FanSensorXX_Reading
OpChecksum
OpLocation
PostSensor
PreTimeoutInterrupt
ResetDelay
SensorRetry
SensorTestMode
SMDeviceID
SMDeviceRev
SMFWRev
SMIPMIVer
SMAddDevSupport
SMManfID
SMProductID
SMBootRev
SMPIARev
ThresholdOffset


1.5.1. ALLOW_BMC_NOT_0x20

Description
This parameter is used to allow parsing of SDR records with sensor owner ID not equal to 0x20. This parameter should be set to 'YES' before executing AutoConfigure on blade systems.

Default Value - ALLOW_BMC_NOT_0x20 = NO
Valid Values = YES, NO

Example
ALLOW_BMC_NOT_0x20 = YES

Used by
AutoConfigure

See Also
Parameters

1.5.2. AnalogSensor

Description
This array parameter list is a sequential list starting with AnalogSensor00 and ending with AnalogSensorXX, which specifies a list of Analog Sensors in the UUT. XX is the number of sensors in the list. This list is generated by AutoConfigure. Autoconfigure reads the Sensor Data Repository (SDR) Records in the system and creates a parameter for each sensor of type Analog.

This parameter is made up of two parts, where the MSB is the Sensor Type and the LSB is the Sensor Number. Typical Sensor Types are: Fans(0x04), Temperatures(0x01), or Voltage (0x02). (Refer to IPMI specification for more detail.)


Used by
CheckAnalogSensors

See Also
Parameters

1.5.3. AnalogSensorXX_Name

Description
This parameter specifies the name for the list of Analog Sensors in the UUT. This name list is generated by AutoConfigure. Autoconfigure reads the Sensor Data Repository (SDR) Records in the system and creates a parameter for each sensor of type Analog. Each AnalogSensorXX_Name is correspond to the AnalogSensorXX parameter.

Example
AnalogSensor/sensorID/sensor Name = Baseboard temp

Used by
CheckAnalogSensors

See Also
Parameters

1.5.4. AnalogSensor_Reading

Description
This parameter specifies the reading for the list of Analog Sensors in the UUT during AutoConfigure. This list is generated by AutoConfigure and the value is the response data from 'Get Sensor Reading' command. Each AnalogSensorXX_Reading is correspond to the AnalogSensorXX parameter.

Example
AnalogSensor00_Reading = 0x32  

Used by
CheckAnalogSensors

See Also
Parameters





1.5.15. DiscreteSensor

Description
This array parameter specifies the name for the list of Discrete Sensors in the UUT. This name list is generated by AutoConfigure. Autoconfigure reads the Sensor Data Repository (SDR) Records in the system and creates a parameter for each sensor of type Discrete. Each DiscreteSensorXX_Name is correspond to the DiscreteSensorXX parameter.


Used by
CheckDiscreteSensors

See Also
Parameters

1.5.16. DiscreteState

Description
This parameter list is a sequential list starting with DiscreteState00 and ending with DiscreteStateXX where XX is the number of sensors in the list. This parameter includes the discrete state returned by the Get Sensor Reading command for the Discrete Sensors in the UUT. This list is generated by AutoConfigure. Autoconfigure reads all the SDR Records in the system and creates a parameter for each sensor of type Discrete. Each DiscreteStateXX must be matched by a corresponding DiscreteSensorXX parameter.

Example
DiscreteState00 = 0x1        (Discrete state = 1h)

Used by
CheckDiscreteSensors

See Also
Parameters




1.5.19. EVMMask_Count

Description
This optional parameter specifies the total number of SEL event messages masks as specified in the EVMMaskXX parameter. This parameter is used when the EVMMaskXX parameter list is not sequential. 

Default Value - 71
Valid Values = 0 to 100

Example
EVMMask_Count = 20

Used by
CheckSELErrors

See Also
Parameters

1.5.20. EVMMaskXX

Description
This parameter specifies what Event Messages are masked from creating an error when the CheckSELErrors test is run.  It consists of a string of hexidecimal bytes in the following format. Mask format and total bytes are record type specific (8 bytes for record type 02h, 10 bytes for record type C0h-DFh and 14 bytes for record type E0h-FFh).

(a) System Events (RecordType = 02h)
  0x[RecordType-1B][DevAddr-1B][SensorType-1B][Sensor#-1B][EvtDir|EvtTrigger-1B][EvtData1-1B][EvtData2-1B][EvtData3-1B]

(b) OEM Timestamped Events (RecordType = C0h - DFh)
  0x[RecordType-1B][ManufactureID-3B][EvtData-6B]

(c) OEM Non-Timestamped (RecordType = E0h - FFh)
  0x[RecordType-1B][EvtData-13B]                           

(Note: 1B denotes 1-Byte, 13B denotes 13-Bytes & etc.)

If any of the bytes in the parameter are 0xFF they are ignored in the comparison. If any of the LSB numbers on the end are left off or missing they are ignored in the compare. This paramter is case insensitive. Maximum length of mask is 15 Bytes. XX = decimal number from 00 to 99, must start with 00.

A total of 71 Event Messages as specified in the module snippet file are masked by default. User is adviced to go through the list of default EVMMaskXX parameters and remove all Event that should not be masked before run the CheckSELErrors subtest. If the EVMMaskXX list is not sequential, EVMMask_Count parameter can be used to specified the total number of Event Message to be masked.

Default Value - EVMMask00 = 0x022010096F420FFF (Log Area Cleared event)
                      (refer to lxBMC.SNX for complete list of default mask event)

Example
EVMMask00 = 0x022005056F400FFF (Physical Security event)

Used by
CheckSELErrors

See Also
Parameters

1.5.21. EVMMaskXX_Name

Description
This parameter specifies the name or description for the associated EVMMaskXX parameter. Each EVMMaskXX_Name is correspond to the EVMMaskXX parameter.

Example
EVMMask00_Name = Processor Presence Detected

Used by
CheckSELErrors

See Also
Parameters

1.5.22. FanRetry

Description
This optional parameter specifies the number of retries that a test will attempt for Fan Sensors to reach a desired state before failing. 

Default Value - FanRetry = 25
Valid Values = 0 to 4294967295

Example
FanRetry = 10

Used by
CheckAnalogSensors

See Also
Parameters

1.5.23. FanSensor

Description
This array parameter list is a sequential list starting with FanSensor00 and ending with FanSensorXX where XX is the number of sensors in the list. It specifies a list of Fan Sensors in the UUT. This list is generated by AutoConfigure. Autoconfigure reads the Sensor Data Repository (SDR) Records in the system and creates a parameter for each sensor of type Fan.

This parameter is made up of two parts, where the MSB is the Sensor Entity ID and the LSB is the Sensor Number. Typical Sensor Entity IDs are: system board(0x07), processor(0x03) or drive backplane(0x0F). 

Example
FanSensor00 = 0x032C       (Processor fan #2Ch)

Used by
CheckAnalogSensors

See Also
Parameters

1.5.24. FanSensorXX_Name

Description
This parameter specifies the name for the list of Fan Sensors in the UUT. This name list is generated by AutoConfigure. Autoconfigure reads the Sensor Data Repository (SDR) Records in the system and creates a parameter for each sensor of type Fan. Each FanSensorXX_Name is correspond to the FanSensorXX parameter.

Example
FanSensor01_Name = Power Cage Fan

Used by
CheckAnalogSensors

See Also
Parameters

1.5.25. FanSensorXX_Reading

Description
This parameter specifies the reading for the list of Fan Sensors in the UUT during AutoConfigure. This list is generated by AutoConfigure and the value is the response data from 'Get Sensor Reading' command. Each FanSensorXX_Reading is correspond to the FanSensorXX parameter.

Example
FanSensor00_Reading = 0x6D

Used by
CheckAnalogSensors

See Also
Parameters

1.5.26. FanSensor_Count

Description
This optional parameter specifies the number of Fan sensors to be tested by CheckAnalogSensors subtest. This parameter enables user to have non-sequential FanSensorXX list. If this parameter is omitted, CheckAnalogSensors subtest assumes the FanSensorXX list is sequential.

Default Value - NONE
Valid Values = 0 to 256

Example
FanSensor_Count = 3

Used by
CheckAnalogSensors

See Also
Parameters


1.5.30. PreTimeoutInterrupt

Description
This parameter specifies the Watchdog Timer "Pre-timeout Interrupt" type. The CheckWatchdogTimer test uses this parameter value to configure the watchdog timer. This parameter will be set during AutoConfigure.

Default Value - PreTimeoutInterrupt = SMI
Valid Values = "SMI", "NMI", "NONE"

Example
PreTimeoutInterrupt = NMI

Used by
CheckWatchdogTimer

See Also
Parameters

1.5.31. ResetDelay

Description
This optional parameter can be used to indicate an additional delay time in miliseconds after Cold Reset command is sent to BMC.

Default Value - ResetDelay = 5000		(5 seconds)
Valid Values = 0 to 4294967295

Example
ResetDelay = 2500

Used by
ColdReset

See Also
Parameters


1.5.32. SensorRetry

Description
This optional parameter specifies the number of retries that a test will attempt for Sensors threshold to be tripped and EVM to be logged into SEL before failing. 

Default Value - SensorRetry = 15
Valid Values = 0 to 4294967295

Example
SensorRetry = 10

Used by
CheckAnalogSensors

See Also
Parameters

1.5.33. SensorTestMode

Description
This parameter specifies the type of analog sensor testing for CheckAnalogSensors. Supported Test Modes are:

SENTHR  - performs sensor threshold bounds check to ensure sensor reading falls between the preset thresholds.

THRTRIP - performs 'SENTHR' test, and then trip each enabled threshold to ensure the thresholds trip. Event Messages are                 disabled.

TRIPEVM - performs 'SENTHR' and 'THRTRIP' test, with the exception of Event Messages is enabled. The test checks that                  each threshold generates correct EVM in SEL repository.

Default Value - SensorTestMode = SENTHR
Valid Values = SENTHR, THRTRIP, TRIPEVM

Example
SensorTestMode = TRIPEVM

Used by
CheckAnalogSensors

See Also
Parameters

1.5.34. SMDeviceID

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the device ID of the BMC controller.

Example
SMDeviceID = 0x20

Used by
CheckDeviceID

See Also
Parameters

1.5.35. SMDeviceRev

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the device revision of the BMC controller.

Example
SMDeviceRev = 0x81

Used by
CheckDeviceID

See Also
Parameters

1.5.36. SMFWRev

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the firmware revision of the BMC controller.

Example
SMFWRev = 0x119          (Firmware revision 1.19)

Used by
CheckDeviceID

See Also
Parameters

1.5.37. SMIPMIVer

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the IPMI version of the BMC controller.

Example
SMIPMIVer = 0x51          (IPMI version 1.5)

Used by
CheckDeviceID

See Also
Parameters

1.5.38. SMAddDevSupport

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the additional device support of the BMC controller.

Example
SMAddDevSupport = 0x9F

Used by
CheckDeviceID

See Also
Parameters

1.5.39. SMManfID

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct 20-bit value for the manufacturer ID (derived from the IANA 'Private Enterprise' ID) of the BMC controller.

Example
SMManfID = 0x157           (Manufacturer is Intel)

Used by
CheckDeviceID

See Also
Parameters

1.5.40. SMProductID

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the product ID of the system, module or board set.

Example
SMProductID = 0x1B

Used by
CheckDeviceID

See Also
Parameters

1.5.41. SMBootRev

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the firmware boot block revision of the BMC controller.

Example
SMBootRev = 0x1500

Used by
CheckDeviceID

See Also
Parameters

1.5.42. SMPIARev

Description
This parameter will be set during AutoConfigure. The CheckDeviceID test uses this parameter value to check that the Get_Device_ID command returns the correct value for the firmware PIA revision of the BMC controller.

Example
SMPIARev = 0x1001

Used by
CheckDeviceID

See Also
Parameters

1.5.43. ThresholdOffset

Description
CheckAnalogSensors subtest uses this parameter to determine the extreme threshold to set when tripping the threshold. Usually lower thresholds are set to (Sensor Reading + ThresholdOffset) and upper thresholds are set to (Sensor Reading - ThresholdOffset).

Default Value - ThresholdOffset = 8
Valid Values = 0 to 65536

Example
ThresholdOffset = 10

Used by
CheckAnalogSensors

See Also
Parameters

1.6. Error Codes


ERROR codes formatted as 0xMMMTTEEE 

MMM - Module number  
TT      - Test number 
EEE   - Error code number, as below:

EEE - Message

50Dxx003   Invalid test number (<Test Number>).
      Likely cause(s): User requested unsupported test number.  
      Package file or SNP file may need to be updated.
50Dxx004   <Function>: Failed to read parameter '<Parameter>', with error status '<Status>'.
50Dxx005   Failed to set cleanup routine!
50Dxx006   <Function>: Device ID Config(<Parameter>) Miscompare! Expected:%Xh, Received:%Xh.
50Dxx007   <SEL Command> Unsuccessful (<Failing Condition>!).
50Dxx008   <Function>: Failed checking state for sensor <Sensor#>. Expected:%Xh, Received:%Xh.
50Dxx009   <Function>: Reading for sensor <Sensor#> is out of range. Expected:%s%Xh, Received:%Xh.
50Dxx00A   <Function>: Failed to trip analog sensor <Sensor#>. Expected:%02Xh, Received:%02Xh.
50Dxx00B   <Function>: Failed to assert EVM for analog sensor <Sensor#>. Expected:%04Xh, Received:%04Xh.
50Dxx00C   <Function>: Analog Sensor <Sensor#> failed to log an EVM in SEL.
50Dxx00D   <Function>: Error restoring threshold for sensor <Sensor#>.
50Dxx00E   <Function>: <IPMI Cmd> command Unsuccessful. CompCode=%02Xh (<CompCode Description>).
50Dxx00F   <Function>: Error response (%d) from imbapi lib. 
50Dxx010   CheckSELError Failed: SEL repository contained an un-masked Event Message!
50Dxx011   Self Test Error: <Error description>.
50Dxx012   <Function>: Invalid parameter value. <Parameter value>.
50Dxx013   Failed to write BMC <RAM type> RAM byte at address %04Xh. Expected:%02Xh, Received:%02Xh.
50Dxx014   Failed to <Enter | Exit> Firmware Transfer Mode.
50Dxx015   Did not find or unsupported Device Info Structure. (Segment:<Segment number>)
50Dxx016   Failed <Device Info type> Checksum.\nExpected Checksum: %04Xh != Actual Checksum: %04Xh.
50Dxx017   Firmware Checksum returned <Address type> address is incorrect. Expected:%04Xh, Received:%04Xh.
50Dxx018   Watchdog Timer failed to start counting down.\nInitial Count:%02Xh, Present Count:%02Xh.
50Dxx019   Watchdog Timer returned incorrect <message> information. Expected:%02Xh, Received:%02Xh.
50Dxx01A  Failed setting <Flag name>. Expected:%Xh, Received:%Xh.

License Key Error
The license key entered is invalid.  NOTE:
* BIOS ID keys must be run under 'root'
* System time must be set correctly
* License file must be named 'license.key'
* License file must be located in the same directory as 'T'



1.7. Glossary

  
BMC	- Baseboard Management Controller.
EVM	- Event Messages.
IANA	- Internet Assigned Number Authority.
IMB	- Intelligent Management Bus.
IPMI	- Intelligent Platform Management Interface.
PIA	- Platform Information Area.
SDR	- Sensor Data Repository.
SEL	- System Event Log.
UUT	- Unit Under Test - The board or system being tested.



