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

/*
 * (C) Copyright 2002
 * 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;

#if defined(CONFIG_LOGBUFFER)

/* 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 char *log_buf = NULL;
static unsigned long *ext_log_size;
static unsigned long *ext_log_start;
static unsigned long *ext_logged_chars;
#define log_size (*ext_log_size)
#define log_start (*ext_log_start)
#define logged_chars (*ext_logged_chars)

/* Forced by code, eh! */
#define LOGBUFF_MAGIC 0xc0de4ced

/* The mapping used here has to be the same as in setup_ext_logbuff ()
   in linux/kernel/printk */
void logbuff_init_ptrs (void)
{
	unsigned long *ext_tag;
	unsigned long post_word;
	char *s;

	log_buf = (unsigned char *)(gd->bd->bi_memsize-LOGBUFF_LEN);
	ext_tag = (unsigned long *)(log_buf)-4;
 	ext_log_start = (unsigned long *)(log_buf)-3;
	ext_log_size = (unsigned long *)(log_buf)-2;
	ext_logged_chars = (unsigned long *)(log_buf)-1;
	post_word = post_word_load();
#ifdef CONFIG_POST
	/* The post routines have setup the word so we can simply test it */
 	if (post_word_load () & POST_COLDBOOT) {
 		logged_chars = log_size = log_start = 0;
		*ext_tag = LOGBUFF_MAGIC;
 	}
#else
	/* No post routines, so we do our own checking                    */
 	if (post_word != LOGBUFF_MAGIC) {
 		logged_chars = log_size = log_start = 0;
		post_word_store (LOGBUFF_MAGIC);
		*ext_tag = LOGBUFF_MAGIC;
 	}
#endif
	/* Initialize default loglevel if present */
	if ((s = getenv ("loglevel")) != NULL)
		console_loglevel = (int)simple_strtoul (s, NULL, 10);

	gd->post_log_word |= LOGBUFF_INITIALIZED;
}

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;

	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) {
			for (i=0; i < (log_size&LOGBUFF_MASK); i++) {
				s = (char *)log_buf+((log_start+i)&LOGBUFF_MASK);
				putc (*s);
			}
			return 0;
		} else if (strcmp(argv[1],"reset") == 0) {
			log_start    = 0;
			log_size     = 0;
			logged_chars = 0;
			return 0;
		} else if (strcmp(argv[1],"info") == 0) {
			printf ("Logbuffer   at  %08lx\n", (unsigned long)log_buf);
			printf ("log_start    =  %08lx\n", log_start);
			printf ("log_size     =  %08lx\n", log_size);
			printf ("logged_chars =  %08lx\n", logged_chars);
			return 0;
		}
		printf ("Usage:\n%s\n", cmdtp->usage);
		return 1;

	default:
		printf ("Usage:\n%s\n", cmdtp->usage);
		return 1;
	}
}
#if defined(CONFIG_LOGBUFFER)
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"
);
#endif	/* CONFIG_LOGBUFFER */
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++) {
			log_buf[(log_start+log_size) & LOGBUFF_MASK] = *p;
			if (log_size < LOGBUFF_LEN)
				log_size++;
			else
				log_start++;

			logged_chars++;
			if (*p == '\n') {
				line_feed = 1;
				break;
			}
		}
		if (msg_level < console_loglevel) {
			printf("%s", msg);
		}
		if (line_feed)
			msg_level = -1;
	}
	return i;
}

#endif /* (CONFIG_LOGBUFFER) */
Commit	Line	Data
56f94be3 WD	1	/*
	2	* (C) Copyright 2002
	3	* Detlev Zundel, DENX Software Engineering, dzu@denx.de.
	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	#if defined(CONFIG_LOGBUFFER)
56f94be3 WD	52
56f94be3 WD	53	/* Local prototypes */
	54	static void logbuff_putc (const char c);
	55	static void logbuff_puts (const char *s);
	56	static int logbuff_printk(const char *line);
	57
	58	static char buf[1024];
	59
