[people/ms/u-boot.git] / common / cmd_log.c

/*
 * (C) Copyright 2002-2007
 * Detlev Zundel, DENX Software Engineering, dzu@denx.de.
 *
 * Code used from linux/kernel/printk.c
 * Copyright (C) 1991, 1992  Linus Torvalds
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 * Comments:
 *
 * After relocating the code, the environment variable "loglevel" is
 * copied to console_loglevel.  The functionality is similar to the
 * handling in the Linux kernel, i.e. messages logged with a priority
 * less than console_loglevel are also output to stdout.
 *
 * If you want messages with the default level (e.g. POST messages) to
 * appear on stdout also, make sure the environment variable
 * "loglevel" is set at boot time to a number higher than
 * default_message_loglevel below.
 */

/*
 * Logbuffer handling routines
 */

#include <common.h>
#include <command.h>
#include <devices.h>
#include <post.h>
#include <logbuff.h>

DECLARE_GLOBAL_DATA_PTR;

/* Local prototypes */
static void logbuff_putc (const char c);
static void logbuff_puts (const char *s);
static int logbuff_printk(const char *line);

static char buf[1024];

/* This combination will not print messages with the default loglevel */
static unsigned console_loglevel = 3;
static unsigned default_message_loglevel = 4;
static unsigned log_version = 1;
static logbuff_t *log;

void logbuff_init_ptrs (void)
{
	unsigned long tag, post_word;
	char *s;

	log = (logbuff_t *)(gd->bd->bi_memsize-LOGBUFF_LEN) - 1;

	/* Set up log version */
	if ((s = getenv ("logversion")) != NULL)
		log_version = (int)simple_strtoul (s, NULL, 10);

	if (log_version == 2)
		tag = log->v2.tag;
	else
		tag = log->v1.tag;
	post_word = post_word_load();
#ifdef CONFIG_POST
	/* The post routines have setup the word so we can simply test it */
	if (tag != LOGBUFF_MAGIC || (post_word & POST_COLDBOOT)) {
		logbuff_reset ();
	}
#else
	/* No post routines, so we do our own checking                    */
	if (tag != LOGBUFF_MAGIC || post_word != LOGBUFF_MAGIC) {
		logbuff_reset ();
		post_word_store (LOGBUFF_MAGIC);
	}
#endif
	if (log_version == 2 && (long)log->v2.start > (long)log->v2.con)
		log->v2.start = log->v2.con;

	/* Initialize default loglevel if present */
	if ((s = getenv ("loglevel")) != NULL)
		console_loglevel = (int)simple_strtoul (s, NULL, 10);

	gd->post_log_word |= LOGBUFF_INITIALIZED;
}

void logbuff_reset (void)
{
	memset (log, 0, sizeof (logbuff_t));
	if (log_version == 2)
		log->v2.tag = LOGBUFF_MAGIC;
	else
		log->v1.tag = LOGBUFF_MAGIC;
}

int drv_logbuff_init (void)
{
	device_t logdev;
	int rc;

	/* Device initialization */
	memset (&logdev, 0, sizeof (logdev));

	strcpy (logdev.name, "logbuff");
	logdev.ext   = 0;			/* No extensions */
	logdev.flags = DEV_FLAGS_OUTPUT;	/* Output only */
	logdev.putc  = logbuff_putc;		/* 'putc' function */
	logdev.puts  = logbuff_puts;		/* 'puts' function */

	rc = device_register (&logdev);

	return (rc == 0) ? 1 : rc;
}

static void logbuff_putc (const char c)
{
	char buf[2];
	buf[0] = c;
	buf[1] = '\0';
	logbuff_printk (buf);
}

static void logbuff_puts (const char *s)
{
	logbuff_printk (s);
}

void logbuff_log(char *msg)
{
	if ((gd->post_log_word & LOGBUFF_INITIALIZED)) {
		logbuff_printk (msg);
	} else {
		/* Can happen only for pre-relocated errors as logging */
		/* at that stage should be disabled                    */
		puts (msg);
	}
}

/*
 * Subroutine:  do_log
 *
 * Description: Handler for 'log' command..
 *
 * Inputs:	argv[1] contains the subcommand
 *
 * Return:      None
 *
 */
