lunaix-os/hal/char/uart/16550.h

   1 #ifndef __LUNAIX_16550_H
   2 #define __LUNAIX_16550_H
   3
   4 #include <hal/serial.h>
   5 #include <lunaix/types.h>
   6
   7 #define UART_rRxTX 0
   8 #define UART_rIE 1
   9 #define UART_rII 2
  10 #define UART_rFC 2
  11 #define UART_rLC 3
  12 #define UART_rMC 4
  13 #define UART_rLS 5
  14 #define UART_rMS 6
  15 #define UART_rSC 7
  16 #define UART_rDLL 0
  17 #define UART_rDLM 1
  18
  19 #define UART_INTRX 0x1
  20 #define UART_DLAB (1 << 7)
  21 #define UART_LOOP (1 << 4)
  22
  23 #define UART_rIE_ERBFI 1
  24 #define UART_rIE_ETBEI (1 << 1)
  25 #define UART_rIE_ELSI (1 << 2)
  26 #define UART_rIE_EDSSI (1 << 3)
  27
  28 #define UART_rLC_STOPB (1 << 2)
  29 #define UART_rLC_PAREN (1 << 3)
  30 #define UART_rLC_PAREVN (1 << 4)
  31 #define UART_rLC_SETBRK (1 << 6)
  32
  33 #define UART_rLS_THRE (1 << 5)
  34 #define UART_rLS_DR 1
  35 #define UART_rLS_BI (1 << 4)
  36
  37 #define UART_rII_FIFOEN (0b11 << 6)
  38 #define UART_rII_ID 0b1111
  39
  40 #define UART_rFC_EN 1
  41 #define UART_rFC_DMA1 (1 << 3)
  42 #define UART_rFC_XMIT_RESET (1 << 2)
  43 #define UART_rFC_RCVR_RESET (1 << 1)
  44
  45 #define UART_rMC_DTR 1
  46 #define UART_rMC_RTS (1 << 1)
  47 #define UART_rMC_IEN (1 << 3)
  48
  49 #define UART_FIFO1 0b00
  50 #define UART_FIFO4 0b01
  51 #define UART_FIFO8 0b10
  52 #define UART_FIFO14 0b11
  53
  54 #define UART_NO_INTR 0b0001
  55 #define UART_LINE_UDPDATE 0b0110
  56 #define UART_DATA_OK 0b0100
  57 #define UART_CHR_TIMEOUT 0b1100
  58 #define UART_SENT_ALL 0b0010
  59 #define UART_MODEM_UPDATE 0b0000
  60
  61 struct uart16550
  62 {
  63     struct llist_header local_ports;
  64     struct serial_dev* sdev;
  65     ptr_t base_addr;
  66     int iv;
  67
  68     struct
  69     {
  70         u8_t rie;
  71         u8_t rfc;
  72         u8_t rmc;
  73         u8_t rlc;
  74     } cntl_save;
  75
  76     u32_t (*read_reg)(struct uart16550* uart, ptr_t regoff);
  77     void (*write_reg)(struct uart16550* uart, ptr_t regoff, u32_t val);
  78 };
  79
  80 #define UART16550(sdev) ((struct uart16550*)(sdev)->backend)
  81
  82 static inline void
  83 uart_setup(struct uart16550* uart)
  84 {
  85     uart->write_reg(uart, UART_rMC, uart->cntl_save.rmc);
  86     uart->write_reg(uart, UART_rIE, uart->cntl_save.rie);
  87 }
  88
  89 static inline void
  90 uart_clrie(struct uart16550* uart)
  91 {
  92     uart->cntl_save.rie = uart->read_reg(uart, UART_rIE);
  93     uart->write_reg(uart, UART_rIE, 0);
  94 }
  95
  96 static inline void
  97 uart_setie(struct uart16550* uart)
  98 {
  99     uart->write_reg(uart, UART_rIE, uart->cntl_save.rie);
 100 }
 101
 102 static inline void
 103 uart_setlc(struct uart16550* uart)
 104 {
 105     uart->write_reg(uart, UART_rLC, uart->cntl_save.rlc);
 106 }
 107
 108 struct uart16550*
 109 uart_alloc(ptr_t base_addr);
 110
 111 void
 112 uart_free(struct uart16550*);
 113
 114 static inline int
 115 uart_baud_divisor(struct uart16550* uart, int div)
 116 {
 117     u32_t rlc = uart->read_reg(uart, UART_rLC);
 118
 119     uart->write_reg(uart, UART_rLC, UART_DLAB | rlc);
 120     u8_t ls = (div & 0xff), ms = (div & 0xff00) >> 8;
 121
 122     uart->write_reg(uart, UART_rLS, ls);
 123     uart->write_reg(uart, UART_rMS, ms);
 124
 125     uart->write_reg(uart, UART_rLC, rlc & ~UART_DLAB);
 126
 127     return 0;
 128 }
 129
 130 static inline int
 131 uart_testport(struct uart16550* uart, char test_code)
 132 {
 133     u32_t rmc = uart->cntl_save.rmc;
 134     uart->write_reg(uart, UART_rMC, rmc | UART_LOOP);
 135
 136     uart->write_reg(uart, UART_rRxTX, test_code);
 137
 138     u32_t result = (char)uart->read_reg(uart, UART_rRxTX) == test_code;
 139     uart->write_reg(uart, UART_rMC, rmc & ~UART_LOOP);
 140
 141     return result;
 142 }
 143
 144 static inline int
 145 uart_pending_data(struct uart16550* uart)
 146 {
 147     return uart->read_reg(uart, UART_rLS) & UART_rLS_DR;
 148 }
 149
 150 static inline int
 151 uart_can_transmit(struct uart16550* uart)
 152 {
 153     return uart->read_reg(uart, UART_rLS) & UART_rLS_THRE;
 154 }
 155
 156 /**
 157  * @brief End of receiving
 158  *
 159  * @param uart
 160  * @return int
 161  */
 162 static inline int
 163 uart_eorcv(struct uart16550* uart)
 164 {
 165     return uart->read_reg(uart, UART_rLS) & UART_rLS_BI;
 166 }
 167
 168 static inline int
 169 uart_enable_fifo(struct uart16550* uart, int trig_lvl)
 170 {
 171     uart->cntl_save.rfc =
 172       UART_rFC_EN | ((trig_lvl & 0b11) << 6) | UART_rFC_DMA1;
 173     uart->write_reg(uart, UART_rFC, uart->cntl_save.rfc);
 174
 175     return uart->read_reg(uart, UART_rII) & UART_rII_FIFOEN;
 176 }
 177
 178 static inline void
 179 uart_clear_rxfifo(struct uart16550* uart)
 180 {
 181     uart->write_reg(uart, UART_rFC, uart->cntl_save.rfc | UART_rFC_RCVR_RESET);
 182 }
 183
 184 static inline void
 185 uart_clear_txfifo(struct uart16550* uart)
 186 {
 187     uart->write_reg(uart, UART_rFC, uart->cntl_save.rfc | UART_rFC_XMIT_RESET);
 188 }
 189
 190 static inline void
 191 uart_clear_fifo(struct uart16550* uart)
 192 {
 193     u32_t rfc = uart->cntl_save.rfc | UART_rFC_XMIT_RESET | UART_rFC_RCVR_RESET;
 194     uart->write_reg(uart, UART_rFC, rfc);
 195 }
 196
 197 static inline int
 198 uart_intr_identify(struct uart16550* uart)
 199 {
 200     u32_t rii = uart->read_reg(uart, UART_rII);
 201     return (rii & UART_rII_ID);
 202 }
 203
 204 static inline u8_t
 205 uart_read_byte(struct uart16550* uart)
 206 {
 207     return (u8_t)uart->read_reg(uart, UART_rRxTX);
 208 }
 209
 210 static inline void
 211 uart_write_byte(struct uart16550* uart, u8_t val)
 212 {
 213     uart->write_reg(uart, UART_rRxTX, val);
 214 }
 215
 216 int
 217 uart_general_exec_cmd(struct serial_dev* sdev, u32_t req, va_list args);
 218
 219 int
 220 uart_general_tx(struct serial_dev* sdev, u8_t* data, size_t len);
 221
 222 void
 223 uart_general_irq_handler(int iv, struct llist_header* ports);
 224
 225 #endif /* __LUNAIX_16550_H */