src/target/arm_cti.c

   1 /***************************************************************************
   2  *   Copyright (C) 2016 by Matthias Welwarsky                              *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *                                                                         *
  18  ***************************************************************************/
  19
  20 #ifdef HAVE_CONFIG_H
  21 #include "config.h"
  22 #endif
  23
  24 #include <stdlib.h>
  25 #include <stdint.h>
  26 #include "target/arm_adi_v5.h"
  27 #include "target/arm_cti.h"
  28 #include "target/target.h"
  29 #include "helper/time_support.h"
  30 #include "helper/list.h"
  31 #include "helper/command.h"
  32
  33 struct arm_cti {
  34         target_addr_t base;
  35         struct adiv5_ap *ap;
  36 };
  37
  38 struct arm_cti_object {
  39         struct list_head lh;
  40         struct arm_cti cti;
  41         int ap_num;
  42         char *name;
  43 };
  44
  45 static LIST_HEAD(all_cti);
  46
  47 const char *arm_cti_name(struct arm_cti *self)
  48 {
  49         struct arm_cti_object *obj = container_of(self, struct arm_cti_object, cti);
  50         return obj->name;
  51 }
  52
  53 struct arm_cti *cti_instance_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
  54 {
  55         struct arm_cti_object *obj = NULL;
  56         const char *name;
  57         bool found = false;
  58
  59         name = Jim_GetString(o, NULL);
  60
  61         list_for_each_entry(obj, &all_cti, lh) {
  62                 if (!strcmp(name, obj->name)) {
  63                         found = true;
  64                         break;
  65                 }
  66         }
  67
  68         if (found)
  69                 return &obj->cti;
  70         return NULL;
  71 }
  72
  73 static int arm_cti_mod_reg_bits(struct arm_cti *self, unsigned int reg, uint32_t mask, uint32_t value)
  74 {
  75         uint32_t tmp;
  76
  77         /* Read register */
  78         int retval = mem_ap_read_atomic_u32(self->ap, self->base + reg, &tmp);
  79         if (ERROR_OK != retval)
  80                 return retval;
  81
  82         /* clear bitfield */
  83         tmp &= ~mask;
  84         /* put new value */
  85         tmp |= value & mask;
  86
  87         /* write new value */
  88         return mem_ap_write_atomic_u32(self->ap, self->base + reg, tmp);
  89 }
  90
  91 int arm_cti_enable(struct arm_cti *self, bool enable)
  92 {
  93         uint32_t val = enable ? 1 : 0;
  94
  95         return mem_ap_write_atomic_u32(self->ap, self->base + CTI_CTR, val);
  96 }
  97
  98 int arm_cti_ack_events(struct arm_cti *self, uint32_t event)
  99 {
 100         int retval;
 101         uint32_t tmp;
 102
 103         retval = mem_ap_write_atomic_u32(self->ap, self->base + CTI_INACK, event);
 104         if (retval == ERROR_OK) {
 105                 int64_t then = timeval_ms();
 106                 for (;;) {
 107                         retval = mem_ap_read_atomic_u32(self->ap, self->base + CTI_TROUT_STATUS, &tmp);
 108                         if (retval != ERROR_OK)
 109                                 break;
 110                         if ((tmp & event) == 0)
 111                                 break;
 112                         if (timeval_ms() > then + 1000) {
 113                                 LOG_ERROR("timeout waiting for target");
 114                                 retval = ERROR_TARGET_TIMEOUT;
 115                                 break;
 116                         }
 117                 }
 118         }
 119
 120         return retval;
 121 }
 122
 123 int arm_cti_gate_channel(struct arm_cti *self, uint32_t channel)
 124 {
 125         if (channel > 31)
 126                 return ERROR_COMMAND_ARGUMENT_INVALID;
 127
 128         return arm_cti_mod_reg_bits(self, CTI_GATE, CTI_CHNL(channel), 0);
 129 }
 130
 131 int arm_cti_ungate_channel(struct arm_cti *self, uint32_t channel)
 132 {
 133         if (channel > 31)
 134                 return ERROR_COMMAND_ARGUMENT_INVALID;
 135
 136         return arm_cti_mod_reg_bits(self, CTI_GATE, CTI_CHNL(channel), 0xFFFFFFFF);
 137 }
 138
 139 int arm_cti_write_reg(struct arm_cti *self, unsigned int reg, uint32_t value)
 140 {
 141         return mem_ap_write_atomic_u32(self->ap, self->base + reg, value);
 142 }
 143
 144 int arm_cti_read_reg(struct arm_cti *self, unsigned int reg, uint32_t *p_value)
 145 {
 146         if (p_value == NULL)
 147                 return ERROR_COMMAND_ARGUMENT_INVALID;
 148
 149         return mem_ap_read_atomic_u32(self->ap, self->base + reg, p_value);
 150 }
 151
 152 int arm_cti_pulse_channel(struct arm_cti *self, uint32_t channel)
 153 {
 154         if (channel > 31)
 155                 return ERROR_COMMAND_ARGUMENT_INVALID;
 156
 157         return arm_cti_write_reg(self, CTI_APPPULSE, CTI_CHNL(channel));
 158 }
 159
 160 int arm_cti_set_channel(struct arm_cti *self, uint32_t channel)
 161 {
 162         if (channel > 31)
 163                 return ERROR_COMMAND_ARGUMENT_INVALID;
 164
 165         return arm_cti_write_reg(self, CTI_APPSET, CTI_CHNL(channel));
 166 }
 167
 168 int arm_cti_clear_channel(struct arm_cti *self, uint32_t channel)
 169 {
 170         if (channel > 31)
 171                 return ERROR_COMMAND_ARGUMENT_INVALID;
 172
 173         return arm_cti_write_reg(self, CTI_APPCLEAR, CTI_CHNL(channel));
 174 }
 175
 176 static uint32_t cti_regs[26];
 177
 178 static const struct {
 179         uint32_t offset;
 180         const char *label;
 181         uint32_t *p_val;
 182 } cti_names[] = {
 183         { CTI_CTR,              "CTR",          &cti_regs[0] },
 184         { CTI_GATE,             "GATE",         &cti_regs[1] },
 185         { CTI_INEN0,    "INEN0",        &cti_regs[2] },
 186         { CTI_INEN1,    "INEN1",        &cti_regs[3] },
 187         { CTI_INEN2,    "INEN2",        &cti_regs[4] },
 188         { CTI_INEN3,    "INEN3",        &cti_regs[5] },
 189         { CTI_INEN4,    "INEN4",        &cti_regs[6] },
 190         { CTI_INEN5,    "INEN5",        &cti_regs[7] },
 191         { CTI_INEN6,    "INEN6",        &cti_regs[8] },
 192         { CTI_INEN7,    "INEN7",        &cti_regs[9] },
 193         { CTI_INEN8,    "INEN8",        &cti_regs[10] },
 194         { CTI_OUTEN0,   "OUTEN0",       &cti_regs[11] },
 195         { CTI_OUTEN1,   "OUTEN1",       &cti_regs[12] },
 196         { CTI_OUTEN2,   "OUTEN2",       &cti_regs[13] },
 197         { CTI_OUTEN3,   "OUTEN3",       &cti_regs[14] },
 198         { CTI_OUTEN4,   "OUTEN4",       &cti_regs[15] },
 199         { CTI_OUTEN5,   "OUTEN5",       &cti_regs[16] },
 200         { CTI_OUTEN6,   "OUTEN6",       &cti_regs[17] },
 201         { CTI_OUTEN7,   "OUTEN7",       &cti_regs[18] },
 202         { CTI_OUTEN8,   "OUTEN8",       &cti_regs[19] },
 203         { CTI_TRIN_STATUS,      "TRIN", &cti_regs[20] },
 204         { CTI_TROUT_STATUS,     "TROUT", &cti_regs[21] },
 205         { CTI_CHIN_STATUS,      "CHIN", &cti_regs[22] },
 206         { CTI_CHOU_STATUS,      "CHOUT", &cti_regs[23] },
 207         { CTI_APPSET,   "APPSET",       &cti_regs[24] },
 208         { CTI_APPCLEAR, "APPCLR",       &cti_regs[25] },
 209 };
 210
 211 static int cti_find_reg_offset(const char *name)
 212 {
 213         unsigned int i;
 214
 215         for (i = 0; i < ARRAY_SIZE(cti_names); i++) {
 216                 if (!strcmp(name, cti_names[i].label))
 217                         return cti_names[i].offset;
 218         }
 219
 220         LOG_ERROR("unknown CTI register %s", name);
 221         return -1;
 222 }
 223
 224 int arm_cti_cleanup_all(void)
 225 {
 226         struct arm_cti_object *obj, *tmp;
 227
 228         list_for_each_entry_safe(obj, tmp, &all_cti, lh) {
 229                 free(obj->name);
 230                 free(obj);
 231         }
 232
 233         return ERROR_OK;
 234 }
 235
 236 COMMAND_HANDLER(handle_cti_dump)
 237 {
 238         struct arm_cti_object *obj = CMD_DATA;
 239         struct arm_cti *cti = &obj->cti;
 240         int retval = ERROR_OK;
 241
 242         for (int i = 0; (retval == ERROR_OK) && (i < (int)ARRAY_SIZE(cti_names)); i++)
 243                 retval = mem_ap_read_u32(cti->ap,
 244                                 cti->base + cti_names[i].offset, cti_names[i].p_val);
 245
 246         if (retval == ERROR_OK)
 247                 retval = dap_run(cti->ap->dap);
 248
 249         if (retval != ERROR_OK)
 250                 return JIM_ERR;
 251
 252         for (int i = 0; i < (int)ARRAY_SIZE(cti_names); i++)
 253                 command_print(CMD_CTX, "%8.8s (0x%04"PRIx32") 0x%08"PRIx32,
 254                                 cti_names[i].label, cti_names[i].offset, *cti_names[i].p_val);
 255
 256         return JIM_OK;
 257 }
 258
 259 COMMAND_HANDLER(handle_cti_enable)
 260 {
 261         struct arm_cti_object *obj = CMD_DATA;
 262         Jim_Interp *interp = CMD_CTX->interp;
 263         struct arm_cti *cti = &obj->cti;
 264         bool on_off;
 265
 266         if (CMD_ARGC != 1) {
 267                 Jim_SetResultString(interp, "wrong number of args", -1);
 268                 return ERROR_FAIL;
 269         }
 270
 271         COMMAND_PARSE_ON_OFF(CMD_ARGV[0], on_off);
 272
 273         return arm_cti_enable(cti, on_off);
 274 }
 275
 276 COMMAND_HANDLER(handle_cti_testmode)
 277 {
 278         struct arm_cti_object *obj = CMD_DATA;
 279         Jim_Interp *interp = CMD_CTX->interp;
 280         struct arm_cti *cti = &obj->cti;
 281         bool on_off;
 282
 283         if (CMD_ARGC != 1) {
 284                 Jim_SetResultString(interp, "wrong number of args", -1);
 285                 return ERROR_FAIL;
 286         }
 287
 288         COMMAND_PARSE_ON_OFF(CMD_ARGV[0], on_off);
 289
 290         return arm_cti_write_reg(cti, 0xf00, on_off ? 0x1 : 0x0);
 291 }
 292
 293 COMMAND_HANDLER(handle_cti_write)
 294 {
 295         struct arm_cti_object *obj = CMD_DATA;
 296         Jim_Interp *interp = CMD_CTX->interp;
 297         struct arm_cti *cti = &obj->cti;
 298         int offset;
 299         uint32_t value;
 300
 301         if (CMD_ARGC != 2) {
 302                 Jim_SetResultString(interp, "Wrong number of args", -1);
 303                 return ERROR_FAIL;
 304         }
 305
 306         offset = cti_find_reg_offset(CMD_ARGV[0]);
 307         if (offset < 0)
 308                 return ERROR_FAIL;
 309
 310         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
 311
 312         return arm_cti_write_reg(cti, offset, value);
 313 }
 314
 315 COMMAND_HANDLER(handle_cti_read)
 316 {
 317         struct arm_cti_object *obj = CMD_DATA;
 318         Jim_Interp *interp = CMD_CTX->interp;
 319         struct arm_cti *cti = &obj->cti;
 320         int offset;
 321         int retval;
 322         uint32_t value;
 323
 324         if (CMD_ARGC != 1) {
 325                 Jim_SetResultString(interp, "Wrong number of args", -1);
 326                 return ERROR_FAIL;
 327         }
 328
 329         offset = cti_find_reg_offset(CMD_ARGV[0]);
 330         if (offset < 0)
 331                 return ERROR_FAIL;
 332
 333         retval = arm_cti_read_reg(cti, offset, &value);
 334         if (retval != ERROR_OK)
 335                 return retval;
 336
 337         command_print(CMD_CTX, "0x%08"PRIx32, value);
 338
 339         return ERROR_OK;
 340 }
 341
 342 static const struct command_registration cti_instance_command_handlers[] = {
 343         {
 344                 .name  = "dump",
 345                 .mode  = COMMAND_EXEC,
 346                 .handler = handle_cti_dump,
 347                 .help  = "dump CTI registers",
 348                 .usage = "",
 349         },
 350         {
 351                 .name = "enable",
 352                 .mode = COMMAND_EXEC,
 353                 .handler = handle_cti_enable,
 354                 .help = "enable or disable the CTI",
 355                 .usage = "'on'|'off'",
 356         },
 357         {
 358                 .name = "testmode",
 359                 .mode = COMMAND_EXEC,
 360                 .handler = handle_cti_testmode,
 361                 .help = "enable or disable integration test mode",
 362                 .usage = "'on'|'off'",
 363         },
 364         {
 365                 .name = "write",
 366                 .mode = COMMAND_EXEC,
 367                 .handler = handle_cti_write,
 368                 .help = "write to a CTI register",
 369                 .usage = "register_name value",
 370         },
 371         {
 372                 .name = "read",
 373                 .mode = COMMAND_EXEC,
 374                 .handler = handle_cti_read,
 375                 .help = "read a CTI register",
 376                 .usage = "register_name",
 377         },
 378         COMMAND_REGISTRATION_DONE
 379 };
 380
 381 enum cti_cfg_param {
 382         CFG_DAP,
 383         CFG_AP_NUM,
 384         CFG_CTIBASE
 385 };
 386
 387 static const Jim_Nvp nvp_config_opts[] = {
 388         { .name = "-dap",     .value = CFG_DAP },
 389         { .name = "-ctibase", .value = CFG_CTIBASE },
 390         { .name = "-ap-num",  .value = CFG_AP_NUM },
 391         { .name = NULL, .value = -1 }
 392 };
 393
 394 static int cti_configure(Jim_GetOptInfo *goi, struct arm_cti_object *cti)
 395 {
 396         struct adiv5_dap *dap = NULL;
 397         Jim_Nvp *n;
 398         jim_wide w;
 399         int e;
 400
 401         /* parse config or cget options ... */
 402         while (goi->argc > 0) {
 403                 Jim_SetEmptyResult(goi->interp);
 404
 405                 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
 406                 if (e != JIM_OK) {
 407                         Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
 408                         return e;
 409                 }
 410                 switch (n->value) {
 411                 case CFG_DAP: {
 412                         Jim_Obj *o_t;
 413                         e = Jim_GetOpt_Obj(goi, &o_t);
 414                         if (e != JIM_OK)
 415                                 return e;
 416                         dap = dap_instance_by_jim_obj(goi->interp, o_t);
 417                         if (dap == NULL) {
 418                                 Jim_SetResultString(goi->interp, "-dap is invalid", -1);
 419                                 return JIM_ERR;
 420                         }
 421                         /* loop for more */
 422                         break;
 423                 }
 424                 case CFG_CTIBASE:
 425                         e = Jim_GetOpt_Wide(goi, &w);
 426                         if (e != JIM_OK)
 427                                 return e;
 428                         cti->cti.base = (uint32_t)w;
 429                         /* loop for more */
 430                         break;
 431
 432                 case CFG_AP_NUM:
 433                         e = Jim_GetOpt_Wide(goi, &w);
 434                         if (e != JIM_OK)
 435                                 return e;
 436                         if (w < 0 || w > DP_APSEL_MAX) {
 437                                 Jim_SetResultString(goi->interp, "-ap-num is invalid", -1);
 438                                 return JIM_ERR;
 439                         }
 440                         cti->ap_num = (uint32_t)w;
 441                 }
 442         }
 443
 444         if (dap == NULL) {
 445                 Jim_SetResultString(goi->interp, "-dap required when creating CTI", -1);
 446                 return JIM_ERR;
 447         }
 448
 449         cti->cti.ap = dap_ap(dap, cti->ap_num);
 450
 451         return JIM_OK;
 452 }
 453
 454 static int cti_create(Jim_GetOptInfo *goi)
 455 {
 456         struct command_context *cmd_ctx;
 457         static struct arm_cti_object *cti;
 458         Jim_Obj *new_cmd;
 459         Jim_Cmd *cmd;
 460         const char *cp;
 461         int e;
 462
 463         cmd_ctx = current_command_context(goi->interp);
 464         assert(cmd_ctx != NULL);
 465
 466         if (goi->argc < 3) {
 467                 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ..options...");
 468                 return JIM_ERR;
 469         }
 470         /* COMMAND */
 471         Jim_GetOpt_Obj(goi, &new_cmd);
 472         /* does this command exist? */
 473         cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
 474         if (cmd) {
 475                 cp = Jim_GetString(new_cmd, NULL);
 476                 Jim_SetResultFormatted(goi->interp, "Command: %s Exists", cp);
 477                 return JIM_ERR;
 478         }
 479
 480         /* Create it */
 481         cti = calloc(1, sizeof(struct arm_cti_object));
 482         if (cti == NULL)
 483                 return JIM_ERR;
 484
 485         e = cti_configure(goi, cti);
 486         if (e != JIM_OK) {
 487                 free(cti);
 488                 return e;
 489         }
 490
 491         cp = Jim_GetString(new_cmd, NULL);
 492         cti->name = strdup(cp);
 493
 494         /* now - create the new cti name command */
 495         const struct command_registration cti_subcommands[] = {
 496                 {
 497                         .chain = cti_instance_command_handlers,
 498                 },
 499                 COMMAND_REGISTRATION_DONE
 500         };
 501         const struct command_registration cti_commands[] = {
 502                 {
 503                         .name = cp,
 504                         .mode = COMMAND_ANY,
 505                         .help = "cti instance command group",
 506                         .usage = "",
 507                         .chain = cti_subcommands,
 508                 },
 509                 COMMAND_REGISTRATION_DONE
 510         };
 511         e = register_commands(cmd_ctx, NULL, cti_commands);
 512         if (ERROR_OK != e)
 513                 return JIM_ERR;
 514
 515         struct command *c = command_find_in_context(cmd_ctx, cp);
 516         assert(c);
 517         command_set_handler_data(c, cti);
 518
 519         list_add_tail(&cti->lh, &all_cti);
 520
 521         return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
 522 }
 523
 524 static int jim_cti_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 525 {
 526         Jim_GetOptInfo goi;
 527         Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
 528         if (goi.argc < 2) {
 529                 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
 530                         "<name> [<cti_options> ...]");
 531                 return JIM_ERR;
 532         }
 533         return cti_create(&goi);
 534 }
 535
 536 static int jim_cti_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 537 {
 538         struct arm_cti_object *obj;
 539
 540         if (argc != 1) {
 541                 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
 542                 return JIM_ERR;
 543         }
 544         Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
 545         list_for_each_entry(obj, &all_cti, lh) {
 546                 Jim_ListAppendElement(interp, Jim_GetResult(interp),
 547                         Jim_NewStringObj(interp, obj->name, -1));
 548         }
 549         return JIM_OK;
 550 }
 551
 552
 553 static const struct command_registration cti_subcommand_handlers[] = {
 554         {
 555                 .name = "create",
 556                 .mode = COMMAND_ANY,
 557                 .jim_handler = jim_cti_create,
 558                 .usage = "name '-chain-position' name [options ...]",
 559                 .help = "Creates a new CTI object",
 560         },
 561         {
 562                 .name = "names",
 563                 .mode = COMMAND_ANY,
 564                 .jim_handler = jim_cti_names,
 565                 .usage = "",
 566                 .help = "Lists all registered CTI objects by name",
 567         },
 568         COMMAND_REGISTRATION_DONE
 569 };
 570
 571 static const struct command_registration cti_command_handlers[] = {
 572         {
 573                 .name = "cti",
 574                 .mode = COMMAND_CONFIG,
 575                 .help = "CTI commands",
 576                 .chain = cti_subcommand_handlers,
 577         },
 578         COMMAND_REGISTRATION_DONE
 579 };
 580
 581 int cti_register_commands(struct command_context *cmd_ctx)
 582 {
 583         return register_commands(cmd_ctx, NULL, cti_command_handlers);
 584 }
 585