1. lxMicFRU

1.1. Overview

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

Version:	2.02.1.0001
Released:	07/31/2012

Purpose
This test module reads and writes the manufacturing data to the FRU (Field Replacable Unit). The module sends IPMI Commands for FRU access to the Baseboard Management Controller (BMC) on supported server systems, once the IMB driver is installed. The IPMB command is passed on to the SMC on the Many Integrated Cores (MIC) PCI-e card.

Runtime Environment
The Intel(R) Modular Test Architecture Test Executive for Linux template module.

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.






1.2. Version Info

 
Date	Version		Owner		Comments
04/27/2012	2.00.1.0001		AYK		Initial release
05/30/2012	2.01.1.0001		AYK		New parameters for SMC read address and bus. Auto-configure now checks for all possible read addresses. 
07/31/2012	2.02.1.0001		AYK		New test for writing and verifying the FRU contents.
				

1.3. Installation

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

In addition, the Linux IMB driver must be installed, and the host board BMC must support the BMC to SMC communication. Please see project contact for a list of supported host boards. This release was tested on Intel Workstation Board W2600CR2.




1.4. Sub-Tests


Test 0	Auto-Configuration

Test 50	FRU_Read

Test 26	FRU_Write

Test 27	FRU_WriteAndVerify

[****]

1.5. Test 0 - Auto-Configuration

Overview

Auto-Configure checks for the existence of the MIC SMC by communicating with it via the BMC on the host board. There are 8 slots for the MIC SMC cards. If a slot is used, it makes the placeholder for the FRU read-write tests for that specific slot, and assigns  the slot identification number, device id and read address to the parameters.  The default parameters are read from the package file for each slot.

Parameter(s)

The following parameters are written by this test:
DeviceId
Slot
MicRdAddr
MicRdBus

Test Execution Time

This test takes approximately 3-4 minutes to execute.

Dependencies/Limitations

If the BMC is not detected on the host board, or the host board does not support BMC to SMC communication, or the IMB driver is not installed in the OS, or the MIC card cannot be found in the specified PCIe slot, or the SMC on the MIC card does not respond, the test will remove itself.





1.6. Test 50 - FRU_read

Overview
This utility gets the FRU inventory, reads and displays the FRU data of interest to the manufacturing. Specifically, the following data is displayed:

	 Manufacturer Name
	 Product name   
	 Product part/model number 
	 UUID 
	 Manufacturing date/time 
	 Product serial number  


Parameter(s)
Slot
MicRdAddr
MicRdBus

Test Execution Time

Test time is variable depending on number of bus errors occuring, and the delay required after each. 

Dependencies/Limitations
If the BMC is not detected on the host board, or the host board does not support BMC to SMC communication, or the IMB driver is not installed in the OS, or the MIC card cannot be found in the specified PCIe slot, or the SMC on the MIC card does not respond, the test will fail.

1.7. Test  26 - FRU_Write

Overview

This utility writes the manufacturing data to the FRU. It writes the default data as well as the specific data that should be updated by manufacturing. It writes the first 0x87 bytes of the FRU. 

Specifically, it accepts these FRU items as inputs from the user 
	 Manufacturer Name - set in the package file.
	 Product name   - set in the package file.
	 Product part/model number - the input filename will be set in the package file.
	 Product serial number  - the input filename will be set in the package file.
	 UUID (offsets 0x53-0x62)  - the program generates a unique UUID every time. 
	 Manufacturing date/time - the current date/time is written to the FRU.

Parameter(s)
Slot
MicRdAddr
MicRdBus
MicFRUMfName
MicFRUProductName
MicFRUSerialNumberFile


Test Execution Time

Test time is about 1 second

Dependencies/Limitations
If the BMC is not detected on the host board, or the host board does not support BMC to SMC communication, or the IMB driver is not installed in the OS, or the MIC card cannot be found in the specified PCIe slot, or the SMC on the MIC card does not respond, the test will fail.

1.8. Test  27 - FRU_WriteAndVerify

Overview

This utility writes the manufacturing data to the FRU. It writes the default data as well as the specific data that should be updated by manufacturing. It writes the first 0x87 bytes of the FRU. 

Specifically, it accepts these FRU items as inputs from the user 
	 Manufacturer Name - set in the package file.
	 Product name   - set in the package file.
	 Product part/model number - the input filename will be set in the package file.
	 Product serial number  - the input filename will be set in the package file.
	 UUID (offsets 0x53-0x62)  - the program generates a unique UUID every time. 
	 Manufacturing date/time - the current date/time is written to the FRU.

   After writing to the FRU, the test reads the contents of the FRU and verifies if the FRU contains the expected data.

Parameter(s)
Slot
MicRdAddr
MicRdBus
MicFRUMfName
MicFRUProductName
MicFRUSerialNumberFile


Test Execution Time

Test time is about 1 second

Dependencies/Limitations
If the BMC is not detected on the host board, or the host board does not support BMC to SMC communication, or the IMB driver is not installed in the OS, or the MIC card cannot be found in the specified PCIe slot, or the SMC on the MIC card does not respond, the test will fail.

