18c2ecf20Sopenharmony_ci// SPDX-License-Identifier: GPL-2.0-or-later
28c2ecf20Sopenharmony_ci/*
38c2ecf20Sopenharmony_ci * Load Analog Devices SigmaStudio firmware files
48c2ecf20Sopenharmony_ci *
58c2ecf20Sopenharmony_ci * Copyright 2009-2014 Analog Devices Inc.
68c2ecf20Sopenharmony_ci */
78c2ecf20Sopenharmony_ci
88c2ecf20Sopenharmony_ci#include <linux/crc32.h>
98c2ecf20Sopenharmony_ci#include <linux/firmware.h>
108c2ecf20Sopenharmony_ci#include <linux/kernel.h>
118c2ecf20Sopenharmony_ci#include <linux/i2c.h>
128c2ecf20Sopenharmony_ci#include <linux/regmap.h>
138c2ecf20Sopenharmony_ci#include <linux/module.h>
148c2ecf20Sopenharmony_ci#include <linux/slab.h>
158c2ecf20Sopenharmony_ci
168c2ecf20Sopenharmony_ci#include <sound/control.h>
178c2ecf20Sopenharmony_ci#include <sound/soc.h>
188c2ecf20Sopenharmony_ci
198c2ecf20Sopenharmony_ci#include "sigmadsp.h"
208c2ecf20Sopenharmony_ci
218c2ecf20Sopenharmony_ci#define SIGMA_MAGIC "ADISIGM"
228c2ecf20Sopenharmony_ci
238c2ecf20Sopenharmony_ci#define SIGMA_FW_CHUNK_TYPE_DATA 0
248c2ecf20Sopenharmony_ci#define SIGMA_FW_CHUNK_TYPE_CONTROL 1
258c2ecf20Sopenharmony_ci#define SIGMA_FW_CHUNK_TYPE_SAMPLERATES 2
268c2ecf20Sopenharmony_ci
278c2ecf20Sopenharmony_cistruct sigmadsp_control {
288c2ecf20Sopenharmony_ci	struct list_head head;
298c2ecf20Sopenharmony_ci	uint32_t samplerates;
308c2ecf20Sopenharmony_ci	unsigned int addr;
318c2ecf20Sopenharmony_ci	unsigned int num_bytes;
328c2ecf20Sopenharmony_ci	const char *name;
338c2ecf20Sopenharmony_ci	struct snd_kcontrol *kcontrol;
348c2ecf20Sopenharmony_ci	bool cached;
358c2ecf20Sopenharmony_ci	uint8_t cache[];
368c2ecf20Sopenharmony_ci};
378c2ecf20Sopenharmony_ci
388c2ecf20Sopenharmony_cistruct sigmadsp_data {
398c2ecf20Sopenharmony_ci	struct list_head head;
408c2ecf20Sopenharmony_ci	uint32_t samplerates;
418c2ecf20Sopenharmony_ci	unsigned int addr;
428c2ecf20Sopenharmony_ci	unsigned int length;
438c2ecf20Sopenharmony_ci	uint8_t data[];
448c2ecf20Sopenharmony_ci};
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_cistruct sigma_fw_chunk {
478c2ecf20Sopenharmony_ci	__le32 length;
488c2ecf20Sopenharmony_ci	__le32 tag;
498c2ecf20Sopenharmony_ci	__le32 samplerates;
508c2ecf20Sopenharmony_ci} __packed;
518c2ecf20Sopenharmony_ci
528c2ecf20Sopenharmony_cistruct sigma_fw_chunk_data {
538c2ecf20Sopenharmony_ci	struct sigma_fw_chunk chunk;
548c2ecf20Sopenharmony_ci	__le16 addr;
558c2ecf20Sopenharmony_ci	uint8_t data[];
568c2ecf20Sopenharmony_ci} __packed;
578c2ecf20Sopenharmony_ci
588c2ecf20Sopenharmony_cistruct sigma_fw_chunk_control {
598c2ecf20Sopenharmony_ci	struct sigma_fw_chunk chunk;
608c2ecf20Sopenharmony_ci	__le16 type;
618c2ecf20Sopenharmony_ci	__le16 addr;
628c2ecf20Sopenharmony_ci	__le16 num_bytes;
638c2ecf20Sopenharmony_ci	const char name[];
648c2ecf20Sopenharmony_ci} __packed;
658c2ecf20Sopenharmony_ci
668c2ecf20Sopenharmony_cistruct sigma_fw_chunk_samplerate {
678c2ecf20Sopenharmony_ci	struct sigma_fw_chunk chunk;
688c2ecf20Sopenharmony_ci	__le32 samplerates[];
698c2ecf20Sopenharmony_ci} __packed;
708c2ecf20Sopenharmony_ci
718c2ecf20Sopenharmony_cistruct sigma_firmware_header {
728c2ecf20Sopenharmony_ci	unsigned char magic[7];
738c2ecf20Sopenharmony_ci	u8 version;
748c2ecf20Sopenharmony_ci	__le32 crc;
758c2ecf20Sopenharmony_ci} __packed;
768c2ecf20Sopenharmony_ci
778c2ecf20Sopenharmony_cienum {
788c2ecf20Sopenharmony_ci	SIGMA_ACTION_WRITEXBYTES = 0,
798c2ecf20Sopenharmony_ci	SIGMA_ACTION_WRITESINGLE,
808c2ecf20Sopenharmony_ci	SIGMA_ACTION_WRITESAFELOAD,
818c2ecf20Sopenharmony_ci	SIGMA_ACTION_END,
828c2ecf20Sopenharmony_ci};
838c2ecf20Sopenharmony_ci
848c2ecf20Sopenharmony_cistruct sigma_action {
858c2ecf20Sopenharmony_ci	u8 instr;
868c2ecf20Sopenharmony_ci	u8 len_hi;
878c2ecf20Sopenharmony_ci	__le16 len;
888c2ecf20Sopenharmony_ci	__be16 addr;
898c2ecf20Sopenharmony_ci	unsigned char payload[];
908c2ecf20Sopenharmony_ci} __packed;
918c2ecf20Sopenharmony_ci
928c2ecf20Sopenharmony_cistatic int sigmadsp_write(struct sigmadsp *sigmadsp, unsigned int addr,
938c2ecf20Sopenharmony_ci	const uint8_t data[], size_t len)
948c2ecf20Sopenharmony_ci{
958c2ecf20Sopenharmony_ci	return sigmadsp->write(sigmadsp->control_data, addr, data, len);
968c2ecf20Sopenharmony_ci}
978c2ecf20Sopenharmony_ci
988c2ecf20Sopenharmony_cistatic int sigmadsp_read(struct sigmadsp *sigmadsp, unsigned int addr,
998c2ecf20Sopenharmony_ci	uint8_t data[], size_t len)
1008c2ecf20Sopenharmony_ci{
1018c2ecf20Sopenharmony_ci	return sigmadsp->read(sigmadsp->control_data, addr, data, len);
1028c2ecf20Sopenharmony_ci}
1038c2ecf20Sopenharmony_ci
1048c2ecf20Sopenharmony_cistatic int sigmadsp_ctrl_info(struct snd_kcontrol *kcontrol,
1058c2ecf20Sopenharmony_ci	struct snd_ctl_elem_info *info)
1068c2ecf20Sopenharmony_ci{
1078c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl = (void *)kcontrol->private_value;
1088c2ecf20Sopenharmony_ci
1098c2ecf20Sopenharmony_ci	info->type = SNDRV_CTL_ELEM_TYPE_BYTES;
1108c2ecf20Sopenharmony_ci	info->count = ctrl->num_bytes;
1118c2ecf20Sopenharmony_ci
1128c2ecf20Sopenharmony_ci	return 0;
1138c2ecf20Sopenharmony_ci}
1148c2ecf20Sopenharmony_ci
1158c2ecf20Sopenharmony_cistatic int sigmadsp_ctrl_write(struct sigmadsp *sigmadsp,
1168c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl, void *data)
1178c2ecf20Sopenharmony_ci{
1188c2ecf20Sopenharmony_ci	/* safeload loads up to 20 bytes in a atomic operation */
1198c2ecf20Sopenharmony_ci	if (ctrl->num_bytes <= 20 && sigmadsp->ops && sigmadsp->ops->safeload)
1208c2ecf20Sopenharmony_ci		return sigmadsp->ops->safeload(sigmadsp, ctrl->addr, data,
1218c2ecf20Sopenharmony_ci			ctrl->num_bytes);
1228c2ecf20Sopenharmony_ci	else
1238c2ecf20Sopenharmony_ci		return sigmadsp_write(sigmadsp, ctrl->addr, data,
1248c2ecf20Sopenharmony_ci			ctrl->num_bytes);
1258c2ecf20Sopenharmony_ci}
1268c2ecf20Sopenharmony_ci
1278c2ecf20Sopenharmony_cistatic int sigmadsp_ctrl_put(struct snd_kcontrol *kcontrol,
1288c2ecf20Sopenharmony_ci	struct snd_ctl_elem_value *ucontrol)
1298c2ecf20Sopenharmony_ci{
1308c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl = (void *)kcontrol->private_value;
1318c2ecf20Sopenharmony_ci	struct sigmadsp *sigmadsp = snd_kcontrol_chip(kcontrol);
1328c2ecf20Sopenharmony_ci	uint8_t *data;
1338c2ecf20Sopenharmony_ci	int ret = 0;
1348c2ecf20Sopenharmony_ci
1358c2ecf20Sopenharmony_ci	mutex_lock(&sigmadsp->lock);
1368c2ecf20Sopenharmony_ci
1378c2ecf20Sopenharmony_ci	data = ucontrol->value.bytes.data;
1388c2ecf20Sopenharmony_ci
1398c2ecf20Sopenharmony_ci	if (!(kcontrol->vd[0].access & SNDRV_CTL_ELEM_ACCESS_INACTIVE))
1408c2ecf20Sopenharmony_ci		ret = sigmadsp_ctrl_write(sigmadsp, ctrl, data);
1418c2ecf20Sopenharmony_ci
1428c2ecf20Sopenharmony_ci	if (ret == 0) {
1438c2ecf20Sopenharmony_ci		memcpy(ctrl->cache, data, ctrl->num_bytes);
1448c2ecf20Sopenharmony_ci		ctrl->cached = true;
1458c2ecf20Sopenharmony_ci	}
1468c2ecf20Sopenharmony_ci
1478c2ecf20Sopenharmony_ci	mutex_unlock(&sigmadsp->lock);
1488c2ecf20Sopenharmony_ci
1498c2ecf20Sopenharmony_ci	return ret;
1508c2ecf20Sopenharmony_ci}
1518c2ecf20Sopenharmony_ci
1528c2ecf20Sopenharmony_cistatic int sigmadsp_ctrl_get(struct snd_kcontrol *kcontrol,
1538c2ecf20Sopenharmony_ci	struct snd_ctl_elem_value *ucontrol)
1548c2ecf20Sopenharmony_ci{
1558c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl = (void *)kcontrol->private_value;
1568c2ecf20Sopenharmony_ci	struct sigmadsp *sigmadsp = snd_kcontrol_chip(kcontrol);
1578c2ecf20Sopenharmony_ci	int ret = 0;
1588c2ecf20Sopenharmony_ci
1598c2ecf20Sopenharmony_ci	mutex_lock(&sigmadsp->lock);
1608c2ecf20Sopenharmony_ci
1618c2ecf20Sopenharmony_ci	if (!ctrl->cached) {
1628c2ecf20Sopenharmony_ci		ret = sigmadsp_read(sigmadsp, ctrl->addr, ctrl->cache,
1638c2ecf20Sopenharmony_ci			ctrl->num_bytes);
1648c2ecf20Sopenharmony_ci	}
1658c2ecf20Sopenharmony_ci
1668c2ecf20Sopenharmony_ci	if (ret == 0) {
1678c2ecf20Sopenharmony_ci		ctrl->cached = true;
1688c2ecf20Sopenharmony_ci		memcpy(ucontrol->value.bytes.data, ctrl->cache,
1698c2ecf20Sopenharmony_ci			ctrl->num_bytes);
1708c2ecf20Sopenharmony_ci	}
1718c2ecf20Sopenharmony_ci
1728c2ecf20Sopenharmony_ci	mutex_unlock(&sigmadsp->lock);
1738c2ecf20Sopenharmony_ci
1748c2ecf20Sopenharmony_ci	return ret;
1758c2ecf20Sopenharmony_ci}
1768c2ecf20Sopenharmony_ci
1778c2ecf20Sopenharmony_cistatic void sigmadsp_control_free(struct snd_kcontrol *kcontrol)
1788c2ecf20Sopenharmony_ci{
1798c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl = (void *)kcontrol->private_value;
1808c2ecf20Sopenharmony_ci
1818c2ecf20Sopenharmony_ci	ctrl->kcontrol = NULL;
1828c2ecf20Sopenharmony_ci}
1838c2ecf20Sopenharmony_ci
1848c2ecf20Sopenharmony_cistatic bool sigma_fw_validate_control_name(const char *name, unsigned int len)
1858c2ecf20Sopenharmony_ci{
1868c2ecf20Sopenharmony_ci	unsigned int i;
1878c2ecf20Sopenharmony_ci
1888c2ecf20Sopenharmony_ci	for (i = 0; i < len; i++) {
1898c2ecf20Sopenharmony_ci		/* Normal ASCII characters are valid */
1908c2ecf20Sopenharmony_ci		if (name[i] < ' ' || name[i] > '~')
1918c2ecf20Sopenharmony_ci			return false;
1928c2ecf20Sopenharmony_ci	}
1938c2ecf20Sopenharmony_ci
1948c2ecf20Sopenharmony_ci	return true;
1958c2ecf20Sopenharmony_ci}
1968c2ecf20Sopenharmony_ci
1978c2ecf20Sopenharmony_cistatic int sigma_fw_load_control(struct sigmadsp *sigmadsp,
1988c2ecf20Sopenharmony_ci	const struct sigma_fw_chunk *chunk, unsigned int length)
1998c2ecf20Sopenharmony_ci{
2008c2ecf20Sopenharmony_ci	const struct sigma_fw_chunk_control *ctrl_chunk;
2018c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl;
2028c2ecf20Sopenharmony_ci	unsigned int num_bytes;
2038c2ecf20Sopenharmony_ci	size_t name_len;
2048c2ecf20Sopenharmony_ci	char *name;
2058c2ecf20Sopenharmony_ci	int ret;
2068c2ecf20Sopenharmony_ci
2078c2ecf20Sopenharmony_ci	if (length <= sizeof(*ctrl_chunk))
2088c2ecf20Sopenharmony_ci		return -EINVAL;
2098c2ecf20Sopenharmony_ci
2108c2ecf20Sopenharmony_ci	ctrl_chunk = (const struct sigma_fw_chunk_control *)chunk;
2118c2ecf20Sopenharmony_ci
2128c2ecf20Sopenharmony_ci	name_len = length - sizeof(*ctrl_chunk);
2138c2ecf20Sopenharmony_ci	if (name_len >= SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2148c2ecf20Sopenharmony_ci		name_len = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - 1;
2158c2ecf20Sopenharmony_ci
2168c2ecf20Sopenharmony_ci	/* Make sure there are no non-displayable characaters in the string */
2178c2ecf20Sopenharmony_ci	if (!sigma_fw_validate_control_name(ctrl_chunk->name, name_len))
2188c2ecf20Sopenharmony_ci		return -EINVAL;
2198c2ecf20Sopenharmony_ci
2208c2ecf20Sopenharmony_ci	num_bytes = le16_to_cpu(ctrl_chunk->num_bytes);
2218c2ecf20Sopenharmony_ci	ctrl = kzalloc(sizeof(*ctrl) + num_bytes, GFP_KERNEL);
2228c2ecf20Sopenharmony_ci	if (!ctrl)
2238c2ecf20Sopenharmony_ci		return -ENOMEM;
2248c2ecf20Sopenharmony_ci
2258c2ecf20Sopenharmony_ci	name = kzalloc(name_len + 1, GFP_KERNEL);
2268c2ecf20Sopenharmony_ci	if (!name) {
2278c2ecf20Sopenharmony_ci		ret = -ENOMEM;
2288c2ecf20Sopenharmony_ci		goto err_free_ctrl;
2298c2ecf20Sopenharmony_ci	}
2308c2ecf20Sopenharmony_ci	memcpy(name, ctrl_chunk->name, name_len);
2318c2ecf20Sopenharmony_ci	name[name_len] = '\0';
2328c2ecf20Sopenharmony_ci	ctrl->name = name;
2338c2ecf20Sopenharmony_ci
2348c2ecf20Sopenharmony_ci	ctrl->addr = le16_to_cpu(ctrl_chunk->addr);
2358c2ecf20Sopenharmony_ci	ctrl->num_bytes = num_bytes;
2368c2ecf20Sopenharmony_ci	ctrl->samplerates = le32_to_cpu(chunk->samplerates);
2378c2ecf20Sopenharmony_ci
2388c2ecf20Sopenharmony_ci	list_add_tail(&ctrl->head, &sigmadsp->ctrl_list);
2398c2ecf20Sopenharmony_ci
2408c2ecf20Sopenharmony_ci	return 0;
2418c2ecf20Sopenharmony_ci
2428c2ecf20Sopenharmony_cierr_free_ctrl:
2438c2ecf20Sopenharmony_ci	kfree(ctrl);
2448c2ecf20Sopenharmony_ci
2458c2ecf20Sopenharmony_ci	return ret;
2468c2ecf20Sopenharmony_ci}
2478c2ecf20Sopenharmony_ci
2488c2ecf20Sopenharmony_cistatic int sigma_fw_load_data(struct sigmadsp *sigmadsp,
2498c2ecf20Sopenharmony_ci	const struct sigma_fw_chunk *chunk, unsigned int length)
2508c2ecf20Sopenharmony_ci{
2518c2ecf20Sopenharmony_ci	const struct sigma_fw_chunk_data *data_chunk;
2528c2ecf20Sopenharmony_ci	struct sigmadsp_data *data;
2538c2ecf20Sopenharmony_ci
2548c2ecf20Sopenharmony_ci	if (length <= sizeof(*data_chunk))
2558c2ecf20Sopenharmony_ci		return -EINVAL;
2568c2ecf20Sopenharmony_ci
2578c2ecf20Sopenharmony_ci	data_chunk = (struct sigma_fw_chunk_data *)chunk;
2588c2ecf20Sopenharmony_ci
2598c2ecf20Sopenharmony_ci	length -= sizeof(*data_chunk);
2608c2ecf20Sopenharmony_ci
2618c2ecf20Sopenharmony_ci	data = kzalloc(sizeof(*data) + length, GFP_KERNEL);
2628c2ecf20Sopenharmony_ci	if (!data)
2638c2ecf20Sopenharmony_ci		return -ENOMEM;
2648c2ecf20Sopenharmony_ci
2658c2ecf20Sopenharmony_ci	data->addr = le16_to_cpu(data_chunk->addr);
2668c2ecf20Sopenharmony_ci	data->length = length;
2678c2ecf20Sopenharmony_ci	data->samplerates = le32_to_cpu(chunk->samplerates);
2688c2ecf20Sopenharmony_ci	memcpy(data->data, data_chunk->data, length);
2698c2ecf20Sopenharmony_ci	list_add_tail(&data->head, &sigmadsp->data_list);
2708c2ecf20Sopenharmony_ci
2718c2ecf20Sopenharmony_ci	return 0;
2728c2ecf20Sopenharmony_ci}
2738c2ecf20Sopenharmony_ci
2748c2ecf20Sopenharmony_cistatic int sigma_fw_load_samplerates(struct sigmadsp *sigmadsp,
2758c2ecf20Sopenharmony_ci	const struct sigma_fw_chunk *chunk, unsigned int length)
2768c2ecf20Sopenharmony_ci{
2778c2ecf20Sopenharmony_ci	const struct sigma_fw_chunk_samplerate *rate_chunk;
2788c2ecf20Sopenharmony_ci	unsigned int num_rates;
2798c2ecf20Sopenharmony_ci	unsigned int *rates;
2808c2ecf20Sopenharmony_ci	unsigned int i;
2818c2ecf20Sopenharmony_ci
2828c2ecf20Sopenharmony_ci	rate_chunk = (const struct sigma_fw_chunk_samplerate *)chunk;
2838c2ecf20Sopenharmony_ci
2848c2ecf20Sopenharmony_ci	num_rates = (length - sizeof(*rate_chunk)) / sizeof(__le32);
2858c2ecf20Sopenharmony_ci
2868c2ecf20Sopenharmony_ci	if (num_rates > 32 || num_rates == 0)
2878c2ecf20Sopenharmony_ci		return -EINVAL;
2888c2ecf20Sopenharmony_ci
2898c2ecf20Sopenharmony_ci	/* We only allow one samplerates block per file */
2908c2ecf20Sopenharmony_ci	if (sigmadsp->rate_constraints.count)
2918c2ecf20Sopenharmony_ci		return -EINVAL;
2928c2ecf20Sopenharmony_ci
2938c2ecf20Sopenharmony_ci	rates = kcalloc(num_rates, sizeof(*rates), GFP_KERNEL);
2948c2ecf20Sopenharmony_ci	if (!rates)
2958c2ecf20Sopenharmony_ci		return -ENOMEM;
2968c2ecf20Sopenharmony_ci
2978c2ecf20Sopenharmony_ci	for (i = 0; i < num_rates; i++)
2988c2ecf20Sopenharmony_ci		rates[i] = le32_to_cpu(rate_chunk->samplerates[i]);
2998c2ecf20Sopenharmony_ci
3008c2ecf20Sopenharmony_ci	sigmadsp->rate_constraints.count = num_rates;
3018c2ecf20Sopenharmony_ci	sigmadsp->rate_constraints.list = rates;
3028c2ecf20Sopenharmony_ci
3038c2ecf20Sopenharmony_ci	return 0;
3048c2ecf20Sopenharmony_ci}
3058c2ecf20Sopenharmony_ci
3068c2ecf20Sopenharmony_cistatic int sigmadsp_fw_load_v2(struct sigmadsp *sigmadsp,
3078c2ecf20Sopenharmony_ci	const struct firmware *fw)
3088c2ecf20Sopenharmony_ci{
3098c2ecf20Sopenharmony_ci	struct sigma_fw_chunk *chunk;
3108c2ecf20Sopenharmony_ci	unsigned int length, pos;
3118c2ecf20Sopenharmony_ci	int ret;
3128c2ecf20Sopenharmony_ci
3138c2ecf20Sopenharmony_ci	/*
3148c2ecf20Sopenharmony_ci	 * Make sure that there is at least one chunk to avoid integer
3158c2ecf20Sopenharmony_ci	 * underflows later on. Empty firmware is still valid though.
3168c2ecf20Sopenharmony_ci	 */
3178c2ecf20Sopenharmony_ci	if (fw->size < sizeof(*chunk) + sizeof(struct sigma_firmware_header))
3188c2ecf20Sopenharmony_ci		return 0;
3198c2ecf20Sopenharmony_ci
3208c2ecf20Sopenharmony_ci	pos = sizeof(struct sigma_firmware_header);
3218c2ecf20Sopenharmony_ci
3228c2ecf20Sopenharmony_ci	while (pos < fw->size - sizeof(*chunk)) {
3238c2ecf20Sopenharmony_ci		chunk = (struct sigma_fw_chunk *)(fw->data + pos);
3248c2ecf20Sopenharmony_ci
3258c2ecf20Sopenharmony_ci		length = le32_to_cpu(chunk->length);
3268c2ecf20Sopenharmony_ci
3278c2ecf20Sopenharmony_ci		if (length > fw->size - pos || length < sizeof(*chunk))
3288c2ecf20Sopenharmony_ci			return -EINVAL;
3298c2ecf20Sopenharmony_ci
3308c2ecf20Sopenharmony_ci		switch (le32_to_cpu(chunk->tag)) {
3318c2ecf20Sopenharmony_ci		case SIGMA_FW_CHUNK_TYPE_DATA:
3328c2ecf20Sopenharmony_ci			ret = sigma_fw_load_data(sigmadsp, chunk, length);
3338c2ecf20Sopenharmony_ci			break;
3348c2ecf20Sopenharmony_ci		case SIGMA_FW_CHUNK_TYPE_CONTROL:
3358c2ecf20Sopenharmony_ci			ret = sigma_fw_load_control(sigmadsp, chunk, length);
3368c2ecf20Sopenharmony_ci			break;
3378c2ecf20Sopenharmony_ci		case SIGMA_FW_CHUNK_TYPE_SAMPLERATES:
3388c2ecf20Sopenharmony_ci			ret = sigma_fw_load_samplerates(sigmadsp, chunk, length);
3398c2ecf20Sopenharmony_ci			break;
3408c2ecf20Sopenharmony_ci		default:
3418c2ecf20Sopenharmony_ci			dev_warn(sigmadsp->dev, "Unknown chunk type: %d\n",
3428c2ecf20Sopenharmony_ci				chunk->tag);
3438c2ecf20Sopenharmony_ci			ret = 0;
3448c2ecf20Sopenharmony_ci			break;
3458c2ecf20Sopenharmony_ci		}
3468c2ecf20Sopenharmony_ci
3478c2ecf20Sopenharmony_ci		if (ret)
3488c2ecf20Sopenharmony_ci			return ret;
3498c2ecf20Sopenharmony_ci
3508c2ecf20Sopenharmony_ci		/*
3518c2ecf20Sopenharmony_ci		 * This can not overflow since if length is larger than the
3528c2ecf20Sopenharmony_ci		 * maximum firmware size (0x4000000) we'll error out earilier.
3538c2ecf20Sopenharmony_ci		 */
3548c2ecf20Sopenharmony_ci		pos += ALIGN(length, sizeof(__le32));
3558c2ecf20Sopenharmony_ci	}
3568c2ecf20Sopenharmony_ci
3578c2ecf20Sopenharmony_ci	return 0;
3588c2ecf20Sopenharmony_ci}
3598c2ecf20Sopenharmony_ci
3608c2ecf20Sopenharmony_cistatic inline u32 sigma_action_len(struct sigma_action *sa)
3618c2ecf20Sopenharmony_ci{
3628c2ecf20Sopenharmony_ci	return (sa->len_hi << 16) | le16_to_cpu(sa->len);
3638c2ecf20Sopenharmony_ci}
3648c2ecf20Sopenharmony_ci
3658c2ecf20Sopenharmony_cistatic size_t sigma_action_size(struct sigma_action *sa)
3668c2ecf20Sopenharmony_ci{
3678c2ecf20Sopenharmony_ci	size_t payload = 0;
3688c2ecf20Sopenharmony_ci
3698c2ecf20Sopenharmony_ci	switch (sa->instr) {
3708c2ecf20Sopenharmony_ci	case SIGMA_ACTION_WRITEXBYTES:
3718c2ecf20Sopenharmony_ci	case SIGMA_ACTION_WRITESINGLE:
3728c2ecf20Sopenharmony_ci	case SIGMA_ACTION_WRITESAFELOAD:
3738c2ecf20Sopenharmony_ci		payload = sigma_action_len(sa);
3748c2ecf20Sopenharmony_ci		break;
3758c2ecf20Sopenharmony_ci	default:
3768c2ecf20Sopenharmony_ci		break;
3778c2ecf20Sopenharmony_ci	}
3788c2ecf20Sopenharmony_ci
3798c2ecf20Sopenharmony_ci	payload = ALIGN(payload, 2);
3808c2ecf20Sopenharmony_ci
3818c2ecf20Sopenharmony_ci	return payload + sizeof(struct sigma_action);
3828c2ecf20Sopenharmony_ci}
3838c2ecf20Sopenharmony_ci
3848c2ecf20Sopenharmony_ci/*
3858c2ecf20Sopenharmony_ci * Returns a negative error value in case of an error, 0 if processing of
3868c2ecf20Sopenharmony_ci * the firmware should be stopped after this action, 1 otherwise.
3878c2ecf20Sopenharmony_ci */
3888c2ecf20Sopenharmony_cistatic int process_sigma_action(struct sigmadsp *sigmadsp,
3898c2ecf20Sopenharmony_ci	struct sigma_action *sa)
3908c2ecf20Sopenharmony_ci{
3918c2ecf20Sopenharmony_ci	size_t len = sigma_action_len(sa);
3928c2ecf20Sopenharmony_ci	struct sigmadsp_data *data;
3938c2ecf20Sopenharmony_ci
3948c2ecf20Sopenharmony_ci	pr_debug("%s: instr:%i addr:%#x len:%zu\n", __func__,
3958c2ecf20Sopenharmony_ci		sa->instr, sa->addr, len);
3968c2ecf20Sopenharmony_ci
3978c2ecf20Sopenharmony_ci	switch (sa->instr) {
3988c2ecf20Sopenharmony_ci	case SIGMA_ACTION_WRITEXBYTES:
3998c2ecf20Sopenharmony_ci	case SIGMA_ACTION_WRITESINGLE:
4008c2ecf20Sopenharmony_ci	case SIGMA_ACTION_WRITESAFELOAD:
4018c2ecf20Sopenharmony_ci		if (len < 3)
4028c2ecf20Sopenharmony_ci			return -EINVAL;
4038c2ecf20Sopenharmony_ci
4048c2ecf20Sopenharmony_ci		data = kzalloc(sizeof(*data) + len - 2, GFP_KERNEL);
4058c2ecf20Sopenharmony_ci		if (!data)
4068c2ecf20Sopenharmony_ci			return -ENOMEM;
4078c2ecf20Sopenharmony_ci
4088c2ecf20Sopenharmony_ci		data->addr = be16_to_cpu(sa->addr);
4098c2ecf20Sopenharmony_ci		data->length = len - 2;
4108c2ecf20Sopenharmony_ci		memcpy(data->data, sa->payload, data->length);
4118c2ecf20Sopenharmony_ci		list_add_tail(&data->head, &sigmadsp->data_list);
4128c2ecf20Sopenharmony_ci		break;
4138c2ecf20Sopenharmony_ci	case SIGMA_ACTION_END:
4148c2ecf20Sopenharmony_ci		return 0;
4158c2ecf20Sopenharmony_ci	default:
4168c2ecf20Sopenharmony_ci		return -EINVAL;
4178c2ecf20Sopenharmony_ci	}
4188c2ecf20Sopenharmony_ci
4198c2ecf20Sopenharmony_ci	return 1;
4208c2ecf20Sopenharmony_ci}
4218c2ecf20Sopenharmony_ci
4228c2ecf20Sopenharmony_cistatic int sigmadsp_fw_load_v1(struct sigmadsp *sigmadsp,
4238c2ecf20Sopenharmony_ci	const struct firmware *fw)
4248c2ecf20Sopenharmony_ci{
4258c2ecf20Sopenharmony_ci	struct sigma_action *sa;
4268c2ecf20Sopenharmony_ci	size_t size, pos;
4278c2ecf20Sopenharmony_ci	int ret;
4288c2ecf20Sopenharmony_ci
4298c2ecf20Sopenharmony_ci	pos = sizeof(struct sigma_firmware_header);
4308c2ecf20Sopenharmony_ci
4318c2ecf20Sopenharmony_ci	while (pos + sizeof(*sa) <= fw->size) {
4328c2ecf20Sopenharmony_ci		sa = (struct sigma_action *)(fw->data + pos);
4338c2ecf20Sopenharmony_ci
4348c2ecf20Sopenharmony_ci		size = sigma_action_size(sa);
4358c2ecf20Sopenharmony_ci		pos += size;
4368c2ecf20Sopenharmony_ci		if (pos > fw->size || size == 0)
4378c2ecf20Sopenharmony_ci			break;
4388c2ecf20Sopenharmony_ci
4398c2ecf20Sopenharmony_ci		ret = process_sigma_action(sigmadsp, sa);
4408c2ecf20Sopenharmony_ci
4418c2ecf20Sopenharmony_ci		pr_debug("%s: action returned %i\n", __func__, ret);
4428c2ecf20Sopenharmony_ci
4438c2ecf20Sopenharmony_ci		if (ret <= 0)
4448c2ecf20Sopenharmony_ci			return ret;
4458c2ecf20Sopenharmony_ci	}
4468c2ecf20Sopenharmony_ci
4478c2ecf20Sopenharmony_ci	if (pos != fw->size)
4488c2ecf20Sopenharmony_ci		return -EINVAL;
4498c2ecf20Sopenharmony_ci
4508c2ecf20Sopenharmony_ci	return 0;
4518c2ecf20Sopenharmony_ci}
4528c2ecf20Sopenharmony_ci
4538c2ecf20Sopenharmony_cistatic void sigmadsp_firmware_release(struct sigmadsp *sigmadsp)
4548c2ecf20Sopenharmony_ci{
4558c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl, *_ctrl;
4568c2ecf20Sopenharmony_ci	struct sigmadsp_data *data, *_data;
4578c2ecf20Sopenharmony_ci
4588c2ecf20Sopenharmony_ci	list_for_each_entry_safe(ctrl, _ctrl, &sigmadsp->ctrl_list, head) {
4598c2ecf20Sopenharmony_ci		kfree(ctrl->name);
4608c2ecf20Sopenharmony_ci		kfree(ctrl);
4618c2ecf20Sopenharmony_ci	}
4628c2ecf20Sopenharmony_ci
4638c2ecf20Sopenharmony_ci	list_for_each_entry_safe(data, _data, &sigmadsp->data_list, head)
4648c2ecf20Sopenharmony_ci		kfree(data);
4658c2ecf20Sopenharmony_ci
4668c2ecf20Sopenharmony_ci	INIT_LIST_HEAD(&sigmadsp->ctrl_list);
4678c2ecf20Sopenharmony_ci	INIT_LIST_HEAD(&sigmadsp->data_list);
4688c2ecf20Sopenharmony_ci}
4698c2ecf20Sopenharmony_ci
4708c2ecf20Sopenharmony_cistatic void devm_sigmadsp_release(struct device *dev, void *res)
4718c2ecf20Sopenharmony_ci{
4728c2ecf20Sopenharmony_ci	sigmadsp_firmware_release((struct sigmadsp *)res);
4738c2ecf20Sopenharmony_ci}
4748c2ecf20Sopenharmony_ci
4758c2ecf20Sopenharmony_cistatic int sigmadsp_firmware_load(struct sigmadsp *sigmadsp, const char *name)
4768c2ecf20Sopenharmony_ci{
4778c2ecf20Sopenharmony_ci	const struct sigma_firmware_header *ssfw_head;
4788c2ecf20Sopenharmony_ci	const struct firmware *fw;
4798c2ecf20Sopenharmony_ci	int ret;
4808c2ecf20Sopenharmony_ci	u32 crc;
4818c2ecf20Sopenharmony_ci
4828c2ecf20Sopenharmony_ci	/* first load the blob */
4838c2ecf20Sopenharmony_ci	ret = request_firmware(&fw, name, sigmadsp->dev);
4848c2ecf20Sopenharmony_ci	if (ret) {
4858c2ecf20Sopenharmony_ci		pr_debug("%s: request_firmware() failed with %i\n", __func__, ret);
4868c2ecf20Sopenharmony_ci		goto done;
4878c2ecf20Sopenharmony_ci	}
4888c2ecf20Sopenharmony_ci
4898c2ecf20Sopenharmony_ci	/* then verify the header */
4908c2ecf20Sopenharmony_ci	ret = -EINVAL;
4918c2ecf20Sopenharmony_ci
4928c2ecf20Sopenharmony_ci	/*
4938c2ecf20Sopenharmony_ci	 * Reject too small or unreasonable large files. The upper limit has been
4948c2ecf20Sopenharmony_ci	 * chosen a bit arbitrarily, but it should be enough for all practical
4958c2ecf20Sopenharmony_ci	 * purposes and having the limit makes it easier to avoid integer
4968c2ecf20Sopenharmony_ci	 * overflows later in the loading process.
4978c2ecf20Sopenharmony_ci	 */
4988c2ecf20Sopenharmony_ci	if (fw->size < sizeof(*ssfw_head) || fw->size >= 0x4000000) {
4998c2ecf20Sopenharmony_ci		dev_err(sigmadsp->dev, "Failed to load firmware: Invalid size\n");
5008c2ecf20Sopenharmony_ci		goto done;
5018c2ecf20Sopenharmony_ci	}
5028c2ecf20Sopenharmony_ci
5038c2ecf20Sopenharmony_ci	ssfw_head = (void *)fw->data;
5048c2ecf20Sopenharmony_ci	if (memcmp(ssfw_head->magic, SIGMA_MAGIC, ARRAY_SIZE(ssfw_head->magic))) {
5058c2ecf20Sopenharmony_ci		dev_err(sigmadsp->dev, "Failed to load firmware: Invalid magic\n");
5068c2ecf20Sopenharmony_ci		goto done;
5078c2ecf20Sopenharmony_ci	}
5088c2ecf20Sopenharmony_ci
5098c2ecf20Sopenharmony_ci	crc = crc32(0, fw->data + sizeof(*ssfw_head),
5108c2ecf20Sopenharmony_ci			fw->size - sizeof(*ssfw_head));
5118c2ecf20Sopenharmony_ci	pr_debug("%s: crc=%x\n", __func__, crc);
5128c2ecf20Sopenharmony_ci	if (crc != le32_to_cpu(ssfw_head->crc)) {
5138c2ecf20Sopenharmony_ci		dev_err(sigmadsp->dev, "Failed to load firmware: Wrong crc checksum: expected %x got %x\n",
5148c2ecf20Sopenharmony_ci			le32_to_cpu(ssfw_head->crc), crc);
5158c2ecf20Sopenharmony_ci		goto done;
5168c2ecf20Sopenharmony_ci	}
5178c2ecf20Sopenharmony_ci
5188c2ecf20Sopenharmony_ci	switch (ssfw_head->version) {
5198c2ecf20Sopenharmony_ci	case 1:
5208c2ecf20Sopenharmony_ci		ret = sigmadsp_fw_load_v1(sigmadsp, fw);
5218c2ecf20Sopenharmony_ci		break;
5228c2ecf20Sopenharmony_ci	case 2:
5238c2ecf20Sopenharmony_ci		ret = sigmadsp_fw_load_v2(sigmadsp, fw);
5248c2ecf20Sopenharmony_ci		break;
5258c2ecf20Sopenharmony_ci	default:
5268c2ecf20Sopenharmony_ci		dev_err(sigmadsp->dev,
5278c2ecf20Sopenharmony_ci			"Failed to load firmware: Invalid version %d. Supported firmware versions: 1, 2\n",
5288c2ecf20Sopenharmony_ci			ssfw_head->version);
5298c2ecf20Sopenharmony_ci		ret = -EINVAL;
5308c2ecf20Sopenharmony_ci		break;
5318c2ecf20Sopenharmony_ci	}
5328c2ecf20Sopenharmony_ci
5338c2ecf20Sopenharmony_ci	if (ret)
5348c2ecf20Sopenharmony_ci		sigmadsp_firmware_release(sigmadsp);
5358c2ecf20Sopenharmony_ci
5368c2ecf20Sopenharmony_cidone:
5378c2ecf20Sopenharmony_ci	release_firmware(fw);
5388c2ecf20Sopenharmony_ci
5398c2ecf20Sopenharmony_ci	return ret;
5408c2ecf20Sopenharmony_ci}
5418c2ecf20Sopenharmony_ci
5428c2ecf20Sopenharmony_cistatic int sigmadsp_init(struct sigmadsp *sigmadsp, struct device *dev,
5438c2ecf20Sopenharmony_ci	const struct sigmadsp_ops *ops, const char *firmware_name)
5448c2ecf20Sopenharmony_ci{
5458c2ecf20Sopenharmony_ci	sigmadsp->ops = ops;
5468c2ecf20Sopenharmony_ci	sigmadsp->dev = dev;
5478c2ecf20Sopenharmony_ci
5488c2ecf20Sopenharmony_ci	INIT_LIST_HEAD(&sigmadsp->ctrl_list);
5498c2ecf20Sopenharmony_ci	INIT_LIST_HEAD(&sigmadsp->data_list);
5508c2ecf20Sopenharmony_ci	mutex_init(&sigmadsp->lock);
5518c2ecf20Sopenharmony_ci
5528c2ecf20Sopenharmony_ci	return sigmadsp_firmware_load(sigmadsp, firmware_name);
5538c2ecf20Sopenharmony_ci}
5548c2ecf20Sopenharmony_ci
5558c2ecf20Sopenharmony_ci/**
5568c2ecf20Sopenharmony_ci * devm_sigmadsp_init() - Initialize SigmaDSP instance
5578c2ecf20Sopenharmony_ci * @dev: The parent device
5588c2ecf20Sopenharmony_ci * @ops: The sigmadsp_ops to use for this instance
5598c2ecf20Sopenharmony_ci * @firmware_name: Name of the firmware file to load
5608c2ecf20Sopenharmony_ci *
5618c2ecf20Sopenharmony_ci * Allocates a SigmaDSP instance and loads the specified firmware file.
5628c2ecf20Sopenharmony_ci *
5638c2ecf20Sopenharmony_ci * Returns a pointer to a struct sigmadsp on success, or a PTR_ERR() on error.
5648c2ecf20Sopenharmony_ci */
5658c2ecf20Sopenharmony_cistruct sigmadsp *devm_sigmadsp_init(struct device *dev,
5668c2ecf20Sopenharmony_ci	const struct sigmadsp_ops *ops, const char *firmware_name)
5678c2ecf20Sopenharmony_ci{
5688c2ecf20Sopenharmony_ci	struct sigmadsp *sigmadsp;
5698c2ecf20Sopenharmony_ci	int ret;
5708c2ecf20Sopenharmony_ci
5718c2ecf20Sopenharmony_ci	sigmadsp = devres_alloc(devm_sigmadsp_release, sizeof(*sigmadsp),
5728c2ecf20Sopenharmony_ci		GFP_KERNEL);
5738c2ecf20Sopenharmony_ci	if (!sigmadsp)
5748c2ecf20Sopenharmony_ci		return ERR_PTR(-ENOMEM);
5758c2ecf20Sopenharmony_ci
5768c2ecf20Sopenharmony_ci	ret = sigmadsp_init(sigmadsp, dev, ops, firmware_name);
5778c2ecf20Sopenharmony_ci	if (ret) {
5788c2ecf20Sopenharmony_ci		devres_free(sigmadsp);
5798c2ecf20Sopenharmony_ci		return ERR_PTR(ret);
5808c2ecf20Sopenharmony_ci	}
5818c2ecf20Sopenharmony_ci
5828c2ecf20Sopenharmony_ci	devres_add(dev, sigmadsp);
5838c2ecf20Sopenharmony_ci
5848c2ecf20Sopenharmony_ci	return sigmadsp;
5858c2ecf20Sopenharmony_ci}
5868c2ecf20Sopenharmony_ciEXPORT_SYMBOL_GPL(devm_sigmadsp_init);
5878c2ecf20Sopenharmony_ci
5888c2ecf20Sopenharmony_cistatic int sigmadsp_rate_to_index(struct sigmadsp *sigmadsp, unsigned int rate)
5898c2ecf20Sopenharmony_ci{
5908c2ecf20Sopenharmony_ci	unsigned int i;
5918c2ecf20Sopenharmony_ci
5928c2ecf20Sopenharmony_ci	for (i = 0; i < sigmadsp->rate_constraints.count; i++) {
5938c2ecf20Sopenharmony_ci		if (sigmadsp->rate_constraints.list[i] == rate)
5948c2ecf20Sopenharmony_ci			return i;
5958c2ecf20Sopenharmony_ci	}
5968c2ecf20Sopenharmony_ci
5978c2ecf20Sopenharmony_ci	return -EINVAL;
5988c2ecf20Sopenharmony_ci}
5998c2ecf20Sopenharmony_ci
6008c2ecf20Sopenharmony_cistatic unsigned int sigmadsp_get_samplerate_mask(struct sigmadsp *sigmadsp,
6018c2ecf20Sopenharmony_ci	unsigned int samplerate)
6028c2ecf20Sopenharmony_ci{
6038c2ecf20Sopenharmony_ci	int samplerate_index;
6048c2ecf20Sopenharmony_ci
6058c2ecf20Sopenharmony_ci	if (samplerate == 0)
6068c2ecf20Sopenharmony_ci		return 0;
6078c2ecf20Sopenharmony_ci
6088c2ecf20Sopenharmony_ci	if (sigmadsp->rate_constraints.count) {
6098c2ecf20Sopenharmony_ci		samplerate_index = sigmadsp_rate_to_index(sigmadsp, samplerate);
6108c2ecf20Sopenharmony_ci		if (samplerate_index < 0)
6118c2ecf20Sopenharmony_ci			return 0;
6128c2ecf20Sopenharmony_ci
6138c2ecf20Sopenharmony_ci		return BIT(samplerate_index);
6148c2ecf20Sopenharmony_ci	} else {
6158c2ecf20Sopenharmony_ci		return ~0;
6168c2ecf20Sopenharmony_ci	}
6178c2ecf20Sopenharmony_ci}
6188c2ecf20Sopenharmony_ci
6198c2ecf20Sopenharmony_cistatic bool sigmadsp_samplerate_valid(unsigned int supported,
6208c2ecf20Sopenharmony_ci	unsigned int requested)
6218c2ecf20Sopenharmony_ci{
6228c2ecf20Sopenharmony_ci	/* All samplerates are supported */
6238c2ecf20Sopenharmony_ci	if (!supported)
6248c2ecf20Sopenharmony_ci		return true;
6258c2ecf20Sopenharmony_ci
6268c2ecf20Sopenharmony_ci	return supported & requested;
6278c2ecf20Sopenharmony_ci}
6288c2ecf20Sopenharmony_ci
6298c2ecf20Sopenharmony_cistatic int sigmadsp_alloc_control(struct sigmadsp *sigmadsp,
6308c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl, unsigned int samplerate_mask)
6318c2ecf20Sopenharmony_ci{
6328c2ecf20Sopenharmony_ci	struct snd_kcontrol_new template;
6338c2ecf20Sopenharmony_ci	struct snd_kcontrol *kcontrol;
6348c2ecf20Sopenharmony_ci
6358c2ecf20Sopenharmony_ci	memset(&template, 0, sizeof(template));
6368c2ecf20Sopenharmony_ci	template.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
6378c2ecf20Sopenharmony_ci	template.name = ctrl->name;
6388c2ecf20Sopenharmony_ci	template.info = sigmadsp_ctrl_info;
6398c2ecf20Sopenharmony_ci	template.get = sigmadsp_ctrl_get;
6408c2ecf20Sopenharmony_ci	template.put = sigmadsp_ctrl_put;
6418c2ecf20Sopenharmony_ci	template.private_value = (unsigned long)ctrl;
6428c2ecf20Sopenharmony_ci	template.access = SNDRV_CTL_ELEM_ACCESS_READWRITE;
6438c2ecf20Sopenharmony_ci	if (!sigmadsp_samplerate_valid(ctrl->samplerates, samplerate_mask))
6448c2ecf20Sopenharmony_ci		template.access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
6458c2ecf20Sopenharmony_ci
6468c2ecf20Sopenharmony_ci	kcontrol = snd_ctl_new1(&template, sigmadsp);
6478c2ecf20Sopenharmony_ci	if (!kcontrol)
6488c2ecf20Sopenharmony_ci		return -ENOMEM;
6498c2ecf20Sopenharmony_ci
6508c2ecf20Sopenharmony_ci	kcontrol->private_free = sigmadsp_control_free;
6518c2ecf20Sopenharmony_ci	ctrl->kcontrol = kcontrol;
6528c2ecf20Sopenharmony_ci
6538c2ecf20Sopenharmony_ci	return snd_ctl_add(sigmadsp->component->card->snd_card, kcontrol);
6548c2ecf20Sopenharmony_ci}
6558c2ecf20Sopenharmony_ci
6568c2ecf20Sopenharmony_cistatic void sigmadsp_activate_ctrl(struct sigmadsp *sigmadsp,
6578c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl, unsigned int samplerate_mask)
6588c2ecf20Sopenharmony_ci{
6598c2ecf20Sopenharmony_ci	struct snd_card *card = sigmadsp->component->card->snd_card;
6608c2ecf20Sopenharmony_ci	struct snd_kcontrol_volatile *vd;
6618c2ecf20Sopenharmony_ci	struct snd_ctl_elem_id id;
6628c2ecf20Sopenharmony_ci	bool active;
6638c2ecf20Sopenharmony_ci	bool changed = false;
6648c2ecf20Sopenharmony_ci
6658c2ecf20Sopenharmony_ci	active = sigmadsp_samplerate_valid(ctrl->samplerates, samplerate_mask);
6668c2ecf20Sopenharmony_ci
6678c2ecf20Sopenharmony_ci	down_write(&card->controls_rwsem);
6688c2ecf20Sopenharmony_ci	if (!ctrl->kcontrol) {
6698c2ecf20Sopenharmony_ci		up_write(&card->controls_rwsem);
6708c2ecf20Sopenharmony_ci		return;
6718c2ecf20Sopenharmony_ci	}
6728c2ecf20Sopenharmony_ci
6738c2ecf20Sopenharmony_ci	id = ctrl->kcontrol->id;
6748c2ecf20Sopenharmony_ci	vd = &ctrl->kcontrol->vd[0];
6758c2ecf20Sopenharmony_ci	if (active == (bool)(vd->access & SNDRV_CTL_ELEM_ACCESS_INACTIVE)) {
6768c2ecf20Sopenharmony_ci		vd->access ^= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
6778c2ecf20Sopenharmony_ci		changed = true;
6788c2ecf20Sopenharmony_ci	}
6798c2ecf20Sopenharmony_ci	up_write(&card->controls_rwsem);
6808c2ecf20Sopenharmony_ci
6818c2ecf20Sopenharmony_ci	if (active && changed) {
6828c2ecf20Sopenharmony_ci		mutex_lock(&sigmadsp->lock);
6838c2ecf20Sopenharmony_ci		if (ctrl->cached)
6848c2ecf20Sopenharmony_ci			sigmadsp_ctrl_write(sigmadsp, ctrl, ctrl->cache);
6858c2ecf20Sopenharmony_ci		mutex_unlock(&sigmadsp->lock);
6868c2ecf20Sopenharmony_ci	}
6878c2ecf20Sopenharmony_ci
6888c2ecf20Sopenharmony_ci	if (changed)
6898c2ecf20Sopenharmony_ci		snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_INFO, &id);
6908c2ecf20Sopenharmony_ci}
6918c2ecf20Sopenharmony_ci
6928c2ecf20Sopenharmony_ci/**
6938c2ecf20Sopenharmony_ci * sigmadsp_attach() - Attach a sigmadsp instance to a ASoC component
6948c2ecf20Sopenharmony_ci * @sigmadsp: The sigmadsp instance to attach
6958c2ecf20Sopenharmony_ci * @component: The component to attach to
6968c2ecf20Sopenharmony_ci *
6978c2ecf20Sopenharmony_ci * Typically called in the components probe callback.
6988c2ecf20Sopenharmony_ci *
6998c2ecf20Sopenharmony_ci * Note, once this function has been called the firmware must not be released
7008c2ecf20Sopenharmony_ci * until after the ALSA snd_card that the component belongs to has been
7018c2ecf20Sopenharmony_ci * disconnected, even if sigmadsp_attach() returns an error.
7028c2ecf20Sopenharmony_ci */
7038c2ecf20Sopenharmony_ciint sigmadsp_attach(struct sigmadsp *sigmadsp,
7048c2ecf20Sopenharmony_ci	struct snd_soc_component *component)
7058c2ecf20Sopenharmony_ci{
7068c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl;
7078c2ecf20Sopenharmony_ci	unsigned int samplerate_mask;
7088c2ecf20Sopenharmony_ci	int ret;
7098c2ecf20Sopenharmony_ci
7108c2ecf20Sopenharmony_ci	sigmadsp->component = component;
7118c2ecf20Sopenharmony_ci
7128c2ecf20Sopenharmony_ci	samplerate_mask = sigmadsp_get_samplerate_mask(sigmadsp,
7138c2ecf20Sopenharmony_ci		sigmadsp->current_samplerate);
7148c2ecf20Sopenharmony_ci
7158c2ecf20Sopenharmony_ci	list_for_each_entry(ctrl, &sigmadsp->ctrl_list, head) {
7168c2ecf20Sopenharmony_ci		ret = sigmadsp_alloc_control(sigmadsp, ctrl, samplerate_mask);
7178c2ecf20Sopenharmony_ci		if (ret)
7188c2ecf20Sopenharmony_ci			return ret;
7198c2ecf20Sopenharmony_ci	}
7208c2ecf20Sopenharmony_ci
7218c2ecf20Sopenharmony_ci	return 0;
7228c2ecf20Sopenharmony_ci}
7238c2ecf20Sopenharmony_ciEXPORT_SYMBOL_GPL(sigmadsp_attach);
7248c2ecf20Sopenharmony_ci
7258c2ecf20Sopenharmony_ci/**
7268c2ecf20Sopenharmony_ci * sigmadsp_setup() - Setup the DSP for the specified samplerate
7278c2ecf20Sopenharmony_ci * @sigmadsp: The sigmadsp instance to configure
7288c2ecf20Sopenharmony_ci * @samplerate: The samplerate the DSP should be configured for
7298c2ecf20Sopenharmony_ci *
7308c2ecf20Sopenharmony_ci * Loads the appropriate firmware program and parameter memory (if not already
7318c2ecf20Sopenharmony_ci * loaded) and enables the controls for the specified samplerate. Any control
7328c2ecf20Sopenharmony_ci * parameter changes that have been made previously will be restored.
7338c2ecf20Sopenharmony_ci *
7348c2ecf20Sopenharmony_ci * Returns 0 on success, a negative error code otherwise.
7358c2ecf20Sopenharmony_ci */
7368c2ecf20Sopenharmony_ciint sigmadsp_setup(struct sigmadsp *sigmadsp, unsigned int samplerate)
7378c2ecf20Sopenharmony_ci{
7388c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl;
7398c2ecf20Sopenharmony_ci	unsigned int samplerate_mask;
7408c2ecf20Sopenharmony_ci	struct sigmadsp_data *data;
7418c2ecf20Sopenharmony_ci	int ret;
7428c2ecf20Sopenharmony_ci
7438c2ecf20Sopenharmony_ci	if (sigmadsp->current_samplerate == samplerate)
7448c2ecf20Sopenharmony_ci		return 0;
7458c2ecf20Sopenharmony_ci
7468c2ecf20Sopenharmony_ci	samplerate_mask = sigmadsp_get_samplerate_mask(sigmadsp, samplerate);
7478c2ecf20Sopenharmony_ci	if (samplerate_mask == 0)
7488c2ecf20Sopenharmony_ci		return -EINVAL;
7498c2ecf20Sopenharmony_ci
7508c2ecf20Sopenharmony_ci	list_for_each_entry(data, &sigmadsp->data_list, head) {
7518c2ecf20Sopenharmony_ci		if (!sigmadsp_samplerate_valid(data->samplerates,
7528c2ecf20Sopenharmony_ci		    samplerate_mask))
7538c2ecf20Sopenharmony_ci			continue;
7548c2ecf20Sopenharmony_ci		ret = sigmadsp_write(sigmadsp, data->addr, data->data,
7558c2ecf20Sopenharmony_ci			data->length);
7568c2ecf20Sopenharmony_ci		if (ret)
7578c2ecf20Sopenharmony_ci			goto err;
7588c2ecf20Sopenharmony_ci	}
7598c2ecf20Sopenharmony_ci
7608c2ecf20Sopenharmony_ci	list_for_each_entry(ctrl, &sigmadsp->ctrl_list, head)
7618c2ecf20Sopenharmony_ci		sigmadsp_activate_ctrl(sigmadsp, ctrl, samplerate_mask);
7628c2ecf20Sopenharmony_ci
7638c2ecf20Sopenharmony_ci	sigmadsp->current_samplerate = samplerate;
7648c2ecf20Sopenharmony_ci
7658c2ecf20Sopenharmony_ci	return 0;
7668c2ecf20Sopenharmony_cierr:
7678c2ecf20Sopenharmony_ci	sigmadsp_reset(sigmadsp);
7688c2ecf20Sopenharmony_ci
7698c2ecf20Sopenharmony_ci	return ret;
7708c2ecf20Sopenharmony_ci}
7718c2ecf20Sopenharmony_ciEXPORT_SYMBOL_GPL(sigmadsp_setup);
7728c2ecf20Sopenharmony_ci
7738c2ecf20Sopenharmony_ci/**
7748c2ecf20Sopenharmony_ci * sigmadsp_reset() - Notify the sigmadsp instance that the DSP has been reset
7758c2ecf20Sopenharmony_ci * @sigmadsp: The sigmadsp instance to reset
7768c2ecf20Sopenharmony_ci *
7778c2ecf20Sopenharmony_ci * Should be called whenever the DSP has been reset and parameter and program
7788c2ecf20Sopenharmony_ci * memory need to be re-loaded.
7798c2ecf20Sopenharmony_ci */
7808c2ecf20Sopenharmony_civoid sigmadsp_reset(struct sigmadsp *sigmadsp)
7818c2ecf20Sopenharmony_ci{
7828c2ecf20Sopenharmony_ci	struct sigmadsp_control *ctrl;
7838c2ecf20Sopenharmony_ci
7848c2ecf20Sopenharmony_ci	list_for_each_entry(ctrl, &sigmadsp->ctrl_list, head)
7858c2ecf20Sopenharmony_ci		sigmadsp_activate_ctrl(sigmadsp, ctrl, false);
7868c2ecf20Sopenharmony_ci
7878c2ecf20Sopenharmony_ci	sigmadsp->current_samplerate = 0;
7888c2ecf20Sopenharmony_ci}
7898c2ecf20Sopenharmony_ciEXPORT_SYMBOL_GPL(sigmadsp_reset);
7908c2ecf20Sopenharmony_ci
7918c2ecf20Sopenharmony_ci/**
7928c2ecf20Sopenharmony_ci * sigmadsp_restrict_params() - Applies DSP firmware specific constraints
7938c2ecf20Sopenharmony_ci * @sigmadsp: The sigmadsp instance
7948c2ecf20Sopenharmony_ci * @substream: The substream to restrict
7958c2ecf20Sopenharmony_ci *
7968c2ecf20Sopenharmony_ci * Applies samplerate constraints that may be required by the firmware Should
7978c2ecf20Sopenharmony_ci * typically be called from the CODEC/component drivers startup callback.
7988c2ecf20Sopenharmony_ci *
7998c2ecf20Sopenharmony_ci * Returns 0 on success, a negative error code otherwise.
8008c2ecf20Sopenharmony_ci */
8018c2ecf20Sopenharmony_ciint sigmadsp_restrict_params(struct sigmadsp *sigmadsp,
8028c2ecf20Sopenharmony_ci	struct snd_pcm_substream *substream)
8038c2ecf20Sopenharmony_ci{
8048c2ecf20Sopenharmony_ci	if (sigmadsp->rate_constraints.count == 0)
8058c2ecf20Sopenharmony_ci		return 0;
8068c2ecf20Sopenharmony_ci
8078c2ecf20Sopenharmony_ci	return snd_pcm_hw_constraint_list(substream->runtime, 0,
8088c2ecf20Sopenharmony_ci		SNDRV_PCM_HW_PARAM_RATE, &sigmadsp->rate_constraints);
8098c2ecf20Sopenharmony_ci}
8108c2ecf20Sopenharmony_ciEXPORT_SYMBOL_GPL(sigmadsp_restrict_params);
8118c2ecf20Sopenharmony_ci
8128c2ecf20Sopenharmony_ciMODULE_LICENSE("GPL");
813