1. lxMicMemory


Copyright (c) 2011-2014 Intel Corporation. All rights reserved.

Version_number=2.24.1.0001

1.1. Overview

Copyright (c) 2011-2014 Intel Corporation. All rights reserved.

Version_number:  	2.24.1.0001
Released:            14-Oct-2014

Purpose
This module tests the GDDR memory on a Many Integrated Cores (MIC) PCI-e card. The test depends on the MIC SW 
Stack which consists of:
*	MIC Board Tools (MICSYSSW)
*	MIC Host Driver
*	MIC uOS
These components are packaged in the RPM file:
intel-mic-knc-kmod-<version>.el6.x86_64.rpm
Where <version> should be at least: 2.1.3126-13...
Earlier versions of this RPM file will not be compatible with this release. 

This module uses the MIC tools to boot the MIC card's uOS and check memory size parameters. Then it puts the MIC 
card in a special Memory Diagnostic mode. In this mode the MIC Board Tools provide APIs which allow the test to read 
and write the GDDR memory on the MIC PCI-e card. The final set of On Board tests, boot the MIC card's uOS, and run a 
subset of the memory tests from the lxMemory test module, on MIC card's memory.

Runtime Environment
The Intel(R) Modular Test Architecture Test Executive for Linux template module.  The MIC SW Stack must be installed 
on the Linux operating system.

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 a MIC PCI-e card in the host system.





1.2. Version Information

 
Date		Version			Owner	 Comments
11/30/2011	2.01.1.0001		DKJ	 First released version 	
12/29/2011	2.02.1.0000		DKJ	 Enhancements include:
							 Improves reliability of uOS 								 Boot.
							 Support looping with MIC Memory 							 Size test enabled.
							 Automatically skips memory 								 mapped MIC Flash area during 
							 testing
01/16/2012	2.03.0.0001		DKJ	 Updates for MIC MPSS v2356 to 								 support ES1 KNC.
02/14/2012	2.04.0.0001		DKJ	 Updates for MIC MPSS v2430-6 to 							 improve support for ES1 KNC.
02/26/2012	2.05.1.0001		DKJ	 Updates for MIC MPSS Alpha 								 release. Also:
							 Adds support for MIC uOS boot 								 timeouts
03/28/2012	2.06.1.0001		DKJ	 Update for MIC MPSS SW stack 								 release
04/25/2012	2.07.1.0001		DKJ	 Recompile with MPSS SW stack 								 po201-0 to support KNC B0 ES2.
                                      Move boot scripts to lxMicBoot
06/22/2012	2.08.1.0001		DKJ	 Update to support MPSS SW
							 3126-13, and MIC Boot commands
07/31/2012	2.09.1.0001		DKJ	 Recompile with MPSS SW stack 								 3653-7  to support KNC B1
08/23/2012	2.10.1.0001		DKJ	 Adds MIC On Board memory tests.
							 Tests added:
							  MIC Reset, OB Memory Size 								  Check, OB CPU Count Check,
							  OB Sliding Ones Test
							 Parameters added:
							  MIC Board SKU
09/11/2012	2.11.1.0001		DKJ	 Adds MIC OB Random Data test, 								 disable OB Sliding Ones Test.
10/02/2012	2.12.1.0001		DKJ	 Adds MIC On Board Cache Test 								 and AutoConfig support for On 
							 Board Tests.
                                      Also, enables monitoring of MIC 							 MCA (Machine Check 										 Architecture) errors during On 							 Board tests.
							 Tests added:
							  Onboard Cache Random Data
							 Parameters added:
							  Onboard Cache CPU Count, 								  Onboard Cache Size, 
							  Onboard Memory Size,
							  Onboard CPU Count,
							  Onboard Memory Accuracy, 								  Onboard Window Size,
							  Onboard Reserved Memory

11/12/2012	2.13.1.0001		DKJ	 Adds MPSS ReInitialization 								 Subtest. Also:
							 Fixes On Board Cache test bug 								 which limited On Board 
							 cache test to a maximum of 32 								 CPUs.
							 Makes Onboard Cache CPU Count 								 an optional parameter.
							 Fixes bug in MICRAS daemon 								 error handling, where 
							 MICRASD errors would not be 								 recorded if MIC card crashed.
							 Adds cumulative MICRAS error 								 log micrasd_all.out
							 Adds logging of Failure 									 messages from lxmicstart.  See 
							 lxMicBoot module for list of 								 lxmicstart failure messages.
							 Rearranges default order of 								 subtests, to remove 
							 unnecessary MIC Resets and uOS 							 Boots.

