lunaix-os/hal/char/uart/16x50.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_LOOP (1 << 4)
  21
  22 #define UART_rIE_ERBFI 1
  23 #define UART_rIE_ETBEI (1 << 1)
  24 #define UART_rIE_ELSI (1 << 2)
  25 #define UART_rIE_EDSSI (1 << 3)
  26
  27 #define UART_rLC_STOPB (1 << 2)
  28 #define UART_rLC_PAREN (1 << 3)
  29 #define UART_rLC_PAREVN (1 << 4)
  30 #define UART_rLC_SETBRK (1 << 6)
  31 #define UART_rLC_DLAB (1 << 7)
  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 #define UART_LCR_RESET \
  62             (UART_rLC_STOPB | \
  63             UART_rLC_PAREN | \
  64             UART_rLC_PAREVN | \
  65             UART_rLC_DLAB | 0b11)
  66
  67 struct uart16550
  68 {
  69     struct llist_header local_ports;
  70     struct serial_dev* sdev;
  71     ptr_t base_addr;
  72     unsigned int base_clk;
  73     int iv;
  74
  75     struct
  76     {
  77         u8_t rie;
  78         u8_t rfc;
  79         u8_t rmc;
  80         u8_t rlc;
  81     } cntl_save;
  82
  83     u32_t (*read_reg)(struct uart16550* uart, ptr_t regoff);
  84     void (*write_reg)(struct uart16550* uart, ptr_t regoff, u32_t val);
  85 };
  86
  87 #define UART16550(sdev) ((struct uart16550*)(sdev)->backend)
  88
  89 static inline void
  90 uart_setup(struct uart16550* uart)
  91 {
  92     uart->write_reg(uart, UART_rMC, uart->cntl_save.rmc);
  93     uart->write_reg(uart, UART_rIE, uart->cntl_save.rie);
  94 }
  95
  96 static inline void
  97 uart_clrie(struct uart16550* uart)
  98 {
  99     uart->cntl_save.rie = uart->read_reg(uart, UART_rIE);
 100     uart->write_reg(uart, UART_rIE, 0);
 101 }
 102
 103 static inline void
 104 uart_setie(struct uart16550* uart)
 105 {
 106     uart->write_reg(uart, UART_rIE, uart->cntl_save.rie);
 107 }
 108
 109 static inline void
 110 uart_setlc(struct uart16550* uart)
 111 {
 112     uart->write_reg(uart, UART_rLC, uart->cntl_save.rlc);
 113 }
 114
 115 struct uart16550*
 116 uart_alloc(ptr_t base_addr);
 117
 118 void
 119 uart_free(struct uart16550*);
 120
 121 static inline int
 122 uart_baud_divisor(struct uart16550* uart, unsigned int div)
 123 {
 124     u32_t rlc = uart->read_reg(uart, UART_rLC);
 125
 126     uart->write_reg(uart, UART_rLC, UART_rLC_DLAB | rlc);
 127     u8_t ls = (div & 0x00ff), ms = (div & 0xff00) >> 8;
 128
 129     uart->write_reg(uart, UART_rLS, ls);
 130     uart->write_reg(uart, UART_rMS, ms);
 131
 132     uart->write_reg(uart, UART_rLC, rlc & ~UART_rLC_DLAB);
 133
 134     return 0;
 135 }
 136
 137 static inline int
 138 uart_testport(struct uart16550* uart, char test_code)
 139 {
 140     u32_t rmc = uart->cntl_save.rmc;
 141     uart->write_reg(uart, UART_rMC, rmc | UART_LOOP);
 142
 143     uart->write_reg(uart, UART_rRxTX, test_code);
 144
 145     u32_t result = (char)uart->read_reg(uart, UART_rRxTX) == test_code;
 146     uart->write_reg(uart, UART_rMC, rmc & ~UART_LOOP);
 147
 148     return result;
 149 }
 150
 151 static inline int
 152 uart_pending_data(struct uart16550* uart)
 153 {
 154     return uart->read_reg(uart, UART_rLS) & UART_rLS_DR;
 155 }
 156
 157 static inline int
 158 uart_can_transmit(struct uart16550* uart)
 159 {
 160     return uart->read_reg(uart, UART_rLS) & UART_rLS_THRE;
 161 }
 162
 163 /**
 164  * @brief End of receiving
 165  *
 166  * @param uart
 167  * @return int
 168  */
 169 static inline int
 170 uart_eorcv(struct uart16550* uart)
 171 {
 172     return uart->read_reg(uart, UART_rLS) & UART_rLS_BI;
 173 }
 174
 175 static inline int
 176 uart_enable_fifo(struct uart16550* uart, int trig_lvl)
 177 {
 178     uart->cntl_save.rfc =
 179       UART_rFC_EN | ((trig_lvl & 0b11) << 6) | UART_rFC_DMA1;
 180     uart->write_reg(uart, UART_rFC, uart->cntl_save.rfc);
 181
 182     return uart->read_reg(uart, UART_rII) & UART_rII_FIFOEN;
 183 }
 184
 185 static inline void
 186 uart_clear_rxfifo(struct uart16550* uart)
 187 {
 188     uart->write_reg(uart, UART_rFC, uart->cntl_save.rfc | UART_rFC_RCVR_RESET);
 189 }
 190
 191 static inline void
 192 uart_clear_txfifo(struct uart16550* uart)
 193 {
 194     uart->write_reg(uart, UART_rFC, uart->cntl_save.rfc | UART_rFC_XMIT_RESET);
 195 }
 196
 197 static inline void
 198 uart_clear_fifo(struct uart16550* uart)
 199 {
 200     u32_t rfc = uart->cntl_save.rfc | UART_rFC_XMIT_RESET | UART_rFC_RCVR_RESET;
 201     uart->write_reg(uart, UART_rFC, rfc);
 202 }
 203
 204 static inline int
 205 uart_intr_identify(struct uart16550* uart)
 206 {
 207     u32_t rii = uart->read_reg(uart, UART_rII);
 208     return (rii & UART_rII_ID);
 209 }
 210
 211 static inline u8_t
 212 uart_read_byte(struct uart16550* uart)
 213 {
 214     return (u8_t)uart->read_reg(uart, UART_rRxTX);
 215 }
 216
 217 static inline void
 218 uart_write_byte(struct uart16550* uart, u8_t val)
 219 {
 220     uart->write_reg(uart, UART_rRxTX, val);
 221 }
 222
 223 int
 224 uart_general_exec_cmd(struct serial_dev* sdev, u32_t req, va_list args);
 225
 226 int
 227 uart_general_tx(struct serial_dev* sdev, u8_t* data, size_t len);
 228
 229 void
 230 uart_handle_irq_overlap(int iv, struct llist_header* ports);
 231
 232 void
 233 uart_handle_irq(int iv, struct uart16550 *uart);
 234
 235 static inline struct serial_dev*
 236 uart_create_serial(struct uart16550* uart, struct devclass* class,
 237                          struct llist_header* ports, char* if_ident)
 238 {
 239     llist_append(ports, &uart->local_ports);
 240
 241     struct serial_dev* sdev = serial_create(class, if_ident);
 242     sdev->backend = uart;
 243     sdev->write = uart_general_tx;
 244     sdev->exec_cmd = uart_general_exec_cmd;
 245
 246     uart->sdev = sdev;
 247
 248     uart_setup(uart);
 249     uart_setie(uart);
 250
 251     return sdev;
 252 }
 253
 254 struct uart16550*
 255 uart16x50_pmio_create(ptr_t base);
 256
 257 struct uart16550*
 258 uart16x50_mmio_create(ptr_t base, ptr_t size);
 259
 260 #endif /* __LUNAIX_16550_H */