summaryrefslogtreecommitdiffstats
path: root/src/usr/secureboot/node_comm/node_comm_dd.C
blob: def2af449b266bf43fb10fefc2f1e87bd5d8deec (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
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/secureboot/node_comm/node_comm_dd.C $                 */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2018                             */
/* [+] 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                                                     */
/**
 * @file node_comm_dd.C
 *
 * @brief Implementation of the Secure Node Communications device driver
 *
 */

// ----------------------------------------------
// Includes
// ----------------------------------------------
#include <string.h>
#include <sys/time.h>
#include <trace/interface.H>
#include <errl/errlentry.H>
#include <errl/errlmanager.H>
#include <errl/errludtarget.H>
#include <targeting/common/targetservice.H>
#include <devicefw/userif.H>
#include <devicefw/driverif.H>
#include <secureboot/secure_reasoncodes.H>

#include "node_comm_dd.H"
#include "node_comm.H"
#include "../common/errlud_secure.H"

// ----------------------------------------------
// Globals
// ----------------------------------------------

// ----------------------------------------------
// Trace definitions
// ----------------------------------------------
trace_desc_t* g_trac_nc = nullptr;
TRAC_INIT( & g_trac_nc, NODECOMM_TRACE_NAME, KILOBYTE );


// ----------------------------------------------
// Defines
// ----------------------------------------------
// If the link(s) are up the operation should complete right away
// so there will only be a short polling window
#define NODE_COMM_POLL_DELAY_NS 1   // Sleep for 1ns per poll
#define NODE_COMM_POLL_DELAY_TOTAL_NS 10 // Total time to poll


using namespace TARGETING;

namespace SECUREBOOT
{

namespace NODECOMM
{

// Register the generic I2C perform Op with the routing code for Procs.
DEVICE_REGISTER_ROUTE( DeviceFW::WILDCARD,
                       DeviceFW::NODECOMM,
                       TARGETING::TYPE_PROC,
                       nodeCommPerformOp );

errlHndl_t nodeCommPerformOp( DeviceFW::OperationType i_opType,
                         TARGETING::Target * i_target,
                         void * io_buffer,
                         size_t & io_buflen,
                         int64_t i_accessType,
                         va_list i_args )
{
    errlHndl_t err = nullptr;
    bool unlock_mutex = false;
    node_comm_args_t node_comm_args;

    uint64_t mode = va_arg( i_args, uint64_t );
    node_comm_args.mode = static_cast<node_comm_modes_t>(mode);

    uint64_t linkId = va_arg( i_args, uint64_t );
    node_comm_args.linkId = static_cast<uint8_t>(linkId);

    uint64_t mboxId = va_arg( i_args, uint64_t );
    node_comm_args.mboxId = static_cast<uint8_t>(mboxId);

    node_comm_args.data_ptr = reinterpret_cast<uint64_t*>(io_buffer);
    node_comm_args.tgt = i_target;
    node_comm_args.tgt_huid = TARGETING::get_huid(i_target);

    do
    {

    // Check other input parameters
    const auto max_linkId = (mode==NCDD_MODE_ABUS)
                              ? NCDD_MAX_ABUS_LINK_ID
                              : NCDD_MAX_XBUS_LINK_ID;

    if (    (node_comm_args.mode >= NCDD_MODE_INVALID)
         || (node_comm_args.linkId > max_linkId)
         || (node_comm_args.mboxId > NCDD_MAX_MBOX_ID)
         || (node_comm_args.data_ptr == nullptr)
       )
    {
        TRACFCOMP( g_trac_nc,ERR_MRK"nodeCommPerformOp: Invalid Input Args!"
                   " mode=%d, linkId=0x%X (max=0x%X), mboxId=0x%X, "
                   " data_ptr=%p",
                   node_comm_args.mode, node_comm_args.linkId,
                   max_linkId, node_comm_args.mboxId,
                   node_comm_args.data_ptr);

        /*@
         * @errortype
         * @reasoncode       RC_NCDD_INVALID_ARGS
         * @moduleid         MOD_NCDD_PERFORM_OP
         * @userdata1[0:15]  BUS Mode Enum Value
         * @userdata1[16:31] LinkId Value
         * @userdata1[32:47] MAX possile LinkId Value based on Mode
         * @userdata1[48:63] MailboxId Value
         * @userdata2        Input Data Pointer
         * @devdesc          Invalid Input Args for Node Comm DD call
         * @custdesc         Secure Boot failure
         */
        err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                       MOD_NCDD_PERFORM_OP,
                                       RC_NCDD_INVALID_ARGS,
                                       FOUR_UINT16_TO_UINT64(
                                         node_comm_args.mode,
                                         node_comm_args.linkId,
                                         max_linkId,
                                         node_comm_args.mboxId),
                                       reinterpret_cast<uint64_t>(
                                         node_comm_args.data_ptr),
                                       true /*Add HB SW Callout*/ );
        break;
    }

    TRACUCOMP(g_trac_nc,ENTER_MRK"nodeCommPerformOp: %s: %s: "
              "tgt=0x%X, LinkId=%d, MboxId=%d, data=0x%.16llX",
              (node_comm_args.mode == NCDD_MODE_ABUS)
              ? NCDD_ABUS_STRING : NCDD_XBUS_STRING,
              ( i_opType == DeviceFW::READ ) ? "read" : "write",
              node_comm_args.tgt_huid, node_comm_args.linkId,
              node_comm_args.mboxId, (*node_comm_args.data_ptr));

    // Mutex Lock
    (mode==NCDD_MODE_ABUS)
      ? mutex_lock(node_comm_args.tgt->
          getHbMutexAttr<TARGETING::ATTR_HB_NODE_COMM_ABUS_MUTEX>())
      : mutex_lock(node_comm_args.tgt->
          getHbMutexAttr<TARGETING::ATTR_HB_NODE_COMM_XBUS_MUTEX>());
    unlock_mutex = true;

    /***********************************************/
    /* Node Comm Read                              */
    /***********************************************/
    if ( i_opType == DeviceFW::READ )
    {
        err = ncddRead( node_comm_args );
    }

    /***********************************************/
    /* Node Comm Write                             */
    /***********************************************/
    else if( i_opType == DeviceFW::WRITE )
    {
        err = ncddWrite( node_comm_args);
    }

    // Handle Error from Operation (like a reset, if necessary)
    if( err )
    {

        ncddHandleError( err,
                         node_comm_args );
        break;
    }

    }
    while (0);

    // If err, add trace and FFDC to log
    if (err)
    {
        err->collectTrace(SECURE_COMP_NAME);
        err->collectTrace(NODECOMM_TRACE_NAME);

        UdNodeCommInfo(i_opType,
                       io_buflen,
                       i_accessType,
                       node_comm_args)
                      .addToLog(err);

        if (err->reasonCode() != RC_NCDD_INVALID_ARGS)
        {
            // Collect FFDC - Target and Registers
            getNodeCommFFDC(node_comm_args.mode,
                            node_comm_args.tgt,
                            err);
        }
    }

    // Mutex unlock
    if (unlock_mutex == true)
    {
        (mode==NCDD_MODE_ABUS)
          ? mutex_unlock(node_comm_args.tgt->
              getHbMutexAttr<TARGETING::ATTR_HB_NODE_COMM_ABUS_MUTEX>())
          : mutex_unlock(node_comm_args.tgt->
              getHbMutexAttr<TARGETING::ATTR_HB_NODE_COMM_XBUS_MUTEX>());
    }


    TRACFCOMP (g_trac_nc, EXIT_MRK"nodeCommPerformOp: %s: %s: "
               "tgt=0x%X, LinkId=%d, MboxId=%d, data=0x%.16llX. "
               TRACE_ERR_FMT,
               (node_comm_args.mode == NCDD_MODE_ABUS)
                 ? NCDD_ABUS_STRING : NCDD_XBUS_STRING,
               ( i_opType == DeviceFW::READ ) ? "read" : "write",
               node_comm_args.tgt_huid,
               node_comm_args.linkId, node_comm_args.mboxId,
               (node_comm_args.data_ptr != nullptr)
                ? (*node_comm_args.data_ptr) : 0,
               TRACE_ERR_ARGS(err));

    return err;
} // end nodeCommPerformOp

errlHndl_t ncddRead(node_comm_args_t & i_args)
{
    errlHndl_t err = nullptr;

    do
    {
    // Determine correct Link Mailbox Register based on inputs
    const uint64_t link_mbox_reg = getLinkMboxReg(i_args.linkId, i_args.mboxId);

    // Read data from the correct LinkId/Mailbox Register
    err = ncddRegisterOp( DeviceFW::READ,
                          i_args.data_ptr,
                          link_mbox_reg,
                          i_args );

    if(err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddRead: SCOM deviceRead call "
            "failed for Target HUID 0x%08X and address 0x%016llX. "
            TRACE_ERR_FMT,
            i_args.tgt_huid,
            link_mbox_reg,
            TRACE_ERR_ARGS(err));
        break;
    }

    // Since Read above was successful, clear the data register
    uint64_t clear_data = 0x0;
    err = ncddRegisterOp( DeviceFW::WRITE,
                          &clear_data,
                          link_mbox_reg,
                          i_args );

    if(err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddRead: SCOM deviceWrite call "
            "failed for Target HUID 0x%08X and address 0x%016llX. "
            TRACE_ERR_FMT,
            i_args.tgt_huid,
            link_mbox_reg,
            TRACE_ERR_ARGS(err));
        break;
    }


    // Since Read above was successful, clear the FIR bit
    uint64_t fir_attn_bit = getLinkMboxFirAttnBit(i_args.linkId, i_args.mboxId);

    // Invert the fir bit and WOX_AND it into the register
    uint64_t clear_fir_bit = ~fir_attn_bit;

    uint64_t reg_addr = getLinkMboxRegAddr(NCDD_REG_FIR_WOX_AND, i_args.mode);

    TRACUCOMP(g_trac_nc,"ncddRead: Clearing FIR bit 0x%.16llX based on "
              "linkId=%d, mboxId=%d, mode=%s, by writing 0x%.16llX to FIR Reg "
              "Addr 0x%.16llX on Target 0x%X",
              fir_attn_bit, i_args.linkId, i_args.mboxId,
              (i_args.mode == NCDD_MODE_ABUS)
                ? NCDD_ABUS_STRING : NCDD_XBUS_STRING,
              clear_fir_bit, reg_addr, i_args.tgt_huid);

    err = ncddRegisterOp( DeviceFW::WRITE,
                          &clear_fir_bit,
                          NCDD_REG_FIR_WOX_AND,
                          i_args );

    if(err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddRead: SCOM deviceWrite call "
            "failed for Target HUID 0x%08X and address 0x%016llX. "
            TRACE_ERR_FMT,
            i_args.tgt_huid,
            link_mbox_reg,
            TRACE_ERR_ARGS(err));
        break;
    }


    } while( 0 );

    TRACUCOMP( g_trac_nc,EXIT_MRK"ncddRead: "
               TRACE_ERR_FMT,
               TRACE_ERR_ARGS(err));

    return err;

} // end ncddRead

