Subversion Repositories HelenOS

Rev

Rev 2093 | Rev 3761 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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