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>
30 #define AICE_KHZ_TO_SPEED_MAP_SIZE 16
31 static const int aice_khz_to_speed_map[AICE_KHZ_TO_SPEED_MAP_SIZE] = {
50 static const struct aice_port *aice_port;
51 static struct aice_port_param_s param;
52 static uint32_t retry_times;
53 static uint32_t count_to_check_dbger;
55 /***************************************************************************/
56 /* External interface implementation */
57 static uint32_t aice_target_id_codes[AICE_MAX_NUM_CORE];
58 static uint8_t aice_num_of_target_id_codes;
60 /***************************************************************************/
62 int aice_init_targets(void)
65 struct target *target;
66 struct aice_port_s *aice;
68 LOG_DEBUG("aice_init_targets");
70 if (aice_num_of_target_id_codes == 0) {
71 res = aice_port->api->idcode(aice_target_id_codes, &aice_num_of_target_id_codes);
72 if (res != ERROR_OK) {
73 LOG_ERROR("<-- TARGET ERROR! Failed to identify AndesCore "
74 "JTAG Manufacture ID in the JTAG scan chain. "
75 "Failed to access EDM registers. -->");
80 for (target = all_targets; target; target = target->next) {
81 target->tap->idcode = aice_target_id_codes[target->tap->abs_chain_position];
83 unsigned ii, limit = target->tap->expected_ids_cnt;
86 for (ii = 0; ii < limit; ii++) {
87 uint32_t expected = target->tap->expected_ids[ii];
89 /* treat "-expected-id 0" as a "don't-warn" wildcard */
90 if (!expected || (target->tap->idcode == expected)) {
98 ("aice_init_targets: target not found: idcode: %" PRIx32,
103 aice = calloc(1, sizeof(struct aice_port_s));
104 aice->port = aice_port;
105 aice->coreid = target->tap->abs_chain_position;
107 target->tap->priv = aice;
108 target->tap->hasidcode = 1;
114 /***************************************************************************/
115 /* End of External interface implementation */
119 * 2. get/show version number
122 static int aice_init(void)
124 if (ERROR_OK != aice_port->api->open(¶m)) {
125 LOG_ERROR("Cannot find AICE Interface! Please check "
126 "connection and permissions.");
127 return ERROR_JTAG_INIT_FAILED;
130 aice_port->api->set_retry_times(retry_times);
131 aice_port->api->set_count_to_check_dbger(count_to_check_dbger);
133 LOG_INFO("AICE JTAG Interface ready");
138 /* cleanup aice resource
141 static int aice_quit(void)
143 aice_port->api->close();
147 static int aice_execute_reset(struct jtag_command *cmd)
149 static int last_trst;
150 int retval = ERROR_OK;
152 LOG_DEBUG_IO("reset trst: %d", cmd->cmd.reset->trst);
154 if (cmd->cmd.reset->trst != last_trst) {
155 if (cmd->cmd.reset->trst)
156 retval = aice_port->api->reset();
158 last_trst = cmd->cmd.reset->trst;
164 static int aice_execute_command(struct jtag_command *cmd)
170 retval = aice_execute_reset(cmd);
179 /* aice has no need to implement jtag execution model
181 static int aice_execute_queue(void)
183 struct jtag_command *cmd = jtag_command_queue; /* currently processed command */
189 if (aice_execute_command(cmd) != ERROR_OK)
190 retval = ERROR_JTAG_QUEUE_FAILED;
198 /* set jtag frequency(base frequency/frequency divider) to your jtag adapter */
199 static int aice_speed(int speed)
201 return aice_port->api->set_jtag_clock(speed);
204 /* convert jtag adapter frequency(base frequency/frequency divider) to
205 * human readable KHz value */
206 static int aice_speed_div(int speed, int *khz)
208 *khz = aice_khz_to_speed_map[speed];
213 /* convert human readable KHz value to jtag adapter frequency
214 * (base frequency/frequency divider) */
215 static int aice_khz(int khz, int *jtag_speed)
218 for (i = 0 ; i < AICE_KHZ_TO_SPEED_MAP_SIZE ; i++) {
219 if (khz == aice_khz_to_speed_map[i]) {
221 *jtag_speed = i | AICE_TCK_CONTROL_TCK3048;
228 if (i == AICE_KHZ_TO_SPEED_MAP_SIZE) {
229 LOG_INFO("No support the jtag clock: %d", khz);
230 LOG_INFO("Supported jtag clocks are:");
232 for (i = 0 ; i < AICE_KHZ_TO_SPEED_MAP_SIZE ; i++)
233 LOG_INFO("* %d", aice_khz_to_speed_map[i]);
241 int aice_scan_jtag_chain(void)
243 LOG_DEBUG("=== %s ===", __func__);
244 uint8_t num_of_idcode = 0;
245 struct target *target;
247 int res = aice_port->api->idcode(aice_target_id_codes, &num_of_idcode);
248 if (res != ERROR_OK) {
249 LOG_ERROR("<-- TARGET ERROR! Failed to identify AndesCore "
250 "JTAG Manufacture ID in the JTAG scan chain. "
251 "Failed to access EDM registers. -->");
255 for (unsigned int i = 0; i < num_of_idcode; i++)
256 LOG_DEBUG("id_codes[%u] = 0x%" PRIx32, i, aice_target_id_codes[i]);
258 /* Update tap idcode */
259 for (target = all_targets; target; target = target->next)
260 target->tap->idcode = aice_target_id_codes[target->tap->abs_chain_position];
265 /***************************************************************************/
266 /* Command handlers */
267 COMMAND_HANDLER(aice_handle_aice_info_command)
269 LOG_DEBUG("aice_handle_aice_info_command");
271 command_print(CMD, "Description: %s", param.device_desc);
272 command_print(CMD, "Serial number: %s", param.serial);
273 if (strncmp(aice_port->name, "aice_pipe", 9) == 0)
274 command_print(CMD, "Adapter: %s", param.adapter_name);
279 COMMAND_HANDLER(aice_handle_aice_port_command)
281 LOG_DEBUG("aice_handle_aice_port_command");
284 LOG_ERROR("Need exactly one argument to 'aice port'");
285 return ERROR_COMMAND_SYNTAX_ERROR;
288 for (const struct aice_port *l = aice_port_get_list(); l->name; l++) {
289 if (strcmp(l->name, CMD_ARGV[0]) == 0) {
295 LOG_ERROR("No AICE port '%s' found", CMD_ARGV[0]);
299 COMMAND_HANDLER(aice_handle_aice_desc_command)
301 LOG_DEBUG("aice_handle_aice_desc_command");
304 param.device_desc = strdup(CMD_ARGV[0]);
306 LOG_ERROR("expected exactly one argument to aice desc <description>");
311 COMMAND_HANDLER(aice_handle_aice_serial_command)
313 LOG_DEBUG("aice_handle_aice_serial_command");
316 param.serial = strdup(CMD_ARGV[0]);
318 LOG_ERROR("expected exactly one argument to aice serial <serial-number>");
323 COMMAND_HANDLER(aice_handle_aice_vid_pid_command)
325 LOG_DEBUG("aice_handle_aice_vid_pid_command");
328 LOG_WARNING("ignoring extra IDs in aice vid_pid (maximum is 1 pair)");
329 return ERROR_COMMAND_SYNTAX_ERROR;
332 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[0], param.vid);
333 COMMAND_PARSE_NUMBER(u16, CMD_ARGV[1], param.pid);
338 COMMAND_HANDLER(aice_handle_aice_adapter_command)
340 LOG_DEBUG("aice_handle_aice_adapter_command");
343 param.adapter_name = strdup(CMD_ARGV[0]);
345 LOG_ERROR("expected exactly one argument to aice adapter <adapter-name>");
350 COMMAND_HANDLER(aice_handle_aice_retry_times_command)
352 LOG_DEBUG("aice_handle_aice_retry_times_command");
355 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], retry_times);
357 LOG_ERROR("expected exactly one argument to aice retry_times <num_of_retry>");
362 COMMAND_HANDLER(aice_handle_aice_count_to_check_dbger_command)
364 LOG_DEBUG("aice_handle_aice_count_to_check_dbger_command");
367 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], count_to_check_dbger);
369 LOG_ERROR("expected exactly one argument to aice count_to_check_dbger "
370 "<count_of_checking>");
375 COMMAND_HANDLER(aice_handle_aice_custom_srst_script_command)
377 LOG_DEBUG("aice_handle_aice_custom_srst_script_command");
380 aice_port->api->set_custom_srst_script(CMD_ARGV[0]);
387 COMMAND_HANDLER(aice_handle_aice_custom_trst_script_command)
389 LOG_DEBUG("aice_handle_aice_custom_trst_script_command");
392 aice_port->api->set_custom_trst_script(CMD_ARGV[0]);
399 COMMAND_HANDLER(aice_handle_aice_custom_restart_script_command)
401 LOG_DEBUG("aice_handle_aice_custom_restart_script_command");
404 aice_port->api->set_custom_restart_script(CMD_ARGV[0]);
411 COMMAND_HANDLER(aice_handle_aice_reset_command)
413 LOG_DEBUG("aice_handle_aice_reset_command");
415 return aice_port->api->reset();
419 static const struct command_registration aice_subcommand_handlers[] = {
422 .handler = &aice_handle_aice_info_command,
423 .mode = COMMAND_EXEC,
424 .help = "show aice info",
429 .handler = &aice_handle_aice_port_command,
430 .mode = COMMAND_CONFIG,
431 .help = "set the port of the AICE",
432 .usage = "['aice_pipe'|'aice_usb']",
436 .handler = &aice_handle_aice_desc_command,
437 .mode = COMMAND_CONFIG,
438 .help = "set the aice device description",
439 .usage = "[desciption string]",
443 .handler = &aice_handle_aice_serial_command,
444 .mode = COMMAND_CONFIG,
445 .help = "set the serial number of the AICE device",
446 .usage = "[serial string]",
450 .handler = &aice_handle_aice_vid_pid_command,
451 .mode = COMMAND_CONFIG,
452 .help = "the vendor and product ID of the AICE device",
453 .usage = "(vid pid)*",
457 .handler = &aice_handle_aice_adapter_command,
458 .mode = COMMAND_CONFIG,
459 .help = "set the file name of adapter",
460 .usage = "[adapter name]",
463 .name = "retry_times",
464 .handler = &aice_handle_aice_retry_times_command,
465 .mode = COMMAND_CONFIG,
466 .help = "set retry times as AICE timeout",
467 .usage = "num_of_retry",
470 .name = "count_to_check_dbger",
471 .handler = &aice_handle_aice_count_to_check_dbger_command,
472 .mode = COMMAND_CONFIG,
473 .help = "set retry times as checking $DBGER status",
474 .usage = "count_of_checking",
477 .name = "custom_srst_script",
478 .handler = &aice_handle_aice_custom_srst_script_command,
479 .mode = COMMAND_CONFIG,
480 .usage = "script_file_name",
481 .help = "set custom srst script",
484 .name = "custom_trst_script",
485 .handler = &aice_handle_aice_custom_trst_script_command,
486 .mode = COMMAND_CONFIG,
487 .usage = "script_file_name",
488 .help = "set custom trst script",
491 .name = "custom_restart_script",
492 .handler = &aice_handle_aice_custom_restart_script_command,
493 .mode = COMMAND_CONFIG,
494 .usage = "script_file_name",
495 .help = "set custom restart script",
499 .handler = &aice_handle_aice_reset_command,
500 .mode = COMMAND_EXEC,
502 .help = "reset AICE",
504 COMMAND_REGISTRATION_DONE
507 static const struct command_registration aice_command_handlers[] = {
511 .help = "perform aice management",
512 .usage = "[subcommand]",
513 .chain = aice_subcommand_handlers,
515 COMMAND_REGISTRATION_DONE
517 /***************************************************************************/
518 /* End of Command handlers */
520 static struct jtag_interface aice_interface = {
521 .execute_queue = aice_execute_queue,
524 struct adapter_driver aice_adapter_driver = {
526 .transports = aice_transports,
527 .commands = aice_command_handlers,
531 .speed = aice_speed, /* set interface speed */
532 .khz = aice_khz, /* convert khz to interface speed value */
533 .speed_div = aice_speed_div, /* return readable value */
535 .jtag_ops = &aice_interface,