resolved merge conflicts

This commit is contained in:
Jake Dahl
2018-07-25 15:16:40 -06:00
committed by Lorenz Meier
parent 79ba6b0d39
commit 3f550bf408
5 changed files with 1409 additions and 764 deletions
+2
View File
@@ -35,6 +35,8 @@ px4_add_module(
MAIN batt_smbus
COMPILE_FLAGS
SRCS
batt_smbus_main.cpp
batt_smbus.cpp
batt_smbus_i2c.cpp
DEPENDS
)
File diff suppressed because it is too large Load Diff
+322
View File
@@ -0,0 +1,322 @@
/****************************************************************************
*
* Copyright (c) 2012-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.
*
****************************************************************************/
/**
* @file batt_smbus.h
*
* Header for a battery monitor connected via SMBus (I2C).
* Designed for BQ40Z50-R1/R2
*
* @author Randy Mackay <rmackay9@yahoo.com>
* @author Alex Klimaj <alexklimaj@gmail.com>
* @author Mark Sauder <mcsauder@gmail.com>
* @author Jacob Dahl <dahl.jakejacob@gmail.com>
*/
#include <px4_config.h>
#include <px4_workqueue.h>
#include <stdio.h>
#include <string.h>
#include <ecl/geo/geo.h>
#include <drivers/device/CDev.hpp>
#include <drivers/device/Device.hpp>
#include <drivers/device/i2c.h>
#include <drivers/drv_device.h>
#include <drivers/drv_hrt.h>
#include <uORB/topics/battery_status.h>
#define DATA_BUFFER_SIZE 32
#define BATT_SMBUS_I2C_BUS PX4_I2C_BUS_EXPANSION
#define BATT_SMBUS_CURRENT 0x0A ///< current register
#define BATT_SMBUS_AVERAGE_CURRENT 0x0B ///< current register
#define BATT_SMBUS_ADDR 0x0B ///< Default 7 bit address I2C address. 8 bit = 0x16
#define BATT_SMBUS_ADDR_MIN 0x00 ///< lowest possible address
#define BATT_SMBUS_ADDR_MAX 0xFF ///< highest possible address
#define BATT_SMBUS_PEC_POLYNOMIAL 0x07 ///< Polynomial for calculating PEC
#define BATT_SMBUS_TEMP 0x08 ///< temperature register
#define BATT_SMBUS_VOLTAGE 0x09 ///< voltage register
#define BATT_SMBUS_FULL_CHARGE_CAPACITY 0x10 ///< capacity when fully charged
#define BATT_SMBUS_RUN_TIME_TO_EMPTY 0x11 ///< predicted remaining battery capacity based on the present rate of discharge in min
#define BATT_SMBUS_AVERAGE_TIME_TO_EMPTY 0x12 ///< predicted remaining battery capacity based on the present rate of discharge in min
#define BATT_SMBUS_REMAINING_CAPACITY 0x0F ///< predicted remaining battery capacity as a percentage
#define BATT_SMBUS_CYCLE_COUNT 0x17 ///< number of cycles the battery has experienced
#define BATT_SMBUS_DESIGN_CAPACITY 0x18 ///< design capacity register
#define BATT_SMBUS_DESIGN_VOLTAGE 0x19 ///< design voltage register
#define BATT_SMBUS_MANUFACTURER_NAME 0x20 ///< manufacturer name
#define BATT_SMBUS_MANUFACTURE_DATE 0x1B ///< manufacture date register
#define BATT_SMBUS_SERIAL_NUMBER 0x1C ///< serial number register
#define BATT_SMBUS_MEASUREMENT_INTERVAL_US 100000 ///< time in microseconds, measure at 10Hz
#define BATT_SMBUS_TIMEOUT_US 1000000 ///< timeout looking for battery 10seconds after startup
#define BATT_SMBUS_MANUFACTURER_ACCESS 0x00
#define BATT_SMBUS_MANUFACTURER_DATA 0x23
#define BATT_SMBUS_MANUFACTURER_BLOCK_ACCESS 0x44
#define BATT_SMBUS_SECURITY_KEYS 0x0035
#ifndef CONFIG_SCHED_WORKQUEUE
# error This requires CONFIG_SCHED_WORKQUEUE.
#endif
/**
* @brief Nuttshell accessible method to return the driver usage arguments.
*/
void batt_smbus_usage();
/**
* @brief Nuttshell accessible method to return the battery manufacture date.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int manufacture_date();
/**
* @brief Nuttshell accessible method to return the battery manufacturer name.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int manufacturer_name();
/**
* @brief Nuttshell accessible method to return the battery serial number.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int serial_number();
extern device::Device *BATT_SMBUS_I2C_interface(int bus);
typedef device::Device *(*BATT_SMBUS_constructor)(int);
class BATT_SMBUS : public device::CDev
{
public:
/**
* @brief Default Constructor.
* @param interface The device communication interface (i2c)
* @param path The device i2c address
*/
BATT_SMBUS(device::Device *interface, const char *path);
/**
* @brief Default Destructor.
*/
virtual ~BATT_SMBUS();
/**
* @brief Sends a block read command.
* @param cmd_code The command code.
* @param data The returned data.
* @param length The number of bytes being read
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int block_read(const uint8_t cmd_code, void *data, const unsigned length);
/**
* @brief Sends a block write command.
* @param cmd_code The command code.
* @param data The data to be written.
* @param length The number of bytes being written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int block_write(const uint8_t cmd_code, void *data, const unsigned length);
/**
* @brief Reads data from flash.
* @param address The address to start the read from.
* @param data The returned data.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int dataflash_read(uint16_t &address, void *data);
/**
* @brief Writes data to flash.
* @param address The start address of the write.
* @param data The data to be written.
* @param length The number of bytes being written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int dataflash_write(uint16_t &address, void *data, const unsigned length);
/**
* @brief Calculates the PEC from the data.
* @param buff The buffer that stores the data.
* @param length The number of bytes being written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
uint8_t get_pec(uint8_t *buffer, const uint8_t length);
/**
* @brief Returns the SBS serial number of the battery device.
* @return Returns the SBS serial number of the battery device.
*/
uint16_t get_serial_number();
/**
* @brief Read info from battery on startup.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int get_startup_info();
/**
* @brief Prints the latest report.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int info();
/**
* @brief Initializes the smart battery device. Calls probe() to check for device on bus.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
virtual int init();
/**
* @brief Gets the SBS manufacture date of the battery.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int manufacture_date(void *man_date);
/**
* @brief Gets the SBS manufacturer name of the battery device.
* @param manufacturer_name Pointer to a buffer into which the manufacturer name is to be written.
* @param max_length The maximum number of bytes to attempt to read from the manufacturer name register,
* including the null character that is appended to the end.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int manufacturer_name(uint8_t *manufacturer_name, const uint8_t length);
/**
* @brief Performs a ManufacturerBlockAccess() read command.
* @param cmd_code The command code.
* @param data The returned data.
* @param length The number of bytes being written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int manufacturer_read(const uint16_t cmd_code, void *data, const unsigned length);
/**
* @brief Performs a ManufacturerBlockAccess() write command.
* @param cmd_code The command code.
* @param data The sent data.
* @param length The number of bytes being written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int manufacturer_write(const uint16_t cmd_code, void *data, const unsigned length);
/**
* @brief Sends a read-word command with cmd_code as the command.
* @param cmd_code The command code.
* @param data The returned data.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int read_word(const uint8_t cmd_code, void *data);
/**
* @brief Search all possible slave addresses for a smart battery.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int search_addresses();
/**
* @brief Starts periodic reads from the battery.
*/
void start();
/**
* @brief Stops periodic reads from the battery.
*/
void stop();
/**
* @brief Unseals the battery to allow writing to restricted flash.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int unseal();
protected:
Device *_interface;
private:
/**
* @brief Static function that is called by worker queue.
*/
static void cycle_trampoline(void *arg);
/**
* @brief The loop that continually generates new reports.
*/
void cycle();
/** @struct _work Work queue for scheduling reads. */
work_s _work = work_s{};
/** @param _last_report Last published report, used for test(). */
battery_status_s _last_report = battery_status_s{};
/** @param _batt_topic uORB battery topic. */
orb_advert_t _batt_topic;
/** @param _batt_orb_id uORB battery topic ID. */
orb_id_t _batt_orb_id;
/** @param _batt_capacity Battery design capacity in mAh (0 means unknown). */
uint16_t _batt_capacity;
/** @param _batt_startup_capacity Battery remaining capacity in mAh on startup. */
uint16_t _batt_startup_capacity;
/** @param _cycle_count The number of cycles the battery has experienced. */
uint16_t _cycle_count;
/** @param _serial_number Serial number register. */
uint16_t _serial_number;
/** @param _crit_thr Critical battery threshold param. */
float _crit_thr;
/** @param _emergency_thr Emergency battery threshold param. */
float _emergency_thr;
/** @param _low_thr Low battery threshold param. */
float _low_thr;
/** @param _manufacturer_name Name of the battery manufacturer. */
char *_manufacturer_name;
/* Do not allow copy construction or move assignment of this class. */
BATT_SMBUS(const BATT_SMBUS &);
BATT_SMBUS operator=(const BATT_SMBUS &);
};
+131
View File
@@ -0,0 +1,131 @@
/****************************************************************************
*
* 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.
*
****************************************************************************/
/**
* @file batt_smbus_i2c.cpp
*
* I2C interface for batt_smbus
*
* @author Jacob Dahl <dahl.jakejacob@gmail.com>
*/
#include "batt_smbus.h"
#include <cstring>
#include <px4_config.h>
#include <drivers/device/i2c.h>
#include <drivers/drv_device.h>
#include "board_config.h"
device::Device *BATT_SMBUS_I2C_interface(int bus);
class BATT_SMBUS_I2C : public device::I2C
{
public:
BATT_SMBUS_I2C(int bus);
virtual ~BATT_SMBUS_I2C() = default;
/**
* @brief Sends a block read command.
* @param cmd_code The command code.
* @param data Pointer to the data being returned.
* @param count The number of bytes being read
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
virtual int read(unsigned cmd_code, void *data, unsigned count);
/**
* @brief Sends a block write command.
* @param cmd_code The command code.
* @param data Pointer to the data to be written.
* @param count The number of bytes being written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
virtual int write(unsigned cmd_code, void *data, unsigned count);
/**
* @brief Sends a block read command.
* @param cmd_code The command code.
* @param data Pointer to the data being returned.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int read(unsigned cmd_code, void *data);
/**
* @brief Sends a block write command.
* @param cmd_code The command code.
* @param data Pointer to the data to be written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
int write(unsigned cmd_code, void *data);
protected:
/**
* @brief Calculates the PEC from the data.
* @param buffer The buffer that stores the data.
* @param length The number of bytes being written.
* @return Returns PX4_OK on success, PX4_ERROR on failure.
*/
uint8_t get_pec(uint8_t *buffer, uint8_t length);
};
device::Device *
BATT_SMBUS_I2C_interface(int bus)
{
return new BATT_SMBUS_I2C(bus);
}
BATT_SMBUS_I2C::BATT_SMBUS_I2C(int bus) :
I2C("BATT_SMBUS_I2C", nullptr, bus, BATT_SMBUS_ADDR, 100000)
{
}
int
BATT_SMBUS_I2C::read(unsigned cmd_code, void *data, unsigned length)
{
uint8_t buf = (uint8_t) cmd_code;
return transfer(&buf, 1, (uint8_t *)data, length);
}
int
BATT_SMBUS_I2C::write(unsigned cmd_code, void *data, unsigned length)
{
return transfer((uint8_t *)data, length, nullptr, 0);
}
File diff suppressed because it is too large Load Diff