New debug command: dump heap

[z180-stamp.git] / avr / debug.c

/*
 * (C) Copyright 2014,2016 Leo C. <erbl259-lmu@yahoo.de>
 *
 * SPDX-License-Identifier:	GPL-2.0
 */

#include "debug.h"
#include "common.h"
#include <stdlib.h>			/* __malloc_margin */
#include <string.h>
#include <ctype.h>
#include <avr/eeprom.h>

#include "command.h"
#include "cli_readline.h"
#include "eval_arg.h"
#include "print-utils.h"

/*
 * Debugging
 */

#ifdef DEBUG

/*
 * Memory Display
 *	md addr {len}
 */
command_ret_t do_dump_mem(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[])
{
	int (*readwhat)(uint8_t *buf, uint32_t addr, uint8_t count);

	(void) cmdtp; (void) flag;

	if (argc < 2)
		return CMD_RET_USAGE;

	uint32_t addr;
	uint32_t length = 128;

	switch (argv[0][3]) {
	case 'r':
		readwhat = ram_read_buf;
		break;
	case 'e':
		readwhat = eeprom_read_buf;
		break;
	case 'f':
		readwhat = flash_read_buf;
		break;
	default:
		return CMD_RET_USAGE;
	}

	/* Address is specified since argc > 1 */
	addr =  eval_arg(argv[1], NULL);

	/* If another parameter, it is the length to display. */
	if (argc > 2)
		length = (uint16_t) eval_arg(argv[2], NULL);

	/* Print the lines. */
	dump_mem(addr, addr, length, readwhat, NULL);

	return CMD_RET_SUCCESS;
}

command_ret_t do_eep_cp(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[])
{
	uint16_t src, dest, count;
	int_fast8_t step;

	(void) cmdtp;
	(void) flag;

	if (argc != 4)
		return CMD_RET_USAGE;

	src   = (size_t) eval_arg(argv[1], NULL);
	dest  = (size_t) eval_arg(argv[2], NULL);
	count = (size_t) eval_arg(argv[3], NULL);

	if (src > E2END) {
		debug("src > EEPROM size: 0x%04x\n", src);
		return CMD_RET_FAILURE;
	}
	if (dest > E2END) {
		debug("dest > EEPROM size: 0x%04x\n", dest);
		return CMD_RET_FAILURE;
	}
	if (count > E2END+1) {
		debug("count > EEPROM size: 0x%04x\n", count);
		return CMD_RET_FAILURE;
	}
	if (count == 0) {
		debug("Zero length?\n");
		return CMD_RET_FAILURE;
	}

	if (dest > src) {
		src += count - 1;
		dest += count - 1;
		step = -1;
	} else
		step = 1;

	while (count-- > 0) {
		uint8_t data;
		data = eeprom_read_byte((uint8_t *) src);
		eeprom_write_byte((uint8_t *) dest, data);
		src += step;
		dest += step;

	}
	return CMD_RET_SUCCESS;
}


/* Modify memory.
 *
 * Syntax:
 *	!mm {addr}
 *	!nm {addr}
 */

 static uint8_t	*mm_last_addr;

static command_ret_t
mod_mem_avr(cmd_tbl_t *cmdtp, int incrflag, uint_fast8_t flag, int argc, char * const argv[])
{
	uint8_t *addr;
	int nbytes;

	(void) cmdtp;

	if (argc != 2)
		return CMD_RET_USAGE;

	/* We use the last specified parameters, unless new ones are
	 * entered.
	 */
	addr = mm_last_addr;

	if ((flag & CMD_FLAG_REPEAT) == 0) {
		/* New command specified.
		 */

		/* Address is specified since argc > 1
		*/
		addr = (uint8_t *) (size_t) eval_arg(argv[1], NULL);
	}

	/* Print the address, followed by value.  Then accept input for
	 * the next value.  A non-converted value exits.
	 */
	do {
		uint8_t data = *addr;
		printf_P(PSTR("%04x: %02x"), addr, data);

		nbytes = cli_readline(PSTR(" ? "), 0);
		if (nbytes == 0 || (nbytes == 1 && console_buffer[0] == '-')) {
			/* <CR> pressed as only input, don't modify current
			 * location and move to next. "-" pressed will go back.
			 */
			if (incrflag)
				addr += nbytes ? -1 : 1;
			nbytes = 1;

		} else {
			char *endp;
			data = eval_arg(console_buffer, &endp);
			nbytes = endp - console_buffer;
			if (nbytes) {
				*addr = data;
				if (incrflag)
					addr++;
			}
		}
	} while (nbytes > 0);

	mm_last_addr = addr;
	return CMD_RET_SUCCESS;
}


command_ret_t do_mem_mm_avr(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[])
{
	return mod_mem_avr (cmdtp, 1, flag, argc, argv);
}
command_ret_t do_mem_nm_avr(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[])
{
	return mod_mem_avr (cmdtp, 0, flag, argc, argv);
}

/*------------------------------------------------------------------------------*/

struct __freelist {
	size_t sz;
	struct __freelist *nx;
};

extern char *__brkval;				/* first location not yet allocated */
extern struct __freelist *__flp;	/* freelist pointer (head of freelist) */

#define STACK_POINTER() ((char *)AVR_STACK_POINTER_REG)

size_t get_freemem(void)
{
	return (size_t) STACK_POINTER() - __malloc_margin - (size_t) __brkval;
}

void
printfreelist(const char * title)
{
	struct __freelist *fp1;
	int i;
	unsigned int freesum = 0;

/* TODO: printf_P */

	if (!__flp) {
		printf("%s no free list\n", title ? title : "");
	} else {
		printf("Free list: %s\n", title ? title : "");
		for (i = 0, fp1 = __flp; fp1; i++, fp1 = fp1->nx) {
			printf("    entry %d @ %04x: size %4u, next ",
			       i, (size_t)fp1, fp1->sz);
			if (fp1->nx)
				printf("%04x\n", (size_t)fp1->nx);
			else
				printf("NULL\n");
			freesum += fp1->sz;
		}
	}

	freesum += get_freemem();

	printf("SP: %04x, __brkval: %04x, Total free: %04u\n",
		(size_t) STACK_POINTER(), (size_t) __brkval, freesum);
}

command_ret_t do_pr_free_avr(cmd_tbl_t *cmdtp UNUSED, uint_fast8_t flag UNUSED, int argc UNUSED, char * const argv[] UNUSED)
{
	printfreelist(NULL);

	return CMD_RET_SUCCESS;
}

void dump_heap(void)
{
	//extern unsigned int __brkval;

	dump_ram((uint8_t *)__malloc_heap_start, (size_t) __malloc_heap_start,	__brkval - __malloc_heap_start,
					"=== Heap:");
}

command_ret_t do_pr_heap_avr(cmd_tbl_t *cmdtp UNUSED, uint_fast8_t flag UNUSED, int argc UNUSED, char * const argv[] UNUSED)
{
	dump_heap();

	return CMD_RET_SUCCESS;
}

#endif /* DEBUG */