1 /***************************************************************************
2 * Copyright (C) 2007,2008 Øyvind Harboe *
3 * Copyright (C) 2008 Duane Ellis *
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, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
24 #include "replacements.h"
26 #include "target_request.h"
29 #include "configuration.h"
30 #include "binarybuffer.h"
38 #include <sys/types.h>
46 #include <time_support.h>
51 static int new_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 val)
54 Jim_Obj *nameObjPtr, *valObjPtr;
57 namebuf = alloc_printf("%s(%d)", varname, idx);
61 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
62 valObjPtr = Jim_NewIntObj(interp, val);
63 if (!nameObjPtr || !valObjPtr)
69 Jim_IncrRefCount(nameObjPtr);
70 Jim_IncrRefCount(valObjPtr);
71 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
72 Jim_DecrRefCount(interp, nameObjPtr);
73 Jim_DecrRefCount(interp, valObjPtr);
75 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
79 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
82 command_context_t *context;
93 /* argv[1] = name of array to receive the data
94 * argv[2] = desired width
95 * argv[3] = memory address
96 * argv[4] = count of times to read
99 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
102 varname = Jim_GetString(argv[1], &len);
103 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
105 e = Jim_GetLong(interp, argv[2], &l);
111 e = Jim_GetLong(interp, argv[3], &l);
116 e = Jim_GetLong(interp, argv[4], &l);
132 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
133 Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
137 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
138 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
141 if ((addr + (len * width)) < addr) {
142 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
143 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
146 /* absurd transfer size? */
148 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
149 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
154 ((width == 2) && ((addr & 1) == 0)) ||
155 ((width == 4) && ((addr & 3) == 0))) {
159 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
160 sprintf(buf, "mem2array address: 0x%08x is not aligned for %d byte reads", addr, width);
161 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
165 context = Jim_GetAssocData(interp, "context");
168 LOG_ERROR("mem2array: no command context");
171 target = get_current_target(context);
174 LOG_ERROR("mem2array: no current target");
185 /* Slurp... in buffer size chunks */
187 count = len; /* in objects.. */
188 if (count > (sizeof(buffer)/width)) {
189 count = (sizeof(buffer)/width);
192 retval = target->type->read_memory( target, addr, width, count, buffer );
193 if (retval != ERROR_OK) {
195 LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
196 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
197 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
201 v = 0; /* shut up gcc */
202 for (i = 0 ;i < count ;i++, n++) {
205 v = target_buffer_get_u32(target, &buffer[i*width]);
208 v = target_buffer_get_u16(target, &buffer[i*width]);
211 v = buffer[i] & 0x0ff;
214 new_int_array_element(interp, varname, n, v);
220 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
225 static int get_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 *val)
228 Jim_Obj *nameObjPtr, *valObjPtr;
232 namebuf = alloc_printf("%s(%d)", varname, idx);
236 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
243 Jim_IncrRefCount(nameObjPtr);
244 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
245 Jim_DecrRefCount(interp, nameObjPtr);
247 if (valObjPtr == NULL)
250 result = Jim_GetLong(interp, valObjPtr, &l);
251 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
256 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
259 command_context_t *context;
270 /* argv[1] = name of array to get the data
271 * argv[2] = desired width
272 * argv[3] = memory address
273 * argv[4] = count to write
276 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
279 varname = Jim_GetString(argv[1], &len);
280 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
282 e = Jim_GetLong(interp, argv[2], &l);
288 e = Jim_GetLong(interp, argv[3], &l);
293 e = Jim_GetLong(interp, argv[4], &l);
309 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
310 Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
314 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
315 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: zero width read?", NULL);
318 if ((addr + (len * width)) < addr) {
319 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
320 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: addr + len - wraps to zero?", NULL);
323 /* absurd transfer size? */
325 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
326 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: absurd > 64K item request", NULL);
331 ((width == 2) && ((addr & 1) == 0)) ||
332 ((width == 4) && ((addr & 3) == 0))) {
336 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
337 sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads", addr, width);
338 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
342 context = Jim_GetAssocData(interp, "context");
345 LOG_ERROR("array2mem: no command context");
348 target = get_current_target(context);
351 LOG_ERROR("array2mem: no current target");
362 /* Slurp... in buffer size chunks */
364 count = len; /* in objects.. */
365 if (count > (sizeof(buffer)/width)) {
366 count = (sizeof(buffer)/width);
369 v = 0; /* shut up gcc */
370 for (i = 0 ;i < count ;i++, n++) {
371 get_int_array_element(interp, varname, n, &v);
374 target_buffer_set_u32(target, &buffer[i*width], v);
377 target_buffer_set_u16(target, &buffer[i*width], v);
380 buffer[i] = v & 0x0ff;
386 retval = target->type->write_memory(target, addr, width, count, buffer);
387 if (retval != ERROR_OK) {
389 LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
390 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
391 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
397 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
402 int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
405 scan_field_t *fields;
413 * args[3] = hex string
414 * ... repeat num bits and hex string ...
416 if ((argc < 4) || ((argc % 2)!=0))
418 Jim_WrongNumArgs(interp, 1, args, "<device> <num_bits1> <value1> <num_bits2> <value2> ...");
422 for (i = 2; i < argc; i+=2)
426 e = Jim_GetLong(interp, args[i], &bits);
431 e = Jim_GetLong(interp, args[1], &device);
435 num_fields=(argc-2)/2;
436 fields = malloc(sizeof(scan_field_t) * num_fields);
437 for (i = 2; i < argc; i+=2)
443 Jim_GetLong(interp, args[i], &bits);
444 str = Jim_GetString(args[i+1], &len);
446 fields[field_count].device = device;
447 fields[field_count].num_bits = bits;
448 fields[field_count].out_value = malloc(CEIL(bits, 8));
449 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
450 fields[field_count].out_mask = NULL;
451 fields[field_count].in_value = fields[field_count].out_value;
452 fields[field_count].in_check_mask = NULL;
453 fields[field_count].in_check_value = NULL;
454 fields[field_count].in_handler = NULL;
455 fields[field_count++].in_handler_priv = NULL;
458 jtag_add_dr_scan(num_fields, fields, -1);
459 retval = jtag_execute_queue();
460 if (retval != ERROR_OK)
462 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
463 Jim_AppendStrings(interp, Jim_GetResult(interp), "drscan: jtag execute failed", NULL);
468 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
469 for (i = 2; i < argc; i+=2)
474 Jim_GetLong(interp, args[i], &bits);
475 str = buf_to_str(fields[field_count].in_value, bits, 16);
476 free(fields[field_count].out_value);
478 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
483 Jim_SetResult(interp, list);
490 static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
495 Jim_WrongNumArgs(interp, 1, argv, "no arguments to flash_banks command");
504 Jim_Obj *list=Jim_NewListObj(interp, NULL, 0);
505 for (p = flash_banks; p; p = p->next)
507 Jim_Obj *elem=Jim_NewListObj(interp, NULL, 0);
509 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
510 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
511 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
512 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
513 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
514 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
515 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
516 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
517 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
518 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
520 Jim_ListAppendElement(interp, list, elem);
523 Jim_SetResult(interp, list);
529 int tclapi_register_commands()
531 register_jim("ocd_mem2array", jim_mem2array, "read memory and return as a TCL array for script processing");
532 register_jim("ocd_array2mem", jim_array2mem, "convert a TCL array to memory locations and write the values");
533 register_jim("drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
534 register_jim("ocd_flash_banks", jim_flash_banks, "return information about the flash banks");