uavcanesc_main.cpp

Go to the documentation of this file.

/****************************************************************************
 *
 *   Copyright (c) 2015 PX4 Development Team. All rights reserved.
 *   Author: Pavel Kirienko <pavel.kirienko@gmail.com>
 *           David Sidrane <david_s5@nscdg.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name PX4 nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/


#include <px4_platform_common/px4_config.h>
#include <px4_platform_common/log.h>
#include <px4_platform_common/tasks.h>

#include <cstdlib>
#include <cstring>
#include <fcntl.h>
#include <systemlib/err.h>
#include <parameters/param.h>
#include <lib/mixer/MixerGroup.hpp>
#include <version/version.h>
#include <arch/board/board.h>
#include <arch/chip/chip.h>

#include <drivers/drv_hrt.h>
#include <drivers/drv_pwm_output.h>

#include "uavcanesc_main.hpp"
#include "led.hpp"
#include "indication_controller.hpp"

#include "boot_app_shared.h"

using namespace time_literals;

/**
 *
 * Implements basic functionality of UAVCAN esc.
 */

/*
 * This is the AppImageDescriptor used
 * by the make_can_boot_descriptor.py tool to set
 * the application image's descriptor so that the
 * uavcan bootloader has the ability to validate the
 * image crc, size etc of this application
*/

boot_app_shared_section app_descriptor_t AppDescriptor = {
    .signature = {APP_DESCRIPTOR_SIGNATURE},
    .image_crc = 0,
    .image_size = 0,
    .vcs_commit = 0,
    .major_version = APP_VERSION_MAJOR,
    .minor_version = APP_VERSION_MINOR,
    .reserved = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff }
};

/*
 * UavcanNode
 */
UavcanEsc *UavcanEsc::_instance;

UavcanEsc::UavcanEsc(uavcan::ICanDriver &can_driver, uavcan::ISystemClock &system_clock) :
    CDev(UAVCAN_DEVICE_PATH),
    active_bitrate(0),
    _node(can_driver, system_clock),
    _node_mutex(),
    _fw_update_listner(_node),
    _reset_timer(_node)
{
    const int res = pthread_mutex_init(&_node_mutex, nullptr);

    if (res < 0) {
        std::abort();
    }

    px4_sem_init(&_sem, 0, 0);
    /* semaphore use case is a signal */
    px4_sem_setprotocol(&_sem, SEM_PRIO_NONE);

}

UavcanEsc::~UavcanEsc()
{
    if (_task != -1) {
        /* tell the task we want it to go away */
        _task_should_exit = true;

        unsigned i = 10;

        do {
            /* wait 5ms - it should wake every 10ms or so worst-case */
            ::usleep(5000);

            /* if we have given up, kill it */
            if (--i == 0) {
                task_delete(_task);
                break;
            }

        } while (_task != -1);
    }

    _instance = nullptr;
    px4_sem_destroy(&_sem);
}

int UavcanEsc::start(uavcan::NodeID node_id, uint32_t bitrate)
{


    if (_instance != nullptr) {
        PX4_WARN("Already started");
        return -1;
    }

    /*
     * CAN driver init
     */
    static CanInitHelper can;
    static bool can_initialized = false;

    if (!can_initialized) {
        const int can_init_res = can.init(bitrate);

        if (can_init_res < 0) {
            PX4_WARN("CAN driver init failed %i", can_init_res);
            return can_init_res;
        }

        can_initialized = true;
    }

    /*
     * Node init
     */
    _instance = new UavcanEsc(can.driver, uavcan_stm32::SystemClock::instance());

    if (_instance == nullptr) {
        PX4_WARN("Out of memory");
        return -1;
    }


    const int node_init_res = _instance->init(node_id, can.driver.updateEvent());

    if (node_init_res < 0) {
        delete _instance;
        _instance = nullptr;
        PX4_WARN("Node init failed %i", node_init_res);
        return node_init_res;
    }


    /* Keep the bit rate for reboots on BenginFirmware updates */

    _instance->active_bitrate = bitrate;

    /*
     * Start the task. Normally it should never exit.
     */
    static auto run_trampoline = [](int, char *[]) {return UavcanEsc::_instance->run();};
    _instance->_task = px4_task_spawn_cmd("uavcanesc", SCHED_DEFAULT, SCHED_PRIORITY_ACTUATOR_OUTPUTS, StackSize,
                          static_cast<main_t>(run_trampoline), nullptr);

    if (_instance->_task < 0) {
        PX4_WARN("start failed: %d", errno);
        return -errno;
    }

    return OK;
}