12/13/2012	2.14.1.0001		DKJ	 Adds fix for occasional OnBoard 							 Memory and Cache Test timeouts.
01/18/2013	2.15.1.0001		DKJ	 Expands error checking and 								 reporting when MIC Memory Test 
							 failures are detected.
01/22/2013	2.16.1.0001		DKJ	 Fix possible On Board test race 							 condition
02/13/2013	2.17.1.0001		DKJ	 Replaces carriage returns in 								 multi-line messages with tab 
							 characters.
   							 Also, bundles, script files 								 used by this test module into a 							 tar file lxMicMemory_sh.tar
02/27/2013	2.18.1.0001		DKJ	 Removed MICRAS daemon 									 monitoring added in earlier 								 versions.
03/12/2013	2.19.1.0001		DKJ	 Adds optional parameters to 								 enable scaling of OnBoard 								 Memory test timeouts.
							Parameters added:
						OnboardSlidingOnesTimeoutSecPerGB
						OnboardRandomMemTimeoutSecPerGB

05/01/2013	2.20.1.0001		DKJ	Rebuild with MPSS 6720-12.
10/02/2013	2.21.1.0001		DKJ	Coverted to use MPSS 3.1 with 								 libmicmgmt interfaces.
                                      Also added support for testing 								 multiple MIC cards.
11/07/2013	2.22.1.0001		DKJ	 Increased retries when looking 							 for On Board test output files.
05/30/2014	2.23.1.0001		DKJ	 Enabled support for testing 								 multiple MIC cards in parallel.	
10/14/2014	2.24.1.0001		DKJ	 Added Test 9 - Memory Stress 								 Test

1.3. Installation

Files needed to run this module:
	
File	Description
lxMicMemory		Executable image.
lxMicMemory.snx		Configuration file.
lxMicMemory.txt		Text only help file.
lxMicMemory.chm		Compressed HTML help file.
lxMicMemory_sh.tgz	Tar file containing script files used by this 					test module, and mc_handler_k1om.elf, the MIC 
				Memory Diagnostic Mode handler.
ob_lxMemory.tgz		Tar file containing On Board memory test 						directory, with executables, scripts, and 						parameter files.
lxmicstart			Script to boot MIC card. Provided by lxMicBoot
lxmicbooted		Script which checks whether the MIC uOS is 					already booted. Provided by lxMicBoot
lxmicready			Script to reset MIC card to FW ready state. P					rovided by lxMicBoot


lxMicBoot:
This package depends on the lxMicBoot test package to provide the lxmicstart, lxmicbooted, and lxmicready scripts 
which are use to boot the MIC uOS.  The lxMcBoot version required to support this version of lxMicMemory, must 
be at least 2.14.1.0001

MPSS RPM: 
To Be Determined

Host board: 	The host board must be supported by the MPSS RPM team. Please see project contact for a list 
of supported boards. This release was tested with Intel Workstation Board W2600CR2.

Operating Systems:	The OS on the host board must be supported by the MPSS team. Currently, the supported OS 
are Red Hat Enterprise Linux 6.0 and Red Hat Desktop 6.0.

SELinux: 	There is a known issue with interaction between the MPSS SW and SELinux, that makes MIC 
uOS boot unreliable. Because of this SELinux should be disabled when running tests which 
require MIC uOS boots and reboots, such as the tests in this test module.  Note:  CTC normally 
puts SELinux, if it is enabled, in permissive mode when CTC is running. However this is not 
solve the problem with SELinux interfering with MIC uOS boot.  SELinux must be disabled to 
avoid this problem.
To Disable SELinux:
*	On the host system, as root, edit /etc/selinux/config
*	Change the line which starts SELINUX=...  to SELINUX=disabled
*	Reboot the system
*	After the reboot use the command: sestatus to verify that SELinux is disabled.

To Re-Enable SELinux:
*	On the host system, as root, edit /etc/selinux/config
*	Change the line: SELINUX=disabled to SELINUX=permissive
*	Reboot the system.  During this reboot SELinux will detect the configuration change and will 
force file label update, and then do a second reboot.
*	After reboot use the command: fixfiles relabel to update labels on all the files monitored by 
SELinux. Responding N to question about cleaning out /tmp is OK.
*	Edit /etc/selinux/config and change SELINUX=permissive to SELINUX=enabled
*	Then reboot again
*	After the reboot use the command: sestatus to verify that SELinux is enabled.  If the system 
automatically starts CTC on reboot, sestatus will show the SELinux status as permissive since 
CTC automatically sets SELinux to permissive mode when it starts, but only if SELinux is 
enabled.

