Serial v2

Serial v2 的协作图:

结构体
struct	serial_configure
struct	rt_serial_rx_fifo
struct	rt_serial_tx_fifo
struct	rt_serial_device
struct	rt_uart_ops

宏定义
#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
#define	PARITY_NONE   0
#define	PARITY_ODD   1
#define	PARITY_EVEN   2
#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 */
#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
#define	RT_DEVICE_CHECK_OPTMODE   0x20
#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 */
#define	RT_SERIAL_EVENT_RX_TIMEOUT   0x05 /* Rx timeout */
#define	RT_SERIAL_ERR_OVERRUN   0x01
#define	RT_SERIAL_ERR_FRAMING   0x02
#define	RT_SERIAL_ERR_PARITY   0x03
#define	RT_SERIAL_TX_DATAQUEUE_SIZE   2048
#define	RT_SERIAL_TX_DATAQUEUE_LWM   30
#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
#define	RT_SERIAL_CONFIG_DEFAULT

类型定义
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)
void	rt_hw_serial_isr (struct rt_serial_device *serial, int event)
rt_err_t	rt_hw_serial_register (struct rt_serial_device *serial, const char *name, rt_uint32_t flag, void *data)
rt_err_t	rt_hw_serial_register_tty (struct rt_serial_device *serial)

详细描述

Serial v2 driver api

Example

#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);

宏定义说明

BAUD_RATE_2400

#define BAUD_RATE_2400   2400

在文件 dev_serial_v2.h 第 132 行定义.

BAUD_RATE_4800

#define BAUD_RATE_4800   4800

在文件 dev_serial_v2.h 第 133 行定义.

BAUD_RATE_9600

#define BAUD_RATE_9600   9600

在文件 dev_serial_v2.h 第 134 行定义.

BAUD_RATE_19200

#define BAUD_RATE_19200   19200

在文件 dev_serial_v2.h 第 135 行定义.

BAUD_RATE_38400

#define BAUD_RATE_38400   38400

在文件 dev_serial_v2.h 第 136 行定义.

BAUD_RATE_57600

#define BAUD_RATE_57600   57600

在文件 dev_serial_v2.h 第 137 行定义.

BAUD_RATE_115200

#define BAUD_RATE_115200   115200

在文件 dev_serial_v2.h 第 138 行定义.

BAUD_RATE_230400

#define BAUD_RATE_230400   230400

在文件 dev_serial_v2.h 第 139 行定义.

BAUD_RATE_460800

#define BAUD_RATE_460800   460800

在文件 dev_serial_v2.h 第 140 行定义.

BAUD_RATE_500000

#define BAUD_RATE_500000   500000

在文件 dev_serial_v2.h 第 141 行定义.

BAUD_RATE_921600

#define BAUD_RATE_921600   921600

在文件 dev_serial_v2.h 第 142 行定义.

BAUD_RATE_2000000

#define BAUD_RATE_2000000   2000000

在文件 dev_serial_v2.h 第 143 行定义.

BAUD_RATE_2500000

#define BAUD_RATE_2500000   2500000

在文件 dev_serial_v2.h 第 144 行定义.

BAUD_RATE_3000000

#define BAUD_RATE_3000000   3000000

在文件 dev_serial_v2.h 第 145 行定义.

DATA_BITS_5

#define DATA_BITS_5   5

在文件 dev_serial_v2.h 第 147 行定义.

DATA_BITS_6

#define DATA_BITS_6   6

在文件 dev_serial_v2.h 第 148 行定义.

DATA_BITS_7

#define DATA_BITS_7   7

在文件 dev_serial_v2.h 第 149 行定义.

DATA_BITS_8

#define DATA_BITS_8   8

在文件 dev_serial_v2.h 第 150 行定义.

DATA_BITS_9

#define DATA_BITS_9   9

在文件 dev_serial_v2.h 第 151 行定义.

STOP_BITS_1

#define STOP_BITS_1   0

在文件 dev_serial_v2.h 第 153 行定义.

