增加了大量注释

bsp/can/bsp_can.h

@@ -4,10 +4,10 @@
 #include <stdint.h>
 #include "can.h"
 
-#define MX_REGISTER_DEVICE_CNT 12  // maximum number of device can be registered to CAN service
-                                   // this number depends on the load of CAN bus.
-#define MX_CAN_FILTER_CNT (2 * 14) // temporarily useless
-#define DEVICE_CAN_CNT 2           // CAN1,CAN2
+// 最多能够支持的CAN设备数
+#define CAN_MX_REGISTER_CNT 16     // 这个数量取决于CAN总线的负载
+#define MX_CAN_FILTER_CNT (2 * 14) // 最多可以使用的CAN过滤器数量,目前远不会用到这么多
+#define DEVICE_CAN_CNT 2           // 根据板子设定,F407IG有CAN1,CAN2,因此为2;F334只有一个,则设为1
 
 /* can instance typedef, every module registered to CAN should have this variable */
 #pragma pack(1)
@@ -23,20 +23,28 @@ typedef struct _
     uint8_t rx_len;                // 接收长度,可能为0-8
     // 接收的回调函数,用于解析接收到的数据
     void (*can_module_callback)(struct _ *); // callback needs an instance to tell among registered ones
-    void* id; // 使用can外设的
+    void *id;                                // 使用can外设的
 } CANInstance;
 #pragma pack()
 
-/* this structure is used for initialization */
+/* CAN实例初始化结构体,将此结构体指针传入注册函数 */
 typedef struct
 {
-    CAN_HandleTypeDef *can_handle;
-    uint32_t tx_id;
-    uint32_t rx_id;
-    void (*can_module_callback)(CANInstance *);
-    void* id;
+    CAN_HandleTypeDef *can_handle;              // can句柄
+    uint32_t tx_id;                             // 发送id
+    uint32_t rx_id;                             // 接收id
+    void (*can_module_callback)(CANInstance *); // 处理接收数据的回调函数
+    void *id;                                   // 拥有can实例的模块地址,用于区分不同的模块(如果有需要的话),如果不需要可以不传入
 } CAN_Init_Config_s;
 
+/**
+ * @brief Register a module to CAN service,remember to call this before using a CAN device
+ *        注册(初始化)一个can实例,需要传入初始化配置的指针.
+ * @param config init config
+ * @return CANInstance* can instance owned by module
+ */
+CANInstance *CANRegister(CAN_Init_Config_s *config);
+
 /**
  * @brief 修改CAN发送报文的数据帧长度;注意最大长度为8,在没有进行修改的时候,默认长度为8
  *
@@ -53,12 +61,4 @@ void CANSetDLC(CANInstance *_instance, uint8_t length);
  */
 void CANTransmit(CANInstance *_instance);
 
-/**
- * @brief Register a module to CAN service,remember to call this before using a CAN device
- *        注册(初始化)一个can实例,需要传入初始化配置的指针.
- * @param config init config
- * @return CANInstance* can instance owned by module
- */
-CANInstance *CANRegister(CAN_Init_Config_s *config);
-
 #endif