summaryrefslogtreecommitdiff
path: root/cros_ec/include/ec_console.h
blob: 827be9fc8668bb72e469a5044df0a355c724b175 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/* Copyright (c) 2011 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.
 */

/* ec_console.h - Debug console for Chrome EC */

#ifndef __CROS_EC_CONSOLE_H
#define __CROS_EC_CONSOLE_H

#include "ec_common.h"

/* Console command */
typedef struct EcConsoleCommand {
  /* Command name.  Case-insensitive. */
  const char* name;
  /* Handler for the command.  argv[0] will be the command name. */
  EcError (*handler)(int argc, char** argv);
} EcConsoleCommand;


/* Console command group */
typedef struct EcConsoleCommandGroup {
  const char* group_name;            /* Name of the command group */
  const EcConsoleCommand* commands;  /* List of commands */
  int command_count;                 /* Number of commands in list */
} EcConsoleCommandGroup;


/* Initializes the console module. */
EcError EcConsoleInit(void);


/* Registers a group of console commands. */
EcError EcConsoleRegisterCommands(const EcConsoleCommandGroup* group);

#endif  /* __CROS_EC_CONSOLE_H */