bmi088_main.cpp

Go to the documentation of this file.

/****************************************************************************
 *
 *   Copyright (c) 2018 PX4 Development Team. All rights reserved.
 *
 * 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 "BMI088_accel.hpp"
#include "BMI088_gyro.hpp"

/** driver 'main' command */
extern "C" { __EXPORT int bmi088_main(int argc, char *argv[]); }

enum sensor_type {
    BMI088_NONE = 0,
    BMI088_ACCEL = 1,
    BMI088_GYRO
};

namespace bmi088
{

BMI088_accel    *g_acc_dev_int; // on internal bus (accel)
BMI088_accel    *g_acc_dev_ext; // on external bus (accel)
BMI088_gyro     *g_gyr_dev_int; // on internal bus (gyro)
BMI088_gyro     *g_gyr_dev_ext; // on external bus (gyro)

void    start(bool, enum Rotation, enum sensor_type);
void    stop(bool, enum sensor_type);
void    info(bool, enum sensor_type);
void    regdump(bool, enum sensor_type);
void    testerror(bool, enum sensor_type);
void    usage();

/**
 * Start the driver.
 *
 * This function only returns if the driver is up and running
 * or failed to detect the sensor.
 */
void
start(bool external_bus, enum Rotation rotation, enum sensor_type sensor)
{

    BMI088_accel **g_dev_acc_ptr = external_bus ? &g_acc_dev_ext : &g_acc_dev_int;
    const char *path_accel = external_bus ? BMI088_DEVICE_PATH_ACCEL_EXT : BMI088_DEVICE_PATH_ACCEL;

    BMI088_gyro **g_dev_gyr_ptr = external_bus ? &g_gyr_dev_ext : &g_gyr_dev_int;
    const char *path_gyro  = external_bus ? BMI088_DEVICE_PATH_GYRO_EXT : BMI088_DEVICE_PATH_GYRO;

    if (sensor == BMI088_ACCEL) {
        if (*g_dev_acc_ptr != nullptr)
            /* if already started, the still command succeeded */
        {
            errx(0, "bmi088 accel sensor already started");
        }

        /* create the driver */
        if (external_bus) {
#if defined(PX4_SPI_BUS_EXT) && defined(PX4_SPIDEV_EXT_BMI)
            *g_dev_acc_ptr = new BMI088_accel(PX4_SPI_BUS_EXT, path_accel, PX4_SPIDEV_EXT_BMI, rotation);
#else
            errx(0, "External SPI not available");
#endif

        } else {
            *g_dev_acc_ptr = new BMI088_accel(PX4_SPI_BUS_SENSORS3, path_accel, PX4_SPIDEV_BMI088_ACC, rotation);
        }

        if (*g_dev_acc_ptr == nullptr) {
            goto fail_accel;
        }

        if (OK != (*g_dev_acc_ptr)->init()) {
            goto fail_accel;
        }

        // start automatic data collection
        (*g_dev_acc_ptr)->start();
    }

    if (sensor == BMI088_GYRO) {

        if (*g_dev_gyr_ptr != nullptr) {
            errx(0, "bmi088 gyro sensor already started");
        }

        /* create the driver */
        if (external_bus) {
#if defined(PX4_SPI_BUS_EXT) && defined(PX4_SPIDEV_EXT_BMI)
            *g_dev_ptr = new BMI088_gyro(PX4_SPI_BUS_EXT, path_gyro, PX4_SPIDEV_EXT_BMI, rotation);
#else
            errx(0, "External SPI not available");
#endif

        } else {
            *g_dev_gyr_ptr = new BMI088_gyro(PX4_SPI_BUS_SENSORS3, path_gyro, PX4_SPIDEV_BMI088_GYR, rotation);
        }

        if (*g_dev_gyr_ptr == nullptr) {
            goto fail_gyro;
        }

        if (OK != (*g_dev_gyr_ptr)->init()) {
            goto fail_gyro;
        }

        // start automatic data collection
        (*g_dev_gyr_ptr)->start();
    }

    exit(PX4_OK);

fail_accel:

    if (*g_dev_acc_ptr != nullptr) {
        delete (*g_dev_acc_ptr);
        *g_dev_acc_ptr = nullptr;
    }

    PX4_WARN("No BMI088 accel found");
    exit(PX4_ERROR);

fail_gyro:

    if (*g_dev_gyr_ptr != nullptr) {
        delete (*g_dev_gyr_ptr);
        *g_dev_gyr_ptr = nullptr;
    }

    PX4_WARN("No BMI088 gyro found");
    exit(PX4_ERROR);
}

void
stop(bool external_bus, enum sensor_type sensor)
{
    BMI088_accel **g_dev_acc_ptr = external_bus ? &g_acc_dev_ext : &g_acc_dev_int;
    BMI088_gyro **g_dev_gyr_ptr = external_bus ? &g_gyr_dev_ext : &g_gyr_dev_int;

    if (sensor == BMI088_ACCEL) {
        if (*g_dev_acc_ptr != nullptr) {
            delete *g_dev_acc_ptr;
            *g_dev_acc_ptr = nullptr;

        } else {
            /* warn, but not an error */
            warnx("bmi088 accel sensor already stopped.");
        }
    }

    if (sensor == BMI088_GYRO) {
        if (*g_dev_gyr_ptr != nullptr) {
            delete *g_dev_gyr_ptr;
            *g_dev_gyr_ptr = nullptr;

        } else {
            /* warn, but not an error */
            warnx("bmi088 gyro sensor already stopped.");
        }
    }

    exit(0);

}

/**
 * Print a little info about the driver.
 */
void
info(bool external_bus, enum sensor_type sensor)
{
    BMI088_accel **g_dev_acc_ptr = external_bus ? &g_acc_dev_ext : &g_acc_dev_int;
    BMI088_gyro **g_dev_gyr_ptr = external_bus ? &g_gyr_dev_ext : &g_gyr_dev_int;

    if (sensor == BMI088_ACCEL) {
        if (*g_dev_acc_ptr == nullptr) {
            errx(1, "bmi088 accel driver not running");
        }

        printf("state @ %p\n", *g_dev_acc_ptr);
        (*g_dev_acc_ptr)->print_info();
    }

    if (sensor == BMI088_GYRO) {
        if (*g_dev_gyr_ptr == nullptr) {
            errx(1, "bmi088 gyro driver not running");
        }

        printf("state @ %p\n", *g_dev_gyr_ptr);
        (*g_dev_gyr_ptr)->print_info();
    }

    exit(0);
}

/**
 * Dump the register information
 */
void
regdump(bool external_bus, enum sensor_type sensor)
{
    BMI088_accel **g_dev_acc_ptr = external_bus ? &g_acc_dev_ext : &g_acc_dev_int;
    BMI088_gyro **g_dev_gyr_ptr = external_bus ? &g_gyr_dev_ext : &g_gyr_dev_int;

    if (sensor == BMI088_ACCEL) {
        if (*g_dev_acc_ptr == nullptr) {
            errx(1, "bmi088 accel driver not running");
        }

        printf("regdump @ %p\n", *g_dev_acc_ptr);
        (*g_dev_acc_ptr)->print_registers();
    }

    if (sensor == BMI088_GYRO) {
        if (*g_dev_gyr_ptr == nullptr) {
            errx(1, "bmi088 gyro driver not running");
        }

        printf("regdump @ %p\n", *g_dev_gyr_ptr);
        (*g_dev_gyr_ptr)->print_registers();
    }

    exit(0);
}

/**
 * deliberately produce an error to test recovery
 */
void
testerror(bool external_bus, enum sensor_type sensor)
{
    BMI088_accel **g_dev_acc_ptr = external_bus ? &g_acc_dev_ext : &g_acc_dev_int;
    BMI088_gyro **g_dev_gyr_ptr = external_bus ? &g_gyr_dev_ext : &g_gyr_dev_int;

    if (sensor == BMI088_ACCEL) {
        if (*g_dev_acc_ptr == nullptr) {
            errx(1, "bmi088 accel driver not running");
        }

        (*g_dev_acc_ptr)->test_error();
    }

    if (sensor == BMI088_GYRO) {
        if (*g_dev_gyr_ptr == nullptr) {
            errx(1, "bmi088 gyro driver not running");
        }

        (*g_dev_gyr_ptr)->test_error();
    }

    exit(0);
}

void
usage()
{
    warnx("missing command: try 'start', 'info', 'stop', 'regdump', 'testerror'");
    warnx("options:");
    warnx("    -X    (external bus)");
    warnx("    -R    rotation");
    warnx("    -A    (Enable Accelerometer)");
    warnx("    -G    (Enable Gyroscope)");
}

}//namespace ends


