增加了大量注释

bsp/usart/bsp_usart.c

@@ -34,6 +34,9 @@ static void USARTServiceInit(USARTInstance *_instance)
 
 USARTInstance *USARTRegister(USART_Init_Config_s *init_config)
 {
+    if (idx >= DEVICE_USART_CNT) // 超过最大实例数
+        while (1)
+            ;
     USARTInstance *instance = (USARTInstance *)malloc(sizeof(USARTInstance));
     memset(instance, 0, sizeof(USARTInstance));
 

bsp/usart/bsp_usart.h

@@ -5,15 +5,14 @@
 #include "main.h"
 
 #define DEVICE_USART_CNT 3     // C板至多分配3个串口
-#define USART_RXBUFF_LIMIT 256 // if your protocol needs bigger buff, modify here
+#define USART_RXBUFF_LIMIT 256 // 如果协议需要更大的buff,请修改这里
 
-/* application callback,which resolves specific protocol,解析协议的回调函数 */
+// 模块回调函数,用于解析协议
 typedef void (*usart_module_callback)();
 
-/* USARTInstance struct,each app would have one instance */
+// 串口实例结构体,每个module都要包含一个实例
 typedef struct
 {
-    // 更新:弃用malloc方案,使用了固定大小的数组方便debug时查看
     uint8_t recv_buff[USART_RXBUFF_LIMIT]; // 预先定义的最大buff大小,如果太小请修改USART_RXBUFF_LIMIT
     uint8_t recv_buff_size;                // 模块接收一包数据的大小
     UART_HandleTypeDef *usart_handle;      // 实例对应的usart_handle
@@ -36,13 +35,10 @@ typedef struct
 USARTInstance *USARTRegister(USART_Init_Config_s *init_config);
 
 /**
- * @todo 是否需要进一步封装发送buff和size,并创建一个串口任务以一定频率自动发送?
- *       若采用此方法,则串口实例的拥有者仅需要在自己的任务中设置发送值,不需要关心发送buffer大小以及何时发送.
+ * @brief 通过调用该函数可以发送一帧数据,需要传入一个usart实例,发送buff以及这一帧的长度
  *
- * @brief api for sending data through a specific serial port,indicated by the first parameter:id
- *        通过调用该函数可以发送一帧数据,需要传入一个usart实例,发送buff以及这一帧的长度
- *
- * @param id specify which usart would be used
+ * @param _instance 串口实例
+ * @param send_buf 待发送数据的buffer
  * @param send_size how many bytes to send
  */
 void USARTSend(USARTInstance *_instance, uint8_t *send_buf, uint16_t send_size);