Subversion Repositories HelenOS

Rev

Rev 4342 | 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 <arch/drivers/kbd.h>
  41. #include <genarch/kbd/key.h>
  42. #include <genarch/kbd/scanc.h>
  43. #include <genarch/kbd/scanc_pc.h>
  44. #include <arch/drivers/i8042.h>
  45. #include <cpu.h>
  46. #include <arch/asm.h>
  47. #include <arch.h>
  48. #include <console/chardev.h>
  49. #include <console/console.h>
  50. #include <interrupt.h>
  51. #include <sysinfo/sysinfo.h>
  52. #include <ipc/irq.h>
  53.  
  54. /* Keyboard commands. */
  55. #define KBD_ENABLE  0xf4
  56. #define KBD_DISABLE 0xf5
  57. #define KBD_ACK     0xfa
  58.  
  59. /*
  60.  * 60  Write 8042 Command Byte: next data byte written to port 60h is
  61.  *     placed in 8042 command register. Format:
  62.  *
  63.  *    |7|6|5|4|3|2|1|0|8042 Command Byte
  64.  *     | | | | | | | `---- 1=enable output register full interrupt
  65.  *     | | | | | | `----- should be 0
  66.  *     | | | | | `------ 1=set status register system, 0=clear
  67.  *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
  68.  *     | | | `-------- disable keyboard I/O by driving clock line low
  69.  *     | | `--------- disable auxiliary device, drives clock line low
  70.  *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
  71.  *     `----------- reserved, should be 0
  72.  */
  73.  
  74. #define i8042_SET_COMMAND   0x60
  75. #define i8042_COMMAND       0x69
  76.  
  77. #define i8042_BUFFER_FULL_MASK  0x01
  78. #define i8042_WAIT_MASK         0x02
  79. #define i8042_MOUSE_DATA        0x20
  80.  
  81. static void i8042_suspend(chardev_t *);
  82. static void i8042_resume(chardev_t *);
  83.  
  84. static chardev_operations_t ops = {
  85.     .suspend = i8042_suspend,
  86.     .resume = i8042_resume,
  87.     .read = i8042_key_read
  88. };
  89.  
  90. /** Structure for i8042's IRQ. */
  91. static irq_t i8042_kbd_irq;
  92. static irq_t i8042_mouse_irq;
  93.  
  94. void i8042_grab(void)
  95. {
  96.     ipl_t ipl = interrupts_disable();
  97.    
  98.     spinlock_lock(&i8042_kbd_irq.lock);
  99.     i8042_kbd_irq.notif_cfg.notify = false;
  100.     spinlock_unlock(&i8042_kbd_irq.lock);
  101.    
  102.     spinlock_lock(&i8042_mouse_irq.lock);
  103.     i8042_mouse_irq.notif_cfg.notify = false;
  104.     spinlock_unlock(&i8042_mouse_irq.lock);
  105.    
  106.     interrupts_restore(ipl);
  107. }
  108.  
  109. void i8042_release(void)
  110. {
  111.     ipl_t ipl = interrupts_disable();
  112.    
  113.     spinlock_lock(&i8042_kbd_irq.lock);
  114.     if (i8042_kbd_irq.notif_cfg.answerbox)
  115.         i8042_kbd_irq.notif_cfg.notify = true;
  116.     spinlock_unlock(&i8042_kbd_irq.lock);
  117.    
  118.     spinlock_lock(&i8042_mouse_irq.lock);
  119.     if (i8042_mouse_irq.notif_cfg.answerbox)
  120.         i8042_mouse_irq.notif_cfg.notify = true;
  121.     spinlock_unlock(&i8042_mouse_irq.lock);
  122.    
  123.     interrupts_restore(ipl);
  124. }
  125.  
  126. static irq_ownership_t i8042_claim(void *instance)
  127. {
  128.     return IRQ_ACCEPT;
  129. }
  130.  
  131. static void i8042_irq_handler(irq_t *irq)
  132. {
  133.     if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)
  134.         ipc_irq_send_notif(irq);
  135.     else {
  136.         uint8_t data;
  137.         uint8_t status;
  138.        
  139.         while (((status = i8042_status_read()) & i8042_BUFFER_FULL_MASK)) {
  140.             data = i8042_data_read();
  141.            
  142.             if ((status & i8042_MOUSE_DATA))
  143.                 continue;
  144.  
  145.             if (data & KEY_RELEASE)
  146.                 key_released(data ^ KEY_RELEASE);
  147.             else
  148.                 key_pressed(data);
  149.         }
  150.     }
  151. }
  152.  
  153. /** Initialize i8042. */
  154. void i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno, inr_t mouse_inr)
  155. {
  156.     chardev_initialize("i8042_kbd", &kbrd, &ops);
  157.     stdin = &kbrd;
  158.    
  159.     irq_initialize(&i8042_kbd_irq);
  160.     i8042_kbd_irq.devno = kbd_devno;
  161.     i8042_kbd_irq.inr = kbd_inr;
  162.     i8042_kbd_irq.claim = i8042_claim;
  163.     i8042_kbd_irq.handler = i8042_irq_handler;
  164.     irq_register(&i8042_kbd_irq);
  165.    
  166.     irq_initialize(&i8042_mouse_irq);
  167.     i8042_mouse_irq.devno = mouse_devno;
  168.     i8042_mouse_irq.inr = mouse_inr;
  169.     i8042_mouse_irq.claim = i8042_claim;
  170.     i8042_mouse_irq.handler = i8042_irq_handler;
  171.     irq_register(&i8042_mouse_irq);
  172.    
  173.     trap_virtual_enable_irqs(1 << kbd_inr);
  174.     trap_virtual_enable_irqs(1 << mouse_inr);
  175.    
  176.     /*
  177.      * Clear input buffer.
  178.      * Number of iterations is limited to prevent infinite looping.
  179.      */
  180.     int i;
  181.     for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {
  182.         i8042_data_read();
  183.     }
  184.    
  185.     sysinfo_set_item_val("kbd", NULL, true);
  186.     sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
  187.     sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
  188. #ifdef KBD_LEGACY
  189.     sysinfo_set_item_val("kbd.type", NULL, KBD_LEGACY);
  190. #endif
  191.     sysinfo_set_item_val("mouse", NULL, true);
  192.     sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
  193.     sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
  194.    
  195.     i8042_grab();
  196. }
  197.  
  198. /* Called from getc(). */
  199. void i8042_resume(chardev_t *d)
  200. {
  201. }
  202.  
  203. /* Called from getc(). */
  204. void i8042_suspend(chardev_t *d)
  205. {
  206. }
  207.  
  208. char i8042_key_read(chardev_t *d)
  209. {
  210.     char ch;
  211.    
  212.     while (!(ch = active_read_buff_read())) {
  213.         uint8_t x;
  214.        
  215.         while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK));
  216.        
  217.         x = i8042_data_read();
  218.         if (x & KEY_RELEASE)
  219.             key_released(x ^ KEY_RELEASE);
  220.         else
  221.             active_read_key_pressed(x);
  222.     }
  223.     return ch;
  224. }
  225.  
  226. /** Poll for key press and release events.
  227.  *
  228.  * This function can be used to implement keyboard polling.
  229.  */
  230. void i8042_poll(void)
  231. {
  232.     uint8_t x;
  233.    
  234.     while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
  235.         x = i8042_data_read();
  236.         if (x & KEY_RELEASE)
  237.             key_released(x ^ KEY_RELEASE);
  238.         else
  239.             key_pressed(x);
  240.     }
  241. }
  242.  
  243. /** @}
  244.  */
  245.