1/* $NetBSD: wskbdvar.h,v 1.19 2012/09/02 21:14:56 he Exp $ */
2
3/*
4 * Copyright (c) 1996, 1997 Christopher G. Demetriou. 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 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. 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 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Christopher G. Demetriou
17 * for the NetBSD Project.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*
34 * WSKBD interfaces.
35 */
36#include <dev/wscons/wsksymvar.h>
37
38/*
39 * Keyboard access functions (must be provided by all keyboards).
40 *
41 * There is a "void *" cookie provided by the keyboard driver associated
42 * with these functions, which is passed to them when they are invoked.
43 */
44struct wskbd_accessops {
45 int (*enable)(void *, int);
46 void (*set_leds)(void *, int);
47 int (*ioctl)(void *, u_long, void *, int, struct lwp *);
48};
49
50/*
51 * Keyboard console functions (must be provided by console input keyboards).
52 *
53 * There is a "void *" cookie provided by the keyboard driver associated
54 * with these functions, which is passed to them when they are invoked.
55 */
56struct wskbd_consops {
57 void (*getc)(void *, u_int *, int *);
58 void (*pollc)(void *, int);
59 void (*bell)(void *, u_int, u_int, u_int);
60};
61
62/*
63 * Attachment information provided by wskbddev devices when attaching
64 * wskbd units.
65 */
66struct wskbddev_attach_args {
67 int console; /* is it console? */
68 const struct wskbd_mapdata *keymap;
69
70 const struct wskbd_accessops *accessops; /* access ops */
71 void *accesscookie; /* access cookie */
72};
73
74#include "locators.h"
75
76#define wskbddevcf_console cf_loc[WSKBDDEVCF_CONSOLE] /* spec'd as console? */
77#define WSKBDDEVCF_CONSOLE_UNK (WSKBDDEVCF_CONSOLE_DEFAULT)
78
79#define wskbddevcf_mux cf_loc[WSKBDDEVCF_MUX]
80
81/*
82 * Autoconfiguration helper functions.
83 */
84void wskbd_cnattach(const struct wskbd_consops *, void *,
85 const struct wskbd_mapdata *);
86void wskbd_cndetach(void);
87int wskbddevprint(void *, const char *);
88
89/*
90 * Callbacks from the keyboard driver to the wskbd interface driver.
91 */
92void wskbd_input(device_t, u_int, int);
93/* for WSDISPLAY_COMPAT_RAWKBD */
94void wskbd_rawinput(device_t, u_char *, int);
95
96/*
97 * Callbacks for (ACPI) hotkey drivers which generate
98 * keycodes.
99 */
100struct wskbd_softc;
101typedef int (wskbd_hotkey_plugin)(struct wskbd_softc *, void *, u_int, int);
102
103device_t wskbd_hotkey_register(device_t, void *, wskbd_hotkey_plugin *);
104void wskbd_hotkey_deregister(device_t);
105
106/*
107 * set a translation table for scancodes in event mode
108 * parameters are a pointer to the table and its length
109 * pass length zero to turn translation off
110 */
111void wskbd_set_evtrans(device_t, keysym_t *, int);
112
113/*
114 * Console interface.
115 */
116int wskbd_cngetc(dev_t);
117void wskbd_cnpollc(dev_t, int);
118void wskbd_cnbell(dev_t, u_int, u_int, u_int);
119