MIC card:	A supported MIC card must be plugged into a PCI-E slot on the supported host board. Please see 
project contact for a list of supported boards.

Expect: 	The expect scripting tool must be installed in /usr/bin/expect.  If expect is not installed  Test 20 
- MPSS ReInitialization will not work.

lxMicMemory:
Copy the test module files, listed above, to the CTC directory.
As root in the CTC test directory, untar the On Board Memory test directory:
> tar -xvzf ob_lxMemory.tgz
As root in the CTC test directory, untar the lxMicMemory_sh.tgz file:
> tar -xvzf ob_lxMicMemory_sh.tgz





1.4. Sub-Tests


Test 0	Auto-Configuration

Test 1	MIC Memory Size Check

Test 2	MIC Memory Test		Not available in lxMicMemory version 2.21.1.0001 and later

Test 3	MIC Reset

Test 4	On Board Memory Size Check

Test 5	On Board CPU Count Check

Test 6	On Board Sliding Ones Test

Test 7	On Board Random Data Test

Test 8	On Board Cache Random Data Test

Test 9	Test 9 - Memory Stress Test

Test 20	MPSS ReInitialization

1.5. On Board Test Operation


This section describes operation of the MIC On Board tests, which are run remotely in stand alone mode on the MIC 
uOS.

Overview:

When an On Board test is executed, all of the test binaries and parameter files needed to execute the test are copied to 
the MIC uOS environment on the target MIC PCIe add-in card.  The local test host, running this test module, monitors 
execution of the remote test, running on the MIC uOS and reports the results of the test to the user, using standard CTC 
reporting conventions.

Because the actual test is runs stand alone mode remotely on the MIC uOS, there are some differences in parameter  
handling that the user should be aware of.  These differences are:
*	Test parameters are passed to the remote test in a configuration file.
*	The parameters in the configuration file are MIC SKU specific.
*	The MIC SKU configuration file used for testing is selected by the MIC Board SKU parameter.
*	During AutoConfiguration a configuration file for MIC Board SKU will be created.  This file will contain the values of 
the On Board test parameters when the configuration file is created.  If, subsequently, an On Board parameter's 
value is changed the new value Will NOT be passed to the On Board test.
*	During AutoConfiguration, a configuration file will be created for each MIC card in the system. These names of 
these configuration files will have the format: lxMemory_<MIC_Board_SKU>_<mic_id>.ini for example: If 
MIC_Board_SKU is PRODUCT_CS, the configuration file for mic0, will be: lxMemory_PRODUCT_CS_mic0.ini 
and for mic1 it will be: lxMemory_PRODUCT_CS_mic1.ini  
*	To change the value of an On Board parameter in a MIC SKU's parameter file:
1.	Exit and Restart CTC  (Note: Reconfigure does not work with MIC SKU parameter file creation)
2.	Load the lxMicMemory .snx file
3.	Set MIC Board SKU to the name of the MIC SKU.
4.	Set the On Board parameters to the desired values, except On Board Memory and On Board CPU Count, 
which will be auto sensed.
5.	Configure the test.  This will create a MIC SKU parameter file(s) with the current values of the On Board 
parameters.




1.6. Test 0 - Auto-Configuration

Overview

This subtest performs required setup for the test executive. 

Parameter(s)
Memory Size
MicDeviceNumber
MicPCIeBusNumber
MicPCIeSlotNumber
MIC Board SKU
Onboard Memory Accuracy
Onboard Window Size
Onboard Reserved Memory
Onboard Cache CPU Count
Onboard Cache Size


Test Execution Time
 Varies. Requires booting the MIC uOS to retrieve Memory Size parameter value. Generally about two minutes.	

Dependencies/Limitations
MIC uOS must be able to boot on the MIC PCI-e card under test.





1.7. Test 1 - MIC Memory Size Check

Overview

This subtest gets the size of the MIC PCI-e card under test's GDDR memory.  Then checks this value against the 
expected value in the Memory Size parameter. The Memory Size Tolerance parameter may be used to allow the actual 
MIC memory size to differ from the expected memory size, within the tolerance specified by this parameter.  By default 
the Memory Size Tolerance parameter is set to 1% of the expected memory size

Parameter(s) 
Memory Size
Memory Size Tolerance
MicDeviceNumber

