Merge pull request #53 from bcmi-labs/can-api

Use ArduinoCore-API/HardwareCAN.

Author: facchinm

libraries/CAN/examples/CAN1Read/CAN1Read.ino renamed to libraries/Arduino_CAN/examples/CAN1Read/CAN1Read.ino

@@ -2,7 +2,7 @@
  * INCLUDE
  **************************************************************************************/
 
-#include <CAN.h>
+#include <Arduino_CAN.h>
 
 /**************************************************************************************
  * SETUP/LOOP

libraries/CAN/examples/CAN1Write/CAN1Write.ino renamed to libraries/Arduino_CAN/examples/CAN1Write/CAN1Write.ino

@@ -2,7 +2,7 @@
  * INCLUDE
  **************************************************************************************/
 
-#include <CAN.h>
+#include <Arduino_CAN.h>
 
 /**************************************************************************************
  * CONSTANTS

libraries/CAN/examples/CANRead/CANRead.ino renamed to libraries/Arduino_CAN/examples/CANRead/CANRead.ino

@@ -2,7 +2,7 @@
  * INCLUDE
  **************************************************************************************/
 
-#include <CAN.h>
+#include <Arduino_CAN.h>
 
 /**************************************************************************************
  * SETUP/LOOP

libraries/CAN/examples/CANWrite/CANWrite.ino renamed to libraries/Arduino_CAN/examples/CANWrite/CANWrite.ino

@@ -2,7 +2,7 @@
  * INCLUDE
  **************************************************************************************/
 
-#include <CAN.h>
+#include <Arduino_CAN.h>
 
 /**************************************************************************************
  * CONSTANTS

libraries/CAN/extras/test/.gitignore renamed to libraries/Arduino_CAN/extras/test/.gitignore

@@ -1,4 +1,4 @@
-name=CAN
+name=Arduino_CAN
 version=1.0
 author=Arduino
 maintainer=Arduino <[email protected]>
@@ -7,4 +7,4 @@ paragraph=This library provides CAN/CANFD access for Uno R4 and Portenta H33.
 category=Other
 url=
 architectures=renesas
-include=CAN.h
+include=Arduino_CAN.h

libraries/CAN/extras/test/CMakeLists.txt renamed to libraries/Arduino_CAN/extras/test/CMakeLists.txt

@@ -19,7 +19,7 @@
 
 #include <tuple>
 
-#include "HardwareCAN.h"
+#include "api/HardwareCAN.h"
 
 /**************************************************************************************
  * NAMESPACE

libraries/CAN/extras/test/README.md renamed to libraries/Arduino_CAN/extras/test/README.md

@@ -19,13 +19,13 @@
 
 #ifdef ARDUINO_SANTIAGO
 
-#include "HardwareCAN.h"
+#include "api/HardwareCAN.h"
 
 #include "bsp_api.h"
 
 #include "r_can.h"
 
-#include "CanMsgRingbuffer.h"
+#include "SyncCanMsgRingbuffer.h"
 
 /**************************************************************************************
  * TYPEDEF
@@ -78,7 +78,7 @@ class R7FA4M1_CAN final : public HardwareCAN
   int const _can_rx_pin;
   bool _is_error;
   int _err_code;
-  CanMsgRingbuffer _can_rx_buf;
+  SyncCanMsgRingbuffer _can_rx_buf;
 
   can_instance_ctrl_t _can_ctrl;
   can_bit_timing_cfg_t _can_bit_timing_cfg;

libraries/CAN/extras/test/external/catch2/v2.13.10/include/catch2/catch.hpp renamed to libraries/Arduino_CAN/extras/test/external/catch2/v2.13.10/include/catch2/catch.hpp

@@ -19,15 +19,15 @@
 
 #ifdef ARDUINO_PORTENTA_H33
 
-#include "HardwareCAN.h"
+#include "api/HardwareCAN.h"
 
 #include  <tuple>
 
 #include "bsp_api.h"
 
 #include "r_canfd.h"
 
-#include "CanMsgRingbuffer.h"
+#include "SyncCanMsgRingbuffer.h"
 
 /**************************************************************************************
  * TYPEDEF
@@ -78,7 +78,7 @@ class R7FA6M5_CAN final : public HardwareCAN
   int const _can_rx_pin;
   bool _is_error;
   int _err_code;
-  CanMsgRingbuffer _can_rx_buf;
+  SyncCanMsgRingbuffer _can_rx_buf;
 
   canfd_instance_ctrl_t _canfd_ctrl;
   can_bit_timing_cfg_t _canfd_bit_timing_cfg;

libraries/CAN/extras/test/src/test_calc_can_bit_timinig.cpp renamed to libraries/Arduino_CAN/extras/test/src/test_calc_can_bit_timinig.cpp

@@ -15,9 +15,8 @@
  * INCLUDE
  **************************************************************************************/
 
-#include <cstdint>
+#include "api/HardwareCAN.h"
 
-#include "CanMsg.h"
 #include "sync.h"
 
 /**************************************************************************************
@@ -31,28 +30,22 @@ namespace arduino
  * CLASS DECLARATION
  **************************************************************************************/
 
-class CanMsgRingbuffer
+class SyncCanMsgRingbuffer
 {
 public:
-  static size_t constexpr RING_BUFFER_SIZE = 32U;
+  SyncCanMsgRingbuffer() : _can_msg_buf{} { }
 
-  CanMsgRingbuffer();
 
-  inline bool isFull() const { synchronized { return (_num_elems == RING_BUFFER_SIZE); } }
-  void enqueue(CanMsg const & msg);
+  bool isFull() const { synchronized { _can_msg_buf.isFull(); } }
+  void enqueue(CanMsg const & msg) { synchronized { _can_msg_buf.enqueue(msg); } }
 
-  inline bool isEmpty() const { synchronized { return (_num_elems == 0); } }
-  CanMsg dequeue();
+  bool isEmpty() const { synchronized { return _can_msg_buf.isEmpty(); } }
+  CanMsg dequeue() { synchronized { return _can_msg_buf.dequeue(); } }
 
-  inline size_t available() const { synchronized { return _num_elems; } }
+  size_t available() const { synchronized { return _can_msg_buf.available(); } }
 
 private:
-  CanMsg _buf[RING_BUFFER_SIZE];
-  volatile size_t _head;
-  volatile size_t _tail;
-  volatile size_t _num_elems;
-
-  inline size_t next(size_t const idx) const { return ((idx + 1) % RING_BUFFER_SIZE); }
+  CanMsgRingbuffer _can_msg_buf;
 };
 
 /**************************************************************************************