mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-28 02:35:28 +00:00
c2b94fd184
This is part one of a series to merge the keyboard scan interface to be common across all platforms. This change just moves and renames files and APIs and removes some read code, and sets up protocol-specific CONFIG options. It makes the next CL which actually merges keyboard scanning easier to parse. BUG=chrome-os-partner:18360 BRANCH=none TEST=compile all boards; test keyboard on spring and link Change-Id: I815a40aae4e5d5f333b8501aff9656080533d913 Signed-off-by: Randall Spangler <rspangler@chromium.org> Reviewed-on: https://gerrit.chromium.org/gerrit/46549 Reviewed-by: Bill Richardson <wfrichar@chromium.org>
130 lines
3.6 KiB
C
130 lines
3.6 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_CHARGER,
|
|
CC_CHIPSET,
|
|
CC_DMA,
|
|
CC_EVENTS,
|
|
CC_GPIO,
|
|
CC_HOSTCMD,
|
|
CC_I2C,
|
|
CC_KEYBOARD,
|
|
CC_KEYSCAN,
|
|
CC_LIGHTBAR,
|
|
CC_LPC,
|
|
CC_PORT80,
|
|
CC_PWM,
|
|
CC_SPI,
|
|
CC_SWITCH,
|
|
CC_SYSTEM,
|
|
CC_TASK,
|
|
CC_THERMAL,
|
|
CC_USBCHARGE,
|
|
CC_VBOOT,
|
|
/* 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
|
|
|
|
/* Max length of a single line of input */
|
|
#define CONSOLE_INPUT_LINE_SIZE 80
|
|
|
|
/**
|
|
* 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, ...);
|
|
|
|
/**
|
|
* 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)
|
|
|
|
/**
|
|
* 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 __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 __con_cmd_##name \
|
|
__attribute__((section(".rodata.cmds." #name))) \
|
|
= {__con_cmd_label_##name, routine}
|
|
#endif
|
|
|
|
#endif /* __CROS_EC_CONSOLE_H */
|