Subversion Repositories HelenOS

Rev

Rev 1842 | Go to most recent revision | Blame | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2001-2004 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - 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.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup genarch
  30.  * @{
  31.  */
  32. /**
  33.  * @file
  34.  * @brief   i8042 processor driver.
  35.  *
  36.  * It takes care of low-level keyboard functions.
  37.  */
  38.  
  39. #include <genarch/kbd/i8042.h>
  40. #include <genarch/kbd/key.h>
  41. #include <genarch/kbd/scanc.h>
  42. #include <genarch/kbd/scanc_pc.h>
  43. #include <arch/drivers/i8042.h>
  44. #include <arch/interrupt.h>
  45. #include <cpu.h>
  46. #include <arch/asm.h>
  47. #include <arch.h>
  48. #include <typedefs.h>
  49. #include <console/chardev.h>
  50. #include <console/console.h>
  51. #include <interrupt.h>
  52.  
  53. /* Keyboard commands. */
  54. #define KBD_ENABLE  0xf4
  55. #define KBD_DISABLE 0xf5
  56. #define KBD_ACK     0xfa
  57.  
  58. /*
  59.  * 60  Write 8042 Command Byte: next data byte written to port 60h is
  60.  *     placed in 8042 command register. Format:
  61.  *
  62.  *    |7|6|5|4|3|2|1|0|8042 Command Byte
  63.  *     | | | | | | | `---- 1=enable output register full interrupt
  64.  *     | | | | | | `----- should be 0
  65.  *     | | | | | `------ 1=set status register system, 0=clear
  66.  *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
  67.  *     | | | `-------- disable keyboard I/O by driving clock line low
  68.  *     | | `--------- disable auxiliary device, drives clock line low
  69.  *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
  70.  *     `----------- reserved, should be 0
  71.  */
  72.  
  73. #define i8042_SET_COMMAND   0x60
  74. #define i8042_COMMAND       0x69
  75.  
  76. #define i8042_BUFFER_FULL_MASK  0x01
  77. #define i8042_WAIT_MASK     0x02
  78. #define i8042_MOUSE_DATA        0x20
  79.  
  80. static void i8042_suspend(chardev_t *);
  81. static void i8042_resume(chardev_t *);
  82.  
  83. chardev_t kbrd;
  84. static chardev_operations_t ops = {
  85.     .suspend = i8042_suspend,
  86.     .resume = i8042_resume,
  87.     .read = key_read
  88. };
  89.  
  90. static void i8042_interrupt(int n, istate_t *istate);
  91. static void i8042_wait(void);
  92.  
  93. static iroutine oldvector;
  94. /** Initialize keyboard and service interrupts using kernel routine */
  95. void i8042_grab(void)
  96. {
  97.     oldvector = exc_register(VECTOR_KBD, "i8042_interrupt", (iroutine) i8042_interrupt);
  98.     i8042_wait();
  99.     i8042_command_write(i8042_SET_COMMAND);
  100.     i8042_wait();
  101.     i8042_data_write(i8042_COMMAND);
  102.     i8042_wait();
  103. }
  104. /** Resume the former interrupt vector */
  105. void i8042_release(void)
  106. {
  107.     if (oldvector)
  108.         exc_register(VECTOR_KBD, "user_interrupt", oldvector);
  109. }
  110.  
  111. /** Initialize i8042. */
  112. void i8042_init(void)
  113. {
  114.     int i;
  115.  
  116.     i8042_grab();
  117.         /* Prevent user from accidentaly releasing calling i8042_resume
  118.      * and disabling keyboard
  119.      */
  120.     oldvector = NULL;
  121.  
  122.     trap_virtual_enable_irqs(1<<IRQ_KBD);
  123.     chardev_initialize("i8042_kbd", &kbrd, &ops);
  124.     stdin = &kbrd;
  125.  
  126.     /*
  127.      * Clear input buffer.
  128.      * Number of iterations is limited to prevent infinite looping.
  129.      */
  130.     for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {
  131.         i8042_data_read();
  132.     }  
  133. }
  134.  
  135. /** Process i8042 interrupt.
  136.  *
  137.  * @param n Interrupt vector.
  138.  * @param istate Interrupted state.
  139.  */
  140. void i8042_interrupt(int n, istate_t *istate)
  141. {
  142.     uint8_t x;
  143.     uint8_t status;
  144.  
  145.     while (((status=i8042_status_read()) & i8042_BUFFER_FULL_MASK)) {
  146.         x = i8042_data_read();
  147.  
  148.         if ((status & i8042_MOUSE_DATA))
  149.             continue;
  150.  
  151.         if (x & KEY_RELEASE)
  152.             key_released(x ^ KEY_RELEASE);
  153.         else
  154.             key_pressed(x);
  155.     }
  156.     trap_virtual_eoi();
  157. }
  158.  
  159. /** Wait until the controller reads its data. */
  160. void i8042_wait(void) {
  161.     while (i8042_status_read() & i8042_WAIT_MASK) {
  162.         /* wait */
  163.     }
  164. }
  165.  
  166. /* Called from getc(). */
  167. void i8042_resume(chardev_t *d)
  168. {
  169. }
  170.  
  171. /* Called from getc(). */
  172. void i8042_suspend(chardev_t *d)
  173. {
  174. }
  175.  
  176. char key_read(chardev_t *d)
  177. {
  178.     char ch;   
  179.  
  180.     while(!(ch = active_read_buff_read())) {
  181.         uint8_t x;
  182.         while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK))
  183.             ;
  184.         x = i8042_data_read();
  185.         if (x & KEY_RELEASE)
  186.             key_released(x ^ KEY_RELEASE);
  187.         else
  188.             active_read_key_pressed(x);
  189.     }
  190.     return ch;
  191. }
  192.  
  193. /** Poll for key press and release events.
  194.  *
  195.  * This function can be used to implement keyboard polling.
  196.  */
  197. void i8042_poll(void)
  198. {
  199.     uint8_t x;
  200.  
  201.     while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
  202.         x = i8042_data_read();
  203.         if (x & KEY_RELEASE)
  204.             key_released(x ^ KEY_RELEASE);
  205.         else
  206.             key_pressed(x);
  207.     }
  208. }
  209.  
  210. /** @}
  211.  */
  212.