1 /* SPDX-License-Identifier: GPL-2.0-or-later */
8 #include "debug_defines.h"
11 #define get_field(reg, mask) (((reg) & (mask)) / ((mask) & ~((mask) << 1)))
12 #define set_field(reg, mask, val) (((reg) & ~(mask)) | (((val) * ((mask) & ~((mask) << 1))) & (mask)))
14 #define DTM_DMI_MAX_ADDRESS_LENGTH ((1<<DTM_DTMCS_ABITS_LENGTH)-1)
15 #define DMI_SCAN_MAX_BIT_LENGTH (DTM_DMI_MAX_ADDRESS_LENGTH + DTM_DMI_DATA_LENGTH + DTM_DMI_OP_LENGTH)
16 #define DMI_SCAN_BUF_SIZE (DIV_ROUND_UP(DMI_SCAN_MAX_BIT_LENGTH, 8))
18 static void dump_field(int idle, const struct scan_field *field);
20 struct riscv_batch *riscv_batch_alloc(struct target *target, size_t scans, size_t idle)
23 struct riscv_batch *out = calloc(1, sizeof(*out));
27 out->allocated_scans = scans;
28 out->idle_count = idle;
29 out->data_out = malloc(sizeof(*out->data_out) * (scans) * DMI_SCAN_BUF_SIZE);
32 out->data_in = malloc(sizeof(*out->data_in) * (scans) * DMI_SCAN_BUF_SIZE);
35 out->fields = malloc(sizeof(*out->fields) * (scans));
38 if (bscan_tunnel_ir_width != 0) {
39 out->bscan_ctxt = malloc(sizeof(*out->bscan_ctxt) * (scans));
43 out->last_scan = RISCV_SCAN_TYPE_INVALID;
44 out->read_keys = malloc(sizeof(*out->read_keys) * (scans));
50 free(out->bscan_ctxt);
63 void riscv_batch_free(struct riscv_batch *batch)
66 free(batch->data_out);
68 free(batch->bscan_ctxt);
69 free(batch->read_keys);
73 bool riscv_batch_full(struct riscv_batch *batch)
75 return batch->used_scans > (batch->allocated_scans - 4);
78 int riscv_batch_run(struct riscv_batch *batch)
80 if (batch->used_scans == 0) {
81 LOG_DEBUG("Ignoring empty batch.");
87 riscv_batch_add_nop(batch);
89 for (size_t i = 0; i < batch->used_scans; ++i) {
90 if (bscan_tunnel_ir_width != 0)
91 riscv_add_bscan_tunneled_scan(batch->target, batch->fields+i, batch->bscan_ctxt+i);
93 jtag_add_dr_scan(batch->target->tap, 1, batch->fields + i, TAP_IDLE);
95 if (batch->idle_count > 0)
96 jtag_add_runtest(batch->idle_count, TAP_IDLE);
99 if (jtag_execute_queue() != ERROR_OK) {
100 LOG_ERROR("Unable to execute JTAG queue");
104 if (bscan_tunnel_ir_width != 0) {
105 /* need to right-shift "in" by one bit, because of clock skew between BSCAN TAP and DM TAP */
106 for (size_t i = 0; i < batch->used_scans; ++i)
107 buffer_shr((batch->fields + i)->in_value, DMI_SCAN_BUF_SIZE, 1);
110 for (size_t i = 0; i < batch->used_scans; ++i)
111 dump_field(batch->idle_count, batch->fields + i);
116 void riscv_batch_add_dmi_write(struct riscv_batch *batch, unsigned address, uint64_t data)
118 assert(batch->used_scans < batch->allocated_scans);
119 struct scan_field *field = batch->fields + batch->used_scans;
120 field->num_bits = riscv_dmi_write_u64_bits(batch->target);
121 field->out_value = (void *)(batch->data_out + batch->used_scans * DMI_SCAN_BUF_SIZE);
122 field->in_value = (void *)(batch->data_in + batch->used_scans * DMI_SCAN_BUF_SIZE);
123 riscv_fill_dmi_write_u64(batch->target, (char *)field->out_value, address, data);
124 riscv_fill_dmi_nop_u64(batch->target, (char *)field->in_value);
125 batch->last_scan = RISCV_SCAN_TYPE_WRITE;
129 size_t riscv_batch_add_dmi_read(struct riscv_batch *batch, unsigned address)
131 assert(batch->used_scans < batch->allocated_scans);
132 struct scan_field *field = batch->fields + batch->used_scans;
133 field->num_bits = riscv_dmi_write_u64_bits(batch->target);
134 field->out_value = (void *)(batch->data_out + batch->used_scans * DMI_SCAN_BUF_SIZE);
135 field->in_value = (void *)(batch->data_in + batch->used_scans * DMI_SCAN_BUF_SIZE);
136 riscv_fill_dmi_read_u64(batch->target, (char *)field->out_value, address);
137 riscv_fill_dmi_nop_u64(batch->target, (char *)field->in_value);
138 batch->last_scan = RISCV_SCAN_TYPE_READ;
141 batch->read_keys[batch->read_keys_used] = batch->used_scans;
142 return batch->read_keys_used++;
145 unsigned riscv_batch_get_dmi_read_op(struct riscv_batch *batch, size_t key)
147 assert(key < batch->read_keys_used);
148 size_t index = batch->read_keys[key];
149 assert(index <= batch->used_scans);
150 uint8_t *base = batch->data_in + DMI_SCAN_BUF_SIZE * index;
151 /* extract "op" field from the DMI read result */
152 return (unsigned)buf_get_u32(base, DTM_DMI_OP_OFFSET, DTM_DMI_OP_LENGTH);
155 uint32_t riscv_batch_get_dmi_read_data(struct riscv_batch *batch, size_t key)
157 assert(key < batch->read_keys_used);
158 size_t index = batch->read_keys[key];
159 assert(index <= batch->used_scans);
160 uint8_t *base = batch->data_in + DMI_SCAN_BUF_SIZE * index;
161 /* extract "data" field from the DMI read result */
162 return buf_get_u32(base, DTM_DMI_DATA_OFFSET, DTM_DMI_DATA_LENGTH);
165 void riscv_batch_add_nop(struct riscv_batch *batch)
167 assert(batch->used_scans < batch->allocated_scans);
168 struct scan_field *field = batch->fields + batch->used_scans;
169 field->num_bits = riscv_dmi_write_u64_bits(batch->target);
170 field->out_value = (void *)(batch->data_out + batch->used_scans * DMI_SCAN_BUF_SIZE);
171 field->in_value = (void *)(batch->data_in + batch->used_scans * DMI_SCAN_BUF_SIZE);
172 riscv_fill_dmi_nop_u64(batch->target, (char *)field->out_value);
173 riscv_fill_dmi_nop_u64(batch->target, (char *)field->in_value);
174 batch->last_scan = RISCV_SCAN_TYPE_NOP;
178 void dump_field(int idle, const struct scan_field *field)
180 static const char * const op_string[] = {"-", "r", "w", "?"};
181 static const char * const status_string[] = {"+", "?", "F", "b"};
183 if (debug_level < LOG_LVL_DEBUG)
186 assert(field->out_value);
187 uint64_t out = buf_get_u64(field->out_value, 0, field->num_bits);
188 unsigned int out_op = get_field(out, DTM_DMI_OP);
189 unsigned int out_data = get_field(out, DTM_DMI_DATA);
190 unsigned int out_address = out >> DTM_DMI_ADDRESS_OFFSET;
192 if (field->in_value) {
193 uint64_t in = buf_get_u64(field->in_value, 0, field->num_bits);
194 unsigned int in_op = get_field(in, DTM_DMI_OP);
195 unsigned int in_data = get_field(in, DTM_DMI_DATA);
196 unsigned int in_address = in >> DTM_DMI_ADDRESS_OFFSET;
198 log_printf_lf(LOG_LVL_DEBUG,
199 __FILE__, __LINE__, __PRETTY_FUNCTION__,
200 "%db %s %08x @%02x -> %s %08x @%02x; %di",
201 field->num_bits, op_string[out_op], out_data, out_address,
202 status_string[in_op], in_data, in_address, idle);
204 log_printf_lf(LOG_LVL_DEBUG,
205 __FILE__, __LINE__, __PRETTY_FUNCTION__, "%db %s %08x @%02x -> ?; %di",
206 field->num_bits, op_string[out_op], out_data, out_address, idle);
210 size_t riscv_batch_available_scans(struct riscv_batch *batch)
212 return batch->allocated_scans - batch->used_scans - 4;