WebSVN – HelenOS – Diff – /branches/sparc/kernel/generic/include/console/kconsole.h


/*
 * Copyright (c) 2005 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericconsole
 * @{
 */
/** @file
 */
 
#ifndef KERN_KCONSOLE_H_
#define KERN_KCONSOLE_H_
 
#include <adt/list.h>
#include <synch/spinlock.h>
 
#define MAX_CMDLINE     256
#define KCONSOLE_HISTORY 10
 
typedef enum {
    ARG_TYPE_INVALID = 0,
    ARG_TYPE_INT,
    ARG_TYPE_STRING,
    /** Variable type - either symbol or string. */
    ARG_TYPE_VAR      
} cmd_arg_type_t;
 
/** Structure representing one argument of kconsole command line. */
typedef struct {
    /** Type descriptor. */
    cmd_arg_type_t type;
    /** Buffer where to store data. */
    void *buffer;
    /** Size of the buffer. */
    size_t len;
    /** Integer value. */
    unative_t intval;
    /** Resulting type of variable arg */
    cmd_arg_type_t vartype;
} cmd_arg_t;
 
/** Structure representing one kconsole command. */
typedef struct {
    /** Command list link. */
    link_t link;
    /** This lock protects everything below. */
    SPINLOCK_DECLARE(lock);
    /** Command name. */
    const char *name;
    /** Textual description. */
    const char *description;
    /** Function implementing the command. */
    int (* func)(cmd_arg_t *);
    /** Number of arguments. */
    count_t argc;
    /** Argument vector. */
    cmd_arg_t *argv;
    /** Function for printing detailed help. */
    void (* help)(void);
} cmd_info_t;
 
SPINLOCK_EXTERN(cmd_lock);
extern link_t cmd_head;
 
extern void kconsole_init(void);
extern void kconsole(char *prompt, char *msg, bool kcon);
extern void kconsole_thread(void *data);
 
extern int cmd_register(cmd_info_t *cmd);
 
#endif
 
/** @}
 */
 

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

Subversion Repositories HelenOS

(root)/branches/sparc/kernel/generic/include/console/kconsole.h – Rev 3343 → 3742