summaryrefslogtreecommitdiffstats
path: root/src/usr/xscom/test/xscomtest.H
blob: a3d7076cea1cd4adb2a998a29a94a3b849922d38 (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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/xscom/test/xscomtest.H $                              */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2011,2019                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* 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                                                     */
#ifndef __XCOMTEST_H
#define __XCOMTEST_H

/**
 *  @file xscomtest.H
 *
 *  @brief Test case for XSCOM code
*/

#include <cxxtest/TestSuite.H>
#include <errl/errlmanager.H>
#include <errl/errlentry.H>
#include <devicefw/userif.H>
#include <xscom/xscomreasoncodes.H>

extern trace_desc_t* g_trac_xscom;

using namespace TARGETING;

// Address and data to read/write
struct testXscomAddrData
{
    uint32_t addr;
    uint64_t data;
};

// Test table values
const testXscomAddrData g_xscomAddrTable[] =
{
        // Write data to be ORed with read value
        // Use EXP0.EC.PCC1.COMMON.SPR_COMMON.SCR0 and
        //EXP0.EC.PCC1.COMMON.SPR_COMMON.SCR1
        // Scom registers for testing
        {0x21010A86, 0x0000040000000000},
        {0x21010A87, 0xC000000000000000},
};
const uint32_t g_xscomAddrTableSz =
                    sizeof(g_xscomAddrTable)/sizeof(testXscomAddrData);


// Test table values written through xscom
const testXscomAddrData g_xscomMultiWriteTable[] =
{
        // Scom registers to write
        // Scratch reg 3
        {0x20010A89, 0x1000000000000000},
        {0x21010A89, 0x0200000000000000},
        {0x22010A89, 0x0030000000000000},
        {0x23010A89, 0x0004000000000000},
        // Local checkstop regs
        {0x10040018, 0x1000000000000000},  // ChipletID 0x10
        {0x20040018, 0x1000000000000000},  // ChipletID 0x20
};
const uint32_t g_xscomMultiWriteTableSz =
                sizeof(g_xscomMultiWriteTable)/sizeof(testXscomAddrData);


// Test table values read through multicast op
const testXscomAddrData g_xscomMultiReadTable[] =
{
        // Scratch reg 3
        //   Multicast OR op
        {0x41010a89, 0x1234000000000000},
        // Local checkstop regs
        //   ChipletID 0x10 0x20
        //   Multicast BITWISE op
        {0x50040018, 0x0000800080000000},
};
const uint32_t g_xscomMultiReadTableSz =
                sizeof(g_xscomMultiReadTable)/sizeof(testXscomAddrData);


class XscomTest: public CxxTest::TestSuite
{
public:

    /**
     * @brief XSCOM test #1
     *        Write value and read back to verify
     */
    void testXscom1(void)
    {

        TARGETING::TargetService& l_targetService = TARGETING::targetService();
        TARGETING::Target* l_testTarget = NULL;
        l_targetService.masterProcChipTargetHandle( l_testTarget );
        assert(l_testTarget != NULL);

        size_t l_size = sizeof(uint64_t);

        // Loop thru table
        errlHndl_t l_err = NULL;
        for( uint32_t l_num=0; l_num < g_xscomAddrTableSz; l_num++)
        {
             testXscomAddrData l_testEntry = g_xscomAddrTable[l_num];

             // Perform XSComOM read
             uint64_t l_readData = 0;
             uint64_t l_writeData = 0;
             uint64_t l_savedData = 0;
             l_err = deviceRead(l_testTarget,
                                &l_readData,
                                l_size,
                                DEVICE_SCOM_ADDRESS(l_testEntry.addr));
             if (l_err)
             {
                 TS_FAIL("testXscom1: XSCom read: deviceRead() fails! Error committed.");
                 break;
             }
             else
             {
                 TS_TRACE("testXscom1: XSCom read, Address 0x%.8X, Data %llx",
                                                      l_testEntry.addr,
                                                      (long long unsigned)l_readData);
             }

             // Perform an XSCom write
             l_savedData = l_readData;
             l_writeData = (l_readData | l_testEntry.data);
             l_err = deviceWrite(l_testTarget,
                                 &l_writeData,
                                 l_size,
                                 DeviceFW::SCOM,
                                 l_testEntry.addr);

             if (l_err)
             {
                 TS_FAIL("testXscom1: XSCom write: deviceWrite() fails!");
                 break;
             }
             else
             {
                 TS_TRACE("testXscom1: XSCom write, Address 0x%.8X, Data %llx",
                         l_testEntry.addr,
                         (long long unsigned)l_writeData);
             }

             // Read back
             l_readData = 0;
             l_err = deviceRead(l_testTarget,
                                &l_readData,
                                l_size,
                                DEVICE_SCOM_ADDRESS(l_testEntry.addr));
             if (l_err)
             {
                 TS_FAIL("testXscom1: XSCom read back: deviceRead() fails!");
                 break;
             }

             if( l_readData != l_writeData )
             {
                 TS_FAIL("testXscom1: XSCom read back doesn't match write!");
                 /*@
                  * @errortype
                  * @moduleid     XSCOM::XSCOM_TEST_XSCOM1
                  * @reasoncode   XSCOM::XSCOM_DATA_UNMATCHED
                  * @userdata1    Write value
                  * @userdata2    Read back value
                  * @devdesc      Read back value doesn't match write
                  */
                 l_err = new ERRORLOG::ErrlEntry(
                         ERRORLOG::ERRL_SEV_INFORMATIONAL,
                         XSCOM::XSCOM_TEST_XSCOM1,
                         XSCOM::XSCOM_DATA_UNMATCHED,
                         l_writeData,
                         l_readData);
                 break;
             }

             // Write back original value
             l_err = deviceWrite(l_testTarget,
                      &l_savedData,
                      l_size,
                      DeviceFW::SCOM,
                      l_testEntry.addr);

              if (l_err)
              {
                  TS_FAIL("testXscom1: XSCom write back original fails!");
                  break;
              }
        }

        if (l_err)
        {
            TS_FAIL("testXscom1 failed!  Error committed.");
            errlCommit(l_err,XSCOM_COMP_ID);
        }
        else
        {
            TS_TRACE("testXscom1 runs successfully!");
        }
        return;
  }


    /**
     * @brief XSCOM test #2
     *        Write value and read back to verify
     */
    void testXscom2(void)
    {

        TARGETING::TargetService& l_targetService = TARGETING::targetService();
        TARGETING::Target* l_testTarget = NULL;
        l_targetService.masterProcChipTargetHandle( l_testTarget );
        assert(l_testTarget != NULL);

        size_t l_size = sizeof(uint64_t);

        uint64_t l_readData = 0;
        uint64_t l_writeData[g_xscomAddrTableSz];
        uint64_t l_savedData[g_xscomAddrTableSz];

        // Loop thru table to do initial write
        errlHndl_t l_err = NULL;
        for( uint32_t l_num=0; l_num < g_xscomAddrTableSz; l_num++)
        {
            testXscomAddrData l_testEntry = g_xscomAddrTable[l_num];

            // Perform XSComOM read
            l_err = deviceRead(l_testTarget,
                               &l_readData,
                               l_size,
                               DEVICE_SCOM_ADDRESS(l_testEntry.addr));
            if (l_err)
            {
                TS_FAIL("testXscom2: XSCom read: deviceRead() fails! Error committed.");
                break;
            }
            else
            {
                TS_TRACE("testXscom2: XSCom read, Address 0x%.8X, Data %llx",
                         l_testEntry.addr,
                         (long long unsigned)l_readData);
            }

            // Perform an XSCom write
            l_savedData[l_num] = l_readData;
            l_writeData[l_num] = (l_readData | l_testEntry.data);
            l_err = deviceWrite(l_testTarget,
                                &l_writeData[l_num],
                                l_size,
                                DeviceFW::SCOM,
                                l_testEntry.addr);

            if (l_err)
            {
                TS_FAIL("testXscom2: XSCom write: deviceWrite() fails!");
                break;
            }
            else
            {
                TS_TRACE("testXscom2: XSCom write, Address 0x%.8X, Data %llx",
                         l_testEntry.addr,
                         (long long unsigned)l_writeData);
            }
        }

        // Loop through table to do the read and verify
        for( uint32_t l_num=0; l_num < g_xscomAddrTableSz; l_num++)
        {
            testXscomAddrData l_testEntry = g_xscomAddrTable[l_num];

            // Read back
            l_readData = 0;
            l_err = deviceRead(l_testTarget,
                               &l_readData,
                               l_size,
                               DEVICE_SCOM_ADDRESS(l_testEntry.addr));
            if (l_err)
            {
                TS_FAIL("testXscom2: XSCom read back: deviceRead() fails!");
                break;
            }

            if( l_readData != l_writeData[l_num] )
            {
                TS_FAIL("testXscom2: XSCom read back doesn't match write!");
                /*@
                 * @errortype
                 * @moduleid     XSCOM::XSCOM_TEST_XSCOM2
                 * @reasoncode   XSCOM::XSCOM_DATA_UNMATCHED
                 * @userdata1    Write value
                 * @userdata2    Read back value
                 * @devdesc      Read back value doesn't match write
                 */
                l_err = new ERRORLOG::ErrlEntry(
                                                ERRORLOG::ERRL_SEV_INFORMATIONAL,
                                                XSCOM::XSCOM_TEST_XSCOM1,
                                                XSCOM::XSCOM_DATA_UNMATCHED,
                                                l_writeData[l_num],
                                                l_readData);
                break;
            }

            // Write back original value
            l_err = deviceWrite(l_testTarget,
                                &l_savedData[l_num],
                                l_size,
                                DeviceFW::SCOM,
                                l_testEntry.addr);

            if (l_err)
            {
                TS_FAIL("testXscom2: XSCom write back original fails!");
                break;
            }
        }

        if (l_err)
        {
            TS_FAIL("testXscom2 failed!  Error committed.");
            errlCommit(l_err,XSCOM_COMP_ID);
        }
        else
        {
            TS_TRACE("testXscom2 runs successfully!");
        }
        return;
    }


    //TODO: RTC34591 - Add testcase that talks to the non master proc.

    /**
     * @brief XSCOM test #3
     *        read to an invalid address to force error path
     */
    void testXscom3(void)
    {

        TARGETING::TargetService& l_targetService = TARGETING::targetService();
        TARGETING::Target* l_testTarget = NULL;
        l_targetService.masterProcChipTargetHandle( l_testTarget );
        assert(l_testTarget != NULL);
        errlHndl_t l_err = NULL;

        size_t l_size = sizeof(uint64_t);


        // Perform XSComOM read
        uint64_t l_readData = 0;
        l_err = deviceRead(l_testTarget,
                           &l_readData,
                           l_size,
                           DEVICE_SCOM_ADDRESS(0x01001111));
        if (l_err)
        {

            TS_TRACE("testXscom3: XSCom read fails as expected: invalid addr");
            errlCommit(l_err,XSCOM_COMP_ID);
            TS_TRACE("testXscom3 runs successfully!");
        }
        else
        {
            TS_FAIL("testXscom3: XSCom read did not fail with bad address");
        }


        return;
    }


    /**
     * @brief XSCOM test #4
     *        Write regs and read as multicast to verify
     */
    void testXscom4(void)
    {

        TARGETING::TargetService& l_targetService = TARGETING::targetService();
        TARGETING::Target* l_testTarget = NULL;
        l_targetService.masterProcChipTargetHandle( l_testTarget );
        assert(l_testTarget != NULL);

        size_t l_size = sizeof(uint64_t);

        errlHndl_t l_err = NULL;
        uint32_t l_num;

        do {
#if defined(CONFIG_EARLY_TESTCASES) || defined(CONFIG_AXONE_BRING_UP)
            TS_TRACE("testXscom4: Skipping test, multicast groups not setup yet");
            break;
#endif

            // Loop thru write table
            for( l_num=0; l_num < g_xscomMultiWriteTableSz; l_num++)
            {
                testXscomAddrData l_testEntry = g_xscomMultiWriteTable[l_num];

                // Perform an XSCom write
                uint64_t l_writeData = l_testEntry.data;
                l_err = deviceWrite( l_testTarget,
                                    &l_writeData,
                                    l_size,
                                    DeviceFW::SCOM,
                                    l_testEntry.addr );

                if (l_err)
                {
                    TS_FAIL("testXscom4: XSCom write: deviceWrite() fails!");
                    break;
                }
                else
                {
                    TS_TRACE("testXscom4: XSCom write, Address 0x%.8X, Data %llx",
                             l_testEntry.addr,
                             (long long unsigned)l_writeData);
                }
            }

            if (l_err)
            {
                break;
            }

            // Read back as multicast, should see combined data
            // Multicast OP type (BITWISE / OR) defined in the address
            for( l_num=0; l_num < g_xscomMultiReadTableSz; l_num++)
            {
                testXscomAddrData l_testEntry = g_xscomMultiReadTable[l_num];

                uint64_t l_readData = 0;
                l_err = deviceRead(l_testTarget,
                                    &l_readData,
                                    l_size,
                                    DEVICE_SCOM_ADDRESS(l_testEntry.addr));

                if (l_err)
                {
                    TS_FAIL("testXscom4: XSCom multicast read back: deviceRead() fails!");
                    break;
                }
                else
                {
                    TS_TRACE("testXscom4: result addr 0x%X data 0x%llX",l_testEntry.addr ,l_readData);
                }

                if( l_readData != l_testEntry.data )
                {
                    TS_FAIL("testXscom4: XSCom multicast read back doesn't match write for %.8X!", l_testEntry.addr);
                    /*@
                    * @errortype
                    * @moduleid     XSCOM::XSCOM_TEST_XSCOM4
                    * @reasoncode   XSCOM::XSCOM_DATA_UNMATCHED
                    * @userdata1    Write value
                    * @userdata2    Multicast read back value
                    * @devdesc      Read back value doesn't match write
                    */
                    l_err = new ERRORLOG::ErrlEntry(
                            ERRORLOG::ERRL_SEV_INFORMATIONAL,
                            XSCOM::XSCOM_TEST_XSCOM4,
                            XSCOM::XSCOM_DATA_UNMATCHED,
                            l_testEntry.data,
                            l_readData);
                    break;
                }
            }

        } while(0);

        if (l_err)
        {
            TS_FAIL("testXscom4 failed!  Error committed.");
            errlCommit(l_err,XSCOM_COMP_ID);
        }
        else
        {
            TS_TRACE("testXscom4 runs successfully!");
        }
        return;
  }


};

#endif
OpenPOWER on IntegriCloud