CAN Library Touch-Up (#400)

* Editing can_reva.c to be more readable.

* Adding warning to keep request structure in scope until the operation has completed.

* Adding request structure scope warnings to MAX32662 CAN header file.

---------

Co-authored-by: Scheiffler <[email protected]>
MSDK-Commit: 07cca94d65e2ac107c228157b287a48e4c4ea168

Author: Jacob-Scheiffler

MAX/Libraries/PeriphDrivers/Include/MAX32662/can.h

@@ -538,6 +538,8 @@ int MXC_CAN_MessageSend(uint32_t can_idx, mxc_can_req_t *req);
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32662 does not support CAN FD, setting req->msg_info->fdf will return an error.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          TX complete event has been signaled.
  */
 int MXC_CAN_MessageSendAsync(uint32_t can_idx, mxc_can_req_t *req);
 
@@ -550,6 +552,8 @@ int MXC_CAN_MessageSendAsync(uint32_t can_idx, mxc_can_req_t *req);
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32662 does not support CAN FD, setting req->msg_info->fdf will return an error.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          TX complete event has been signaled.
  */
 int MXC_CAN_MessageSendDMA(uint32_t can_idx, mxc_can_req_t *req);
 
@@ -574,6 +578,8 @@ int MXC_CAN_MessageRead(uint32_t can_idx, mxc_can_req_t *req);
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32662 does not support CAN FD, setting req->msg_info->fdf will return an error.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          RX complete event has been signaled.
  */
 int MXC_CAN_MessageReadAsync(uint32_t can_idx, mxc_can_req_t *req);
 
@@ -586,6 +592,8 @@ int MXC_CAN_MessageReadAsync(uint32_t can_idx, mxc_can_req_t *req);
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32662 does not support CAN FD, setting req->msg_info->fdf will return an error.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          RX complete event has been signaled.
  */
 int MXC_CAN_MessageReadDMA(uint32_t can_idx, mxc_can_req_t *req, void (*dma_cb)(int, int));
 

MAX/Libraries/PeriphDrivers/Include/MAX32690/can.h

@@ -534,12 +534,15 @@ int MXC_CAN_MessageSend(uint32_t can_idx, mxc_can_req_t *req);
 /**
  * @brief   Send message (non-blocking).
  * 
+ * 
  * @param can_idx   Index of the CAN peripheral to send the message from
  * @param req       Contains information about the format and data of message to send
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32690 does not support CAN FD, setting req->msg_info->fdf will return an error.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          TX complete event has been signaled.
  */
 int MXC_CAN_MessageSendAsync(uint32_t can_idx, mxc_can_req_t *req);
 
@@ -552,6 +555,8 @@ int MXC_CAN_MessageSendAsync(uint32_t can_idx, mxc_can_req_t *req);
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32690 does not support CAN FD, setting req->msg_info->fdf will return an error.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          TX complete event has been signaled.
  */
 int MXC_CAN_MessageSendDMA(uint32_t can_idx, mxc_can_req_t *req);
 
@@ -576,6 +581,8 @@ int MXC_CAN_MessageRead(uint32_t can_idx, mxc_can_req_t *req);
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32690 does not support receiving CAN FD messages.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          RX complete event has been signaled.
  */
 int MXC_CAN_MessageReadAsync(uint32_t can_idx, mxc_can_req_t *req);
 
@@ -588,6 +595,8 @@ int MXC_CAN_MessageReadAsync(uint32_t can_idx, mxc_can_req_t *req);
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  * 
  * @warning MAX32690 does not support receiving CAN FD messages.
+ * @warning The structure pointed to by 'req' must remain unchanged and in scope until the 
+ *          RX complete event has been signaled.
  */
 int MXC_CAN_MessageReadDMA(uint32_t can_idx, mxc_can_req_t *req, void (*dma_cb)(int, int));