BMI088::BMI088(const char *name, const char *devname, int bus, uint32_t device, enum spi_mode_e mode,
           uint32_t frequency, enum Rotation rotation):
    SPI(name, devname, bus, device, mode, frequency),
    _whoami(0),
    _register_wait(0),
    _reset_wait(0),
    _rotation(rotation),
    _checked_next(0)
{
}

uint8_t
BMI088::read_reg(unsigned reg)
{
    uint8_t cmd[2] = { (uint8_t)(reg | DIR_READ), 0};

    transfer(cmd, cmd, sizeof(cmd));

    return cmd[1];
}

uint16_t
BMI088::read_reg16(unsigned reg)
{
    uint8_t cmd[3] = { (uint8_t)(reg | DIR_READ), 0, 0 };

    transfer(cmd, cmd, sizeof(cmd));

    return (uint16_t)(cmd[1] << 8) | cmd[2];
}

void
BMI088::write_reg(unsigned reg, uint8_t value)
{
    uint8_t cmd[2];

    cmd[0] = reg | DIR_WRITE;
    cmd[1] = value;

    transfer(cmd, nullptr, sizeof(cmd));
}

int
bmi088_main(int argc, char *argv[])
{
    bool external_bus = false;
    int ch;
    enum Rotation rotation = ROTATION_NONE;
    enum sensor_type sensor = BMI088_NONE;
    int myoptind = 1;
    const char *myoptarg = NULL;

    /* jump over start/off/etc and look at options first */
    while ((ch = px4_getopt(argc, argv, "XR:AG", &myoptind, &myoptarg)) != EOF) {
        switch (ch) {
        case 'X':
            external_bus = true;
            break;

        case 'R':
            rotation = (enum Rotation)atoi(myoptarg);
            break;

        case 'A':
            sensor = BMI088_ACCEL;
            break;

        case 'G':
            sensor = BMI088_GYRO;
            break;

        default:
            bmi088::usage();
            exit(0);
        }
    }

    const char *verb = argv[myoptind];

    if (sensor == BMI088_NONE) {
        bmi088::usage();
        exit(0);
    }

    /*
    * Start/load the driver.
    */
    if (!strcmp(verb, "start")) {
        bmi088::start(external_bus, rotation, sensor);
    }

    /*
    * Stop the driver.
    */
    if (!strcmp(verb, "stop")) {
        bmi088::stop(external_bus, sensor);
    }

    /*
    * Print driver information.
    */
    if (!strcmp(verb, "info")) {
        bmi088::info(external_bus, sensor);
    }

    /*
    * Print register information.
    */
    if (!strcmp(verb, "regdump")) {
        bmi088::regdump(external_bus, sensor);
    }

    if (!strcmp(verb, "testerror")) {
        bmi088::testerror(external_bus, sensor);
    }

    bmi088::usage();
    exit(1);
}