linux/sound/soc/soc-card-test.c

// SPDX-License-Identifier: GPL-2.0-only
// Copyright (C) 2024 Cirrus Logic, Inc. and
//                    Cirrus Logic International Semiconductor Ltd.

#include <kunit/device.h>
#include <kunit/test.h>
#include <linux/module.h>
#include <sound/control.h>
#include <sound/soc.h>
#include <sound/soc-card.h>

struct soc_card_test_priv {
	struct device *card_dev;
	struct snd_soc_card *card;
};

static const struct snd_kcontrol_new test_card_controls[] = {
	SOC_SINGLE("Fee", SND_SOC_NOPM, 0, 1, 0),
	SOC_SINGLE("Fi", SND_SOC_NOPM, 1, 1, 0),
	SOC_SINGLE("Fo", SND_SOC_NOPM, 2, 1, 0),
	SOC_SINGLE("Fum", SND_SOC_NOPM, 3, 1, 0),
	SOC_SINGLE("Left Fee", SND_SOC_NOPM, 4, 1, 0),
	SOC_SINGLE("Right Fee", SND_SOC_NOPM, 5, 1, 0),
	SOC_SINGLE("Left Fi", SND_SOC_NOPM, 6, 1, 0),
	SOC_SINGLE("Right Fi", SND_SOC_NOPM, 7, 1, 0),
	SOC_SINGLE("Left Fo", SND_SOC_NOPM, 8, 1, 0),
	SOC_SINGLE("Right Fo", SND_SOC_NOPM, 9, 1, 0),
	SOC_SINGLE("Left Fum", SND_SOC_NOPM, 10, 1, 0),
	SOC_SINGLE("Right Fum", SND_SOC_NOPM, 11, 1, 0),
};

static void test_snd_soc_card_get_kcontrol(struct kunit *test)
{
	struct soc_card_test_priv *priv = test->priv;
	struct snd_soc_card *card = priv->card;
	struct snd_kcontrol *kc;
	struct soc_mixer_control *mc;
	int i, ret;

	ret = snd_soc_add_card_controls(card, test_card_controls, ARRAY_SIZE(test_card_controls));
	KUNIT_ASSERT_EQ(test, ret, 0);

	/* Look up every control */
	for (i = 0; i < ARRAY_SIZE(test_card_controls); ++i) {
		kc = snd_soc_card_get_kcontrol(card, test_card_controls[i].name);
		KUNIT_EXPECT_NOT_ERR_OR_NULL_MSG(test, kc, "Failed to find '%s'\n",
						 test_card_controls[i].name);
		if (!kc)
			continue;

		/* Test that it is the correct control */
		mc = (struct soc_mixer_control *)kc->private_value;
		KUNIT_EXPECT_EQ_MSG(test, mc->shift, i, "For '%s'\n", test_card_controls[i].name);
	}

	/* Test some names that should not be found */
	kc = snd_soc_card_get_kcontrol(card, "None");
	KUNIT_EXPECT_NULL(test, kc);

	kc = snd_soc_card_get_kcontrol(card, "Left None");
	KUNIT_EXPECT_NULL(test, kc);

	kc = snd_soc_card_get_kcontrol(card, "Left");
	KUNIT_EXPECT_NULL(test, kc);

	kc = snd_soc_card_get_kcontrol(card, NULL);
	KUNIT_EXPECT_NULL(test, kc);
}

