source: mainline/uspace/drv/char/i8042/i8042.c@ 60744cb

Last change on this file since 60744cb was 60744cb, checked in by Jiri Svoboda <jiri@…>, 14 months ago

Let driver specify any argument to IRQ handler

This allows the driver to register a single handler for multiple
interrupts and still distinguish between them. It also removes
the extra step of having to get softstate from ddf_dev_t.
  • Property mode set to 100644
File size: 11.0 KB
Line 
1/*
2 * Copyright (c) 2001-2004 Jakub Jermar
3 * Copyright (c) 2006 Josef Cejka
4 * Copyright (c) 2021 Jiri Svoboda
5 * Copyright (c) 2011 Jan Vesely
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * - Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * - Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * - The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32/** @addtogroup i8042
33 * @{
34 */
35
36/** @file
37 * @brief i8042 PS/2 port driver.
38 */
39
40#include <adt/circ_buf.h>
41#include <ddf/log.h>
42#include <ddf/interrupt.h>
43#include <ddi.h>
44#include <device/hw_res.h>
45#include <errno.h>
46#include <str_error.h>
47#include <inttypes.h>
48#include <io/chardev_srv.h>
49
50#include "i8042.h"
51
52/* Interesting bits for status register */
53#define i8042_OUTPUT_FULL 0x01
54#define i8042_INPUT_FULL 0x02
55#define i8042_AUX_DATA 0x20
56
57/* Command constants */
58#define i8042_CMD_WRITE_CMDB 0x60 /**< Write command byte */
59#define i8042_CMD_WRITE_AUX 0xd4 /**< Write aux device */
60
61/* Command byte fields */
62#define i8042_KBD_IE 0x01
63#define i8042_AUX_IE 0x02
64#define i8042_KBD_DISABLE 0x10
65#define i8042_AUX_DISABLE 0x20
66#define i8042_KBD_TRANSLATE 0x40 /* Use this to switch to XT scancodes */
67
68static void i8042_char_conn(ipc_call_t *, void *);
69static errno_t i8042_read(chardev_srv_t *, void *, size_t, size_t *,
70 chardev_flags_t);
71static errno_t i8042_write(chardev_srv_t *, const void *, size_t, size_t *);
72
73static chardev_ops_t i8042_chardev_ops = {
74 .read = i8042_read,
75 .write = i8042_write
76};
77
78static const irq_pio_range_t i8042_ranges[] = {
79 {
80 .base = 0,
81 .size = sizeof(i8042_regs_t)
82 }
83};
84
85/** i8042 Interrupt pseudo-code. */
86static const irq_cmd_t i8042_cmds[] = {
87 {
88 .cmd = CMD_PIO_READ_8,
89 .addr = NULL, /* will be patched in run-time */
90 .dstarg = 1
91 },
92 {
93 .cmd = CMD_AND,
94 .value = i8042_OUTPUT_FULL,
95 .srcarg = 1,
96 .dstarg = 3
97 },
98 {
99 .cmd = CMD_PREDICATE,
100 .value = 2,
101 .srcarg = 3
102 },
103 {
104 .cmd = CMD_PIO_READ_8,
105 .addr = NULL, /* will be patched in run-time */
106 .dstarg = 2
107 },
108 {
109 .cmd = CMD_ACCEPT
110 }
111};
112
113/** Wait until it is safe to write to the device. */
114static void wait_ready(i8042_t *dev)
115{
116 assert(dev);
117 while (pio_read_8(&dev->regs->status) & i8042_INPUT_FULL)
118 ;
119}
120
121/** Interrupt handler routine.
122 *
123 * Write new data to the corresponding buffer.
124 *
125 * @param call Pointer to call data.
126 * @param arg Argument (i8042_t *)
127 */
128static void i8042_irq_handler(ipc_call_t *call, void *arg)
129{
130 i8042_t *controller = (i8042_t *)arg;
131 errno_t rc;
132
133 const uint8_t status = ipc_get_arg1(call);
134 const uint8_t data = ipc_get_arg2(call);
135
136 i8042_port_t *port = (status & i8042_AUX_DATA) ?
137 controller->aux : controller->kbd;
138
139 fibril_mutex_lock(&port->buf_lock);
140
141 rc = circ_buf_push(&port->cbuf, &data);
142 if (rc != EOK)
143 ddf_msg(LVL_ERROR, "Buffer overrun");
144
145 fibril_mutex_unlock(&port->buf_lock);
146 fibril_condvar_broadcast(&port->buf_cv);
147
148 async_sess_t *parent_sess = ddf_dev_parent_sess_get(controller->dev);
149 hw_res_clear_interrupt(parent_sess, port->irq);
150}
151
152/** Initialize i8042 driver structure.
153 *
154 * @param dev Driver structure to initialize.
155 * @param regs I/O range of registers.
156 * @param irq_kbd IRQ for primary port.
157 * @param irq_mouse IRQ for aux port.
158 * @param ddf_dev DDF device structure of the device.
159 *
160 * @return Error code.
161 *
162 */
163errno_t i8042_init(i8042_t *dev, addr_range_t *regs, int irq_kbd,
164 int irq_mouse, ddf_dev_t *ddf_dev)
165{
166 const size_t range_count = sizeof(i8042_ranges) /
167 sizeof(irq_pio_range_t);
168 irq_pio_range_t ranges[range_count];
169 const size_t cmd_count = sizeof(i8042_cmds) / sizeof(irq_cmd_t);
170 irq_cmd_t cmds[cmd_count];
171 ddf_fun_t *kbd_fun;
172 ddf_fun_t *aux_fun;
173 i8042_regs_t *ar;
174
175 errno_t rc;
176 bool kbd_bound = false;
177 bool aux_bound = false;
178
179 dev->dev = ddf_dev;
180
181 if (regs->size < sizeof(i8042_regs_t)) {
182 rc = EINVAL;
183 goto error;
184 }
185
186 if (pio_enable_range(regs, (void **) &dev->regs) != 0) {
187 rc = EIO;
188 goto error;
189 }
190
191 kbd_fun = ddf_fun_create(ddf_dev, fun_inner, "ps2a");
192 if (kbd_fun == NULL) {
193 rc = ENOMEM;
194 goto error;
195 }
196
197 dev->kbd = ddf_fun_data_alloc(kbd_fun, sizeof(i8042_port_t));
198 if (dev->kbd == NULL) {
199 rc = ENOMEM;
200 goto error;
201 }
202
203 dev->kbd->fun = kbd_fun;
204 dev->kbd->ctl = dev;
205 chardev_srvs_init(&dev->kbd->cds);
206 dev->kbd->cds.ops = &i8042_chardev_ops;
207 dev->kbd->cds.sarg = dev->kbd;
208 dev->kbd->irq = irq_kbd;
209 fibril_mutex_initialize(&dev->kbd->buf_lock);
210 fibril_condvar_initialize(&dev->kbd->buf_cv);
211
212 rc = ddf_fun_add_match_id(dev->kbd->fun, "char/xtkbd", 90);
213 if (rc != EOK)
214 goto error;
215
216 aux_fun = ddf_fun_create(ddf_dev, fun_inner, "ps2b");
217 if (aux_fun == NULL) {
218 rc = ENOMEM;
219 goto error;
220 }
221
222 dev->aux = ddf_fun_data_alloc(aux_fun, sizeof(i8042_port_t));
223 if (dev->aux == NULL) {
224 rc = ENOMEM;
225 goto error;
226 }
227
228 dev->aux->fun = aux_fun;
229 dev->aux->ctl = dev;
230 chardev_srvs_init(&dev->aux->cds);
231 dev->aux->cds.ops = &i8042_chardev_ops;
232 dev->aux->cds.sarg = dev->aux;
233 dev->aux->irq = irq_mouse;
234 fibril_mutex_initialize(&dev->aux->buf_lock);
235 fibril_condvar_initialize(&dev->aux->buf_cv);
236
237 rc = ddf_fun_add_match_id(dev->aux->fun, "char/ps2mouse", 90);
238 if (rc != EOK)
239 goto error;
240
241 ddf_fun_set_conn_handler(dev->kbd->fun, i8042_char_conn);
242 ddf_fun_set_conn_handler(dev->aux->fun, i8042_char_conn);
243
244 circ_buf_init(&dev->kbd->cbuf, dev->kbd->buf_data, BUFFER_SIZE, 1);
245 circ_buf_init(&dev->aux->cbuf, dev->aux->buf_data, BUFFER_SIZE, 1);
246 fibril_mutex_initialize(&dev->write_guard);
247
248 rc = ddf_fun_bind(dev->kbd->fun);
249 if (rc != EOK) {
250 ddf_msg(LVL_ERROR, "Failed to bind keyboard function: %s.",
251 ddf_fun_get_name(dev->kbd->fun));
252 goto error;
253 }
254 kbd_bound = true;
255
256 rc = ddf_fun_bind(dev->aux->fun);
257 if (rc != EOK) {
258 ddf_msg(LVL_ERROR, "Failed to bind aux function: %s.",
259 ddf_fun_get_name(dev->aux->fun));
260 goto error;
261 }
262 aux_bound = true;
263
264 /* Disable kbd and aux */
265 wait_ready(dev);
266 pio_write_8(&dev->regs->status, i8042_CMD_WRITE_CMDB);
267 wait_ready(dev);
268 pio_write_8(&dev->regs->data, i8042_KBD_DISABLE | i8042_AUX_DISABLE);
269
270 /* Flush all current IO */
271 while (pio_read_8(&dev->regs->status) & i8042_OUTPUT_FULL)
272 (void) pio_read_8(&dev->regs->data);
273
274 memcpy(ranges, i8042_ranges, sizeof(i8042_ranges));
275 ranges[0].base = RNGABS(*regs);
276
277 ar = RNGABSPTR(*regs);
278 memcpy(cmds, i8042_cmds, sizeof(i8042_cmds));
279 cmds[0].addr = (void *) &ar->status;
280 cmds[3].addr = (void *) &ar->data;
281
282 irq_code_t irq_code = {
283 .rangecount = range_count,
284 .ranges = ranges,
285 .cmdcount = cmd_count,
286 .cmds = cmds
287 };
288
289 cap_irq_handle_t kbd_ihandle;
290 rc = register_interrupt_handler(ddf_dev, irq_kbd,
291 i8042_irq_handler, (void *)dev, &irq_code, &kbd_ihandle);
292 if (rc != EOK) {
293 ddf_msg(LVL_ERROR, "Failed set handler for kbd: %s.",
294 ddf_dev_get_name(ddf_dev));
295 goto error;
296 }
297
298 cap_irq_handle_t mouse_ihandle;
299 rc = register_interrupt_handler(ddf_dev, irq_mouse,
300 i8042_irq_handler, (void *)dev, &irq_code, &mouse_ihandle);
301 if (rc != EOK) {
302 ddf_msg(LVL_ERROR, "Failed set handler for mouse: %s.",
303 ddf_dev_get_name(ddf_dev));
304 goto error;
305 }
306
307 /* Enable interrupts */
308 async_sess_t *parent_sess = ddf_dev_parent_sess_get(ddf_dev);
309 assert(parent_sess != NULL);
310
311 rc = hw_res_enable_interrupt(parent_sess, irq_kbd);
312 if (rc != EOK) {
313 log_msg(LOG_DEFAULT, LVL_ERROR, "Failed to enable keyboard interrupt: %s.",
314 ddf_dev_get_name(ddf_dev));
315 rc = EIO;
316 goto error;
317 }
318
319 rc = hw_res_enable_interrupt(parent_sess, irq_mouse);
320 if (rc != EOK) {
321 log_msg(LOG_DEFAULT, LVL_ERROR, "Failed to enable mouse interrupt: %s.",
322 ddf_dev_get_name(ddf_dev));
323 rc = EIO;
324 goto error;
325 }
326
327 /* Enable port interrupts. */
328 wait_ready(dev);
329 pio_write_8(&dev->regs->status, i8042_CMD_WRITE_CMDB);
330 wait_ready(dev);
331 pio_write_8(&dev->regs->data, i8042_KBD_IE | i8042_KBD_TRANSLATE |
332 i8042_AUX_IE);
333
334 return EOK;
335error:
336 if (kbd_bound)
337 ddf_fun_unbind(dev->kbd->fun);
338 if (aux_bound)
339 ddf_fun_unbind(dev->aux->fun);
340 if (dev->kbd->fun != NULL)
341 ddf_fun_destroy(dev->kbd->fun);
342 if (dev->aux->fun != NULL)
343 ddf_fun_destroy(dev->aux->fun);
344
345 return rc;
346}
347
348/** Write data to i8042 port.
349 *
350 * @param srv Connection-specific data
351 * @param buffer Data source
352 * @param size Data size
353 * @param nwr Place to store number of bytes successfully written
354 *
355 * @return EOK on success or non-zero error code
356 *
357 */
358static errno_t i8042_write(chardev_srv_t *srv, const void *data, size_t size,
359 size_t *nwr)
360{
361 i8042_port_t *port = (i8042_port_t *)srv->srvs->sarg;
362 i8042_t *i8042 = port->ctl;
363 const char *dp = (const char *)data;
364
365 fibril_mutex_lock(&i8042->write_guard);
366
367 for (size_t i = 0; i < size; ++i) {
368 if (port == i8042->aux) {
369 wait_ready(i8042);
370 pio_write_8(&i8042->regs->status,
371 i8042_CMD_WRITE_AUX);
372 }
373
374 wait_ready(i8042);
375 pio_write_8(&i8042->regs->data, dp[i]);
376 }
377
378 fibril_mutex_unlock(&i8042->write_guard);
379 *nwr = size;
380 return EOK;
381}
382
383/** Read data from i8042 port.
384 *
385 * @param srv Connection-specific data
386 * @param buffer Data place
387 * @param size Data place size
388 * @param nread Place to store number of bytes successfully read
389 *
390 * @return EOK on success or non-zero error code
391 *
392 */
393static errno_t i8042_read(chardev_srv_t *srv, void *dest, size_t size,
394 size_t *nread, chardev_flags_t flags)
395{
396 i8042_port_t *port = (i8042_port_t *)srv->srvs->sarg;
397 size_t p;
398 uint8_t *destp = (uint8_t *)dest;
399 errno_t rc;
400
401 fibril_mutex_lock(&port->buf_lock);
402
403 while ((flags & chardev_f_nonblock) == 0 &&
404 circ_buf_nused(&port->cbuf) == 0)
405 fibril_condvar_wait(&port->buf_cv, &port->buf_lock);
406
407 p = 0;
408 while (p < size) {
409 rc = circ_buf_pop(&port->cbuf, &destp[p]);
410 if (rc != EOK)
411 break;
412 ++p;
413 }
414
415 fibril_mutex_unlock(&port->buf_lock);
416
417 *nread = p;
418 return EOK;
419}
420
421/** Handle data requests.
422 *
423 * @param call IPC request.
424 * @param arg ddf_fun_t function.
425 *
426 */
427void i8042_char_conn(ipc_call_t *icall, void *arg)
428{
429 i8042_port_t *port = ddf_fun_data_get((ddf_fun_t *)arg);
430
431 chardev_conn(icall, &port->cds);
432}
433
434/**
435 * @}
436 */
Note: See TracBrowser for help on using the repository browser.