WebSVN – HelenOS – Diff – /trunk/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 CHARDEV_BUFLEN 512
 
struct chardev;
 
/* Character device operations interface. */
typedef struct {
    /** Suspend pushing characters. */
    void (* suspend)(struct chardev *);
    /** Resume pushing characters. */
    void (* resume)(struct chardev *);
    /** Write character to stream. */
    void (* write)(struct chardev *, char c, bool silent);
    /** Read character directly from device, assume interrupts disabled. */
    char (* read)(struct chardev *);
} chardev_operations_t;
 
/** Character input device. */
typedef struct chardev {
    char *name;
   
    waitq_t wq;
    /** Protects everything below. */
    SPINLOCK_DECLARE(lock);
    uint8_t buffer[CHARDEV_BUFLEN];
    count_t counter;
    /** Implementation of chardev operations. */
    chardev_operations_t *op;
    index_t index;
    void *data;
} chardev_t;
 
extern void chardev_initialize(char *name, chardev_t *chardev,
    chardev_operations_t *op);
extern void chardev_push_character(chardev_t *chardev, uint8_t ch);
 
#endif /* KERN_CHARDEV_H_ */
 
/** @}
 */
 

Rev 2106	Rev 3844
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 CHARDEV_BUFLEN 512	42	#define CHARDEV_BUFLEN 512
43		43
44	struct chardev;	44	struct chardev;
45		45
46	/* Character device operations interface. */	46	/* Character device operations interface. */
47	typedef struct {	47	typedef struct {
48	/** Suspend pushing characters. */	48	/** Suspend pushing characters. */
49	void (* suspend)(struct chardev *);	49	void (* suspend)(struct chardev *);
50	/** Resume pushing characters. */	50	/** Resume pushing characters. */
51	void (* resume)(struct chardev *);	51	void (* resume)(struct chardev *);
52	/** Write character to stream. */	52	/** Write character to stream. */
53	void (* write)(struct chardev *, char c);	53	void (* write)(struct chardev *, char c, bool silent);
54	/** Read character directly from device, assume interrupts disabled. */	54	/** Read character directly from device, assume interrupts disabled. */
55	char (* read)(struct chardev *);	55	char (* read)(struct chardev *);
56	} chardev_operations_t;	56	} chardev_operations_t;
57		57
58	/** Character input device. */	58	/** Character input device. */
59	typedef struct chardev {	59	typedef struct chardev {
60	char *name;	60	char *name;
61		61
62	waitq_t wq;	62	waitq_t wq;
63	/** Protects everything below. */	63	/** Protects everything below. */
64	SPINLOCK_DECLARE(lock);	64	SPINLOCK_DECLARE(lock);
65	uint8_t buffer[CHARDEV_BUFLEN];	65	uint8_t buffer[CHARDEV_BUFLEN];
66	count_t counter;	66	count_t counter;
67	/** Implementation of chardev operations. */	67	/** Implementation of chardev operations. */
68	chardev_operations_t *op;	68	chardev_operations_t *op;
69	index_t index;	69	index_t index;
70	void *data;	70	void *data;
71	} chardev_t;	71	} chardev_t;
72		72
73	extern void chardev_initialize(char name, chardev_t chardev,	73	extern void chardev_initialize(char name, chardev_t chardev,
74	chardev_operations_t *op);	74	chardev_operations_t *op);
75	extern void chardev_push_character(chardev_t *chardev, uint8_t ch);	75	extern void chardev_push_character(chardev_t *chardev, uint8_t ch);
76		76
77	#endif /* KERN_CHARDEV_H_ */	77	#endif /* KERN_CHARDEV_H_ */
78		78
79	/** @}	79	/** @}
80	*/	80	*/
81		81

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/console/chardev.h – Rev 2106 → 3844