WebSVN – HelenOS-historic – Diff – /kernel/trunk/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 __KCONSOLE_H__
#define __KCONSOLE_H__
 
#include <typedefs.h>
#include <adt/list.h>
#include <synch/spinlock.h>
 
#define MAX_CMDLINE     256
#define KCONSOLE_HISTORY 10
 
enum cmd_arg_type {
    ARG_TYPE_INVALID = 0,
    ARG_TYPE_INT,
    ARG_TYPE_STRING,
    ARG_TYPE_VAR      /**< Variable type - either symbol or string */
};
 
/** Structure representing one argument of kconsole command line. */
struct cmd_arg {
    cmd_arg_type_t type;        /**< Type descriptor. */
    void *buffer;           /**< Buffer where to store data. */
    size_t len;         /**< Size of the buffer. */
    unative_t intval;                /**< Integer value */
    cmd_arg_type_t vartype;         /**< Resulting type of variable arg */
};
 
/** Structure representing one kconsole command. */
struct cmd_info {
    link_t link;            /**< Command list link. */
    SPINLOCK_DECLARE(lock);     /**< This lock protects everything below. */
    const char *name;       /**< Command name. */
    const char *description;    /**< Textual description. */
    int (* func)(cmd_arg_t *);  /**< Function implementing the command. */
    count_t argc;           /**< Number of arguments. */
    cmd_arg_t *argv;        /**< Argument vector. */
    void (* help)(void);        /**< Function for printing detailed help. */
};
 
extern spinlock_t cmd_lock;
extern link_t cmd_head;
 
extern void kconsole_init(void);
extern void kconsole(void *prompt);
 
extern int cmd_register(cmd_info_t *cmd);
 
#endif
 
 /** @}
 */
 
 

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/console/kconsole.h – Rev 1702 → 1780

Rev 1702		Rev 1780
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 __KCONSOLE_H__	35	#ifndef __KCONSOLE_H__
36	#define __KCONSOLE_H__	36	#define __KCONSOLE_H__
37		37
38	#include <typedefs.h>	38	#include <typedefs.h>
39	#include <adt/list.h>	39	#include <adt/list.h>
40	#include <synch/spinlock.h>	40	#include <synch/spinlock.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	enum cmd_arg_type {	45	enum cmd_arg_type {
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	ARG_TYPE_VAR /*< Variable type - either symbol or string /	49	ARG_TYPE_VAR /*< Variable type - either symbol or string /
50	};	50	};
51		51
52	/** Structure representing one argument of kconsole command line. */	52	/** Structure representing one argument of kconsole command line. */
53	struct cmd_arg {	53	struct cmd_arg {
54	cmd_arg_type_t type; /*< Type descriptor. /	54	cmd_arg_type_t type; /*< Type descriptor. /
55	void buffer; /< Buffer where to store data. /	55	void buffer; /< Buffer where to store data. /
56	size_t len; /*< Size of the buffer. /	56	size_t len; /*< Size of the buffer. /
57	__native intval; /*< Integer value /	57	unative_t intval; /*< Integer value /
58	cmd_arg_type_t vartype; /*< Resulting type of variable arg /	58	cmd_arg_type_t vartype; /*< Resulting type of variable arg /
59	};	59	};
60		60
61	/** Structure representing one kconsole command. */	61	/** Structure representing one kconsole command. */
62	struct cmd_info {	62	struct cmd_info {
63	link_t link; /*< Command list link. /	63	link_t link; /*< Command list link. /
64	SPINLOCK_DECLARE(lock); /*< This lock protects everything below. /	64	SPINLOCK_DECLARE(lock); /*< This lock protects everything below. /
65	const char name; /< Command name. /	65	const char name; /< Command name. /
66	const char description; /< Textual description. /	66	const char description; /< Textual description. /
67	int (* func)(cmd_arg_t ); /< Function implementing the command. /	67	int (* func)(cmd_arg_t ); /< Function implementing the command. /
68	count_t argc; /*< Number of arguments. /	68	count_t argc; /*< Number of arguments. /
69	cmd_arg_t argv; /< Argument vector. /	69	cmd_arg_t argv; /< Argument vector. /
70	void (* help)(void); /*< Function for printing detailed help. /	70	void (* help)(void); /*< Function for printing detailed help. /
71	};	71	};
72		72
73	extern spinlock_t cmd_lock;	73	extern spinlock_t cmd_lock;
74	extern link_t cmd_head;	74	extern link_t cmd_head;
75		75
76	extern void kconsole_init(void);	76	extern void kconsole_init(void);
77	extern void kconsole(void *prompt);	77	extern void kconsole(void *prompt);
78		78
79	extern int cmd_register(cmd_info_t *cmd);	79	extern int cmd_register(cmd_info_t *cmd);
80		80
81	#endif	81	#endif
82		82
83	/** @}	83	/** @}
84	*/	84	*/
85		85
86		86