cmd/log.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2017 Google, Inc
   4  * Written by Simon Glass <sjg@chromium.org>
   5  */
   6
   7 #include <common.h>
   8 #include <command.h>
   9 #include <dm.h>
  10 #include <log.h>
  11
  12 static char log_fmt_chars[LOGF_COUNT] = "clFLfm";
  13
  14 static enum log_level_t parse_log_level(char *const arg)
  15 {
  16         enum log_level_t ret;
  17         ulong level;
  18
  19         if (!strict_strtoul(arg, 10, &level)) {
  20                 if (level > _LOG_MAX_LEVEL) {
  21                         printf("Only log levels <= %d are supported\n",
  22                                _LOG_MAX_LEVEL);
  23                         return LOGL_NONE;
  24                 }
  25                 return level;
  26         }
  27
  28         ret = log_get_level_by_name(arg);
  29         if (ret == LOGL_NONE)
  30                 printf("Unknown log level \"%s\"\n", arg);
  31         return ret;
  32 }
  33
  34 static int do_log_level(struct cmd_tbl *cmdtp, int flag, int argc,
  35                         char *const argv[])
  36 {
  37         if (argc > 1) {
  38                 enum log_level_t log_level = parse_log_level(argv[1]);
  39
  40                 if (log_level == LOGL_NONE)
  41                         return CMD_RET_FAILURE;
  42                 gd->default_log_level = log_level;
  43         } else {
  44                 printf("Default log level: %d\n", gd->default_log_level);
  45         }
  46
  47         return CMD_RET_SUCCESS;
  48 }
  49
  50 static int do_log_categories(struct cmd_tbl *cmdtp, int flag, int argc,
  51                              char *const argv[])
  52 {
  53         enum log_category_t cat;
  54         const char *name;
  55
  56         for (cat = LOGC_FIRST; cat < LOGC_COUNT; cat++) {
  57                 name = log_get_cat_name(cat);
  58                 /*
  59                  * Invalid category names (e.g. <invalid> or <missing>) begin
  60                  * with '<'.
  61                  */
  62                 if (name[0] == '<')
  63                         continue;
  64                 printf("%s\n", name);
  65         }
  66
  67         return CMD_RET_SUCCESS;
  68 }
  69
  70 static int do_log_drivers(struct cmd_tbl *cmdtp, int flag, int argc,
  71                           char *const argv[])
  72 {
  73         struct log_device *ldev;
  74
  75         list_for_each_entry(ldev, &gd->log_head, sibling_node)
  76                 printf("%s\n", ldev->drv->name);
  77
  78         return CMD_RET_SUCCESS;
  79 }
  80
  81 static int do_log_format(struct cmd_tbl *cmdtp, int flag, int argc,
  82                          char *const argv[])
  83 {
  84         int i;
  85
  86         if (argc > 1) {
  87                 const char *str = argv[1];
  88
  89                 if (!strcmp(str, "default")) {
  90                         gd->log_fmt = log_get_default_format();
  91                 } else if (!strcmp(str, "all")) {
  92                         gd->log_fmt = LOGF_ALL;
  93                 } else {
  94                         gd->log_fmt = 0;
  95                         for (; *str; str++) {
  96                                 char *ptr = strchr(log_fmt_chars, *str);
  97
  98                                 if (!ptr) {
  99                                         printf("Invalid log char '%c'\n", *str);
 100                                         return CMD_RET_FAILURE;
 101                                 }
 102                                 gd->log_fmt |= 1 << (ptr - log_fmt_chars);
 103                         }
 104                 }
 105         } else {
 106                 printf("Log format: ");
 107                 for (i = 0; i < LOGF_COUNT; i++) {
 108                         if (gd->log_fmt & (1 << i))
 109                                 printf("%c", log_fmt_chars[i]);
 110                 }
 111                 printf("\n");
 112         }
 113
 114         return 0;
 115 }
 116
 117 static int do_log_rec(struct cmd_tbl *cmdtp, int flag, int argc,
 118                       char *const argv[])
 119 {
 120         enum log_category_t cat;
 121         enum log_level_t level;
 122         const char *file;
 123         uint line;
 124         const char *func;
 125         const char *msg;
 126         char *end;
 127
 128         if (argc < 7)
 129                 return CMD_RET_USAGE;
 130         cat = log_get_cat_by_name(argv[1]);
 131         level = simple_strtoul(argv[2], &end, 10);
 132         if (end == argv[2]) {
 133                 level = log_get_level_by_name(argv[2]);
 134
 135                 if (level == LOGL_NONE) {
 136                         printf("Invalid log level '%s'\n", argv[2]);
 137                         return CMD_RET_USAGE;
 138                 }
 139         }
 140         if (level >= LOGL_MAX) {
 141                 printf("Invalid log level %u\n", level);
 142                 return CMD_RET_USAGE;
 143         }
 144         file = argv[3];
 145         line = simple_strtoul(argv[4], NULL, 10);
 146         func = argv[5];
 147         msg = argv[6];
 148         if (_log(cat, level, file, line, func, "%s\n", msg))
 149                 return CMD_RET_FAILURE;
 150
 151         return 0;
 152 }
 153
 154 #ifdef CONFIG_SYS_LONGHELP
 155 static char log_help_text[] =
 156         "level - get/set log level\n"
 157         "categories - list log categories\n"
 158         "drivers - list log drivers\n"
 159         "log format <fmt> - set log output format. <fmt> is a string where\n"
 160         "\teach letter indicates something that should be displayed:\n"
 161         "\tc=category, l=level, F=file, L=line number, f=function, m=msg\n"
 162         "\tor 'default', or 'all' for all\n"
 163         "log rec <category> <level> <file> <line> <func> <message> - "
 164                 "output a log record"
 165         ;
 166 #endif
 167
 168 U_BOOT_CMD_WITH_SUBCMDS(log, "log system", log_help_text,
 169         U_BOOT_SUBCMD_MKENT(level, 2, 1, do_log_level),
 170         U_BOOT_SUBCMD_MKENT(categories, 1, 1, do_log_categories),
 171         U_BOOT_SUBCMD_MKENT(drivers, 1, 1, do_log_drivers),
 172         U_BOOT_SUBCMD_MKENT(format, 2, 1, do_log_format),
 173         U_BOOT_SUBCMD_MKENT(rec, 7, 1, do_log_rec),
 174 );