xref: /linux/sound/soc/sof/compress.c (revision c5b6285aae050ff1c3ea824ca3d88ac4be1e69c8)
1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
2 //
3 // Copyright 2021 NXP
4 //
5 // Author: Daniel Baluta <daniel.baluta@nxp.com>
6 
7 #include <sound/soc.h>
8 #include <sound/sof.h>
9 #include <sound/compress_driver.h>
10 #include "sof-audio.h"
11 #include "sof-priv.h"
12 #include "sof-utils.h"
13 #include "ops.h"
14 
15 static void sof_set_transferred_bytes(struct sof_compr_stream *sstream,
16 				      u64 host_pos, u64 buffer_size)
17 {
18 	u64 prev_pos;
19 	unsigned int copied;
20 
21 	div64_u64_rem(sstream->copied_total, buffer_size, &prev_pos);
22 
23 	if (host_pos < prev_pos)
24 		copied = (buffer_size - prev_pos) + host_pos;
25 	else
26 		copied = host_pos - prev_pos;
27 
28 	sstream->copied_total += copied;
29 }
30 
31 static void snd_sof_compr_fragment_elapsed_work(struct work_struct *work)
32 {
33 	struct snd_sof_pcm_stream *sps =
34 		container_of(work, struct snd_sof_pcm_stream,
35 			     period_elapsed_work);
36 
37 	snd_compr_fragment_elapsed(sps->cstream);
38 }
39 
40 void snd_sof_compr_init_elapsed_work(struct work_struct *work)
41 {
42 	INIT_WORK(work, snd_sof_compr_fragment_elapsed_work);
43 }
44 
45 /*
46  * sof compr fragment elapse, this could be called in irq thread context
47  */
48 void snd_sof_compr_fragment_elapsed(struct snd_compr_stream *cstream)
49 {
50 	struct snd_soc_pcm_runtime *rtd;
51 	struct snd_compr_runtime *crtd;
52 	struct snd_soc_component *component;
53 	struct sof_compr_stream *sstream;
54 	struct snd_sof_pcm *spcm;
55 
56 	if (!cstream)
57 		return;
58 
59 	rtd = cstream->private_data;
60 	crtd = cstream->runtime;
61 	sstream = crtd->private_data;
62 	component = snd_soc_rtdcom_lookup(rtd, SOF_AUDIO_PCM_DRV_NAME);
63 
64 	spcm = snd_sof_find_spcm_dai(component, rtd);
65 	if (!spcm) {
66 		dev_err(component->dev,
67 			"fragment elapsed called for unknown stream!\n");
68 		return;
69 	}
70 
71 	sof_set_transferred_bytes(sstream, spcm->stream[cstream->direction].posn.host_posn,
72 				  crtd->buffer_size);
73 
74 	/* use the same workqueue-based solution as for PCM, cf. snd_sof_pcm_elapsed */
75 	schedule_work(&spcm->stream[cstream->direction].period_elapsed_work);
76 }
77 
78 static int create_page_table(struct snd_soc_component *component,
79 			     struct snd_compr_stream *cstream,
80 			     unsigned char *dma_area, size_t size)
81 {
82 	struct snd_dma_buffer *dmab = cstream->runtime->dma_buffer_p;
83 	struct snd_soc_pcm_runtime *rtd = cstream->private_data;
84 	int dir = cstream->direction;
85 	struct snd_sof_pcm *spcm;
86 
87 	spcm = snd_sof_find_spcm_dai(component, rtd);
88 	if (!spcm)
89 		return -EINVAL;
90 
91 	return snd_sof_create_page_table(component->dev, dmab,
92 					 spcm->stream[dir].page_table.area, size);
93 }
94 
95 static int sof_compr_open(struct snd_soc_component *component,
96 			  struct snd_compr_stream *cstream)
97 {
98 	struct snd_soc_pcm_runtime *rtd = cstream->private_data;
99 	struct snd_compr_runtime *crtd = cstream->runtime;
100 	struct sof_compr_stream *sstream;
101 	struct snd_sof_pcm *spcm;
102 	int dir;
103 
104 	sstream = kzalloc_obj(*sstream);
105 	if (!sstream)
106 		return -ENOMEM;
107 
108 	spcm = snd_sof_find_spcm_dai(component, rtd);
109 	if (!spcm) {
110 		kfree(sstream);
111 		return -EINVAL;
112 	}
113 
114 	dir = cstream->direction;
115 
116 	if (spcm->stream[dir].cstream) {
117 		kfree(sstream);
118 		return -EBUSY;
119 	}
120 
121 	spcm->stream[dir].cstream = cstream;
122 	spcm->stream[dir].posn.host_posn = 0;
123 	spcm->stream[dir].posn.dai_posn = 0;
124 	spcm->prepared[dir] = false;
125 
126 	crtd->private_data = sstream;
127 
128 	return 0;
129 }
130 
131 static int sof_compr_free(struct snd_soc_component *component,
132 			  struct snd_compr_stream *cstream)
133 {
134 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
135 	struct sof_compr_stream *sstream = cstream->runtime->private_data;
136 	struct snd_soc_pcm_runtime *rtd = cstream->private_data;
137 	struct sof_ipc_stream stream;
138 	struct snd_sof_pcm *spcm;
139 	int ret = 0;
140 
141 	spcm = snd_sof_find_spcm_dai(component, rtd);
142 	if (!spcm)
143 		return -EINVAL;
144 
145 	stream.hdr.size = sizeof(stream);
146 	stream.hdr.cmd = SOF_IPC_GLB_STREAM_MSG | SOF_IPC_STREAM_PCM_FREE;
147 	stream.comp_id = spcm->stream[cstream->direction].comp_id;
148 
149 	if (spcm->prepared[cstream->direction]) {
150 		ret = sof_ipc_tx_message_no_reply(sdev->ipc, &stream, sizeof(stream));
151 		if (!ret)
152 			spcm->prepared[cstream->direction] = false;
153 	}
154 
155 	cancel_work_sync(&spcm->stream[cstream->direction].period_elapsed_work);
156 	spcm->stream[cstream->direction].cstream = NULL;
157 	kfree(sstream);
158 
159 	return ret;
160 }
161 
162 static int sof_compr_set_params(struct snd_soc_component *component,
163 				struct snd_compr_stream *cstream, struct snd_compr_params *params)
164 {
165 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
166 	struct snd_soc_pcm_runtime *rtd = cstream->private_data;
167 	struct snd_compr_runtime *crtd = cstream->runtime;
168 	struct sof_ipc_pcm_params_reply ipc_params_reply;
169 	struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
170 	struct sof_ipc_fw_version *v = &ready->version;
171 	struct sof_compr_stream *sstream;
172 	struct sof_ipc_pcm_params *pcm;
173 	struct snd_sof_pcm *spcm;
174 	size_t ext_data_size;
175 	int ret;
176 
177 	if (v->abi_version < SOF_ABI_VER(3, 22, 0)) {
178 		dev_err(component->dev,
179 			"Compress params not supported with FW ABI version %d:%d:%d\n",
180 			SOF_ABI_VERSION_MAJOR(v->abi_version),
181 			SOF_ABI_VERSION_MINOR(v->abi_version),
182 			SOF_ABI_VERSION_PATCH(v->abi_version));
183 		return -EINVAL;
184 	}
185 
186 	sstream = crtd->private_data;
187 
188 	spcm = snd_sof_find_spcm_dai(component, rtd);
189 
190 	if (!spcm)
191 		return -EINVAL;
192 
193 	ext_data_size = sizeof(params->codec);
194 
195 	if (sizeof(*pcm) + ext_data_size > sdev->ipc->max_payload_size)
196 		return -EINVAL;
197 
198 	/*
199 	 * Make sure that the DSP is booted up, which might not be the
200 	 * case if the on-demand DSP boot is used
201 	 */
202 	ret = snd_sof_boot_dsp_firmware(sdev);
203 	if (ret)
204 		return ret;
205 
206 	pcm = kzalloc(sizeof(*pcm) + ext_data_size, GFP_KERNEL);
207 	if (!pcm)
208 		return -ENOMEM;
209 
210 	cstream->dma_buffer.dev.type = SNDRV_DMA_TYPE_DEV_SG;
211 	cstream->dma_buffer.dev.dev = sdev->dev;
212 	ret = snd_compr_malloc_pages(cstream, crtd->buffer_size);
213 	if (ret < 0)
214 		goto out;
215 
216 	ret = create_page_table(component, cstream, crtd->dma_area, crtd->dma_bytes);
217 	if (ret < 0)
218 		goto out;
219 
220 	pcm->params.buffer.pages = PFN_UP(crtd->dma_bytes);
221 	pcm->hdr.size = sizeof(*pcm) + ext_data_size;
222 	pcm->hdr.cmd = SOF_IPC_GLB_STREAM_MSG | SOF_IPC_STREAM_PCM_PARAMS;
223 
224 	pcm->comp_id = spcm->stream[cstream->direction].comp_id;
225 	pcm->params.hdr.size = sizeof(pcm->params) + ext_data_size;
226 	pcm->params.buffer.phy_addr = spcm->stream[cstream->direction].page_table.addr;
227 	pcm->params.buffer.size = crtd->dma_bytes;
228 	pcm->params.direction = cstream->direction;
229 	pcm->params.channels = params->codec.ch_out;
230 	pcm->params.rate = params->codec.sample_rate;
231 	pcm->params.buffer_fmt = SOF_IPC_BUFFER_INTERLEAVED;
232 	pcm->params.frame_fmt = SOF_IPC_FRAME_S32_LE;
233 	pcm->params.sample_container_bytes =
234 		snd_pcm_format_physical_width(SNDRV_PCM_FORMAT_S32) >> 3;
235 	pcm->params.host_period_bytes = params->buffer.fragment_size;
236 	pcm->params.ext_data_length = ext_data_size;
237 
238 	memcpy((u8 *)pcm->params.ext_data, &params->codec, ext_data_size);
239 
240 	ret = sof_ipc_tx_message(sdev->ipc, pcm, sizeof(*pcm) + ext_data_size,
241 				 &ipc_params_reply, sizeof(ipc_params_reply));
242 	if (ret < 0) {
243 		dev_err(component->dev, "error ipc failed\n");
244 		goto out;
245 	}
246 
247 	ret = snd_sof_set_stream_data_offset(sdev, &spcm->stream[cstream->direction],
248 					     ipc_params_reply.posn_offset);
249 	if (ret < 0) {
250 		dev_err(component->dev, "Invalid stream data offset for Compr %u\n",
251 			le32_to_cpu(spcm->pcm.pcm_id));
252 		goto out;
253 	}
254 
255 	sstream->sampling_rate = params->codec.sample_rate;
256 	sstream->channels = params->codec.ch_out;
257 	sstream->sample_container_bytes = pcm->params.sample_container_bytes;
258 	sstream->codec_params = params->codec;
259 
260 	spcm->prepared[cstream->direction] = true;
261 
262 out:
263 	kfree(pcm);
264 
265 	return ret;
266 }
267 
268 static int sof_compr_get_params(struct snd_soc_component *component,
269 				struct snd_compr_stream *cstream, struct snd_codec *params)
270 {
271 	struct sof_compr_stream *sstream = cstream->runtime->private_data;
272 
273 	*params = sstream->codec_params;
274 
275 	return 0;
276 }
277 
278 static int sof_compr_trigger(struct snd_soc_component *component,
279 			     struct snd_compr_stream *cstream, int cmd)
280 {
281 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
282 	struct snd_soc_pcm_runtime *rtd = cstream->private_data;
283 	struct sof_ipc_stream stream;
284 	struct snd_sof_pcm *spcm;
285 
286 	spcm = snd_sof_find_spcm_dai(component, rtd);
287 	if (!spcm)
288 		return -EINVAL;
289 
290 	stream.hdr.size = sizeof(stream);
291 	stream.hdr.cmd = SOF_IPC_GLB_STREAM_MSG;
292 	stream.comp_id = spcm->stream[cstream->direction].comp_id;
293 
294 	switch (cmd) {
295 	case SNDRV_PCM_TRIGGER_START:
296 		stream.hdr.cmd |= SOF_IPC_STREAM_TRIG_START;
297 		break;
298 	case SNDRV_PCM_TRIGGER_STOP:
299 		stream.hdr.cmd |= SOF_IPC_STREAM_TRIG_STOP;
300 		break;
301 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
302 		stream.hdr.cmd |= SOF_IPC_STREAM_TRIG_PAUSE;
303 		break;
304 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
305 		stream.hdr.cmd |= SOF_IPC_STREAM_TRIG_RELEASE;
306 		break;
307 	default:
308 		dev_err(component->dev, "error: unhandled trigger cmd %d\n", cmd);
309 		break;
310 	}
311 
312 	return sof_ipc_tx_message_no_reply(sdev->ipc, &stream, sizeof(stream));
313 }
314 
315 static int sof_compr_copy_playback(struct snd_compr_runtime *rtd,
316 				   char __user *buf, size_t count)
317 {
318 	void *ptr;
319 	unsigned int offset, n;
320 	int ret;
321 
322 	div_u64_rem(rtd->total_bytes_available, rtd->buffer_size, &offset);
323 	ptr = rtd->dma_area + offset;
324 	n = rtd->buffer_size - offset;
325 
326 	if (count < n) {
327 		ret = copy_from_user(ptr, buf, count);
328 	} else {
329 		ret = copy_from_user(ptr, buf, n);
330 		ret += copy_from_user(rtd->dma_area, buf + n, count - n);
331 	}
332 
333 	return count - ret;
334 }
335 
336 static int sof_compr_copy_capture(struct snd_compr_runtime *rtd,
337 				  char __user *buf, size_t count)
338 {
339 	void *ptr;
340 	unsigned int offset, n;
341 	int ret;
342 
343 	div_u64_rem(rtd->total_bytes_transferred, rtd->buffer_size, &offset);
344 	ptr = rtd->dma_area + offset;
345 	n = rtd->buffer_size - offset;
346 
347 	if (count < n) {
348 		ret = copy_to_user(buf, ptr, count);
349 	} else {
350 		ret = copy_to_user(buf, ptr, n);
351 		ret += copy_to_user(buf + n, rtd->dma_area, count - n);
352 	}
353 
354 	return count - ret;
355 }
356 
357 static int sof_compr_copy(struct snd_soc_component *component,
358 			  struct snd_compr_stream *cstream,
359 			  char __user *buf, size_t count)
360 {
361 	struct snd_compr_runtime *rtd = cstream->runtime;
362 
363 	if (count > rtd->buffer_size)
364 		count = rtd->buffer_size;
365 
366 	if (cstream->direction == SND_COMPRESS_PLAYBACK)
367 		return sof_compr_copy_playback(rtd, buf, count);
368 	else
369 		return sof_compr_copy_capture(rtd, buf, count);
370 }
371 
372 static int sof_compr_pointer(struct snd_soc_component *component,
373 			     struct snd_compr_stream *cstream,
374 			     struct snd_compr_tstamp64 *tstamp)
375 {
376 	struct snd_sof_pcm *spcm;
377 	struct snd_soc_pcm_runtime *rtd = cstream->private_data;
378 	struct sof_compr_stream *sstream = cstream->runtime->private_data;
379 
380 	spcm = snd_sof_find_spcm_dai(component, rtd);
381 	if (!spcm)
382 		return -EINVAL;
383 
384 	if (!sstream->channels || !sstream->sample_container_bytes)
385 		return -EBUSY;
386 
387 	tstamp->sampling_rate = sstream->sampling_rate;
388 	tstamp->copied_total = sstream->copied_total;
389 	tstamp->pcm_io_frames = div_u64(spcm->stream[cstream->direction].posn.dai_posn,
390 					sstream->channels * sstream->sample_container_bytes);
391 
392 	return 0;
393 }
394 
395 struct snd_compress_ops sof_compressed_ops = {
396 	.open		= sof_compr_open,
397 	.free		= sof_compr_free,
398 	.set_params	= sof_compr_set_params,
399 	.get_params	= sof_compr_get_params,
400 	.trigger	= sof_compr_trigger,
401 	.pointer	= sof_compr_pointer,
402 	.copy		= sof_compr_copy,
403 };
404 EXPORT_SYMBOL(sof_compressed_ops);
405