common/cmd_log.c

   1 /*
   2  * (C) Copyright 2002-2007
   3  * Detlev Zundel, DENX Software Engineering, dzu@denx.de.
   4  *
   5  * Code used from linux/kernel/printk.c
   6  * Copyright (C) 1991, 1992  Linus Torvalds
   7  *
   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
  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.
  37  */
  38
  39 /*
  40  * Logbuffer handling routines
  41  */
  42
  43 #include <common.h>
  44 #include <command.h>
  45 #include <devices.h>
  46 #include <post.h>
  47 #include <logbuff.h>
  48
  49 DECLARE_GLOBAL_DATA_PTR;
  50
  51 #if defined(CONFIG_LOGBUFFER)
  52
  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
  60 /* This combination will not print messages with the default loglevel */
  61 static unsigned console_loglevel = 3;
  62 static unsigned default_message_loglevel = 4;
  63 static unsigned log_version = 1;
  64 static logbuff_t *log;
  65
  66 void logbuff_init_ptrs (void)
  67 {
  68         unsigned long tag, post_word;
  69         char *s;
  70
  71         log = (logbuff_t *)(gd->bd->bi_memsize-LOGBUFF_LEN) - 1;
  72
  73         /* Set up log version */
  74         if ((s = getenv ("logversion")) != NULL)
  75                 log_version = (int)simple_strtoul (s, NULL, 10);
  76
  77         if (log_version == 2)
  78                 tag = log->v2.tag;
  79         else
  80                 tag = log->v1.tag;
  81         post_word = post_word_load();
  82 #ifdef CONFIG_POST
  83         /* The post routines have setup the word so we can simply test it */
  84         if (tag != LOGBUFF_MAGIC || (post_word & POST_COLDBOOT)) {
  85                 logbuff_reset ();
  86         }
  87 #else
  88         /* No post routines, so we do our own checking                    */
  89         if (tag != LOGBUFF_MAGIC || post_word != LOGBUFF_MAGIC) {
  90                 logbuff_reset ();
  91                 post_word_store (LOGBUFF_MAGIC);
  92         }
  93 #endif
  94         if (log_version == 2 && (long)log->v2.start > (long)log->v2.con)
  95                 log->v2.start = log->v2.con;
  96
  97         /* Initialize default loglevel if present */
  98         if ((s = getenv ("loglevel")) != NULL)
  99                 console_loglevel = (int)simple_strtoul (s, NULL, 10);
 100
 101         gd->post_log_word |= LOGBUFF_INITIALIZED;
 102 }
 103
 104 void logbuff_reset (void)
 105 {
 106         memset (log, 0, sizeof (logbuff_t));
 107         if (log_version == 2)
 108                 log->v2.tag = LOGBUFF_MAGIC;
 109         else
 110                 log->v1.tag = LOGBUFF_MAGIC;
 111 }
 112
 113 int drv_logbuff_init (void)
 114 {
 115         device_t logdev;
 116         int rc;
 117
 118         /* Device initialization */
 119         memset (&logdev, 0, sizeof (logdev));
 120
 121         strcpy (logdev.name, "logbuff");
 122         logdev.ext   = 0;                       /* No extensions */
 123         logdev.flags = DEV_FLAGS_OUTPUT;        /* Output only */
 124         logdev.putc  = logbuff_putc;            /* 'putc' function */
 125         logdev.puts  = logbuff_puts;            /* 'puts' function */
 126
 127         rc = device_register (&logdev);
 128
 129         return (rc == 0) ? 1 : rc;
 130 }
 131
 132 static void logbuff_putc (const char c)
 133 {
 134         char buf[2];
 135         buf[0] = c;
 136         buf[1] = '\0';
 137         logbuff_printk (buf);
 138 }
 139
 140 static void logbuff_puts (const char *s)
 141 {
 142         logbuff_printk (s);
 143 }
 144
 145 void logbuff_log(char *msg)
 146 {
 147         if ((gd->post_log_word & LOGBUFF_INITIALIZED)) {
 148                 logbuff_printk (msg);
 149         } else {
 150                 /* Can happen only for pre-relocated errors as logging */
 151                 /* at that stage should be disabled                    */
 152                 puts (msg);
 153         }
 154 }
 155
 156 /*
 157  * Subroutine:  do_log
 158  *
 159  * Description: Handler for 'log' command..
 160  *
 161  * Inputs:      argv[1] contains the subcommand
 162  *
 163  * Return:      None
 164  *
 165  */
 166 int do_log (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
 167 {
 168         char *s;
 169         unsigned long i, start, size;
 170
 171         if (strcmp(argv[1],"append") == 0) {
 172                 /* Log concatenation of all arguments separated by spaces */
 173                 for (i=2; i<argc; i++) {
 174                         logbuff_printk (argv[i]);
 175                         logbuff_putc ((i<argc-1) ? ' ' : '\n');
 176                 }
 177                 return 0;
 178         }
 179
 180         switch (argc) {
 181
 182         case 2:
 183                 if (strcmp(argv[1],"show") == 0) {
 184                         if (log_version == 2) {
 185                                 start = log->v2.start;
 186                                 size = log->v2.end - log->v2.start;
 187                         }
 188                         else {
 189                                 start = log->v1.start;
 190                                 size = log->v1.size;
 191                         }
 192                         for (i=0; i < (size&LOGBUFF_MASK); i++) {
 193                                 s = (char *)log->buf+((start+i)&LOGBUFF_MASK);
 194                                 putc (*s);
 195                         }
 196                         return 0;
 197                 } else if (strcmp(argv[1],"reset") == 0) {
 198                         logbuff_reset ();
 199                         return 0;
 200                 } else if (strcmp(argv[1],"info") == 0) {
 201                         printf ("Logbuffer   at  %08lx\n", (unsigned long)log->buf);
 202                         if (log_version == 2) {
 203                                 printf ("log_start    =  %08lx\n", log->v2.start);
 204                                 printf ("log_end      =  %08lx\n", log->v2.end);
 205                                 printf ("logged_chars =  %08lx\n", log->v2.chars);
 206                         }
 207                         else {
 208                                 printf ("log_start    =  %08lx\n", log->v1.start);
 209                                 printf ("log_size     =  %08lx\n", log->v1.size);
 210                                 printf ("logged_chars =  %08lx\n", log->v1.chars);
 211                         }
 212                         return 0;
 213                 }
 214                 printf ("Usage:\n%s\n", cmdtp->usage);
 215                 return 1;
 216
 217         default:
 218                 printf ("Usage:\n%s\n", cmdtp->usage);
 219                 return 1;
 220         }
 221 }
 222
 223 U_BOOT_CMD(
 224         log,     255,   1,      do_log,
 225         "log     - manipulate logbuffer\n",
 226         "info   - show pointer details\n"
 227         "log reset  - clear contents\n"
 228         "log show   - show contents\n"
 229         "log append <msg> - append <msg> to the logbuffer\n"
 230 );
 231
 232 static int logbuff_printk(const char *line)
 233 {
 234         int i;
 235         char *msg, *p, *buf_end;
 236         int line_feed;
 237         static signed char msg_level = -1;
 238
 239         strcpy (buf + 3, line);
 240         i = strlen (line);
 241         buf_end = buf + 3 + i;
 242         for (p = buf + 3; p < buf_end; p++) {
 243                 msg = p;
 244                 if (msg_level < 0) {
 245                         if (
 246                                 p[0] != '<' ||
 247                                 p[1] < '0' ||
 248                                 p[1] > '7' ||
 249                                 p[2] != '>'
 250                         ) {
 251                                 p -= 3;
 252                                 p[0] = '<';
 253                                 p[1] = default_message_loglevel + '0';
 254                                 p[2] = '>';
 255                         } else
 256                                 msg += 3;
 257                         msg_level = p[1] - '0';
 258                 }
 259                 line_feed = 0;
 260                 for (; p < buf_end; p++) {
 261                         if (log_version == 2) {
 262                                 log->buf[log->v2.end & LOGBUFF_MASK] = *p;
 263                                 log->v2.end++;
 264                                 if (log->v2.end - log->v2.start > LOGBUFF_LEN)
 265                                         log->v2.start++;
 266                                 log->v2.chars++;
 267                         }
 268                         else {
 269                                 log->buf[(log->v1.start + log->v1.size) &
 270                                          LOGBUFF_MASK] = *p;
 271                                 if (log->v1.size < LOGBUFF_LEN)
 272                                         log->v1.size++;
 273                                 else
 274                                         log->v1.start++;
 275                                 log->v1.chars++;
 276                         }
 277                         if (*p == '\n') {
 278                                 line_feed = 1;
 279                                 break;
 280                         }
 281                 }
 282                 if (msg_level < console_loglevel) {
 283                         printf("%s", msg);
 284                 }
 285                 if (line_feed)
 286                         msg_level = -1;
 287         }
 288         return i;
 289 }
 290
 291 #endif /* (CONFIG_LOGBUFFER) */