u-boot/test/dm/regmap.c
Andrew Scull 7f58feae3f test: Fix pointer overrun in dm_test_devm_regmap()
This tests calls regmap_read() which takes a uint pointer as an output
parameter. The test was passing a pointer to a u16 which resulted in an
overflow when the output was written. Fix this by following the
regmap_read() API and passing a uint pointer instead.

Signed-off-by: Andrew Scull <ascull@google.com>
Cc: Simon Glass <sjg@chromium.org>
Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>
Cc: Jean-Jacques Hiblot <jjhiblot@ti.com>
Cc: Pratyush Yadav <p.yadav@ti.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
2022-04-29 11:11:36 -04:00

386 lines
9.9 KiB
C

// SPDX-License-Identifier: GPL-2.0+
/*
* Copyright (C) 2015 Google, Inc
*/
#include <common.h>
#include <dm.h>
#include <log.h>
#include <mapmem.h>
#include <regmap.h>
#include <syscon.h>
#include <rand.h>
#include <asm/test.h>
#include <dm/test.h>
#include <dm/devres.h>
#include <linux/err.h>
#include <test/test.h>
#include <test/ut.h>
/* Base test of register maps */
static int dm_test_regmap_base(struct unit_test_state *uts)
{
struct udevice *dev;
struct regmap *map;
ofnode node;
int i;
ut_assertok(uclass_get_device(UCLASS_SYSCON, 0, &dev));
map = syscon_get_regmap(dev);
ut_assertok_ptr(map);
ut_asserteq(1, map->range_count);
ut_asserteq(0x10, map->ranges[0].start);
ut_asserteq(16, map->ranges[0].size);
ut_asserteq(0x10, map_to_sysmem(regmap_get_range(map, 0)));
ut_assertok(uclass_get_device(UCLASS_SYSCON, 1, &dev));
map = syscon_get_regmap(dev);
ut_assertok_ptr(map);
ut_asserteq(4, map->range_count);
ut_asserteq(0x20, map->ranges[0].start);
for (i = 0; i < 4; i++) {
const unsigned long addr = 0x20 + 8 * i;
ut_asserteq(addr, map->ranges[i].start);
ut_asserteq(5 + i, map->ranges[i].size);
ut_asserteq(addr, map_to_sysmem(regmap_get_range(map, i)));
}
/* Check that we can't pretend a different device is a syscon */
ut_assertok(uclass_get_device(UCLASS_I2C, 0, &dev));
map = syscon_get_regmap(dev);
ut_asserteq_ptr(ERR_PTR(-ENOEXEC), map);
/* A different device can be a syscon by using Linux-compat API */
node = ofnode_path("/syscon@2");
ut_assert(ofnode_valid(node));
map = syscon_node_to_regmap(node);
ut_assertok_ptr(map);
ut_asserteq(4, map->range_count);
ut_asserteq(0x40, map->ranges[0].start);
for (i = 0; i < 4; i++) {
const unsigned long addr = 0x40 + 8 * i;
ut_asserteq(addr, map->ranges[i].start);
ut_asserteq(5 + i, map->ranges[i].size);
ut_asserteq(addr, map_to_sysmem(regmap_get_range(map, i)));
}
return 0;
}
DM_TEST(dm_test_regmap_base, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
/* Test we can access a regmap through syscon */
static int dm_test_regmap_syscon(struct unit_test_state *uts)
{
struct regmap *map;
map = syscon_get_regmap_by_driver_data(SYSCON0);
ut_assertok_ptr(map);
ut_asserteq(1, map->range_count);
map = syscon_get_regmap_by_driver_data(SYSCON1);
ut_assertok_ptr(map);
ut_asserteq(4, map->range_count);
map = syscon_get_regmap_by_driver_data(SYSCON_COUNT);
ut_asserteq_ptr(ERR_PTR(-ENODEV), map);
ut_asserteq(0x10, map_to_sysmem(syscon_get_first_range(SYSCON0)));
ut_asserteq(0x20, map_to_sysmem(syscon_get_first_range(SYSCON1)));
ut_asserteq_ptr(ERR_PTR(-ENODEV),
syscon_get_first_range(SYSCON_COUNT));
return 0;
}
DM_TEST(dm_test_regmap_syscon, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
/* Read/Write/Modify test */
static int dm_test_regmap_rw(struct unit_test_state *uts)
{
struct udevice *dev;
struct regmap *map;
uint reg;
sandbox_set_enable_memio(true);
ut_assertok(uclass_get_device(UCLASS_SYSCON, 0, &dev));
map = syscon_get_regmap(dev);
ut_assertok_ptr(map);
ut_assertok(regmap_write(map, 0, 0xcacafafa));
ut_assertok(regmap_write(map, 5, 0x55aa2211));
ut_assertok(regmap_read(map, 0, &reg));
ut_asserteq(0xcacafafa, reg);
ut_assertok(regmap_read(map, 5, &reg));
ut_asserteq(0x55aa2211, reg);
ut_assertok(regmap_read(map, 0, &reg));
ut_asserteq(0xcacafafa, reg);
ut_assertok(regmap_update_bits(map, 0, 0xff00ff00, 0x55aa2211));
ut_assertok(regmap_read(map, 0, &reg));
ut_asserteq(0x55ca22fa, reg);
ut_assertok(regmap_update_bits(map, 5, 0x00ff00ff, 0xcacafada));
ut_assertok(regmap_read(map, 5, &reg));
ut_asserteq(0x55ca22da, reg);
return 0;
}
DM_TEST(dm_test_regmap_rw, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
/* Get/Set test */
static int dm_test_regmap_getset(struct unit_test_state *uts)
{
struct udevice *dev;
struct regmap *map;
uint reg;
struct layout {
u32 val0;
u32 val1;
u32 val2;
u32 val3;
};
sandbox_set_enable_memio(true);
ut_assertok(uclass_get_device(UCLASS_SYSCON, 0, &dev));
map = syscon_get_regmap(dev);
ut_assertok_ptr(map);
regmap_set(map, struct layout, val0, 0xcacafafa);
regmap_set(map, struct layout, val3, 0x55aa2211);
ut_assertok(regmap_get(map, struct layout, val0, &reg));
ut_asserteq(0xcacafafa, reg);
ut_assertok(regmap_get(map, struct layout, val3, &reg));
ut_asserteq(0x55aa2211, reg);
return 0;
}
DM_TEST(dm_test_regmap_getset, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
/* Read polling test */
static int dm_test_regmap_poll(struct unit_test_state *uts)
{
struct udevice *dev;
struct regmap *map;
uint reg;
unsigned long start;
ut_assertok(uclass_get_device(UCLASS_SYSCON, 0, &dev));
map = syscon_get_regmap(dev);
ut_assertok_ptr(map);
start = get_timer(0);
ut_assertok(regmap_write(map, 0, 0x0));
ut_asserteq(-ETIMEDOUT,
regmap_read_poll_timeout_test(map, 0, reg,
(reg == 0xcacafafa),
1, 5 * CONFIG_SYS_HZ,
5 * CONFIG_SYS_HZ));
ut_assert(get_timer(start) > (5 * CONFIG_SYS_HZ));
return 0;
}
DM_TEST(dm_test_regmap_poll, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
struct regmaptest_priv {
struct regmap *cfg_regmap; /* For testing regmap_config options. */
struct regmap *fld_regmap; /* For testing regmap fields. */
struct regmap_field **fields;
};
static const struct reg_field field_cfgs[] = {
{
.reg = 0,
.lsb = 0,
.msb = 6,
},
{
.reg = 2,
.lsb = 4,
.msb = 12,
},
{
.reg = 2,
.lsb = 12,
.msb = 15,
}
};
#define REGMAP_TEST_BUF_START 0
#define REGMAP_TEST_BUF_SZ 5
static int remaptest_probe(struct udevice *dev)
{
struct regmaptest_priv *priv = dev_get_priv(dev);
struct regmap *regmap;
struct regmap_field *field;
struct regmap_config cfg;
int i;
static const int n = ARRAY_SIZE(field_cfgs);
/*
* To exercise all the regmap config options, create a regmap that
* points to a custom memory area instead of the one defined in device
* tree. Use 2-byte elements. To allow directly indexing into the
* elements, use an offset shift of 1. So, accessing offset 1 gets the
* element at index 1 at memory location 2.
*
* REGMAP_TEST_BUF_SZ is the number of elements, so we need to multiply
* it by 2 because r_size expects number of bytes.
*/
cfg.reg_offset_shift = 1;
cfg.r_start = REGMAP_TEST_BUF_START;
cfg.r_size = REGMAP_TEST_BUF_SZ * 2;
cfg.width = REGMAP_SIZE_16;
regmap = devm_regmap_init(dev, NULL, NULL, &cfg);
if (IS_ERR(regmap))
return PTR_ERR(regmap);
priv->cfg_regmap = regmap;
memset(&cfg, 0, sizeof(struct regmap_config));
cfg.width = REGMAP_SIZE_16;
regmap = devm_regmap_init(dev, NULL, NULL, &cfg);
if (IS_ERR(regmap))
return PTR_ERR(regmap);
priv->fld_regmap = regmap;
priv->fields = devm_kzalloc(dev, sizeof(struct regmap_field *) * n,
GFP_KERNEL);
if (!priv->fields)
return -ENOMEM;
for (i = 0 ; i < n; i++) {
field = devm_regmap_field_alloc(dev, priv->fld_regmap,
field_cfgs[i]);
if (IS_ERR(field))
return PTR_ERR(field);
priv->fields[i] = field;
}
return 0;
}
static const struct udevice_id regmaptest_ids[] = {
{ .compatible = "sandbox,regmap_test" },
{ }
};
U_BOOT_DRIVER(regmap_test) = {
.name = "regmaptest_drv",
.of_match = regmaptest_ids,
.id = UCLASS_NOP,
.probe = remaptest_probe,
.priv_auto = sizeof(struct regmaptest_priv),
};
static int dm_test_devm_regmap(struct unit_test_state *uts)
{
int i = 0;
uint val;
u16 pattern[REGMAP_TEST_BUF_SZ];
u16 *buffer;
struct udevice *dev;
struct regmaptest_priv *priv;
sandbox_set_enable_memio(true);
/*
* Map the memory area the regmap should point to so we can make sure
* the writes actually go to that location.
*/
buffer = map_physmem(REGMAP_TEST_BUF_START,
REGMAP_TEST_BUF_SZ * 2, MAP_NOCACHE);
ut_assertok(uclass_get_device_by_name(UCLASS_NOP, "regmap-test_0",
&dev));
priv = dev_get_priv(dev);
for (i = 0; i < REGMAP_TEST_BUF_SZ; i++) {
pattern[i] = i * 0x87654321;
ut_assertok(regmap_write(priv->cfg_regmap, i, pattern[i]));
}
for (i = 0; i < REGMAP_TEST_BUF_SZ; i++) {
ut_assertok(regmap_read(priv->cfg_regmap, i, &val));
ut_asserteq(val, buffer[i]);
ut_asserteq(val, pattern[i]);
}
ut_asserteq(-ERANGE, regmap_write(priv->cfg_regmap, REGMAP_TEST_BUF_SZ,
val));
ut_asserteq(-ERANGE, regmap_read(priv->cfg_regmap, REGMAP_TEST_BUF_SZ,
&val));
ut_asserteq(-ERANGE, regmap_write(priv->cfg_regmap, -1, val));
ut_asserteq(-ERANGE, regmap_read(priv->cfg_regmap, -1, &val));
return 0;
}
DM_TEST(dm_test_devm_regmap, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
static int test_one_field(struct unit_test_state *uts,
struct regmap *regmap,
struct regmap_field *field,
struct reg_field field_cfg)
{
int j;
unsigned int val;
int mask = (1 << (field_cfg.msb - field_cfg.lsb + 1)) - 1;
int shift = field_cfg.lsb;
ut_assertok(regmap_write(regmap, field_cfg.reg, 0));
ut_assertok(regmap_read(regmap, field_cfg.reg, &val));
ut_asserteq(0, val);
for (j = 0; j <= mask; j++) {
ut_assertok(regmap_field_write(field, j));
ut_assertok(regmap_field_read(field, &val));
ut_asserteq(j, val);
ut_assertok(regmap_read(regmap, field_cfg.reg, &val));
ut_asserteq(j << shift, val);
}
ut_assertok(regmap_field_write(field, mask + 1));
ut_assertok(regmap_read(regmap, field_cfg.reg, &val));
ut_asserteq(0, val);
ut_assertok(regmap_field_write(field, 0xFFFF));
ut_assertok(regmap_read(regmap, field_cfg.reg, &val));
ut_asserteq(mask << shift, val);
ut_assertok(regmap_write(regmap, field_cfg.reg, 0xFFFF));
ut_assertok(regmap_field_write(field, 0));
ut_assertok(regmap_read(regmap, field_cfg.reg, &val));
ut_asserteq(0xFFFF & ~(mask << shift), val);
return 0;
}
static int dm_test_devm_regmap_field(struct unit_test_state *uts)
{
int i, rc;
struct udevice *dev;
struct regmaptest_priv *priv;
ut_assertok(uclass_get_device_by_name(UCLASS_NOP, "regmap-test_0",
&dev));
priv = dev_get_priv(dev);
sandbox_set_enable_memio(true);
for (i = 0 ; i < ARRAY_SIZE(field_cfgs); i++) {
rc = test_one_field(uts, priv->fld_regmap, priv->fields[i],
field_cfgs[i]);
if (rc)
break;
}
return 0;
}
DM_TEST(dm_test_devm_regmap_field, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);