| 1 | /*
|
|---|
| 2 | * Copyright (c) 2005 Jakub Jermar
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup genericconsole
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | #ifndef KERN_KCONSOLE_H_
|
|---|
| 36 | #define KERN_KCONSOLE_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <adt/list.h>
|
|---|
| 39 | #include <synch/spinlock.h>
|
|---|
| 40 | #include <ipc/irq.h>
|
|---|
| 41 |
|
|---|
| 42 | #define MAX_CMDLINE 256
|
|---|
| 43 | #define KCONSOLE_HISTORY 10
|
|---|
| 44 |
|
|---|
| 45 | typedef enum {
|
|---|
| 46 | ARG_TYPE_INVALID = 0,
|
|---|
| 47 | ARG_TYPE_INT,
|
|---|
| 48 | ARG_TYPE_STRING,
|
|---|
| 49 | /** Optional string */
|
|---|
| 50 | ARG_TYPE_STRING_OPTIONAL,
|
|---|
| 51 | /** Variable type - either symbol or string. */
|
|---|
| 52 | ARG_TYPE_VAR
|
|---|
| 53 | } cmd_arg_type_t;
|
|---|
| 54 |
|
|---|
| 55 | /** Structure representing one argument of kconsole command line. */
|
|---|
| 56 | typedef struct {
|
|---|
| 57 | /** Type descriptor. */
|
|---|
| 58 | cmd_arg_type_t type;
|
|---|
| 59 | /** Buffer where to store data. */
|
|---|
| 60 | void *buffer;
|
|---|
| 61 | /** Size of the buffer. */
|
|---|
| 62 | size_t len;
|
|---|
| 63 | /** Integer value. */
|
|---|
| 64 | sysarg_t intval;
|
|---|
| 65 | /** Resulting type of variable arg */
|
|---|
| 66 | cmd_arg_type_t vartype;
|
|---|
| 67 | } cmd_arg_t;
|
|---|
| 68 |
|
|---|
| 69 | /** Structure representing one kconsole command. */
|
|---|
| 70 | typedef struct {
|
|---|
| 71 | /** Command list link. */
|
|---|
| 72 | link_t link;
|
|---|
| 73 | /** This lock protects everything below. */
|
|---|
| 74 | SPINLOCK_DECLARE(lock);
|
|---|
| 75 | /** Command name. */
|
|---|
| 76 | const char *name;
|
|---|
| 77 | /** Textual description. */
|
|---|
| 78 | const char *description;
|
|---|
| 79 | /** Function implementing the command. */
|
|---|
| 80 | int (* func)(cmd_arg_t *);
|
|---|
| 81 | /** Number of arguments. */
|
|---|
| 82 | size_t argc;
|
|---|
| 83 | /** Argument vector. */
|
|---|
| 84 | cmd_arg_t *argv;
|
|---|
| 85 | /** Function for printing detailed help. */
|
|---|
| 86 | void (* help)(void);
|
|---|
| 87 | } cmd_info_t;
|
|---|
| 88 |
|
|---|
| 89 | extern bool kconsole_notify;
|
|---|
| 90 | extern irq_t kconsole_irq;
|
|---|
| 91 |
|
|---|
| 92 | SPINLOCK_EXTERN(cmd_lock);
|
|---|
| 93 | extern list_t cmd_list;
|
|---|
| 94 |
|
|---|
| 95 | extern void kconsole_init(void);
|
|---|
| 96 | extern void kconsole_notify_init(void);
|
|---|
| 97 | extern bool kconsole_check_poll(void);
|
|---|
| 98 | extern void kconsole(const char *prompt, const char *msg, bool kcon);
|
|---|
| 99 | extern void kconsole_thread(void *data);
|
|---|
| 100 |
|
|---|
| 101 | extern bool cmd_register(cmd_info_t *cmd);
|
|---|
| 102 |
|
|---|
| 103 | #endif
|
|---|
| 104 |
|
|---|
| 105 | /** @}
|
|---|
| 106 | */
|
|---|