errlHndl_t ncddWrite (node_comm_args_t & i_args)
{
    errlHndl_t err = nullptr;

    do
    {
    // Write data to data movement register
    err = ncddRegisterOp( DeviceFW::WRITE,
                          i_args.data_ptr,
                          NCDD_REG_DATA,
                          i_args );

    if(err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddWrite: SCOM deviceWrite call "
            "failed for Target HUID 0x%08X and address 0x%016llX. "
            TRACE_ERR_FMT,
            i_args.tgt_huid,
            NCDD_REG_DATA,
            TRACE_ERR_ARGS(err));
        break;
    }


    // Write Control Reg to send the data
    ctrl_reg_t ctrl_reg_cmd;
    ctrl_reg_cmd.value = 0x0;

    ctrl_reg_cmd.start_stop = 1; // to start the command
    ctrl_reg_cmd.write_not_read = 1;  // write command
    ctrl_reg_cmd.mbox_id = i_args.mboxId;
    ctrl_reg_cmd.link_id = i_args.linkId;


    err = ncddRegisterOp( DeviceFW::WRITE,
                          &ctrl_reg_cmd.value,
                          NCDD_REG_CTRL,
                          i_args );

    if(err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddWrite: SCOM deviceWrite call "
            "failed for Target HUID 0x%08X and address 0x%016llX. "
            TRACE_ERR_FMT,
            i_args.tgt_huid,
            NCDD_REG_CTRL,
            TRACE_ERR_ARGS(err));
        break;
    }

    // Wait for command to be complete
    ctrl_reg_cmd.value = 0;
    err = ncddWaitForCmdComp(i_args, ctrl_reg_cmd);
    if(err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddWrite: Wait For Cmd Complete "
            "failed for Target HUID 0x%08X. "
            TRACE_ERR_FMT,
            i_args.tgt_huid,
            TRACE_ERR_ARGS(err));
        break;
    }

    // Check for 'sent' bit being set
    if (ctrl_reg_cmd.sent != 1)
    {
        TRACFCOMP( g_trac_nc,
                   ERR_MRK"ncddWrite: 'Sent' bit not set in status reg: "
                   "0x%.16llX (Target 0x%X)",
                   ctrl_reg_cmd.value, i_args.tgt_huid );

        /*@
         * @errortype
         * @reasoncode       RC_NCDD_DATA_NOT_SENT
         * @moduleid         MOD_NCDD_WRITE
         * @userdata1        Status Register Value
         * @userdata2        Target HUID
         * @devdesc          Sent bit not set in Node Comm status/ctrl register
         * @custdesc         Secure Boot failure
         */
        err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                       MOD_NCDD_WRITE,
                                       RC_NCDD_DATA_NOT_SENT,
                                       ctrl_reg_cmd.value,
                                       i_args.tgt_huid);

        // Likely an issue with Processor or its bus
        err->addHwCallout( i_args.tgt,
                           HWAS::SRCI_PRIORITY_HIGH,
                           HWAS::DELAYED_DECONFIG,
                           HWAS::GARD_NULL );

        // Or HB code failed to do the procedure correctly
        err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
                                 HWAS::SRCI_PRIORITY_MED);

        // @TODO RTC 184518 - Look into bus callouts

        break;
    }

    } while( 0 );

    TRACUCOMP( g_trac_nc,EXIT_MRK"ncddWrite: "
               TRACE_ERR_FMT,
               TRACE_ERR_ARGS(err));

    return err;

} // end ncddWrite