228f29ac	60	/* This combination will not print messages with the default loglevel */
56f94be3 WD	61	static unsigned console_loglevel = 3;
56f94be3 WD	62	static unsigned default_message_loglevel = 4;
228f29ac WD	63	static unsigned char *log_buf = NULL;
	64	static unsigned long *ext_log_size;
	65	static unsigned long *ext_log_start;
	66	static unsigned long *ext_logged_chars;
	67	#define log_size (*ext_log_size)
56f94be3 WD	68	#define log_start (*ext_log_start)
	69	#define logged_chars (*ext_logged_chars)
	70
	71	/* Forced by code, eh! */
	72	#define LOGBUFF_MAGIC 0xc0de4ced
	73
228f29ac WD	74	/* The mapping used here has to be the same as in setup_ext_logbuff ()
	75	in linux/kernel/printk */
	76	void logbuff_init_ptrs (void)
	77	{
b37c7e5e	78	unsigned long *ext_tag;
2960b65a	79	unsigned long post_word;
228f29ac WD	80	char *s;
	81
	82	log_buf = (unsigned char *)(gd->bd->bi_memsize-LOGBUFF_LEN);
b37c7e5e WD	83	ext_tag = (unsigned long *)(log_buf)-4;
b37c7e5e WD	84	ext_log_start = (unsigned long *)(log_buf)-3;
228f29ac WD	85	ext_log_size = (unsigned long *)(log_buf)-2;
228f29ac WD	86	ext_logged_chars = (unsigned long *)(log_buf)-1;
2960b65a	87	post_word = post_word_load();
d1cbe85b WD	88	#ifdef CONFIG_POST
d1cbe85b WD	89	/* The post routines have setup the word so we can simply test it */
27b207fd	90	if (post_word_load () & POST_COLDBOOT) {
228f29ac	91	logged_chars = log_size = log_start = 0;
b37c7e5e	92	*ext_tag = LOGBUFF_MAGIC;
228f29ac	93	}
d1cbe85b WD	94	#else
d1cbe85b WD	95	/* No post routines, so we do our own checking */
667122af	96	if (post_word != LOGBUFF_MAGIC) {
d1cbe85b WD	97	logged_chars = log_size = log_start = 0;
d1cbe85b WD	98	post_word_store (LOGBUFF_MAGIC);
b37c7e5e	99	*ext_tag = LOGBUFF_MAGIC;
d1cbe85b WD	100	}
d1cbe85b WD	101	#endif
228f29ac WD	102	/* Initialize default loglevel if present */
	103	if ((s = getenv ("loglevel")) != NULL)
	104	console_loglevel = (int)simple_strtoul (s, NULL, 10);
	105
	106	gd->post_log_word \|= LOGBUFF_INITIALIZED;
	107	}
	108
