Subversion Repositories HelenOS

Rev

Rev 4310 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
510 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2005 Jakub Jermar
510 jermar 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
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
15
 *   derived from this software without specific prior written permission.
16
 *
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
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
1888 jermar 29
/** @addtogroup genericconsole
1702 cejka 30
 * @{
31
 */
32
/** @file
33
 */
34
 
1888 jermar 35
#ifndef KERN_CHARDEV_H_
36
#define KERN_CHARDEV_H_
510 jermar 37
 
38
#include <arch/types.h>
39
#include <synch/waitq.h>
40
#include <synch/spinlock.h>
41
 
4086 decky 42
#define INDEV_BUFLEN  512
510 jermar 43
 
4086 decky 44
struct indev;
2089 decky 45
 
4086 decky 46
/* Input character device operations interface. */
2089 decky 47
typedef struct {
2106 jermar 48
    /** Read character directly from device, assume interrupts disabled. */
4214 decky 49
    wchar_t (* poll)(struct indev *);
4086 decky 50
} indev_operations_t;
510 jermar 51
 
52
/** Character input device. */
4086 decky 53
typedef struct indev {
575 palkovsky 54
    char *name;
4086 decky 55
    waitq_t wq;
575 palkovsky 56
 
2106 jermar 57
    /** Protects everything below. */
4086 decky 58
    SPINLOCK_DECLARE(lock);
4214 decky 59
    wchar_t buffer[INDEV_BUFLEN];
4490 decky 60
    size_t counter;
4086 decky 61
 
62
    /** Implementation of indev operations. */
63
    indev_operations_t *op;
4490 decky 64
    size_t index;
575 palkovsky 65
    void *data;
4086 decky 66
} indev_t;
510 jermar 67
 
68
 
4086 decky 69
struct outdev;
70
 
71
/* Output character device operations interface. */
72
typedef struct {
73
    /** Write character to output. */
4214 decky 74
    void (* write)(struct outdev *, wchar_t, bool);
4086 decky 75
} outdev_operations_t;
76
 
77
/** Character input device. */
78
typedef struct outdev {
79
    char *name;
80
 
81
    /** Protects everything below. */
82
    SPINLOCK_DECLARE(lock);
83
 
84
    /** Implementation of outdev operations. */
85
    outdev_operations_t *op;
86
    void *data;
87
} outdev_t;
88
 
89
extern void indev_initialize(char *name, indev_t *indev,
90
    indev_operations_t *op);
4214 decky 91
extern void indev_push_character(indev_t *indev, wchar_t ch);
4310 decky 92
extern wchar_t indev_pop_character(indev_t *indev);
4086 decky 93
 
94
extern void outdev_initialize(char *name, outdev_t *outdev,
95
    outdev_operations_t *op);
96
 
4310 decky 97
extern bool check_poll(indev_t *indev);
98
 
1888 jermar 99
#endif /* KERN_CHARDEV_H_ */
1702 cejka 100
 
1888 jermar 101
/** @}
1702 cejka 102
 */