mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-28 02:35:28 +00:00
a8f2e3625e
This patch introduces a facility which would allow to compile in callbacks for arbitrary commands passed over various communication protocols. Typically this will be used for testing, when various test commands are multiplexed over an existing protocol. The callbacks are associated with 16 bit command codes. On input the callback receives a buffer, containing the command's argument, the size of the command argument and the maximum size of the buffer. On output the callback stores processing result in the same buffer and updates the size to the actual amount of returned data. Callback descriptors are stored in a dedicated read only section which is scanned by extension_route_command() to find a callback associated with a certain command code. A console channel is also being introduced to allow controlling console output generated by extension commands handlers. BRANCH=none BUG=chrome-os-partner:47524 TEST=none yet Change-Id: I8ae16a78ca7d72176a5e7f74dd7a232078e7c06c Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/312586 Reviewed-by: Randall Spangler <rspangler@chromium.org>
160 lines
4.2 KiB
C
160 lines
4.2 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 *shorthelp;
|
|
#endif
|
|
};
|
|
|
|
/* Console channels */
|
|
enum console_channel {
|
|
CC_COMMAND = 0, /* Console command (interactive I/O). Use this only
|
|
* inside a console command routine. */
|
|
CC_ACCEL,
|
|
#ifdef CONFIG_EXTENSION_COMMAND
|
|
CC_EXTENSION,
|
|
#endif
|
|
CC_CHARGER,
|
|
CC_CHIPSET,
|
|
CC_CLOCK,
|
|
CC_DMA,
|
|
CC_EVENTS,
|
|
CC_GESTURE,
|
|
CC_GPIO,
|
|
CC_HOSTCMD,
|
|
CC_I2C,
|
|
CC_KEYBOARD,
|
|
CC_KEYSCAN,
|
|
CC_LIDANGLE,
|
|
#ifdef HAS_TASK_LIGHTBAR
|
|
CC_LIGHTBAR,
|
|
#endif
|
|
CC_LPC,
|
|
CC_MOTION_LID,
|
|
CC_MOTION_SENSE,
|
|
#ifdef HAS_TASK_PDCMD
|
|
CC_PD_HOST_CMD,
|
|
#endif
|
|
CC_PORT80,
|
|
CC_PWM,
|
|
CC_SPI,
|
|
#ifdef CONFIG_SPS
|
|
CC_SPS,
|
|
#endif
|
|
CC_SWITCH,
|
|
CC_SYSTEM,
|
|
CC_TASK,
|
|
CC_THERMAL,
|
|
CC_TPM,
|
|
CC_USB,
|
|
CC_USBCHARGE,
|
|
CC_USBPD,
|
|
CC_VBOOT,
|
|
CC_HOOK,
|
|
/* 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 shorthelp String with one-line description of command.
|
|
* @param longhelp String with long description of command.
|
|
*/
|
|
#ifdef CONFIG_CONSOLE_CMDHELP
|
|
#define DECLARE_CONSOLE_COMMAND(name, routine, argdesc, shorthelp, longhelp) \
|
|
static const char __con_cmd_label_##name[] = #name; \
|
|
const struct console_command __keep __con_cmd_##name \
|
|
__attribute__((section(".rodata.cmds." #name))) \
|
|
= {__con_cmd_label_##name, routine, argdesc, shorthelp}
|
|
#else
|
|
#define DECLARE_CONSOLE_COMMAND(name, routine, argdesc, shorthelp, longhelp) \
|
|
static const char __con_cmd_label_##name[] = #name; \
|
|
const struct console_command __keep __con_cmd_##name \
|
|
__attribute__((section(".rodata.cmds." #name))) \
|
|
= {__con_cmd_label_##name, routine}
|
|
#endif
|
|
|
|
#endif /* __CROS_EC_CONSOLE_H */
|