1.9. Parameters

Slot
MicRdAddr
MicRdBus
DeviceId
MicFRUMfName
MicFRUProductName
MicFRUSerialNumberFile
[****]





1.10. Slot

Description

Parameter indicates the IPMI slot information. Set to the correct slot number. 

Auto-Configure checks to see if the slot is filled with the SMC card. If the slot is used, it makes the placeholder for the FRU read-write tests for that specific slot, and assigns  the Slot identification number to the parameter.


Default
-

Dependencies

Required

Used by

Auto-Configure
FRU_Read
FRU_Write

See Also

Parameters

1.11. MicRdAddr

Description

Parameter indicates either the IPMI unique ID or the slave address (8 bit "write" address), dependent on the "Address Type" (see MicRdAddressType parameter) field. 

See "IPMI Intelligent Platform Management Interface Specification Second Generation v2.0" for complete information.


Default
	
	MicRdAddr = 0x30

Valid Range

	The read address can be an even number from 0x30 to 0x4E.

Dependencies

Required

Used by

Auto-Configure
FRU_Read
FRU_Write

See Also

Parameters

1.12. MicRdBus

Description

Parameter indicates the IPMI address information. It is one byte long, broken up as follows:
[7:6] Address Type
	00b = Bus/Slot/Address
	01b = Reserved for unique identifier
[5:4] Reserved
[3:0] Bus number. Set to 0 for "Address Type" not "Bus/Slot/Address"

See "IPMI Intelligent Platform Management Interface Specification Second Generation v2.0" for complete information.


Default
   MicRdBus = 0x02

Dependencies

Required

Used by

Auto-Configure
FRU_Read
FRU_Write

See Also

Parameters

1.13. DeviceId

Description

The Device ID of the SMC on the MIC card.

Auto-Configure checks to see if the slot is filled with the SMC card. If the slot is used, it makes the placeholder for the FRU read-write tests for that specific slot, and assigns  the SMC device ID to the parameter.

Default
	 
   DeviceID = 0x540001

Dependencies

Required

Used by

Auto-Configure


See Also

Parameters

1.14. MicFRUMfName

Description

Parameter indicates the manufacturing name to be written to the SMC FRU.

Default

	MicFRUMfName ="Intel Corporation"

Dependencies

Required

Used by

Auto-Configure
FRU_Write

See Also

Parameters

1.15. MicFRUProductName

Description

Parameter indicates the product name to be written to the SMC FRU.

Default

MicFRUProductName = "Knights Corner"

Dependencies

Required

Used by

Auto-Configure
FRU_Write

See Also

Parameters

1.16. MicFRUSerialNumberFile

Description

Parameter indicates the file name to be read for writing the Serial number and production code or 
model number to the SMC FRU.

The format of this input file is as expected below:

	SERIALNUMBER=<SerialNumber>        
	PRODUCTCODE=<Productcode>          
             
where 
<SerialNumber> is 12 alphanumeric characters without spaces e.g. 1234567890AB
<Productcode> is 10 alphanumeric characters without spaces e.g. 123456-001

These lines can exist at any place in the file, but they have to be present. 

Default

	MicFRUSerialNumberFile = "lxMicSerNum.txt"

Dependencies

Required

Used by

Auto-Configure
FRU_Write

See Also

Parameters

1.17. Error Codes


ERROR codes formatted as 0xMMMTTEEE 

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

Error Code   	Message
52501003 	Invalid test number (X).
5252601F	Test_name: Error writing FRU data.
52526020   Test_name: Error reading Serial number and Product code from file: 'filename'
52516021   Test_name: <paramname> parameter exceeds length. Expected: <expected length> Actual: <actual length>
52526022	Test_name: Error in manufacturing date (year): <year>.
52526023	Test_name: Error writing parameter <parameter> : value - <value> for slot <slot number>.
52526024	Test_name: Read FRU Inventory size of Zero.


Overall Debug Hints:
Ensure the MIC card is plugged into correct slot, as indicated in SlotId.

Make sure the IMB driver is correctly installed on the host system. Check with this command:
rpm -qa | grep imb

The host baseboard must support BMC to SMC communication. 

See "IPMI Intelligent Platform Management Interface Specification Second Generation v2.0" for complete IPMI command information.

1.18. Glossary


Term	Definition

FRU	Field Replaceable Unit (typically includes information such as Serial Number, GUID, Manufacturer ID, Product Name, etc)

GUID	Guaranteed Unique ID

Host Board	The baseboard into which the MIC card is plugged via a PCI-e slot. 

MIC	Many Integrated Cores - an add-in card with processors and memory, to offload compute intensive processing

SDR	Sensor Data Repository

SEL	System Event Log

SMC	System Management Controller - similar to the BMC on the host board. It controls temperatures and other intelligent board management.

uOS	micro-OS - an embedded OS on the MIC card, which runs separately from the OS on the host board.

Usage mode	The mode which the MIC card is booted in. There are multiple modes, including Normal (for regular usage), Maintenance (to perform card maintenance), etc.

UUT	Unit Under Test - the MIC card which is being tested.
