• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Intel Smart Sound Technology (SST) DSP Core Driver
3  *
4  * Copyright (C) 2013, Intel Corporation. All rights reserved.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License version
8  * 2 as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  */
16 
17 #include <linux/slab.h>
18 #include <linux/export.h>
19 #include <linux/interrupt.h>
20 #include <linux/module.h>
21 #include <linux/platform_device.h>
22 #include <linux/io.h>
23 
24 #include "sst-dsp.h"
25 #include "sst-dsp-priv.h"
26 
27 #define CREATE_TRACE_POINTS
28 #include <trace/events/intel-sst.h>
29 
30 /* Internal generic low-level SST IO functions - can be overidden */
sst_shim32_write(void __iomem * addr,u32 offset,u32 value)31 void sst_shim32_write(void __iomem *addr, u32 offset, u32 value)
32 {
33 	writel(value, addr + offset);
34 }
35 EXPORT_SYMBOL_GPL(sst_shim32_write);
36 
sst_shim32_read(void __iomem * addr,u32 offset)37 u32 sst_shim32_read(void __iomem *addr, u32 offset)
38 {
39 	return readl(addr + offset);
40 }
41 EXPORT_SYMBOL_GPL(sst_shim32_read);
42 
sst_shim32_write64(void __iomem * addr,u32 offset,u64 value)43 void sst_shim32_write64(void __iomem *addr, u32 offset, u64 value)
44 {
45 	memcpy_toio(addr + offset, &value, sizeof(value));
46 }
47 EXPORT_SYMBOL_GPL(sst_shim32_write64);
48 
sst_shim32_read64(void __iomem * addr,u32 offset)49 u64 sst_shim32_read64(void __iomem *addr, u32 offset)
50 {
51 	u64 val;
52 
53 	memcpy_fromio(&val, addr + offset, sizeof(val));
54 	return val;
55 }
56 EXPORT_SYMBOL_GPL(sst_shim32_read64);
57 
_sst_memcpy_toio_32(volatile u32 __iomem * dest,u32 * src,size_t bytes)58 static inline void _sst_memcpy_toio_32(volatile u32 __iomem *dest,
59 	u32 *src, size_t bytes)
60 {
61 	int i, words = bytes >> 2;
62 
63 	for (i = 0; i < words; i++)
64 		writel(src[i], dest + i);
65 }
66 
_sst_memcpy_fromio_32(u32 * dest,const volatile __iomem u32 * src,size_t bytes)67 static inline void _sst_memcpy_fromio_32(u32 *dest,
68 	const volatile __iomem u32 *src, size_t bytes)
69 {
70 	int i, words = bytes >> 2;
71 
72 	for (i = 0; i < words; i++)
73 		dest[i] = readl(src + i);
74 }
75 
sst_memcpy_toio_32(struct sst_dsp * sst,void __iomem * dest,void * src,size_t bytes)76 void sst_memcpy_toio_32(struct sst_dsp *sst,
77 	void __iomem *dest, void *src, size_t bytes)
78 {
79 	_sst_memcpy_toio_32(dest, src, bytes);
80 }
81 EXPORT_SYMBOL_GPL(sst_memcpy_toio_32);
82 
sst_memcpy_fromio_32(struct sst_dsp * sst,void * dest,void __iomem * src,size_t bytes)83 void sst_memcpy_fromio_32(struct sst_dsp *sst, void *dest,
84 	void __iomem *src, size_t bytes)
85 {
86 	_sst_memcpy_fromio_32(dest, src, bytes);
87 }
88 EXPORT_SYMBOL_GPL(sst_memcpy_fromio_32);
89 
90 /* Public API */
sst_dsp_shim_write(struct sst_dsp * sst,u32 offset,u32 value)91 void sst_dsp_shim_write(struct sst_dsp *sst, u32 offset, u32 value)
92 {
93 	unsigned long flags;
94 
95 	spin_lock_irqsave(&sst->spinlock, flags);
96 	sst->ops->write(sst->addr.shim, offset, value);
97 	spin_unlock_irqrestore(&sst->spinlock, flags);
98 }
99 EXPORT_SYMBOL_GPL(sst_dsp_shim_write);
100 
sst_dsp_shim_read(struct sst_dsp * sst,u32 offset)101 u32 sst_dsp_shim_read(struct sst_dsp *sst, u32 offset)
102 {
103 	unsigned long flags;
104 	u32 val;
105 
106 	spin_lock_irqsave(&sst->spinlock, flags);
107 	val = sst->ops->read(sst->addr.shim, offset);
108 	spin_unlock_irqrestore(&sst->spinlock, flags);
109 
110 	return val;
111 }
112 EXPORT_SYMBOL_GPL(sst_dsp_shim_read);
113 
sst_dsp_shim_write64(struct sst_dsp * sst,u32 offset,u64 value)114 void sst_dsp_shim_write64(struct sst_dsp *sst, u32 offset, u64 value)
115 {
116 	unsigned long flags;
117 
118 	spin_lock_irqsave(&sst->spinlock, flags);
119 	sst->ops->write64(sst->addr.shim, offset, value);
120 	spin_unlock_irqrestore(&sst->spinlock, flags);
121 }
122 EXPORT_SYMBOL_GPL(sst_dsp_shim_write64);
123 
sst_dsp_shim_read64(struct sst_dsp * sst,u32 offset)124 u64 sst_dsp_shim_read64(struct sst_dsp *sst, u32 offset)
125 {
126 	unsigned long flags;
127 	u64 val;
128 
129 	spin_lock_irqsave(&sst->spinlock, flags);
130 	val = sst->ops->read64(sst->addr.shim, offset);
131 	spin_unlock_irqrestore(&sst->spinlock, flags);
132 
133 	return val;
134 }
135 EXPORT_SYMBOL_GPL(sst_dsp_shim_read64);
136 
sst_dsp_shim_write_unlocked(struct sst_dsp * sst,u32 offset,u32 value)137 void sst_dsp_shim_write_unlocked(struct sst_dsp *sst, u32 offset, u32 value)
138 {
139 	sst->ops->write(sst->addr.shim, offset, value);
140 }
141 EXPORT_SYMBOL_GPL(sst_dsp_shim_write_unlocked);
142 
sst_dsp_shim_read_unlocked(struct sst_dsp * sst,u32 offset)143 u32 sst_dsp_shim_read_unlocked(struct sst_dsp *sst, u32 offset)
144 {
145 	return sst->ops->read(sst->addr.shim, offset);
146 }
147 EXPORT_SYMBOL_GPL(sst_dsp_shim_read_unlocked);
148 
sst_dsp_shim_write64_unlocked(struct sst_dsp * sst,u32 offset,u64 value)149 void sst_dsp_shim_write64_unlocked(struct sst_dsp *sst, u32 offset, u64 value)
150 {
151 	sst->ops->write64(sst->addr.shim, offset, value);
152 }
153 EXPORT_SYMBOL_GPL(sst_dsp_shim_write64_unlocked);
154 
sst_dsp_shim_read64_unlocked(struct sst_dsp * sst,u32 offset)155 u64 sst_dsp_shim_read64_unlocked(struct sst_dsp *sst, u32 offset)
156 {
157 	return sst->ops->read64(sst->addr.shim, offset);
158 }
159 EXPORT_SYMBOL_GPL(sst_dsp_shim_read64_unlocked);
160 
sst_dsp_shim_update_bits_unlocked(struct sst_dsp * sst,u32 offset,u32 mask,u32 value)161 int sst_dsp_shim_update_bits_unlocked(struct sst_dsp *sst, u32 offset,
162 				u32 mask, u32 value)
163 {
164 	bool change;
165 	unsigned int old, new;
166 	u32 ret;
167 
168 	ret = sst_dsp_shim_read_unlocked(sst, offset);
169 
170 	old = ret;
171 	new = (old & (~mask)) | (value & mask);
172 
173 	change = (old != new);
174 	if (change)
175 		sst_dsp_shim_write_unlocked(sst, offset, new);
176 
177 	return change;
178 }
179 EXPORT_SYMBOL_GPL(sst_dsp_shim_update_bits_unlocked);
180 
sst_dsp_shim_update_bits64_unlocked(struct sst_dsp * sst,u32 offset,u64 mask,u64 value)181 int sst_dsp_shim_update_bits64_unlocked(struct sst_dsp *sst, u32 offset,
182 				u64 mask, u64 value)
183 {
184 	bool change;
185 	u64 old, new;
186 
187 	old = sst_dsp_shim_read64_unlocked(sst, offset);
188 
189 	new = (old & (~mask)) | (value & mask);
190 
191 	change = (old != new);
192 	if (change)
193 		sst_dsp_shim_write64_unlocked(sst, offset, new);
194 
195 	return change;
196 }
197 EXPORT_SYMBOL_GPL(sst_dsp_shim_update_bits64_unlocked);
198 
sst_dsp_shim_update_bits(struct sst_dsp * sst,u32 offset,u32 mask,u32 value)199 int sst_dsp_shim_update_bits(struct sst_dsp *sst, u32 offset,
200 				u32 mask, u32 value)
201 {
202 	unsigned long flags;
203 	bool change;
204 
205 	spin_lock_irqsave(&sst->spinlock, flags);
206 	change = sst_dsp_shim_update_bits_unlocked(sst, offset, mask, value);
207 	spin_unlock_irqrestore(&sst->spinlock, flags);
208 	return change;
209 }
210 EXPORT_SYMBOL_GPL(sst_dsp_shim_update_bits);
211 
sst_dsp_shim_update_bits64(struct sst_dsp * sst,u32 offset,u64 mask,u64 value)212 int sst_dsp_shim_update_bits64(struct sst_dsp *sst, u32 offset,
213 				u64 mask, u64 value)
214 {
215 	unsigned long flags;
216 	bool change;
217 
218 	spin_lock_irqsave(&sst->spinlock, flags);
219 	change = sst_dsp_shim_update_bits64_unlocked(sst, offset, mask, value);
220 	spin_unlock_irqrestore(&sst->spinlock, flags);
221 	return change;
222 }
223 EXPORT_SYMBOL_GPL(sst_dsp_shim_update_bits64);
224 
sst_dsp_dump(struct sst_dsp * sst)225 void sst_dsp_dump(struct sst_dsp *sst)
226 {
227 	if (sst->ops->dump)
228 		sst->ops->dump(sst);
229 }
230 EXPORT_SYMBOL_GPL(sst_dsp_dump);
231 
sst_dsp_reset(struct sst_dsp * sst)232 void sst_dsp_reset(struct sst_dsp *sst)
233 {
234 	if (sst->ops->reset)
235 		sst->ops->reset(sst);
236 }
237 EXPORT_SYMBOL_GPL(sst_dsp_reset);
238 
sst_dsp_boot(struct sst_dsp * sst)239 int sst_dsp_boot(struct sst_dsp *sst)
240 {
241 	if (sst->ops->boot)
242 		sst->ops->boot(sst);
243 
244 	return 0;
245 }
246 EXPORT_SYMBOL_GPL(sst_dsp_boot);
247 
sst_dsp_ipc_msg_tx(struct sst_dsp * dsp,u32 msg)248 void sst_dsp_ipc_msg_tx(struct sst_dsp *dsp, u32 msg)
249 {
250 	sst_dsp_shim_write_unlocked(dsp, SST_IPCX, msg | SST_IPCX_BUSY);
251 	trace_sst_ipc_msg_tx(msg);
252 }
253 EXPORT_SYMBOL_GPL(sst_dsp_ipc_msg_tx);
254 
sst_dsp_ipc_msg_rx(struct sst_dsp * dsp)255 u32 sst_dsp_ipc_msg_rx(struct sst_dsp *dsp)
256 {
257 	u32 msg;
258 
259 	msg = sst_dsp_shim_read_unlocked(dsp, SST_IPCX);
260 	trace_sst_ipc_msg_rx(msg);
261 
262 	return msg;
263 }
264 EXPORT_SYMBOL_GPL(sst_dsp_ipc_msg_rx);
265 
sst_dsp_mailbox_init(struct sst_dsp * sst,u32 inbox_offset,size_t inbox_size,u32 outbox_offset,size_t outbox_size)266 int sst_dsp_mailbox_init(struct sst_dsp *sst, u32 inbox_offset, size_t inbox_size,
267 	u32 outbox_offset, size_t outbox_size)
268 {
269 	sst->mailbox.in_base = sst->addr.lpe + inbox_offset;
270 	sst->mailbox.out_base = sst->addr.lpe + outbox_offset;
271 	sst->mailbox.in_size = inbox_size;
272 	sst->mailbox.out_size = outbox_size;
273 	return 0;
274 }
275 EXPORT_SYMBOL_GPL(sst_dsp_mailbox_init);
276 
sst_dsp_outbox_write(struct sst_dsp * sst,void * message,size_t bytes)277 void sst_dsp_outbox_write(struct sst_dsp *sst, void *message, size_t bytes)
278 {
279 	u32 i;
280 
281 	trace_sst_ipc_outbox_write(bytes);
282 
283 	memcpy_toio(sst->mailbox.out_base, message, bytes);
284 
285 	for (i = 0; i < bytes; i += 4)
286 		trace_sst_ipc_outbox_wdata(i, *(u32 *)(message + i));
287 }
288 EXPORT_SYMBOL_GPL(sst_dsp_outbox_write);
289 
sst_dsp_outbox_read(struct sst_dsp * sst,void * message,size_t bytes)290 void sst_dsp_outbox_read(struct sst_dsp *sst, void *message, size_t bytes)
291 {
292 	u32 i;
293 
294 	trace_sst_ipc_outbox_read(bytes);
295 
296 	memcpy_fromio(message, sst->mailbox.out_base, bytes);
297 
298 	for (i = 0; i < bytes; i += 4)
299 		trace_sst_ipc_outbox_rdata(i, *(u32 *)(message + i));
300 }
301 EXPORT_SYMBOL_GPL(sst_dsp_outbox_read);
302 
sst_dsp_inbox_write(struct sst_dsp * sst,void * message,size_t bytes)303 void sst_dsp_inbox_write(struct sst_dsp *sst, void *message, size_t bytes)
304 {
305 	u32 i;
306 
307 	trace_sst_ipc_inbox_write(bytes);
308 
309 	memcpy_toio(sst->mailbox.in_base, message, bytes);
310 
311 	for (i = 0; i < bytes; i += 4)
312 		trace_sst_ipc_inbox_wdata(i, *(u32 *)(message + i));
313 }
314 EXPORT_SYMBOL_GPL(sst_dsp_inbox_write);
315 
sst_dsp_inbox_read(struct sst_dsp * sst,void * message,size_t bytes)316 void sst_dsp_inbox_read(struct sst_dsp *sst, void *message, size_t bytes)
317 {
318 	u32 i;
319 
320 	trace_sst_ipc_inbox_read(bytes);
321 
322 	memcpy_fromio(message, sst->mailbox.in_base, bytes);
323 
324 	for (i = 0; i < bytes; i += 4)
325 		trace_sst_ipc_inbox_rdata(i, *(u32 *)(message + i));
326 }
327 EXPORT_SYMBOL_GPL(sst_dsp_inbox_read);
328 
sst_dsp_new(struct device * dev,struct sst_dsp_device * sst_dev,struct sst_pdata * pdata)329 struct sst_dsp *sst_dsp_new(struct device *dev,
330 	struct sst_dsp_device *sst_dev, struct sst_pdata *pdata)
331 {
332 	struct sst_dsp *sst;
333 	int err;
334 
335 	dev_dbg(dev, "initialising audio DSP id 0x%x\n", pdata->id);
336 
337 	sst = devm_kzalloc(dev, sizeof(*sst), GFP_KERNEL);
338 	if (sst == NULL)
339 		return NULL;
340 
341 	spin_lock_init(&sst->spinlock);
342 	mutex_init(&sst->mutex);
343 	sst->dev = dev;
344 	sst->dma_dev = pdata->dma_dev;
345 	sst->thread_context = sst_dev->thread_context;
346 	sst->sst_dev = sst_dev;
347 	sst->id = pdata->id;
348 	sst->irq = pdata->irq;
349 	sst->ops = sst_dev->ops;
350 	sst->pdata = pdata;
351 	INIT_LIST_HEAD(&sst->used_block_list);
352 	INIT_LIST_HEAD(&sst->free_block_list);
353 	INIT_LIST_HEAD(&sst->module_list);
354 	INIT_LIST_HEAD(&sst->fw_list);
355 
356 	/* Initialise SST Audio DSP */
357 	if (sst->ops->init) {
358 		err = sst->ops->init(sst, pdata);
359 		if (err < 0)
360 			return NULL;
361 	}
362 
363 	/* Register the ISR */
364 	err = request_threaded_irq(sst->irq, sst->ops->irq_handler,
365 		sst_dev->thread, IRQF_SHARED, "AudioDSP", sst);
366 	if (err)
367 		goto irq_err;
368 
369 	return sst;
370 
371 irq_err:
372 	if (sst->ops->free)
373 		sst->ops->free(sst);
374 
375 	return NULL;
376 }
377 EXPORT_SYMBOL_GPL(sst_dsp_new);
378 
sst_dsp_free(struct sst_dsp * sst)379 void sst_dsp_free(struct sst_dsp *sst)
380 {
381 	free_irq(sst->irq, sst);
382 	if (sst->ops->free)
383 		sst->ops->free(sst);
384 }
385 EXPORT_SYMBOL_GPL(sst_dsp_free);
386 
387 /* Module information */
388 MODULE_AUTHOR("Liam Girdwood");
389 MODULE_DESCRIPTION("Intel SST Core");
390 MODULE_LICENSE("GPL v2");
391