Imagelibrary/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-02-04 13:01:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(can): improve dev_can.h docs for batched RX example

Browse Source
This commit is contained in:
wdfk-prog
2026-02-02 15:32:10 +08:00
committed by R b b666
parent 1eaa85c581
commit 06e829b1b3
1 changed files with 29 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
components/drivers/include/drivers/dev_can.h
View File

@@ -132,22 +132,42 @@ enum CANBAUD
* res = rt_device_control(can_dev, RT_CAN_CMD_START, &cmd_arg); * res = rt_device_control(can_dev, RT_CAN_CMD_START, &cmd_arg);
* RT_ASSERT(res == RT_EOK); * RT_ASSERT(res == RT_EOK);
* *
* #define CAN_RX_BATCH_SIZE 8
*
* while (1) * while (1)
* { * {
* // Block and wait for the semaphore, which is released by the receive callback. * // Block and wait for the semaphore, which is released by the receive callback.
* rt_sem_take(&rx_sem, RT_WAITING_FOREVER); * rt_sem_take(&rx_sem, RT_WAITING_FOREVER);
* *
* // Read one frame of data from the CAN device's general message queue. * // Drain all pending frames in batches.
* rx_msg.hdr_index = -1; * struct rt_can_msg rx_buf[CAN_RX_BATCH_SIZE];
* rt_device_read(can_dev, 0, &rx_msg, sizeof(rx_msg)); * rt_ssize_t read_size;
* * rt_size_t count;
* // Print the received message's ID and data. * do
* rt_kprintf("Received a message. ID: 0x%x, Data: ", rx_msg.id);
* for (int i = 0; i < rx_msg.len; i++)
* { * {
* rt_kprintf("%02x ", rx_msg.data[i]); * for (rt_size_t i = 0; i < CAN_RX_BATCH_SIZE; i++)
* {
* rx_buf[i].hdr_index = -1;
* }
*
* read_size = rt_device_read(can_dev, 0, rx_buf, sizeof(rx_buf));
* if (read_size <= 0)
* {
* break;
* }
* count = (rt_size_t)(read_size / sizeof(rx_buf[0]));
* for (rt_size_t i = 0; i < count; i++)
* {
* // Print the received message's ID and data.
* rt_kprintf("Received a message. ID: 0x%x, Data: ", rx_buf[i].id);
* for (int j = 0; j < rx_buf[i].len; j++)
* {
* rt_kprintf("%02x ", rx_buf[i].data[j]);
* }
* rt_kprintf("\n");
* }
* } * }
* rt_kprintf("\n"); * while(count == CAN_RX_BATCH_SIZE);
* } * }
* } * }
* *