| /* ns16550.c - NS16550D serial driver */ |
| |
| #define DT_DRV_COMPAT ns16550 |
| |
| /* |
| * Copyright (c) 2010, 2012-2015 Wind River Systems, Inc. |
| * Copyright (c) 2020-2022 Intel Corp. |
| * |
| * SPDX-License-Identifier: Apache-2.0 |
| */ |
| |
| /** |
| * @brief NS16550 Serial Driver |
| * |
| * This is the driver for the Intel NS16550 UART Chip used on the PC 386. |
| * It uses the SCCs in asynchronous mode only. |
| * |
| * Before individual UART port can be used, uart_ns16550_port_init() has to be |
| * called to setup the port. |
| */ |
| |
| #include <errno.h> |
| #include <zephyr/kernel.h> |
| #include <zephyr/arch/cpu.h> |
| #include <zephyr/types.h> |
| |
| #include <zephyr/init.h> |
| #include <zephyr/toolchain.h> |
| #include <zephyr/linker/sections.h> |
| #include <zephyr/drivers/uart.h> |
| #include <zephyr/drivers/clock_control.h> |
| #include <zephyr/pm/policy.h> |
| #include <zephyr/sys/sys_io.h> |
| #include <zephyr/spinlock.h> |
| |
| #include "uart_ns16550.h" |
| |
| #define INST_HAS_PCP_HELPER(inst) DT_INST_NODE_HAS_PROP(inst, pcp) || |
| #define INST_HAS_DLF_HELPER(inst) DT_INST_NODE_HAS_PROP(inst, dlf) || |
| |
| #define UART_NS16550_PCP_ENABLED \ |
| (DT_INST_FOREACH_STATUS_OKAY(INST_HAS_PCP_HELPER) 0) |
| #define UART_NS16550_DLF_ENABLED \ |
| (DT_INST_FOREACH_STATUS_OKAY(INST_HAS_DLF_HELPER) 0) |
| |
| #if DT_ANY_INST_ON_BUS_STATUS_OKAY(pcie) |
| BUILD_ASSERT(IS_ENABLED(CONFIG_PCIE), "NS16550(s) in DT need CONFIG_PCIE"); |
| #include <zephyr/drivers/pcie/pcie.h> |
| #endif |
| |
| /* register definitions */ |
| |
| #define REG_THR 0x00 /* Transmitter holding reg. */ |
| #define REG_RDR 0x00 /* Receiver data reg. */ |
| #define REG_BRDL 0x00 /* Baud rate divisor (LSB) */ |
| #define REG_BRDH 0x01 /* Baud rate divisor (MSB) */ |
| #define REG_IER 0x01 /* Interrupt enable reg. */ |
| #define REG_IIR 0x02 /* Interrupt ID reg. */ |
| #define REG_FCR 0x02 /* FIFO control reg. */ |
| #define REG_LCR 0x03 /* Line control reg. */ |
| #define REG_MDC 0x04 /* Modem control reg. */ |
| #define REG_LSR 0x05 /* Line status reg. */ |
| #define REG_MSR 0x06 /* Modem status reg. */ |
| #define REG_DLF 0xC0 /* Divisor Latch Fraction */ |
| #define REG_PCP 0x200 /* PRV_CLOCK_PARAMS (Apollo Lake) */ |
| |
| /* equates for interrupt enable register */ |
| |
| #define IER_RXRDY 0x01 /* receiver data ready */ |
| #define IER_TBE 0x02 /* transmit bit enable */ |
| #define IER_LSR 0x04 /* line status interrupts */ |
| #define IER_MSI 0x08 /* modem status interrupts */ |
| |
| /* equates for interrupt identification register */ |
| |
| #define IIR_MSTAT 0x00 /* modem status interrupt */ |
| #define IIR_NIP 0x01 /* no interrupt pending */ |
| #define IIR_THRE 0x02 /* transmit holding register empty interrupt */ |
| #define IIR_RBRF 0x04 /* receiver buffer register full interrupt */ |
| #define IIR_LS 0x06 /* receiver line status interrupt */ |
| #define IIR_MASK 0x07 /* interrupt id bits mask */ |
| #define IIR_ID 0x06 /* interrupt ID mask without NIP */ |
| #define IIR_FE 0xC0 /* FIFO mode enabled */ |
| #define IIR_CH 0x0C /* Character timeout*/ |
| |
| /* equates for FIFO control register */ |
| |
| #define FCR_FIFO 0x01 /* enable XMIT and RCVR FIFO */ |
| #define FCR_RCVRCLR 0x02 /* clear RCVR FIFO */ |
| #define FCR_XMITCLR 0x04 /* clear XMIT FIFO */ |
| |
| /* equates for Apollo Lake clock control register (PRV_CLOCK_PARAMS) */ |
| |
| #define PCP_UPDATE 0x80000000 /* update clock */ |
| #define PCP_EN 0x00000001 /* enable clock output */ |
| |
| /* |
| * Per PC16550D (Literature Number: SNLS378B): |
| * |
| * RXRDY, Mode 0: When in the 16450 Mode (FCR0 = 0) or in |
| * the FIFO Mode (FCR0 = 1, FCR3 = 0) and there is at least 1 |
| * character in the RCVR FIFO or RCVR holding register, the |
| * RXRDY pin (29) will be low active. Once it is activated the |
| * RXRDY pin will go inactive when there are no more charac- |
| * ters in the FIFO or holding register. |
| * |
| * RXRDY, Mode 1: In the FIFO Mode (FCR0 = 1) when the |
| * FCR3 = 1 and the trigger level or the timeout has been |
| * reached, the RXRDY pin will go low active. Once it is acti- |
| * vated it will go inactive when there are no more characters |
| * in the FIFO or holding register. |
| * |
| * TXRDY, Mode 0: In the 16450 Mode (FCR0 = 0) or in the |
| * FIFO Mode (FCR0 = 1, FCR3 = 0) and there are no charac- |
| * ters in the XMIT FIFO or XMIT holding register, the TXRDY |
| * pin (24) will be low active. Once it is activated the TXRDY |
| * pin will go inactive after the first character is loaded into the |
| * XMIT FIFO or holding register. |
| * |
| * TXRDY, Mode 1: In the FIFO Mode (FCR0 = 1) when |
| * FCR3 = 1 and there are no characters in the XMIT FIFO, the |
| * TXRDY pin will go low active. This pin will become inactive |
| * when the XMIT FIFO is completely full. |
| */ |
| #define FCR_MODE0 0x00 /* set receiver in mode 0 */ |
| #define FCR_MODE1 0x08 /* set receiver in mode 1 */ |
| |
| /* RCVR FIFO interrupt levels: trigger interrupt with this bytes in FIFO */ |
| #define FCR_FIFO_1 0x00 /* 1 byte in RCVR FIFO */ |
| #define FCR_FIFO_4 0x40 /* 4 bytes in RCVR FIFO */ |
| #define FCR_FIFO_8 0x80 /* 8 bytes in RCVR FIFO */ |
| #define FCR_FIFO_14 0xC0 /* 14 bytes in RCVR FIFO */ |
| |
| /* |
| * UART NS16750 supports 64 bytes FIFO, which can be enabled |
| * via the FCR register |
| */ |
| #define FCR_FIFO_64 0x20 /* Enable 64 bytes FIFO */ |
| |
| /* constants for line control register */ |
| |
| #define LCR_CS5 0x00 /* 5 bits data size */ |
| #define LCR_CS6 0x01 /* 6 bits data size */ |
| #define LCR_CS7 0x02 /* 7 bits data size */ |
| #define LCR_CS8 0x03 /* 8 bits data size */ |
| #define LCR_2_STB 0x04 /* 2 stop bits */ |
| #define LCR_1_STB 0x00 /* 1 stop bit */ |
| #define LCR_PEN 0x08 /* parity enable */ |
| #define LCR_PDIS 0x00 /* parity disable */ |
| #define LCR_EPS 0x10 /* even parity select */ |
| #define LCR_SP 0x20 /* stick parity select */ |
| #define LCR_SBRK 0x40 /* break control bit */ |
| #define LCR_DLAB 0x80 /* divisor latch access enable */ |
| |
| /* constants for the modem control register */ |
| |
| #define MCR_DTR 0x01 /* dtr output */ |
| #define MCR_RTS 0x02 /* rts output */ |
| #define MCR_OUT1 0x04 /* output #1 */ |
| #define MCR_OUT2 0x08 /* output #2 */ |
| #define MCR_LOOP 0x10 /* loop back */ |
| #define MCR_AFCE 0x20 /* auto flow control enable */ |
| |
| /* constants for line status register */ |
| |
| #define LSR_RXRDY 0x01 /* receiver data available */ |
| #define LSR_OE 0x02 /* overrun error */ |
| #define LSR_PE 0x04 /* parity error */ |
| #define LSR_FE 0x08 /* framing error */ |
| #define LSR_BI 0x10 /* break interrupt */ |
| #define LSR_EOB_MASK 0x1E /* Error or Break mask */ |
| #define LSR_THRE 0x20 /* transmit holding register empty */ |
| #define LSR_TEMT 0x40 /* transmitter empty */ |
| |
| /* constants for modem status register */ |
| |
| #define MSR_DCTS 0x01 /* cts change */ |
| #define MSR_DDSR 0x02 /* dsr change */ |
| #define MSR_DRI 0x04 /* ring change */ |
| #define MSR_DDCD 0x08 /* data carrier change */ |
| #define MSR_CTS 0x10 /* complement of cts */ |
| #define MSR_DSR 0x20 /* complement of dsr */ |
| #define MSR_RI 0x40 /* complement of ring signal */ |
| #define MSR_DCD 0x80 /* complement of dcd */ |
| |
| #define THR(dev) (get_port(dev) + REG_THR * reg_interval(dev)) |
| #define RDR(dev) (get_port(dev) + REG_RDR * reg_interval(dev)) |
| #define BRDL(dev) (get_port(dev) + REG_BRDL * reg_interval(dev)) |
| #define BRDH(dev) (get_port(dev) + REG_BRDH * reg_interval(dev)) |
| #define IER(dev) (get_port(dev) + REG_IER * reg_interval(dev)) |
| #define IIR(dev) (get_port(dev) + REG_IIR * reg_interval(dev)) |
| #define FCR(dev) (get_port(dev) + REG_FCR * reg_interval(dev)) |
| #define LCR(dev) (get_port(dev) + REG_LCR * reg_interval(dev)) |
| #define MDC(dev) (get_port(dev) + REG_MDC * reg_interval(dev)) |
| #define LSR(dev) (get_port(dev) + REG_LSR * reg_interval(dev)) |
| #define MSR(dev) (get_port(dev) + REG_MSR * reg_interval(dev)) |
| #define DLF(dev) (get_port(dev) + REG_DLF) |
| #define PCP(dev) (get_port(dev) + REG_PCP) |
| |
| #define IIRC(dev) (((struct uart_ns16550_dev_data *)(dev)->data)->iir_cache) |
| |
| #ifdef CONFIG_UART_NS16550_ACCESS_IOPORT |
| #define INBYTE(x) sys_in8(x) |
| #define INWORD(x) sys_in32(x) |
| #define OUTBYTE(x, d) sys_out8(d, x) |
| #define OUTWORD(x, d) sys_out32(d, x) |
| #else |
| #define INBYTE(x) sys_read8(x) |
| #define INWORD(x) sys_read32(x) |
| #define OUTBYTE(x, d) sys_write8(d, x) |
| #define OUTWORD(x, d) sys_write32(d, x) |
| #endif /* CONFIG_UART_NS16550_ACCESS_IOPORT */ |
| |
| #ifdef CONFIG_UART_NS16550_ACCESS_WORD_ONLY |
| #undef INBYTE |
| #define INBYTE(x) INWORD(x) |
| #undef OUTBYTE |
| #define OUTBYTE(x, d) OUTWORD(x, d) |
| #endif |
| |
| /* device config */ |
| struct uart_ns16550_device_config { |
| #ifndef CONFIG_UART_NS16550_ACCESS_IOPORT |
| DEVICE_MMIO_ROM; |
| #else |
| uint32_t port; |
| #endif |
| uint32_t sys_clk_freq; |
| const struct device *clock_dev; |
| clock_control_subsys_t clock_subsys; |
| #if defined(CONFIG_UART_INTERRUPT_DRIVEN) || defined(CONFIG_UART_ASYNC_API) |
| uart_irq_config_func_t irq_config_func; |
| #endif |
| #if UART_NS16550_PCP_ENABLED |
| uint32_t pcp; |
| #endif |
| uint8_t reg_interval; |
| #if DT_ANY_INST_ON_BUS_STATUS_OKAY(pcie) |
| bool pcie; |
| pcie_bdf_t pcie_bdf; |
| pcie_id_t pcie_id; |
| #endif |
| }; |
| |
| /** Device data structure */ |
| struct uart_ns16550_dev_data { |
| #ifndef CONFIG_UART_NS16550_ACCESS_IOPORT |
| DEVICE_MMIO_RAM; |
| #endif |
| struct uart_config uart_config; |
| struct k_spinlock lock; |
| uint8_t fifo_size; |
| |
| #ifdef CONFIG_UART_INTERRUPT_DRIVEN |
| uint8_t iir_cache; /**< cache of IIR since it clears when read */ |
| uart_irq_callback_user_data_t cb; /**< Callback function pointer */ |
| void *cb_data; /**< Callback function arg */ |
| #endif |
| |
| #if UART_NS16550_DLF_ENABLED |
| uint8_t dlf; /**< DLF value */ |
| #endif |
| |
| #if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_PM) |
| bool tx_stream_on; |
| #endif |
| }; |
| |
| static inline uint8_t reg_interval(const struct device *dev) |
| { |
| const struct uart_ns16550_device_config *config = dev->config; |
| |
| return config->reg_interval; |
| } |
| |
| static const struct uart_driver_api uart_ns16550_driver_api; |
| |
| static inline uintptr_t get_port(const struct device *dev) |
| { |
| #ifndef CONFIG_UART_NS16550_ACCESS_IOPORT |
| return DEVICE_MMIO_GET(dev); |
| #else |
| const struct uart_ns16550_device_config *config = dev->config; |
| |
| return config->port; |
| #endif |
| } |
| |
| static void set_baud_rate(const struct device *dev, uint32_t baud_rate, uint32_t pclk) |
| { |
| struct uart_ns16550_dev_data * const dev_data = dev->data; |
| uint32_t divisor; /* baud rate divisor */ |
| uint8_t lcr_cache; |
| |
| if ((baud_rate != 0U) && (pclk != 0U)) { |
| /* |
| * calculate baud rate divisor. a variant of |
| * (uint32_t)(pclk / (16.0 * baud_rate) + 0.5) |
| */ |
| divisor = ((pclk + (baud_rate << 3)) |
| / baud_rate) >> 4; |
| |
| /* set the DLAB to access the baud rate divisor registers */ |
| lcr_cache = INBYTE(LCR(dev)); |
| OUTBYTE(LCR(dev), LCR_DLAB | lcr_cache); |
| OUTBYTE(BRDL(dev), (unsigned char)(divisor & 0xff)); |
| OUTBYTE(BRDH(dev), (unsigned char)((divisor >> 8) & 0xff)); |
| |
| /* restore the DLAB to access the baud rate divisor registers */ |
| OUTBYTE(LCR(dev), lcr_cache); |
| |
| dev_data->uart_config.baudrate = baud_rate; |
| } |
| } |
| |
| static int uart_ns16550_configure(const struct device *dev, |
| const struct uart_config *cfg) |
| { |
| struct uart_ns16550_dev_data * const dev_data = dev->data; |
| const struct uart_ns16550_device_config * const dev_cfg = dev->config; |
| uint8_t mdc = 0U; |
| uint32_t pclk = 0U; |
| |
| /* temp for return value if error occurs in this locked region */ |
| int ret = 0; |
| |
| k_spinlock_key_t key = k_spin_lock(&dev_data->lock); |
| |
| ARG_UNUSED(dev_data); |
| ARG_UNUSED(dev_cfg); |
| |
| #ifndef CONFIG_UART_NS16550_ACCESS_IOPORT |
| #if DT_ANY_INST_ON_BUS_STATUS_OKAY(pcie) |
| if (dev_cfg->pcie) { |
| struct pcie_mbar mbar; |
| |
| if (!pcie_probe(dev_cfg->pcie_bdf, dev_cfg->pcie_id)) { |
| ret = -EINVAL; |
| goto out; |
| } |
| |
| pcie_probe_mbar(dev_cfg->pcie_bdf, 0, &mbar); |
| pcie_set_cmd(dev_cfg->pcie_bdf, PCIE_CONF_CMDSTAT_MEM, true); |
| |
| device_map(DEVICE_MMIO_RAM_PTR(dev), mbar.phys_addr, mbar.size, |
| K_MEM_CACHE_NONE); |
| } else |
| #endif /* DT_ANY_INST_ON_BUS_STATUS_OKAY(pcie) */ |
| { |
| /* Map directly from DTS */ |
| DEVICE_MMIO_MAP(dev, K_MEM_CACHE_NONE); |
| } |
| #endif /* UART_NS15660_ACCESS_IOPORT */ |
| |
| #ifdef CONFIG_UART_INTERRUPT_DRIVEN |
| dev_data->iir_cache = 0U; |
| #endif |
| |
| #if UART_NS16550_DLF_ENABLED |
| OUTBYTE(DLF(dev), dev_data->dlf); |
| #endif |
| |
| #if UART_NS16550_PCP_ENABLED |
| uint32_t pcp = dev_cfg->pcp; |
| |
| if (pcp) { |
| pcp |= PCP_EN; |
| OUTWORD(PCP(dev), pcp & ~PCP_UPDATE); |
| OUTWORD(PCP(dev), pcp | PCP_UPDATE); |
| } |
| #endif |
| |
| /* |
| * set clock frequency from clock_frequency property if valid, |
| * otherwise, get clock frequency from clock manager |
| */ |
| if (dev_cfg->sys_clk_freq != 0U) { |
| pclk = dev_cfg->sys_clk_freq; |
| } else { |
| if (!device_is_ready(dev_cfg->clock_dev)) { |
| ret = -EINVAL; |
| goto out; |
| } |
| |
| clock_control_get_rate(dev_cfg->clock_dev, dev_cfg->clock_subsys, |
| &pclk); |
| } |
| |
| set_baud_rate(dev, cfg->baudrate, pclk); |
| |
| /* Local structure to hold temporary values to pass to OUTBYTE() */ |
| struct uart_config uart_cfg; |
| |
| switch (cfg->data_bits) { |
| case UART_CFG_DATA_BITS_5: |
| uart_cfg.data_bits = LCR_CS5; |
| break; |
| case UART_CFG_DATA_BITS_6: |
| uart_cfg.data_bits = LCR_CS6; |
| break; |
| case UART_CFG_DATA_BITS_7: |
| uart_cfg.data_bits = LCR_CS7; |
| break; |
| case UART_CFG_DATA_BITS_8: |
| uart_cfg.data_bits = LCR_CS8; |
| break; |
| default: |
| ret = -ENOTSUP; |
| goto out; |
| } |
| |
| switch (cfg->stop_bits) { |
| case UART_CFG_STOP_BITS_1: |
| uart_cfg.stop_bits = LCR_1_STB; |
| break; |
| case UART_CFG_STOP_BITS_2: |
| uart_cfg.stop_bits = LCR_2_STB; |
| break; |
| default: |
| ret = -ENOTSUP; |
| goto out; |
| } |
| |
| switch (cfg->parity) { |
| case UART_CFG_PARITY_NONE: |
| uart_cfg.parity = LCR_PDIS; |
| break; |
| case UART_CFG_PARITY_EVEN: |
| uart_cfg.parity = LCR_EPS; |
| break; |
| default: |
| ret = -ENOTSUP; |
| goto out; |
| } |
| |
| dev_data->uart_config = *cfg; |
| |
| /* data bits, stop bits, parity, clear DLAB */ |
| OUTBYTE(LCR(dev), |
| uart_cfg.data_bits | uart_cfg.stop_bits | uart_cfg.parity); |
| |
| mdc = MCR_OUT2 | MCR_RTS | MCR_DTR; |
| #if defined(CONFIG_UART_NS16550_VARIANT_NS16750) || \ |
| defined(CONFIG_UART_NS16550_VARIANT_NS16950) |
| if (cfg->flow_ctrl == UART_CFG_FLOW_CTRL_RTS_CTS) { |
| mdc |= MCR_AFCE; |
| } |
| #endif |
| |
| OUTBYTE(MDC(dev), mdc); |
| |
| /* |
| * Program FIFO: enabled, mode 0 (set for compatibility with quark), |
| * generate the interrupt at 8th byte |
| * Clear TX and RX FIFO |
| */ |
| OUTBYTE(FCR(dev), |
| FCR_FIFO | FCR_MODE0 | FCR_FIFO_8 | FCR_RCVRCLR | FCR_XMITCLR |
| #ifdef CONFIG_UART_NS16550_VARIANT_NS16750 |
| | FCR_FIFO_64 |
| #endif |
| ); |
| |
| if ((INBYTE(IIR(dev)) & IIR_FE) == IIR_FE) { |
| #ifdef CONFIG_UART_NS16550_VARIANT_NS16750 |
| dev_data->fifo_size = 64; |
| #elif defined(CONFIG_UART_NS16550_VARIANT_NS16950) |
| dev_data->fifo_size = 128; |
| #else |
| dev_data->fifo_size = 16; |
| #endif |
| } else { |
| dev_data->fifo_size = 1; |
| } |
| |
| /* clear the port */ |
| INBYTE(RDR(dev)); |
| |
| /* disable interrupts */ |
| OUTBYTE(IER(dev), 0x00); |
| |
| out: |
| k_spin_unlock(&dev_data->lock, key); |
| return ret; |
| }; |
| |
| #ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE |
| static int uart_ns16550_config_get(const struct device *dev, |
| struct uart_config *cfg) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| |
| cfg->baudrate = data->uart_config.baudrate; |
| cfg->parity = data->uart_config.parity; |
| cfg->stop_bits = data->uart_config.stop_bits; |
| cfg->data_bits = data->uart_config.data_bits; |
| cfg->flow_ctrl = data->uart_config.flow_ctrl; |
| |
| return 0; |
| } |
| #endif /* CONFIG_UART_USE_RUNTIME_CONFIGURE */ |
| |
| /** |
| * @brief Initialize individual UART port |
| * |
| * This routine is called to reset the chip in a quiescent state. |
| * |
| * @param dev UART device struct |
| * |
| * @return 0 if successful, failed otherwise |
| */ |
| static int uart_ns16550_init(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| int ret; |
| |
| ret = uart_ns16550_configure(dev, &data->uart_config); |
| if (ret != 0) { |
| return ret; |
| } |
| |
| #ifdef CONFIG_UART_INTERRUPT_DRIVEN |
| const struct uart_ns16550_device_config *config = dev->config; |
| |
| config->irq_config_func(dev); |
| #endif |
| |
| return 0; |
| } |
| |
| /** |
| * @brief Poll the device for input. |
| * |
| * @param dev UART device struct |
| * @param c Pointer to character |
| * |
| * @return 0 if a character arrived, -1 if the input buffer if empty. |
| */ |
| static int uart_ns16550_poll_in(const struct device *dev, unsigned char *c) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| int ret = -1; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| if ((INBYTE(LSR(dev)) & LSR_RXRDY) != 0) { |
| /* got a character */ |
| *c = INBYTE(RDR(dev)); |
| ret = 0; |
| } |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return ret; |
| } |
| |
| /** |
| * @brief Output a character in polled mode. |
| * |
| * Checks if the transmitter is empty. If empty, a character is written to |
| * the data register. |
| * |
| * If the hardware flow control is enabled then the handshake signal CTS has to |
| * be asserted in order to send a character. |
| * |
| * @param dev UART device struct |
| * @param c Character to send |
| */ |
| static void uart_ns16550_poll_out(const struct device *dev, |
| unsigned char c) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| while ((INBYTE(LSR(dev)) & LSR_THRE) == 0) { |
| } |
| |
| OUTBYTE(THR(dev), c); |
| |
| k_spin_unlock(&data->lock, key); |
| } |
| |
| /** |
| * @brief Check if an error was received |
| * |
| * @param dev UART device struct |
| * |
| * @return one of UART_ERROR_OVERRUN, UART_ERROR_PARITY, UART_ERROR_FRAMING, |
| * UART_BREAK if an error was detected, 0 otherwise. |
| */ |
| static int uart_ns16550_err_check(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| int check = (INBYTE(LSR(dev)) & LSR_EOB_MASK); |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return check >> 1; |
| } |
| |
| #if CONFIG_UART_INTERRUPT_DRIVEN |
| |
| /** |
| * @brief Fill FIFO with data |
| * |
| * @param dev UART device struct |
| * @param tx_data Data to transmit |
| * @param size Number of bytes to send |
| * |
| * @return Number of bytes sent |
| */ |
| static int uart_ns16550_fifo_fill(const struct device *dev, |
| const uint8_t *tx_data, |
| int size) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| int i; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| for (i = 0; (i < size) && (i < data->fifo_size); i++) { |
| OUTBYTE(THR(dev), tx_data[i]); |
| } |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return i; |
| } |
| |
| /** |
| * @brief Read data from FIFO |
| * |
| * @param dev UART device struct |
| * @param rxData Data container |
| * @param size Container size |
| * |
| * @return Number of bytes read |
| */ |
| static int uart_ns16550_fifo_read(const struct device *dev, uint8_t *rx_data, |
| const int size) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| int i; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| for (i = 0; (i < size) && (INBYTE(LSR(dev)) & LSR_RXRDY) != 0; i++) { |
| rx_data[i] = INBYTE(RDR(dev)); |
| } |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return i; |
| } |
| |
| /** |
| * @brief Enable TX interrupt in IER |
| * |
| * @param dev UART device struct |
| */ |
| static void uart_ns16550_irq_tx_enable(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| #if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_PM) |
| struct uart_ns16550_dev_data *const dev_data = dev->data; |
| |
| if (!dev_data->tx_stream_on) { |
| dev_data->tx_stream_on = true; |
| uint8_t num_cpu_states; |
| const struct pm_state_info *cpu_states; |
| |
| num_cpu_states = pm_state_cpu_get_all(0U, &cpu_states); |
| |
| /* |
| * Power state to be disabled. Some platforms have multiple |
| * states and need to be given a constraint set according to |
| * different states. |
| */ |
| for (uint8_t i = 0U; i < num_cpu_states; i++) { |
| pm_policy_state_lock_get(cpu_states[i].state, PM_ALL_SUBSTATES); |
| } |
| } |
| #endif |
| OUTBYTE(IER(dev), INBYTE(IER(dev)) | IER_TBE); |
| |
| k_spin_unlock(&data->lock, key); |
| } |
| |
| /** |
| * @brief Disable TX interrupt in IER |
| * |
| * @param dev UART device struct |
| */ |
| static void uart_ns16550_irq_tx_disable(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| OUTBYTE(IER(dev), INBYTE(IER(dev)) & (~IER_TBE)); |
| |
| #if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_PM) |
| struct uart_ns16550_dev_data *const dev_data = dev->data; |
| |
| if (dev_data->tx_stream_on) { |
| dev_data->tx_stream_on = false; |
| uint8_t num_cpu_states; |
| const struct pm_state_info *cpu_states; |
| |
| num_cpu_states = pm_state_cpu_get_all(0U, &cpu_states); |
| |
| /* |
| * Power state to be enabled. Some platforms have multiple |
| * states and need to be given a constraint release according |
| * to different states. |
| */ |
| for (uint8_t i = 0U; i < num_cpu_states; i++) { |
| pm_policy_state_lock_put(cpu_states[i].state, PM_ALL_SUBSTATES); |
| } |
| } |
| #endif |
| k_spin_unlock(&data->lock, key); |
| } |
| |
| /** |
| * @brief Check if Tx IRQ has been raised |
| * |
| * @param dev UART device struct |
| * |
| * @return 1 if an IRQ is ready, 0 otherwise |
| */ |
| static int uart_ns16550_irq_tx_ready(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| int ret = ((IIRC(dev) & IIR_ID) == IIR_THRE) ? 1 : 0; |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return ret; |
| } |
| |
| /** |
| * @brief Check if nothing remains to be transmitted |
| * |
| * @param dev UART device struct |
| * |
| * @return 1 if nothing remains to be transmitted, 0 otherwise |
| */ |
| static int uart_ns16550_irq_tx_complete(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| int ret = ((INBYTE(LSR(dev)) & (LSR_TEMT | LSR_THRE)) |
| == (LSR_TEMT | LSR_THRE)) ? 1 : 0; |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return ret; |
| } |
| |
| /** |
| * @brief Enable RX interrupt in IER |
| * |
| * @param dev UART device struct |
| */ |
| static void uart_ns16550_irq_rx_enable(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| OUTBYTE(IER(dev), INBYTE(IER(dev)) | IER_RXRDY); |
| |
| k_spin_unlock(&data->lock, key); |
| } |
| |
| /** |
| * @brief Disable RX interrupt in IER |
| * |
| * @param dev UART device struct |
| */ |
| static void uart_ns16550_irq_rx_disable(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| OUTBYTE(IER(dev), INBYTE(IER(dev)) & (~IER_RXRDY)); |
| |
| k_spin_unlock(&data->lock, key); |
| } |
| |
| /** |
| * @brief Check if Rx IRQ has been raised |
| * |
| * @param dev UART device struct |
| * |
| * @return 1 if an IRQ is ready, 0 otherwise |
| */ |
| static int uart_ns16550_irq_rx_ready(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| int ret = ((IIRC(dev) & IIR_ID) == IIR_RBRF) ? 1 : 0; |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return ret; |
| } |
| |
| /** |
| * @brief Enable error interrupt in IER |
| * |
| * @param dev UART device struct |
| */ |
| static void uart_ns16550_irq_err_enable(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| OUTBYTE(IER(dev), INBYTE(IER(dev)) | IER_LSR); |
| |
| k_spin_unlock(&data->lock, key); |
| } |
| |
| /** |
| * @brief Disable error interrupt in IER |
| * |
| * @param dev UART device struct |
| * |
| * @return 1 if an IRQ is ready, 0 otherwise |
| */ |
| static void uart_ns16550_irq_err_disable(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| OUTBYTE(IER(dev), INBYTE(IER(dev)) & (~IER_LSR)); |
| |
| k_spin_unlock(&data->lock, key); |
| } |
| |
| /** |
| * @brief Check if any IRQ is pending |
| * |
| * @param dev UART device struct |
| * |
| * @return 1 if an IRQ is pending, 0 otherwise |
| */ |
| static int uart_ns16550_irq_is_pending(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| int ret = (!(IIRC(dev) & IIR_NIP)) ? 1 : 0; |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return ret; |
| } |
| |
| /** |
| * @brief Update cached contents of IIR |
| * |
| * @param dev UART device struct |
| * |
| * @return Always 1 |
| */ |
| static int uart_ns16550_irq_update(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&data->lock); |
| |
| IIRC(dev) = INBYTE(IIR(dev)); |
| |
| k_spin_unlock(&data->lock, key); |
| |
| return 1; |
| } |
| |
| /** |
| * @brief Set the callback function pointer for IRQ. |
| * |
| * @param dev UART device struct |
| * @param cb Callback function pointer. |
| */ |
| static void uart_ns16550_irq_callback_set(const struct device *dev, |
| uart_irq_callback_user_data_t cb, |
| void *cb_data) |
| { |
| struct uart_ns16550_dev_data * const dev_data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&dev_data->lock); |
| |
| dev_data->cb = cb; |
| dev_data->cb_data = cb_data; |
| |
| k_spin_unlock(&dev_data->lock, key); |
| } |
| |
| /** |
| * @brief Interrupt service routine. |
| * |
| * This simply calls the callback function, if one exists. |
| * |
| * @param arg Argument to ISR. |
| */ |
| static void uart_ns16550_isr(const struct device *dev) |
| { |
| struct uart_ns16550_dev_data * const dev_data = dev->data; |
| |
| if (dev_data->cb) { |
| dev_data->cb(dev, dev_data->cb_data); |
| } |
| |
| #ifdef CONFIG_UART_NS16550_WA_ISR_REENABLE_INTERRUPT |
| uint8_t cached_ier = INBYTE(IER(dev)); |
| |
| OUTBYTE(IER(dev), 0U); |
| OUTBYTE(IER(dev), cached_ier); |
| #endif |
| } |
| |
| #endif /* CONFIG_UART_INTERRUPT_DRIVEN */ |
| |
| #ifdef CONFIG_UART_NS16550_LINE_CTRL |
| |
| /** |
| * @brief Manipulate line control for UART. |
| * |
| * @param dev UART device struct |
| * @param ctrl The line control to be manipulated |
| * @param val Value to set the line control |
| * |
| * @return 0 if successful, failed otherwise |
| */ |
| static int uart_ns16550_line_ctrl_set(const struct device *dev, |
| uint32_t ctrl, uint32_t val) |
| { |
| struct uart_ns16550_dev_data *data = dev->data; |
| uint32_t mdc, chg; |
| k_spinlock_key_t key; |
| |
| switch (ctrl) { |
| case UART_LINE_CTRL_BAUD_RATE: |
| set_baud_rate(dev, val); |
| return 0; |
| |
| case UART_LINE_CTRL_RTS: |
| case UART_LINE_CTRL_DTR: |
| key = k_spin_lock(&data->lock); |
| mdc = INBYTE(MDC(dev)); |
| |
| if (ctrl == UART_LINE_CTRL_RTS) { |
| chg = MCR_RTS; |
| } else { |
| chg = MCR_DTR; |
| } |
| |
| if (val) { |
| mdc |= chg; |
| } else { |
| mdc &= ~(chg); |
| } |
| OUTBYTE(MDC(dev), mdc); |
| k_spin_unlock(&data->lock, key); |
| return 0; |
| } |
| |
| return -ENOTSUP; |
| } |
| |
| #endif /* CONFIG_UART_NS16550_LINE_CTRL */ |
| |
| #ifdef CONFIG_UART_NS16550_DRV_CMD |
| |
| /** |
| * @brief Send extra command to driver |
| * |
| * @param dev UART device struct |
| * @param cmd Command to driver |
| * @param p Parameter to the command |
| * |
| * @return 0 if successful, failed otherwise |
| */ |
| static int uart_ns16550_drv_cmd(const struct device *dev, uint32_t cmd, |
| uint32_t p) |
| { |
| #if UART_NS16550_DLF_ENABLED |
| if (cmd == CMD_SET_DLF) { |
| struct uart_ns16550_dev_data * const dev_data = dev->data; |
| k_spinlock_key_t key = k_spin_lock(&dev_data->lock); |
| |
| dev_data->dlf = p; |
| OUTBYTE(DLF(dev), dev_data->dlf); |
| k_spin_unlock(&dev_data->lock, key); |
| return 0; |
| } |
| #endif |
| |
| return -ENOTSUP; |
| } |
| |
| #endif /* CONFIG_UART_NS16550_DRV_CMD */ |
| |
| |
| static const struct uart_driver_api uart_ns16550_driver_api = { |
| .poll_in = uart_ns16550_poll_in, |
| .poll_out = uart_ns16550_poll_out, |
| .err_check = uart_ns16550_err_check, |
| #ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE |
| .configure = uart_ns16550_configure, |
| .config_get = uart_ns16550_config_get, |
| #endif |
| #ifdef CONFIG_UART_INTERRUPT_DRIVEN |
| |
| .fifo_fill = uart_ns16550_fifo_fill, |
| .fifo_read = uart_ns16550_fifo_read, |
| .irq_tx_enable = uart_ns16550_irq_tx_enable, |
| .irq_tx_disable = uart_ns16550_irq_tx_disable, |
| .irq_tx_ready = uart_ns16550_irq_tx_ready, |
| .irq_tx_complete = uart_ns16550_irq_tx_complete, |
| .irq_rx_enable = uart_ns16550_irq_rx_enable, |
| .irq_rx_disable = uart_ns16550_irq_rx_disable, |
| .irq_rx_ready = uart_ns16550_irq_rx_ready, |
| .irq_err_enable = uart_ns16550_irq_err_enable, |
| .irq_err_disable = uart_ns16550_irq_err_disable, |
| .irq_is_pending = uart_ns16550_irq_is_pending, |
| .irq_update = uart_ns16550_irq_update, |
| .irq_callback_set = uart_ns16550_irq_callback_set, |
| |
| #endif |
| |
| #ifdef CONFIG_UART_NS16550_LINE_CTRL |
| .line_ctrl_set = uart_ns16550_line_ctrl_set, |
| #endif |
| |
| #ifdef CONFIG_UART_NS16550_DRV_CMD |
| .drv_cmd = uart_ns16550_drv_cmd, |
| #endif |
| }; |
| |
| #define UART_NS16550_IRQ_FLAGS_SENSE0(n) 0 |
| #define UART_NS16550_IRQ_FLAGS_SENSE1(n) DT_INST_IRQ(n, sense) |
| #define UART_NS16550_IRQ_FLAGS(n) \ |
| _CONCAT(UART_NS16550_IRQ_FLAGS_SENSE, DT_INST_IRQ_HAS_CELL(n, sense))(n) |
| |
| /* not PCI(e) */ |
| #define UART_NS16550_IRQ_CONFIG_PCIE0(n) \ |
| static void irq_config_func##n(const struct device *dev) \ |
| { \ |
| ARG_UNUSED(dev); \ |
| IRQ_CONNECT(DT_INST_IRQN(n), DT_INST_IRQ(n, priority), \ |
| uart_ns16550_isr, DEVICE_DT_INST_GET(n), \ |
| UART_NS16550_IRQ_FLAGS(n)); \ |
| irq_enable(DT_INST_IRQN(n)); \ |
| } |
| |
| /* PCI(e) with auto IRQ detection */ |
| #define UART_NS16550_IRQ_CONFIG_PCIE1(n) \ |
| static void irq_config_func##n(const struct device *dev) \ |
| { \ |
| ARG_UNUSED(dev); \ |
| BUILD_ASSERT(DT_INST_IRQN(n) == PCIE_IRQ_DETECT, \ |
| "Only runtime IRQ configuration is supported"); \ |
| BUILD_ASSERT(IS_ENABLED(CONFIG_DYNAMIC_INTERRUPTS), \ |
| "NS16550 PCIe requires dynamic interrupts"); \ |
| unsigned int irq = pcie_alloc_irq(DT_INST_REG_ADDR(n)); \ |
| if (irq == PCIE_CONF_INTR_IRQ_NONE) { \ |
| return; \ |
| } \ |
| pcie_connect_dynamic_irq(DT_INST_REG_ADDR(n), irq, \ |
| DT_INST_IRQ(n, priority), \ |
| (void (*)(const void *))uart_ns16550_isr, \ |
| DEVICE_DT_INST_GET(n), \ |
| UART_NS16550_IRQ_FLAGS(n)); \ |
| pcie_irq_enable(DT_INST_REG_ADDR(n), irq); \ |
| } |
| |
| #ifdef CONFIG_UART_NS16550_ACCESS_IOPORT |
| #define DEV_CONFIG_REG_INIT(n) \ |
| .port = DT_INST_REG_ADDR(n), |
| #else |
| #define DEV_CONFIG_REG_INIT_PCIE0(n) DEVICE_MMIO_ROM_INIT(DT_DRV_INST(n)), |
| #define DEV_CONFIG_REG_INIT_PCIE1(n) |
| #define DEV_CONFIG_REG_INIT(n) \ |
| _CONCAT(DEV_CONFIG_REG_INIT_PCIE, DT_INST_ON_BUS(n, pcie))(n) |
| #endif |
| |
| #ifdef CONFIG_UART_INTERRUPT_DRIVEN |
| #define DEV_CONFIG_IRQ_FUNC_INIT(n) \ |
| .irq_config_func = irq_config_func##n, |
| #define UART_NS16550_IRQ_FUNC_DECLARE(n) \ |
| static void irq_config_func##n(const struct device *dev); |
| #define UART_NS16550_IRQ_FUNC_DEFINE(n) \ |
| _CONCAT(UART_NS16550_IRQ_CONFIG_PCIE, DT_INST_ON_BUS(n, pcie))(n) |
| #else |
| /* !CONFIG_UART_INTERRUPT_DRIVEN */ |
| #define DEV_CONFIG_IRQ_FUNC_INIT(n) |
| #define UART_NS16550_IRQ_FUNC_DECLARE(n) |
| #define UART_NS16550_IRQ_FUNC_DEFINE(n) |
| #endif /* CONFIG_UART_INTERRUPT_DRIVEN */ |
| |
| #if UART_NS16550_PCP_ENABLED |
| #define DEV_CONFIG_PCP_INIT(n) .pcp = DT_INST_PROP_OR(n, pcp, 0), |
| #else |
| #define DEV_CONFIG_PCP_INIT(n) |
| #endif |
| |
| #define DEV_CONFIG_PCIE0(n) |
| #define DEV_CONFIG_PCIE1(n) \ |
| .pcie = true, \ |
| .pcie_bdf = DT_INST_REG_ADDR(n), \ |
| .pcie_id = DT_INST_REG_SIZE(n), |
| #define DEV_CONFIG_PCIE_INIT(n) \ |
| _CONCAT(DEV_CONFIG_PCIE, DT_INST_ON_BUS(n, pcie))(n) |
| |
| #define DEV_DATA_FLOW_CTRL0 UART_CFG_FLOW_CTRL_NONE |
| #define DEV_DATA_FLOW_CTRL1 UART_CFG_FLOW_CTRL_RTS_CTS |
| #define DEV_DATA_FLOW_CTRL(n) \ |
| _CONCAT(DEV_DATA_FLOW_CTRL, DT_INST_PROP_OR(n, hw_flow_control, 0)) |
| |
| #define DEV_DATA_DLF0(n) |
| #define DEV_DATA_DLF1(n) \ |
| .dlf = DT_INST_PROP(n, dlf), |
| #define DEV_DATA_DLF_INIT(n) \ |
| _CONCAT(DEV_DATA_DLF, DT_INST_NODE_HAS_PROP(n, dlf))(n) |
| |
| #define UART_NS16550_DEVICE_INIT(n) \ |
| UART_NS16550_IRQ_FUNC_DECLARE(n); \ |
| static const struct uart_ns16550_device_config uart_ns16550_dev_cfg_##n = { \ |
| DEV_CONFIG_REG_INIT(n) \ |
| COND_CODE_1(DT_INST_NODE_HAS_PROP(n, clock_frequency), ( \ |
| .sys_clk_freq = DT_INST_PROP(n, clock_frequency), \ |
| .clock_dev = NULL, \ |
| .clock_subsys = NULL, \ |
| ), ( \ |
| .sys_clk_freq = 0, \ |
| .clock_dev = DEVICE_DT_GET(DT_INST_CLOCKS_CTLR(n)), \ |
| .clock_subsys = (clock_control_subsys_t) DT_INST_PHA(\ |
| 0, clocks, clkid), \ |
| ) \ |
| ) \ |
| DEV_CONFIG_IRQ_FUNC_INIT(n) \ |
| DEV_CONFIG_PCP_INIT(n) \ |
| .reg_interval = (1 << DT_INST_PROP(n, reg_shift)), \ |
| DEV_CONFIG_PCIE_INIT(n) \ |
| }; \ |
| static struct uart_ns16550_dev_data uart_ns16550_dev_data_##n = { \ |
| .uart_config.baudrate = DT_INST_PROP_OR(n, current_speed, 0), \ |
| .uart_config.parity = UART_CFG_PARITY_NONE, \ |
| .uart_config.stop_bits = UART_CFG_STOP_BITS_1, \ |
| .uart_config.data_bits = UART_CFG_DATA_BITS_8, \ |
| .uart_config.flow_ctrl = DEV_DATA_FLOW_CTRL(n), \ |
| DEV_DATA_DLF_INIT(n) \ |
| }; \ |
| DEVICE_DT_INST_DEFINE(n, &uart_ns16550_init, NULL, \ |
| &uart_ns16550_dev_data_##n, &uart_ns16550_dev_cfg_##n, \ |
| PRE_KERNEL_1, CONFIG_SERIAL_INIT_PRIORITY, \ |
| &uart_ns16550_driver_api); \ |
| UART_NS16550_IRQ_FUNC_DEFINE(n) |
| |
| DT_INST_FOREACH_STATUS_OKAY(UART_NS16550_DEVICE_INIT) |