tests/drivers/fuel_gauge/bq27z746/src/test_bq27z746.c

/*
 * Copyright (c) 2023, ithinx GmbH
 * Copyright (c) 2023, Tonies GmbH
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#include <zephyr/device.h>
#include <zephyr/drivers/fuel_gauge.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/byteorder.h>
#include <zephyr/sys/util.h>
#include <zephyr/ztest.h>
#include <zephyr/ztest_assert.h>

struct bq27z746_fixture {
	const struct device *dev;
	const struct fuel_gauge_driver_api *api;
};

static void *bq27z746_setup(void)
{
	static ZTEST_DMEM struct bq27z746_fixture fixture;

	fixture.dev = DEVICE_DT_GET_ANY(ti_bq27z746);
	k_object_access_all_grant(fixture.dev);

	zassert_true(device_is_ready(fixture.dev), "Fuel Gauge not found");

	return &fixture;
}

ZTEST_USER_F(bq27z746, test_get_some_props_failed_returns_bad_status)
{
	fuel_gauge_prop_t props[] = {
		/* First invalid property */
		FUEL_GAUGE_PROP_MAX,
		/* Second invalid property */
		FUEL_GAUGE_PROP_MAX,
		/* Valid property */
		FUEL_GAUGE_VOLTAGE,
	};
	union fuel_gauge_prop_val vals[ARRAY_SIZE(props)];

	int ret = fuel_gauge_get_props(fixture->dev, props, vals, ARRAY_SIZE(props));

	zassert_equal(ret, -ENOTSUP, "Getting bad property has a good status.");
}

ZTEST_USER_F(bq27z746, test_get_buffer_prop)
{
	int ret;

	{
		struct sbs_gauge_manufacturer_name mfg_name;

		ret = fuel_gauge_get_buffer_prop(fixture->dev, FUEL_GAUGE_MANUFACTURER_NAME,
						 &mfg_name, sizeof(mfg_name));
		zassert_ok(ret);
#if CONFIG_EMUL
		/* Only test for fixed values in emulation since the real device might be */
		/* reprogrammed and respond with different values */
		zassert_equal(sizeof("Texas Instruments") - 1, mfg_name.manufacturer_name_length);
		zassert_mem_equal(mfg_name.manufacturer_name, "Texas Instruments",
				  mfg_name.manufacturer_name_length,
				  "mfg_name.manufacturer_name='%s'", mfg_name.manufacturer_name);
#endif
	}
	{
		struct sbs_gauge_device_name dev_name;

		ret = fuel_gauge_get_buffer_prop(fixture->dev, FUEL_GAUGE_DEVICE_NAME, &dev_name,
						 sizeof(dev_name));
		zassert_ok(ret);
#if CONFIG_EMUL
		/* Only test for fixed values in emulation since the real device might be */
		/* reprogrammed and respond with different values */
		zassert_equal(sizeof("BQ27Z746") - 1, dev_name.device_name_length);
		zassert_mem_equal(dev_name.device_name, "BQ27Z746", dev_name.device_name_length);
#endif
	}
	{
		struct sbs_gauge_device_chemistry device_chemistry;

		ret = fuel_gauge_get_buffer_prop(fixture->dev, FUEL_GAUGE_DEVICE_CHEMISTRY,
						 &device_chemistry, sizeof(device_chemistry));
		zassert_ok(ret);
#if CONFIG_EMUL
		/* Only test for fixed values in emulation since the real device might be */
		/* reprogrammed and respond with different values */
		zassert_equal(sizeof("LION") - 1, device_chemistry.device_chemistry_length);
		zassert_mem_equal(device_chemistry.device_chemistry, "LION",
				  device_chemistry.device_chemistry_length);
#endif
	}
}