void UavcanEsc::fill_node_info()
{
    /* software version */
    uavcan::protocol::SoftwareVersion swver;

    // Extracting the first 8 hex digits of the git hash and converting them to int
    char fw_git_short[9] = {};
    std::memmove(fw_git_short, px4_firmware_version_string(), 8);
    char *end = nullptr;
    swver.vcs_commit = std::strtol(fw_git_short, &end, 16);
    swver.optional_field_flags |= swver.OPTIONAL_FIELD_FLAG_VCS_COMMIT;
    swver.major = AppDescriptor.major_version;
    swver.minor = AppDescriptor.minor_version;
    swver.image_crc = AppDescriptor.image_crc;

    PX4_WARN("SW version vcs_commit: 0x%08x", unsigned(swver.vcs_commit));

    _node.setSoftwareVersion(swver);

    /* hardware version */
    uavcan::protocol::HardwareVersion hwver;

    hwver.major = HW_VERSION_MAJOR;
    hwver.minor = HW_VERSION_MINOR;

    mfguid_t mfgid = {};
    board_get_mfguid(mfgid);
    uavcan::copy(mfgid, mfgid + sizeof(mfgid), hwver.unique_id.begin());

    _node.setHardwareVersion(hwver);
}

static void cb_reboot(const uavcan::TimerEvent &)
{
    px4_systemreset(false);

}

void UavcanEsc::cb_beginfirmware_update(const uavcan::ReceivedDataStructure<UavcanEsc::BeginFirmwareUpdate::Request>
                    &req,
                    uavcan::ServiceResponseDataStructure<UavcanEsc::BeginFirmwareUpdate::Response> &rsp)
{
    static bool inprogress = false;

    rsp.error = rsp.ERROR_UNKNOWN;

    if (req.image_file_remote_path.path.size()) {
        rsp.error = rsp.ERROR_IN_PROGRESS;

        if (!inprogress) {
            inprogress = true;
            bootloader_app_shared_t shared;
            shared.bus_speed = active_bitrate;
            shared.node_id = _node.getNodeID().get();
            bootloader_app_shared_write(&shared, App);
            rgb_led(255, 128, 0, 5);
            _reset_timer.setCallback(cb_reboot);
            _reset_timer.startOneShotWithDelay(uavcan::MonotonicDuration::fromMSec(1000));
            rsp.error = rsp.ERROR_OK;
        }
    }
}

int UavcanEsc::init(uavcan::NodeID node_id, uavcan_stm32::BusEvent &bus_events)
{
    int ret = -1;

    // Do regular cdev init
    ret = CDev::init();

    if (ret != OK) {
        return ret;
    }

    _node.setName(HW_UAVCAN_NAME);

    _node.setNodeID(node_id);

    fill_node_info();

    const int srv_start_res = _fw_update_listner.start(BeginFirmwareUpdateCallBack(this,
                  &UavcanEsc::cb_beginfirmware_update));

    if (srv_start_res < 0) {
        return ret;
    }

    bus_events.registerSignalCallback(UavcanEsc::busevent_signal_trampoline);

    return _node.start();
}


/*
 * Restart handler
 */
class RestartRequestHandler: public uavcan::IRestartRequestHandler
{
    bool handleRestartRequest(uavcan::NodeID request_source) override
    {
        ::syslog(LOG_INFO, "UAVCAN: Restarting by request from %i\n", int(request_source.get()));
        ::usleep(20 * 1000 * 1000);
        px4_systemreset(false);
        return true; // Will never be executed BTW
    }
} restart_request_handler;

void UavcanEsc::node_spin_once()
{
    const int spin_res = _node.spin(uavcan::MonotonicTime());

    if (spin_res < 0) {
        PX4_WARN("node spin error %i", spin_res);
    }
}

