Commit | Line | Data |
---|---|---|
e359dc24 MF |
1 | /* |
2 | * Load Analog Devices SigmaStudio firmware files | |
3 | * | |
4 | * Copyright 2009-2011 Analog Devices Inc. | |
5 | * | |
6 | * Licensed under the GPL-2 or later. | |
7 | */ | |
8 | ||
9 | #include <linux/crc32.h> | |
10 | #include <linux/delay.h> | |
11 | #include <linux/firmware.h> | |
12 | #include <linux/kernel.h> | |
13 | #include <linux/i2c.h> | |
38fd54ee | 14 | #include <linux/regmap.h> |
27c46a25 | 15 | #include <linux/module.h> |
40216ce7 LPC |
16 | |
17 | #include "sigmadsp.h" | |
e359dc24 | 18 | |
a4c1d7e6 LPC |
19 | #define SIGMA_MAGIC "ADISIGM" |
20 | ||
21 | struct sigma_firmware_header { | |
22 | unsigned char magic[7]; | |
23 | u8 version; | |
24 | __le32 crc; | |
25 | } __packed; | |
26 | ||
27 | enum { | |
28 | SIGMA_ACTION_WRITEXBYTES = 0, | |
29 | SIGMA_ACTION_WRITESINGLE, | |
30 | SIGMA_ACTION_WRITESAFELOAD, | |
31 | SIGMA_ACTION_DELAY, | |
32 | SIGMA_ACTION_PLLWAIT, | |
33 | SIGMA_ACTION_NOOP, | |
34 | SIGMA_ACTION_END, | |
35 | }; | |
36 | ||
37 | struct sigma_action { | |
38 | u8 instr; | |
39 | u8 len_hi; | |
40 | __le16 len; | |
41 | __be16 addr; | |
42 | unsigned char payload[]; | |
43 | } __packed; | |
44 | ||
45 | struct sigma_firmware { | |
46 | const struct firmware *fw; | |
47 | size_t pos; | |
38fd54ee LPC |
48 | |
49 | void *control_data; | |
50 | int (*write)(void *control_data, const struct sigma_action *sa, | |
51 | size_t len); | |
a4c1d7e6 LPC |
52 | }; |
53 | ||
54 | static inline u32 sigma_action_len(struct sigma_action *sa) | |
55 | { | |
56 | return (sa->len_hi << 16) | le16_to_cpu(sa->len); | |
57 | } | |
58 | ||
4f718a29 LPC |
59 | static size_t sigma_action_size(struct sigma_action *sa) |
60 | { | |
61 | size_t payload = 0; | |
62 | ||
63 | switch (sa->instr) { | |
64 | case SIGMA_ACTION_WRITEXBYTES: | |
65 | case SIGMA_ACTION_WRITESINGLE: | |
66 | case SIGMA_ACTION_WRITESAFELOAD: | |
67 | payload = sigma_action_len(sa); | |
68 | break; | |
69 | default: | |
70 | break; | |
71 | } | |
72 | ||
73 | payload = ALIGN(payload, 2); | |
74 | ||
75 | return payload + sizeof(struct sigma_action); | |
76 | } | |
77 | ||
78 | /* | |
79 | * Returns a negative error value in case of an error, 0 if processing of | |
80 | * the firmware should be stopped after this action, 1 otherwise. | |
81 | */ | |
e359dc24 | 82 | static int |
38fd54ee | 83 | process_sigma_action(struct sigma_firmware *ssfw, struct sigma_action *sa) |
e359dc24 | 84 | { |
e359dc24 | 85 | size_t len = sigma_action_len(sa); |
4f718a29 | 86 | int ret; |
e359dc24 MF |
87 | |
88 | pr_debug("%s: instr:%i addr:%#x len:%zu\n", __func__, | |
89 | sa->instr, sa->addr, len); | |
90 | ||
91 | switch (sa->instr) { | |
92 | case SIGMA_ACTION_WRITEXBYTES: | |
93 | case SIGMA_ACTION_WRITESINGLE: | |
94 | case SIGMA_ACTION_WRITESAFELOAD: | |
38fd54ee | 95 | ret = ssfw->write(ssfw->control_data, sa, len); |
e359dc24 MF |
96 | if (ret < 0) |
97 | return -EINVAL; | |
98 | break; | |
e359dc24 | 99 | case SIGMA_ACTION_DELAY: |
e359dc24 MF |
100 | udelay(len); |
101 | len = 0; | |
102 | break; | |
e359dc24 | 103 | case SIGMA_ACTION_END: |
4f718a29 | 104 | return 0; |
e359dc24 MF |
105 | default: |
106 | return -EINVAL; | |
107 | } | |
108 | ||
4f718a29 | 109 | return 1; |
e359dc24 MF |
110 | } |
111 | ||
112 | static int | |
38fd54ee | 113 | process_sigma_actions(struct sigma_firmware *ssfw) |
e359dc24 | 114 | { |
4f718a29 LPC |
115 | struct sigma_action *sa; |
116 | size_t size; | |
117 | int ret; | |
118 | ||
119 | while (ssfw->pos + sizeof(*sa) <= ssfw->fw->size) { | |
120 | sa = (struct sigma_action *)(ssfw->fw->data + ssfw->pos); | |
121 | ||
122 | size = sigma_action_size(sa); | |
123 | ssfw->pos += size; | |
124 | if (ssfw->pos > ssfw->fw->size || size == 0) | |
125 | break; | |
126 | ||
38fd54ee | 127 | ret = process_sigma_action(ssfw, sa); |
e359dc24 | 128 | |
e359dc24 | 129 | pr_debug("%s: action returned %i\n", __func__, ret); |
4f718a29 LPC |
130 | |
131 | if (ret <= 0) | |
e359dc24 MF |
132 | return ret; |
133 | } | |
4f718a29 LPC |
134 | |
135 | if (ssfw->pos != ssfw->fw->size) | |
136 | return -EINVAL; | |
137 | ||
138 | return 0; | |
e359dc24 MF |
139 | } |
140 | ||
38fd54ee LPC |
141 | static int _process_sigma_firmware(struct device *dev, |
142 | struct sigma_firmware *ssfw, const char *name) | |
e359dc24 MF |
143 | { |
144 | int ret; | |
145 | struct sigma_firmware_header *ssfw_head; | |
e359dc24 MF |
146 | const struct firmware *fw; |
147 | u32 crc; | |
148 | ||
149 | pr_debug("%s: loading firmware %s\n", __func__, name); | |
150 | ||
151 | /* first load the blob */ | |
38fd54ee | 152 | ret = request_firmware(&fw, name, dev); |
e359dc24 MF |
153 | if (ret) { |
154 | pr_debug("%s: request_firmware() failed with %i\n", __func__, ret); | |
155 | return ret; | |
156 | } | |
38fd54ee | 157 | ssfw->fw = fw; |
e359dc24 MF |
158 | |
159 | /* then verify the header */ | |
160 | ret = -EINVAL; | |
4f718a29 LPC |
161 | |
162 | /* | |
163 | * Reject too small or unreasonable large files. The upper limit has been | |
164 | * chosen a bit arbitrarily, but it should be enough for all practical | |
165 | * purposes and having the limit makes it easier to avoid integer | |
166 | * overflows later in the loading process. | |
167 | */ | |
48afc527 | 168 | if (fw->size < sizeof(*ssfw_head) || fw->size >= 0x4000000) { |
38fd54ee | 169 | dev_err(dev, "Failed to load firmware: Invalid size\n"); |
e359dc24 | 170 | goto done; |
48afc527 | 171 | } |
e359dc24 MF |
172 | |
173 | ssfw_head = (void *)fw->data; | |
48afc527 | 174 | if (memcmp(ssfw_head->magic, SIGMA_MAGIC, ARRAY_SIZE(ssfw_head->magic))) { |
38fd54ee | 175 | dev_err(dev, "Failed to load firmware: Invalid magic\n"); |
e359dc24 | 176 | goto done; |
48afc527 | 177 | } |
e359dc24 | 178 | |
c56935bd LPC |
179 | crc = crc32(0, fw->data + sizeof(*ssfw_head), |
180 | fw->size - sizeof(*ssfw_head)); | |
e359dc24 | 181 | pr_debug("%s: crc=%x\n", __func__, crc); |
48afc527 | 182 | if (crc != le32_to_cpu(ssfw_head->crc)) { |
38fd54ee | 183 | dev_err(dev, "Failed to load firmware: Wrong crc checksum: expected %x got %x\n", |
48afc527 | 184 | le32_to_cpu(ssfw_head->crc), crc); |
e359dc24 | 185 | goto done; |
48afc527 | 186 | } |
e359dc24 | 187 | |
38fd54ee | 188 | ssfw->pos = sizeof(*ssfw_head); |
e359dc24 MF |
189 | |
190 | /* finally process all of the actions */ | |
38fd54ee | 191 | ret = process_sigma_actions(ssfw); |
e359dc24 MF |
192 | |
193 | done: | |
194 | release_firmware(fw); | |
195 | ||
196 | pr_debug("%s: loaded %s\n", __func__, name); | |
197 | ||
198 | return ret; | |
199 | } | |
38fd54ee LPC |
200 | |
201 | #if IS_ENABLED(CONFIG_I2C) | |
202 | ||
203 | static int sigma_action_write_i2c(void *control_data, | |
204 | const struct sigma_action *sa, size_t len) | |
205 | { | |
206 | return i2c_master_send(control_data, (const unsigned char *)&sa->addr, | |
207 | len); | |
208 | } | |
209 | ||
210 | int process_sigma_firmware(struct i2c_client *client, const char *name) | |
211 | { | |
212 | struct sigma_firmware ssfw; | |
213 | ||
214 | ssfw.control_data = client; | |
215 | ssfw.write = sigma_action_write_i2c; | |
216 | ||
217 | return _process_sigma_firmware(&client->dev, &ssfw, name); | |
218 | } | |
e359dc24 | 219 | EXPORT_SYMBOL(process_sigma_firmware); |
27c46a25 | 220 | |
38fd54ee LPC |
221 | #endif |
222 | ||
223 | #if IS_ENABLED(CONFIG_REGMAP) | |
224 | ||
225 | static int sigma_action_write_regmap(void *control_data, | |
226 | const struct sigma_action *sa, size_t len) | |
227 | { | |
228 | return regmap_raw_write(control_data, le16_to_cpu(sa->addr), | |
229 | sa->payload, len - 2); | |
230 | } | |
231 | ||
232 | int process_sigma_firmware_regmap(struct device *dev, struct regmap *regmap, | |
233 | const char *name) | |
234 | { | |
235 | struct sigma_firmware ssfw; | |
236 | ||
237 | ssfw.control_data = regmap; | |
238 | ssfw.write = sigma_action_write_regmap; | |
239 | ||
240 | return _process_sigma_firmware(dev, &ssfw, name); | |
241 | } | |
242 | EXPORT_SYMBOL(process_sigma_firmware_regmap); | |
243 | ||
244 | #endif | |
245 | ||
27c46a25 | 246 | MODULE_LICENSE("GPL"); |