2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
4 * Author "Loic Collignon" <loic.collignon@iot.bzh>
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "low-can-binding.hpp"
27 #include <linux/can.h>
28 #include <json-c/json.h>
30 #include "openxc.pb.h"
31 #include "configuration.hpp"
32 #include "can/can-bus.hpp"
33 #include "can/can-signals.hpp"
34 #include "can/can-message.hpp"
35 #include "utils/timer.hpp"
36 #include "utils/signals.hpp"
37 #include "diagnostic/diagnostic-message.hpp"
38 #include "utils/openxc-utils.hpp"
42 #include <afb/afb-service-itf.h>
45 // Interface between the daemon and the binding
46 const struct afb_binding_interface *binder_interface;
48 ///******************************************************************************
50 /// Subscription and unsubscription
52 ///*******************************************************************************/
54 static int make_subscription_unsubscription(struct afb_req request, const std::string& sig_name, std::map<std::string, struct afb_event>& s, bool subscribe)
56 /* Make the subscription or unsubscription to the event */
57 if (((subscribe ? afb_req_subscribe : afb_req_unsubscribe)(request, s[sig_name])) < 0)
59 ERROR(binder_interface, "make_subscription_unsubscription: Operation goes wrong for signal: %s", sig_name.c_str());
66 static int create_event_handle(const std::string& sig_name, std::map<std::string, struct afb_event>& s)
68 s[sig_name] = afb_daemon_make_event(binder_interface->daemon, sig_name.c_str());
69 if (!afb_event_is_valid(s[sig_name]))
71 ERROR(binder_interface, "create_event_handle: Can't create an event for %s, something goes wrong.", sig_name.c_str());
77 static int subscribe_unsubscribe_signal(struct afb_req request, bool subscribe, const std::string& sig)
81 std::lock_guard<std::mutex> subscribed_signals_lock(get_subscribed_signals_mutex());
82 std::map<std::string, struct afb_event>& s = get_subscribed_signals();
83 if (s.find(sig) != s.end())
85 if (!afb_event_is_valid(s[sig]) && !subscribe)
87 NOTICE(binder_interface, "subscribe_unsubscribe_signal: Event isn't valid, it can't be unsubscribed.");
92 // Event it isn't valid annymore, recreate it
93 ret = create_event_handle(sig, s);
98 /* Event doesn't exist , so let's create it */
99 struct afb_event empty_event = {nullptr, nullptr};
100 subscribed_signals[sig] = empty_event;
101 ret = create_event_handle(sig, s);
104 /* Check whether or not the event handler has been correctly created and
105 * make the subscription/unsubscription operation is so.
109 return make_subscription_unsubscription(request, sig, s, subscribe);
113 /// @fn static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<can_signal_t>& signals)
114 /// @brief subscribe to all signals in the vector signals
116 /// @param[in] afb_req request : contain original request use to subscribe or unsubscribe
117 /// @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription
118 /// @param[in] can_signal_t vector with can_signal_t to subscribe
120 /// @return Number of correctly subscribed signal
122 static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<std::string>& signals)
126 //TODO: Implement way to dynamically call the right function no matter
127 // how much signals types we have.
129 for(const std::string& sig : signals)
132 if (active_diagnostic_request_t::is_diagnostic_signal(sig))
134 std::vector<diagnostic_message_t*> found;
135 configuration_t::instance().find_diagnostic_messages(build_DynamicField(sig), found);
136 DiagnosticRequest* diag_req = new DiagnosticRequest(found.front()->build_diagnostic_request());
138 // If the requested diagnostic message isn't supported by the car then unssubcribe.
139 // no matter what we want, worse case will be a fail unsubscription but at least we don't
140 // poll a PID for nothing.
141 if(found.front()->get_supported())
143 float frequency = found.front()->get_frequency();
144 configuration_t::instance().get_diagnostic_manager().add_recurring_request(
145 diag_req, sig.c_str(), false, found.front()->get_decoder(), found.front()->get_callback(), (float)frequency);
146 //TODO: Adding callback requesting ignition status: diag_req, sig.c_str(), false, diagnostic_message_t::decode_obd2_response, diagnostic_message_t::check_ignition_status, frequency);
150 found.front()->set_supported(false);
151 configuration_t::instance().get_diagnostic_manager().cleanup_request(
152 configuration_t::instance().get_diagnostic_manager().find_recurring_request(diag_req), true);
153 DEBUG(binder_interface, "Signal: %s isn't supported. Canceling operation.", sig.c_str());
158 ret = subscribe_unsubscribe_signal(request, subscribe, sig);
163 DEBUG(binder_interface, "Signal: %s subscribed", sig.c_str());
168 static int subscribe_unsubscribe_name(struct afb_req request, bool subscribe, const char *name)
170 std::vector<std::string> signals;
173 openxc_DynamicField search_key = build_DynamicField(std::string(name));
174 signals = find_signals(search_key);
178 ret = subscribe_unsubscribe_signals(request, subscribe, signals);
179 NOTICE(binder_interface, "Subscribed/unsubscribe correctly to %d/%d signal(s).", ret, (int)signals.size());
184 static void subscribe_unsubscribe(struct afb_req request, bool subscribe)
187 struct json_object *args, *a, *x;
189 /* makes the subscription/unsubscription */
190 args = afb_req_json(request);
191 if (args == NULL || !json_object_object_get_ex(args, "event", &a)) {
192 ok = subscribe_unsubscribe_name(request, subscribe, "*");
193 } else if (json_object_get_type(a) != json_type_array) {
194 ok = subscribe_unsubscribe_name(request, subscribe, json_object_get_string(a));
196 n = json_object_array_length(a);
198 for (i = 0 ; i < n ; i++) {
199 x = json_object_array_get_idx(a, i);
200 if (subscribe_unsubscribe_name(request, subscribe, json_object_get_string(x)))
206 /* send the report */
208 afb_req_success(request, NULL, NULL);
210 afb_req_fail(request, "error", NULL);
215 static void subscribe(struct afb_req request)
217 subscribe_unsubscribe(request, true);
220 static void unsubscribe(struct afb_req request)
222 subscribe_unsubscribe(request, false);
225 static const struct afb_verb_desc_v1 verbs[]=
227 { .name= "subscribe", .session= AFB_SESSION_NONE, .callback= subscribe, .info= "subscribe to notification of CAN bus messages." },
228 { .name= "unsubscribe", .session= AFB_SESSION_NONE, .callback= unsubscribe, .info= "unsubscribe a previous subscription." }
231 static const struct afb_binding binding_desc {
232 AFB_BINDING_VERSION_1,
234 "Low level CAN bus service",
240 const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *itf)
242 binder_interface = itf;
244 return &binding_desc;
247 /// @brief Initialize the binding.
249 /// @param[in] service Structure which represent the Application Framework Binder.
251 /// @return Exit code, zero if success.
252 int afbBindingV1ServiceInit(struct afb_service service)
254 can_bus_t& can_bus_manager = configuration_t::instance().get_can_bus_manager();
256 /// Initialize CAN socket
257 if(can_bus_manager.init_can_dev() == 0)
259 can_bus_manager.start_threads();
261 /// Initialize Diagnostic manager that will handle obd2 requests.
262 /// We pass by default the first CAN bus device to its Initialization.
263 /// TODO: be able to choose the CAN bus device that will be use as Diagnostic bus.
264 if(configuration_t::instance().get_diagnostic_manager().initialize())
268 ERROR(binder_interface, "There was something wrong with CAN device Initialization. Check your config file maybe");