Subversion Repositories HelenOS

Rev

Rev 2089 | Rev 2106 | Go to most recent revision | 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>
40
 
596 jermar 41
#define MAX_CMDLINE     256
601 palkovsky 42
#define KCONSOLE_HISTORY 10
596 jermar 43
 
2089 decky 44
typedef enum {
517 jermar 45
    ARG_TYPE_INVALID = 0,
46
    ARG_TYPE_INT,
585 palkovsky 47
    ARG_TYPE_STRING,
48
    ARG_TYPE_VAR      /**< Variable type - either symbol or string */
2089 decky 49
} cmd_arg_type_t;
517 jermar 50
 
51
/** Structure representing one argument of kconsole command line. */
2089 decky 52
typedef struct {
517 jermar 53
    cmd_arg_type_t type;        /**< Type descriptor. */
54
    void *buffer;           /**< Buffer where to store data. */
518 jermar 55
    size_t len;         /**< Size of the buffer. */
1780 jermar 56
    unative_t intval;                /**< Integer value */
585 palkovsky 57
    cmd_arg_type_t vartype;         /**< Resulting type of variable arg */
2089 decky 58
} cmd_arg_t;
517 jermar 59
 
60
/** Structure representing one kconsole command. */
2089 decky 61
typedef struct {
517 jermar 62
    link_t link;            /**< Command list link. */
623 jermar 63
    SPINLOCK_DECLARE(lock);     /**< This lock protects everything below. */
517 jermar 64
    const char *name;       /**< Command name. */
65
    const char *description;    /**< Textual description. */
518 jermar 66
    int (* func)(cmd_arg_t *);  /**< Function implementing the command. */
517 jermar 67
    count_t argc;           /**< Number of arguments. */
68
    cmd_arg_t *argv;        /**< Argument vector. */
518 jermar 69
    void (* help)(void);        /**< Function for printing detailed help. */
2089 decky 70
} cmd_info_t;
517 jermar 71
 
2093 decky 72
SPINLOCK_EXTERN(cmd_lock);
517 jermar 73
extern link_t cmd_head;
74
 
75
extern void kconsole_init(void);
609 palkovsky 76
extern void kconsole(void *prompt);
510 jermar 77
 
517 jermar 78
extern int cmd_register(cmd_info_t *cmd);
79
 
510 jermar 80
#endif
1702 cejka 81
 
1888 jermar 82
/** @}
1702 cejka 83
 */