STOP_BITS_2

#define STOP_BITS_2   1

在文件 dev_serial_v2.h 第 154 行定义.

STOP_BITS_3

#define STOP_BITS_3   2

在文件 dev_serial_v2.h 第 155 行定义.

STOP_BITS_4

#define STOP_BITS_4   3

在文件 dev_serial_v2.h 第 156 行定义.

PARITY_NONE

#define PARITY_NONE   0

在文件 dev_serial_v2.h 第 161 行定义.

PARITY_ODD

#define PARITY_ODD   1

在文件 dev_serial_v2.h 第 162 行定义.

PARITY_EVEN

#define PARITY_EVEN   2

在文件 dev_serial_v2.h 第 163 行定义.

BIT_ORDER_LSB

#define BIT_ORDER_LSB   0

在文件 dev_serial_v2.h 第 166 行定义.

BIT_ORDER_MSB

#define BIT_ORDER_MSB   1

在文件 dev_serial_v2.h 第 167 行定义.

NRZ_NORMAL

#define NRZ_NORMAL   0 /* Non Return to Zero : normal mode */

在文件 dev_serial_v2.h 第 169 行定义.

NRZ_INVERTED

#define NRZ_INVERTED   1 /* Non Return to Zero : inverted mode */

在文件 dev_serial_v2.h 第 170 行定义.

RT_DEVICE_FLAG_RX_BLOCKING

#define RT_DEVICE_FLAG_RX_BLOCKING   0x1000

在文件 dev_serial_v2.h 第 172 行定义.

RT_DEVICE_FLAG_RX_NON_BLOCKING

#define RT_DEVICE_FLAG_RX_NON_BLOCKING   0x2000

在文件 dev_serial_v2.h 第 173 行定义.

RT_DEVICE_FLAG_TX_BLOCKING

#define RT_DEVICE_FLAG_TX_BLOCKING   0x4000

在文件 dev_serial_v2.h 第 175 行定义.

RT_DEVICE_FLAG_TX_NON_BLOCKING

#define RT_DEVICE_FLAG_TX_NON_BLOCKING   0x8000

在文件 dev_serial_v2.h 第 176 行定义.

RT_SERIAL_RX_BLOCKING

#define RT_SERIAL_RX_BLOCKING   RT_DEVICE_FLAG_RX_BLOCKING

在文件 dev_serial_v2.h 第 178 行定义.

RT_SERIAL_RX_NON_BLOCKING

#define RT_SERIAL_RX_NON_BLOCKING   RT_DEVICE_FLAG_RX_NON_BLOCKING

在文件 dev_serial_v2.h 第 179 行定义.

RT_SERIAL_TX_BLOCKING

#define RT_SERIAL_TX_BLOCKING   RT_DEVICE_FLAG_TX_BLOCKING

在文件 dev_serial_v2.h 第 180 行定义.

RT_SERIAL_TX_NON_BLOCKING

#define RT_SERIAL_TX_NON_BLOCKING   RT_DEVICE_FLAG_TX_NON_BLOCKING

在文件 dev_serial_v2.h 第 181 行定义.

RT_DEVICE_CHECK_OPTMODE

#define RT_DEVICE_CHECK_OPTMODE   0x20

在文件 dev_serial_v2.h 第 183 行定义.

RT_SERIAL_EVENT_RX_IND

#define RT_SERIAL_EVENT_RX_IND   0x01 /* Rx indication */

在文件 dev_serial_v2.h 第 185 行定义.

RT_SERIAL_EVENT_TX_DONE

#define RT_SERIAL_EVENT_TX_DONE   0x02 /* Tx complete */

在文件 dev_serial_v2.h 第 186 行定义.

RT_SERIAL_EVENT_RX_DMADONE

#define RT_SERIAL_EVENT_RX_DMADONE   0x03 /* Rx DMA transfer done */

在文件 dev_serial_v2.h 第 187 行定义.

RT_SERIAL_EVENT_TX_DMADONE

