HardwareCAN.h

/*
  HardwareCAN.h - CAN bus interface for Arduino core
  Copyright (c) 2023 Arduino. All right reserved.
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
 
#ifndef ARDUINOCORE_API_HARDWARECAN_H
#define ARDUINOCORE_API_HARDWARECAN_H
 
/**************************************************************************************
 * INCLUDE
 **************************************************************************************/
 
#include "CanMsg.h"
#include "CanMsgRingbuffer.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_API_HARDWARECAN_H */