Subversion Repositories HelenOS

Rev

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

Rev 4156 Rev 4296
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
#include <ipc/irq.h>
40
#include <ipc/irq.h>
41
 
41
 
42
#define MAX_CMDLINE     256
42
#define MAX_CMDLINE       256
43
#define KCONSOLE_HISTORY 10
43
#define KCONSOLE_HISTORY  10
44
 
44
 
45
typedef enum {
45
typedef enum {
46
    ARG_TYPE_INVALID = 0,
46
    ARG_TYPE_INVALID = 0,
47
    ARG_TYPE_INT,
47
    ARG_TYPE_INT,
48
    ARG_TYPE_STRING,
48
    ARG_TYPE_STRING,
49
    /** Variable type - either symbol or string. */
49
    /** Variable type - either symbol or string. */
50
    ARG_TYPE_VAR      
50
    ARG_TYPE_VAR
51
} cmd_arg_type_t;
51
} cmd_arg_type_t;
52
 
52
 
53
/** Structure representing one argument of kconsole command line. */
53
/** Structure representing one argument of kconsole command line. */
54
typedef struct {
54
typedef struct {
55
    /** Type descriptor. */
55
    /** Type descriptor. */
56
    cmd_arg_type_t type;
56
    cmd_arg_type_t type;
57
    /** Buffer where to store data. */
57
    /** Buffer where to store data. */
58
    void *buffer;
58
    void *buffer;
59
    /** Size of the buffer. */
59
    /** Size of the buffer. */
60
    size_t len;
60
    size_t len;
61
    /** Integer value. */
61
    /** Integer value. */
62
    unative_t intval;
62
    unative_t intval;
63
    /** Resulting type of variable arg */
63
    /** Resulting type of variable arg */
64
    cmd_arg_type_t vartype;
64
    cmd_arg_type_t vartype;
65
} cmd_arg_t;
65
} cmd_arg_t;
66
 
66
 
67
/** Structure representing one kconsole command. */
67
/** Structure representing one kconsole command. */
68
typedef struct {
68
typedef struct {
69
    /** Command list link. */
69
    /** Command list link. */
70
    link_t link;
70
    link_t link;
71
    /** This lock protects everything below. */
71
    /** This lock protects everything below. */
72
    SPINLOCK_DECLARE(lock);
72
    SPINLOCK_DECLARE(lock);
73
    /** Command name. */
73
    /** Command name. */
74
    const char *name;
74
    const char *name;
75
    /** Textual description. */
75
    /** Textual description. */
76
    const char *description;
76
    const char *description;
77
    /** Function implementing the command. */
77
    /** Function implementing the command. */
78
    int (* func)(cmd_arg_t *);
78
    int (* func)(cmd_arg_t *);
79
    /** Number of arguments. */
79
    /** Number of arguments. */
80
    count_t argc;
80
    count_t argc;
81
    /** Argument vector. */
81
    /** Argument vector. */
82
    cmd_arg_t *argv;
82
    cmd_arg_t *argv;
83
    /** Function for printing detailed help. */
83
    /** Function for printing detailed help. */
84
    void (* help)(void);
84
    void (* help)(void);
85
} cmd_info_t;
85
} cmd_info_t;
86
 
86
 
87
extern bool kconsole_notify;
87
extern bool kconsole_notify;
88
extern irq_t kconsole_irq;
88
extern irq_t kconsole_irq;
89
 
89
 
90
SPINLOCK_EXTERN(cmd_lock);
90
SPINLOCK_EXTERN(cmd_lock);
91
extern link_t cmd_head;
91
extern link_t cmd_head;
92
 
92
 
93
extern void kconsole_init(void);
93
extern void kconsole_init(void);
94
extern void kconsole_notify_init(void);
94
extern void kconsole_notify_init(void);
95
extern bool kconsole_check_poll(void);
95
extern bool kconsole_check_poll(void);
96
extern void kconsole(char *prompt, char *msg, bool kcon);
96
extern void kconsole(char *prompt, char *msg, bool kcon);
97
extern void kconsole_thread(void *data);
97
extern void kconsole_thread(void *data);
98
 
98
 
99
extern int cmd_register(cmd_info_t *cmd);
99
extern bool cmd_register(cmd_info_t *cmd);
100
 
100
 
101
#endif
101
#endif
102
 
102
 
103
/** @}
103
/** @}
104
 */
104
 */
105
 
105