WebSVN – HelenOS – Diff – /branches/tracing/kernel/generic/include/console/chardev.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_CHARDEV_H_
#define KERN_CHARDEV_H_
 
#include <arch/types.h>
#include <synch/waitq.h>
#include <synch/spinlock.h>
 
#define INDEV_BUFLEN  512
 
struct indev;
 
/* Input character device operations interface. */
typedef struct {
    /** Read character directly from device, assume interrupts disabled. */
    wchar_t (* poll)(struct indev *);
} indev_operations_t;
 
/** Character input device. */
typedef struct indev {
    char *name;
    waitq_t wq;
   
    /** Protects everything below. */
    SPINLOCK_DECLARE(lock);
    wchar_t buffer[INDEV_BUFLEN];
    size_t counter;
   
    /** Implementation of indev operations. */
    indev_operations_t *op;
    size_t index;
    void *data;
} indev_t;
 
 
struct outdev;
 
/* Output character device operations interface. */
typedef struct {
    /** Write character to output. */
    void (* write)(struct outdev *, wchar_t, bool);
} outdev_operations_t;
 
/** Character input device. */
typedef struct outdev {
    char *name;
   
    /** Protects everything below. */
    SPINLOCK_DECLARE(lock);
   
    /** Implementation of outdev operations. */
    outdev_operations_t *op;
    void *data;
} outdev_t;
 
extern void indev_initialize(char *name, indev_t *indev,
    indev_operations_t *op);
extern void indev_push_character(indev_t *indev, wchar_t ch);
extern wchar_t indev_pop_character(indev_t *indev);
 
extern void outdev_initialize(char *name, outdev_t *outdev,
    outdev_operations_t *op);
 
extern bool check_poll(indev_t *indev);
 
#endif /* KERN_CHARDEV_H_ */
 
/** @}
 */
 

Rev 4377	Rev 4692
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_CHARDEV_H_	35	#ifndef KERN_CHARDEV_H_
36	#define KERN_CHARDEV_H_	36	#define KERN_CHARDEV_H_
37		37
38	#include <arch/types.h>	38	#include <arch/types.h>
39	#include <synch/waitq.h>	39	#include <synch/waitq.h>
40	#include <synch/spinlock.h>	40	#include <synch/spinlock.h>
41		41
42	#define INDEV_BUFLEN 512	42	#define INDEV_BUFLEN 512
43		43
44	struct indev;	44	struct indev;
45		45
46	/* Input character device operations interface. */	46	/* Input character device operations interface. */
47	typedef struct {	47	typedef struct {
48	/** Read character directly from device, assume interrupts disabled. */	48	/** Read character directly from device, assume interrupts disabled. */
49	wchar_t (* poll)(struct indev *);	49	wchar_t (* poll)(struct indev *);
50	} indev_operations_t;	50	} indev_operations_t;
51		51
52	/** Character input device. */	52	/** Character input device. */
53	typedef struct indev {	53	typedef struct indev {
54	char *name;	54	char *name;
55	waitq_t wq;	55	waitq_t wq;
56		56
57	/** Protects everything below. */	57	/** Protects everything below. */
58	SPINLOCK_DECLARE(lock);	58	SPINLOCK_DECLARE(lock);
59	wchar_t buffer[INDEV_BUFLEN];	59	wchar_t buffer[INDEV_BUFLEN];
60	count_t counter;	60	size_t counter;
61		61
62	/** Implementation of indev operations. */	62	/** Implementation of indev operations. */
63	indev_operations_t *op;	63	indev_operations_t *op;
64	index_t index;	64	size_t index;
65	void *data;	65	void *data;
66	} indev_t;	66	} indev_t;
67		67
68		68
69	struct outdev;	69	struct outdev;
70		70
71	/* Output character device operations interface. */	71	/* Output character device operations interface. */
72	typedef struct {	72	typedef struct {
73	/** Write character to output. */	73	/** Write character to output. */
74	void (* write)(struct outdev *, wchar_t, bool);	74	void (* write)(struct outdev *, wchar_t, bool);
75	} outdev_operations_t;	75	} outdev_operations_t;
76		76
77	/** Character input device. */	77	/** Character input device. */
78	typedef struct outdev {	78	typedef struct outdev {
79	char *name;	79	char *name;
80		80
81	/** Protects everything below. */	81	/** Protects everything below. */
82	SPINLOCK_DECLARE(lock);	82	SPINLOCK_DECLARE(lock);
83		83
84	/** Implementation of outdev operations. */	84	/** Implementation of outdev operations. */
85	outdev_operations_t *op;	85	outdev_operations_t *op;
86	void *data;	86	void *data;
87	} outdev_t;	87	} outdev_t;
88		88
89	extern void indev_initialize(char name, indev_t indev,	89	extern void indev_initialize(char name, indev_t indev,
90	indev_operations_t *op);	90	indev_operations_t *op);
91	extern void indev_push_character(indev_t *indev, wchar_t ch);	91	extern void indev_push_character(indev_t *indev, wchar_t ch);
92	extern wchar_t indev_pop_character(indev_t *indev);	92	extern wchar_t indev_pop_character(indev_t *indev);
93		93
94	extern void outdev_initialize(char name, outdev_t outdev,	94	extern void outdev_initialize(char name, outdev_t outdev,
95	outdev_operations_t *op);	95	outdev_operations_t *op);
96		96
97	extern bool check_poll(indev_t *indev);	97	extern bool check_poll(indev_t *indev);
98		98
99	#endif /* KERN_CHARDEV_H_ */	99	#endif /* KERN_CHARDEV_H_ */
100		100
101	/** @}	101	/** @}
102	*/	102	*/
103		103

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/generic/include/console/chardev.h – Rev 4377 → 4692