summaryrefslogtreecommitdiffstats
path: root/src/usr/hwpf/hwp/dram_training/mss_draminit_trainadv/mss_generic_shmoo.H
blob: df73008ee7b81560527e11953c83a6e28ec1937d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/hwpf/hwp/dram_training/mss_draminit_trainadv/mss_generic_shmoo.H $ */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2012,2013              */
/*                                                                        */
/* 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 otherwise         */
/* divested of its trade secrets, irrespective of what has been           */
/* deposited with the U.S. Copyright Office.                              */
/*                                                                        */
/* Origin: 30                                                             */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
// $Id: mss_generic_shmoo.H,v 1.13 2013/04/09 12:18:47 lapietra Exp $
// *!***************************************************************************
// *! (C) Copyright International Business Machines Corp. 1997, 1998
// *!           All Rights Reserved -- Property of IBM
// *!                   *** IBM Confidential ***
// *!***************************************************************************
// *! FILENAME             : mss_generic_shmoo.H
// *! TITLE                : MSS Generic Shmoo 
// *! DESCRIPTION          : Memory Subsystem Generic Shmoo -- abstraction for HB
// *! CONTEXT              : To make all shmoos share a common abstraction layer
// *!
// *! OWNER  NAME          : Varkey Varghese          Email: varkey.kv@in.ibm.com
// *! BACKUP NAME          : Abhijit Saurabh          Email:  abhijit.saurabh@in.ibm.com   
// *!
// *!***************************************************************************
// CHANGE HISTORY:
//------------------------------------------------------------------------------
// Version:|Author: | Date:  | Comment:
// --------|--------|--------|--------------------------------------------------
//   1.11  |abhijit |1/21/13 |fixed constructor definition  
//   1.9   |abhijit |06/12/12|fixed fw review comments 
//   1.4   |abhijit |09/27/11|made changes according to new design
//   1.5   |abhijit |10/29/12|made changes after target and returncode 
//   1.6   |abhijit |10/29/12|made changes  
//   1.7   |abhijit |11/15/12|made changes for fw review comments 
//------------------------------------------------------------------------------
#include <fapi.H>

#ifndef generic_shmoo_H
#define generic_shmoo_H

using namespace fapi;
//! Globals
#define SHMOO_DEBUG 0
#define SHMOO_DEBUG2 0
#include "mss_shmoo_common.H"
#include "mss_mcbist.H"



//! MSS Generic Shmoo Class.. Inherits from PHY access class and the knob abstraction 
class generic_shmoo
{
    private:
        
        
        //! MBS Config : Port + Socket + Knobs
        struct SHMOO_SCENARIO{
            struct MBS_CONFIG{
               struct PORT{
                   struct RANK{
                        shmoo_knob_data_t K; // Set of knobs used by this shmoo 
                   }S[MAX_RANK];
               } P[MAX_PORT];
           }MBA;
           shmoo_knob_config_t static_knob; // Static info regarding the knob
        }SHMOO[MAX_SHMOO]; // Denote max shmoo scenarios we have
     
        //! Result Data 
	
        uint8_t convergence_gap;
        shmoo_algorithm_t algorithm;
        shmoo_mode mcbist_mode;
        uint8_t mcbist_error_map[MAX_PORT][MAX_RANK][MAX_BYTE][MAX_NIBBLES];
		uint8_t schmoo_error_map[MAX_PORT][MAX_RANK][20];
		shmoo_type_t shmoo_mask;
	uint8_t iv_addr;
	uint8_t iv_MAX_RANKS[MAX_PORT];
	uint8_t iv_MAX_BYTES;
	uint8_t iv_pattern;
	uint8_t iv_test_type;
	uint8_t iv_dmm_type;
	uint8_t iv_DQS_ON;
	uint8_t iv_shmoo_type;
	uint32_t iv_shmoo_param;
	uint8_t valid_rank[MAX_RANK];

        
    public:
        
    
	
	
        enum bound_t { LEFT , RIGHT};    
     
        generic_shmoo(uint8_t iv_addr,shmoo_type_t shmoo_mask,shmoo_algorithm_t shmoo_algorithm);// Constructor
        generic_shmoo(){};
        ~generic_shmoo(){};  // Destructor
        void  init_multi_array(uint32_t (&array)[MAX_DQ][MAX_RPS],uint32_t init_val); //initialize multi dim arrays to known value
	fapi::ReturnCode init_multi_array_dqs(uint32_t (&array)[MAX_DQ][MAX_RPS],uint32_t init_val);
        fapi::ReturnCode get_all_noms(const fapi::Target & i_target); //! Read in all the Nominal values of the relevant knobs
        fapi::ReturnCode find_bound(const fapi::Target & i_target,bound_t); // generic Right bound
        fapi::ReturnCode knob_update(const fapi::Target & i_target,bound_t bound,uint8_t scenario,uint8_t bit,uint8_t pass,bool &flag); // Increment or decrement the knob
	fapi::ReturnCode knob_update_dqs(const fapi::Target & i_target,bound_t bound,uint8_t scenario,uint8_t rank,uint8_t byte,uint8_t nibble,uint8_t bit,uint8_t pass);
        fapi::ReturnCode print_report(const fapi::Target & i_target); // Print Shmoo report to file or STDOUT
        fapi::ReturnCode print_shmoo_parms();
	fapi::ReturnCode get_margin(const fapi::Target & i_target);
	fapi::ReturnCode get_min_margin(const fapi::Target & i_target,uint32_t *o_right_min_margin,uint32_t *o_left_min_margin);
        fapi::ReturnCode do_mcbist_test(const fapi::Target & i_target);
        fapi::ReturnCode  check_error_map(const fapi::Target & i_target,uint8_t port,uint8_t &pass);
        fapi::ReturnCode sanity_check(const fapi::Target & i_target);
		fapi::ReturnCode schmoo_setup_mcb( const fapi::Target & i_target);
        fapi::ReturnCode run(const fapi::Target & i_target,uint32_t *right_min_margin,uint32_t *left_min_margin,uint8_t i_pattern,uint8_t i_test_type,uint32_t i_shmoo_param);
};
#endif
OpenPOWER on IntegriCloud