Subversion Repositories HelenOS

Rev

Rev 2071 | Rev 2321 | Go to most recent revision | Blame | Compare with Previous | 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 <cpu.h>
  45. #include <arch/asm.h>
  46. #include <arch.h>
  47. #include <console/chardev.h>
  48. #include <console/console.h>
  49. #include <interrupt.h>
  50. #include <sysinfo/sysinfo.h>
  51. #include <ipc/irq.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. static chardev_operations_t ops = {
  84.     .suspend = i8042_suspend,
  85.     .resume = i8042_resume,
  86.     .read = i8042_key_read
  87. };
  88.  
  89. /** Structure for i8042's IRQ. */
  90. static irq_t i8042_kbd_irq;
  91. static irq_t i8042_mouse_irq;
  92.  
  93. /** Wait until the controller reads its data. */
  94. static void i8042_wait(void) {
  95.     while (i8042_status_read() & i8042_WAIT_MASK) {
  96.         /* wait */
  97.     }
  98. }
  99.  
  100. void i8042_grab(void)
  101. {
  102.     ipl_t ipl = interrupts_disable();
  103.    
  104.     i8042_wait();
  105.     i8042_command_write(i8042_SET_COMMAND);
  106.     i8042_wait();
  107.     i8042_data_write(i8042_COMMAND);
  108.     i8042_wait();
  109.  
  110.     spinlock_lock(&i8042_kbd_irq.lock);
  111.     i8042_kbd_irq.notif_cfg.notify = false;
  112.     spinlock_unlock(&i8042_kbd_irq.lock);
  113.    
  114.     spinlock_lock(&i8042_mouse_irq.lock);
  115.     i8042_mouse_irq.notif_cfg.notify = false;
  116.     spinlock_unlock(&i8042_mouse_irq.lock);
  117.    
  118.     interrupts_restore(ipl);
  119. }
  120.  
  121. void i8042_release(void)
  122. {
  123.     ipl_t ipl = interrupts_disable();
  124.    
  125.     spinlock_lock(&i8042_kbd_irq.lock);
  126.     if (i8042_kbd_irq.notif_cfg.answerbox)
  127.         i8042_kbd_irq.notif_cfg.notify = true;
  128.     spinlock_unlock(&i8042_kbd_irq.lock);
  129.    
  130.     spinlock_lock(&i8042_mouse_irq.lock);
  131.     if (i8042_mouse_irq.notif_cfg.answerbox)
  132.         i8042_mouse_irq.notif_cfg.notify = true;
  133.     spinlock_unlock(&i8042_mouse_irq.lock);
  134.    
  135.     interrupts_restore(ipl);
  136. }
  137.  
  138. static irq_ownership_t i8042_claim(void)
  139. {
  140.     return IRQ_ACCEPT;
  141. }
  142.  
  143. static void i8042_kbd_irq_handler(irq_t *irq, void *arg, ...)
  144. {
  145.     if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)
  146.         ipc_irq_send_notif(irq);
  147.     else {
  148.         uint8_t x;
  149.         uint8_t status;
  150.        
  151.         while (((status = i8042_status_read()) & i8042_BUFFER_FULL_MASK)) {
  152.             x = i8042_data_read();
  153.            
  154.             if ((status & i8042_MOUSE_DATA))
  155.                 continue;
  156.            
  157.             if (x & KEY_RELEASE)
  158.                 key_released(x ^ KEY_RELEASE);
  159.             else
  160.                 key_pressed(x);
  161.         }
  162.     }
  163. }
  164.  
  165. static void i8042_mouse_irq_handler(irq_t *irq, void *arg, ...)
  166. {
  167.     if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)
  168.         ipc_irq_send_notif(irq);
  169. }
  170.  
  171. /** Initialize i8042. */
  172. void i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno, inr_t mouse_inr)
  173. {
  174.     chardev_initialize("i8042_kbd", &kbrd, &ops);
  175.     stdin = &kbrd;
  176.    
  177.     irq_initialize(&i8042_kbd_irq);
  178.     i8042_kbd_irq.devno = kbd_devno;
  179.     i8042_kbd_irq.inr = kbd_inr;
  180.     i8042_kbd_irq.claim = i8042_claim;
  181.     i8042_kbd_irq.handler = i8042_kbd_irq_handler;
  182.     irq_register(&i8042_kbd_irq);
  183.    
  184.     irq_initialize(&i8042_mouse_irq);
  185.     i8042_mouse_irq.devno = mouse_devno;
  186.     i8042_mouse_irq.inr = mouse_inr;
  187.     i8042_mouse_irq.claim = i8042_claim;
  188.     i8042_mouse_irq.handler = i8042_mouse_irq_handler;
  189.     irq_register(&i8042_mouse_irq);
  190.    
  191.     trap_virtual_enable_irqs(1 << kbd_inr);
  192.     trap_virtual_enable_irqs(1 << mouse_inr);
  193.    
  194.     /*
  195.      * Clear input buffer.
  196.      * Number of iterations is limited to prevent infinite looping.
  197.      */
  198.     int i;
  199.     for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {
  200.         i8042_data_read();
  201.     }
  202.    
  203.     sysinfo_set_item_val("kbd", NULL, true);
  204.     sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
  205.     sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
  206.    
  207.     sysinfo_set_item_val("mouse", NULL, true);
  208.     sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
  209.     sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
  210.    
  211.     i8042_grab();
  212. }
  213.  
  214. /* Called from getc(). */
  215. void i8042_resume(chardev_t *d)
  216. {
  217. }
  218.  
  219. /* Called from getc(). */
  220. void i8042_suspend(chardev_t *d)
  221. {
  222. }
  223.  
  224. char i8042_key_read(chardev_t *d)
  225. {
  226.     char ch;   
  227.  
  228.     while(!(ch = active_read_buff_read())) {
  229.         uint8_t x;
  230.         while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK))
  231.             ;
  232.         x = i8042_data_read();
  233.         if (x & KEY_RELEASE)
  234.             key_released(x ^ KEY_RELEASE);
  235.         else
  236.             active_read_key_pressed(x);
  237.     }
  238.     return ch;
  239. }
  240.  
  241. /** Poll for key press and release events.
  242.  *
  243.  * This function can be used to implement keyboard polling.
  244.  */
  245. void i8042_poll(void)
  246. {
  247.     uint8_t x;
  248.  
  249.     while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
  250.         x = i8042_data_read();
  251.         if (x & KEY_RELEASE)
  252.             key_released(x ^ KEY_RELEASE);
  253.         else
  254.             key_pressed(x);
  255.     }
  256. }
  257.  
  258. /** @}
  259.  */
  260.