summaryrefslogtreecommitdiffstats
path: root/src/usr/hwpf/fapi/fapiHwAccess.C
blob: 02cb8c9ff167c638808eb4d0acb9e4fc7cc513b3 (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
//  IBM_PROLOG_BEGIN_TAG
//  This is an automatically generated prolog.
//
//  $Source: src/usr/hwpf/fapi/fapiHwAccess.C $
//
//  IBM CONFIDENTIAL
//
//  COPYRIGHT International Business Machines Corp. 2011
//
//  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
/**
 *  @file fapiHwAccess.C
 *
 *  @brief Implements the fapiHwAccess.H functions at a high level,
 *  allowing for scand common tracing to occur before and after
 *  the call to the platform-specific worker. 
 *
 *  Note that platform code must provide the implementation.
 */

/*
 * Change Log ******************************************************************
 * Flag     Defect/Feature  User        Date        Description
 * ------   --------------  ----------  ----------- ----------------------------
 *                          copelanm    09/13/2011  new for common scan traces
 *                          mjjones     09/14/2011  Prepended fapi to functions
 *                                                  and enabled all functions
 *                          mjjones     10/13/2011  util namespace change
 */

#include <fapi.H>
#include <fapiPlatHwAccess.H>

extern "C"
{

//******************************************************************************
// fapiGetScom function
//******************************************************************************
fapi::ReturnCode fapiGetScom(const fapi::Target& i_target,
                             const uint64_t i_address,
                             ecmdDataBufferBase & o_data)
{
    fapi::ReturnCode l_rc;
    char l_string[fapi::MAX_ECMD_STRING_LEN] = {0};
    bool l_traceit = platIsScanTraceEnabled(); 


    if( l_traceit )
    {
        // get the string representation of the target  
        i_target.toString(l_string);


        FAPI_SCAN( "TRACE : GETSCOM     : START : %s : %.16llX", 
                   l_string,
                   i_address ); 
    }

    // call the platform implementation
    l_rc = platGetScom( i_target, i_address, o_data );


    if( l_traceit )
    {
        FAPI_SCAN( "TRACE : GETSCOM     : END   : %s : %.16llX %.16llX", 
                   l_string,
                   i_address,
                   o_data.getDoubleWord( 0 ) ); 
    }

    return l_rc;
}


//******************************************************************************
// fapiPutScom function
//******************************************************************************
fapi::ReturnCode fapiPutScom(const fapi::Target& i_target,
                             const uint64_t i_address,
                             ecmdDataBufferBase & i_data)
{
    fapi::ReturnCode l_rc;
    char l_string[fapi::MAX_ECMD_STRING_LEN] = {0};
    bool l_traceit = platIsScanTraceEnabled(); 

    if( l_traceit )
    {
        // get the string representation of the target  
        i_target.toString(l_string);

        FAPI_SCAN( "TRACE : PUTSCOM     : START : %s : %.16llX %.16llX", 
                   l_string,
                   i_address,
                   i_data.getDoubleWord( 0 )  ); 
    }

    // call the platform implemenation  
    l_rc = platPutScom( i_target, i_address, i_data );


    if( l_traceit )
    {
        FAPI_SCAN( "TRACE : PUTSCOM     : END   : %s : %.16llX", 
                   l_string,
                   i_address );
    }

    return l_rc;
}

//******************************************************************************
// fapiPutScomUnderMask function
//******************************************************************************
fapi::ReturnCode fapiPutScomUnderMask(const fapi::Target& i_target,
                                      const uint64_t i_address,
                                      ecmdDataBufferBase & i_data,
                                      ecmdDataBufferBase & i_mask)
{
    fapi::ReturnCode l_rc;
    char l_string[fapi::MAX_ECMD_STRING_LEN] = {0};
    bool l_traceit = platIsScanTraceEnabled(); 

    if( l_traceit )
    {
        // get the string representation of the target
        i_target.toString(l_string);

        FAPI_SCAN( "TRACE : PUTSCOMMASK : START : %s : %.16llX %.16llX %.16llX", 
               l_string,
               i_address,
               i_data.getDoubleWord(0),
               i_mask.getDoubleWord(0));
    }

    // call the platform implementation
    l_rc = platPutScomUnderMask( i_target, i_address, i_data, i_mask );

    if( l_traceit )
    {
        FAPI_SCAN( "TRACE : PUTSCOMMASK : END   : %s : %.16llX", 
               l_string,
               i_address );
    }
    return l_rc;
}

//******************************************************************************
// fapiGetCfamRegister function
//******************************************************************************
fapi::ReturnCode fapiGetCfamRegister(const fapi::Target& i_target,
                                     const uint32_t i_address,
                                     ecmdDataBufferBase & o_data)
{
    fapi::ReturnCode l_rc;
    char l_string[fapi::MAX_ECMD_STRING_LEN] = {0};
    bool l_traceit = platIsScanTraceEnabled();

    if( l_traceit )
    {
        // get the string representation of the target
        i_target.toString(l_string);

        FAPI_SCAN( "TRACE : GETCFAMREG  : START : %s : %.16llX", 
               l_string,
               i_address ); 
    }

    // call the platform implementation
    l_rc = platGetCfamRegister( i_target, i_address, o_data );

    if( l_traceit )
    {
        FAPI_SCAN( "TRACE : GETCFAMREG  : END   : %s : %.16llX %.16llX", 
               l_string,
               i_address,
               o_data.getDoubleWord(0) ); 
    }

    return l_rc;
}

//******************************************************************************
// fapiPutCfamRegister function
//******************************************************************************
fapi::ReturnCode fapiPutCfamRegister(const fapi::Target& i_target,
                                     const uint32_t i_address,
                                     ecmdDataBufferBase & i_data)
{
    fapi::ReturnCode l_rc;
    char l_string[fapi::MAX_ECMD_STRING_LEN] = {0};
    bool l_traceit = platIsScanTraceEnabled(); 

    if( l_traceit )
    {
        // get the string representation of the target  
        i_target.toString(l_string);

        FAPI_SCAN( "TRACE : PUTCFAMREG  : START : %s : %.16llX %.16llX", 
               l_string,
               i_address,
               i_data.getDoubleWord(0) );
    } 

    // call the platform implementation
    l_rc = platPutCfamRegister( i_target, i_address, i_data );


    if( l_traceit )
    {
        FAPI_SCAN( "TRACE : PUTCFAMREG  : END   : %s : %.16llX", 
               l_string,
               i_address ); 
    }
    return l_rc;
}

//******************************************************************************
// fapiModifyCfamRegister function
//******************************************************************************
fapi::ReturnCode fapiModifyCfamRegister(const fapi::Target& i_target,
                                        const uint32_t i_address,
                                        ecmdDataBufferBase & i_data,
                                        const fapi::ChipOpModifyMode i_modifyMode)
{
    fapi::ReturnCode l_rc;
    char l_string[fapi::MAX_ECMD_STRING_LEN] = {0};
    bool l_traceit = platIsScanTraceEnabled(); 
    const char * l_pMode = NULL;

    if( l_traceit )
    {
        // get the string representation of the target  
        i_target.toString(l_string);

        // get string representation of the modify mode
        if (i_modifyMode == fapi::CHIP_OP_MODIFY_MODE_OR)
        {
            l_pMode = "OR";
        }
        else if (i_modifyMode == fapi::CHIP_OP_MODIFY_MODE_AND)
        {
            l_pMode = "AND";
        }
        else if (i_modifyMode == fapi::CHIP_OP_MODIFY_MODE_XOR)
        {
            l_pMode = "XOR";
        }
        else
        {
            l_pMode = "?";
        }

        FAPI_SCAN( "TRACE : MODCFAMREG  : START : %s : %.16llX %.16llX %s", 
               l_string,
               i_address,
               i_data.getDoubleWord(0),
               l_pMode ); 
    }

    // call the platform implementation
    l_rc = platModifyCfamRegister( i_target, i_address, i_data, i_modifyMode );

    if( l_traceit )
    {
        FAPI_SCAN( "TRACE : MODCFAMREG  : END   : %s : %llX %s", 
               l_string,
               i_address,
               l_pMode ); 
    }

    return l_rc;
}

} // extern "C"
OpenPOWER on IntegriCloud