Test Execution Time
Varies, but basically the time it takes to boot the uOS on the MIC PCI-e card.

Dependencies/Limitations
None.





1.8. Test 2 - MIC Memory  Test

Overview

This subtest is NOT included in release 2.21.1.0001 of the lxMicMemory test module, due to transition MPSS 3.1 
and libmicmgmt.

Boots the MIC PCI-e card into Memory Diagnostic mode. Then runs a simple data pattern test on the MIC GDDR 
memory between MIC Memory Start and MIC Memory End. The test's parameters can be used to customize the test.  
The default parameter values do a Write-Read-Compare test on the first 512MB of MIC GDDR memory. Setting MIC 
Memory End to Memory Size will test all accessible MIC memory.

When an error is detected, this test gathers additional data on the error by:
*	Rereading the current buffer from MIC Memory to check whether the data is corrupted in memory, or wether it was 
corrupted while being copied from KNC memory.
*	Automatically restart the test at the start of the memory range, to check whether all of MIC memory has been 
corrupted.
All of the data gathered by these checks is included in the error message, which is logged when an error is detected.
 
Parameter(s) 
Test Data Width
MIC Memory Start
MIC Memory End
Window Size
Pattern
Address Sequence
Subtest Type
Memory Size

Test Execution Time
The first time the test is executed, the test takes about 2 minutes to put the system in Memory Diagnostic mode.
Once the system is in Memory Diagnostic mode, testing the first 512MB of memory using the default parameters takes 
about one minute.

Dependencies/Limitations
None.





1.9. Test 3 - MIC Reset

Overview

The Mic Reset test invokes the lxmicready script, which resets the current MIC card, to put it in firmware ready state.
 
Parameter(s) 
  MicDeviceNumber

Test Execution Time
MIC card reset takes  between 1 and 2 minutes.

Dependencies/Limitations
None beyond Installation dependencies.





1.10. Test 4 - On Board Memory Size Check

Overview
This test runs Memory Size check from the lxMemory test module, on the MIC uOS.  The MIC Board SKU parameter is 
used to select the parameter file with the correct expected memory size for the MIC board under test.

See On Board Test Operation for information on how parameters are defined and passed to MIC On Board tests.
See the lxMemory documentation for descriptions of the parameters required by its' Memory Size Check test.


Parameter(s) 
MIC Board SKU
MicDeviceNumber

Test Execution Time
Varies, but basically the time it takes to boot the uOS on the MIC PCI-e card.

Dependencies/Limitations
None.





1.11. Test 5 - On Board CPU Count Check

Overview
This test runs the CPU Count check from the lxMemory test module, on the MIC uOS.  The MIC Board SKU parameter is 
used to select the parameter file with the correct expected memory size for the MIC board under test.

See On Board Test Operation for information on how parameters are defined and passed to MIC On Board tests.
See the lxMemory documentation for descriptions of the parameters required by its' CPU Count Check.


Parameter(s) 
MIC Board SKU
MicDeviceNumber

Test Execution Time
Varies, but basically the time it takes to boot the uOS on the MIC PCI-e card.

Dependencies/Limitations
None.





1.12. Test 6 - On Board Sliding Ones Test

Overview
This test runs the Memory Sliding Ones and Zeroes test from the lxMemory test module, on the MIC uOS.  The MIC 
Board SKU parameter is used to select the parameter file with the correct expected memory size for the MIC board under 
test.

See On Board Test Operation for information on how parameters are defined and passed to MIC On Board tests.
See the lxMemory documentation for descriptions of the parameters required by its' Memory Sliding Ones and Zeroes 
test.


Parameter(s) 
MIC Board SKU
OnboardSlidingOnesTimeoutSecPerGB
MicDeviceNumber

Test Execution Time
Varies, depending on the size of memory.

Dependencies/Limitations
None.





1.13. Test 7 - On Board Random Data Test

Overview
This test runs the Memory Random Data test from the lxMemory test module, on the MIC uOS.  The MIC Board SKU 
parameter is used to select the parameter file with the correct expected memory size for the MIC board under test.

See On Board Test Operation for information on how parameters are defined and passed to MIC On Board tests.
See the lxMemory documentation for descriptions of the parameters required by its' Memory Random Data test.


Parameter(s) 
MIC Board SKU
OnboardRandomMemTimeoutSecPerGB
MicDeviceNumber

Test Execution Time
Varies, depending on the size of memory.

Dependencies/Limitations
None.





1.14. Test 8 - On Board Cache Random Data Test