56f94be3 WD	109	int drv_logbuff_init (void)
	110	{
	111	device_t logdev;
	112	int rc;
	113
	114	/* Device initialization */
	115	memset (&logdev, 0, sizeof (logdev));
	116
	117	strcpy (logdev.name, "logbuff");
	118	logdev.ext = 0; /* No extensions */
	119	logdev.flags = DEV_FLAGS_OUTPUT; /* Output only */
	120	logdev.putc = logbuff_putc; /* 'putc' function */
	121	logdev.puts = logbuff_puts; /* 'puts' function */
	122
	123	rc = device_register (&logdev);
	124
	125	return (rc == 0) ? 1 : rc;
	126	}
	127
	128	static void logbuff_putc (const char c)
	129	{
	130	char buf[2];
228f29ac WD	131	buf[0] = c;
	132	buf[1] = '\0';
	133	logbuff_printk (buf);
56f94be3 WD	134	}
	135
	136	static void logbuff_puts (const char *s)
	137	{
228f29ac	138	logbuff_printk (s);
56f94be3 WD	139	}
	140
	141	void logbuff_log(char *msg)
	142	{
228f29ac WD	143	if ((gd->post_log_word & LOGBUFF_INITIALIZED)) {
228f29ac WD	144	logbuff_printk (msg);
56f94be3	145	} else {
228f29ac WD	146	/* Can happen only for pre-relocated errors as logging */
	147	/* at that stage should be disabled */
	148	puts (msg);
56f94be3 WD	149	}
	150	}
	151
	152	/*
	153	* Subroutine: do_log
	154	*
	155	* Description: Handler for 'log' command..
	156	*
	157	* Inputs: argv[1] contains the subcommand
	158	*
	159	* Return: None
	160	*
	161	*/
	162	int do_log (cmd_tbl_t cmdtp, int flag, int argc, char argv[])
	163	{
	164	char *s;
	165	unsigned long i;
	166
228f29ac WD	167	if (strcmp(argv[1],"append") == 0) {
	168	/* Log concatenation of all arguments separated by spaces */
	169	for (i=2; i<argc; i++) {
b37c7e5e WD	170	logbuff_printk (argv[i]);
b37c7e5e WD	171	logbuff_putc ((i<argc-1) ? ' ' : '\n');
228f29ac WD	172	}
228f29ac WD	173	return 0;
56f94be3 WD	174	}
	175
	176	switch (argc) {
	177
	178	case 2:
	179	if (strcmp(argv[1],"show") == 0) {
228f29ac	180	for (i=0; i < (log_size&LOGBUFF_MASK); i++) {
77ddac94	181	s = (char *)log_buf+((log_start+i)&LOGBUFF_MASK);
228f29ac	182	putc (*s);
56f94be3 WD	183	}
	184	return 0;
	185	} else if (strcmp(argv[1],"reset") == 0) {
228f29ac WD	186	log_start = 0;
	187	log_size = 0;
	188	logged_chars = 0;
56f94be3	189	return 0;
228f29ac WD	190	} else if (strcmp(argv[1],"info") == 0) {
	191	printf ("Logbuffer at %08lx\n", (unsigned long)log_buf);
	192	printf ("log_start = %08lx\n", log_start);
	193	printf ("log_size = %08lx\n", log_size);
	194	printf ("logged_chars = %08lx\n", logged_chars);
56f94be3	195	return 0;
56f94be3 WD	196	}
	197	printf ("Usage:\n%s\n", cmdtp->usage);
	198	return 1;
	199
	200	default:
	201	printf ("Usage:\n%s\n", cmdtp->usage);
	202	return 1;
	203	}
	204	}
8bde7f77	205	#if defined(CONFIG_LOGBUFFER)
0d498393 WD	206	U_BOOT_CMD(
0d498393 WD	207	log, 255, 1, do_log,
8bde7f77	208	"log - manipulate logbuffer\n",
b37c7e5e	209	"info - show pointer details\n"
8bde7f77 WD	210	"log reset - clear contents\n"
	211	"log show - show contents\n"
	212	"log append <msg> - append <msg> to the logbuffer\n"
	213	);
	214	#endif /* CONFIG_LOGBUFFER */
56f94be3 WD	215	static int logbuff_printk(const char *line)
	216	{
	217	int i;
	218	char msg, p, *buf_end;
	219	int line_feed;
	220	static signed char msg_level = -1;
	221
228f29ac WD	222	strcpy (buf + 3, line);
228f29ac WD	223	i = strlen (line);
56f94be3 WD	224	buf_end = buf + 3 + i;
	225	for (p = buf + 3; p < buf_end; p++) {
	226	msg = p;
	227	if (msg_level < 0) {
	228	if (
	229	p[0] != '<' \|\|
	230	p[1] < '0' \|\|
	231	p[1] > '7' \|\|
	232	p[2] != '>'
	233	) {
	234	p -= 3;
	235	p[0] = '<';
	236	p[1] = default_message_loglevel + '0';
	237	p[2] = '>';
	238	} else
	239	msg += 3;
	240	msg_level = p[1] - '0';
	241	}
	242	line_feed = 0;
	243	for (; p < buf_end; p++) {
228f29ac WD	244	log_buf[(log_start+log_size) & LOGBUFF_MASK] = *p;
228f29ac WD	245	if (log_size < LOGBUFF_LEN)
56f94be3 WD	246	log_size++;
	247	else
	248	log_start++;
	249
	250	logged_chars++;
	251	if (*p == '\n') {
	252	line_feed = 1;
	253	break;
	254	}
	255	}
	256	if (msg_level < console_loglevel) {
	257	printf("%s", msg);
	258	}
	259	if (line_feed)
	260	msg_level = -1;
	261	}
	262	return i;
	263	}
	264
	265	#endif /* (CONFIG_LOGBUFFER) */