errlHndl_t ncddCheckStatus (node_comm_args_t & i_args,
                            const ctrl_reg_t & i_statusVal )
{
    errlHndl_t err = nullptr;
    bool errorFound = false;

    TRACUCOMP( g_trac_nc,
               ENTER_MRK"ncddCheckStatus(): Tgt=0x%X: 0x%.16llX",
               i_args.tgt_huid,
               i_statusVal.value );

    do
    {
        if( 1 == i_statusVal.bad_addr )
        {
            errorFound = true;
            TRACFCOMP(g_trac_nc,ERR_MRK
                      "Node Comm DD: Bad Address! - status reg: 0x%016llx",
                      i_statusVal.value );
        }

        if( 1 == i_statusVal.link_down )
        {
            errorFound = true;
            TRACFCOMP(g_trac_nc,ERR_MRK
                      "Node Comm DD: Link Down! - status reg: 0x%016llx",
                      i_statusVal.value );
        }

        if( 1 == i_statusVal.corrupt )
        {
            errorFound = true;
            TRACFCOMP(g_trac_nc,ERR_MRK
                      "Node Comm DD: Corrupt! - status reg: 0x%016llx",
                      i_statusVal.value );
        }

        if( 1 == i_statusVal.bad_write )
        {
            errorFound = true;
            TRACFCOMP(g_trac_nc,ERR_MRK
                      "Node Comm DD: Bad Write! - status reg: 0x%016llx",
                      i_statusVal.value );
        }

        // Create Error Log
        if( errorFound )
        {
            TRACFCOMP( g_trac_nc,
                       ERR_MRK"ncddCheckStatus() - Error(s) found on "
                       "Target 0x%X",
                       i_args.tgt_huid );

            /*@
             * @errortype
             * @reasoncode       RC_NCDD_HW_ERROR_FOUND
             * @moduleid         MOD_NCDD_CHECK_FOR_ERRORS
             * @userdata1        Status Register Value
             * @userdata2        Target HUID
             * @devdesc          Error found in Node Comm status/ctrl register
             * @custdesc         Secure Boot failure
             */
            err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                           MOD_NCDD_CHECK_FOR_ERRORS,
                                           RC_NCDD_HW_ERROR_FOUND,
                                           i_statusVal.value,
                                           i_args.tgt_huid);

            // Likely an issue with Processor or its bus
            err->addHwCallout( i_args.tgt,
                               HWAS::SRCI_PRIORITY_HIGH,
                               HWAS::DELAYED_DECONFIG,
                               HWAS::GARD_NULL );

            // Or HB code failed to do the procedure correctly
            err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
                                     HWAS::SRCI_PRIORITY_MED);

            // @TODO RTC 184518 - Look into bus callouts

           break;
        }


    } while( 0 );

    TRACUCOMP( g_trac_nc,EXIT_MRK"ncddCheckStatus: "
               TRACE_ERR_FMT,
               TRACE_ERR_ARGS(err));

    return err;

} // end ncddCheckStatus


