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         enum log_level_t log_level;
  38
  39         if (argc > 1) {
  40                 log_level = parse_log_level(argv[1]);
  41
  42                 if (log_level == LOGL_NONE)
  43                         return CMD_RET_FAILURE;
  44                 gd->default_log_level = log_level;
  45         } else {
  46                 for (log_level = LOGL_FIRST; log_level <= _LOG_MAX_LEVEL;
  47                      log_level++)
  48                         printf("%s%s\n", log_get_level_name(log_level),
  49                                log_level == gd->default_log_level ?
  50                                " (default)" : "");
  51         }
  52
  53         return CMD_RET_SUCCESS;
  54 }
  55
  56 static int do_log_categories(struct cmd_tbl *cmdtp, int flag, int argc,
  57                              char *const argv[])
  58 {
  59         enum log_category_t cat;
  60         const char *name;
  61
  62         for (cat = LOGC_FIRST; cat < LOGC_COUNT; cat++) {
  63                 name = log_get_cat_name(cat);
  64                 /*
  65                  * Invalid category names (e.g. <invalid> or <missing>) begin
  66                  * with '<'.
  67                  */
  68                 if (name[0] == '<')
  69                         continue;
  70                 printf("%s\n", name);
  71         }
  72
  73         return CMD_RET_SUCCESS;
  74 }
  75
  76 static int do_log_drivers(struct cmd_tbl *cmdtp, int flag, int argc,
  77                           char *const argv[])
  78 {
  79         struct log_device *ldev;
  80
  81         list_for_each_entry(ldev, &gd->log_head, sibling_node)
  82                 printf("%s\n", ldev->drv->name);
  83
  84         return CMD_RET_SUCCESS;
  85 }
  86
  87 static int do_log_format(struct cmd_tbl *cmdtp, int flag, int argc,
  88                          char *const argv[])
  89 {
  90         int i;
  91
  92         if (argc > 1) {
  93                 const char *str = argv[1];
  94
  95                 if (!strcmp(str, "default")) {
  96                         gd->log_fmt = log_get_default_format();
  97                 } else if (!strcmp(str, "all")) {
  98                         gd->log_fmt = LOGF_ALL;
  99                 } else {
 100                         gd->log_fmt = 0;
 101                         for (; *str; str++) {
 102                                 char *ptr = strchr(log_fmt_chars, *str);
 103
 104                                 if (!ptr) {
 105                                         printf("Invalid log char '%c'\n", *str);
 106                                         return CMD_RET_FAILURE;
 107                                 }
 108                                 gd->log_fmt |= 1 << (ptr - log_fmt_chars);
 109                         }
 110                 }
 111         } else {
 112                 printf("Log format: ");
 113                 for (i = 0; i < LOGF_COUNT; i++) {
 114                         if (gd->log_fmt & (1 << i))
 115                                 printf("%c", log_fmt_chars[i]);
 116                 }
 117                 printf("\n");
 118         }
 119
 120         return 0;
 121 }
 122
 123 static int do_log_rec(struct cmd_tbl *cmdtp, int flag, int argc,
 124                       char *const argv[])
 125 {
 126         enum log_category_t cat;
 127         enum log_level_t level;
 128         const char *file;
 129         uint line;
 130         const char *func;
 131         const char *msg;
 132         char *end;
 133
 134         if (argc < 7)
 135                 return CMD_RET_USAGE;
 136         cat = log_get_cat_by_name(argv[1]);
 137         level = simple_strtoul(argv[2], &end, 10);
 138         if (end == argv[2]) {
 139                 level = log_get_level_by_name(argv[2]);
 140
 141                 if (level == LOGL_NONE) {
 142                         printf("Invalid log level '%s'\n", argv[2]);
 143                         return CMD_RET_USAGE;
 144                 }
 145         }
 146         if (level >= LOGL_MAX) {
 147                 printf("Invalid log level %u\n", level);
 148                 return CMD_RET_USAGE;
 149         }
 150         file = argv[3];
 151         line = simple_strtoul(argv[4], NULL, 10);
 152         func = argv[5];
 153         msg = argv[6];
 154         if (_log(cat, level, file, line, func, "%s\n", msg))
 155                 return CMD_RET_FAILURE;
 156
 157         return 0;
 158 }
 159
 160 #ifdef CONFIG_SYS_LONGHELP
 161 static char log_help_text[] =
 162         "level [<level>] - get/set log level\n"
 163         "categories - list log categories\n"
 164         "drivers - list log drivers\n"
 165         "log format <fmt> - set log output format. <fmt> is a string where\n"
 166         "\teach letter indicates something that should be displayed:\n"
 167         "\tc=category, l=level, F=file, L=line number, f=function, m=msg\n"
 168         "\tor 'default', or 'all' for all\n"
 169         "log rec <category> <level> <file> <line> <func> <message> - "
 170                 "output a log record"
 171         ;
 172 #endif
 173
 174 U_BOOT_CMD_WITH_SUBCMDS(log, "log system", log_help_text,
 175         U_BOOT_SUBCMD_MKENT(level, 2, 1, do_log_level),
 176         U_BOOT_SUBCMD_MKENT(categories, 1, 1, do_log_categories),
 177         U_BOOT_SUBCMD_MKENT(drivers, 1, 1, do_log_drivers),
 178         U_BOOT_SUBCMD_MKENT(format, 2, 1, do_log_format),
 179         U_BOOT_SUBCMD_MKENT(rec, 7, 1, do_log_rec),
 180 );