Overview
This test runs the Cache Random Data test from the lxMemory test module, on the MIC uOS.  The MIC Board SKU 
parameter is used to select the parameter file with the correct expected memory size for the MIC board under test.

See On Board Test Operation for information on how parameters are defined and passed to MIC On Board tests.
By default, when this test is autoconfigured for the target MIC, it is configured to test all CPU Caches.  However, the 
parameter Onboard Cache CPU Count may be used to limit the number of CPU caches which are tested.

See the lxMemory documentation for descriptions of the parameters required by its' Cache Random Data test.


Parameter(s) 
MIC Board SKU
Onboard Cache CPU Count
MicDeviceNumber

Test Execution Time
Depends on number of CPU Caches tested. Typically less than 10 seconds.

Dependencies/Limitations
None.





1.15. Test 9 - Memory Stress Test

Overview
This test runs a user defined stress test on the target MIC PCIe add-in card.  The user provides two scripts, one to start 
the stress test and one to stop the stress test. The names of these scripts are specified by the parameters: 
StressStartScript and StressStopScript.

The test will:
*	Run the script specified by StressStartScript and pass the name of the target MIC (i.e. mic0, mic1, mic2, ...) as a script 
command line parameter, to start the test.
*	Wait StressDelayTime seconds.
*	Run the script specified by StressStopScript, also with the name of the target MIC passed as a parameter, to stop the 
test.

This test does not do any error checking, beyond verifying that the target MIC is booted, and the user supplied scripts are 
run.
The test assumes the user built any other required error checking into their test.


Parameter(s) 
StressStartScript
StressDelayTime
StressStopScript

Test Execution Time
Determined by the parameter: StressDelayTime

Dependencies/Limitations
None.





1.16. Test 20 - MPSS ReInitialization

Overview
This subtest reinitializes the MPSS SW stack to it's default configuration for the currently installed MIC PCIe addin cards.
Because the MPSS SW stack maintains different default configurations for different MIC HW SKUs, the MPSS SW stack 
must be reinitialized each time the MIC HW SKU being tested changes.  Hence, whenever, it is possible that the MIC HW 
SKU under test has changed this should be run before doing any uOS Boots. 

Note: This test ignores the MicDeviceNumber parameter, because MPSS Reinitialization, affects all of the MIC 
cards in the system.  when this test is run, the MPSS SW stack will be unloaded, resulting in all the MIC cards 
being Reset to FW ready state, and then rebooted.


Parameter(s) 
  None

Test Execution Time
If the MIC uOS has already been booted, this test takes about 3 minutes to complete.
If the MIC is in ready (i.e. reset, but not booted to uOS) state this test takes about 1.5 minutes to complete, and leave 
the MIC in online state with the uOS booted.

Dependencies/Limitations
lxMicBoot, at least, version 2.09.1.0001.
The expect  scripting tool must be installed in /usr/bin/expect





1.17. Parameters


MicDeviceNumber

MicPCIeSlotNumber

MicPCIeBusNumber

Memory Size

Memory Size Tolerance

Test Data Width

MIC Memory Start

MIC Memory End

Window Size

Pattern

Address Sequence

Subtest Type

MIC Board SKU

Onboard Memory Size

Onboard Memory Accuracy

Onboard Window Size

Onboard Reserved Memory

Onboard Cache CPU Count

Onboard Cache Size

OnboardSlidingOnesTimeoutSecPerGB

OnboardRandomMemTimeoutSecPerGB

StressStartScript

StressDelayTime

StressStopScript



1.18. Test Data Width

Description
Used to mask the Pattern which is then used to fill the Window Size test buffer.  Possible values:
1 - Least significant byte of pattern will be used to fill the test buffer
4 - Least significant 4 bytes of pattern will be used to fill the test buffer
8 - Least significant 8 bytes of pattern will be used to fill the test buffer

Default
8

Dependencies
Required

Used by
MIC Memory Size Check


See Also
Parameters

1.19. MicDeviceNumber

Description
Device Number of the current MIC Device.  This parameter is set during AutoConfig, to distinguish the current MIC 
device from other MIC devices in the test system. When this number is appended to the string mic it creates the MIC 
Device Name for the target MIC card, which is recognized by the MPSS SW. Hence if this parameter has a value of 0, 
the MIC Device Name is: mic0

Default
None

Dependencies
Required

