Provide abstract base class HardwareCAN (prepare for ArduinoCore-API).

Author: aentinger

Diff for: libraries/CAN/src/CanConst.h

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

Diff for: libraries/CAN/src/CanUtil.h

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2022 by Alexander Entinger <[email protected]>
+ * CAN library for Arduino.
+ *
+ * This file is free software; you can redistribute it and/or modify
+ * it under the terms of either the GNU General Public License version 2
+ * or the GNU Lesser General Public License version 2.1, both as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef ARDUINOCORE_RENESAS_HARDWARECAN_H
+#define ARDUINOCORE_RENESAS_HARDWARECAN_H
+
+/**************************************************************************************
+ * INCLUDE
+ **************************************************************************************/
+
+#include "CanMsg.h"
+
+/**************************************************************************************
+ * TYPEDEF
+ **************************************************************************************/
+
+enum class CanBitRate : int
+{
+  BR_125k  =  125000,
+  BR_250k  =  250000,
+  BR_500k  =  500000,
+  BR_1000k = 1000000,
+};
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+namespace arduino
+{
+
+/**************************************************************************************
+ * CLASS DECLARATION
+ **************************************************************************************/
+
+class HardwareCAN
+{
+public:
+  virtual ~HardwareCAN() {}
+
+
+  virtual bool begin(CanBitRate const can_bitrate) = 0;
+  virtual void end() = 0;
+
+
+  virtual int write(CanMsg const &msg) = 0;
+  virtual size_t available() = 0;
+  virtual CanMsg read() = 0;
+};
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+} /* arduino */
+
+#endif /* ARDUINOCORE_RENESAS_HARDWARECAN_H */

Diff for: libraries/CAN/src/HardwareCAN.h

@@ -221,7 +221,7 @@ int R7FA4M1_CAN::write(CanMsg const & msg)
   return 1;
 }
 
-size_t R7FA4M1_CAN::available() const
+size_t R7FA4M1_CAN::available()
 {
   return _can_rx_buf.available();
 }

Diff for: libraries/CAN/src/R7FA4M1_CAN.cpp

@@ -19,12 +19,12 @@
 
 #ifdef ARDUINO_SANTIAGO
 
+#include "HardwareCAN.h"
+
 #include "bsp_api.h"
 
 #include "r_can.h"
 
-#include "CanMsg.h"
-#include "CanConst.h"
 #include "CanMsgRingbuffer.h"
 
 /**************************************************************************************
@@ -44,23 +44,24 @@ namespace arduino
  * CLASS DECLARATION
  **************************************************************************************/
 
-class R7FA4M1_CAN
+class R7FA4M1_CAN final : public HardwareCAN
 {
 public:
   R7FA4M1_CAN(int const can_tx_pin, int const can_rx_pin);
+  virtual ~R7FA4M1_CAN() { }
 
 
-  bool begin(CanBitRate const can_bitrate);
-  void end();
+  bool begin(CanBitRate const can_bitrate) override;
+  void end() override;
 
 
   int enableInternalLoopback();
   int disableInternalLoopback();
 
 
-  int write(CanMsg const & msg);
-  size_t available() const;
-  CanMsg read();
+  int write(CanMsg const & msg) override;
+  size_t available() override;
+  CanMsg read() override;
 
 
   inline bool isError(int & err_code) const { err_code = _err_code; return _is_error; }

Diff for: libraries/CAN/src/R7FA4M1_CAN.h

@@ -19,14 +19,14 @@
 
 #ifdef ARDUINO_PORTENTA_H33
 
+#include "HardwareCAN.h"
+
 #include  <tuple>
 
 #include "bsp_api.h"
 
 #include "r_canfd.h"
 
-#include "CanMsg.h"
-#include "CanConst.h"
 #include "CanMsgRingbuffer.h"
 
 /**************************************************************************************
@@ -46,23 +46,24 @@ namespace arduino
  * CLASS DECLARATION
  **************************************************************************************/
 
-class R7FA6M5_CAN
+class R7FA6M5_CAN final : public HardwareCAN
 {
 public:
   R7FA6M5_CAN(int const can_tx_pin, int const can_rx_pin);
+  virtual ~R7FA6M5_CAN() { }
 
 
-  bool begin(CanBitRate const can_bitrate);
-  void end();
+  bool begin(CanBitRate const can_bitrate) override;
+  void end() override;
 
 
   int enableInternalLoopback();
   int disableInternalLoopback();
 
 
-  int write(CanMsg const & msg);
-  size_t available();
-  CanMsg read();
+  int write(CanMsg const & msg) override;
+  size_t available() override;
+  CanMsg read() override;
 
 
   inline bool isError(int & err_code) const { err_code = _err_code; return _is_error; }