errlHndl_t ncddWaitForCmdComp (node_comm_args_t & i_args,
                               ctrl_reg_t & o_statusVal )
{
    errlHndl_t err = nullptr;
    uint64_t interval_ns  = NODE_COMM_POLL_DELAY_NS;
    int timeout_ns = NODE_COMM_POLL_DELAY_TOTAL_NS;
    ctrl_reg_t ctrl_reg_status;

    TRACUCOMP(g_trac_nc, "ncddWaitForCmdComp(): timeout_ns=%d, "
              "interval_ns=%d", timeout_ns, interval_ns);

    do
    {
        do
        {
            // Read Control Reg to check for status
            ctrl_reg_status.value = 0x0;

            err = ncddRegisterOp( DeviceFW::READ,
                                  &ctrl_reg_status.value,
                                  NCDD_REG_CTRL,
                                  i_args );
            if(err)
            {
                TRACFCOMP(g_trac_nc,ERR_MRK"ncddWaitForCmdComp: ncddRegisterOp "
                          "failed for Target HUID 0x%08X and address 0x%016llX. "
                          TRACE_ERR_FMT,
                          i_args.tgt_huid,
                          NCDD_REG_CTRL,
                          TRACE_ERR_ARGS(err));
                break;
            }

            // Check For Errors
            err = ncddCheckStatus(i_args, ctrl_reg_status);
            if(err)
            {
                TRACFCOMP(g_trac_nc,ERR_MRK"ncddWaitForCmdComp: ncddCheckStatus"
                          " failed for Target HUID 0x%08X, address 0x%016llX. "
                          TRACE_ERR_FMT,
                          i_args.tgt_huid,
                          NCDD_REG_CTRL,
                          TRACE_ERR_ARGS(err));
                break;
            }

            // Check if we have more time to poll
            if (timeout_ns < 0)
            {
                TRACFCOMP(g_trac_nc,
                          ERR_MRK"ncddWaitForCmdComp() - "
                          "Timed out waiting for Command Complete! "
                          "status=0x%016llX from reg=0x%016llX",
                          ctrl_reg_status.value, NCDD_REG_CTRL);

                /*@
                 * @errortype
                 * @reasoncode       RC_NCDD_CMD_COMP_TIMEOUT
                 * @moduleid         MOD_NCDD_WAIT_FOR_CMD_COMP
                 * @userdata1        Status Register Value
                 * @userdata2[0:31]  Status/Control Register Address
                 * @userdata2[32:63] Target HUID
                 * @devdesc          Timed out waiting for command complete.
                 * @custdesc         Secure Boot failure
                 */
                err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
                                              MOD_NCDD_WAIT_FOR_CMD_COMP,
                                              RC_NCDD_CMD_COMP_TIMEOUT,
                                              ctrl_reg_status.value,
                                              TWO_UINT32_TO_UINT64(
                                                NCDD_REG_CTRL,
                                                i_args.tgt_huid));

                // Likely an issue with Processor or its bus
                err->addHwCallout(i_args.tgt,
                                  HWAS::SRCI_PRIORITY_HIGH,
                                  HWAS::DELAYED_DECONFIG,
                                  HWAS::GARD_NULL);

                // Or HB code failed to do the procedure correctly
                err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
                                         HWAS::SRCI_PRIORITY_MED);

                // @TODO RTC 184518 - Look into bus callouts

                break;
            }

            // Sleep before polling again
            nanosleep( 0, interval_ns );
            timeout_ns -= interval_ns;

         } while( 1 == ctrl_reg_status.start_stop ); /* Cmd Complete when ==0 */

         if (err)
         {
             break;
         }

    } while (0);

    o_statusVal = ctrl_reg_status;

    TRACUCOMP( g_trac_nc,EXIT_MRK"ncddWaitForCmdComp: "
               TRACE_ERR_FMT,
               TRACE_ERR_ARGS(err));

    return err;

} // end ncddWaitForCmdComp


