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 void on_no_clients(std::string message)
50 DiagnosticRequest* diag_req = configuration_t::instance().get_request_from_diagnostic_message(message);
51 active_diagnostic_request_t* adr = configuration_t::instance().get_diagnostic_manager().find_recurring_request(diag_req);
52 configuration_t::instance().get_diagnostic_manager().cleanup_request(adr, true);
55 ///******************************************************************************
57 /// Subscription and unsubscription
59 ///*******************************************************************************/
61 static int make_subscription_unsubscription(struct afb_req request, const std::string& sig_name, std::map<std::string, struct afb_event>& s, bool subscribe)
63 /* Make the subscription or unsubscription to the event */
64 if (((subscribe ? afb_req_subscribe : afb_req_unsubscribe)(request, s[sig_name])) < 0)
66 ERROR(binder_interface, "make_subscription_unsubscription: Operation goes wrong for signal: %s", sig_name.c_str());
72 static int create_event_handle(const std::string& sig_name, std::map<std::string, struct afb_event>& s)
74 s[sig_name] = afb_daemon_make_event(binder_interface->daemon, sig_name.c_str());
75 if (!afb_event_is_valid(s[sig_name]))
77 ERROR(binder_interface, "create_event_handle: Can't create an event for %s, something goes wrong.", sig_name.c_str());
83 static int subscribe_unsubscribe_signal(struct afb_req request, bool subscribe, const std::string& sig)
87 std::lock_guard<std::mutex> subscribed_signals_lock(get_subscribed_signals_mutex());
88 std::map<std::string, struct afb_event>& s = get_subscribed_signals();
89 if (s.find(sig) != s.end())
91 if (!afb_event_is_valid(s[sig]) && !subscribe)
93 NOTICE(binder_interface, "subscribe_unsubscribe_signal: Event isn't valid, it can't be unsubscribed.");
98 // Event it isn't valid annymore, recreate it
99 ret = create_event_handle(sig, s);
104 /* Event doesn't exist , so let's create it */
105 struct afb_event empty_event = {nullptr, nullptr};
106 subscribed_signals[sig] = empty_event;
107 ret = create_event_handle(sig, s);
110 /* Check whether or not the event handler has been correctly created and
111 * make the subscription/unsubscription operation is so.
115 return make_subscription_unsubscription(request, sig, s, subscribe);
119 /// @fn static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<can_signal_t>& signals)
120 /// @brief subscribe to all signals in the vector signals
122 /// @param[in] afb_req request : contain original request use to subscribe or unsubscribe
123 /// @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription
124 /// @param[in] can_signal_t vector with can_signal_t to subscribe
126 /// @return Number of correctly subscribed signal
128 static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<std::string>& signals)
132 //TODO: Implement way to dynamically call the right function no matter
133 // how much signals types we have.
135 for(const std::string& sig : signals)
138 bool to_subscribe = false;
139 if (active_diagnostic_request_t::is_diagnostic_signal(sig))
141 diagnostic_message_t* diag_msg = configuration_t::instance().get_diagnostic_message(sig);
142 DiagnosticRequest* diag_req = configuration_t::instance().get_request_from_diagnostic_message(diag_msg);
144 // If the requested diagnostic message isn't supported by the car then unssubcribe.
145 // no matter what we want, worse case will be a fail unsubscription but at least we don't
146 // poll a PID for nothing.
147 if(diag_msg->get_supported() && subscribe)
149 float frequency = diag_msg->get_frequency();
150 to_subscribe = configuration_t::instance().get_diagnostic_manager().add_recurring_request(
151 diag_req, sig.c_str(), false, diag_msg->get_decoder(), diag_msg->get_callback(), (float)frequency);
152 //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);
156 configuration_t::instance().get_diagnostic_manager().cleanup_request(
157 configuration_t::instance().get_diagnostic_manager().find_recurring_request(diag_req), true);
158 WARNING(binder_interface, "Signal: %s isn't supported. Canceling operation.", sig.c_str());
165 ret = subscribe_unsubscribe_signal(request, subscribe, sig);
170 DEBUG(binder_interface, "Signal: %s subscribed", sig.c_str());
175 static int subscribe_unsubscribe_name(struct afb_req request, bool subscribe, const char *name)
177 std::vector<std::string> signals;
180 openxc_DynamicField search_key = build_DynamicField(std::string(name));
181 signals = find_signals(search_key);
185 ret = subscribe_unsubscribe_signals(request, subscribe, signals);
186 NOTICE(binder_interface, "Subscribed/unsubscribe correctly to %d/%d signal(s).", ret, (int)signals.size());
191 static void subscribe_unsubscribe(struct afb_req request, bool subscribe)
194 struct json_object *args, *a, *x;
196 /* makes the subscription/unsubscription */
197 args = afb_req_json(request);
198 if (args == NULL || !json_object_object_get_ex(args, "event", &a)) {
199 ok = subscribe_unsubscribe_name(request, subscribe, "*");
200 } else if (json_object_get_type(a) != json_type_array) {
201 ok = subscribe_unsubscribe_name(request, subscribe, json_object_get_string(a));
203 n = json_object_array_length(a);
205 for (i = 0 ; i < n ; i++) {
206 x = json_object_array_get_idx(a, i);
207 if (subscribe_unsubscribe_name(request, subscribe, json_object_get_string(x)))
213 /* send the report */
215 afb_req_success(request, NULL, NULL);
217 afb_req_fail(request, "error", NULL);
222 static void subscribe(struct afb_req request)
224 subscribe_unsubscribe(request, true);
227 static void unsubscribe(struct afb_req request)
229 subscribe_unsubscribe(request, false);
232 static const struct afb_verb_desc_v1 verbs[]=
234 { .name= "subscribe", .session= AFB_SESSION_NONE, .callback= subscribe, .info= "subscribe to notification of CAN bus messages." },
235 { .name= "unsubscribe", .session= AFB_SESSION_NONE, .callback= unsubscribe, .info= "unsubscribe a previous subscription." }
238 static const struct afb_binding binding_desc {
239 AFB_BINDING_VERSION_1,
241 "Low level CAN bus service",
247 const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *itf)
249 binder_interface = itf;
251 return &binding_desc;
254 /// @brief Initialize the binding.
256 /// @param[in] service Structure which represent the Application Framework Binder.
258 /// @return Exit code, zero if success.
259 int afbBindingV1ServiceInit(struct afb_service service)
261 can_bus_t& can_bus_manager = configuration_t::instance().get_can_bus_manager();
263 /// Initialize CAN socket
264 if(can_bus_manager.init_can_dev() == 0)
266 can_bus_manager.start_threads();
268 /// Initialize Diagnostic manager that will handle obd2 requests.
269 /// We pass by default the first CAN bus device to its Initialization.
270 /// TODO: be able to choose the CAN bus device that will be use as Diagnostic bus.
271 if(configuration_t::instance().get_diagnostic_manager().initialize())
275 ERROR(binder_interface, "There was something wrong with CAN device Initialization. Check your config file maybe");