summaryrefslogtreecommitdiffstats
path: root/src/sbefw/sbecmdsram.C
blob: ac11ffc6b0972c3251288617bb7ca8f163dc3bc1 (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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/sbefw/sbecmdsram.C $                                      */
/*                                                                        */
/* OpenPOWER sbe Project                                                  */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2016                             */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
/*
 * @file: ppe/sbe/sbefw/sbecmdsram.C
 *
 * @brief This file contains the SBE Sram Access chipOps
 *
 */

#include "sbecmdsram.H"
#include "sbefifo.H"
#include "sbe_sp_intf.H"
#include "sbetrace.H"
#include "sbeFifoMsgUtils.H"
#include "sberegaccess.H"

#include "fapi2.H"
#include "p9_pm_ocb_init.H"
#include "p9_pm_ocb_indir_setup_linear.H"
#include "p9_pm_ocb_indir_access.H"
#include "p9_perv_scom_addresses.H"

using namespace fapi2;


///////////////////////////////////////////////////////////////////////
// @brief sbeOccSramAccess_Wrap Occ Sran Access Wrapper function
//
// @param [in] i_isGetFlag Flag to indicate the sram Access Type
//                 true  : GetOccSram ChipOp
//                 false : PutOccSram ChipOp
//
// @return  RC from the underlying FIFO utility
///////////////////////////////////////////////////////////////////////
uint32_t sbeOccSramAccess_Wrap(const bool i_isGetFlag)
{
    #define SBE_FUNC " sbeOccSramAccess_Wrap "
    SBE_ENTER(SBE_FUNC);

    uint32_t l_rc = SBE_SEC_OPERATION_SUCCESSFUL;

    ReturnCode l_fapiRc = FAPI2_RC_SUCCESS;

    sbeRespGenHdrWithLen_t l_respHdr;
    l_respHdr.init();
    sbeResponseFfdc_t l_ffdc;

    // Total Returned length from the procedure
    uint32_t l_totalReturnLen = 0;

    // Create the req struct for the OCC Sram Chip-op
    sbeOccSramAccessReqMsgHdr_t l_req = {0};

    // Check if True - Get / False - Put
    p9ocb::PM_OCB_ACCESS_OP l_ocb_access =
            (i_isGetFlag)? p9ocb::OCB_GET : p9ocb::OCB_PUT;

    do
    {
        // Get the Req Struct Size Data from upstream Fifo
        uint32_t l_len2dequeue  = sizeof(l_req) / sizeof(uint32_t);
        l_rc = sbeUpFifoDeq_mult (l_len2dequeue,
                                  (uint32_t *)&l_req,
                                  i_isGetFlag);

        // If FIFO failure
        if (SBE_SEC_OPERATION_SUCCESSFUL != l_rc)
        {
            // Let command processor routine to handle the RC.
            break;
        }

        SBE_INFO("mode [0x%08X] addr[0x%08X] len[0x%08X]",
             l_req.mode, l_req.addr, l_req.len);

        // Get the Proc Chip Target to be passed in to the procedure call
        Target<fapi2::TARGET_TYPE_PROC_CHIP> l_proc = plat_getChipTarget();

        // Do linear setup for indirect access HWP for Chan0, Chan2 and Chan3
        // For Circular Mode, Chan1 is assumed to be setup by default
        // Linear mode is setup with Linear streaming mode only

        // Sram Access condition to pass valid address during the first access
        bool l_validAddrForFirstAccess = true;

        // Channel Selection based on Mode as well as Fsp attchament
        p9ocb::PM_OCB_CHAN_NUM l_chan = p9ocb::OCB_CHAN0;
        switch(l_req.mode)
        {
            case NORMAL_MODE:
                if(false == SbeRegAccess::theSbeRegAccess().isFspSystem())
                {
                    l_chan = p9ocb::OCB_CHAN2;
                }
                break;

            case DEBUG_MODE:
                l_chan = p9ocb::OCB_CHAN3;
                break;

            case CIRCULAR_MODE:
                l_chan = p9ocb::OCB_CHAN1;
                l_validAddrForFirstAccess = false;
                break;

            default:
                SBE_ERROR(SBE_FUNC "Invalid Mode Passed by User");
                l_rc = SBE_SEC_GENERIC_FAILURE_IN_EXECUTION;
                l_respHdr.respHdr.setStatus( SBE_PRI_INVALID_DATA, l_rc);
                break;
        }
        if (SBE_SEC_OPERATION_SUCCESSFUL != l_rc)
        {
            break;
        }

        // Setup Needs to be called in Normal and Debug Mode only
        if( (l_req.mode == NORMAL_MODE) || (l_req.mode == DEBUG_MODE) )
        {
            l_fapiRc = p9_pm_ocb_indir_setup_linear(l_proc, l_chan,
                                                    p9ocb::OCB_TYPE_LINSTR,
                                                    l_req.addr);
            if(l_fapiRc != FAPI2_RC_SUCCESS)
            {
                SBE_ERROR(SBE_FUNC "p9_pm_ocb_indir_setup_linear failed, "
                    "Channel[0x%02X] Addr[0x%08X]",
                    l_chan, l_req.addr);

                // Respond with HWP FFDC
                l_respHdr.respHdr.setStatus(SBE_PRI_GENERIC_EXECUTION_FAILURE,
                                         SBE_SEC_GENERIC_FAILURE_IN_EXECUTION);
                l_ffdc.setRc(l_fapiRc);
                break;
            }
        }

        //Create a 128 Byte Buffer -  16 64-Bit buffer
        // This is our Granule size as well for this HWP
        uint32_t l_getBuf[SBE_OCC_SRAM_GRANULE/SBE_32BIT_ALIGN_FACTOR] = {};
        uint32_t l_remainingLen = l_req.len; // Initialize with Total Len
        uint32_t l_lenPassedToHwp = 0;
        uint32_t l_actLen = 0;  // Return Len from Hwp not used

        while(l_remainingLen)
        {
            if(l_remainingLen <= SBE_OCC_SRAM_GRANULE)
            {
                l_lenPassedToHwp = l_remainingLen;
            }
            else
            {
                l_lenPassedToHwp = SBE_OCC_SRAM_GRANULE;
            }
            l_remainingLen = l_remainingLen - l_lenPassedToHwp;

            // Fetch buffer from Upstream Fifo for the HWP if it is PutOCC Sram
            if(!i_isGetFlag)
            {
                l_len2dequeue = (l_lenPassedToHwp/SBE_32BIT_ALIGN_FACTOR);
                l_rc = sbeUpFifoDeq_mult ( l_len2dequeue,
                                           l_getBuf,
                                           false);
                // If there was an underlying FIFO operation failure
                if (SBE_SEC_OPERATION_SUCCESSFUL != l_rc)
                {
                    // Let command processor routine to handle the RC.
                    break;
                }
            }

            // Don't need to put any check for Linear/Circular - It's the same
            // API for access, For circular valid address flag is false, Hwp
            // doesn't need the address field from us.
            l_fapiRc = p9_pm_ocb_indir_access(
                    l_proc,
                    l_chan,
                    l_ocb_access, // Get/Put
                    (l_lenPassedToHwp/SBE_64BIT_ALIGN_FACTOR), // 64-bit aligned
                    l_validAddrForFirstAccess, // If requested addr is valid
                    l_req.addr, // Requested Addr being passed
                    l_actLen, // O/p from hwp not used
                    (uint64_t *)l_getBuf); // O/p buffer
            if(l_fapiRc != FAPI2_RC_SUCCESS)
            {
                SBE_ERROR(SBE_FUNC "p9_pm_ocb_indir_access failed, "
                 "Channel[0x%02X] Addr[0x%08X] 64Bit Aligned Len[0x%08X]",
                 l_chan, l_req.addr, (l_lenPassedToHwp/SBE_64BIT_ALIGN_FACTOR));

                // Respond with HWP FFDC
                l_respHdr.respHdr.setStatus(SBE_PRI_GENERIC_EXECUTION_FAILURE,
                                         SBE_SEC_GENERIC_FAILURE_IN_EXECUTION);
                l_ffdc.setRc(l_fapiRc);
                break;
            }

            l_totalReturnLen = l_totalReturnLen + l_lenPassedToHwp;
            // Change this to false, so that Indirect Access Hwp doesn't
            // reset the Address to starting point.
            l_validAddrForFirstAccess = false;

            if(i_isGetFlag) // Get Occ Sram
            {
                l_len2dequeue = (l_lenPassedToHwp/SBE_32BIT_ALIGN_FACTOR);
                // Push this into the downstream FIFO
                l_rc = sbeDownFifoEnq_mult (l_len2dequeue, l_getBuf);

                // If FIFO failure
                if (SBE_SEC_OPERATION_SUCCESSFUL != l_rc)
                {
                    // Let command processor routine to handle the RC.
                    break;
                }
            }
        } // End of while Put/Get from Hwp

        // If there was a FIFO error, will skip sending the response,
        // instead give the control back to the command processor thread
        if ( SBE_SEC_OPERATION_SUCCESSFUL != l_rc )
        {
            break;
        }

        do
        {
            l_len2dequeue = 0;
            if (!i_isGetFlag)
            {
                // If there was a HWP failure for put sram occ request,
                // need to Flush out upstream FIFO, until EOT arrives
                if ( l_fapiRc != FAPI2_RC_SUCCESS )
                {
                    l_rc = sbeUpFifoDeq_mult(l_len2dequeue, NULL,
                                             true, true);
                    if ( SBE_SEC_OPERATION_SUCCESSFUL != l_rc )
                    {
                        break;
                    }
                }
                // For other success paths, just attempt to offload
                // the next entry, which is supposed to be the EOT entry
                else
                {
                    l_rc = sbeUpFifoDeq_mult(l_len2dequeue, NULL, true);
                    if ( SBE_SEC_OPERATION_SUCCESSFUL != l_rc )
                    {
                        break;
                    }
                }
            }

            // Distance to Header is minus the length field in the response
            // buffer. So when we do sizeof(l_respHdr) It will add an extra byte
            // for the length. So it compensates for the length, if we start the
            // distance from hdr as zero.
            uint32_t l_dist2Hdr = 0;

            // Now enqueue the minimum response header
            // first enqueue the length of data actually written
            l_respHdr.setLength(l_totalReturnLen);
            uint32_t l_len = sizeof(l_respHdr) / sizeof(uint32_t);
            l_rc = sbeDownFifoEnq_mult(l_len, (uint32_t *)(&l_respHdr));

            if ( SBE_SEC_OPERATION_SUCCESSFUL != l_rc )
            {
                break;
            }

            l_dist2Hdr += l_len;

            // Enqueue FFDC data if there is one
            if( l_ffdc.getRc() )
            {
                l_len = sizeof(l_ffdc) / sizeof(uint32_t);
                l_rc = sbeDownFifoEnq_mult (l_len, (uint32_t *)(&l_ffdc));
                if ( SBE_SEC_OPERATION_SUCCESSFUL != l_rc )
                {
                    break;
                }

                l_dist2Hdr += l_len;
            }

            l_len = sizeof(l_dist2Hdr) / sizeof(uint32_t);
            l_rc = sbeDownFifoEnq_mult ( l_len, &l_dist2Hdr);

            if ( SBE_SEC_OPERATION_SUCCESSFUL != l_rc )
            {
                break;
            }
        }while(0);
    }while(0);

    SBE_EXIT(SBE_FUNC);
    return l_rc;
    #undef SBE_FUNC
}


//////////////////////////////////////////////////////
//////////////////////////////////////////////////////
uint32_t sbePutOccSram (uint8_t *i_pArg)
{
    #define SBE_FUNC " sbePutOccSram "
    return sbeOccSramAccess_Wrap (false);
    #undef SBE_FUNC
}

/////////////////////////////////////////////////////
//////////////////////////////////////////////////////
uint32_t sbeGetOccSram (uint8_t *i_pArg)
{
    #define SBE_FUNC " sbeGetOccSram "
    return sbeOccSramAccess_Wrap (true);
    #undef SBE_FUNC
}

OpenPOWER on IntegriCloud