411 lines
12 KiB
C
411 lines
12 KiB
C
/*
|
||
* Copyright (c) 2006-2024 RT-Thread Development Team
|
||
*
|
||
* SPDX-License-Identifier: Apache-2.0
|
||
*
|
||
* Change Logs:
|
||
* Date Author Notes
|
||
* 2021-06-01 KyleChan first version
|
||
*/
|
||
|
||
#ifndef __DEV_SERIAL_V2_H__
|
||
#define __DEV_SERIAL_V2_H__
|
||
|
||
#include <rtthread.h>
|
||
#include <rtdevice.h>
|
||
/**
|
||
* @defgroup group_drivers_serial_v2 Serial v2
|
||
* @brief Serial v2 driver api
|
||
* @ingroup group_device_driver
|
||
*
|
||
* <b>Example</b>
|
||
* @code {.c}
|
||
*
|
||
* #include <rtthread.h>
|
||
* #include <rtdevice.h>
|
||
*
|
||
* #define SAMPLE_UART_NAME "uart1"
|
||
*
|
||
* struct rx_msg
|
||
* {
|
||
* rt_device_t dev;
|
||
* rt_size_t size;
|
||
* };
|
||
* static rt_device_t serial;
|
||
* static struct rt_messagequeue rx_mq;
|
||
*
|
||
* static rt_err_t uart_input(rt_device_t dev, rt_size_t size)
|
||
* {
|
||
* struct rx_msg msg;
|
||
* rt_err_t result;
|
||
* msg.dev = dev;
|
||
* msg.size = size;
|
||
*
|
||
* result = rt_mq_send(&rx_mq, &msg, sizeof(msg));
|
||
* if (result == -RT_EFULL)
|
||
* {
|
||
* rt_kprintf("message queue full！\n");
|
||
* }
|
||
* return result;
|
||
* }
|
||
*
|
||
* static void serial_thread_entry(void *parameter)
|
||
* {
|
||
* struct rx_msg msg;
|
||
* rt_err_t result;
|
||
* rt_uint32_t rx_length;
|
||
* static char rx_buffer[BSP_UART1_RX_BUFSIZE + 1];
|
||
*
|
||
* while (1)
|
||
* {
|
||
* rt_memset(&msg, 0, sizeof(msg));
|
||
* result = rt_mq_recv(&rx_mq, &msg, sizeof(msg), RT_WAITING_FOREVER);
|
||
* if (result > 0)
|
||
* {
|
||
* rx_length = rt_device_read(msg.dev, 0, rx_buffer, msg.size);
|
||
* rx_buffer[rx_length] = '\0';
|
||
* rt_device_write(serial, 0, rx_buffer, rx_length);
|
||
* rt_kprintf("%s\n",rx_buffer);
|
||
* }
|
||
* }
|
||
* }
|
||
*
|
||
* static int uart_dma_sample(int argc, char *argv[])
|
||
* {
|
||
* rt_err_t ret = RT_EOK;
|
||
* char uart_name[RT_NAME_MAX];
|
||
* static char msg_pool[256];
|
||
* char str[] = "hello RT-Thread!\r\n";
|
||
*
|
||
* if (argc == 2)
|
||
* {
|
||
* rt_strncpy(uart_name, argv[1], RT_NAME_MAX);
|
||
* }
|
||
* else
|
||
* {
|
||
* rt_strncpy(uart_name, SAMPLE_UART_NAME, RT_NAME_MAX);
|
||
* }
|
||
*
|
||
* serial = rt_device_find(uart_name);
|
||
* if (!serial)
|
||
* {
|
||
* rt_kprintf("find %s failed!\n", uart_name);
|
||
* return -RT_ERROR;
|
||
* }
|
||
*
|
||
* rt_mq_init(&rx_mq, "rx_mq",
|
||
* msg_pool,
|
||
* sizeof(struct rx_msg),
|
||
* sizeof(msg_pool),
|
||
* RT_IPC_FLAG_FIFO);
|
||
*
|
||
* rt_device_open(serial, RT_DEVICE_FLAG_RX_NON_BLOCKING | RT_DEVICE_FLAG_TX_BLOCKING);
|
||
* rt_device_set_rx_indicate(serial, uart_input);
|
||
* rt_device_write(serial, 0, str, (sizeof(str) - 1));
|
||
*
|
||
* rt_thread_t thread = rt_thread_create("serial", serial_thread_entry, RT_NULL, 1024, 25, 10);
|
||
* if (thread != RT_NULL)
|
||
* {
|
||
* rt_thread_startup(thread);
|
||
* }
|
||
* else
|
||
* {
|
||
* ret = RT_ERROR;
|
||
* }
|
||
*
|
||
* return ret;
|
||
* }
|
||
* MSH_CMD_EXPORT(uart_dma_sample, uart device dma sample);
|
||
* @endcode
|
||
*/
|
||
|
||
|
||
/*!
|
||
* @addtogroup group_drivers_serial_v2
|
||
* @{
|
||
*/
|
||
|
||
#define BAUD_RATE_2400 2400
|
||
#define BAUD_RATE_4800 4800
|
||
#define BAUD_RATE_9600 9600
|
||
#define BAUD_RATE_19200 19200
|
||
#define BAUD_RATE_38400 38400
|
||
#define BAUD_RATE_57600 57600
|
||
#define BAUD_RATE_115200 115200
|
||
#define BAUD_RATE_230400 230400
|
||
#define BAUD_RATE_460800 460800
|
||
#define BAUD_RATE_500000 500000
|
||
#define BAUD_RATE_921600 921600
|
||
#define BAUD_RATE_2000000 2000000
|
||
#define BAUD_RATE_2500000 2500000
|
||
#define BAUD_RATE_3000000 3000000
|
||
|
||
#define DATA_BITS_5 5
|
||
#define DATA_BITS_6 6
|
||
#define DATA_BITS_7 7
|
||
#define DATA_BITS_8 8
|
||
#define DATA_BITS_9 9
|
||
|
||
#define STOP_BITS_1 0
|
||
#define STOP_BITS_2 1
|
||
#define STOP_BITS_3 2
|
||
#define STOP_BITS_4 3
|
||
|
||
#ifdef _WIN32
|
||
#include <windows.h>
|
||
#else
|
||
#define PARITY_NONE 0
|
||
#define PARITY_ODD 1
|
||
#define PARITY_EVEN 2
|
||
#endif
|
||
|
||
#define BIT_ORDER_LSB 0
|
||
#define BIT_ORDER_MSB 1
|
||
|
||
#define NRZ_NORMAL 0 /* Non Return to Zero : normal mode */
|
||
#define NRZ_INVERTED 1 /* Non Return to Zero : inverted mode */
|
||
|
||
/**
|
||
* device flag
|
||
*/
|
||
#define RT_DEVICE_FLAG_RX_BLOCKING 0x1000
|
||
#define RT_DEVICE_FLAG_RX_NON_BLOCKING 0x2000
|
||
|
||
#define RT_DEVICE_FLAG_TX_BLOCKING 0x4000
|
||
#define RT_DEVICE_FLAG_TX_NON_BLOCKING 0x8000
|
||
|
||
#define RT_SERIAL_RX_BLOCKING RT_DEVICE_FLAG_RX_BLOCKING
|
||
#define RT_SERIAL_RX_NON_BLOCKING RT_DEVICE_FLAG_RX_NON_BLOCKING
|
||
#define RT_SERIAL_TX_BLOCKING RT_DEVICE_FLAG_TX_BLOCKING
|
||
#define RT_SERIAL_TX_NON_BLOCKING RT_DEVICE_FLAG_TX_NON_BLOCKING
|
||
|
||
/**
|
||
* hw device control commands
|
||
*/
|
||
#define RT_DEVICE_CHECK_OPTMODE 0x20
|
||
|
||
/**
|
||
* hw serial control commands
|
||
*/
|
||
#define RT_HW_SERIAL_CTRL_GETC 0x01 /* Tx irq get char */
|
||
#define RT_HW_SERIAL_CTRL_PUTC 0x02 /* Rx irq put char */
|
||
#define RT_HW_SERIAL_CTRL_GET_DMA_PING_BUF 0x03 /* Get DMA ping-pong buffer */
|
||
|
||
/**
|
||
* hw isr event
|
||
*/
|
||
#define RT_SERIAL_EVENT_RX_IND 0x01 /* Rx indication */
|
||
#define RT_SERIAL_EVENT_TX_DONE 0x02 /* Tx complete */
|
||
#define RT_SERIAL_EVENT_RX_DMADONE 0x03 /* Rx DMA transfer done */
|
||
#define RT_SERIAL_EVENT_TX_DMADONE 0x04 /* Tx DMA transfer done */
|
||
|
||
/**
|
||
* device commands
|
||
* 0x40 - special device control commands
|
||
*/
|
||
#define RT_SERIAL_CTRL_SET_RX_TIMEOUT 0x41 /* set Rx timeout. Call before rt_device_read. not supported in poll mode */
|
||
#define RT_SERIAL_CTRL_SET_TX_TIMEOUT 0x42 /* set Tx timeout. Call before rt_device_write. not supported in poll mode */
|
||
#define RT_SERIAL_CTRL_GET_RX_TIMEOUT 0x43 /* get Rx timeout. not supported in poll mode */
|
||
#define RT_SERIAL_CTRL_GET_TX_TIMEOUT 0x44 /* get Tx timeout. not supported in poll mode */
|
||
#define RT_SERIAL_CTRL_RX_FLUSH 0x45 /* clear rx buffer. Discard all data */
|
||
#define RT_SERIAL_CTRL_TX_FLUSH 0x46 /* clear tx buffer. Blocking and wait for the send buffer data to be sent. not supported in poll mode */
|
||
#define RT_SERIAL_CTRL_GET_UNREAD_BYTES_COUNT 0x47 /* get unread bytes count. not supported in poll mode */
|
||
#define RT_SERIAL_CTRL_GET_CONFIG 0x48 /* get serial config */
|
||
|
||
#define RT_SERIAL_ERR_OVERRUN 0x01
|
||
#define RT_SERIAL_ERR_FRAMING 0x02
|
||
#define RT_SERIAL_ERR_PARITY 0x03
|
||
|
||
#define RT_SERIAL_RX_MINBUFSZ 64
|
||
#define RT_SERIAL_TX_MINBUFSZ 64
|
||
|
||
#define RT_SERIAL_TX_BLOCKING_BUFFER 1
|
||
#define RT_SERIAL_TX_BLOCKING_NO_BUFFER 0
|
||
|
||
#define RT_SERIAL_FLOWCONTROL_CTSRTS 1
|
||
#define RT_SERIAL_FLOWCONTROL_NONE 0
|
||
|
||
/* Default config for serial_configure structure */
|
||
#ifdef RT_SERIAL_USING_DMA
|
||
#define RT_SERIAL_CONFIG_DEFAULT \
|
||
{ \
|
||
BAUD_RATE_115200, /* 115200 bits/s */ \
|
||
DATA_BITS_8, /* 8 databits */ \
|
||
STOP_BITS_1, /* 1 stopbit */ \
|
||
PARITY_NONE, /* No parity */ \
|
||
BIT_ORDER_LSB, /* LSB first sent */ \
|
||
NRZ_NORMAL, /* Normal mode */ \
|
||
RT_SERIAL_RX_MINBUFSZ, /* rxBuf size */ \
|
||
RT_SERIAL_TX_MINBUFSZ, /* txBuf size */ \
|
||
RT_SERIAL_FLOWCONTROL_NONE, /* Off flowcontrol */ \
|
||
0, /* reserved */ \
|
||
RT_SERIAL_RX_MINBUFSZ / 2, /* dma_ping_bufsz */ \
|
||
}
|
||
#else
|
||
#define RT_SERIAL_CONFIG_DEFAULT \
|
||
{ \
|
||
BAUD_RATE_115200, /* 115200 bits/s */ \
|
||
DATA_BITS_8, /* 8 databits */ \
|
||
STOP_BITS_1, /* 1 stopbit */ \
|
||
PARITY_NONE, /* No parity */ \
|
||
BIT_ORDER_LSB, /* LSB first sent */ \
|
||
NRZ_NORMAL, /* Normal mode */ \
|
||
RT_SERIAL_RX_MINBUFSZ, /* rxBuf size */ \
|
||
RT_SERIAL_TX_MINBUFSZ, /* txBuf size */ \
|
||
RT_SERIAL_FLOWCONTROL_NONE, /* Off flowcontrol */ \
|
||
0, /* reserved */ \
|
||
}
|
||
#endif
|
||
|
||
/**
|
||
* @brief Serial receive indicate hook function type
|
||
*
|
||
*/
|
||
typedef void (*rt_hw_serial_rxind_hookproto_t)(rt_device_t dev, rt_size_t size);
|
||
RT_OBJECT_HOOKLIST_DECLARE(rt_hw_serial_rxind_hookproto_t, rt_hw_serial_rxind);
|
||
|
||
struct serial_configure
|
||
{
|
||
rt_uint32_t baud_rate;
|
||
|
||
rt_uint32_t data_bits :4;
|
||
rt_uint32_t stop_bits :2;
|
||
rt_uint32_t parity :2;
|
||
rt_uint32_t bit_order :1;
|
||
rt_uint32_t invert :1;
|
||
rt_uint32_t rx_bufsz :16;
|
||
rt_uint32_t tx_bufsz :16;
|
||
rt_uint32_t flowcontrol :1;
|
||
rt_uint32_t reserved :5;
|
||
|
||
#ifdef RT_SERIAL_USING_DMA
|
||
rt_uint32_t dma_ping_bufsz :16;
|
||
#endif
|
||
};
|
||
|
||
/**
|
||
* @brief Serial Receive FIFO mode
|
||
*/
|
||
struct rt_serial_rx_fifo
|
||
{
|
||
struct rt_ringbuffer rb;
|
||
|
||
#ifdef RT_SERIAL_USING_DMA
|
||
struct rt_ringbuffer dma_ping_rb;
|
||
#endif
|
||
|
||
struct rt_completion rx_cpt;
|
||
|
||
rt_size_t rx_cpt_index;
|
||
|
||
rt_atomic_t rx_timeout;
|
||
};
|
||
|
||
/**
|
||
* @brief Serial Transmit FIFO mode
|
||
*
|
||
*/
|
||
struct rt_serial_tx_fifo
|
||
{
|
||
struct rt_ringbuffer rb;
|
||
|
||
struct rt_completion tx_cpt;
|
||
|
||
rt_size_t put_size;
|
||
|
||
rt_atomic_t tx_timeout;
|
||
|
||
rt_atomic_t activated;
|
||
};
|
||
|
||
/**
|
||
* @brief serial device structure
|
||
*
|
||
*/
|
||
struct rt_serial_device
|
||
{
|
||
struct rt_device parent;
|
||
|
||
const struct rt_uart_ops *ops;
|
||
struct serial_configure config;
|
||
|
||
void *serial_rx;
|
||
void *serial_tx;
|
||
|
||
struct rt_spinlock spinlock;
|
||
|
||
#ifdef RT_USING_SERIAL_BYPASS
|
||
struct rt_serial_bypass* bypass;
|
||
#endif
|
||
|
||
struct rt_device_notify rx_notify;
|
||
|
||
#ifdef RT_USING_POSIX_STDIO
|
||
rt_bool_t is_posix_mode;
|
||
#endif
|
||
};
|
||
|
||
/**
|
||
* @brief uart device operations
|
||
*
|
||
*/
|
||
struct rt_uart_ops
|
||
{
|
||
rt_err_t (*configure)(struct rt_serial_device *serial,
|
||
struct serial_configure *cfg);
|
||
|
||
rt_err_t (*control)(struct rt_serial_device *serial,
|
||
int cmd,
|
||
void *arg);
|
||
|
||
int (*putc)(struct rt_serial_device *serial, char c);
|
||
int (*getc)(struct rt_serial_device *serial);
|
||
|
||
rt_ssize_t (*transmit)(struct rt_serial_device *serial,
|
||
rt_uint8_t *buf,
|
||
rt_size_t size,
|
||
rt_uint32_t tx_flag);
|
||
};
|
||
|
||
/**
|
||
* @brief Serial interrupt service routine
|
||
* @param serial serial device
|
||
* @param event event mask
|
||
* @ingroup group_drivers_serial_v2
|
||
*/
|
||
void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
|
||
|
||
rt_err_t rt_hw_serial_control_isr(struct rt_serial_device *serial, int cmd, void *args);
|
||
|
||
/**
|
||
* @brief Register a serial device to device list
|
||
*
|
||
* @param serial serial device
|
||
* @param name device name
|
||
* @param flag device flag
|
||
* @param data device private data
|
||
* @return rt_err_t error code
|
||
* @note This function will register a serial device to system device list,
|
||
* and add a device object to system object list.
|
||
* @ingroup group_drivers_serial_v2
|
||
*/
|
||
rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
|
||
const char *name,
|
||
rt_uint32_t flag,
|
||
void *data);
|
||
|
||
/**
|
||
* @brief register a serial device to system device list and add a device object to system object list
|
||
*
|
||
* @param serial serial device
|
||
* @return rt_err_t error code
|
||
*
|
||
* @ingroup group_drivers_serial_v2
|
||
*/
|
||
rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);
|
||
|
||
|
||
/*! @}*/
|
||
|
||
#endif
|