summaryrefslogtreecommitdiff
path: root/sound/soc/codecs/ntpfw.c
blob: 5ced2e966ab7d284c48a99f7ba9690d21b838c67 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
// SPDX-License-Identifier: GPL-2.0-only
/*
 * ntpfw.c - Firmware helper functions for Neofidelity codecs
 *
 * Copyright (c) 2024, SaluteDevices. All Rights Reserved.
 */

#include <linux/i2c.h>
#include <linux/firmware.h>
#include <linux/module.h>

#include "ntpfw.h"

struct ntpfw_chunk {
	__be16 length;
	u8 step;
	u8 data[];
} __packed;

struct ntpfw_header {
	__be32 magic;
} __packed;

static bool ntpfw_verify(struct device *dev, const u8 *buf, size_t buf_size, u32 magic)
{
	const struct ntpfw_header *header = (struct ntpfw_header *)buf;
	u32 buf_magic;

	if (buf_size <= sizeof(*header)) {
		dev_err(dev, "Failed to load firmware: image too small\n");
		return false;
	}

	buf_magic = be32_to_cpu(header->magic);
	if (buf_magic != magic) {
		dev_err(dev, "Failed to load firmware: invalid magic 0x%x:\n", buf_magic);
		return false;
	}

	return true;
}

static bool ntpfw_verify_chunk(struct device *dev, const struct ntpfw_chunk *chunk, size_t buf_size)
{
	size_t chunk_size;

	if (buf_size <= sizeof(*chunk)) {
		dev_err(dev, "Failed to load firmware: chunk size too big\n");
		return false;
	}

	if (chunk->step != 2 && chunk->step != 5) {
		dev_err(dev, "Failed to load firmware: invalid chunk step: %d\n", chunk->step);
		return false;
	}

	chunk_size = be16_to_cpu(chunk->length);
	if (chunk_size > buf_size) {
		dev_err(dev, "Failed to load firmware: invalid chunk length\n");
		return false;
	}

	if (chunk_size % chunk->step) {
		dev_err(dev, "Failed to load firmware: chunk length and step mismatch\n");
		return false;
	}

	return true;
}

static int ntpfw_send_chunk(struct i2c_client *i2c, const struct ntpfw_chunk *chunk)
{
	int ret;
	size_t i;
	size_t length = be16_to_cpu(chunk->length);

	for (i = 0; i < length; i += chunk->step) {
		ret = i2c_master_send(i2c, &chunk->data[i], chunk->step);
		if (ret != chunk->step) {
			dev_err(&i2c->dev, "I2C send failed: %d\n", ret);
			return ret < 0 ? ret : -EIO;
		}
	}

	return 0;
}

int ntpfw_load(struct i2c_client *i2c, const char *name, u32 magic)
{
	struct device *dev = &i2c->dev;
	const struct ntpfw_chunk *chunk;
	const struct firmware *fw;
	const u8 *data;
	size_t leftover;
	int ret;

	ret = request_firmware(&fw, name, dev);
	if (ret) {
		dev_warn(dev, "request_firmware '%s' failed with %d\n",
			 name, ret);
		return ret;
	}

	if (!ntpfw_verify(dev, fw->data, fw->size, magic)) {
		ret = -EINVAL;
		goto done;
	}

	data = fw->data + sizeof(struct ntpfw_header);
	leftover = fw->size - sizeof(struct ntpfw_header);

	while (leftover) {
		chunk = (struct ntpfw_chunk *)data;

		if (!ntpfw_verify_chunk(dev, chunk, leftover)) {
			ret = -EINVAL;
			goto done;
		}

		ret = ntpfw_send_chunk(i2c, chunk);
		if (ret)
			goto done;

		data += be16_to_cpu(chunk->length) + sizeof(*chunk);
		leftover -= be16_to_cpu(chunk->length) + sizeof(*chunk);
	}

done:
	release_firmware(fw);

	return ret;
}
EXPORT_SYMBOL_GPL(ntpfw_load);

MODULE_AUTHOR("Igor Prusov <ivprusov@salutedevices.com>");
MODULE_DESCRIPTION("Helper for loading Neofidelity amplifiers firmware");
MODULE_LICENSE("GPL");