1 /***************************************************************************
2 * Copyright (C) 2013 by Andes Technology *
3 * Hsiangkai Wang <hkwang@andestech.com> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
17 ***************************************************************************/
23 #include <jtag/interface.h>
24 #include <jtag/commands.h>
25 #include <transport/transport.h>
26 #include <target/target.h>
27 #include <jtag/aice/aice_transport.h>
28 #include <jtag/drivers/libusb_common.h>
31 #define AICE_KHZ_TO_SPEED_MAP_SIZE 16
32 static const int aice_khz_to_speed_map[AICE_KHZ_TO_SPEED_MAP_SIZE] = {
51 static const struct aice_port *aice_port;
52 static struct aice_port_param_s param;
53 static uint32_t retry_times;
54 static uint32_t count_to_check_dbger;
56 /***************************************************************************/
57 /* External interface implementation */
58 static uint32_t aice_target_id_codes[AICE_MAX_NUM_CORE];
59 static uint8_t aice_num_of_target_id_codes;
61 /***************************************************************************/
63 int aice_init_targets(void)
66 struct target *target;
67 struct aice_port_s *aice;
69 LOG_DEBUG("aice_init_targets");
71 if (aice_num_of_target_id_codes == 0) {
72 res = aice_port->api->idcode(aice_target_id_codes, &aice_num_of_target_id_codes);
73 if (res != ERROR_OK) {
74 LOG_ERROR("<-- TARGET ERROR! Failed to identify AndesCore "
75 "JTAG Manufacture ID in the JTAG scan chain. "
76 "Failed to access EDM registers. -->");
81 for (target = all_targets; target; target = target->next) {
82 target->tap->idcode = aice_target_id_codes[target->tap->abs_chain_position];
84 unsigned ii, limit = target->tap->expected_ids_cnt;
87 for (ii = 0; ii < limit; ii++) {
88 uint32_t expected = target->tap->expected_ids[ii];
90 /* treat "-expected-id 0" as a "don't-warn" wildcard */
91 if (!expected || (target->tap->idcode == expected)) {
99 ("aice_init_targets: target not found: idcode: %" PRIx32,
100 target->tap->idcode);
104 aice = calloc(1, sizeof(struct aice_port_s));
105 aice->port = aice_port;
106 aice->coreid = target->tap->abs_chain_position;
108 target->tap->priv = aice;
109 target->tap->hasidcode = 1;
115 /***************************************************************************/
116 /* End of External interface implementation */
120 * 2. get/show version number
123 static int aice_init(void)
125 if (ERROR_OK != aice_port->api->open(¶m)) {
126 LOG_ERROR("Cannot find AICE Interface! Please check "
127 "connection and permissions.");
128 return ERROR_JTAG_INIT_FAILED;
131 aice_port->api->set_retry_times(retry_times);
132 aice_port->api->set_count_to_check_dbger(count_to_check_dbger);
134 LOG_INFO("AICE JTAG Interface ready");
139 /* cleanup aice resource
142 static int aice_quit(void)
144 aice_port->api->close();
148 static int aice_execute_reset(struct jtag_command *cmd)
150 static int last_trst;
151 int retval = ERROR_OK;
153 DEBUG_JTAG_IO("reset trst: %d", cmd->cmd.reset->trst);
155 if (cmd->cmd.reset->trst != last_trst) {
156 if (cmd->cmd.reset->trst)
157 retval = aice_port->api->reset();
159 last_trst = cmd->cmd.reset->trst;
165 static int aice_execute_command(struct jtag_command *cmd)
171 retval = aice_execute_reset(cmd);
180 /* aice has no need to implement jtag execution model
182 static int aice_execute_queue(void)
184 struct jtag_command *cmd = jtag_command_queue; /* currently processed command */
190 if (aice_execute_command(cmd) != ERROR_OK)
191 retval = ERROR_JTAG_QUEUE_FAILED;
199 /* set jtag frequency(base frequency/frequency divider) to your jtag adapter */
200 static int aice_speed(int speed)
202 return aice_port->api->set_jtag_clock(speed);
205 /* convert jtag adapter frequency(base frequency/frequency divider) to
206 * human readable KHz value */
207 static int aice_speed_div(int speed, int *khz)
209 *khz = aice_khz_to_speed_map[speed];
214 /* convert human readable KHz value to jtag adapter frequency
215 * (base frequency/frequency divider) */
216 static int aice_khz(int khz, int *jtag_speed)
219 for (i = 0 ; i < AICE_KHZ_TO_SPEED_MAP_SIZE ; i++) {
220 if (khz == aice_khz_to_speed_map[i]) {
222 *jtag_speed = i | AICE_TCK_CONTROL_TCK3048;
229 if (i == AICE_KHZ_TO_SPEED_MAP_SIZE) {
230 LOG_INFO("No support the jtag clock: %d", khz);
231 LOG_INFO("Supported jtag clocks are:");
233 for (i = 0 ; i < AICE_KHZ_TO_SPEED_MAP_SIZE ; i++)
234 LOG_INFO("* %d", aice_khz_to_speed_map[i]);
242 int aice_scan_jtag_chain(void)
244 LOG_DEBUG("=== %s ===", __func__);
245 uint8_t num_of_idcode = 0;
246 struct target *target;
248 int res = aice_port->api->idcode(aice_target_id_codes, &num_of_idcode);
249 if (res != ERROR_OK) {
250 LOG_ERROR("<-- TARGET ERROR! Failed to identify AndesCore "
251 "JTAG Manufacture ID in the JTAG scan chain. "
252 "Failed to access EDM registers. -->");
256 for (uint32_t i = 0; i < num_of_idcode; i++)
257 LOG_DEBUG("id_codes[%d] = 0x%x", i, aice_target_id_codes[i]);
259 /* Update tap idcode */
260 for (target = all_targets; target; target = target->next)
261 target->tap->idcode = aice_target_id_codes[target->tap->abs_chain_position];
266 /***************************************************************************/
267 /* Command handlers */
268 COMMAND_HANDLER(aice_handle_aice_info_command)
270 LOG_DEBUG("aice_handle_aice_info_command");
272 command_print(CMD_CTX, "Description: %s", param.device_desc);
273 command_print(CMD_CTX, "Serial number: %s", param.serial);
274 if (strncmp(aice_port->name, "aice_pipe", 9) == 0)
275 command_print(CMD_CTX, "Adapter: %s", param.adapter_name);
280 COMMAND_HANDLER(aice_handle_aice_port_command)
282 LOG_DEBUG("aice_handle_aice_port_command");
285 LOG_ERROR("Need exactly one argument to 'aice port'");
286 return ERROR_COMMAND_SYNTAX_ERROR;
289 for (const struct aice_port *l = aice_port_get_list(); l->name; l++) {
290 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
296 LOG_ERROR("No AICE port '%s' found", CMD_ARGV[0]);
300 COMMAND_HANDLER(aice_handle_aice_desc_command)
302 LOG_DEBUG("aice_handle_aice_desc_command");
305 param.device_desc = strdup(CMD_ARGV[0]);
307 LOG_ERROR("expected exactly one argument to aice desc <description>");
312 COMMAND_HANDLER(aice_handle_aice_serial_command)
314 LOG_DEBUG("aice_handle_aice_serial_command");
317 param.serial = strdup(CMD_ARGV[0]);
319 LOG_ERROR("expected exactly one argument to aice serial <serial-number>");
324 COMMAND_HANDLER(aice_handle_aice_vid_pid_command)
326 LOG_DEBUG("aice_handle_aice_vid_pid_command");
329 LOG_WARNING("ignoring extra IDs in aice vid_pid (maximum is 1 pair)");
330 return ERROR_COMMAND_SYNTAX_ERROR;
333 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], param.vid);
334 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], param.pid);
339 COMMAND_HANDLER(aice_handle_aice_adapter_command)
341 LOG_DEBUG("aice_handle_aice_adapter_command");
344 param.adapter_name = strdup(CMD_ARGV[0]);
346 LOG_ERROR("expected exactly one argument to aice adapter <adapter-name>");
351 COMMAND_HANDLER(aice_handle_aice_retry_times_command)
353 LOG_DEBUG("aice_handle_aice_retry_times_command");
356 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], retry_times);
358 LOG_ERROR("expected exactly one argument to aice retry_times <num_of_retry>");
363 COMMAND_HANDLER(aice_handle_aice_count_to_check_dbger_command)
365 LOG_DEBUG("aice_handle_aice_count_to_check_dbger_command");
368 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], count_to_check_dbger);
370 LOG_ERROR("expected exactly one argument to aice count_to_check_dbger "
371 "<count_of_checking>");
376 COMMAND_HANDLER(aice_handle_aice_custom_srst_script_command)
378 LOG_DEBUG("aice_handle_aice_custom_srst_script_command");
381 aice_port->api->set_custom_srst_script(CMD_ARGV[0]);
388 COMMAND_HANDLER(aice_handle_aice_custom_trst_script_command)
390 LOG_DEBUG("aice_handle_aice_custom_trst_script_command");
393 aice_port->api->set_custom_trst_script(CMD_ARGV[0]);
400 COMMAND_HANDLER(aice_handle_aice_custom_restart_script_command)
402 LOG_DEBUG("aice_handle_aice_custom_restart_script_command");
405 aice_port->api->set_custom_restart_script(CMD_ARGV[0]);
412 COMMAND_HANDLER(aice_handle_aice_reset_command)
414 LOG_DEBUG("aice_handle_aice_reset_command");
416 return aice_port->api->reset();
420 static const struct command_registration aice_subcommand_handlers[] = {
423 .handler = &aice_handle_aice_info_command,
424 .mode = COMMAND_EXEC,
425 .help = "show aice info",
426 .usage = "aice info",
430 .handler = &aice_handle_aice_port_command,
431 .mode = COMMAND_CONFIG,
432 .help = "set the port of the AICE",
433 .usage = "aice port ['aice_pipe'|'aice_usb']",
437 .handler = &aice_handle_aice_desc_command,
438 .mode = COMMAND_CONFIG,
439 .help = "set the aice device description",
440 .usage = "aice desc [desciption string]",
444 .handler = &aice_handle_aice_serial_command,
445 .mode = COMMAND_CONFIG,
446 .help = "set the serial number of the AICE device",
447 .usage = "aice serial [serial string]",
451 .handler = &aice_handle_aice_vid_pid_command,
452 .mode = COMMAND_CONFIG,
453 .help = "the vendor and product ID of the AICE device",
454 .usage = "aice vid_pid (vid pid)*",
458 .handler = &aice_handle_aice_adapter_command,
459 .mode = COMMAND_CONFIG,
460 .help = "set the file name of adapter",
461 .usage = "aice adapter [adapter name]",
464 .name = "retry_times",
465 .handler = &aice_handle_aice_retry_times_command,
466 .mode = COMMAND_CONFIG,
467 .help = "set retry times as AICE timeout",
468 .usage = "aice retry_times num_of_retry",
471 .name = "count_to_check_dbger",
472 .handler = &aice_handle_aice_count_to_check_dbger_command,
473 .mode = COMMAND_CONFIG,
474 .help = "set retry times as checking $DBGER status",
475 .usage = "aice count_to_check_dbger count_of_checking",
478 .name = "custom_srst_script",
479 .handler = &aice_handle_aice_custom_srst_script_command,
480 .mode = COMMAND_CONFIG,
481 .usage = "custom_srst_script script_file_name",
482 .help = "set custom srst script",
485 .name = "custom_trst_script",
486 .handler = &aice_handle_aice_custom_trst_script_command,
487 .mode = COMMAND_CONFIG,
488 .usage = "custom_trst_script script_file_name",
489 .help = "set custom trst script",
492 .name = "custom_restart_script",
493 .handler = &aice_handle_aice_custom_restart_script_command,
494 .mode = COMMAND_CONFIG,
495 .usage = "custom_restart_script script_file_name",
496 .help = "set custom restart script",
500 .handler = &aice_handle_aice_reset_command,
501 .mode = COMMAND_EXEC,
502 .usage = "aice reset",
503 .help = "reset AICE",
505 COMMAND_REGISTRATION_DONE
508 static const struct command_registration aice_command_handlers[] = {
512 .help = "perform aice management",
513 .usage = "aice [subcommand]",
514 .chain = aice_subcommand_handlers,
516 COMMAND_REGISTRATION_DONE
518 /***************************************************************************/
519 /* End of Command handlers */
521 struct jtag_interface aice_interface = {
523 .commands = aice_command_handlers,
524 .transports = aice_transports,
527 .execute_queue = aice_execute_queue,
528 .speed = aice_speed, /* set interface speed */
529 .speed_div = aice_speed_div, /* return readable value */
530 .khz = aice_khz, /* convert khz to interface speed value */