Unverified Commit 7b7982f1 authored by Richard Fitzgerald's avatar Richard Fitzgerald Committed by Mark Brown
Browse files

regmap: kunit: Create a struct device for the regmap 



Use kunit_device_register() to create a real struct device for the
regmap instead of leaving it at NULL.

The main reason for this is that it allows context data to be passed
into the readable_reg/writable_reg/volatile_reg functions by attaching
it to the struct device with dev_set_drvdata().

The gen_regmap() and gen_raw_regmap() functions are updated to take a
struct kunit * argument.

A new struct regmap_test_priv has been created to hold the struct device
created by kunit_device_register(). This allows the struct to be
extended in the future to hold more private data for the test suite.

Signed-off-by: default avatarRichard Fitzgerald <rf@opensource.cirrus.com>
Link: https://msgid.link/r/20240408144600.230848-3-rf@opensource.cirrus.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 866f7021

drivers/base/regmap/internal.h

+8 −6
Original line number Diff line number Diff line
@@ -326,20 +326,22 @@ struct regmap_ram_data { 
 * Create a test register map with data stored in RAM, not intended

 * for practical use.

 */

struct regmap *__regmap_init_ram(const struct regmap_config *config,

struct regmap *__regmap_init_ram(struct device *dev,

				 const struct regmap_config *config,

				 struct regmap_ram_data *data,

				 struct lock_class_key *lock_key,

				 const char *lock_name);



#define regmap_init_ram(config, data)					\

	__regmap_lockdep_wrapper(__regmap_init_ram, #config, config, data)

#define regmap_init_ram(dev, config, data)					\

	__regmap_lockdep_wrapper(__regmap_init_ram, #dev, dev, config, data)



struct regmap *__regmap_init_raw_ram(const struct regmap_config *config,

struct regmap *__regmap_init_raw_ram(struct device *dev,

				     const struct regmap_config *config,

				     struct regmap_ram_data *data,

				     struct lock_class_key *lock_key,

				     const char *lock_name);



#define regmap_init_raw_ram(config, data)				\

	__regmap_lockdep_wrapper(__regmap_init_raw_ram, #config, config, data)

#define regmap_init_raw_ram(dev, config, data)				\

	__regmap_lockdep_wrapper(__regmap_init_raw_ram, #dev, dev, config, data)



#endif

drivers/base/regmap/regmap-kunit.c

+73 −32
Original line number Diff line number Diff line
@@ -4,11 +4,16 @@ 
//

// Copyright 2023 Arm Ltd



#include <kunit/device.h>

#include <kunit/test.h>

#include "internal.h"



#define BLOCK_TEST_SIZE 12



struct regmap_test_priv {

	struct device *dev;

};



static void get_changed_bytes(void *orig, void *new, size_t size)

{

	char *o = orig;
@@ -66,9 +71,11 @@ static const struct regcache_types sparse_cache_types_list[] = { 


KUNIT_ARRAY_PARAM(sparse_cache_types, sparse_cache_types_list, case_to_desc);



static struct regmap *gen_regmap(struct regmap_config *config,

static struct regmap *gen_regmap(struct kunit *test,

				 struct regmap_config *config,

				 struct regmap_ram_data **data)

{

	struct regmap_test_priv *priv = test->priv;

	unsigned int *buf;

	struct regmap *ret;

	size_t size = (config->max_register + 1) * sizeof(unsigned int);
@@ -103,7 +110,7 @@ static struct regmap *gen_regmap(struct regmap_config *config, 
		}

	}



	ret = regmap_init_ram(config, *data);

	ret = regmap_init_ram(priv->dev, config, *data);

	if (IS_ERR(ret)) {

		kfree(buf);

		kfree(*data);
@@ -128,7 +135,7 @@ static void basic_read_write(struct kunit *test) 
	config = test_regmap_config;

	config.cache_type = t->type;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -158,7 +165,7 @@ static void bulk_write(struct kunit *test) 
	config = test_regmap_config;

	config.cache_type = t->type;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -195,7 +202,7 @@ static void bulk_read(struct kunit *test) 
	config = test_regmap_config;

	config.cache_type = t->type;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -230,7 +237,7 @@ static void write_readonly(struct kunit *test) 
	config.num_reg_defaults = BLOCK_TEST_SIZE;

	config.writeable_reg = reg_5_false;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -264,7 +271,7 @@ static void read_writeonly(struct kunit *test) 
	config.cache_type = t->type;

	config.readable_reg = reg_5_false;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -304,7 +311,7 @@ static void reg_defaults(struct kunit *test) 
	config.cache_type = t->type;

	config.num_reg_defaults = BLOCK_TEST_SIZE;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -332,7 +339,7 @@ static void reg_defaults_read_dev(struct kunit *test) 
	config.cache_type = t->type;

	config.num_reg_defaults_raw = BLOCK_TEST_SIZE;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -368,7 +375,7 @@ static void register_patch(struct kunit *test) 
	config.cache_type = t->type;

	config.num_reg_defaults = BLOCK_TEST_SIZE;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -419,7 +426,7 @@ static void stride(struct kunit *test) 
	config.reg_stride = 2;

	config.num_reg_defaults = BLOCK_TEST_SIZE / 2;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -495,7 +502,7 @@ static void basic_ranges(struct kunit *test) 
	config.num_ranges = 1;

	config.max_register = test_range.range_max;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -565,7 +572,7 @@ static void stress_insert(struct kunit *test) 
	config.cache_type = t->type;

	config.max_register = 300;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -616,7 +623,7 @@ static void cache_bypass(struct kunit *test) 
	config = test_regmap_config;

	config.cache_type = t->type;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -655,7 +662,7 @@ static void cache_sync(struct kunit *test) 
	config = test_regmap_config;

	config.cache_type = t->type;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -694,7 +701,7 @@ static void cache_sync_defaults(struct kunit *test) 
	config.cache_type = t->type;

	config.num_reg_defaults = BLOCK_TEST_SIZE;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -730,7 +737,7 @@ static void cache_sync_readonly(struct kunit *test) 
	config.cache_type = t->type;

	config.writeable_reg = reg_5_false;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -773,7 +780,7 @@ static void cache_sync_patch(struct kunit *test) 
	config.cache_type = t->type;

	config.num_reg_defaults = BLOCK_TEST_SIZE;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -832,7 +839,7 @@ static void cache_drop(struct kunit *test) 
	config.cache_type = t->type;

	config.num_reg_defaults = BLOCK_TEST_SIZE;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -873,7 +880,7 @@ static void cache_present(struct kunit *test) 
	config = test_regmap_config;

	config.cache_type = t->type;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -917,7 +924,7 @@ static void cache_range_window_reg(struct kunit *test) 
	config.num_ranges = 1;

	config.max_register = test_range.range_max;



	map = gen_regmap(&config, &data);

	map = gen_regmap(test, &config, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -997,10 +1004,12 @@ static const struct regmap_config raw_regmap_config = { 
	.val_bits = 16,

};



static struct regmap *gen_raw_regmap(struct regmap_config *config,

static struct regmap *gen_raw_regmap(struct kunit *test,

				     struct regmap_config *config,

				     struct raw_test_types *test_type,

				     struct regmap_ram_data **data)

{

	struct regmap_test_priv *priv = test->priv;

	u16 *buf;

	struct regmap *ret;

	size_t size = (config->max_register + 1) * config->reg_bits / 8;
@@ -1052,7 +1061,7 @@ static struct regmap *gen_raw_regmap(struct regmap_config *config, 
	if (config->cache_type == REGCACHE_NONE)

		config->num_reg_defaults = 0;



	ret = regmap_init_raw_ram(config, *data);

	ret = regmap_init_raw_ram(priv->dev, config, *data);

	if (IS_ERR(ret)) {

		kfree(buf);

		kfree(*data);
@@ -1072,7 +1081,7 @@ static void raw_read_defaults_single(struct kunit *test) 


	config = raw_regmap_config;



	map = gen_raw_regmap(&config, t, &data);

	map = gen_raw_regmap(test, &config, t, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -1099,7 +1108,7 @@ static void raw_read_defaults(struct kunit *test) 


	config = raw_regmap_config;



	map = gen_raw_regmap(&config, t, &data);

	map = gen_raw_regmap(test, &config, t, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -1136,7 +1145,7 @@ static void raw_write_read_single(struct kunit *test) 


	config = raw_regmap_config;



	map = gen_raw_regmap(&config, t, &data);

	map = gen_raw_regmap(test, &config, t, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -1164,7 +1173,7 @@ static void raw_write(struct kunit *test) 


	config = raw_regmap_config;



	map = gen_raw_regmap(&config, t, &data);

	map = gen_raw_regmap(test, &config, t, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -1228,7 +1237,7 @@ static void raw_noinc_write(struct kunit *test) 
	config.writeable_noinc_reg = reg_zero;

	config.readable_noinc_reg = reg_zero;



	map = gen_raw_regmap(&config, t, &data);

	map = gen_raw_regmap(test, &config, t, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -1276,7 +1285,7 @@ static void raw_sync(struct kunit *test) 


	config = raw_regmap_config;



	map = gen_raw_regmap(&config, t, &data);

	map = gen_raw_regmap(test, &config, t, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -1356,7 +1365,7 @@ static void raw_ranges(struct kunit *test) 
	config.num_ranges = 1;

	config.max_register = test_range.range_max;



	map = gen_raw_regmap(&config, t, &data);

	map = gen_raw_regmap(test, &config, t, &data);

	KUNIT_ASSERT_FALSE(test, IS_ERR(map));

	if (IS_ERR(map))

		return;
@@ -1437,8 +1446,40 @@ static struct kunit_case regmap_test_cases[] = { 
	{}

};



static int regmap_test_init(struct kunit *test)

{

	struct regmap_test_priv *priv;

	struct device *dev;



	priv = kunit_kzalloc(test, sizeof(*priv), GFP_KERNEL);

	if (!priv)

		return -ENOMEM;



	test->priv = priv;



	dev = kunit_device_register(test, "regmap_test");

	priv->dev = get_device(dev);

	if (!priv->dev)

		return -ENODEV;



	dev_set_drvdata(dev, test);



	return 0;

}



static void regmap_test_exit(struct kunit *test)

{

	struct regmap_test_priv *priv = test->priv;



	/* Destroy the dummy struct device */

	if (priv && priv->dev)

		put_device(priv->dev);

}



static struct kunit_suite regmap_test_suite = {

	.name = "regmap",

	.init = regmap_test_init,

	.exit = regmap_test_exit,

	.test_cases = regmap_test_cases,

};

kunit_test_suite(regmap_test_suite);

drivers/base/regmap/regmap-ram.c

+3 −2
Original line number Diff line number Diff line
@@ -53,7 +53,8 @@ static const struct regmap_bus regmap_ram = { 
	.free_context = regmap_ram_free_context,

};



struct regmap *__regmap_init_ram(const struct regmap_config *config,

struct regmap *__regmap_init_ram(struct device *dev,

				 const struct regmap_config *config,

				 struct regmap_ram_data *data,

				 struct lock_class_key *lock_key,

				 const char *lock_name)
@@ -75,7 +76,7 @@ struct regmap *__regmap_init_ram(const struct regmap_config *config, 
	if (!data->written)

		return ERR_PTR(-ENOMEM);



	map = __regmap_init(NULL, &regmap_ram, data, config,

	map = __regmap_init(dev, &regmap_ram, data, config,

			    lock_key, lock_name);



	return map;

drivers/base/regmap/regmap-raw-ram.c

+3 −2
Original line number Diff line number Diff line
@@ -107,7 +107,8 @@ static const struct regmap_bus regmap_raw_ram = { 
	.free_context = regmap_raw_ram_free_context,

};



struct regmap *__regmap_init_raw_ram(const struct regmap_config *config,

struct regmap *__regmap_init_raw_ram(struct device *dev,

				     const struct regmap_config *config,

				     struct regmap_ram_data *data,

				     struct lock_class_key *lock_key,

				     const char *lock_name)
@@ -134,7 +135,7 @@ struct regmap *__regmap_init_raw_ram(const struct regmap_config *config, 


	data->reg_endian = config->reg_format_endian;



	map = __regmap_init(NULL, &regmap_raw_ram, data, config,

	map = __regmap_init(dev, &regmap_raw_ram, data, config,

			    lock_key, lock_name);



	return map;