source: mainline/uspace/srv/hid/output/output.h@ 6feccae

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 6feccae was 4122410, checked in by Jakub Jermar <jakub@…>, 7 years ago

Improve Doxygen documentaion

This is stil WiP. A number of libraries, drivers and services were
converted to using a more hierarchical and decentralized scheme when it
comes to specifying to which doxygen group they belong.

  • Property mode set to 100644
File size: 2.4 KB
Line 
1/*
2 * Copyright (c) 2011 Martin Decky
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 output
30 * @{
31 */
32
33#ifndef OUTPUT_OUTPUT_H_
34#define OUTPUT_OUTPUT_H_
35
36#include <stdbool.h>
37#include <loc.h>
38#include <io/console.h>
39#include <io/style.h>
40#include <io/color.h>
41#include <io/chargrid.h>
42
43#define NAME "output"
44
45struct outdev;
46
47typedef struct {
48 errno_t (*yield)(struct outdev *dev);
49 errno_t (*claim)(struct outdev *dev);
50
51 void (*get_dimensions)(struct outdev *dev, sysarg_t *cols,
52 sysarg_t *rows);
53 console_caps_t (*get_caps)(struct outdev *dev);
54
55 void (*cursor_update)(struct outdev *dev, sysarg_t prev_col,
56 sysarg_t prev_row, sysarg_t col, sysarg_t row, bool visible);
57 void (*char_update)(struct outdev *dev, sysarg_t col, sysarg_t row);
58 void (*flush)(struct outdev *dev);
59} outdev_ops_t;
60
61typedef struct outdev {
62 link_t link;
63
64 sysarg_t cols;
65 sysarg_t rows;
66 char_attrs_t attrs;
67
68 chargrid_t *backbuf;
69 sysarg_t top_row;
70
71 outdev_ops_t ops;
72 void *data;
73} outdev_t;
74
75extern outdev_t *outdev_register(outdev_ops_t *, void *);
76
77#endif
78
79/** @}
80 */
Note: See TracBrowser for help on using the repository browser.