Used by
MIC Memory Size Check
Test 0 - Auto-Configuration
Test 1 - MIC Memory Size Check
Test 3 - MIC Reset
Test 4 - On Board Memory Size Check
Test 5 - On Board CPU Count Check
Test 6 - On Board Sliding Ones Test
Test 7 - On Board Random Data Test
Test 8 - On Board Cache Random Data Test



See Also
Parameters

1.20. MicPCIeSlotNumber

Description
PCIe Slot Number of current MIC device. This parameter is set during AutoConfig. It is not used by the tests.  It exists, 
to help the user identify the current MIC device with a physical PCIe slot, in cases where multiple MIC cards are in the 
system.

Default
None

Dependencies
Required

Used by


See Also
Parameters

1.21. MicPCIeBusNumber

Description
PCIe Bus Number of current MIC device. This parameter is set during AutoConfig. It is not used by the tests.  It exists, 
to help the user identify the current MIC device with a physical PCIe slot, in cases where multiple MIC cards are in the 
system.

Default
None

Dependencies
Required

Used by


See Also
Parameters

1.22. Pattern

Description
Data pattern used to test MIC Memory. The "Window Size" test buffer will be filled with this pattern, when it is written to 
MIC memory. In Compare portion of MIC Memory Test, the buffer read from MIC Memory will be compared against this 
data pattern.

Default
0xA5A5A5A5A5A5A5A

Dependencies
Required

Used by
MIC Memory Test

See Also
Parameters

1.23. Memory Size

Description
Size, in bytes, of MIC PCI-e cards GDDR memory. 

Default
None

Dependencies
Required

Used by
MIC Memory Size Check
MIC Memory Test


See Also
Parameters

1.24. Memory Size Tolerance

Description
Tolerance in percent of Memory Size parameter value, that the actual memory size from the value in the Memory Size 
parameter and still pass the MIC Memory Size test. 

Default
1

Dependencies
Required

Used by
MIC Memory Size Check


See Also
Parameters

1.25. MIC Memory Start

Description
Physical address of first byte in MIC GDDR memory range to be tested

Default
0

Dependencies
Required

Used by
MIC Memory Test


See Also
Parameters

1.26. MIC Memory End

Description
Physical address of last byte in MIC memory range to be tested.  The value of this parameter may not exceed the value 
of the Memory Size parameter.

Default
512MB

Dependencies
Required

Used by
MIC Memory Test


See Also
Parameters

1.27. Window Size

Description
Size, in bytes, of data buffer passed to MIC Board Tools API to Read or Write MIC Memory. The MIC Board Tools API 
will read or write the buffer to physical addresses in MIC Memory.

Default
0x80000

Dependencies
Required

Used by
MIC Memory Size Check


See Also
Parameters

1.28. Address Sequence

Description
Used to gallop test through memory skipping over Window Size sections of memory. The default value of 1 will not skip 
any memory. If set to 2, every other memory window will be tested and if set to 3, every third memory window will be 
tested.

Default
1

Dependencies
Required

Used by
MIC Memory Test

See Also
Parameters

1.29. Subtest Type

Description
Determines the type of test which will be run on the MIC memory range.
Valid settings for this parameter are:
*	Read			Reads memory, but does not check values
*	Write			Writes memory, but does not check values written
*	WriteReadCompare	Writes then Reads memory and checks values read

Default
WriteReadCompare

Dependencies
Required

Used by
MIC Memory Test

See Also
Parameters

1.30. MIC Board SKU

Description
Name or ID of the MIC Board type, or SKU, being tested. The value in this parameter is used to select the parameter file 
which will be used by the MIC On Board memory tests.  When run on the MIC, under the MIC uOS, lxMemory runs in 
standalone mode.  In this mode the test parameters are read from a parameter, named: lxMemory.ini  
Automatic configuration for On Board tests is not supported. Hence, the tester must provide a version of lxMemory.ini 
which contains parameters for the MIC board type being tested.
To manage testing of different board types, on the same test system, this parameter can be used to identify the board 
type being tested, and which parameter file will be used for testing.
When one of the On Board tests starts this value is passed to lxmic_obtest.sh which uses it to create a soft link from 
the generic parameter filename lxMemory.ini to a board type specific parameter file named: lxMemory_<MIC Board 
SKU><mic_id>.ini
See On Board Test Operation for more information on the format of OnBoard parameter file names.

When the On Board test is run it will use this link to get the correct parameters for the MIC card being tested.

Default
PRODUCT_CS

Dependencies
Required

