Rev 4296 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 510 | jermar | 1 | /* |
| 2071 | jermar | 2 | * Copyright (c) 2005 Jakub Jermar |
| 510 | 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 | |||
| 1888 | jermar | 29 | /** @addtogroup genericconsole |
| 1702 | cejka | 30 | * @{ |
| 31 | */ |
||
| 32 | /** @file |
||
| 33 | */ |
||
| 34 | |||
| 1888 | jermar | 35 | #ifndef KERN_KCONSOLE_H_ |
| 36 | #define KERN_KCONSOLE_H_ |
||
| 510 | jermar | 37 | |
| 788 | jermar | 38 | #include <adt/list.h> |
| 517 | jermar | 39 | #include <synch/spinlock.h> |
| 4055 | trochtova | 40 | #include <ipc/irq.h> |
| 517 | jermar | 41 | |
| 4296 | trochtova | 42 | #define MAX_CMDLINE 256 |
| 43 | #define KCONSOLE_HISTORY 10 |
||
| 596 | jermar | 44 | |
| 2089 | decky | 45 | typedef enum { |
| 517 | jermar | 46 | ARG_TYPE_INVALID = 0, |
| 47 | ARG_TYPE_INT, |
||
| 585 | palkovsky | 48 | ARG_TYPE_STRING, |
| 2106 | jermar | 49 | /** Variable type - either symbol or string. */ |
| 4296 | trochtova | 50 | ARG_TYPE_VAR |
| 2089 | decky | 51 | } cmd_arg_type_t; |
| 517 | jermar | 52 | |
| 53 | /** Structure representing one argument of kconsole command line. */ |
||
| 2089 | decky | 54 | typedef struct { |
| 2106 | jermar | 55 | /** Type descriptor. */ |
| 56 | cmd_arg_type_t type; |
||
| 57 | /** Buffer where to store data. */ |
||
| 58 | void *buffer; |
||
| 59 | /** Size of the buffer. */ |
||
| 60 | size_t len; |
||
| 61 | /** Integer value. */ |
||
| 62 | unative_t intval; |
||
| 63 | /** Resulting type of variable arg */ |
||
| 64 | cmd_arg_type_t vartype; |
||
| 2089 | decky | 65 | } cmd_arg_t; |
| 517 | jermar | 66 | |
| 67 | /** Structure representing one kconsole command. */ |
||
| 2089 | decky | 68 | typedef struct { |
| 2106 | jermar | 69 | /** Command list link. */ |
| 70 | link_t link; |
||
| 71 | /** This lock protects everything below. */ |
||
| 72 | SPINLOCK_DECLARE(lock); |
||
| 73 | /** Command name. */ |
||
| 74 | const char *name; |
||
| 75 | /** Textual description. */ |
||
| 76 | const char *description; |
||
| 77 | /** Function implementing the command. */ |
||
| 78 | int (* func)(cmd_arg_t *); |
||
| 79 | /** Number of arguments. */ |
||
| 4537 | trochtova | 80 | size_t argc; |
| 2106 | jermar | 81 | /** Argument vector. */ |
| 82 | cmd_arg_t *argv; |
||
| 83 | /** Function for printing detailed help. */ |
||
| 84 | void (* help)(void); |
||
| 2089 | decky | 85 | } cmd_info_t; |
| 517 | jermar | 86 | |
| 4055 | trochtova | 87 | extern bool kconsole_notify; |
| 88 | extern irq_t kconsole_irq; |
||
| 89 | |||
| 2093 | decky | 90 | SPINLOCK_EXTERN(cmd_lock); |
| 517 | jermar | 91 | extern link_t cmd_head; |
| 92 | |||
| 93 | extern void kconsole_init(void); |
||
| 4055 | trochtova | 94 | extern void kconsole_notify_init(void); |
| 4156 | trochtova | 95 | extern bool kconsole_check_poll(void); |
| 4055 | trochtova | 96 | extern void kconsole(char *prompt, char *msg, bool kcon); |
| 97 | extern void kconsole_thread(void *data); |
||
| 510 | jermar | 98 | |
| 4296 | trochtova | 99 | extern bool cmd_register(cmd_info_t *cmd); |
| 517 | jermar | 100 | |
| 510 | jermar | 101 | #endif |
| 1702 | cejka | 102 | |
| 1888 | jermar | 103 | /** @} |
| 1702 | cejka | 104 | */ |