ZTEST_USER_F(bq27z746, test_get_props__returns_ok)
{
	/* Validate what props are supported by the driver */

	fuel_gauge_prop_t props[] = {
			FUEL_GAUGE_AVG_CURRENT,
			FUEL_GAUGE_CYCLE_COUNT,
			FUEL_GAUGE_CURRENT,
			FUEL_GAUGE_FULL_CHARGE_CAPACITY,
			FUEL_GAUGE_REMAINING_CAPACITY,
			FUEL_GAUGE_RUNTIME_TO_EMPTY,
			FUEL_GAUGE_RUNTIME_TO_FULL,
			FUEL_GAUGE_SBS_MFR_ACCESS,
			FUEL_GAUGE_RELATIVE_STATE_OF_CHARGE,
			FUEL_GAUGE_TEMPERATURE,
			FUEL_GAUGE_VOLTAGE,
			FUEL_GAUGE_SBS_ATRATE,
			FUEL_GAUGE_SBS_ATRATE_TIME_TO_EMPTY,
			FUEL_GAUGE_CHARGE_VOLTAGE,
			FUEL_GAUGE_CHARGE_CURRENT,
			FUEL_GAUGE_STATUS,
			FUEL_GAUGE_DESIGN_CAPACITY,
	};
	union fuel_gauge_prop_val vals[ARRAY_SIZE(props)];

	zassert_ok(fuel_gauge_get_props(fixture->dev, props, vals, ARRAY_SIZE(props)));

	/* Check properties for valid ranges */
#if CONFIG_EMUL
	/* When emulating, check for the fixed values coming from the emulator */
	zassert_equal(vals[0].avg_current, -2000);
	zassert_equal(vals[1].cycle_count, 100);
	zassert_equal(vals[2].current, -2000);
	zassert_equal(vals[3].full_charge_capacity, 1000);
	zassert_equal(vals[4].remaining_capacity, 1000);
	zassert_equal(vals[5].runtime_to_empty, 1);
	zassert_equal(vals[6].runtime_to_full, 1);
	zassert_equal(vals[7].sbs_mfr_access_word, 1);
	zassert_equal(vals[8].relative_state_of_charge, 1);
	zassert_equal(vals[9].temperature, 1);
	zassert_equal(vals[10].voltage, 1000);
	zassert_equal(vals[11].sbs_at_rate, -2);
	zassert_equal(vals[12].sbs_at_rate_time_to_empty, 1);
	zassert_equal(vals[13].chg_voltage, 1000);
	zassert_equal(vals[14].chg_current, 1000);
	zassert_equal(vals[15].fg_status, 1);
	zassert_equal(vals[16].design_cap, 1);
#else
	/* When having a real device, check for the valid ranges */
	zassert_between_inclusive(props[0].avg_current, -32768 * 1000, 32767 * 1000);
	zassert_between_inclusive(props[1].cycle_count, 0, 6553500);
	zassert_between_inclusive(props[2].current, -32768 * 1000, 32767 * 1000);
	zassert_between_inclusive(props[3].full_charge_capacity, 0, 32767 * 1000);
	zassert_between_inclusive(props[4].remaining_capacity, 0, 32767 * 1000);
	zassert_between_inclusive(props[5].runtime_to_empty, 0, 65535);
	zassert_between_inclusive(props[6].runtime_to_full, 0, 65535);
	/* Not testing props[7]. This is the manufacturer access and has only status bits */
	zassert_between_inclusive(props[8].relative_state_of_charge, 0, 100);
	zassert_between_inclusive(props[9].temperature, 0, 32767);
	zassert_between_inclusive(props[10].voltage, 0, 32767 * 1000);
	zassert_between_inclusive(props[11].sbs_at_rate, -32768, 32767);
	zassert_between_inclusive(props[12].sbs_at_rate_time_to_empty, 0, 65535);
	zassert_between_inclusive(props[13].chg_voltage, 0, 32767);
	zassert_between_inclusive(props[14].chg_current, 0, 32767);
	/* Not testing props[15]. This property is the status and only has only status bits */
	zassert_between_inclusive(props[16].design_cap, 0, 32767);
#endif
}

ZTEST_SUITE(bq27z746, NULL, bq27z746_setup, NULL, NULL, NULL);