summaryrefslogtreecommitdiffstats
path: root/low-can-binding/binding/application.hpp
blob: 47a0e2f18836cfe4462862f7275a2af0a86b5056 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/*
 * Copyright (C) 2015, 2016 "IoT.bzh"
 * Author "Romain Forlot" <romain.forlot@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *	 http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <map>
#include <vector>
#include <string>
#include <memory>

#include "../can/can-bus.hpp"
#include "../can/message-set.hpp"
#include "../can/signals.hpp"
#include "../diagnostic/diagnostic-manager.hpp"
#ifdef USE_FEATURE_J1939
	#include "../utils/socketcan-j1939/socketcan-j1939-data.hpp"
	#include "../utils/socketcan-j1939/socketcan-j1939-addressclaiming.hpp"
#endif

///
/// @brief Class represents a configuration attached to the binding.
///
/// It regroups all object instances from other classes
///  that will be used through the binding life. It receives a global vision
///  on which signals are implemented for that binding.
///  Here, only the definition of the class is given with predefined accessors
///  methods used in the binding.
///
///  It will be the reference point to needed objects.
///
class application_t
{
	private:
		can_bus_t can_bus_manager_; ///< instanciate the CAN bus manager. It's responsible of initializing the CAN bus devices.
		diagnostic_manager_t diagnostic_manager_; ///< Diagnostic manager use to manage diagnostic message communication.
		uint8_t active_message_set_ = 0; ///< Which is the active message set ? Default to 0.

		std::vector<std::shared_ptr<message_set_t> > message_set_; ///< Vector holding all message set from JSON signals description file

		std::map<std::string, std::shared_ptr<low_can_subscription_t> > can_devices_; ///< Map containing all independant opened CAN sockets, key is the socket int value.
#ifdef USE_FEATURE_J1939
		std::shared_ptr<low_can_subscription_t> subscription_address_claiming_; ///< Subscription holding the socketcan J1939 which is in charge of handling the address claiming protocol
		//std::shared_ptr<utils::socketcan_j1939_addressclaiming_t> socket_address_claiming_;
#endif
		application_t(); ///< Private constructor with implementation generated by the AGL generator.

	public:
		static application_t& instance();

		can_bus_t& get_can_bus_manager();

		std::map<std::string, std::shared_ptr<low_can_subscription_t> >& get_can_devices();

		const std::string get_diagnostic_bus() const;

		diagnostic_manager_t& get_diagnostic_manager() ;

		uint8_t get_active_message_set() const;

		std::vector<std::shared_ptr<message_set_t> > get_message_set();

		vect_ptr_signal_t get_all_signals();

		vect_ptr_diag_msg_t get_diagnostic_messages();

		const std::vector<std::string>& get_signals_prefix() const;

		std::vector<std::shared_ptr<message_definition_t> > get_messages_definition();

		std::shared_ptr<message_definition_t> get_message_definition(uint32_t id);

		uint32_t get_signal_id(diagnostic_message_t& sig) const;

		uint32_t get_signal_id(signal_t& sig) const;

		bool isEngineOn();

		void set_active_message_set(uint8_t id);

#ifdef USE_FEATURE_J1939
		std::shared_ptr<utils::socketcan_t> get_socket_address_claiming();

		std::shared_ptr<low_can_subscription_t> get_subscription_address_claiming();

		void set_subscription_address_claiming(std::shared_ptr<low_can_subscription_t> new_subscription);
#endif
/*
		/// TODO: implement this function as method into can_bus class
		/// @brief Pre initialize actions made before CAN bus initialization
		/// @param[in] bus A CanBus struct defining the bus's metadata
		/// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
		/// @param[in] buses An array of all CAN buses.
		void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
		/// TODO: implement this function as method into can_bus class
		/// @brief Post-initialize actions made after CAN bus initialization
		/// @param[in] bus A CanBus struct defining the bus's metadata
		/// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
		/// @param[in] buses An array of all CAN buses.
		void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
		/// TODO: implement this function as method into can_bus class
		/// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
		/// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
		bool isBusActive(can_bus_dev_t* bus);
		*/
};
out_value "$x" sep=" " done ;; json) out "[" while read x; do out $sep out_value "$x" sep="," done out "]" ;; esac } function out_value() { # string # number # object # array # 'true' # 'false' # 'null' x=$1 # litterals if [[ "$x" =~ ^(true|false|null)$ ]]; then out "$x" # number elif [[ "$x" =~ ^[+-]?[0-9]+(\.[0-9]+)?$ ]]; then out "$x" # object elif [[ "$x" =~ ^\{.*\}$ ]]; then out "$x" # array elif [[ "$x" =~ ^\[.*\]$ ]]; then out "$x" # string else out "\"$(sed 's/\("\)/\\\1/g' <<<$x)\"" fi } function out_comment() { case $format in bash) [[ "$verbose" == 1 ]] && echo "# $@" || true ;; json) ;; esac } function _getgitmanifest() { # this function takes the setup.manifest generated by setup script and uses DIST_METADIR # to analyze git repos local manifest=$1 mode=$2 [[ -f $manifest ]] && source $manifest || { error "Invalid setup manifest '$manifest'"; return 1; } [[ ! -d "$DIST_METADIR" ]] && { error "Invalid meta directory. Check variable DIST_METADIR in manifest file '$manifest'." error "$BASH_SOURCE: Also, check directory '$DIST_METADIR'." return 2 } local GIT=$(which git) REALPATH=$(which realpath) [[ ! -x $GIT ]] && { error "$BASH_SOURCE: Unable to find git command in $PATH."; return 3; } [[ ! -x $REALPATH ]] && { error "$BASH_SOURCE: Unable to find realpath command in $PATH."; return 4; } local gitrepo gitrev metagitdir sep="" DIST_LAYERS="" for metagitdir in $(find $DIST_METADIR -maxdepth 2 -type d \( -not -path '*/.*' \) -exec test -d "{}/.git" \; -print -prune); do gitrepo=$($REALPATH -Ls $metagitdir --relative-to=$DIST_METADIR) pushd $DIST_METADIR/$gitrepo &>/dev/null && { gitrev=$( { $GIT describe --long --dirty --always 2>/dev/null || echo "unknown_revision"; } | tr ' \t' '__' ) popd &>/dev/null } || { gitrev=unknown } DIST_LAYERS="${DIST_LAYERS}${sep}${gitrepo}:${gitrev}" sep=" " done # layers checksum DIST_LAYERS_MD5=$(echo $DIST_LAYERS|md5sum -|awk '{print $1;}') # in json, transform layers in an object, features in array [[ "$format" == "json" ]] && { DIST_FEATURES=$(for x in $DIST_FEATURES; do echo $x done | out_array) DIST_LAYERS=$(for x in $DIST_LAYERS; do echo ${x%%:*} echo ${x#*:} done | out_object) } # compute build hash DIST_BUILD_HASH="F${DIST_FEATURES_MD5:0:8}-L${DIST_LAYERS_MD5:0:8}" DIST_BUILD_ID="${DIST_DISTRO_NAME}-${DIST_MACHINE}-F${DIST_FEATURES_MD5:0:8}-L${DIST_LAYERS_MD5:0:8}" # compute setup manifest path and build TS DIST_SETUP_MANIFEST="$($REALPATH $manifest)" # Manifest build timestamp DIST_BUILD_TS="$timestamp" # build topic from setup topic DIST_BUILD_TOPIC="${DIST_SETUP_TOPIC}" # what to retain from setup manifest? # to generate the full list: cat setup.manifest | grep = | cut -f1 -d"=" | awk '{printf("%s ",$1);}' declare -A SETUP_VARS SETUP_VARS[deploy]="DIST_MACHINE DIST_FEATURES DIST_FEATURES_MD5 DIST_BUILD_HOST DIST_BUILD_OS DIST_SETUP_TS" SETUP_VARS[target]="DIST_MACHINE DIST_FEATURES" SETUP_VARS[sdk]="DIST_MACHINE DIST_FEATURES" # extra vars not coming from setup.manifest but generated here declare -A EXTRA_VARS EXTRA_VARS[deploy]="DIST_SETUP_MANIFEST DIST_BUILD_TS DIST_LAYERS DIST_LAYERS_MD5 DIST_BUILD_HASH DIST_BUILD_ID DIST_BUILD_TOPIC" EXTRA_VARS[target]="DIST_LAYERS DIST_BUILD_HASH DIST_BUILD_ID DIST_BUILD_TS DIST_BUILD_TOPIC" EXTRA_VARS[sdk]="DIST_LAYERS DIST_BUILD_HASH DIST_BUILD_ID DIST_BUILD_TS DIST_BUILD_TOPIC" # BITBAKE_VARS may be defined from external file to source (--source arg) # this is used to dump extra vars from inside bitbake recipe { for x in ${SETUP_VARS[$mode]} ${EXTRA_VARS[$mode]} ${BITBAKE_VARS[$mode]}; do k=$x [[ "$format" == "json" ]] && { k=${k#DIST_} # remove prefix k=${k,,*} # to lower case } echo $k echo ${!x} done } | out_object } function getmanifest() { local rc=0 out_comment "DISTRO BUILD MANIFEST" out_comment # add layers manifest out_comment "----- this fragment has been generated by $BASH_SOURCE" _getgitmanifest $1 $2 || rc=$? out_comment "------------ end of $BASH_SOURCE fragment --------" return $rc } function __usage() { cat <<EOF >&2 Usage: $BASH_SOURCE [-v|--verbose] [-f|--format <fmt>] [-t|--timestamp <value>] [-m|--mode <mode>] [-s|--source <file>] <setup_manifest_file> Options: -v|--verbose: generate comments in the output file -s|--source: extra file to source (get extra variables generated from bitbake recipe) -t|--timestamp: set build timestamp (default: current date - may not be the same ts as bitbake) -f|--format: specify output format: 'bash' or 'json' -m|--mode: specify the destination for the generated manifest 'deploy' : for the tmp/deploy/images/* directories 'target' : for the manifest to be installed inside a target image 'sdk' : for the manifest to be installed inside the SDK <setup_manifest_file> is the input manifest generated from setup script EOF } set -e tmp=$(getopt -o h,v,m:,f:,t:,s: --long help,verbose,mode:,format:,timestamp:,source: -n "$BASH_SOURCE" -- "$@") || { error "Invalid arguments." __usage exit 1 } eval set -- $tmp while true; do case "$1" in -h|--help) __usage; exit 0;; -v|--verbose) verbose=1; shift ;; -f|--format) format=$2; shift 2;; -m|--mode) mode=$2; shift 2;; -t|--timestamp) timestamp=$2; shift 2;; -s|--source) sourcefile=$2; shift 2;; --) shift; break;; *) fatal "Internal error";; esac done manifest=$1 shift [[ ! -f "$manifest" ]] && { __usage; exit 1; } case $mode in deploy|target|sdk) ;; *) error "Invalid mode specified. Allowed modes are: 'deploy', 'target', 'sdk'"; __usage; exit 42;; esac case $format in bash|json) ;; *) error "Invalid format specified. Allowed formats are 'json' or 'bash'"; __usage; exit 43;; esac info "Generating manifest: mode=$mode format=$format manifest=$manifest" [[ -f "$sourcefile" ]] && { info "Sourcing file $sourcefile" . $sourcefile # this may define extra vars: to be taken into account BITBAKE_VARS must be defined } [[ "$format" == "json" ]] && { # if jq is present, use it to format json output jq=$(which jq || true) [[ -n "$jq" ]] && { getmanifest $manifest $mode | $jq "" exit ${PIPESTATUS[0]} } } getmanifest $manifest $mode