CAN-binder/low-can-binding/can/can-bus-dev.hpp

   1 /*
   2  * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  * Author "Loïc Collignon" <loic.collignon@iot.bzh>
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *       http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #pragma once
  20
  21 #include <stdint.h>
  22 #include <string>
  23 #include <thread>
  24
  25 #include "../utils/socketcan-raw.hpp"
  26
  27 class can_bus_t;
  28 class can_message_t;
  29 class can_signal_t;
  30
  31 /// @brief Object representing a can device. Handle opening, closing and reading on the
  32 /// socket. This is the low level object to be initialized and use by can_bus_t.
  33 class can_bus_dev_t
  34 {
  35 private:
  36         std::string device_name_; ///< a string identifier identitfying the linux CAN device.
  37         utils::socketcan_raw_t can_socket_;
  38
  39         int index_;
  40
  41         std::thread th_reading_; ///< Thread handling read the socket can device filling can_message_q_ queue of can_bus_t
  42         bool is_running_ = false; ///< boolean telling whether or not reading is running or not
  43         void can_reader(can_bus_t& can_bus);
  44
  45 public:
  46         can_bus_dev_t(const std::string& dev_name, int index);
  47
  48         std::string get_device_name() const;
  49         int get_index() const;
  50         utils::socketcan_t& get_socket();
  51
  52         int open();
  53         void configure();
  54         int close();
  55
  56         void start_reading(can_bus_t& can_bus);
  57
  58         void stop_reading();
  59
  60         can_message_t read();
  61
  62         int send(can_message_t& can_msg);
  63         bool shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size);
  64 };