diff options
Diffstat (limited to 'src/usr/spd/spd.H')
| -rwxr-xr-x | src/usr/spd/spd.H | 261 |
1 files changed, 261 insertions, 0 deletions
diff --git a/src/usr/spd/spd.H b/src/usr/spd/spd.H new file mode 100755 index 000000000..65f85119a --- /dev/null +++ b/src/usr/spd/spd.H @@ -0,0 +1,261 @@ +// IBM_PROLOG_BEGIN_TAG +// This is an automatically generated prolog. +// +// $Source: src/usr/spd/spd.H $ +// +// IBM CONFIDENTIAL +// +// COPYRIGHT International Business Machines Corp. 2012 +// +// p1 +// +// Object Code Only (OCO) source materials +// Licensed Internal Code Source Materials +// IBM HostBoot Licensed Internal Code +// +// The source code for this program is not published or other- +// wise divested of its trade secrets, irrespective of what has +// been deposited with the U.S. Copyright Office. +// +// Origin: 30 +// +// IBM_PROLOG_END +#ifndef __SPD_H +#define __SPD_H + +/** + * @file spd.H + * + * @brief Provides the interfaces for the SPD device driver + * + */ + +// ---------------------------------------------- +// Includes +// ---------------------------------------------- +#include <errl/errltypes.H> + +namespace SPD +{ + +/** +* @brief Miscellaneous enumerations for SPD +*/ +enum +{ + MEM_TYPE_ADDR = 0x2, // DIMM Basic Memory Type address + MEM_TYPE_ADDR_SZ = 0x1, // DIMM Basic Memory Type address size + + // Basic Memory Type Enumerations + SPD_DDR3 = 0xB, + SPD_DDR4 = 0xC, // TODO - Proposed value from draft Spec. +}; + +/** +* @brief Structure to define the lookup table for SPD keywords +* for DIMMs. +*/ +struct KeywordData +{ + uint16_t keyword; // SPD keyword this data corresponds to + uint8_t offset; // Byte offset in the SPD data + uint8_t length; // Number of bytes to retrieve + bool useBitMask; // Use the bitmask to mask off bits, if true, length must be + // l byte, unless it is a "special" case + uint8_t bitMask; // Bit mask + uint8_t shift; // Used for fields < 1 byte to right justify all values. + bool isSpecialCase; // Whether or not this entry is a special case. +}; + + +/** +* +* @brief Perform an SPD operation. It follows a pre-defined +* prototype function in order to be registered with the device +* driver framework. +* +* @param[in] i_opType - Operation Type - See DeviceFW::OperationType in +* driververif.H +* +* @param[in] i_target - DIMM Target device +* +* @param [in/out] io_buffer - Pointer to the data that was read from +* the target device. It will also be used to contain data to +* be written to the device. +* +* @param [in/out] io_buflen - Length of the buffer to be read or written +* to/from the target. This value should indicate the size of the +* io_buffer parameter that has been allocated. Being returned it will +* indicate the number of valid bytes in the buffer being returned. +* +* @param [in] i_accessType - Access Type - See DeviceFW::AccessType in +* usrif.H +* +* @param [in] i_args - This is an argument list for the device driver +* framework. +* +* @return errlHndl_t - NULL if successful, otherwise a pointer to the +* error log. +* +*/ +errlHndl_t spdAccess ( DeviceFW::OperationType i_opType, + TARGETING::Target * i_target, + void * io_buffer, + size_t & io_buflen, + int64_t i_accessType, + va_list i_args ); + +/** + * @brief This function is used to read SPD keywords from collected + * SPD data for the given target + * + * @param[in] i_keyword - The SPD keyword to access. + * + * @param[in/out] io_buffer - The buffer that will contain the data + * read from the SPD data. + * + * @param[in/out] io_buflen - The requested number of bytes to read. + * The actual number of bytes read will be returned. + * + * @param[in] i_target - The target DIMM to access the data for. + * + * @return errlHndl_t - NULL if successful, otherwise a pointer to the + * error log. + */ +errlHndl_t spdGetKeywordValue ( uint64_t i_keyword, + void * io_buffer, + size_t & io_buflen, + TARGETING::Target * i_target ); + +/** + * @brief This function is used to write SPD keyword values. + * + * @param[in] i_keyword - The SPD keyword to access. + * + * @param[in/out] io_buffer - The buffer that will contain the data + * read from the SPD data. + * + * @param[in/out] io_buflen - The requested number of bytes to read. + * The actual number of bytes read will be returned. + * + * @param[in] i_target - The target DIMM to access the data for. + * + * @return errlHndl_t - NULL if successful, otherwise a pointer to the + * error log. + */ +errlHndl_t spdWriteKeywordValue ( uint64_t i_keyword, + void * io_buffer, + size_t & io_buflen, + TARGETING::Target * i_target ); + +/** + * @param This function is a wrapper for reading the correct keyword. + * It will route the read to whatever function has the latest + * supported access code. + * + * @param[in] i_byteAddress - The offset into the JEDEC SPD layout. + * + * @param[in] i_numbytes - Number of bytes to read. + * + * @param[out] o_data - The data buffer that will return the data read. + * + * @param[in] i_target - The target DIMM to access. + * + * @return errlHndl_t - NULL if successful, otherwise a pointer to the + * error log. + */ +errlHndl_t spdFetchData ( uint64_t i_byteAddr, + size_t i_numBytes, + void * o_data, + TARGETING::Target * i_target ); + +/** + * @param This function will read the SPD keyword from the appropriate + * table. + * + * @param[in] i_keyword - The SPD keyword to access. + * + * @param[in/out] io_buffer - The buffer that will contain the data + * read from the SPD data. + * + * @param[in/out] io_buflen - The requested number of bytes to read. + * The actual number of bytes read will be returned. + * + * @param[in] i_target - The target DIMM to access the data for. + * + * @param[in] i_DDRRev - The DIMM DDR Revision. + * + * @return errlHndl_t - NULL if successful, otherwise a pointer to the + * error log. + */ +errlHndl_t spdGetValue ( uint64_t i_keyword, + void * io_buffer, + size_t & io_buflen, + TARGETING::Target * i_target, + uint64_t i_DDRRev ); + +/** + * @param This function handles the special case keywords where + * the data isn't sequential, or is broken up between two different + * offsets within the layout. + * + * @param[in] i_keyword - The SPD keyword to access. + * + * @param[in/out] io_buffer - The buffer that will contain the data + * read from the SPD data. + * + * @param[in/out] io_buflen - The requested number of bytes to read. + * The actual number of bytes read will be returned. + * + * @param[in] i_target - The target DIMM to access the data for. + * + * @param[in] i_entry - The table entry for the keyword to read. + * + * @return errlHndl_t - NULL if successful, otherwise a pointer to the + * error log. + */ +errlHndl_t spdSpecialCases ( uint64_t i_keyword, + void * io_buffer, + size_t & io_buflen, + TARGETING::Target * i_target, + uint64_t i_entry, + uint64_t i_DDRRev ); + +/** + * @brief This function checks to make sure that the buffer allocated + * is large enough to hold the data that needs to be returned. + * + * @param[in] i_bufferSz - The size of the buffer passed in by the caller. + * + * @param[in] i_expBufferSz - The expected buffer size for the keyword + * requested. + * + * @param[in] i_keyword - The SPD Keyword requested. + * + * @return errlHndl_t - NULL if successful, otherwise a pointer to the + * error log. + */ +errlHndl_t spdCheckSize ( size_t i_bufferSz, + size_t i_expBufferSz, + uint64_t i_keyword ); + +/** + * @brief This function will read a binary file from PNOR. This is + * not the long term solution, but mainly for initial testing. + * + * @param[in] i_byteAddr - The byte offset into the SPD layout. + * + * @param[in] i_bytes - Number of bytes to access. + * + * @param[out] o_data - The data buffer containing the data read. + * + * @return errlHndl_t - NULL if successful, otherwise a pointer to the + * error log. + */ +errlHndl_t spdReadBinaryFile ( uint64_t i_byteAddr, + size_t i_numBytes, + void * o_data ); + +}; // end SPD namespace + +#endif // __SPD_H |
