Subversion Repositories HelenOS

Rev

Rev 3593 | Go to most recent revision | Blame | Compare with Previous | 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. #ifndef ia64
  43. #include <arch/drivers/ns16550.h>
  44. #endif
  45. #include <ddi/irq.h>
  46. #include <ipc/irq.h>
  47. #include <cpu.h>
  48. #include <arch/asm.h>
  49. #include <arch.h>
  50. #include <console/chardev.h>
  51. #include <console/console.h>
  52. #include <interrupt.h>
  53. #include <arch/interrupt.h>
  54. #include <sysinfo/sysinfo.h>
  55. #include <synch/spinlock.h>
  56.  
  57. #define LSR_DATA_READY  0x01
  58.  
  59. /** Structure representing the ns16550. */
  60. static ns16550_t ns16550;
  61.  
  62. /** Structure for ns16550's IRQ. */
  63. static irq_t ns16550_irq;
  64.  
  65. /*
  66.  * These codes read from ns16550 data register are silently ignored.
  67.  */
  68. #define IGNORE_CODE 0x7f        /* all keys up */
  69.  
  70. static void ns16550_suspend(chardev_t *);
  71. static void ns16550_resume(chardev_t *);
  72.  
  73. static chardev_operations_t ops = {
  74.     .suspend = ns16550_suspend,
  75.     .resume = ns16550_resume,
  76.     .read = ns16550_key_read
  77. };
  78.  
  79. void ns16550_interrupt(void);
  80.  
  81. /** Initialize keyboard and service interrupts using kernel routine */
  82. void ns16550_grab(void)
  83. {
  84.     ipl_t ipl = interrupts_disable();
  85.  
  86.     ns16550_ier_write(&ns16550, IER_ERBFI);     /* enable receiver interrupt */
  87.    
  88.     while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)
  89.         (void) ns16550_rbr_read(&ns16550);
  90.  
  91.     spinlock_lock(&ns16550_irq.lock);
  92.     ns16550_irq.notif_cfg.notify = false;
  93.     spinlock_unlock(&ns16550_irq.lock);
  94.     interrupts_restore(ipl);
  95. }
  96.  
  97. /** Resume the former interrupt vector */
  98. void ns16550_release(void)
  99. {
  100.     ipl_t ipl = interrupts_disable();
  101.     spinlock_lock(&ns16550_irq.lock);
  102.     if (ns16550_irq.notif_cfg.answerbox)
  103.         ns16550_irq.notif_cfg.notify = true;
  104.     spinlock_unlock(&ns16550_irq.lock);
  105.     interrupts_restore(ipl);
  106. }
  107.  
  108. /** Initialize ns16550.
  109.  *
  110.  * @param devno     Device number.
  111.  * @param port      Virtual/IO address of device's registers.
  112.  * @param inr       Interrupt number.
  113.  * @param cir       Clear interrupt function.
  114.  * @param cir_arg   First argument to cir.
  115.  */
  116. void
  117. ns16550_init(devno_t devno, ioport_t port, inr_t inr, cir_t cir, void *cir_arg)
  118. {
  119.     chardev_initialize("ns16550_kbd", &kbrd, &ops);
  120.     stdin = &kbrd;
  121.    
  122.     ns16550.devno = devno;
  123.     ns16550.io_port = port;
  124.    
  125.     irq_initialize(&ns16550_irq);
  126.     ns16550_irq.devno = devno;
  127.     ns16550_irq.inr = inr;
  128.     ns16550_irq.claim = ns16550_claim;
  129.     ns16550_irq.handler = ns16550_irq_handler;
  130.     ns16550_irq.cir = cir;
  131.     ns16550_irq.cir_arg = cir_arg;
  132.     irq_register(&ns16550_irq);
  133.  
  134.  
  135.     while ((ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
  136.         ns16550_rbr_read(&ns16550);
  137.  
  138.    
  139.     sysinfo_set_item_val("kbd", NULL, true);
  140.     sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
  141.     sysinfo_set_item_val("kbd.devno", NULL, devno);
  142.     sysinfo_set_item_val("kbd.inr", NULL, inr);
  143.     sysinfo_set_item_val("kbd.address.virtual", NULL, port);
  144.     sysinfo_set_item_val("kbd.port", NULL, port);
  145.  
  146. #ifdef CONFIG_NS16550_INTERRUPT_DRIVEN
  147.     /* Enable interrupts */
  148.         ns16550_ier_write(&ns16550, IER_ERBFI);
  149.     ns16550_mcr_write(&ns16550, MCR_OUT2);
  150. #endif
  151.  
  152. #ifdef ia64
  153.         uint8_t c;
  154.         // This switches rbr & ier to mode when accept baudrate constant
  155.         c = ns16550_lcr_read(&ns16550);
  156.         ns16550_lcr_write(&ns16550, 0x80 | c);
  157.         ns16550_rbr_write(&ns16550, 0x0c);
  158.         ns16550_ier_write(&ns16550, 0x00);
  159.         ns16550_lcr_write(&ns16550, c);
  160. #endif
  161.    
  162.     ns16550_grab();
  163. }
  164.  
  165. /** Process ns16550 interrupt. */
  166. void ns16550_interrupt(void)
  167. {
  168.     ns16550_poll();
  169. }
  170.  
  171. /* Called from getc(). */
  172. void ns16550_resume(chardev_t *d)
  173. {
  174. }
  175.  
  176. /* Called from getc(). */
  177. void ns16550_suspend(chardev_t *d)
  178. {
  179. }
  180.  
  181.  
  182. char ns16550_key_read(chardev_t *d)
  183. {
  184.     char ch;   
  185.  
  186.     while(!(ch = active_read_buff_read())) {
  187.         uint8_t x;
  188.         while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
  189.             ;
  190.         x = ns16550_rbr_read(&ns16550);
  191. #ifndef ia64
  192.         if (x != IGNORE_CODE) {
  193.             if (x & KEY_RELEASE)
  194.                 key_released(x ^ KEY_RELEASE);
  195.             else
  196.                 active_read_key_pressed(x);
  197.         }
  198. #else
  199.         extern chardev_t kbrd;
  200.         if(x != 0x0d) {
  201.             if(x == 0x7f)
  202.                 x = '\b';
  203.              chardev_push_character(&kbrd, x);
  204.         }    
  205. #endif     
  206.  
  207.     }
  208.     return ch;
  209. }
  210.  
  211. /** Poll for key press and release events.
  212.  *
  213.  * This function can be used to implement keyboard polling.
  214.  */
  215. void ns16550_poll(void)
  216. {
  217. #ifndef CONFIG_NS16550_INTERRUPT_DRIVEN
  218.     ipl_t ipl;
  219.  
  220.     ipl = interrupts_disable();
  221.     spinlock_lock(&ns16550_irq.lock);
  222.  
  223.     if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
  224.         if (ns16550_irq.notif_cfg.notify && ns16550_irq.notif_cfg.answerbox) {
  225.             /*
  226.              * Send IPC notification.
  227.              */
  228.             ipc_irq_send_notif(&ns16550_irq);
  229.             spinlock_unlock(&ns16550_irq.lock);
  230.             interrupts_restore(ipl);
  231.             return;
  232.         }
  233.     }
  234.  
  235.     spinlock_unlock(&ns16550_irq.lock);
  236.     interrupts_restore(ipl);
  237. #endif
  238.  
  239.     while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
  240.         uint8_t x;
  241.        
  242.         x = ns16550_rbr_read(&ns16550);
  243. #ifndef ia64
  244.         if (x != IGNORE_CODE) {
  245.             if (x & KEY_RELEASE)
  246.                 key_released(x ^ KEY_RELEASE);
  247.             else
  248.                 key_pressed(x);
  249.         }
  250. #else
  251.         extern chardev_t kbrd;
  252.         if(x != 0x0d) {
  253.             if (x == 0x7f)
  254.                 x = '\b';
  255.             chardev_push_character(&kbrd, x);
  256.         }    
  257. #endif     
  258.  
  259.     }
  260. }
  261.  
  262. irq_ownership_t ns16550_claim(void)
  263. {
  264.     return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);
  265. }
  266.  
  267. void ns16550_irq_handler(irq_t *irq, void *arg, ...)
  268. {
  269.     if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)
  270.         ipc_irq_send_notif(irq);
  271.     else
  272.         ns16550_interrupt();
  273. }
  274.  
  275. /** @}
  276.  */
  277.