void ncddHandleError( errlHndl_t & io_err,
                      node_comm_args_t & i_args )
{
    TRACFCOMP( g_trac_nc,ENTER_MRK"ncddHandleError: "
               TRACE_ERR_FMT,
               TRACE_ERR_ARGS(io_err));

    errlHndl_t l_err = nullptr;

    do
    {
    // On a fail issue a cmd to the control reg with just the 'reset' bit set
    ctrl_reg_t ctrl_reg_cmd;
    ctrl_reg_cmd.value = 0x0;
    ctrl_reg_cmd.reset = 1;


    l_err = ncddRegisterOp( DeviceFW::WRITE,
                            &ctrl_reg_cmd.value,
                            NCDD_REG_CTRL,
                            i_args );

    if(l_err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddHandleError: SCOM deviceWrite call "
            "failed for Target HUID 0x%08X and address 0x%016llX: "
            TRACE_ERR_FMT
            " . Committing after chaining to existing error: "
            TRACE_ERR_FMT,
            i_args.tgt_huid,
            NCDD_REG_CTRL,
            TRACE_ERR_ARGS(l_err),
            TRACE_ERR_ARGS(io_err));

        l_err->plid(io_err->plid());
        errlCommit( l_err, SECURE_COMP_ID );
        break;
    }

    } while (0);

    TRACFCOMP( g_trac_nc,EXIT_MRK"ncddHandleError: "
               TRACE_ERR_FMT,
               TRACE_ERR_ARGS(io_err));

    return;

} // end ncddHandleError



