blob: 2422b38850eddd056d6267c4bd16831da9de8c2f [file] [log] [blame]
Ben Tyner92e39fd2020-02-05 18:11:02 -06001/**
Ben Tynerb859d792020-05-06 21:29:47 -05002 * @file These are the implementations of the user interfaces declared
3 * in hei_user_interface.hpp
Ben Tyner92e39fd2020-02-05 18:11:02 -06004 */
5
Ben Tynerb859d792020-05-06 21:29:47 -05006#include <assert.h>
Ben Tyner0523f8a2020-05-14 16:01:53 -05007#include <inttypes.h>
8#include <libpdbg.h>
Zane Shelleyb78dd0c2020-05-08 14:35:15 -05009#include <stdarg.h>
10#include <stdio.h>
11
Ben Tyner92e39fd2020-02-05 18:11:02 -060012#include <hei_user_interface.hpp>
Zane Shelleya0299852020-11-13 13:38:04 -060013#include <util/pdbg.hpp>
Zane Shelley0c44c2f2020-06-05 17:14:31 -050014#include <util/trace.hpp>
Ben Tyner92e39fd2020-02-05 18:11:02 -060015
16namespace libhei
17{
18
Zane Shelley06e10f92020-08-10 20:35:08 -050019const char* __regType(RegisterType_t i_regType)
20{
21 const char* str = "";
22 switch (i_regType)
23 {
24 case REG_TYPE_SCOM:
25 str = "SCOM";
26 break;
27 case REG_TYPE_ID_SCOM:
28 str = "ID_SCOM";
29 break;
30 default:
31 trace::err("Unsupported register type: i_regType=0x%02x",
32 i_regType);
33 assert(0);
34 }
35 return str;
36}
37
38//------------------------------------------------------------------------------
39
40bool __readProc(pdbg_target* i_procTrgt, RegisterType_t i_regType,
41 uint64_t i_address, uint64_t& o_value)
42{
43 bool accessFailure = false;
44
45 // The processor PIB target is required for SCOM access.
Zane Shelley171a2e02020-11-13 13:56:13 -060046 pdbg_target* scomTrgt = util::pdbg::getPibTrgt(i_procTrgt);
Zane Shelley06e10f92020-08-10 20:35:08 -050047
48 switch (i_regType)
49 {
50 case REG_TYPE_SCOM:
51 case REG_TYPE_ID_SCOM:
52 // Read the 64-bit SCOM register.
53 accessFailure = (0 != pib_read(scomTrgt, i_address, &o_value));
54 break;
55
56 default:
57 trace::err("Unsupported register type: trgt=%s regType=0x%02x "
58 "addr=0x%0" PRIx64,
Zane Shelleya0299852020-11-13 13:38:04 -060059 util::pdbg::getPath(i_procTrgt), i_regType, i_address);
Zane Shelley06e10f92020-08-10 20:35:08 -050060 assert(0); // an unsupported register type
61 }
62
63 return accessFailure;
64}
65
66//------------------------------------------------------------------------------
67
68bool __readOcmb(pdbg_target* i_obmcTrgt, RegisterType_t i_regType,
69 uint64_t i_address, uint64_t& o_value)
70{
71 bool accessFailure = false;
72
73 /* TODO: ocmb_getscom() currently does not exist upstream.
74 // The OCMB target is used for SCOM access.
75 pdbg_target* scomTrgt = i_obmcTrgt;
76
77 switch (i_regType)
78 {
79 case REG_TYPE_SCOM:
80 case REG_TYPE_ID_SCOM:
81 // Read the 64-bit SCOM register.
82 accessFailure = (0 != ocmb_getscom(scomTrgt, i_address, &o_value));
83 break;
84
85 default:
86 trace::err("Unsupported register type: trgt=%s regType=0x%02x "
87 "addr=0x%0" PRIx64,
Zane Shelleya0299852020-11-13 13:38:04 -060088 util::pdbg::getPath(i_obmcTrgt), i_regType, i_address);
Zane Shelley06e10f92020-08-10 20:35:08 -050089 assert(0);
90 }
91 */
92
93 return accessFailure;
94}
95
Ben Tyner92e39fd2020-02-05 18:11:02 -060096//------------------------------------------------------------------------------
97
Ben Tyner0523f8a2020-05-14 16:01:53 -050098bool registerRead(const Chip& i_chip, RegisterType_t i_regType,
99 uint64_t i_address, uint64_t& o_value)
Ben Tyner92e39fd2020-02-05 18:11:02 -0600100{
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500101 bool accessFailure = false;
Ben Tyner92e39fd2020-02-05 18:11:02 -0600102
Zane Shelleya0299852020-11-13 13:38:04 -0600103 auto trgt = util::pdbg::getTrgt(i_chip);
Zane Shelley2f263182020-07-10 21:41:21 -0500104
Zane Shelleya0299852020-11-13 13:38:04 -0600105 uint8_t trgtType = util::pdbg::getTrgtType(trgt);
Zane Shelley06e10f92020-08-10 20:35:08 -0500106
107 switch (trgtType)
Ben Tyner0523f8a2020-05-14 16:01:53 -0500108 {
Zane Shelley06e10f92020-08-10 20:35:08 -0500109 case 0x05: // PROC
110 accessFailure = __readProc(trgt, i_regType, i_address, o_value);
111 break;
112
113 case 0x4b: // OCMB_CHIP
114 accessFailure = __readOcmb(trgt, i_regType, i_address, o_value);
Ben Tyner0523f8a2020-05-14 16:01:53 -0500115 break;
Ben Tynerb859d792020-05-06 21:29:47 -0500116
Ben Tyner0523f8a2020-05-14 16:01:53 -0500117 default:
Zane Shelley06e10f92020-08-10 20:35:08 -0500118 trace::err("Unsupported target type: trgt=%s trgtType=0x%02x",
Zane Shelleya0299852020-11-13 13:38:04 -0600119 util::pdbg::getPath(trgt), trgtType);
Zane Shelley06e10f92020-08-10 20:35:08 -0500120 assert(0);
Ben Tyner0523f8a2020-05-14 16:01:53 -0500121 }
122
123 if (accessFailure)
124 {
Zane Shelley06e10f92020-08-10 20:35:08 -0500125 trace::err("%s failure: trgt=%s addr=0x%0" PRIx64, __regType(i_regType),
Zane Shelleya0299852020-11-13 13:38:04 -0600126 util::pdbg::getPath(trgt), i_address);
Ben Tyner0523f8a2020-05-14 16:01:53 -0500127 o_value = 0; // just in case
128 }
Ben Tyner92e39fd2020-02-05 18:11:02 -0600129
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500130 return accessFailure;
Ben Tyner92e39fd2020-02-05 18:11:02 -0600131}
132
133//------------------------------------------------------------------------------
134
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500135// prints a single line to stdout
136void hei_inf(char* format, ...)
137{
138 va_list args;
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500139 va_start(args, format);
Zane Shelley0c44c2f2020-06-05 17:14:31 -0500140 trace::inf(format, args);
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500141 va_end(args);
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500142}
143
144//------------------------------------------------------------------------------
145
146// prints a single line to stderr
147void hei_err(char* format, ...)
148{
149 va_list args;
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500150 va_start(args, format);
Zane Shelley0c44c2f2020-06-05 17:14:31 -0500151 trace::err(format, args);
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500152 va_end(args);
Zane Shelleyb78dd0c2020-05-08 14:35:15 -0500153}
154
Ben Tyner92e39fd2020-02-05 18:11:02 -0600155} // namespace libhei