#define RT_SERIAL_EVENT_TX_DMADONE   0x04 /* Tx DMA transfer done */

在文件 dev_serial_v2.h 第 188 行定义.

RT_SERIAL_EVENT_RX_TIMEOUT

#define RT_SERIAL_EVENT_RX_TIMEOUT   0x05 /* Rx timeout */

在文件 dev_serial_v2.h 第 189 行定义.

RT_SERIAL_ERR_OVERRUN

#define RT_SERIAL_ERR_OVERRUN   0x01

在文件 dev_serial_v2.h 第 191 行定义.

RT_SERIAL_ERR_FRAMING

#define RT_SERIAL_ERR_FRAMING   0x02

在文件 dev_serial_v2.h 第 192 行定义.

RT_SERIAL_ERR_PARITY

#define RT_SERIAL_ERR_PARITY   0x03

在文件 dev_serial_v2.h 第 193 行定义.

RT_SERIAL_TX_DATAQUEUE_SIZE

#define RT_SERIAL_TX_DATAQUEUE_SIZE   2048

在文件 dev_serial_v2.h 第 195 行定义.

RT_SERIAL_TX_DATAQUEUE_LWM

#define RT_SERIAL_TX_DATAQUEUE_LWM   30

在文件 dev_serial_v2.h 第 196 行定义.

RT_SERIAL_RX_MINBUFSZ

#define RT_SERIAL_RX_MINBUFSZ   64

在文件 dev_serial_v2.h 第 198 行定义.

RT_SERIAL_TX_MINBUFSZ

#define RT_SERIAL_TX_MINBUFSZ   64

在文件 dev_serial_v2.h 第 199 行定义.

RT_SERIAL_TX_BLOCKING_BUFFER

#define RT_SERIAL_TX_BLOCKING_BUFFER   1

在文件 dev_serial_v2.h 第 201 行定义.

RT_SERIAL_TX_BLOCKING_NO_BUFFER

#define RT_SERIAL_TX_BLOCKING_NO_BUFFER   0

在文件 dev_serial_v2.h 第 202 行定义.

RT_SERIAL_FLOWCONTROL_CTSRTS

#define RT_SERIAL_FLOWCONTROL_CTSRTS   1

在文件 dev_serial_v2.h 第 204 行定义.

RT_SERIAL_FLOWCONTROL_NONE

#define RT_SERIAL_FLOWCONTROL_NONE   0

在文件 dev_serial_v2.h 第 205 行定义.

RT_SERIAL_CONFIG_DEFAULT

#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                                                 \
}

在文件 dev_serial_v2.h 第 208 行定义.

#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                                                 \
}

类型定义说明

rt_hw_serial_rxind_hookproto_t

typedef void(* rt_hw_serial_rxind_hookproto_t) (rt_device_t dev, rt_size_t size)

Serial receive indicate hook function type

在文件 dev_serial_v2.h 第 226 行定义.

函数说明

RT_OBJECT_HOOKLIST_DECLARE()

RT_OBJECT_HOOKLIST_DECLARE	(	rt_hw_serial_rxind_hookproto_t	,
		rt_hw_serial_rxind	)

rt_hw_serial_isr()

void rt_hw_serial_isr	(	struct rt_serial_device *	serial,
		int	event )

Serial interrupt service routine

参数

serial	serial device
event	event mask

rt_hw_serial_register()

rt_err_t rt_hw_serial_register	(	struct rt_serial_device *	serial,
		const char *	name,
		rt_uint32_t	flag,
		void *	data )

Register a serial device to device list

参数

serial	serial device
name	device name
flag	device flag
data	device private data

返回

rt_err_t error code

注解

This function will register a serial device to system device list, and add a device object to system object list.

rt_hw_serial_register_tty()

rt_err_t rt_hw_serial_register_tty

(

struct rt_serial_device *

serial

)

register a serial device to system device list and add a device object to system object list

参数

serial

serial device

返回

rt_err_t error code