| 1 | /*
|
|---|
| 2 | * Copyright (c) 2005 Jakub 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 |
|
|---|
| 29 | /** @addtogroup genericconsole
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | #ifndef KERN_CHARDEV_H_
|
|---|
| 36 | #define KERN_CHARDEV_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <adt/list.h>
|
|---|
| 39 | #include <arch/types.h>
|
|---|
| 40 | #include <synch/waitq.h>
|
|---|
| 41 | #include <synch/spinlock.h>
|
|---|
| 42 |
|
|---|
| 43 | #define INDEV_BUFLEN 512
|
|---|
| 44 |
|
|---|
| 45 | struct indev;
|
|---|
| 46 |
|
|---|
| 47 | /* Input character device operations interface. */
|
|---|
| 48 | typedef struct {
|
|---|
| 49 | /** Read character directly from device, assume interrupts disabled. */
|
|---|
| 50 | wchar_t (* poll)(struct indev *);
|
|---|
| 51 | } indev_operations_t;
|
|---|
| 52 |
|
|---|
| 53 | /** Character input device. */
|
|---|
| 54 | typedef struct indev {
|
|---|
| 55 | char *name;
|
|---|
| 56 | waitq_t wq;
|
|---|
| 57 |
|
|---|
| 58 | /** Protects everything below. */
|
|---|
| 59 | SPINLOCK_DECLARE(lock);
|
|---|
| 60 | wchar_t buffer[INDEV_BUFLEN];
|
|---|
| 61 | size_t counter;
|
|---|
| 62 |
|
|---|
| 63 | /** Implementation of indev operations. */
|
|---|
| 64 | indev_operations_t *op;
|
|---|
| 65 | size_t index;
|
|---|
| 66 | void *data;
|
|---|
| 67 | } indev_t;
|
|---|
| 68 |
|
|---|
| 69 |
|
|---|
| 70 | struct outdev;
|
|---|
| 71 |
|
|---|
| 72 | /* Output character device operations interface. */
|
|---|
| 73 | typedef struct {
|
|---|
| 74 | /** Write character to output. */
|
|---|
| 75 | void (* write)(struct outdev *, wchar_t, bool);
|
|---|
| 76 |
|
|---|
| 77 | /** Redraw any previously cached characters. */
|
|---|
| 78 | void (* redraw)(struct outdev *);
|
|---|
| 79 | } outdev_operations_t;
|
|---|
| 80 |
|
|---|
| 81 | /** Character output device. */
|
|---|
| 82 | typedef struct outdev {
|
|---|
| 83 | char *name;
|
|---|
| 84 |
|
|---|
| 85 | /** Protects everything below. */
|
|---|
| 86 | SPINLOCK_DECLARE(lock);
|
|---|
| 87 |
|
|---|
| 88 | /** Fields suitable for multiplexing. */
|
|---|
| 89 | link_t link;
|
|---|
| 90 | link_t list;
|
|---|
| 91 |
|
|---|
| 92 | /** Implementation of outdev operations. */
|
|---|
| 93 | outdev_operations_t *op;
|
|---|
| 94 | void *data;
|
|---|
| 95 | } outdev_t;
|
|---|
| 96 |
|
|---|
| 97 | extern void indev_initialize(char *name, indev_t *indev,
|
|---|
| 98 | indev_operations_t *op);
|
|---|
| 99 | extern void indev_push_character(indev_t *indev, wchar_t ch);
|
|---|
| 100 | extern wchar_t indev_pop_character(indev_t *indev);
|
|---|
| 101 |
|
|---|
| 102 | extern void outdev_initialize(char *name, outdev_t *outdev,
|
|---|
| 103 | outdev_operations_t *op);
|
|---|
| 104 |
|
|---|
| 105 | extern bool check_poll(indev_t *indev);
|
|---|
| 106 |
|
|---|
| 107 | #endif /* KERN_CHARDEV_H_ */
|
|---|
| 108 |
|
|---|
| 109 | /** @}
|
|---|
| 110 | */
|
|---|
