Subversion Repositories HelenOS

Rev

Rev 3941 | Blame | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2001-2006 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   NS 16550 serial port / keyboard driver.
  35.  */
  36.  
  37. #include <genarch/kbd/ns16550.h>
  38. #include <genarch/kbd/key.h>
  39. #include <genarch/kbd/scanc.h>
  40. #include <genarch/kbd/scanc_sun.h>
  41. #include <arch/drivers/kbd.h>
  42. #include <ddi/irq.h>
  43. #include <cpu.h>
  44. #include <arch/asm.h>
  45. #include <arch.h>
  46. #include <console/chardev.h>
  47. #include <console/console.h>
  48. #include <interrupt.h>
  49. #include <arch/interrupt.h>
  50. #include <sysinfo/sysinfo.h>
  51. #include <synch/spinlock.h>
  52. #include <mm/slab.h>
  53.  
  54. #define LSR_DATA_READY  0x01
  55.  
  56. /*
  57.  * These codes read from ns16550 data register are silently ignored.
  58.  */
  59. #define IGNORE_CODE 0x7f        /* all keys up */
  60.  
  61. static void ns16550_suspend(chardev_t *);
  62. static void ns16550_resume(chardev_t *);
  63.  
  64. static chardev_operations_t ops = {
  65.     .suspend = ns16550_suspend,
  66.     .resume = ns16550_resume,
  67. };
  68.  
  69. /** Initialize ns16550.
  70.  *
  71.  * @param dev       Addrress of the beginning of the device in I/O space.
  72.  * @param devno     Device number.
  73.  * @param inr       Interrupt number.
  74.  * @param cir       Clear interrupt function.
  75.  * @param cir_arg   First argument to cir.
  76.  *
  77.  * @return      True on success, false on failure.
  78.  */
  79. bool
  80. ns16550_init(ns16550_t *dev, devno_t devno, inr_t inr, cir_t cir, void *cir_arg)
  81. {
  82.     ns16550_instance_t *instance;
  83.  
  84.     chardev_initialize("ns16550_kbd", &kbrd, &ops);
  85.     stdin = &kbrd;
  86.    
  87.     instance = malloc(sizeof(ns16550_instance_t), FRAME_ATOMIC);
  88.     if (!instance)
  89.         return false;
  90.  
  91.     instance->devno = devno;
  92.     instance->ns16550 = dev;
  93.    
  94.     irq_initialize(&instance->irq);
  95.     instance->irq.devno = devno;
  96.     instance->irq.inr = inr;
  97.     instance->irq.claim = ns16550_claim;
  98.     instance->irq.handler = ns16550_irq_handler;
  99.     instance->irq.instance = instance;
  100.     instance->irq.cir = cir;
  101.     instance->irq.cir_arg = cir_arg;
  102.     irq_register(&instance->irq);
  103.  
  104.     while ((pio_read_8(&dev->lsr) & LSR_DATA_READY))
  105.         (void) pio_read_8(&dev->rbr);
  106.    
  107.     /*
  108.      * This is the necessary evil until the userspace driver is entirely
  109.      * self-sufficient.
  110.      */
  111.     sysinfo_set_item_val("kbd", NULL, true);
  112.     sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
  113.     sysinfo_set_item_val("kbd.devno", NULL, devno);
  114.     sysinfo_set_item_val("kbd.inr", NULL, inr);
  115.     sysinfo_set_item_val("kbd.address.virtual", NULL, (uintptr_t) dev);
  116.     sysinfo_set_item_val("kbd.port", NULL, (uintptr_t) dev);
  117.    
  118.     /* Enable interrupts */
  119.     pio_write_8(&dev->ier, IER_ERBFI);
  120.     pio_write_8(&dev->mcr, MCR_OUT2);
  121.    
  122.     return true;
  123. }
  124.  
  125. /* Called from getc(). */
  126. void ns16550_resume(chardev_t *d)
  127. {
  128. }
  129.  
  130. /* Called from getc(). */
  131. void ns16550_suspend(chardev_t *d)
  132. {
  133. }
  134.  
  135. irq_ownership_t ns16550_claim(irq_t *irq)
  136. {
  137.     ns16550_instance_t *ns16550_instance = irq->instance;
  138.     ns16550_t *dev = ns16550_instance->ns16550;
  139.  
  140.     if (pio_read_8(&dev->lsr) & LSR_DATA_READY)
  141.         return IRQ_ACCEPT;
  142.     else
  143.         return IRQ_DECLINE;
  144. }
  145.  
  146. void ns16550_irq_handler(irq_t *irq)
  147. {
  148.     ns16550_instance_t *ns16550_instance = irq->instance;
  149.     ns16550_t *dev = ns16550_instance->ns16550;
  150.  
  151.     if (pio_read_8(&dev->lsr) & LSR_DATA_READY) {
  152.         uint8_t x;
  153.        
  154.         x = pio_read_8(&dev->rbr);
  155.        
  156.         if (x != IGNORE_CODE) {
  157.             if (x & KEY_RELEASE)
  158.                 key_released(x ^ KEY_RELEASE);
  159.             else
  160.                 key_pressed(x);
  161.         }
  162.     }
  163.  
  164. }
  165.  
  166. /** @}
  167.  */
  168.