summaryrefslogtreecommitdiffstats
path: root/src/usr/hwpf/hwp/nest_chiplets/proc_start_clocks_chiplets/proc_start_clocks_chiplets.C
blob: ae76464fe211b71799181fd5cdac21df57ec21a8 (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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
/*  IBM_PROLOG_BEGIN_TAG
 *  This is an automatically generated prolog.
 *
 *  $Source: src/usr/hwpf/hwp/nest_chiplets/proc_start_clocks_chiplets/proc_start_clocks_chiplets.C $
 *
 *  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_TAG
 */
// $Id: proc_start_clocks_chiplets.C,v 1.5 2012/08/08 12:05:11 rkoester Exp $
// $Source: /afs/awd/projects/eclipz/KnowledgeBase/.cvsroot/eclipz/chips/p8/working/procedures/ipl/fapi/proc_start_clocks_chiplets.C,v $
//------------------------------------------------------------------------------
// *|
// *! (C) Copyright International Business Machines Corp. 2011
// *! All Rights Reserved -- Property of IBM
// *! *** IBM Confidential ****
// *|
// *! TITLE       : proc_start_clocks_chiplets.H
// *! DESCRIPTION : Start X/A/PCIE chiplet clocks (FAPI)
// *!
// *! OWNER NAME  : Ralph Koester           Email: rkoester@de.ibm.com
// *! BACKUP NAME : Gebhard Weber           Email: gweber@de.ibm.com
// *!
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include "proc_start_clocks_chiplets.H"

extern "C"
{


//------------------------------------------------------------------------------
// function: utility subroutine to clear chiplet fence in GP3 register
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_clear_chiplet_fence(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    uint32_t rc_ecmd = 0;
    ecmdDataBufferBase mask_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_GP3_AND_0x000F0013;

    FAPI_DBG("proc_start_clocks_chiplet_clear_chiplet_fence: Start");

    do
    {
        // form AND mask to clear chiplet fence bit
        rc_ecmd |= mask_data.flushTo1();
        rc_ecmd |= mask_data.clearBit(GP3_FENCE_EN_BIT);
        if (rc_ecmd)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_chiplet_fence: Error 0x%x setting up data buffer to clear chiplet fence",
                     rc_ecmd);
            rc.setEcmdError(rc_ecmd);
            break;
        }

        // write chiplet GP3 AND mask register to clear fence bit
        rc = fapiPutScom(i_target, scom_addr, mask_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_chiplet_fence: fapiPutScom error (GP3_AND_0x%08X)",
                     scom_addr);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_clear_chiplet_fence: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to clear pervasive fence in GP0 register
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_clear_perv_fence(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    uint32_t rc_ecmd = 0;
    ecmdDataBufferBase mask_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_GP0_AND_0x00000004;

    FAPI_DBG("proc_start_clocks_chiplet_clear_perv_fence: Start");

    do
    {
        // form AND mask to clear pervasive fence bit
        rc_ecmd |= mask_data.flushTo1();
        rc_ecmd |= mask_data.clearBit(GP0_PERV_FENCE_BIT);
        if (rc_ecmd)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_perv_fence: Error 0x%x setting up data buffer to clear pervasive fence",
                     rc_ecmd);
            rc.setEcmdError(rc_ecmd);
            break;
        }

        // write chiplet GP0 AND mask register to clear pervasive fence bit
        rc = fapiPutScom(i_target, scom_addr, mask_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_perv_fence: fapiPutScom error (GP0_AND_0x%08X)",
                     scom_addr);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_clear_perv_fence: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to set functional mode clock mux selects
//           in GP0 register
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_set_mux_selects(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    uint32_t rc_ecmd = 0;
    ecmdDataBufferBase mask_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_GP0_AND_0x00000004;

    FAPI_DBG("proc_start_clocks_chiplet_set_mux_selects: Start");

    do
    {
        // form AND mask to clear mux selects
        rc_ecmd |= mask_data.flushTo1();
        rc_ecmd |= mask_data.clearBit(GP0_ABSTCLK_MUXSEL_BIT);
        rc_ecmd |= mask_data.clearBit(GP0_SYNCCLK_MUXSEL_BIT);
        if (rc_ecmd)
        {
            FAPI_ERR("proc_start_clocks_chiplet_set_mux_selects: Error 0x%x setting up data buffer to clear chiplet mux selects",
                     rc_ecmd);
            rc.setEcmdError(rc_ecmd);
            break;
        }

        // write chiplet GP0 AND mask register to clear mux selects
        rc = fapiPutScom(i_target, scom_addr, mask_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_set_mux_selects: fapiPutScom error (GP0_AND_0x%08X)",
                     scom_addr);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_set_mux_selects: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to clear scan select register
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_clear_clk_scansel_reg(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    ecmdDataBufferBase zero_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_CLK_SCANSEL_0x00030007;

    FAPI_DBG("proc_start_clocks_chiplet_clear_clk_scansel_reg: Start");

    do
    {
        // clear chiplet scan select register
        rc = fapiPutScom(i_target, scom_addr, zero_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_clk_scansel_reg: fapiPutScom error (CLK_SCANSEL_0x%08X)",
                     scom_addr);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_clear_clk_scansel_reg: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to set clock region register (starts clocks)
// parameters: i_target                 => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_set_clk_region_reg(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    uint32_t rc_ecmd = 0;
    ecmdDataBufferBase data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_CLK_REGION_0x00030006;

    FAPI_DBG("proc_start_clocks_chiplet_set_clk_region_reg: Start");

    do
    {
        // start NSL/array clocks
        rc_ecmd |= data.setDoubleWord(0, PROC_START_CLOCKS_CHIPLETS_CLK_REGION_REG_START_NSL_ARY);
        if (rc_ecmd)
        {
            FAPI_ERR("proc_start_clocks_chiplet_set_clk_region_reg: Error 0x%x setting up data buffer for NSL/ARY clock start",
                     rc_ecmd);
            rc.setEcmdError(rc_ecmd);
            break;
        }

        rc = fapiPutScom(i_target, scom_addr, data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_set_clk_region_reg: fapiPutScom error (CLK_REGION_0x%08X)",
                     scom_addr);
            break;
        }

        // start all clocks
        rc_ecmd |= data.setDoubleWord(0, PROC_START_CLOCKS_CHIPLETS_CLK_REGION_REG_START_ALL);
        if (rc_ecmd)
        {
            FAPI_ERR("proc_start_clocks_chiplet_set_clk_region_reg: Error 0x%x setting up data buffer for SL/NSL/ARY clock start",
                     rc_ecmd);
            rc.setEcmdError(rc_ecmd);
            break;
        }

        rc = fapiPutScom(i_target, scom_addr, data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_set_clk_region_reg: fapiPutScom error (CLK_REGION_0x%08X)",
                     scom_addr);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_set_clk_region_reg: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to check clock status register to ensure
//           all desired clock domains have been started
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
//             i_status_reg_exp    => expected value for clock status register
//                                    after clock start
// returns: FAPI_RC_SUCCESS if operation was successful, else
//          RC_PROC_START_CLOCKS_CHIPLETS_CLK_STATUS_ERR if status register
//          data does not match expected pattern
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_check_clk_status_reg(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr,
    const uint64_t i_status_reg_exp)
{
    fapi::ReturnCode rc;
    ecmdDataBufferBase status_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_CLK_STATUS_0x00030008;

    FAPI_DBG("proc_start_clocks_chiplet_check_clk_status_reg: Start");

    do
    {
        // read clock status register
        rc = fapiGetScom(i_target, scom_addr, status_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_check_clk_status_reg: fapiGetScom error (CLK_STATUS_0x%08X)",
                     scom_addr);
            break;
        }

        // check that value matches expected pattern
        // set a unique HWP_ERROR
        if (status_data.getDoubleWord(0) != i_status_reg_exp)
        {
            FAPI_ERR("proc_start_clocks_chiplet_check_clk_status_reg: Clock status register actual value (%016llX) does not match expected value (%016llX)",
                     status_data.getDoubleWord(0), i_status_reg_exp);
            ecmdDataBufferBase & STATUS_REG = status_data;
            uint32_t CHIPLET_BASE_SCOM_ADDR = i_chiplet_base_addr;
            FAPI_SET_HWP_ERROR(rc, RC_PROC_START_CLOCKS_CHIPLETS_CLK_STATUS_ERR);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_check_clk_status_reg: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to clear force align in GP0 register
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_clear_force_align(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    uint32_t rc_ecmd = 0;
    ecmdDataBufferBase mask_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_GP0_AND_0x00000004;

    FAPI_DBG("proc_start_clocks_chiplet_clear_force_align: Start");

    do
    {
        // form AND mask to clear force align bit
        rc_ecmd |= mask_data.flushTo1();
        rc_ecmd |= mask_data.clearBit(GP0_FORCE_ALIGN_BIT);
        if (rc_ecmd)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_force_align: Error 0x%x setting up data buffer to clear force align",
                     rc_ecmd);
            rc.setEcmdError(rc_ecmd);
            break;
        }

        // write chiplet GP0 AND mask register to clear force align bit
        rc = fapiPutScom(i_target, scom_addr, mask_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_force_align: fapiPutScom error (GP0_AND_0x%08X)",
                     scom_addr);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_clear_force_align: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to clear flushmode inhibit in GP0 register
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_clear_flushmode_inhibit(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    uint32_t rc_ecmd = 0;
    ecmdDataBufferBase mask_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_GP0_AND_0x00000004;

    FAPI_DBG("proc_start_clocks_chiplet_clear_flushmode_inhibit: Start");

    do
    {
        // form AND mask to clear force align bit
        rc_ecmd |= mask_data.flushTo1();
        rc_ecmd |= mask_data.clearBit(GP0_FLUSHMODE_INHIBIT_BIT);
        if (rc_ecmd)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_flushmode_inhibit: Error 0x%x setting up data buffer to clear flushmode inhibit",
                     rc_ecmd);
            rc.setEcmdError(rc_ecmd);
            break;
        }

        // write chiplet GP0 AND mask register to clear force align bit
        rc = fapiPutScom(i_target, scom_addr, mask_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_clear_flushmode_inhibit: fapiPutScom error (GP0_AND_0x%08X)",
                     scom_addr);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_clear_flushmode_inhibit: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to check chiplet FIR register for errors
//           after clocks have been started
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
// returns: FAPI_RC_SUCCESS if operation was successful, else
//          RC_PROC_START_CLOCKS_CHIPLETS_FIR_ERR if FIR register data doesn't
//          match expected pattern
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplet_check_fir(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr)
{
    fapi::ReturnCode rc;
    ecmdDataBufferBase fir_data(64);
    uint32_t scom_addr = i_chiplet_base_addr |
                         GENERIC_XSTOP_0x00040000;

    FAPI_DBG("proc_start_clocks_chiplet_check_fir: Start");

    do
    {
        // read chiplet FIR register
        rc = fapiGetScom(i_target, scom_addr, fir_data);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_chiplet_check_fir: fapiGetScom error (XSTOP_0x%08X)",
                     scom_addr);
            break;
        }

        // check that value matches expected pattern
        // set a unique HWP_ERROR
        if (fir_data.getDoubleWord(0) !=
            PROC_START_CLOCKS_CHIPLETS_CHIPLET_FIR_REG_EXP)
        {
            FAPI_ERR("proc_start_clocks_chiplet_check_fir: FIR register actual value (%016llX) does not match expected value (%016llX)",
                     fir_data.getDoubleWord(0), PROC_START_CLOCKS_CHIPLETS_CHIPLET_FIR_REG_EXP);
            ecmdDataBufferBase & FIR_REG = fir_data;
            uint32_t CHIPLET_BASE_SCOM_ADDR = i_chiplet_base_addr;
            FAPI_SET_HWP_ERROR(rc, RC_PROC_START_CLOCKS_CHIPLETS_FIR_ERR);
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_chiplet_check_fir: End");

    return rc;
}


//------------------------------------------------------------------------------
// function: utility subroutine to run clock start sequence on a generic chiplet
// parameters: i_target            => chip target
//             i_chiplet_base_addr => base SCOM address for chiplet
//             i_status_reg_exp    => expected value for clock status register
//                                    after clock start
// returns: FAPI_RC_SUCCESS if operation was successful, else error
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_generic_chiplet(
    const fapi::Target& i_target,
    const uint32_t i_chiplet_base_addr,
    const uint64_t i_status_reg_exp)
{
    fapi::ReturnCode rc;

    FAPI_DBG("proc_start_clocks_generic_chiplet: Start");

    do
    {
        // clear chiplet fence in GP3 register
        FAPI_DBG("Writing GP3 AND mask to clear chiplet fence ...");
        rc = proc_start_clocks_chiplet_clear_chiplet_fence(i_target,
                                                           i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error writing GP3 AND mask to clear chiplet fence");
            break;
        }

        // clear pervasive fence in GP0 register
        FAPI_DBG("Writing GP0 AND mask to clear pervasive fence ...");
        rc = proc_start_clocks_chiplet_clear_perv_fence(i_target,
                                                        i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error writing GP0 AND mask to clear pervasive fence");
            break;
        }

        // set functional clock mux selects in GP0 register
        FAPI_DBG("Writing GP0 AND mask to set functional clock mux selects ...");
        rc = proc_start_clocks_chiplet_set_mux_selects(i_target,
                                                       i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error writing GP0 AND mask to set functional clock mux selects");
            break;
        }

        // clear clock scansel register
        FAPI_DBG("Clearing clock scansel register ...");
        rc = proc_start_clocks_chiplet_clear_clk_scansel_reg(i_target,
                                                             i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error clearing clock scansel register");
            break;
        }

        // write clock region register to start clocks
        FAPI_DBG("Writing clock region register to start clocks ...");
        rc = proc_start_clocks_chiplet_set_clk_region_reg(i_target,
                                                          i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error writing clock region register");
            break;
        }

        // check clock status register to ensure that all clocks are started
        FAPI_DBG("Chcecking clock status register ...");
        rc = proc_start_clocks_chiplet_check_clk_status_reg(i_target,
                                                            i_chiplet_base_addr,
                                                            i_status_reg_exp);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error checking clock status register");
            break;
        }

        // clear force align bit in GP0 register
        FAPI_DBG("Writing GP0 AND mask to clear force align ...");
        rc = proc_start_clocks_chiplet_clear_force_align(i_target,
                                                         i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error writing GP0 AND mask to clear force align");
            break;
        }

        // clear flushmode inhibit bit in GP0 register
        FAPI_DBG("Writing GP0 AND mask to clear flushmode inhibit ...");
        rc = proc_start_clocks_chiplet_clear_flushmode_inhibit(i_target,
                                                               i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error writing GP0 AND mask to clear flushmode inhibit");
            break;
        }

        // check chiplet FIR register
        FAPI_DBG("Checking chiplet FIR register for errors after clock start ...");
        rc = proc_start_clocks_chiplet_check_fir(i_target,
                                                 i_chiplet_base_addr);
        if (rc)
        {
            FAPI_ERR("proc_start_clocks_generic_chiplet: Error checking chiplet FIR register after clock start");
            break;
        }

    } while(0);

    FAPI_DBG("proc_start_clocks_generic_chiplet: End");

    return rc;
}


//------------------------------------------------------------------------------
// Hardware Procedure
//------------------------------------------------------------------------------
fapi::ReturnCode proc_start_clocks_chiplets(const fapi::Target& i_target,
                                            bool xbus, bool abus, bool pcie)
{
    fapi::ReturnCode rc;

    // mark HWP entry
    FAPI_IMP("proc_start_clocks_chiplets: Entering ...");

    do
    {
        if (xbus)
        {
            FAPI_DBG("Starting X bus chiplet clocks ...");
            rc = proc_start_clocks_generic_chiplet(
                i_target,
                X_BUS_CHIPLET_0x04000000,
                PROC_START_CLOCKS_CHIPLETS_XBUS_CLK_STATUS_REG_EXP);
            if (rc)
            {
                break;
            }
        }

        if (abus)
        {
            FAPI_DBG("Starting A bus chiplet clocks ...");
            rc = proc_start_clocks_generic_chiplet(
                i_target,
                // TODO MJJ Updated to A_BUS_CHIPLET_0x08000000 to match new
                // p8_scom_addresses, this will go away when this HWP is
                // refreshed
                A_BUS_CHIPLET_0x08000000,
                PROC_START_CLOCKS_CHIPLETS_ABUS_CLK_STATUS_REG_EXP);
            if (rc)
            {
                break;
            }
        }

        if (pcie)
        {
            FAPI_DBG("Starting PCIE chiplet clocks ...");
            rc = proc_start_clocks_generic_chiplet(
                i_target,
                // TODO MJJ Updated to PCIE_CHIPLET_0x09000000 to match new
                // p8_scom_addresses, this will go away when this HWP is
                // refreshed
                PCIE_CHIPLET_0x09000000,
                PROC_START_CLOCKS_CHIPLETS_PCIE_CLK_STATUS_REG_EXP);
            if (rc)
            {
                break;
            }
        }

    } while (0);

    // mark HWP exit
    FAPI_IMP("proc_start_clocks_chiplets: Exiting ...");
    return rc;
}


} // extern "C"
OpenPOWER on IntegriCloud