errlHndl_t ncddRegisterOp ( DeviceFW::OperationType i_opType,
                            uint64_t * io_data_64,
                            uint64_t i_reg,
                            node_comm_args_t & i_args )
{
    errlHndl_t err = nullptr;
    const size_t expSize = sizeof(i_reg);
    uint64_t l_reg = getLinkMboxRegAddr(i_reg, i_args.mode);

    TRACUCOMP(g_trac_nc,ENTER_MRK"ncddRegisterOp: %s: %s: "
              "tgt=0x%X, reg_addr=0x%.16llX, data=0x%.16llX",
              (i_args.mode == NCDD_MODE_ABUS)
                ? NCDD_ABUS_STRING : NCDD_XBUS_STRING,
              ( i_opType == DeviceFW::READ ) ? "read" : "write",
              i_args.tgt_huid,
              l_reg, (*io_data_64)) ;

    do
    {
    uint64_t reqSize = expSize;
    err = DeviceFW::deviceOp( i_opType,
                              i_args.tgt,
                              io_data_64,
                              reqSize,
                              DEVICE_SCOM_ADDRESS(l_reg));

    if(err)
    {
        TRACFCOMP(g_trac_nc,ERR_MRK"ncddRegisterOp %s %s Fail! "
                  TRACE_ERR_FMT
                  " tgt=0x%X, reg_addr=0x%.8X, data=0x%.16X",
                  (i_args.mode == NCDD_MODE_ABUS)
                    ? NCDD_ABUS_STRING : NCDD_XBUS_STRING,
                  ( i_opType == DeviceFW::READ ) ? "read" : "write",
                  TRACE_ERR_ARGS(err),
                  i_args.tgt_huid,
                  l_reg, (*io_data_64) );
            break;
        }
    assert(reqSize==expSize,"ncddRegisterOp: SCOM deviceRead didn't return expected data size of %d (it was %d)",
           expSize,reqSize);

    } while (0);

    TRACUCOMP(g_trac_nc,EXIT_MRK"ncddRegisterOp: %s: %s: "
              "tgt=0x%X, reg_addr=0x%.16llX, data=0x%.16llX. "
              TRACE_ERR_FMT,
              (i_args.mode == NCDD_MODE_ABUS)
                ? NCDD_ABUS_STRING : NCDD_XBUS_STRING,
              ( i_opType == DeviceFW::READ ) ? "read" : "write",
              i_args.tgt_huid,
              l_reg, (*io_data_64),
              TRACE_ERR_ARGS(err));

    return err;

} // end ncddRegisterOp


} // end NODECOMM namespace

} // end SECUREBOOT namespace

OpenPOWER on IntegriCloud