Used by
Test 4 - On Board Memory Size Check
Test 5 - On Board CPU Count Check
Test 6 - On Board Sliding Ones Test
Test 7 - On Board Random Data Test
Test 8 - On Board Cache Random Data Test

See Also
Parameters

1.31. Onboard Memory Size

Description
Size in MB of available memory in MIC uOS environment.  This value is automatically set during automatic 
configuration for Onboard tests.  During automatic configuration this value is copied into the configuration file for the 
MIC board SKU indicated by MIC Board SKU.

See the lxMemory documentation for a description of this parameter, and how it is used by the lxMemory test module.

Default
7692

Dependencies
Required

Used by
Test 4 - On Board Memory Size Check
Test 6 - On Board Sliding Ones Test
Test 7 - On Board Random Data Test
Test 8 - On Board Cache Random Data Test

See Also
Parameters

1.32. Onboard Memory Accuracy

Description
Amount, in MB, that the memory available in the MIC uOS environment may vary from the size specified by Onboard 
Memory Size, and still pass the Onboard Memory Size check. During automatic configuration this value is copied into 
the configuration file for the MIC board SKU indicated by MIC Board SKU.

See the lxMemory documentation for a description of this parameter, and how it is used by the lxMemory test module.


Default
16

Dependencies
Required

Used by
Test 4 - On Board Memory Size Check

See Also
Parameters

1.33. Onboard Window Size

Description
Size, in MB, of memory windows used in Onboard Memory and Cache testing. During automatic configuration this value 
is copied into the configuration file for the MIC board SKU indicated by MIC Board SKU.

See the lxMemory documentation for a description of this parameter, and how it is used by the lxMemory test module

Default
0x14000

Dependencies
Required

Used by
Test 6 - On Board Sliding Ones Test
Test 7 - On Board Random Data Test
Test 8 - On Board Cache Random Data Test

See Also
Parameters

1.34. Onboard Reserved Memory

Description
Size, in MB, of the MIC uOS reserved memory. During automatic configuration this value is copied into the configuration 
file for the MIC board SKU indicated by MIC Board SKU.

See the lxMemory documentation for a description of this parameter, and how it is used by the lxMemory test module

Default
512

Dependencies
Required

Used by
Test 4 - On Board Memory Size Check
Test 5 - On Board CPU Count Check

See Also
Parameters

1.35. Onboard Cache CPU Count

Description
If defined, this parameter specifies the number of CPUs to use when running Onboard Cache tests.  This parameter is 
used to limit the number of CPUs used to run the Onboard Cache tests. If this parameter is not defined the Onboard 
Cache tests will be configured to test all the CPU Caches.

See the lxMemory documentation for a description of this parameter, and how it is used by the lxMemory test module

Default
32

Dependencies
Optional

Used by
Test 8 - On Board Cache Random Data Test

See Also
Parameters

1.36. Onboard Cache Size

Description
Size of MIC CPU Caches.

See the lxMemory documentation for a description of this parameter, and how it is used by the lxMemory test module


Default
0x80000

Dependencies
Required

Used by
Test 8 - On Board Cache Random Data Test

See Also
Parameters

1.37. OnboardSlidingOnesTimeoutSecPerGB

Description
This parameter specifies the number of seconds per GigByte of available OnBoard memory to let Test 6 - On Board 
Sliding Ones Test run before failing the test due to a timeout.

GigBytes of available memory is calculated by dividing the value of Onboard Memory Size by 1024.


Default
128

Dependencies
Optional

Used by
Test 6 - On Board Sliding Ones Test

See Also
Parameters

1.38. OnboardRandomMemTimeoutSecPerGB

Description
This parameter specifies the number of seconds per GigByte of available OnBoard memory to let Test 7 - On Board 
Random Data Test run before failing the test due to a timeout.

GigBytes of available memory is calculated by dividing the value of Onboard Memory Size by 1024.


Default
32

Dependencies
Optional

Used by
Test 7 - On Board Random Data Test

See Also
Parameters

1.39. StressStartScript

Description
Specifies a user supplied script which will start a user defined stress test on the target MIC PCIe add-in card.  The 
script must accept one parameter, which is the name of the target MIC PCIe add-in card. This name will be of the form 
mic# (i.e. mic0, mic1, mic2 ...).
After the script starts the test is should terminate, while leaving the test running.


Default
None

Dependencies
Required

Used by
Test 9 - Memory Stress Test

See Also
Parameters

1.40. StressDelayTime

