87d7bf5bf91a0887fcff7084da523eb81f6dcefb
[apps/agl-service-can-low-level.git] / src / can / can-bus-dev.cpp
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
20 #include <unistd.h>
21 #include <string.h>
22 #include <net/if.h>
23 #include <sys/ioctl.h>
24 #include <linux/can/raw.h>
25
26 #include <mutex>
27
28 #include "can-bus-dev.hpp"
29
30 #include "can-bus.hpp"
31 #include "can-message.hpp"
32 #include "low-can-binding.hpp"
33
34 /// @brief Class constructor
35 /// @param dev_name String representing the device name into the linux /dev tree
36 can_bus_dev_t::can_bus_dev_t(const std::string& dev_name)
37         : device_name_{dev_name}
38 {
39 }
40
41 /// @brief Open the can socket and returning it
42 /// @return -1 if something wrong.
43 int can_bus_dev_t::open()
44 {
45         const int canfd_on = 1;
46         const int timestamp_on = 1;
47         struct ifreq ifr;
48         struct timeval timeout;
49
50         DEBUG(binder_interface, "CAN Handler socket : %d", can_socket_.socket());
51         if (can_socket_)
52                 return 0;
53
54         can_socket_.open(PF_CAN, SOCK_RAW, CAN_RAW);
55         if (can_socket_)
56         {
57                 DEBUG(binder_interface, "CAN Handler socket correctly initialized : %d", can_socket_.socket());
58
59                 // Set timeout for read
60                 can_socket_.setopt(SOL_SOCKET, SO_RCVTIMEO, (char *)&timeout, sizeof(timeout));
61
62                 // Set timestamp for receveid frame
63                 if (can_socket_.setopt(SOL_SOCKET, SO_TIMESTAMP, &timestamp_on, sizeof(timestamp_on)) < 0)
64                         WARNING(binder_interface, "setsockopt SO_TIMESTAMP error: %s", ::strerror(errno));
65                 DEBUG(binder_interface, "Switch CAN Handler socket to use fd mode");
66
67                 // try to switch the socket into CAN_FD mode
68                 if (can_socket_.setopt(SOL_CAN_RAW, CAN_RAW_FD_FRAMES, &canfd_on, sizeof(canfd_on)) < 0)
69                 {
70                         NOTICE(binder_interface, "Can not switch into CAN Extended frame format.");
71                         is_fdmode_on_ = false;
72                 }
73                 else
74                 {
75                         DEBUG(binder_interface, "Correctly set up CAN socket to use FD frames.");
76                         is_fdmode_on_ = true;
77                 }
78
79                 // Attempts to open a socket to CAN bus
80                 ::strcpy(ifr.ifr_name, device_name_.c_str());
81                 DEBUG(binder_interface, "ifr_name is : %s", ifr.ifr_name);
82                 if(::ioctl(can_socket_.socket(), SIOCGIFINDEX, &ifr) < 0)
83                 {
84                         ERROR(binder_interface, "ioctl failed. Error was : %s", strerror(errno));
85                 }
86                 else
87                 {
88                         txAddress_.can_family = AF_CAN;
89                         txAddress_.can_ifindex = ifr.ifr_ifindex;
90
91                         // And bind it to txAddress
92                         DEBUG(binder_interface, "Bind the socket");
93                         if (can_socket_.bind((struct sockaddr *)&txAddress_, sizeof(txAddress_)) < 0)
94                                 ERROR(binder_interface, "Bind failed. %s", strerror(errno));
95                         else return 0;
96                 }
97                 close();
98         }
99         else ERROR(binder_interface, "socket could not be created. Error was : %s", ::strerror(errno));
100         return -1;
101 }
102
103 /// @brief Close the bus.
104 int can_bus_dev_t::close()
105 {
106         return can_socket_.close();
107 }
108
109 /// @brief Read the can socket and retrieve canfd_frame
110 can_message_t can_bus_dev_t::read()
111 {
112         ssize_t nbytes;
113         struct canfd_frame cfd;
114
115         // Test that socket is really opened
116         if (can_socket_)
117         {
118                 ERROR(binder_interface, "read_can: Socket unavailable. Closing thread.");
119                 is_running_ = false;
120         }
121
122         nbytes = ::read(can_socket_.socket(), &cfd, CANFD_MTU);
123
124         // if we did not fit into CAN sized messages then stop_reading.
125         if (nbytes != CANFD_MTU && nbytes != CAN_MTU)
126         {
127                 if (errno == ENETDOWN)
128                         ERROR(binder_interface, "read: %s CAN device down", device_name_.c_str());
129                 ERROR(binder_interface, "read: Incomplete CAN(FD) frame");
130                 ::memset(&cfd, 0, sizeof(cfd));
131         }
132
133         DEBUG(binder_interface, "read: Found id: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X", cfd.can_id, cfd.len,
134                                                         cfd.data[0], cfd.data[1], cfd.data[2], cfd.data[3], cfd.data[4], cfd.data[5], cfd.data[6], cfd.data[7]);
135         return can_message_t::convert_from_canfd_frame(cfd, nbytes);
136 }
137
138 /// @brief start reading threads and set flag is_running_
139 /// @param[in] can_bus reference can_bus_t. it will be passed to the thread to allow using can_bus_t queue.
140 void can_bus_dev_t::start_reading(can_bus_t& can_bus)
141 {
142         DEBUG(binder_interface, "Launching reading thread");
143         is_running_ = true;
144         th_reading_ = std::thread(&can_bus_dev_t::can_reader, this, std::ref(can_bus));
145         if(!th_reading_.joinable())
146                 is_running_ = false;
147 }
148
149 /// @brief stop the reading thread setting flag is_running_ to false and and wait that the thread finish its job.
150 void can_bus_dev_t::stop_reading()
151 {
152         is_running_ = false;
153 }
154
155 /// @brief Thread function used to read the can socket.
156 /// @param[in] can_bus object to be used to read the can socket
157 void can_bus_dev_t::can_reader(can_bus_t& can_bus)
158 {
159         while(is_running_)
160         {
161                 can_message_t msg = read();
162                 {
163                         std::lock_guard<std::mutex> can_message_lock(can_bus.get_can_message_mutex());
164                         can_bus.push_new_can_message(msg);
165                 }
166                 can_bus.get_new_can_message_cv().notify_one();
167         }
168 }
169
170 /// @brief Send a can message from a can_message_t object.
171 /// @param[in] can_msg the can message object to send
172 int can_bus_dev_t::send(can_message_t& can_msg)
173 {
174         ssize_t nbytes;
175         canfd_frame f;
176
177         f = can_msg.convert_to_canfd_frame();
178
179         if(can_socket_.socket())
180         {
181                 nbytes = ::sendto(can_socket_.socket(), &f, sizeof(struct canfd_frame), 0,
182                         (struct sockaddr*)&txAddress_, sizeof(txAddress_));
183                 if (nbytes == -1)
184                 {
185                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
186                         return -1;
187                 }
188                 return (int)nbytes;
189         }
190         else
191         {
192                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
193                 open();
194         }
195         return 0;
196 }
197
198 /// @brief Send a can message from a can_message_t object.
199 /// @param[in] can bus used to send the message
200 /// @param[in] can_msg the can message object to send
201 bool can_bus_dev_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size)
202 {
203         ssize_t nbytes;
204         canfd_frame f;
205
206         f.can_id = arbitration_id;
207         f.len = size;
208         ::memcpy(f.data, data, size);
209
210         if(can_socket_.socket())
211         {
212                 nbytes = ::sendto(can_socket_.socket(), &f, sizeof(struct canfd_frame), 0,
213                         (struct sockaddr*)&txAddress_, sizeof(txAddress_));
214                 if (nbytes == -1)
215                 {
216                         ERROR(binder_interface, "send_can_message: Sending CAN frame failed.");
217                         return -1;
218                 }
219                 return (int)nbytes;
220         }
221         else
222         {
223                 ERROR(binder_interface, "send_can_message: socket not initialized. Attempt to reopen can device socket.");
224                 open();
225         }
226         return 0;
227 }