Subversion Repositories HelenOS

Rev

Rev 3674 | 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   Headers for NS 16550 serial port / keyboard driver.
  35.  */
  36.  
  37. #ifndef KERN_NS16550_H_
  38. #define KERN_NS16550_H_
  39.  
  40. #include <console/chardev.h>
  41. #include <ddi/irq.h>
  42. #include <ipc/irq.h>
  43.  
  44. extern void ns16550_init(devno_t, uintptr_t, inr_t, cir_t, void *);
  45. extern void ns16550_poll(void);
  46. extern void ns16550_grab(void);
  47. extern void ns16550_release(void);
  48. extern char ns16550_key_read(chardev_t *);
  49. extern irq_ownership_t ns16550_claim(void *);
  50. extern void ns16550_irq_handler(irq_t *);
  51.  
  52. #include <arch/types.h>
  53. #include <arch/drivers/kbd.h>
  54.  
  55. /* NS16550 registers */
  56. #define RBR_REG     0   /** Receiver Buffer Register. */
  57. #define IER_REG     1   /** Interrupt Enable Register. */
  58. #define IIR_REG     2   /** Interrupt Ident Register (read). */
  59. #define FCR_REG     2   /** FIFO control register (write). */
  60. #define LCR_REG     3   /** Line Control register. */
  61. #define MCR_REG     4   /** Modem Control Register. */
  62. #define LSR_REG     5   /** Line Status Register. */
  63.  
  64. #define IER_ERBFI   0x01    /** Enable Receive Buffer Full Interrupt. */
  65.  
  66. #define LCR_DLAB    0x80    /** Divisor Latch Access bit. */
  67.  
  68. #define MCR_OUT2    0x08    /** OUT2. */
  69.  
  70. /** Structure representing the ns16550 device. */
  71. typedef struct {
  72.     devno_t devno;
  73.     /** Memory mapped registers of the ns16550. */
  74.     volatile ioport_t io_port;
  75. } ns16550_t;
  76.  
  77. static inline uint8_t ns16550_rbr_read(ns16550_t *dev)
  78. {
  79.     return pio_read_8(dev->io_port + RBR_REG);
  80. }
  81. static inline void ns16550_rbr_write(ns16550_t *dev, uint8_t v)
  82. {
  83.     pio_write_8(dev->io_port + RBR_REG, v);
  84. }
  85.  
  86. static inline uint8_t ns16550_ier_read(ns16550_t *dev)
  87. {
  88.     return pio_read_8(dev->io_port + IER_REG);
  89. }
  90.  
  91. static inline void ns16550_ier_write(ns16550_t *dev, uint8_t v)
  92. {
  93.     pio_write_8(dev->io_port + IER_REG, v);
  94. }
  95.  
  96. static inline uint8_t ns16550_iir_read(ns16550_t *dev)
  97. {
  98.     return pio_read_8(dev->io_port + IIR_REG);
  99. }
  100.  
  101. static inline void ns16550_fcr_write(ns16550_t *dev, uint8_t v)
  102. {
  103.     pio_write_8(dev->io_port + FCR_REG, v);
  104. }
  105.  
  106. static inline uint8_t ns16550_lcr_read(ns16550_t *dev)
  107. {
  108.     return pio_read_8(dev->io_port + LCR_REG);
  109. }
  110.  
  111. static inline void ns16550_lcr_write(ns16550_t *dev, uint8_t v)
  112. {
  113.     pio_write_8(dev->io_port + LCR_REG, v);
  114. }
  115.  
  116. static inline uint8_t ns16550_lsr_read(ns16550_t *dev)
  117. {
  118.     return pio_read_8(dev->io_port + LSR_REG);
  119. }
  120.  
  121. static inline uint8_t ns16550_mcr_read(ns16550_t *dev)
  122. {
  123.     return pio_read_8(dev->io_port + MCR_REG);
  124. }
  125.  
  126. static inline void ns16550_mcr_write(ns16550_t *dev, uint8_t v)
  127. {
  128.     pio_write_8(dev->io_port + MCR_REG, v);
  129. }
  130.  
  131. #endif
  132.  
  133. /** @}
  134.  */
  135.