static void signal_callback(void *arg)
{
    /* Note: we are in IRQ context here */
    px4_sem_t *sem = (px4_sem_t *)arg;
    int semaphore_value;

    if (px4_sem_getvalue(sem, &semaphore_value) == 0 && semaphore_value > 1) {
        return;
    }

    px4_sem_post(sem);
}


void
UavcanEsc::busevent_signal_trampoline()
{
    if (_instance) {
        signal_callback(&_instance->_sem);
    }
}

int UavcanEsc::run()
{

    get_node().setRestartRequestHandler(&restart_request_handler);

    while (init_indication_controller(get_node()) < 0) {
        ::syslog(LOG_INFO, "UAVCAN: Indication controller init failed\n");
        ::sleep(1);
    }

    (void)pthread_mutex_lock(&_node_mutex);

    _node.setModeOperational();

    hrt_call timer_call{};
    hrt_call_every(&timer_call, 50_ms, 50_ms, signal_callback, &_sem);

    while (!_task_should_exit) {
        // Mutex is unlocked while the thread is blocked on IO multiplexing
        (void)pthread_mutex_unlock(&_node_mutex);

        while (px4_sem_wait(&_sem) != 0);

        (void)pthread_mutex_lock(&_node_mutex);

        node_spin_once();  // Non-blocking

        // Do Something

    }

    hrt_cancel(&timer_call);
    teardown();
    (void)pthread_mutex_unlock(&_node_mutex);

    exit(0);
}

int
UavcanEsc::teardown()
{
    return 0;
}



int
UavcanEsc::ioctl(file *filp, int cmd, unsigned long arg)
{
    int ret = OK;

    lock();

    switch (cmd) {



    default:
        ret = -ENOTTY;
        break;
    }

    unlock();

    if (ret == -ENOTTY) {
        ret = CDev::ioctl(filp, cmd, arg);
    }

    return ret;
}

void
UavcanEsc::print_info()
{
    if (!_instance) {
        PX4_WARN("not running, start first");
    }

    (void)pthread_mutex_lock(&_node_mutex);


    (void)pthread_mutex_unlock(&_node_mutex);
}

/*
 * App entry point
 */
static void print_usage()
{
    PX4_INFO("usage: \n"
         "\tuavcanesc {start|status|stop}");
}

extern "C" __EXPORT int uavcannode_start(int argc, char *argv[]);

int uavcannode_start(int argc, char *argv[])
{
    // CAN bitrate
    int32_t bitrate = 0;
    // Node ID
    int32_t node_id = 0;

    // Did the bootloader auto baud and get a node ID Allocated

    bootloader_app_shared_t shared;
    int valid  = bootloader_app_shared_read(&shared, BootLoader);

    if (valid == 0) {

        bitrate = shared.bus_speed;
        node_id = shared.node_id;

        // Invalidate to prevent deja vu

        bootloader_app_shared_invalidate();

    } else {

        // Node ID
        (void)param_get(param_find("ESC_NODE_ID"), &node_id);
        (void)param_get(param_find("ESC_BITRATE"), &bitrate);
    }

    if (node_id < 0 || node_id > uavcan::NodeID::Max || !uavcan::NodeID(node_id).isUnicast()) {
        PX4_WARN("Invalid Node ID %i", node_id);
        ::exit(1);
    }

    // Start
    PX4_WARN("Node ID %u, bitrate %u", node_id, bitrate);
    int rv = UavcanEsc::start(node_id, bitrate);
    ::sleep(1);
    return rv;
}

extern "C" __EXPORT int uavcanesc_main(int argc, char *argv[]);
int uavcanesc_main(int argc, char *argv[])
{
    if (argc < 2) {
        print_usage();
        ::exit(1);
    }

    if (!std::strcmp(argv[1], "start")) {

        if (UavcanEsc::instance()) {
            errx(1, "already started");
        }

        return uavcannode_start(argc, argv);
    }

    /* commands below require the app to be started */
    UavcanEsc *const inst = UavcanEsc::instance();

    if (!inst) {
        PX4_ERR("application not running");
        ::exit(1);

    }

    if (!std::strcmp(argv[1], "status") || !std::strcmp(argv[1], "info")) {
        inst->print_info();
        ::exit(0);
    }

    if (!std::strcmp(argv[1], "stop")) {
        delete inst;
        ::exit(0);
    }

    print_usage();
    ::exit(1);
}