mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-27 18:25:05 +00:00
70341959e6
This adds support for CONFIG_RESTRICTED_CONSOLE_COMMANDS. If the
appropriate options are configured, restricted commands can be
prevented from running.
Nothing in this CL actually uses that, but it works if you turn
it on.
BUG=chrome-os-partner:55322
BRANCH=none
TEST=make buildall, test on Cr50 hardware
I also tested it manually. If you add this to board.h:
#define CONFIG_CONSOLE_COMMAND_FLAGS
#define CONFIG_RESTRICTED_CONSOLE_COMMANDS
#define CONFIG_CONSOLE_COMMAND_FLAGS_DEFAULT CMD_FLAG_RESTRICTED
and this to board.c:
static int restricted_state;
int console_is_restricted(void)
{
return restricted_state;
}
static int command_lock(int argc, char **argv)
{
int enabled;
if (argc > 1) {
if (!parse_bool(argv[1], &enabled))
return EC_ERROR_PARAM1;
restricted_state = enabled;
}
ccprintf("The restricted console lock is %s\n",
restricted_state ? "enabled" : "disabled");
return EC_SUCCESS;
}
DECLARE_CONSOLE_COMMAND_FLAGS(lock, command_lock,
"[<BOOLEAN>]",
"Get/Set the restricted console lock",
0); /* no restrictions */
then you can use the "lock" command to enable and disable every
other console command except for it and "help".
Change-Id: Ic9517f9ea7a9867f15e5d14b302246070163d558
Signed-off-by: Bill Richardson <wfrichar@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/376186
Reviewed-by: Randall Spangler <rspangler@chromium.org>
189 lines
5.9 KiB
C
189 lines
5.9 KiB
C
/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
/* Debug console for Chrome EC */
|
|
|
|
#ifndef __CROS_EC_CONSOLE_H
|
|
#define __CROS_EC_CONSOLE_H
|
|
|
|
#include "common.h"
|
|
|
|
/* Console command; used by DECLARE_CONSOLE_COMMAND macro. */
|
|
struct console_command {
|
|
/* Command name. Case-insensitive. */
|
|
const char *name;
|
|
/* Handler for the command. argv[0] will be the command name. */
|
|
int (*handler)(int argc, char **argv);
|
|
#ifdef CONFIG_CONSOLE_CMDHELP
|
|
/* Description of args */
|
|
const char *argdesc;
|
|
/* Short help for command */
|
|
const char *help;
|
|
#endif
|
|
#ifdef CONFIG_CONSOLE_COMMAND_FLAGS
|
|
const uint32_t flags;
|
|
#endif
|
|
};
|
|
|
|
/* Flag bits for when CONFIG_CONSOLE_COMMAND_FLAGS is enabled */
|
|
#define CMD_FLAG_RESTRICTED 0x00000001
|
|
|
|
/* The default .flags value can be overridden in board.h */
|
|
#ifndef CONFIG_CONSOLE_COMMAND_FLAGS_DEFAULT
|
|
#define CONFIG_CONSOLE_COMMAND_FLAGS_DEFAULT 0
|
|
#endif
|
|
|
|
#ifdef CONFIG_RESTRICTED_CONSOLE_COMMANDS
|
|
/*
|
|
* This must be implemented somewhere. A true return value means that all
|
|
* CMD_FLAG_RESTRICTED commands are disabled.
|
|
*/
|
|
int console_is_restricted(void);
|
|
#endif
|
|
|
|
/* Console channels */
|
|
enum console_channel {
|
|
#define CONSOLE_CHANNEL(enumeration, string) enumeration,
|
|
#include "include/console_channel.inc"
|
|
#undef CONSOLE_CHANNEL
|
|
|
|
/* Channel count; not itself a channel */
|
|
CC_CHANNEL_COUNT
|
|
};
|
|
|
|
/* Mask in channel_mask for a particular channel */
|
|
#define CC_MASK(channel) (1UL << (channel))
|
|
|
|
/* Mask to use to enable all channels */
|
|
#define CC_ALL 0xffffffffUL
|
|
|
|
/**
|
|
* Put a string to the console channel.
|
|
*
|
|
* @param channel Output chanel
|
|
* @param outstr String to write
|
|
*
|
|
* @return non-zero if output was truncated.
|
|
*/
|
|
int cputs(enum console_channel channel, const char *outstr);
|
|
|
|
/**
|
|
* Print formatted output to the console channel.
|
|
*
|
|
* @param channel Output chanel
|
|
* @param format Format string; see printf.h for valid formatting codes
|
|
*
|
|
* @return non-zero if output was truncated.
|
|
*/
|
|
int cprintf(enum console_channel channel, const char *format, ...);
|
|
|
|
/**
|
|
* Print formatted output with timestamp. This is like:
|
|
* cprintf(channel, "[%T " + format + "]\n", ...)
|
|
*
|
|
* @param channel Output channel
|
|
* @param format Format string; see printf.h for valid formatting codes
|
|
*
|
|
* @return non-zero if output was truncated.
|
|
*/
|
|
int cprints(enum console_channel channel, const char *format, ...);
|
|
|
|
/**
|
|
* Flush the console output for all channels.
|
|
*/
|
|
void cflush(void);
|
|
|
|
/* Convenience macros for printing to the command channel.
|
|
*
|
|
* Modules may define similar macros in their .c files for their own use; it is
|
|
* recommended those module-specific macros be named CPUTS and CPRINTF. */
|
|
#define ccputs(outstr) cputs(CC_COMMAND, outstr)
|
|
/* gcc allows variable arg lists in macros; see
|
|
* http://gcc.gnu.org/onlinedocs/gcc/Variadic-Macros.html */
|
|
#define ccprintf(format, args...) cprintf(CC_COMMAND, format, ## args)
|
|
#define ccprints(format, args...) cprints(CC_COMMAND, format, ## args)
|
|
|
|
/**
|
|
* Called by UART when a line of input is pending.
|
|
*/
|
|
void console_has_input(void);
|
|
|
|
/**
|
|
* Register a console command handler.
|
|
*
|
|
* @param name Command name; must not be the beginning of another
|
|
* existing command name. Note this is NOT in quotes
|
|
* so it can be concatenated to form a struct name.
|
|
* @param routine Command handling routine, of the form
|
|
* int handler(int argc, char **argv)
|
|
* @param argdesc String describing arguments to command; NULL if none.
|
|
* @param help String with one-line description of command, or NULL.
|
|
* @param flags Per-command flags, if needed.
|
|
*/
|
|
#ifndef HAS_TASK_CONSOLE
|
|
#define DECLARE_CONSOLE_COMMAND(NAME, ROUTINE, ARGDESC, HELP) \
|
|
int (ROUTINE)(int argc, char **argv) __attribute__((unused))
|
|
#define DECLARE_SAFE_CONSOLE_COMMAND(NAME, ROUTINE, ARGDESC, HELP) \
|
|
int (ROUTINE)(int argc, char **argv) __attribute__((unused))
|
|
#define DECLARE_CONSOLE_COMMAND_FLAGS(NAME, ROUTINE, ARGDESC, HELP, FLAGS) \
|
|
int (ROUTINE)(int argc, char **argv) __attribute__((unused))
|
|
#else
|
|
|
|
/* We always provde help args, but we may discard them to save space. */
|
|
#if defined(CONFIG_CONSOLE_CMDHELP)
|
|
#define _HELP_ARGS(A, H) \
|
|
.argdesc = A, \
|
|
.help = H,
|
|
#else
|
|
#define _HELP_ARGS(A, H)
|
|
#endif
|
|
|
|
/* We may or may not have a .flags field */
|
|
#ifdef CONFIG_CONSOLE_COMMAND_FLAGS
|
|
#define _FLAG_ARGS(F) \
|
|
.flags = F,
|
|
#else
|
|
#define _FLAG_ARGS(F)
|
|
#endif
|
|
|
|
/* This macro takes all possible args and discards the ones we don't use */
|
|
#define _DCL_CON_CMD_ALL(NAME, ROUTINE, ARGDESC, HELP, FLAGS) \
|
|
static const char __con_cmd_label_##NAME[] = #NAME; \
|
|
struct size_check##NAME { \
|
|
int field[2 * (sizeof(__con_cmd_label_##NAME) < 16) - 1]; }; \
|
|
const struct console_command __keep __con_cmd_##NAME \
|
|
__attribute__((section(".rodata.cmds." #NAME))) = \
|
|
{ .name = __con_cmd_label_##NAME, \
|
|
.handler = ROUTINE, \
|
|
_HELP_ARGS(ARGDESC, HELP) \
|
|
_FLAG_ARGS(FLAGS) \
|
|
}
|
|
|
|
/*
|
|
* If the .flags field exists, we can use this to specify its value. If not,
|
|
* the value will be discarded so it doesn't matter.
|
|
*/
|
|
#define DECLARE_CONSOLE_COMMAND_FLAGS(NAME, ROUTINE, ARGDESC, HELP, FLAGS) \
|
|
_DCL_CON_CMD_ALL(NAME, ROUTINE, ARGDESC, HELP, FLAGS)
|
|
|
|
/* This works as before, for the same reason. */
|
|
#define DECLARE_CONSOLE_COMMAND(NAME, ROUTINE, ARGDESC, HELP) \
|
|
_DCL_CON_CMD_ALL(NAME, ROUTINE, ARGDESC, HELP, \
|
|
CONFIG_CONSOLE_COMMAND_FLAGS_DEFAULT)
|
|
|
|
/*
|
|
* This can be used to ensure that whatever default flag bits are set (if any),
|
|
* the command is never restricted. BE CAREFUL! You should only use this for
|
|
* commands that either do nothing or that do only safe things.
|
|
*/
|
|
#define DECLARE_SAFE_CONSOLE_COMMAND(NAME, ROUTINE, ARGDESC, HELP) \
|
|
_DCL_CON_CMD_ALL(NAME, ROUTINE, ARGDESC, HELP, \
|
|
(CONFIG_CONSOLE_COMMAND_FLAGS_DEFAULT & \
|
|
~CMD_FLAG_RESTRICTED))
|
|
|
|
#endif /* HAS_TASK_CONSOLE */
|
|
|
|
#endif /* __CROS_EC_CONSOLE_H */
|