int do_log (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
{
	char *s;
	unsigned long i, start, size;

	if (strcmp(argv[1],"append") == 0) {
		/* Log concatenation of all arguments separated by spaces */
		for (i=2; i<argc; i++) {
			logbuff_printk (argv[i]);
			logbuff_putc ((i<argc-1) ? ' ' : '\n');
		}
		return 0;
	}

	switch (argc) {

	case 2:
		if (strcmp(argv[1],"show") == 0) {
			if (log_version == 2) {
				start = log->v2.start;
				size = log->v2.end - log->v2.start;
			}
			else {
				start = log->v1.start;
				size = log->v1.size;
			}
			for (i=0; i < (size&LOGBUFF_MASK); i++) {
				s = (char *)log->buf+((start+i)&LOGBUFF_MASK);
				putc (*s);
			}
			return 0;
		} else if (strcmp(argv[1],"reset") == 0) {
			logbuff_reset ();
			return 0;
		} else if (strcmp(argv[1],"info") == 0) {
			printf ("Logbuffer   at  %08lx\n", (unsigned long)log->buf);
			if (log_version == 2) {
				printf ("log_start    =  %08lx\n", log->v2.start);
				printf ("log_end      =  %08lx\n", log->v2.end);
				printf ("logged_chars =  %08lx\n", log->v2.chars);
			}
			else {
				printf ("log_start    =  %08lx\n", log->v1.start);
				printf ("log_size     =  %08lx\n", log->v1.size);
				printf ("logged_chars =  %08lx\n", log->v1.chars);
			}
			return 0;
		}
		printf ("Usage:\n%s\n", cmdtp->usage);
		return 1;

	default:
		printf ("Usage:\n%s\n", cmdtp->usage);
		return 1;
	}
}

U_BOOT_CMD(
	log,     255,	1,	do_log,
	"log     - manipulate logbuffer\n",
	"info   - show pointer details\n"
	"log reset  - clear contents\n"
	"log show   - show contents\n"
	"log append <msg> - append <msg> to the logbuffer\n"
);

static int logbuff_printk(const char *line)
{
	int i;
	char *msg, *p, *buf_end;
	int line_feed;
	static signed char msg_level = -1;

	strcpy (buf + 3, line);
	i = strlen (line);
	buf_end = buf + 3 + i;
	for (p = buf + 3; p < buf_end; p++) {
		msg = p;
		if (msg_level < 0) {
			if (
				p[0] != '<' ||
				p[1] < '0' ||
				p[1] > '7' ||
				p[2] != '>'
			) {
				p -= 3;
				p[0] = '<';
				p[1] = default_message_loglevel + '0';
				p[2] = '>';
			} else
				msg += 3;
			msg_level = p[1] - '0';
		}
		line_feed = 0;
		for (; p < buf_end; p++) {
			if (log_version == 2) {
				log->buf[log->v2.end & LOGBUFF_MASK] = *p;
				log->v2.end++;
				if (log->v2.end - log->v2.start > LOGBUFF_LEN)
					log->v2.start++;
				log->v2.chars++;
			}
			else {
				log->buf[(log->v1.start + log->v1.size) &
					 LOGBUFF_MASK] = *p;
				if (log->v1.size < LOGBUFF_LEN)
					log->v1.size++;
				else
					log->v1.start++;
				log->v1.chars++;
			}
			if (*p == '\n') {
				line_feed = 1;
				break;
			}
		}
		if (msg_level < console_loglevel) {
			printf("%s", msg);
		}
		if (line_feed)
			msg_level = -1;
	}
	return i;
}
Commit	Line	Data
56f94be3	1	/*
2dc64451	2	* (C) Copyright 2002-2007
56f94be3 WD	3	* Detlev Zundel, DENX Software Engineering, dzu@denx.de.
56f94be3 WD	4	*
228f29ac WD	5	* Code used from linux/kernel/printk.c
	6	* Copyright (C) 1991, 1992 Linus Torvalds
	7	*
56f94be3 WD	8	* See file CREDITS for list of people who contributed to this
	9	* project.
	10	*
	11	* This program is free software; you can redistribute it and/or
	12	* modify it under the terms of the GNU General Public License as
	13	* published by the Free Software Foundation; either version 2 of
	14	* the License, or (at your option) any later version.
	15	*
	16	* This program is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	* GNU General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	24	* MA 02111-1307 USA
228f29ac WD	25	*
	26	* Comments:
	27	*
	28	* After relocating the code, the environment variable "loglevel" is
	29	* copied to console_loglevel. The functionality is similar to the
	30	* handling in the Linux kernel, i.e. messages logged with a priority
	31	* less than console_loglevel are also output to stdout.
	32	*
	33	* If you want messages with the default level (e.g. POST messages) to
	34	* appear on stdout also, make sure the environment variable
	35	* "loglevel" is set at boot time to a number higher than
	36	* default_message_loglevel below.
56f94be3 WD	37	*/
	38
	39	/*
	40	* Logbuffer handling routines
	41	*/
	42
	43	#include <common.h>
	44	#include <command.h>
	45	#include <devices.h>
228f29ac	46	#include <post.h>
56f94be3 WD	47	#include <logbuff.h>
56f94be3 WD	48
d87080b7 WD	49	DECLARE_GLOBAL_DATA_PTR;
d87080b7 WD	50
56f94be3 WD	51	/* Local prototypes */
	52	static void logbuff_putc (const char c);
	53	static void logbuff_puts (const char *s);
	54	static int logbuff_printk(const char *line);
	55
	56	static char buf[1024];
	57
228f29ac	58	/* This combination will not print messages with the default loglevel */
56f94be3 WD	59	static unsigned console_loglevel = 3;
56f94be3 WD	60	static unsigned default_message_loglevel = 4;
2dc64451 IL	61	static unsigned log_version = 1;
2dc64451 IL	62	static logbuff_t *log;
56f94be3	63
228f29ac WD	64	void logbuff_init_ptrs (void)
228f29ac WD	65	{
2dc64451	66	unsigned long tag, post_word;
228f29ac WD	67	char *s;
228f29ac WD	68
2dc64451 IL	69	log = (logbuff_t *)(gd->bd->bi_memsize-LOGBUFF_LEN) - 1;
	70
	71	/* Set up log version */
	72	if ((s = getenv ("logversion")) != NULL)
	73	log_version = (int)simple_strtoul (s, NULL, 10);
	74
	75	if (log_version == 2)
	76	tag = log->v2.tag;
	77	else
	78	tag = log->v1.tag;
2960b65a	79	post_word = post_word_load();
d1cbe85b WD	80	#ifdef CONFIG_POST
d1cbe85b WD	81	/* The post routines have setup the word so we can simply test it */
2dc64451 IL	82	if (tag != LOGBUFF_MAGIC \|\| (post_word & POST_COLDBOOT)) {
2dc64451 IL	83	logbuff_reset ();
1636d1c8	84	}
d1cbe85b WD	85	#else
d1cbe85b WD	86	/* No post routines, so we do our own checking */
2dc64451 IL	87	if (tag != LOGBUFF_MAGIC \|\| post_word != LOGBUFF_MAGIC) {
2dc64451 IL	88	logbuff_reset ();
d1cbe85b	89	post_word_store (LOGBUFF_MAGIC);
1636d1c8	90	}
d1cbe85b	91	#endif
2dc64451 IL	92	if (log_version == 2 && (long)log->v2.start > (long)log->v2.con)
	93	log->v2.start = log->v2.con;
	94
228f29ac WD	95	/* Initialize default loglevel if present */
	96	if ((s = getenv ("loglevel")) != NULL)
	97	console_loglevel = (int)simple_strtoul (s, NULL, 10);
	98
	99	gd->post_log_word \|= LOGBUFF_INITIALIZED;
	100	}
	101
2dc64451 IL	102	void logbuff_reset (void)
	103	{
	104	memset (log, 0, sizeof (logbuff_t));
	105	if (log_version == 2)
	106	log->v2.tag = LOGBUFF_MAGIC;
	107	else
	108	log->v1.tag = LOGBUFF_MAGIC;
	109	}
	110
56f94be3 WD	111	int drv_logbuff_init (void)
	112	{
	113	device_t logdev;
	114	int rc;
	115
	116	/* Device initialization */
	117	memset (&logdev, 0, sizeof (logdev));
	118
	119	strcpy (logdev.name, "logbuff");
	120	logdev.ext = 0; /* No extensions */
	121	logdev.flags = DEV_FLAGS_OUTPUT; /* Output only */
	122	logdev.putc = logbuff_putc; /* 'putc' function */
	123	logdev.puts = logbuff_puts; /* 'puts' function */
	124
	125	rc = device_register (&logdev);
	126
	127	return (rc == 0) ? 1 : rc;
	128	}
	129
	130	static void logbuff_putc (const char c)
	131	{
	132	char buf[2];
228f29ac WD	133	buf[0] = c;
	134	buf[1] = '\0';
	135	logbuff_printk (buf);
56f94be3 WD	136	}
	137
	138	static void logbuff_puts (const char *s)
	139	{
228f29ac	140	logbuff_printk (s);
56f94be3 WD	141	}
	142
	143	void logbuff_log(char *msg)
	144	{
228f29ac WD	145	if ((gd->post_log_word & LOGBUFF_INITIALIZED)) {
228f29ac WD	146	logbuff_printk (msg);
56f94be3	147	} else {
228f29ac WD	148	/* Can happen only for pre-relocated errors as logging */
	149	/* at that stage should be disabled */
	150	puts (msg);
56f94be3 WD	151	}
	152	}
	153
	154	/*
	155	* Subroutine: do_log
	156	*
	157	* Description: Handler for 'log' command..
	158	*
	159	* Inputs: argv[1] contains the subcommand
	160	*
	161	* Return: None
	162	*
	163	*/
	164	int do_log (cmd_tbl_t cmdtp, int flag, int argc, char argv[])
	165	{
	166	char *s;
2dc64451	167	unsigned long i, start, size;
56f94be3	168
228f29ac WD	169	if (strcmp(argv[1],"append") == 0) {
	170	/* Log concatenation of all arguments separated by spaces */
	171	for (i=2; i<argc; i++) {
b37c7e5e WD	172	logbuff_printk (argv[i]);
b37c7e5e WD	173	logbuff_putc ((i<argc-1) ? ' ' : '\n');
228f29ac WD	174	}
228f29ac WD	175	return 0;
56f94be3 WD	176	}
	177
	178	switch (argc) {
	179
	180	case 2:
	181	if (strcmp(argv[1],"show") == 0) {
2dc64451 IL	182	if (log_version == 2) {
	183	start = log->v2.start;
	184	size = log->v2.end - log->v2.start;
	185	}
	186	else {
	187	start = log->v1.start;
	188	size = log->v1.size;
	189	}
	190	for (i=0; i < (size&LOGBUFF_MASK); i++) {
	191	s = (char *)log->buf+((start+i)&LOGBUFF_MASK);
228f29ac	192	putc (*s);
56f94be3 WD	193	}
	194	return 0;
	195	} else if (strcmp(argv[1],"reset") == 0) {
2dc64451	196	logbuff_reset ();
56f94be3	197	return 0;
228f29ac	198	} else if (strcmp(argv[1],"info") == 0) {
2dc64451 IL	199	printf ("Logbuffer at %08lx\n", (unsigned long)log->buf);
	200	if (log_version == 2) {
	201	printf ("log_start = %08lx\n", log->v2.start);
	202	printf ("log_end = %08lx\n", log->v2.end);
	203	printf ("logged_chars = %08lx\n", log->v2.chars);
	204	}
	205	else {
	206	printf ("log_start = %08lx\n", log->v1.start);
	207	printf ("log_size = %08lx\n", log->v1.size);
	208	printf ("logged_chars = %08lx\n", log->v1.chars);
	209	}
56f94be3	210	return 0;
56f94be3 WD	211	}
	212	printf ("Usage:\n%s\n", cmdtp->usage);
	213	return 1;
	214
	215	default:
	216	printf ("Usage:\n%s\n", cmdtp->usage);
	217	return 1;
	218	}
	219	}
2dc64451	220
0d498393 WD	221	U_BOOT_CMD(
0d498393 WD	222	log, 255, 1, do_log,
8bde7f77	223	"log - manipulate logbuffer\n",
b37c7e5e	224	"info - show pointer details\n"
8bde7f77 WD	225	"log reset - clear contents\n"
	226	"log show - show contents\n"
	227	"log append <msg> - append <msg> to the logbuffer\n"
	228	);
2dc64451	229
56f94be3 WD	230	static int logbuff_printk(const char *line)
	231	{
	232	int i;
	233	char msg, p, *buf_end;
	234	int line_feed;
	235	static signed char msg_level = -1;
	236
228f29ac WD	237	strcpy (buf + 3, line);
228f29ac WD	238	i = strlen (line);
56f94be3 WD	239	buf_end = buf + 3 + i;
	240	for (p = buf + 3; p < buf_end; p++) {
	241	msg = p;
	242	if (msg_level < 0) {
	243	if (
	244	p[0] != '<' \|\|
	245	p[1] < '0' \|\|
	246	p[1] > '7' \|\|
	247	p[2] != '>'
	248	) {
	249	p -= 3;
	250	p[0] = '<';
	251	p[1] = default_message_loglevel + '0';
	252	p[2] = '>';
	253	} else
	254	msg += 3;
	255	msg_level = p[1] - '0';
	256	}
	257	line_feed = 0;
	258	for (; p < buf_end; p++) {
2dc64451 IL	259	if (log_version == 2) {
	260	log->buf[log->v2.end & LOGBUFF_MASK] = *p;
	261	log->v2.end++;
	262	if (log->v2.end - log->v2.start > LOGBUFF_LEN)
	263	log->v2.start++;
	264	log->v2.chars++;
	265	}
	266	else {
	267	log->buf[(log->v1.start + log->v1.size) &
	268	LOGBUFF_MASK] = *p;
	269	if (log->v1.size < LOGBUFF_LEN)
	270	log->v1.size++;
	271	else
	272	log->v1.start++;
	273	log->v1.chars++;
	274	}
56f94be3 WD	275	if (*p == '\n') {
	276	line_feed = 1;
	277	break;
	278	}
	279	}
	280	if (msg_level < console_loglevel) {
	281	printf("%s", msg);
	282	}
	283	if (line_feed)
	284	msg_level = -1;
	285	}
	286	return i;
	287	}