drivers/input/i8042.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2002 ELTEC Elektronik AG
   4  * Frank Gottschling <fgottschling@eltec.de>
   5  */
   6
   7 /* i8042.c - Intel 8042 keyboard driver routines */
   8
   9 #include <common.h>
  10 #include <dm.h>
  11 #include <env.h>
  12 #include <errno.h>
  13 #include <i8042.h>
  14 #include <input.h>
  15 #include <keyboard.h>
  16 #include <log.h>
  17 #include <asm/io.h>
  18 #include <linux/delay.h>
  19
  20 DECLARE_GLOBAL_DATA_PTR;
  21
  22 /* defines */
  23 #define in8(p)          inb(p)
  24 #define out8(p, v)      outb(v, p)
  25
  26 enum {
  27         QUIRK_DUP_POR   = 1 << 0,
  28 };
  29
  30 /* locals */
  31 struct i8042_kbd_priv {
  32         bool extended;  /* true if an extended keycode is expected next */
  33         int quirks;     /* quirks that we support */
  34 };
  35
  36 static unsigned char ext_key_map[] = {
  37         0x1c, /* keypad enter */
  38         0x1d, /* right control */
  39         0x35, /* keypad slash */
  40         0x37, /* print screen */
  41         0x38, /* right alt */
  42         0x46, /* break */
  43         0x47, /* editpad home */
  44         0x48, /* editpad up */
  45         0x49, /* editpad pgup */
  46         0x4b, /* editpad left */
  47         0x4d, /* editpad right */
  48         0x4f, /* editpad end */
  49         0x50, /* editpad dn */
  50         0x51, /* editpad pgdn */
  51         0x52, /* editpad ins */
  52         0x53, /* editpad del */
  53         0x00  /* map end */
  54         };
  55
  56 static int kbd_input_empty(void)
  57 {
  58         int kbd_timeout = KBD_TIMEOUT * 1000;
  59
  60         while ((in8(I8042_STS_REG) & STATUS_IBF) && kbd_timeout--)
  61                 udelay(1);
  62
  63         return kbd_timeout != -1;
  64 }
  65
  66 static int kbd_output_full(void)
  67 {
  68         int kbd_timeout = KBD_TIMEOUT * 1000;
  69
  70         while (((in8(I8042_STS_REG) & STATUS_OBF) == 0) && kbd_timeout--)
  71                 udelay(1);
  72
  73         return kbd_timeout != -1;
  74 }
  75
  76 /**
  77  * check_leds() - Check the keyboard LEDs and update them it needed
  78  *
  79  * @ret:        Value to return
  80  * @return value of @ret
  81  */
  82 static int i8042_kbd_update_leds(struct udevice *dev, int leds)
  83 {
  84         kbd_input_empty();
  85         out8(I8042_DATA_REG, CMD_SET_KBD_LED);
  86         kbd_input_empty();
  87         out8(I8042_DATA_REG, leds & 0x7);
  88
  89         return 0;
  90 }
  91
  92 static int kbd_write(int reg, int value)
  93 {
  94         if (!kbd_input_empty())
  95                 return -1;
  96         out8(reg, value);
  97
  98         return 0;
  99 }
 100
 101 static int kbd_read(int reg)
 102 {
 103         if (!kbd_output_full())
 104                 return -1;
 105
 106         return in8(reg);
 107 }
 108
 109 static int kbd_cmd_read(int cmd)
 110 {
 111         if (kbd_write(I8042_CMD_REG, cmd))
 112                 return -1;
 113
 114         return kbd_read(I8042_DATA_REG);
 115 }
 116
 117 static int kbd_cmd_write(int cmd, int data)
 118 {
 119         if (kbd_write(I8042_CMD_REG, cmd))
 120                 return -1;
 121
 122         return kbd_write(I8042_DATA_REG, data);
 123 }
 124
 125 static int kbd_reset(int quirk)
 126 {
 127         int config;
 128
 129         /* controller self test */
 130         if (kbd_cmd_read(CMD_SELF_TEST) != KBC_TEST_OK)
 131                 goto err;
 132
 133         /* keyboard reset */
 134         if (kbd_write(I8042_DATA_REG, CMD_RESET_KBD) ||
 135             kbd_read(I8042_DATA_REG) != KBD_ACK ||
 136             kbd_read(I8042_DATA_REG) != KBD_POR)
 137                 goto err;
 138
 139         if (kbd_write(I8042_DATA_REG, CMD_DRAIN_OUTPUT) ||
 140             kbd_read(I8042_DATA_REG) != KBD_ACK)
 141                 goto err;
 142
 143         /* set AT translation and disable irq */
 144         config = kbd_cmd_read(CMD_RD_CONFIG);
 145         if (config == -1)
 146                 goto err;
 147
 148         /* Sometimes get a second byte */
 149         else if ((quirk & QUIRK_DUP_POR) && config == KBD_POR)
 150                 config = kbd_cmd_read(CMD_RD_CONFIG);
 151
 152         config |= CONFIG_AT_TRANS;
 153         config &= ~(CONFIG_KIRQ_EN | CONFIG_MIRQ_EN);
 154         if (kbd_cmd_write(CMD_WR_CONFIG, config))
 155                 goto err;
 156
 157         /* enable keyboard */
 158         if (kbd_write(I8042_CMD_REG, CMD_KBD_EN) ||
 159             !kbd_input_empty())
 160                 goto err;
 161
 162         return 0;
 163 err:
 164         debug("%s: Keyboard failure\n", __func__);
 165         return -1;
 166 }
 167
 168 static int kbd_controller_present(void)
 169 {
 170         return in8(I8042_STS_REG) != 0xff;
 171 }
 172
 173 /** Flush all buffer from keyboard controller to host*/
 174 static void i8042_flush(void)
 175 {
 176         int timeout;
 177
 178         /*
 179          * The delay is to give the keyboard controller some time
 180          * to fill the next byte.
 181          */
 182         while (1) {
 183                 timeout = 100;  /* wait for no longer than 100us */
 184                 while (timeout > 0 && !(in8(I8042_STS_REG) & STATUS_OBF)) {
 185                         udelay(1);
 186                         timeout--;
 187                 }
 188
 189                 /* Try to pull next byte if not timeout */
 190                 if (in8(I8042_STS_REG) & STATUS_OBF)
 191                         in8(I8042_DATA_REG);
 192                 else
 193                         break;
 194         }
 195 }
 196
 197 /**
 198  * Disables the keyboard so that key strokes no longer generate scancodes to
 199  * the host.
 200  *
 201  * @return 0 if ok, -1 if keyboard input was found while disabling
 202  */
 203 static int i8042_disable(void)
 204 {
 205         if (kbd_input_empty() == 0)
 206                 return -1;
 207
 208         /* Disable keyboard */
 209         out8(I8042_CMD_REG, CMD_KBD_DIS);
 210
 211         if (kbd_input_empty() == 0)
 212                 return -1;
 213
 214         return 0;
 215 }
 216
 217 static int i8042_kbd_check(struct input_config *input)
 218 {
 219         struct i8042_kbd_priv *priv = dev_get_priv(input->dev);
 220
 221         if ((in8(I8042_STS_REG) & STATUS_OBF) == 0) {
 222                 return 0;
 223         } else {
 224                 bool release = false;
 225                 int scan_code;
 226                 int i;
 227
 228                 scan_code = in8(I8042_DATA_REG);
 229                 if (scan_code == 0xfa) {
 230                         return 0;
 231                 } else if (scan_code == 0xe0) {
 232                         priv->extended = true;
 233                         return 0;
 234                 }
 235                 if (scan_code & 0x80) {
 236                         scan_code &= 0x7f;
 237                         release = true;
 238                 }
 239                 if (priv->extended) {
 240                         priv->extended = false;
 241                         for (i = 0; ext_key_map[i]; i++) {
 242                                 if (ext_key_map[i] == scan_code) {
 243                                         scan_code = 0x60 + i;
 244                                         break;
 245                                 }
 246                         }
 247                         /* not found ? */
 248                         if (!ext_key_map[i])
 249                                 return 0;
 250                 }
 251
 252                 input_add_keycode(input, scan_code, release);
 253                 return 1;
 254         }
 255 }
 256
 257 /* i8042_kbd_init - reset keyboard and init state flags */
 258 static int i8042_start(struct udevice *dev)
 259 {
 260         struct keyboard_priv *uc_priv = dev_get_uclass_priv(dev);
 261         struct i8042_kbd_priv *priv = dev_get_priv(dev);
 262         struct input_config *input = &uc_priv->input;
 263         int keymap, try;
 264         char *penv;
 265         int ret;
 266
 267         if (!kbd_controller_present()) {
 268                 debug("i8042 keyboard controller is not present\n");
 269                 return -ENOENT;
 270         }
 271
 272         /* Init keyboard device (default US layout) */
 273         keymap = KBD_US;
 274         penv = env_get("keymap");
 275         if (penv != NULL) {
 276                 if (strncmp(penv, "de", 3) == 0)
 277                         keymap = KBD_GER;
 278         }
 279
 280         for (try = 0; kbd_reset(priv->quirks) != 0; try++) {
 281                 if (try >= KBD_RESET_TRIES)
 282                         return -1;
 283         }
 284
 285         ret = input_add_tables(input, keymap == KBD_GER);
 286         if (ret)
 287                 return ret;
 288
 289         i8042_kbd_update_leds(dev, NORMAL);
 290         debug("%s: started\n", __func__);
 291
 292         return 0;
 293 }
 294
 295 static int i8042_kbd_remove(struct udevice *dev)
 296 {
 297         if (i8042_disable())
 298                 log_debug("i8042_disable() failed. fine, continue.\n");
 299         i8042_flush();
 300
 301         return 0;
 302 }
 303
 304 /**
 305  * Set up the i8042 keyboard. This is called by the stdio device handler
 306  *
 307  * We want to do this init when the keyboard is actually used rather than
 308  * at start-up, since keyboard input may not currently be selected.
 309  *
 310  * Once the keyboard starts there will be a period during which we must
 311  * wait for the keyboard to init. We do this only when a key is first
 312  * read - see kbd_wait_for_fifo_init().
 313  *
 314  * @return 0 if ok, -ve on error
 315  */
 316 static int i8042_kbd_probe(struct udevice *dev)
 317 {
 318         struct keyboard_priv *uc_priv = dev_get_uclass_priv(dev);
 319         struct i8042_kbd_priv *priv = dev_get_priv(dev);
 320         struct stdio_dev *sdev = &uc_priv->sdev;
 321         struct input_config *input = &uc_priv->input;
 322         int ret;
 323
 324         if (fdtdec_get_bool(gd->fdt_blob, dev_of_offset(dev),
 325                             "intel,duplicate-por"))
 326                 priv->quirks |= QUIRK_DUP_POR;
 327
 328         /* Register the device. i8042_start() will be called soon */
 329         input->dev = dev;
 330         input->read_keys = i8042_kbd_check;
 331         input_allow_repeats(input, true);
 332         strcpy(sdev->name, "i8042-kbd");
 333         ret = input_stdio_register(sdev);
 334         if (ret) {
 335                 debug("%s: input_stdio_register() failed\n", __func__);
 336                 return ret;
 337         }
 338         debug("%s: ready\n", __func__);
 339
 340         return 0;
 341 }
 342
 343 static const struct keyboard_ops i8042_kbd_ops = {
 344         .start  = i8042_start,
 345         .update_leds    = i8042_kbd_update_leds,
 346 };
 347
 348 static const struct udevice_id i8042_kbd_ids[] = {
 349         { .compatible = "intel,i8042-keyboard" },
 350         { }
 351 };
 352
 353 U_BOOT_DRIVER(i8042_kbd) = {
 354         .name   = "i8042_kbd",
 355         .id     = UCLASS_KEYBOARD,
 356         .of_match = i8042_kbd_ids,
 357         .probe = i8042_kbd_probe,
 358         .remove = i8042_kbd_remove,
 359         .ops    = &i8042_kbd_ops,
 360         .priv_auto_alloc_size = sizeof(struct i8042_kbd_priv),
 361 };