1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SYS_KBTRANS_H
#define _SYS_KBTRANS_H
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* Interface between hardware keyboard driver and generic keyboard
* translation module.
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/consdev.h>
/*
* The default value (0) indicates that the keyboard layout isn't
* configured in kernel.
*/
#define KBTRANS_USBKB_DEFAULT_LAYOUT 0
/*
* Maximum of keys in a keyboard
*/
#define KBTRANS_KEYNUMS_MAX 255
/*
* Do not expose the internals of these structures to kbtrans clients
*/
struct kbtrans_hardware;
struct kbtrans;
enum kbtrans_message_response {
KBTRANS_MESSAGE_HANDLED = 0,
KBTRANS_MESSAGE_NOT_HANDLED = 1
};
typedef boolean_t (*polled_keycode_func)(struct kbtrans_hardware *,
kbtrans_key_t *, enum keystate *);
struct hw_polledio {
void *polled_argument;
polled_keycode_func *polled_keycode;
};
/*
* Callbacks registered by the hardware specific driver/module
*/
struct kbtrans_callbacks {
/* Routine to set the LED's in non-polled mode */
void (*kbtrans_streams_setled)(struct kbtrans_hardware *, int);
/* Routine to set the LED's in polled mode */
void (*kbtrans_polled_setled)(struct kbtrans_hardware *, int);
/* Routine to indicate that a scande is available in polled mode */
boolean_t (*kbtrans_polled_keycheck)(struct kbtrans_hardware *,
kbtrans_key_t *, enum keystate *);
};
/*
* kbtrans_streams_init():
*
* Initializes the generic keyboard translation module. Must be
* called from the hardware module's open(9e) routine.
*
* Arguments:
* - queue_t *q
* The read queue.
*
* - int sflag
* sflag from the streams open routine
*
* - cred_t *crp
* credentials from open
*
* - struct kbtrans_hardware *hw
* hardware-specific data, passed to hardware callbacks
*
* - struct kbtrans_callbacks *hw_callbacks
* hardware support callbacks (see below)
*
* - struct kbtrans **kbtrans
* returned state structure pointer
*
* - int initial_leds
* - int initial_led_mask
* Provides state information (if available) about the current
* keyboard state, in the form of LED state. initial_leds shows
* which LEDs are lit; initial_led_mask shows which bits in
* initial_leds are valid. This mechanism exists primarily to
* retain the existing state of NumLock across the transition
* from firmware to the OS.
*/
extern int kbtrans_streams_init(queue_t *, int, cred_t *,
struct kbtrans_hardware *, struct kbtrans_callbacks *,
struct kbtrans **, int, int);
/*
* kbtrans_streams_fini():
*
* Shuts down the generic translation module. Must be called from
* the hardware module's close(9e) routine.
*/
extern int kbtrans_streams_fini(struct kbtrans *);
/*
* kbtrans_streams_message():
*
* The hardware module should pass all streams messages received from
* above to this routine. The generic translation module will process
* most of them, returning KBTRANS_MESSAGE_HANDLED for the ones that
* it has handled and KBTRANS_MESSAGE_NOT_HANDLED for the ones that
* it did not handle. For KBTRANS_MESSAGE_HANDLED, the hardware module
* should take no further action on the message. For
* KBTRANS_MESSAGE_NOT_HANDLED, the hardware module is responsible for
* any action, including returning an appropriate error.
*
* Must be called from the hardware module's write put(9e) or srv(9e)
* routine.
*/
extern enum kbtrans_message_response kbtrans_streams_message(struct kbtrans *,
mblk_t *);
/*
* kbtrans_streams_key():
*
* When a key is pressed or released, the hardware module should
* call kbtrans, passing the key number and its new
* state. kbtrans is responsible for autorepeat handling;
* the hardware module should report only actual press/release
* events, suppressing any hardware-generated autorepeat.
*/
extern void kbtrans_streams_key(struct kbtrans *, kbtrans_key_t key,
enum keystate state);
/*
* kbtrans_streams_set_keyboard():
*
* At any time after calling kbtrans_streams_init, the hardware
* module should make this call to report the type of keyboard
* attached. "type" is the keyboard type, typically KB_SUN4,
* KB_PC, or KB_USB.
*/
extern void kbtrans_streams_set_keyboard(struct kbtrans *, int,
struct keyboard *);
/*
* kbtrans_streams_has_reset():
*
* At any time between kbtrans_streams_init and kbtrans_streams_fini,
* the hardware module can call this routine to report that the
* keyboard has been reset, e.g. by being unplugged and reattached.
*
* This function is for use by keyboard devices that do not formally
* support hotplug. If the keyboard hardware spontaneously resets
* itself in a case other than hotplug, this routine is called to
* report the rest.
*
*/
extern void kbtrans_streams_has_reset(struct kbtrans *);
/*
* kbtrans_ischar():
* kbtrans_getchar():
*
* These routines are used for polled input, e.g. for kmdb or PROM
* input. Note that, with suitable casting, these routines are usable
* as CONSOPENPOLLEDIO routines.
*
* May only be called from single-threaded code, e.g. kmdb.
*/
extern boolean_t kbtrans_ischar(struct kbtrans *);
extern int kbtrans_getchar(struct kbtrans *);
/*
* kbtrans_streams_enable():
* Routine to be called from the hardware specific module when
* the stream is ready to take messages.
*/
extern void kbtrans_streams_enable(struct kbtrans *);
/*
* kbtrans_streams_setled():
* Routine to be called to only update the led state in kbtrans.
*/
extern void kbtrans_streams_setled(struct kbtrans *, int);
/*
* kbtrans_streams_releaseall():
* Release all the keys that are held down.
*/
extern void kbtrans_streams_releaseall(struct kbtrans *);
/*
* kbtrans_streams_set_queue():
* Change the queue above the device, to support multiplexors.
*/
extern void kbtrans_streams_set_queue(struct kbtrans *, queue_t *);
/*
* kbtrans_streams_get_queue():
* Retrieve the current queue above the device.
*/
extern queue_t *kbtrans_streams_get_queue(struct kbtrans *);
/*
* kbtrans_streams_untimeout():
* Clear timeout
*/
extern void kbtrans_streams_untimeout(struct kbtrans *);
#ifdef __cplusplus
}
#endif
#endif /* _SYS_KBTRANS_H */
|