static void test_snd_soc_card_get_kcontrol_locked(struct kunit *test)
{
	struct soc_card_test_priv *priv = test->priv;
	struct snd_soc_card *card = priv->card;
	struct snd_kcontrol *kc, *kcw;
	struct soc_mixer_control *mc;
	int i, ret;

	ret = snd_soc_add_card_controls(card, test_card_controls, ARRAY_SIZE(test_card_controls));
	KUNIT_ASSERT_EQ(test, ret, 0);

	/* Look up every control */
	for (i = 0; i < ARRAY_SIZE(test_card_controls); ++i) {
		down_read(&card->snd_card->controls_rwsem);
		kc = snd_soc_card_get_kcontrol_locked(card, test_card_controls[i].name);
		up_read(&card->snd_card->controls_rwsem);
		KUNIT_EXPECT_NOT_ERR_OR_NULL_MSG(test, kc, "Failed to find '%s'\n",
						 test_card_controls[i].name);
		if (!kc)
			continue;

		/* Test that it is the correct control */
		mc = (struct soc_mixer_control *)kc->private_value;
		KUNIT_EXPECT_EQ_MSG(test, mc->shift, i, "For '%s'\n", test_card_controls[i].name);

		down_write(&card->snd_card->controls_rwsem);
		kcw = snd_soc_card_get_kcontrol_locked(card, test_card_controls[i].name);
		up_write(&card->snd_card->controls_rwsem);
		KUNIT_EXPECT_NOT_ERR_OR_NULL_MSG(test, kcw, "Failed to find '%s'\n",
						 test_card_controls[i].name);

		KUNIT_EXPECT_PTR_EQ(test, kc, kcw);
	}

	/* Test some names that should not be found */
	down_read(&card->snd_card->controls_rwsem);
	kc = snd_soc_card_get_kcontrol_locked(card, "None");
	up_read(&card->snd_card->controls_rwsem);
	KUNIT_EXPECT_NULL(test, kc);

	down_read(&card->snd_card->controls_rwsem);
	kc = snd_soc_card_get_kcontrol_locked(card, "Left None");
	up_read(&card->snd_card->controls_rwsem);
	KUNIT_EXPECT_NULL(test, kc);

	down_read(&card->snd_card->controls_rwsem);
	kc = snd_soc_card_get_kcontrol_locked(card, "Left");
	up_read(&card->snd_card->controls_rwsem);
	KUNIT_EXPECT_NULL(test, kc);

	down_read(&card->snd_card->controls_rwsem);
	kc = snd_soc_card_get_kcontrol_locked(card, NULL);
	up_read(&card->snd_card->controls_rwsem);
	KUNIT_EXPECT_NULL(test, kc);
}

static int soc_card_test_case_init(struct kunit *test)
{
	struct soc_card_test_priv *priv;
	int ret;

	priv = kunit_kzalloc(test, sizeof(*priv), GFP_KERNEL);
	if (!priv)
		return -ENOMEM;

	test->priv = priv;

	priv->card = kunit_kzalloc(test, sizeof(*priv->card), GFP_KERNEL);
	if (!priv->card)
		return -ENOMEM;

	priv->card_dev = kunit_device_register(test, "sound-soc-card-test");
	priv->card_dev = get_device(priv->card_dev);
	if (!priv->card_dev)
		return -ENODEV;

	priv->card->name = "soc-card-test";
	priv->card->dev = priv->card_dev;
	priv->card->owner = THIS_MODULE;

	ret = snd_soc_register_card(priv->card);
	if (ret) {
		put_device(priv->card_dev);
		return ret;
	}

	return 0;
}

static void soc_card_test_case_exit(struct kunit *test)
{
	struct soc_card_test_priv *priv = test->priv;

	if (priv->card)
		snd_soc_unregister_card(priv->card);

	if (priv->card_dev)
		put_device(priv->card_dev);
}

static struct kunit_case soc_card_test_cases[] = {
	KUNIT_CASE(test_snd_soc_card_get_kcontrol),
	KUNIT_CASE(test_snd_soc_card_get_kcontrol_locked),
	{}
};

static struct kunit_suite soc_card_test_suite = {
	.name = "soc-card",
	.test_cases = soc_card_test_cases,
	.init = soc_card_test_case_init,
	.exit = soc_card_test_case_exit,
};

kunit_test_suites(&soc_card_test_suite);

MODULE_DESCRIPTION("ASoC soc-card KUnit test");
MODULE_LICENSE("GPL");