source: mainline/uspace/drv/hid/xtkbd/xtkbd.h

Last change on this file was c8ea6eca, checked in by Jakub Jermar <jakub@…>, 7 years ago

Improve doxygen documentation

  • Property mode set to 100644
File size: 2.0 KB
RevLine 
[5b0de4c]1/*
2 * Copyright (c) 2011 Jan Vesely
[15c5418]3 * Copyright (c) 2017 Jiri Svoboda
[5b0de4c]4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
[c072a29]29
[c8ea6eca]30/** @addtogroup xtkbd
[5b0de4c]31 * @{
32 */
33/** @file
[a84ddf0]34 * @brief XT keyboard driver
[5b0de4c]35 */
36
[15c5418]37#ifndef XT_KBD_H_
38#define XT_KBD_H_
[5b0de4c]39
[15c5418]40#include <async.h>
[5b0de4c]41#include <ddf/driver.h>
42#include <fibril.h>
[15c5418]43#include <io/chardev.h>
[5b0de4c]44
[15c5418]45/** PC/XT keyboard driver structure */
[5b0de4c]46typedef struct {
[15c5418]47 /** Keyboard function */
48 ddf_fun_t *kbd_fun;
49 /** Device providing keyboard connection */
50 chardev_t *chardev;
51 /** Callback connection to client */
52 async_sess_t *client_sess;
53 /** Fibril retrieving an parsing data */
54 fid_t polling_fibril;
[5b0de4c]55} xt_kbd_t;
56
[b7fd2a0]57extern errno_t xt_kbd_init(xt_kbd_t *, ddf_dev_t *);
[5b0de4c]58
59#endif
[c072a29]60
[5b0de4c]61/**
62 * @}
63 */
Note: See TracBrowser for help on using the repository browser.