2019-09-21 00:16:06 -03:00
|
|
|
|
|
|
|
/*
|
|
|
|
* This file is free software: you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU General Public License as published by the
|
|
|
|
* Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This file is distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
|
* See the GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
* Author: Siddharth Bharat Purohit
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <AP_HAL/AP_HAL.h>
|
|
|
|
|
2021-05-19 04:29:55 -03:00
|
|
|
#if HAL_ENABLE_LIBUAVCAN_DRIVERS
|
2019-09-21 00:16:06 -03:00
|
|
|
|
2019-10-25 00:03:16 -03:00
|
|
|
#include "AP_UAVCAN_DNA_Server.h"
|
2019-09-21 00:16:06 -03:00
|
|
|
#include "AP_UAVCAN.h"
|
|
|
|
#include <StorageManager/StorageManager.h>
|
|
|
|
#include <AP_HAL/AP_HAL.h>
|
|
|
|
#include <AP_Math/AP_Math.h>
|
|
|
|
#include <uavcan/protocol/dynamic_node_id/Allocation.hpp>
|
|
|
|
#include <GCS_MAVLink/GCS.h>
|
2020-12-31 17:04:08 -04:00
|
|
|
#include <AP_Logger/AP_Logger.h>
|
2020-06-24 09:07:28 -03:00
|
|
|
#include "AP_UAVCAN_Clock.h"
|
2019-09-21 00:16:06 -03:00
|
|
|
extern const AP_HAL::HAL& hal;
|
|
|
|
|
|
|
|
#define NODEDATA_MAGIC 0xAC01
|
|
|
|
#define NODEDATA_MAGIC_LEN 2
|
|
|
|
#define MAX_NODE_ID 125
|
|
|
|
|
2020-06-24 09:07:28 -03:00
|
|
|
#define debug_uavcan(level_debug, fmt, args...) do { AP::can().log_text(level_debug, "UAVCAN", fmt, ##args); } while (0)
|
2019-09-21 00:16:06 -03:00
|
|
|
|
|
|
|
//Callback Object Definitions
|
|
|
|
UC_REGISTRY_BINDER(AllocationCb, uavcan::protocol::dynamic_node_id::Allocation);
|
|
|
|
UC_REGISTRY_BINDER(NodeStatusCb, uavcan::protocol::NodeStatus);
|
|
|
|
|
|
|
|
static void trampoline_handleNodeInfo(const uavcan::ServiceCallResult<uavcan::protocol::GetNodeInfo>& resp);
|
|
|
|
static void trampoline_handleAllocation(AP_UAVCAN* ap_uavcan, uint8_t node_id, const AllocationCb &cb);
|
|
|
|
static void trampoline_handleNodeStatus(AP_UAVCAN* ap_uavcan, uint8_t node_id, const NodeStatusCb &cb);
|
|
|
|
|
2020-06-24 09:07:28 -03:00
|
|
|
static uavcan::ServiceClient<uavcan::protocol::GetNodeInfo>* getNodeInfo_client[HAL_MAX_CAN_PROTOCOL_DRIVERS];
|
2019-09-21 00:16:06 -03:00
|
|
|
|
2020-06-24 09:07:28 -03:00
|
|
|
static uavcan::Publisher<uavcan::protocol::dynamic_node_id::Allocation>* allocation_pub[HAL_MAX_CAN_PROTOCOL_DRIVERS];
|
2019-09-21 00:16:06 -03:00
|
|
|
|
|
|
|
/* Subscribe to all the messages we are going to handle for
|
|
|
|
Server registry and Node allocation. */
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::subscribe_msgs(AP_UAVCAN* ap_uavcan)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (ap_uavcan == nullptr) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
auto* node = ap_uavcan->get_node();
|
|
|
|
//Register Allocation Message Handler
|
|
|
|
uavcan::Subscriber<uavcan::protocol::dynamic_node_id::Allocation, AllocationCb> *AllocationListener;
|
|
|
|
AllocationListener = new uavcan::Subscriber<uavcan::protocol::dynamic_node_id::Allocation, AllocationCb>(*node);
|
|
|
|
if (AllocationListener == nullptr) {
|
|
|
|
AP_HAL::panic("Allocation Subscriber allocation failed\n\r");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
const int alloc_listener_res = AllocationListener->start(AllocationCb(ap_uavcan, &trampoline_handleAllocation));
|
|
|
|
if (alloc_listener_res < 0) {
|
|
|
|
AP_HAL::panic("Allocation Subscriber start problem\n\r");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
//We allow anonymous transfers, as they are specifically for Node Allocation
|
|
|
|
AllocationListener->allowAnonymousTransfers();
|
|
|
|
|
|
|
|
//Register Node Status Listener
|
|
|
|
uavcan::Subscriber<uavcan::protocol::NodeStatus, NodeStatusCb> *NodeStatusListener;
|
|
|
|
NodeStatusListener = new uavcan::Subscriber<uavcan::protocol::NodeStatus, NodeStatusCb>(*node);
|
|
|
|
if (NodeStatusListener == nullptr) {
|
|
|
|
AP_HAL::panic("NodeStatus Subscriber allocation failed\n\r");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
const int nodestatus_listener_res = NodeStatusListener->start(NodeStatusCb(ap_uavcan, &trampoline_handleNodeStatus));
|
|
|
|
if (nodestatus_listener_res < 0) {
|
|
|
|
AP_HAL::panic("NodeStatus Subscriber start problem\n\r");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Method to generate 6byte hash from the Unique ID.
|
|
|
|
We return it packed inside the referenced NodeData structure */
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::getHash(NodeData &node_data, const uint8_t unique_id[], uint8_t size) const
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
uint64_t hash = FNV_1_OFFSET_BASIS_64;
|
|
|
|
hash_fnv_1a(size, unique_id, &hash);
|
|
|
|
|
|
|
|
// xor-folding per http://www.isthe.com/chongo/tech/comp/fnv/
|
|
|
|
hash = (hash>>56) ^ (hash&(((uint64_t)1<<56)-1));
|
|
|
|
|
|
|
|
// write it to ret
|
|
|
|
for (uint8_t i=0; i<6; i++) {
|
|
|
|
node_data.hwid_hash[i] = (hash >> (8*i)) & 0xff;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//Read Node Data from Storage Region
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::readNodeData(NodeData &data, uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
if (!storage.read_block(&data, (node_id * sizeof(struct NodeData)) + NODEDATA_MAGIC_LEN, sizeof(struct NodeData))) {
|
|
|
|
//This will fall through to Prearm Check
|
|
|
|
server_state = STORAGE_FAILURE;
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
//Write Node Data to Storage Region
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::writeNodeData(const NodeData &data, uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
if (!storage.write_block((node_id * sizeof(struct NodeData)) + NODEDATA_MAGIC_LEN,
|
|
|
|
&data, sizeof(struct NodeData))) {
|
|
|
|
server_state = STORAGE_FAILURE;
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Set Occupation Mask, handy for keeping track of all node ids that
|
|
|
|
are allocated and all that are available. */
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::setOccupationMask(uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
occupation_mask.set(node_id);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Remove Node Data from Server Record in Storage,
|
|
|
|
and also clear Occupation Mask */
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::freeNodeID(uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
struct NodeData node_data;
|
|
|
|
|
|
|
|
//Eliminate from Server Record
|
|
|
|
memset(&node_data, 0, sizeof(node_data));
|
|
|
|
writeNodeData(node_data, node_id);
|
|
|
|
|
|
|
|
//Clear Occupation Mask
|
|
|
|
occupation_mask.clear(node_id);
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Sets the verification mask. This is to be called, once
|
|
|
|
The Seen Node has been both registered and verified against the
|
|
|
|
Server Records. */
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::setVerificationMask(uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
verified_mask.set(node_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Checks if the NodeID is occupied, i.e. its recorded
|
|
|
|
in the Server Records against a unique ID */
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::isNodeIDOccupied(uint8_t node_id) const
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return occupation_mask.get(node_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Checks if NodeID is verified, i.e. the unique id in
|
|
|
|
Storage Records matches the one provided by Device with this node id. */
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::isNodeIDVerified(uint8_t node_id) const
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return verified_mask.get(node_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Go through Server Records, and fetch node id that matches the provided
|
|
|
|
Unique IDs hash.
|
|
|
|
Returns 255 if no Node ID was detected */
|
2019-10-25 00:03:16 -03:00
|
|
|
uint8_t AP_UAVCAN_DNA_Server::getNodeIDForUniqueID(const uint8_t unique_id[], uint8_t size)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
uint8_t node_id = 255;
|
|
|
|
NodeData node_data, cmp_node_data;
|
|
|
|
getHash(cmp_node_data, unique_id, size);
|
|
|
|
|
|
|
|
for (int i = MAX_NODE_ID; i >= 0; i--) {
|
|
|
|
if (!isNodeIDOccupied(i)) { // No point in checking NodeID that's not taken
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
if (!readNodeData(node_data, i)) {
|
|
|
|
break; //Storage module has failed, report that as no NodeID detected
|
|
|
|
}
|
|
|
|
if (memcmp(node_data.hwid_hash, cmp_node_data.hwid_hash, sizeof(NodeData::hwid_hash)) == 0) {
|
|
|
|
node_id = i;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return node_id;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Hash the Unique ID and add it to the Server Record
|
|
|
|
for specified Node ID. */
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::addNodeIDForUniqueID(uint8_t node_id, const uint8_t unique_id[], uint8_t size)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
NodeData node_data;
|
|
|
|
getHash(node_data, unique_id, size);
|
|
|
|
//Generate CRC for validating the data when read back
|
|
|
|
node_data.crc = crc_crc8(node_data.hwid_hash, sizeof(node_data.hwid_hash));
|
|
|
|
|
|
|
|
//Write Data to the records
|
|
|
|
if (!writeNodeData(node_data, node_id)) {
|
|
|
|
server_state = FAILED_TO_ADD_NODE;
|
|
|
|
fault_node_id = node_id;
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
setOccupationMask(node_id);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
//Checks if a valid Server Record is present for specified Node ID
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::isValidNodeDataAvailable(uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
NodeData node_data;
|
|
|
|
readNodeData(node_data, node_id);
|
|
|
|
uint8_t crc = crc_crc8(node_data.hwid_hash, sizeof(node_data.hwid_hash));
|
|
|
|
if (crc == node_data.crc && node_data.crc != 0) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Initialises Publishers for respective UAVCAN Instance
|
|
|
|
Also resets the Server Record in case there is a mismatch
|
|
|
|
between specified node id and unique id against the existing
|
|
|
|
Server Record. */
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::init(AP_UAVCAN *ap_uavcan)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (ap_uavcan == nullptr) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2020-01-15 19:49:41 -04:00
|
|
|
WITH_SEMAPHORE(sem);
|
|
|
|
|
2021-11-02 02:26:10 -03:00
|
|
|
_ap_uavcan = ap_uavcan;
|
|
|
|
|
2019-09-21 00:16:06 -03:00
|
|
|
//Read the details from ap_uavcan
|
|
|
|
uavcan::Node<0>* _node = ap_uavcan->get_node();
|
|
|
|
uint8_t node_id = _node->getNodeID().get();
|
|
|
|
uint8_t driver_index = ap_uavcan->get_driver_index();
|
|
|
|
uint8_t own_unique_id[16] = {0};
|
|
|
|
uint8_t own_unique_id_len = 16;
|
|
|
|
|
|
|
|
//copy unique id from node to uint8_t array
|
|
|
|
uavcan::copy(_node->getHardwareVersion().unique_id.begin(),
|
|
|
|
_node->getHardwareVersion().unique_id.end(),
|
|
|
|
own_unique_id);
|
|
|
|
|
|
|
|
server_state = HEALTHY;
|
|
|
|
|
|
|
|
//Setup publisher for this driver index
|
|
|
|
allocation_pub[driver_index] = new uavcan::Publisher<uavcan::protocol::dynamic_node_id::Allocation>(*_node);
|
|
|
|
if (allocation_pub[driver_index] == nullptr) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
int res = allocation_pub[driver_index]->init(uavcan::TransferPriority::Default);
|
|
|
|
if (res < 0) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
allocation_pub[driver_index]->setTxTimeout(uavcan::MonotonicDuration::fromMSec(uavcan::protocol::dynamic_node_id::Allocation::FOLLOWUP_TIMEOUT_MS));
|
|
|
|
|
|
|
|
//Setup GetNodeInfo Client
|
|
|
|
getNodeInfo_client[driver_index] = new uavcan::ServiceClient<uavcan::protocol::GetNodeInfo>(*_node);
|
|
|
|
if (getNodeInfo_client[driver_index] == nullptr) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
res = getNodeInfo_client[driver_index]->init();
|
|
|
|
if (res < 0) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
getNodeInfo_client[driver_index]->setCallback(trampoline_handleNodeInfo);
|
|
|
|
|
|
|
|
/* Go through our records and look for valid NodeData, to initialise
|
|
|
|
occupation mask */
|
|
|
|
for (uint8_t i = 0; i <= MAX_NODE_ID; i++) {
|
|
|
|
if (isValidNodeDataAvailable(i)) {
|
|
|
|
occupation_mask.set(i);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check if the magic is present
|
|
|
|
uint16_t magic;
|
|
|
|
storage.read_block(&magic, 0, NODEDATA_MAGIC_LEN);
|
|
|
|
if (magic != NODEDATA_MAGIC) {
|
|
|
|
//Its not there a reset should write it in the Storage
|
|
|
|
reset();
|
|
|
|
}
|
2021-11-02 02:26:10 -03:00
|
|
|
if (ap_uavcan->check_and_reset_option(AP_UAVCAN::Options::DNA_CLEAR_DATABASE)) {
|
|
|
|
GCS_SEND_TEXT(MAV_SEVERITY_INFO, "UC DNA database reset");
|
|
|
|
reset();
|
|
|
|
}
|
2019-09-21 00:16:06 -03:00
|
|
|
// Making sure that the server is started with the same node ID
|
|
|
|
const uint8_t stored_own_node_id = getNodeIDForUniqueID(own_unique_id, own_unique_id_len);
|
|
|
|
static bool reset_done;
|
|
|
|
if (stored_own_node_id != 255) {
|
|
|
|
if (stored_own_node_id != node_id) {
|
|
|
|
/* We have a different node id recorded against our own unique id
|
|
|
|
This calls for a reset */
|
|
|
|
if (!reset_done) {
|
|
|
|
/* ensure we only reset once per power cycle
|
|
|
|
else we will wipe own record on next init(s) */
|
|
|
|
reset();
|
|
|
|
reset_done = true;
|
|
|
|
}
|
|
|
|
//Add ourselves to the Server Record
|
|
|
|
if (!addNodeIDForUniqueID(node_id, own_unique_id, own_unique_id_len)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
//We have no record of our own Unique ID do a reset
|
|
|
|
if (!reset_done) {
|
|
|
|
/* ensure we only reset once per power cycle
|
|
|
|
else we will wipe own record on next init(s) */
|
|
|
|
reset();
|
|
|
|
reset_done = true;
|
|
|
|
}
|
|
|
|
//Add ourselves to the Server Record
|
|
|
|
if (!addNodeIDForUniqueID(node_id, own_unique_id, own_unique_id_len)) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
/* Also add to seen node id this is to verify
|
|
|
|
if any duplicates are on the bus carrying our Node ID */
|
|
|
|
addToSeenNodeMask(node_id);
|
|
|
|
setVerificationMask(node_id);
|
|
|
|
self_node_id[driver_index] = node_id;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
//Reset the Server Records
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::reset()
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
NodeData node_data;
|
|
|
|
memset(&node_data, 0, sizeof(node_data));
|
|
|
|
occupation_mask.clearall();
|
|
|
|
|
|
|
|
//Just write empty Node Data to the Records
|
|
|
|
for (uint8_t i = 0; i <= MAX_NODE_ID; i++) {
|
|
|
|
writeNodeData(node_data, i);
|
|
|
|
}
|
|
|
|
//Ensure we mark magic at the end
|
|
|
|
uint16_t magic = NODEDATA_MAGIC;
|
|
|
|
storage.write_block(0, &magic, NODEDATA_MAGIC_LEN);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Go through the Occupation mask for available Node ID
|
|
|
|
based on pseudo code provided in
|
|
|
|
uavcan/protocol/dynamic_node_id/1.Allocation.uavcan */
|
2019-10-25 00:03:16 -03:00
|
|
|
uint8_t AP_UAVCAN_DNA_Server::findFreeNodeID(uint8_t preferred)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
// Search up
|
|
|
|
uint8_t candidate = (preferred > 0) ? preferred : 125;
|
|
|
|
while (candidate <= 125) {
|
|
|
|
if (!isNodeIDOccupied(candidate)) {
|
|
|
|
return candidate;
|
|
|
|
}
|
|
|
|
candidate++;
|
|
|
|
}
|
|
|
|
//Search down
|
|
|
|
candidate = (preferred > 0) ? preferred : 125;
|
|
|
|
while (candidate > 0) {
|
|
|
|
if (!isNodeIDOccupied(candidate)) {
|
|
|
|
return candidate;
|
|
|
|
}
|
|
|
|
candidate--;
|
|
|
|
}
|
|
|
|
// Not found
|
|
|
|
return 255;
|
|
|
|
}
|
|
|
|
|
|
|
|
//Check if we have received Node Status from this node_id
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::isNodeSeen(uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return node_seen_mask.get(node_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Set the Seen Node Mask, to be called when received
|
|
|
|
Node Status from the node id */
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::addToSeenNodeMask(uint8_t node_id)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
node_seen_mask.set(node_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Run through the list of seen node ids for verification no more
|
|
|
|
than once per 5 second. We continually verify the nodes in our
|
|
|
|
seen list, So that we can raise issue if there are duplicates
|
|
|
|
on the bus. */
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::verify_nodes(AP_UAVCAN *ap_uavcan)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
2020-01-15 19:49:41 -04:00
|
|
|
WITH_SEMAPHORE(sem);
|
|
|
|
|
2020-06-24 09:07:28 -03:00
|
|
|
uint32_t now = uavcan::SystemClock::instance().getMonotonic().toMSec();
|
2019-09-21 00:16:06 -03:00
|
|
|
if ((now - last_verification_request) < 5000) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2020-12-31 17:04:08 -04:00
|
|
|
uint8_t log_count = AP::logger().get_log_start_count();
|
|
|
|
if (log_count != last_logging_count) {
|
|
|
|
last_logging_count = log_count;
|
|
|
|
logged.clearall();
|
|
|
|
}
|
|
|
|
|
2019-09-21 00:16:06 -03:00
|
|
|
//Check if we got acknowledgement from previous request
|
|
|
|
//except for requests using our own node_id
|
2020-06-24 09:07:28 -03:00
|
|
|
for (uint8_t i = 0; i < HAL_MAX_CAN_PROTOCOL_DRIVERS; i++) {
|
2019-09-21 00:16:06 -03:00
|
|
|
if (curr_verifying_node == self_node_id[i]) {
|
|
|
|
nodeInfo_resp_rcvd = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (!nodeInfo_resp_rcvd) {
|
|
|
|
/* Also notify GCS about this
|
|
|
|
Reason for this could be either the node was disconnected
|
|
|
|
Or a node with conflicting ID appeared and is sending response
|
|
|
|
at the same time. */
|
|
|
|
/* Only report if the node was verified, otherwise ignore
|
|
|
|
as this could be just Bootloader to Application transition. */
|
|
|
|
if (isNodeIDVerified(curr_verifying_node)) {
|
|
|
|
// remove verification flag for this node
|
|
|
|
verified_mask.clear(curr_verifying_node);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
last_verification_request = now;
|
|
|
|
//Find the next registered Node ID to be verified.
|
|
|
|
for (uint8_t i = 0; i <= MAX_NODE_ID; i++) {
|
|
|
|
curr_verifying_node = (curr_verifying_node + 1) % (MAX_NODE_ID + 1);
|
|
|
|
if (isNodeSeen(curr_verifying_node)) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
2020-06-24 09:07:28 -03:00
|
|
|
for (uint8_t i = 0; i < HAL_MAX_CAN_PROTOCOL_DRIVERS; i++) {
|
2019-09-21 00:16:06 -03:00
|
|
|
if (getNodeInfo_client[i] != nullptr && isNodeIDOccupied(curr_verifying_node)) {
|
|
|
|
uavcan::protocol::GetNodeInfo::Request request;
|
|
|
|
getNodeInfo_client[i]->call(curr_verifying_node, request);
|
|
|
|
nodeInfo_resp_rcvd = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Handles Node Status Message, adds to the Seen Node list
|
|
|
|
Also starts the Service call for Node Info to complete the
|
|
|
|
Verification process. */
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::handleNodeStatus(uint8_t node_id, const NodeStatusCb &cb)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return;
|
|
|
|
}
|
2020-01-15 19:49:41 -04:00
|
|
|
WITH_SEMAPHORE(sem);
|
2019-09-21 00:16:06 -03:00
|
|
|
if (!isNodeIDVerified(node_id)) {
|
|
|
|
//immediately begin verification of the node_id
|
2020-06-24 09:07:28 -03:00
|
|
|
for (uint8_t i = 0; i < HAL_MAX_CAN_PROTOCOL_DRIVERS; i++) {
|
2019-09-21 00:16:06 -03:00
|
|
|
if (getNodeInfo_client[i] != nullptr) {
|
|
|
|
uavcan::protocol::GetNodeInfo::Request request;
|
|
|
|
getNodeInfo_client[i]->call(node_id, request);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
//Add node to seen list if not seen before
|
|
|
|
addToSeenNodeMask(node_id);
|
|
|
|
}
|
|
|
|
|
|
|
|
//Trampoline call for handleNodeStatus member method
|
|
|
|
void trampoline_handleNodeStatus(AP_UAVCAN* ap_uavcan, uint8_t node_id, const NodeStatusCb &cb)
|
|
|
|
{
|
|
|
|
if (ap_uavcan == nullptr) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2019-10-25 00:03:16 -03:00
|
|
|
AP::uavcan_dna_server().handleNodeStatus(node_id, cb);
|
2019-09-21 00:16:06 -03:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/* Node Info message handler
|
|
|
|
Handle responses from GetNodeInfo Request. We verify the node info
|
|
|
|
against our records. Marks Verification mask if already recorded,
|
|
|
|
Or register if the node id is available and not recorded for the
|
|
|
|
received Unique ID */
|
2020-12-31 17:04:08 -04:00
|
|
|
void AP_UAVCAN_DNA_Server::handleNodeInfo(uint8_t node_id, uint8_t unique_id[], char name[], uint8_t major, uint8_t minor, uint32_t vcs_commit)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (node_id > MAX_NODE_ID) {
|
|
|
|
return;
|
|
|
|
}
|
2020-01-15 19:49:41 -04:00
|
|
|
WITH_SEMAPHORE(sem);
|
2020-12-31 17:04:08 -04:00
|
|
|
|
|
|
|
/*
|
|
|
|
if we haven't logged this node then log it now
|
|
|
|
*/
|
|
|
|
if (!logged.get(node_id) && AP::logger().logging_started()) {
|
|
|
|
logged.set(node_id);
|
|
|
|
uint64_t uid[2];
|
|
|
|
memcpy(uid, unique_id, sizeof(uid));
|
|
|
|
AP::logger().Write("CAND", "TimeUS,NodeId,UID1,UID2,Name,Major,Minor,Version",
|
|
|
|
"s#------", "F-------", "QBQQZBBI",
|
|
|
|
AP_HAL::micros64(),
|
|
|
|
node_id,
|
|
|
|
uid[0], uid[1],
|
|
|
|
name,
|
|
|
|
major,
|
|
|
|
minor,
|
|
|
|
vcs_commit);
|
|
|
|
}
|
|
|
|
|
2019-09-21 00:16:06 -03:00
|
|
|
if (isNodeIDOccupied(node_id)) {
|
|
|
|
//if node_id already registered, just verify if Unique ID matches as well
|
|
|
|
if (node_id == getNodeIDForUniqueID(unique_id, 16)) {
|
|
|
|
if (node_id == curr_verifying_node) {
|
|
|
|
nodeInfo_resp_rcvd = true;
|
|
|
|
}
|
|
|
|
setVerificationMask(node_id);
|
2021-11-02 02:26:10 -03:00
|
|
|
} else if (!_ap_uavcan->option_is_set(AP_UAVCAN::Options::DNA_IGNORE_DUPLICATE_NODE)) {
|
2019-09-21 00:16:06 -03:00
|
|
|
/* This is a device with node_id already registered
|
|
|
|
for another device */
|
|
|
|
server_state = DUPLICATE_NODES;
|
|
|
|
fault_node_id = node_id;
|
|
|
|
memcpy(fault_node_name, name, sizeof(fault_node_name));
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
/* Node Id was not allocated by us, or during this boot, let's register this in our records
|
|
|
|
Check if we allocated this Node before */
|
|
|
|
uint8_t prev_node_id = getNodeIDForUniqueID(unique_id, 16);
|
|
|
|
if (prev_node_id != 255) {
|
|
|
|
//yes we did, remove this registration
|
|
|
|
freeNodeID(prev_node_id);
|
|
|
|
}
|
|
|
|
//add a new server record
|
|
|
|
addNodeIDForUniqueID(node_id, unique_id, 16);
|
|
|
|
//Verify as well
|
|
|
|
setVerificationMask(node_id);
|
|
|
|
if (node_id == curr_verifying_node) {
|
|
|
|
nodeInfo_resp_rcvd = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
//Trampoline call for handleNodeInfo member call
|
|
|
|
void trampoline_handleNodeInfo(const uavcan::ServiceCallResult<uavcan::protocol::GetNodeInfo>& resp)
|
|
|
|
{
|
|
|
|
uint8_t node_id, unique_id[16] = {0};
|
2020-12-31 17:04:08 -04:00
|
|
|
char name[50] = {0};
|
2019-09-21 00:16:06 -03:00
|
|
|
|
|
|
|
node_id = resp.getResponse().getSrcNodeID().get();
|
|
|
|
|
|
|
|
//copy the unique id from message to uint8_t array
|
2020-12-31 17:04:08 -04:00
|
|
|
auto &r = resp.getResponse();
|
|
|
|
uavcan::copy(r.hardware_version.unique_id.begin(),
|
|
|
|
r.hardware_version.unique_id.end(),
|
2019-09-21 00:16:06 -03:00
|
|
|
unique_id);
|
2020-12-31 17:04:08 -04:00
|
|
|
strncpy_noterm(name, r.name.c_str(), sizeof(name)-1);
|
|
|
|
|
|
|
|
auto &dna_server = AP::uavcan_dna_server();
|
|
|
|
|
|
|
|
dna_server.handleNodeInfo(node_id, unique_id, name,
|
|
|
|
r.software_version.major,
|
|
|
|
r.software_version.minor,
|
|
|
|
r.software_version.vcs_commit);
|
2019-09-21 00:16:06 -03:00
|
|
|
}
|
|
|
|
|
|
|
|
/* Handle the allocation message from the devices supporting
|
|
|
|
dynamic node allocation. */
|
2019-10-25 00:03:16 -03:00
|
|
|
void AP_UAVCAN_DNA_Server::handleAllocation(uint8_t driver_index, uint8_t node_id, const AllocationCb &cb)
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
if (allocation_pub[driver_index] == nullptr) {
|
|
|
|
//init has not been called for this driver.
|
|
|
|
return;
|
|
|
|
}
|
2020-01-15 19:49:41 -04:00
|
|
|
WITH_SEMAPHORE(sem);
|
2019-09-21 00:16:06 -03:00
|
|
|
if (!cb.msg->isAnonymousTransfer()) {
|
|
|
|
//Ignore Allocation messages that are not DNA requests
|
|
|
|
return;
|
|
|
|
}
|
2020-06-24 09:07:28 -03:00
|
|
|
uint32_t now = uavcan::SystemClock::instance().getMonotonic().toMSec();
|
2019-09-21 00:16:06 -03:00
|
|
|
if (driver_index == current_driver_index) {
|
|
|
|
last_activity_ms = now;
|
|
|
|
} else if ((now - last_activity_ms) > 500) {
|
|
|
|
/* prepare for requests on another driver if we didn't had any activity on
|
|
|
|
current driver for more than 500ms */
|
|
|
|
current_driver_index = driver_index;
|
|
|
|
last_activity_ms = now;
|
|
|
|
rcvd_unique_id_offset = 0;
|
|
|
|
memset(rcvd_unique_id, 0, sizeof(rcvd_unique_id));
|
|
|
|
} else {
|
|
|
|
/* we ignore the requests from other drivers,
|
|
|
|
while busy handling the current one */
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2020-05-31 09:47:45 -03:00
|
|
|
if (rcvd_unique_id_offset == 0 ||
|
|
|
|
(now - last_alloc_msg_ms) > 500) {
|
|
|
|
if (cb.msg->first_part_of_unique_id) {
|
|
|
|
rcvd_unique_id_offset = 0;
|
|
|
|
memset(rcvd_unique_id, 0, sizeof(rcvd_unique_id));
|
|
|
|
} else {
|
|
|
|
//we are only accepting first part
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
} else if (cb.msg->first_part_of_unique_id) {
|
|
|
|
// we are only accepting follow up messages
|
2019-09-21 00:16:06 -03:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2020-05-31 09:47:45 -03:00
|
|
|
if (rcvd_unique_id_offset) {
|
|
|
|
debug_uavcan(AP_CANManager::LOG_DEBUG, "TIME: %ld -- Accepting Followup part! %u\n", uavcan::SystemClock::instance().getMonotonic().toUSec()/1000, (now - last_alloc_msg_ms));
|
|
|
|
} else {
|
|
|
|
debug_uavcan(AP_CANManager::LOG_DEBUG, "TIME: %ld -- Accepting First part! %u\n", uavcan::SystemClock::instance().getMonotonic().toUSec()/1000, (now - last_alloc_msg_ms));
|
|
|
|
}
|
|
|
|
|
|
|
|
last_alloc_msg_ms = now;
|
2019-09-21 00:16:06 -03:00
|
|
|
if ((rcvd_unique_id_offset + cb.msg->unique_id.size()) > 16) {
|
|
|
|
//This request is malformed, Reset!
|
|
|
|
rcvd_unique_id_offset = 0;
|
|
|
|
memset(rcvd_unique_id, 0, sizeof(rcvd_unique_id));
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
//copy over the unique_id
|
|
|
|
for (uint8_t i=rcvd_unique_id_offset; i<(rcvd_unique_id_offset + cb.msg->unique_id.size()); i++) {
|
|
|
|
rcvd_unique_id[i] = cb.msg->unique_id[i - rcvd_unique_id_offset];
|
|
|
|
}
|
|
|
|
rcvd_unique_id_offset += cb.msg->unique_id.size();
|
|
|
|
|
|
|
|
//send follow up message
|
|
|
|
uavcan::protocol::dynamic_node_id::Allocation msg;
|
|
|
|
|
2020-05-31 09:47:45 -03:00
|
|
|
/* Respond with the message containing the received unique ID so far
|
|
|
|
or with node id if we successfully allocated one. */
|
|
|
|
for (uint8_t i = 0; i < rcvd_unique_id_offset; i++) {
|
|
|
|
msg.unique_id.push_back(rcvd_unique_id[i]);
|
|
|
|
}
|
|
|
|
|
2019-09-21 00:16:06 -03:00
|
|
|
if (rcvd_unique_id_offset == 16) {
|
|
|
|
//We have received the full Unique ID, time to do allocation
|
|
|
|
uint8_t resp_node_id = getNodeIDForUniqueID((const uint8_t*)rcvd_unique_id, 16);
|
|
|
|
if (resp_node_id == 255) {
|
|
|
|
resp_node_id = findFreeNodeID(cb.msg->node_id);
|
|
|
|
if (resp_node_id != 255) {
|
|
|
|
if (addNodeIDForUniqueID(resp_node_id, (const uint8_t*)rcvd_unique_id, 16)) {
|
|
|
|
msg.node_id = resp_node_id;
|
|
|
|
}
|
|
|
|
} else {
|
2020-11-05 19:35:00 -04:00
|
|
|
GCS_SEND_TEXT(MAV_SEVERITY_ERROR, "UC Node Alloc Failed!");
|
2019-09-21 00:16:06 -03:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
msg.node_id = resp_node_id;
|
|
|
|
}
|
2020-05-31 09:47:45 -03:00
|
|
|
//reset states as well
|
|
|
|
rcvd_unique_id_offset = 0;
|
|
|
|
memset(rcvd_unique_id, 0, sizeof(rcvd_unique_id));
|
2019-09-21 00:16:06 -03:00
|
|
|
}
|
|
|
|
|
|
|
|
allocation_pub[driver_index]->broadcast(msg);
|
|
|
|
}
|
|
|
|
|
|
|
|
//Trampoline Call for handleAllocation member call
|
|
|
|
void trampoline_handleAllocation(AP_UAVCAN* ap_uavcan, uint8_t node_id, const AllocationCb &cb)
|
|
|
|
{
|
|
|
|
if (ap_uavcan == nullptr) {
|
|
|
|
return;
|
|
|
|
}
|
2019-10-25 00:03:16 -03:00
|
|
|
AP::uavcan_dna_server().handleAllocation(ap_uavcan->get_driver_index(), node_id, cb);
|
2019-09-21 00:16:06 -03:00
|
|
|
}
|
|
|
|
|
|
|
|
//report the server state, along with failure message if any
|
2019-10-25 00:03:16 -03:00
|
|
|
bool AP_UAVCAN_DNA_Server::prearm_check(char* fail_msg, uint8_t fail_msg_len) const
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
|
|
|
switch (server_state) {
|
2020-05-01 02:20:00 -03:00
|
|
|
case HEALTHY:
|
|
|
|
return true;
|
2019-09-21 00:16:06 -03:00
|
|
|
case STORAGE_FAILURE: {
|
2020-05-01 02:20:00 -03:00
|
|
|
snprintf(fail_msg, fail_msg_len, "Failed to access storage!");
|
2019-09-21 00:16:06 -03:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
case DUPLICATE_NODES: {
|
2021-11-02 02:26:10 -03:00
|
|
|
if (_ap_uavcan->option_is_set(AP_UAVCAN::Options::DNA_IGNORE_DUPLICATE_NODE)) {
|
|
|
|
// ignore error
|
|
|
|
return true;
|
|
|
|
}
|
2020-05-01 02:20:00 -03:00
|
|
|
snprintf(fail_msg, fail_msg_len, "Duplicate Node %s../%d!", fault_node_name, fault_node_id);
|
2019-09-21 00:16:06 -03:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
case FAILED_TO_ADD_NODE: {
|
2020-05-01 02:20:00 -03:00
|
|
|
snprintf(fail_msg, fail_msg_len, "Failed to add Node %d!", fault_node_id);
|
2019-09-21 00:16:06 -03:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
2020-05-01 02:20:00 -03:00
|
|
|
// should never get; compiler should enforce all server_states are covered
|
2019-09-21 00:16:06 -03:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace AP
|
|
|
|
{
|
2019-10-25 00:03:16 -03:00
|
|
|
AP_UAVCAN_DNA_Server& uavcan_dna_server()
|
2019-09-21 00:16:06 -03:00
|
|
|
{
|
2020-06-24 09:07:28 -03:00
|
|
|
// clang gets confused with only one pair of braces so we add one more pair
|
|
|
|
static AP_UAVCAN_DNA_Server _server((StorageAccess(StorageManager::StorageCANDNA)));
|
2019-09-21 00:16:06 -03:00
|
|
|
return _server;
|
|
|
|
}
|
|
|
|
}
|
2020-06-24 09:07:28 -03:00
|
|
|
#endif //HAL_NUM_CAN_IFACES
|