1 /*
2 * Copyright (c) 2022-2024, Xiaohua Semiconductor Co., Ltd.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 *
6 * Change Logs:
7 * Date Author Notes
8 * 2024-12-30 CDT first version
9 */
10
11 /*
12 * 程序清单：这是一个串口设备
13 * 例程导出了 uart_sample_v2 命令到控制终端
14 *
15 * 命令解释：命令第二个参数是要使用的串口设备名称，为空则使用默认的串口设备(uart1)
16 * 程序功能：通过串口输出字符串:
17 * drv_usart: drv_usart_v1
18 * commnucation：using DMA/interrupt,
19 * uart_ch: uartx (x对应测试通道)
20 * 输出输入的字符
21 *
22 * 命令调用格式：
23 * uart1 中断，命令调用格式：uart_sample_v1 uart1 int
24 * uart1 DMA，命令调用格式：uart_sample_v1 uart1 dma
25 *
26 * 中断方式，rtconfig.h修改如下
27 * #define BSP_USING_GPIO
28 * #define BSP_USING_UART
29 * #define BSP_USING_UART1
30 * //#define BSP_UART1_RX_USING_DMA
31 * //#define BSP_UART1_TX_USING_DMA
32 * #define BSP_UART1_RX_BUFSIZE 256
33 * #define BSP_UART1_TX_BUFSIZE 256
34 * #define BSP_USING_UART2
35 * #define BSP_UART2_RX_USING_DMA
36 * #define BSP_UART2_TX_USING_DMA
37 * #define BSP_UART2_RX_BUFSIZE 256
38 * #define BSP_UART2_TX_BUFSIZE 0
39 * #define BSP_USING_UART5
40 * //#define BSP_UART5_RX_USING_DMA
41 * //#define BSP_UART5_TX_USING_DMA
42 * #define BSP_UART5_RX_BUFSIZE 256
43 * #define BSP_UART5_TX_BUFSIZE 256
44 *
45 * DMA方式，rtconfig.h修改如下
46 * #define BSP_USING_GPIO
47 * #define BSP_USING_UART
48 * #define BSP_USING_UART1
49 * #define BSP_UART1_RX_USING_DMA
50 * #define BSP_UART1_TX_USING_DMA
51 * #define BSP_UART1_RX_BUFSIZE 256
52 * #define BSP_UART1_TX_BUFSIZE 256
53 * #define BSP_USING_UART2
54 * #define BSP_UART2_RX_USING_DMA
55 * #define BSP_UART2_TX_USING_DMA
56 * #define BSP_UART2_RX_BUFSIZE 256
57 * #define BSP_UART2_TX_BUFSIZE 0
58 * #define BSP_USING_UART5
59 * #define BSP_UART5_RX_USING_DMA
60 * #define BSP_UART5_TX_USING_DMA
61 * #define BSP_UART5_RX_BUFSIZE 256
62 * #define BSP_UART5_TX_BUFSIZE 256
63 *
64 */
65
66 #include <rtthread.h>
67 #include <rtdevice.h>
68
69 #if defined(HC32F460) && defined(BSP_USING_UART2)
70 #define SAMPLE_DEFAULT_UART_NAME "uart2"
71 #elif defined(HC32F4A0) && defined (BSP_USING_UART6)
72 #define SAMPLE_DEFAULT_UART_NAME "uart6"
73 #elif defined(HC32F448) && defined (BSP_USING_UART1)
74 #define SAMPLE_DEFAULT_UART_NAME "uart1"
75 #elif defined(HC32F472) && defined (BSP_USING_UART1)
76 #define SAMPLE_DEFAULT_UART_NAME "uart1"
77 #elif defined(HC32F4A8) && defined (BSP_USING_UART6)
78 #define SAMPLE_DEFAULT_UART_NAME "uart6"
79 #elif defined(HC32F334) && defined (BSP_USING_UART1)
80 #define SAMPLE_DEFAULT_UART_NAME "uart1"
81 #endif
82
83 #if defined(SAMPLE_DEFAULT_UART_NAME)
84
85 /* 串口接收消息结构 */
86 struct rx_msg
87 {
88 rt_device_t dev;
89 rt_size_t size;
90 };
91 /* 串口设备句柄 */
92 static rt_device_t serial;
93 /* 消息队列控制块 */
94 static struct rt_messagequeue rx_mq;
95
96 /* 用于接收消息的信号量 */
97 static struct rt_semaphore rx_sem;
98
99 static rt_device_t serial;
100 static struct serial_configure config = RT_SERIAL_CONFIG_DEFAULT;
101
102 /* DMA接收数据回调函数 */
uart_input_dma(rt_device_t dev,rt_size_t size)103 static rt_err_t uart_input_dma(rt_device_t dev, rt_size_t size)
104 {
105 struct rx_msg msg;
106 rt_err_t result;
107 msg.dev = dev;
108 msg.size = size;
109
110 result = rt_mq_send(&rx_mq, &msg, sizeof(msg));
111 if (result == -RT_EFULL)
112 {
113 /* 消息队列满 */
114 rt_kprintf("message queue full!\n");
115 }
116 return result;
117 }
118
119 /* INT接收数据回调函数 */
uart_input_int(rt_device_t dev,rt_size_t size)120 static rt_err_t uart_input_int(rt_device_t dev, rt_size_t size)
121 {
122 /* 串口接收到数据后产生中断，调用此回调函数，然后发送接收信号量 */
123 rt_sem_release(&rx_sem);
124
125 return RT_EOK;
126 }
127
128 /* 发送完成回调函数 */
uart_ouput(rt_device_t dev,void * buffer)129 static rt_err_t uart_ouput(rt_device_t dev, void *buffer)
130 {
131 return RT_EOK;
132 }
133
serial_thread_entry_dma(void * parameter)134 static void serial_thread_entry_dma(void *parameter)
135 {
136 struct rx_msg msg;
137 rt_err_t result;
138 rt_uint32_t rx_length;
139 static char rx_buffer[256];
140 static rt_uint32_t buf_size = sizeof(rx_buffer);
141 static rt_uint32_t put_index = 0;
142
143 while (1)
144 {
145 rt_memset(&msg, 0, sizeof(msg));
146 /* 从消息队列中读取消息 */
147 result = rt_mq_recv(&rx_mq, &msg, sizeof(msg), RT_WAITING_FOREVER);
148 if (result > 0UL)
149 {
150 while (msg.size)
151 {
152 if (msg.size > (buf_size - put_index))
153 {
154 rx_length = rt_device_read(msg.dev, 0, rx_buffer + put_index, buf_size - put_index);
155 msg.size -= rx_length;
156 }
157 else
158 {
159 rx_length = rt_device_read(msg.dev, 0, rx_buffer + put_index, msg.size);
160 msg.size = 0UL;
161 }
162 rt_device_write(serial, 0, rx_buffer + put_index, rx_length);
163 put_index += rx_length;
164 put_index %= sizeof(rx_buffer);
165 }
166 }
167 }
168 }
169
serial_thread_entry_int(void * parameter)170 static void serial_thread_entry_int(void *parameter)
171 {
172 char ch;
173
174 while (1)
175 {
176 /* 从串口读取一个字节的数据，没有读取到则等待接收信号量 */
177 while (rt_device_read(serial, -1, &ch, 1) != 1)
178 {
179 /* 阻塞等待接收信号量，等到信号量后再次读取数据 */
180 rt_sem_take(&rx_sem, RT_WAITING_FOREVER);
181 }
182 /* 读取到的数据通过串口错位输出 */
183 rt_device_write(serial, 0, &ch, 1);
184 }
185 }
186
uart_sample_v2(int argc,char * argv[])187 int uart_sample_v2(int argc, char *argv[])
188 {
189 rt_thread_t thread;
190 rt_err_t ret = RT_EOK;
191 rt_size_t n;
192 rt_err_t open_flag = 0UL;
193 static char uart_name[RT_NAME_MAX];
194 static char comm_mode[RT_NAME_MAX];
195 const static char comm_mode_int[] = "int";
196 const static char comm_mode_dma[] = "dma";
197 const static char comm_info_dma[] = "\r\n drv_version: drv_usart_v2 \r\n communication: using DMA \r\n uart_ch: ";
198 const static char comm_info_int[] = "\r\n drv_version: drv_usart_v2 \r\n communication: using interrupt \r\n uart_ch: ";
199 static char comm_info[150];
200
201 rt_memset(uart_name, 0, sizeof(uart_name));
202 rt_memset(comm_mode, 0, sizeof(comm_mode));
203
204 if (argc == 1)
205 {
206 rt_strncpy(uart_name, SAMPLE_DEFAULT_UART_NAME, RT_NAME_MAX);
207 rt_strncpy(comm_mode, comm_mode_int, sizeof(comm_mode_int));
208 }
209 else if (argc == 2)
210 {
211 rt_strncpy(uart_name, argv[1], RT_NAME_MAX);
212 rt_strncpy(comm_mode, comm_mode_int, sizeof(comm_mode_int));
213 }
214 else if (argc == 3)
215 {
216 rt_strncpy(uart_name, argv[1], RT_NAME_MAX);
217 rt_strncpy(comm_mode, argv[2], RT_NAME_MAX);
218 }
219 else
220 {
221 rt_kprintf("argc error!\n");
222 return -RT_ERROR;
223 }
224
225 /* 查找串口设备 */
226 serial = rt_device_find(uart_name);
227 if (!serial)
228 {
229 rt_kprintf("find %s failed!\n", uart_name);
230 return -RT_ERROR;
231 }
232
233 /* modify configure */
234 config.baud_rate = BAUD_RATE_115200; //baudrate 115200
235 config.data_bits = DATA_BITS_8; //data bit 8
236 config.stop_bits = STOP_BITS_1; //stop bit 1
237 config.parity = PARITY_NONE;
238 rt_device_control(serial, RT_DEVICE_CTRL_CONFIG, &config);
239
240 if (0 == rt_strncmp(comm_mode, comm_mode_dma, 3))
241 {
242 static char msg_pool[256U];
243 /* 初始化消息队列 */
244 rt_mq_init(&rx_mq, "rx_mq",
245 msg_pool, /* 存放消息的缓冲区 */
246 sizeof(struct rx_msg), /* 一条消息的最大长度 */
247 sizeof(msg_pool), /* 存放消息的缓冲区大小 */
248 RT_IPC_FLAG_FIFO); /* 如果有多个线程等待，按照先来先得到的方法分配消息 */
249
250 /* 以DMA接收和发送模式打开串口设备 */
251 open_flag |= RT_DEVICE_FLAG_DMA_RX | RT_DEVICE_FLAG_DMA_TX;
252 rt_device_open(serial, open_flag);
253
254 /* 设置回调函数 */
255 rt_device_set_rx_indicate(serial, uart_input_dma);
256 rt_device_set_tx_complete(serial, uart_ouput);
257
258 /* 发送字符串 */
259 n = rt_strlen(comm_info_dma);
260 rt_strncpy(comm_info, comm_info_dma, n);
261 rt_strncpy(comm_info + n, uart_name, rt_strlen(uart_name));
262 rt_device_write(serial, 0, comm_info, rt_strlen(comm_info));
263
264 /* 创建 serial 线程 */
265 thread = rt_thread_create("serial", serial_thread_entry_dma, RT_NULL, 1024, 25, 10);
266 }
267 else if (0 == rt_strncmp(comm_mode, comm_mode_int, 3))
268 {
269 /* 以中断模式打开串口设备 */
270 open_flag = RT_DEVICE_FLAG_INT_RX | RT_DEVICE_FLAG_INT_TX;
271 rt_sem_init(&rx_sem, "rx_sem", 0, RT_IPC_FLAG_FIFO);
272
273 rt_device_open(serial, open_flag);
274
275 /* 设置回调函数 */
276 rt_device_set_rx_indicate(serial, uart_input_int);
277 rt_device_set_tx_complete(serial, uart_ouput);
278
279 /* 发送字符串 */
280 n = rt_strlen(comm_info_int);
281 rt_strncpy(comm_info, comm_info_int, n);
282 rt_strncpy(comm_info + n, uart_name, rt_strlen(uart_name));
283 rt_device_write(serial, 0, comm_info, rt_strlen(comm_info));
284
285 /* 创建 serial 线程 */
286 thread = rt_thread_create("serial", serial_thread_entry_int, RT_NULL, 1024, 25, 10);
287 }
288 else
289 {
290 rt_kprintf("communication mode error, please input cmd: uart_sample_v2 %s int or uart_sample_v1 uartx dma!\n", uart_name);
291 return -RT_ERROR;
292 }
293
294 if (thread != RT_NULL)
295 {
296 rt_thread_startup(thread);
297 }
298 else
299 {
300 ret = -RT_ERROR;
301 }
302
303 return ret;
304 }
305 /* 导出到 msh 命令列表中 */
306 MSH_CMD_EXPORT(uart_sample_v2, uart device sample);
307
308 #endif
309