WebSVN – HelenOS-historic – Diff – /kernel/trunk/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 __CHARDEV_H__
#define __CHARDEV_H__
 
#include <typedefs.h>
#include <arch/types.h>
#include <synch/waitq.h>
#include <synch/spinlock.h>
 
#define CHARDEV_BUFLEN 512
 
/* Character device operations interface. */
struct chardev_operations {
    void (* suspend)(chardev_t *);      /**< Suspend pushing characters. */
    void (* resume)(chardev_t *);       /**< Resume pushing characters. */
    void (* write)(chardev_t *, char c);    /**< Write character to stream. */
    /** Read character directly from device, assume interrupts disabled */
    char (* read)(chardev_t *);
};
 
typedef struct chardev_operations chardev_operations_t;
 
/** Character input device. */
struct chardev {
    char *name;
   
    waitq_t wq;
    SPINLOCK_DECLARE(lock);     /**< Protects everything below. */
    uint8_t buffer[CHARDEV_BUFLEN];
    count_t counter;
    chardev_operations_t *op;   /**< Implementation of chardev operations. */
    index_t index;
    void *data;
};
 
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 /* __CHARDEV_H__ */
 
 /** @}
 */
 
 

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

Subversion Repositories HelenOS-historic

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