Description
Specifies the time, in seconds, that Test 9 - Memory Stress Test should delay after starting the user specified stress 
test, using the user supplied script specified by: .  After this delay time is completed, the stress test will be stopped 
using the user supplied script specified by: 


Default
None

Dependencies
Required

Used by
Test 9 - Memory Stress Test

See Also
Parameters

1.41. StressStopScript

Description
Specifies a user supplied script which will stop the user defined stress test started by: .  The script must accept one 
parameter, which is the name of the target MIC PCIe add-in card. This name will be of the form mic# (i.e. mic0, mic1, 
mic2 ...).


Default
None

Dependencies
Required

Used by
Test 9 - Memory Stress Test

See Also
Parameters

1.42. Error Codes


ERROR codes formatted as 0xMMMTTEEE 

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

EEE	Message
001  	Unable to retrieve parameter: ____ Return Code ____
002  	Invalid test number ___
003  	Error setting parameter ____
004  	Internal error: ___ with error number: ____
005  	Invalid value for  ___ of: ___
006  	uOS Boot Flag file ____ not created
007	uOS Boot failed ____
008	____ value error. Expected ____ Actual ____
009	Memory Size Error, Expected ____ Actual ____
00A	Memory Size File ____ not created
00B	MIC Memory End ____ exceeds Memory Size ____
00C	MIC Reset failed ____
00D	MIC On-Board Test Failed to start
010	On-Board Output File ____ Not Created
012	Unable to open file ____
013	Script ___ timed out after ____ seconds
014	MIC On-Board Test Reports Error: ____
015	On Board Test parameter file: ____ not found
017	Unable to ReConfigure MPSS Service
018	On Board Test did not send TEST DONE message
019	MIC device ____ no available: ____: ____
101	uOS Boot Failure: Unable to get MIC Usage mode: ____
102	MIC Memory Error at address range ____ through ___  Expected ____ Actual ____ <Additional information 
about failure>
103	MIC Access ____ error ____
104	Unknown memory subtest type: ____
105	Memory Start ____ is greater than Memory End ____
106	Maximum Window Size is: ____
107	Address Sequence value must be greater than 0
108	Memory Allocation Error, size: ____
109	MIC API Initialization failed: ____
10A	Invalid Data Width: ____
10B	MIC Memory Diag. handler not found at: ____

Debug Help:

Error 004 indicates that an internal error has been detected.
Error 006  indicates a problem with write permission on the CTC directory
Error 007 indicates the MIC uOS will not boot. Check setup and install of MIC PCIe card and software.
Error 009 indicates a problem with the setup of the MIC SW stack
Error 00A  indicates a problem with write permission on the CTC directory
Error 00C indicates a problem with MIC card reset.  The MIC Card may be hung, and may require a host system reboot 
to recover.
Error 00D The current On-Board test did not start. The MIC Card may be hung, and unable to boot the MIC uOS. This 
may require a host system reboot to recover.
Error 010 Unable to create file for storing output from an On-Board test. Check file permissions in CTC directory.
Error 012 Unable to create/open a file in the CTC directory. Check file permissions in CTC directory.
Error 013 On-Board test timed out. The On-Board test took much longer to run than expected. Check On-Board test's 
parameters, in lxMemory<SKU>.ini to see if On-Board test can be configured to run faster.
Error 014 On-Board test reported and error. This message records that error message in the CTC logs. Check lxMemory 
help file for information on the error. 
Error 015 On-Board test configuration file for MIC Board SKU not found. Use procedure described in On Board Test 
Operation to create one.
Error 017 The MPSS ReConfiguration failed.  It may be necessary to reinstall the MPSS RPMs.
Error 018 The On Board test had a major failure, such as a Segmentation Fault, and did not complete normally.
Error 019 MPSS library call failed for the MIC device. Error includes name of library call which failed, and error message 
from libmicmgmt. This indicates a problem with the interaction between the MPSS libmicmgmt, and the MIC card 
under test.
Error 101 indicates a problem with the setup of the MIC SW stack
Error 102 The host based MIC memory check found corrupt data in the range described.  Additional information about 
the failure provides information about automatic retries.
Error 103 indicates a problem with the setup of the MIC SW stack
Error 106 means the user has set a Window Size which is larger than the MIC SW stack's maximum window size
Error 109 indicates a problem with the setup of the MIC SW stack
Error 10A indicates user specified invalid Data Width. See TestDataWidth for valid Data Widths
Error 10B indicates that the MIC Memory Diagnostic handler md_handler_k1om.elf must be copied to the specified 
location.

header text	 


footer text	 Page 
