xref: /linux/sound/xen/xen_snd_front_alsa.c (revision 32a92f8c89326985e05dce8b22d3f0aa07a3e1bd)
1 // SPDX-License-Identifier: GPL-2.0 OR MIT
2 
3 /*
4  * Xen para-virtual sound device
5  *
6  * Copyright (C) 2016-2018 EPAM Systems Inc.
7  *
8  * Author: Oleksandr Andrushchenko <oleksandr_andrushchenko@epam.com>
9  */
10 
11 #include <linux/platform_device.h>
12 
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/pcm_params.h>
16 
17 #include <xen/xenbus.h>
18 #include <xen/xen-front-pgdir-shbuf.h>
19 
20 #include "xen_snd_front.h"
21 #include "xen_snd_front_alsa.h"
22 #include "xen_snd_front_cfg.h"
23 #include "xen_snd_front_evtchnl.h"
24 
25 struct xen_snd_front_pcm_stream_info {
26 	struct xen_snd_front_info *front_info;
27 	struct xen_snd_front_evtchnl_pair *evt_pair;
28 
29 	/* This is the shared buffer with its backing storage. */
30 	struct xen_front_pgdir_shbuf shbuf;
31 	u8 *buffer;
32 	size_t buffer_sz;
33 	int num_pages;
34 	struct page **pages;
35 
36 	int index;
37 
38 	bool is_open;
39 	struct snd_pcm_hardware pcm_hw;
40 
41 	/* Number of processed frames as reported by the backend. */
42 	snd_pcm_uframes_t be_cur_frame;
43 	/* Current HW pointer to be reported via .period callback. */
44 	atomic_t hw_ptr;
45 	/* Modulo of the number of processed frames - for period detection. */
46 	u32 out_frames;
47 };
48 
49 struct xen_snd_front_pcm_instance_info {
50 	struct xen_snd_front_card_info *card_info;
51 	struct snd_pcm *pcm;
52 	struct snd_pcm_hardware pcm_hw;
53 	int num_pcm_streams_pb;
54 	struct xen_snd_front_pcm_stream_info *streams_pb;
55 	int num_pcm_streams_cap;
56 	struct xen_snd_front_pcm_stream_info *streams_cap;
57 };
58 
59 struct xen_snd_front_card_info {
60 	struct xen_snd_front_info *front_info;
61 	struct snd_card *card;
62 	struct snd_pcm_hardware pcm_hw;
63 	int num_pcm_instances;
64 	struct xen_snd_front_pcm_instance_info *pcm_instances;
65 };
66 
67 struct alsa_sndif_sample_format {
68 	u8 sndif;
69 	snd_pcm_format_t alsa;
70 };
71 
72 static const struct alsa_sndif_sample_format ALSA_SNDIF_FORMATS[] = {
73 	{
74 		.sndif = XENSND_PCM_FORMAT_U8,
75 		.alsa = SNDRV_PCM_FORMAT_U8
76 	},
77 	{
78 		.sndif = XENSND_PCM_FORMAT_S8,
79 		.alsa = SNDRV_PCM_FORMAT_S8
80 	},
81 	{
82 		.sndif = XENSND_PCM_FORMAT_U16_LE,
83 		.alsa = SNDRV_PCM_FORMAT_U16_LE
84 	},
85 	{
86 		.sndif = XENSND_PCM_FORMAT_U16_BE,
87 		.alsa = SNDRV_PCM_FORMAT_U16_BE
88 	},
89 	{
90 		.sndif = XENSND_PCM_FORMAT_S16_LE,
91 		.alsa = SNDRV_PCM_FORMAT_S16_LE
92 	},
93 	{
94 		.sndif = XENSND_PCM_FORMAT_S16_BE,
95 		.alsa = SNDRV_PCM_FORMAT_S16_BE
96 	},
97 	{
98 		.sndif = XENSND_PCM_FORMAT_U24_LE,
99 		.alsa = SNDRV_PCM_FORMAT_U24_LE
100 	},
101 	{
102 		.sndif = XENSND_PCM_FORMAT_U24_BE,
103 		.alsa = SNDRV_PCM_FORMAT_U24_BE
104 	},
105 	{
106 		.sndif = XENSND_PCM_FORMAT_S24_LE,
107 		.alsa = SNDRV_PCM_FORMAT_S24_LE
108 	},
109 	{
110 		.sndif = XENSND_PCM_FORMAT_S24_BE,
111 		.alsa = SNDRV_PCM_FORMAT_S24_BE
112 	},
113 	{
114 		.sndif = XENSND_PCM_FORMAT_U32_LE,
115 		.alsa = SNDRV_PCM_FORMAT_U32_LE
116 	},
117 	{
118 		.sndif = XENSND_PCM_FORMAT_U32_BE,
119 		.alsa = SNDRV_PCM_FORMAT_U32_BE
120 	},
121 	{
122 		.sndif = XENSND_PCM_FORMAT_S32_LE,
123 		.alsa = SNDRV_PCM_FORMAT_S32_LE
124 	},
125 	{
126 		.sndif = XENSND_PCM_FORMAT_S32_BE,
127 		.alsa = SNDRV_PCM_FORMAT_S32_BE
128 	},
129 	{
130 		.sndif = XENSND_PCM_FORMAT_A_LAW,
131 		.alsa = SNDRV_PCM_FORMAT_A_LAW
132 	},
133 	{
134 		.sndif = XENSND_PCM_FORMAT_MU_LAW,
135 		.alsa = SNDRV_PCM_FORMAT_MU_LAW
136 	},
137 	{
138 		.sndif = XENSND_PCM_FORMAT_F32_LE,
139 		.alsa = SNDRV_PCM_FORMAT_FLOAT_LE
140 	},
141 	{
142 		.sndif = XENSND_PCM_FORMAT_F32_BE,
143 		.alsa = SNDRV_PCM_FORMAT_FLOAT_BE
144 	},
145 	{
146 		.sndif = XENSND_PCM_FORMAT_F64_LE,
147 		.alsa = SNDRV_PCM_FORMAT_FLOAT64_LE
148 	},
149 	{
150 		.sndif = XENSND_PCM_FORMAT_F64_BE,
151 		.alsa = SNDRV_PCM_FORMAT_FLOAT64_BE
152 	},
153 	{
154 		.sndif = XENSND_PCM_FORMAT_IEC958_SUBFRAME_LE,
155 		.alsa = SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE
156 	},
157 	{
158 		.sndif = XENSND_PCM_FORMAT_IEC958_SUBFRAME_BE,
159 		.alsa = SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE
160 	},
161 	{
162 		.sndif = XENSND_PCM_FORMAT_IMA_ADPCM,
163 		.alsa = SNDRV_PCM_FORMAT_IMA_ADPCM
164 	},
165 	{
166 		.sndif = XENSND_PCM_FORMAT_MPEG,
167 		.alsa = SNDRV_PCM_FORMAT_MPEG
168 	},
169 	{
170 		.sndif = XENSND_PCM_FORMAT_GSM,
171 		.alsa = SNDRV_PCM_FORMAT_GSM
172 	},
173 };
174 
to_sndif_format(snd_pcm_format_t format)175 static int to_sndif_format(snd_pcm_format_t format)
176 {
177 	int i;
178 
179 	for (i = 0; i < ARRAY_SIZE(ALSA_SNDIF_FORMATS); i++)
180 		if (ALSA_SNDIF_FORMATS[i].alsa == format)
181 			return ALSA_SNDIF_FORMATS[i].sndif;
182 
183 	return -EINVAL;
184 }
185 
to_sndif_formats_mask(u64 alsa_formats)186 static u64 to_sndif_formats_mask(u64 alsa_formats)
187 {
188 	u64 mask;
189 	int i;
190 
191 	mask = 0;
192 	for (i = 0; i < ARRAY_SIZE(ALSA_SNDIF_FORMATS); i++)
193 		if (pcm_format_to_bits(ALSA_SNDIF_FORMATS[i].alsa) & alsa_formats)
194 			mask |= BIT_ULL(ALSA_SNDIF_FORMATS[i].sndif);
195 
196 	return mask;
197 }
198 
to_alsa_formats_mask(u64 sndif_formats)199 static u64 to_alsa_formats_mask(u64 sndif_formats)
200 {
201 	u64 mask;
202 	int i;
203 
204 	mask = 0;
205 	for (i = 0; i < ARRAY_SIZE(ALSA_SNDIF_FORMATS); i++)
206 		if (BIT_ULL(ALSA_SNDIF_FORMATS[i].sndif) & sndif_formats)
207 			mask |= pcm_format_to_bits(ALSA_SNDIF_FORMATS[i].alsa);
208 
209 	return mask;
210 }
211 
stream_clear(struct xen_snd_front_pcm_stream_info * stream)212 static void stream_clear(struct xen_snd_front_pcm_stream_info *stream)
213 {
214 	stream->is_open = false;
215 	stream->be_cur_frame = 0;
216 	stream->out_frames = 0;
217 	atomic_set(&stream->hw_ptr, 0);
218 	xen_snd_front_evtchnl_pair_clear(stream->evt_pair);
219 	memset(&stream->shbuf, 0, sizeof(stream->shbuf));
220 	stream->buffer = NULL;
221 	stream->buffer_sz = 0;
222 	stream->pages = NULL;
223 	stream->num_pages = 0;
224 }
225 
stream_free(struct xen_snd_front_pcm_stream_info * stream)226 static void stream_free(struct xen_snd_front_pcm_stream_info *stream)
227 {
228 	xen_front_pgdir_shbuf_unmap(&stream->shbuf);
229 	xen_front_pgdir_shbuf_free(&stream->shbuf);
230 	if (stream->buffer)
231 		free_pages_exact(stream->buffer, stream->buffer_sz);
232 	kfree(stream->pages);
233 	stream_clear(stream);
234 }
235 
236 static struct xen_snd_front_pcm_stream_info *
stream_get(struct snd_pcm_substream * substream)237 stream_get(struct snd_pcm_substream *substream)
238 {
239 	struct xen_snd_front_pcm_instance_info *pcm_instance =
240 			snd_pcm_substream_chip(substream);
241 	struct xen_snd_front_pcm_stream_info *stream;
242 
243 	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
244 		stream = &pcm_instance->streams_pb[substream->number];
245 	else
246 		stream = &pcm_instance->streams_cap[substream->number];
247 
248 	return stream;
249 }
250 
alsa_hw_rule(struct snd_pcm_hw_params * params,struct snd_pcm_hw_rule * rule)251 static int alsa_hw_rule(struct snd_pcm_hw_params *params,
252 			struct snd_pcm_hw_rule *rule)
253 {
254 	struct xen_snd_front_pcm_stream_info *stream = rule->private;
255 	struct device *dev = &stream->front_info->xb_dev->dev;
256 	struct snd_mask *formats =
257 			hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
258 	struct snd_interval *rates =
259 			hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
260 	struct snd_interval *channels =
261 			hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
262 	struct snd_interval *period =
263 			hw_param_interval(params,
264 					  SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
265 	struct snd_interval *buffer =
266 			hw_param_interval(params,
267 					  SNDRV_PCM_HW_PARAM_BUFFER_SIZE);
268 	struct xensnd_query_hw_param req;
269 	struct xensnd_query_hw_param resp;
270 	struct snd_interval interval;
271 	struct snd_mask mask;
272 	u64 sndif_formats;
273 	int changed, ret;
274 
275 	/* Collect all the values we need for the query. */
276 
277 	req.formats = to_sndif_formats_mask((u64)formats->bits[0] |
278 					    (u64)(formats->bits[1]) << 32);
279 
280 	req.rates.min = rates->min;
281 	req.rates.max = rates->max;
282 
283 	req.channels.min = channels->min;
284 	req.channels.max = channels->max;
285 
286 	req.buffer.min = buffer->min;
287 	req.buffer.max = buffer->max;
288 
289 	req.period.min = period->min;
290 	req.period.max = period->max;
291 
292 	ret = xen_snd_front_stream_query_hw_param(&stream->evt_pair->req,
293 						  &req, &resp);
294 	if (ret < 0) {
295 		/* Check if this is due to backend communication error. */
296 		if (ret == -EIO || ret == -ETIMEDOUT)
297 			dev_err(dev, "Failed to query ALSA HW parameters\n");
298 		return ret;
299 	}
300 
301 	/* Refine HW parameters after the query. */
302 	changed  = 0;
303 
304 	sndif_formats = to_alsa_formats_mask(resp.formats);
305 	snd_mask_none(&mask);
306 	mask.bits[0] = (u32)sndif_formats;
307 	mask.bits[1] = (u32)(sndif_formats >> 32);
308 	ret = snd_mask_refine(formats, &mask);
309 	if (ret < 0)
310 		return ret;
311 	changed |= ret;
312 
313 	interval.openmin = 0;
314 	interval.openmax = 0;
315 	interval.integer = 1;
316 
317 	interval.min = resp.rates.min;
318 	interval.max = resp.rates.max;
319 	ret = snd_interval_refine(rates, &interval);
320 	if (ret < 0)
321 		return ret;
322 	changed |= ret;
323 
324 	interval.min = resp.channels.min;
325 	interval.max = resp.channels.max;
326 	ret = snd_interval_refine(channels, &interval);
327 	if (ret < 0)
328 		return ret;
329 	changed |= ret;
330 
331 	interval.min = resp.buffer.min;
332 	interval.max = resp.buffer.max;
333 	ret = snd_interval_refine(buffer, &interval);
334 	if (ret < 0)
335 		return ret;
336 	changed |= ret;
337 
338 	interval.min = resp.period.min;
339 	interval.max = resp.period.max;
340 	ret = snd_interval_refine(period, &interval);
341 	if (ret < 0)
342 		return ret;
343 	changed |= ret;
344 
345 	return changed;
346 }
347 
alsa_open(struct snd_pcm_substream * substream)348 static int alsa_open(struct snd_pcm_substream *substream)
349 {
350 	struct xen_snd_front_pcm_instance_info *pcm_instance =
351 			snd_pcm_substream_chip(substream);
352 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
353 	struct snd_pcm_runtime *runtime = substream->runtime;
354 	struct xen_snd_front_info *front_info =
355 			pcm_instance->card_info->front_info;
356 	struct device *dev = &front_info->xb_dev->dev;
357 	int ret;
358 
359 	/*
360 	 * Return our HW properties: override defaults with those configured
361 	 * via XenStore.
362 	 */
363 	runtime->hw = stream->pcm_hw;
364 	runtime->hw.info &= ~(SNDRV_PCM_INFO_MMAP |
365 			      SNDRV_PCM_INFO_MMAP_VALID |
366 			      SNDRV_PCM_INFO_DOUBLE |
367 			      SNDRV_PCM_INFO_BATCH |
368 			      SNDRV_PCM_INFO_NONINTERLEAVED |
369 			      SNDRV_PCM_INFO_RESUME |
370 			      SNDRV_PCM_INFO_PAUSE);
371 	runtime->hw.info |= SNDRV_PCM_INFO_INTERLEAVED;
372 
373 	stream->evt_pair = &front_info->evt_pairs[stream->index];
374 
375 	stream->front_info = front_info;
376 
377 	stream->evt_pair->evt.u.evt.substream = substream;
378 
379 	stream_clear(stream);
380 
381 	xen_snd_front_evtchnl_pair_set_connected(stream->evt_pair, true);
382 
383 	ret = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
384 				  alsa_hw_rule, stream,
385 				  SNDRV_PCM_HW_PARAM_FORMAT, -1);
386 	if (ret) {
387 		dev_err(dev, "Failed to add HW rule for SNDRV_PCM_HW_PARAM_FORMAT\n");
388 		return ret;
389 	}
390 
391 	ret = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
392 				  alsa_hw_rule, stream,
393 				  SNDRV_PCM_HW_PARAM_RATE, -1);
394 	if (ret) {
395 		dev_err(dev, "Failed to add HW rule for SNDRV_PCM_HW_PARAM_RATE\n");
396 		return ret;
397 	}
398 
399 	ret = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
400 				  alsa_hw_rule, stream,
401 				  SNDRV_PCM_HW_PARAM_CHANNELS, -1);
402 	if (ret) {
403 		dev_err(dev, "Failed to add HW rule for SNDRV_PCM_HW_PARAM_CHANNELS\n");
404 		return ret;
405 	}
406 
407 	ret = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
408 				  alsa_hw_rule, stream,
409 				  SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
410 	if (ret) {
411 		dev_err(dev, "Failed to add HW rule for SNDRV_PCM_HW_PARAM_PERIOD_SIZE\n");
412 		return ret;
413 	}
414 
415 	ret = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
416 				  alsa_hw_rule, stream,
417 				  SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
418 	if (ret) {
419 		dev_err(dev, "Failed to add HW rule for SNDRV_PCM_HW_PARAM_BUFFER_SIZE\n");
420 		return ret;
421 	}
422 
423 	return 0;
424 }
425 
alsa_close(struct snd_pcm_substream * substream)426 static int alsa_close(struct snd_pcm_substream *substream)
427 {
428 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
429 
430 	xen_snd_front_evtchnl_pair_set_connected(stream->evt_pair, false);
431 	return 0;
432 }
433 
shbuf_setup_backstore(struct xen_snd_front_pcm_stream_info * stream,size_t buffer_sz)434 static int shbuf_setup_backstore(struct xen_snd_front_pcm_stream_info *stream,
435 				 size_t buffer_sz)
436 {
437 	int i;
438 
439 	stream->buffer = alloc_pages_exact(buffer_sz, GFP_KERNEL);
440 	if (!stream->buffer)
441 		return -ENOMEM;
442 
443 	stream->buffer_sz = buffer_sz;
444 	stream->num_pages = DIV_ROUND_UP(stream->buffer_sz, PAGE_SIZE);
445 	stream->pages = kzalloc_objs(struct page *, stream->num_pages);
446 	if (!stream->pages)
447 		return -ENOMEM;
448 
449 	for (i = 0; i < stream->num_pages; i++)
450 		stream->pages[i] = virt_to_page(stream->buffer + i * PAGE_SIZE);
451 
452 	return 0;
453 }
454 
alsa_hw_params(struct snd_pcm_substream * substream,struct snd_pcm_hw_params * params)455 static int alsa_hw_params(struct snd_pcm_substream *substream,
456 			  struct snd_pcm_hw_params *params)
457 {
458 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
459 	struct xen_snd_front_info *front_info = stream->front_info;
460 	struct xen_front_pgdir_shbuf_cfg buf_cfg;
461 	int ret;
462 
463 	/*
464 	 * This callback may be called multiple times,
465 	 * so free the previously allocated shared buffer if any.
466 	 */
467 	stream_free(stream);
468 	ret = shbuf_setup_backstore(stream, params_buffer_bytes(params));
469 	if (ret < 0)
470 		goto fail;
471 
472 	memset(&buf_cfg, 0, sizeof(buf_cfg));
473 	buf_cfg.xb_dev = front_info->xb_dev;
474 	buf_cfg.pgdir = &stream->shbuf;
475 	buf_cfg.num_pages = stream->num_pages;
476 	buf_cfg.pages = stream->pages;
477 
478 	ret = xen_front_pgdir_shbuf_alloc(&buf_cfg);
479 	if (ret < 0)
480 		goto fail;
481 
482 	ret = xen_front_pgdir_shbuf_map(&stream->shbuf);
483 	if (ret < 0)
484 		goto fail;
485 
486 	return 0;
487 
488 fail:
489 	stream_free(stream);
490 	dev_err(&front_info->xb_dev->dev,
491 		"Failed to allocate buffers for stream with index %d\n",
492 		stream->index);
493 	return ret;
494 }
495 
alsa_hw_free(struct snd_pcm_substream * substream)496 static int alsa_hw_free(struct snd_pcm_substream *substream)
497 {
498 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
499 	int ret;
500 
501 	ret = xen_snd_front_stream_close(&stream->evt_pair->req);
502 	stream_free(stream);
503 	return ret;
504 }
505 
alsa_prepare(struct snd_pcm_substream * substream)506 static int alsa_prepare(struct snd_pcm_substream *substream)
507 {
508 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
509 
510 	if (!stream->is_open) {
511 		struct snd_pcm_runtime *runtime = substream->runtime;
512 		u8 sndif_format;
513 		int ret;
514 
515 		ret = to_sndif_format(runtime->format);
516 		if (ret < 0) {
517 			dev_err(&stream->front_info->xb_dev->dev,
518 				"Unsupported sample format: %d\n",
519 				runtime->format);
520 			return ret;
521 		}
522 		sndif_format = ret;
523 
524 		ret = xen_snd_front_stream_prepare(&stream->evt_pair->req,
525 						   &stream->shbuf,
526 						   sndif_format,
527 						   runtime->channels,
528 						   runtime->rate,
529 						   snd_pcm_lib_buffer_bytes(substream),
530 						   snd_pcm_lib_period_bytes(substream));
531 		if (ret < 0)
532 			return ret;
533 
534 		stream->is_open = true;
535 	}
536 
537 	return 0;
538 }
539 
alsa_trigger(struct snd_pcm_substream * substream,int cmd)540 static int alsa_trigger(struct snd_pcm_substream *substream, int cmd)
541 {
542 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
543 	int type;
544 
545 	switch (cmd) {
546 	case SNDRV_PCM_TRIGGER_START:
547 		type = XENSND_OP_TRIGGER_START;
548 		break;
549 
550 	case SNDRV_PCM_TRIGGER_RESUME:
551 		type = XENSND_OP_TRIGGER_RESUME;
552 		break;
553 
554 	case SNDRV_PCM_TRIGGER_STOP:
555 		type = XENSND_OP_TRIGGER_STOP;
556 		break;
557 
558 	case SNDRV_PCM_TRIGGER_SUSPEND:
559 		type = XENSND_OP_TRIGGER_PAUSE;
560 		break;
561 
562 	default:
563 		return -EINVAL;
564 	}
565 
566 	return xen_snd_front_stream_trigger(&stream->evt_pair->req, type);
567 }
568 
xen_snd_front_alsa_handle_cur_pos(struct xen_snd_front_evtchnl * evtchnl,u64 pos_bytes)569 void xen_snd_front_alsa_handle_cur_pos(struct xen_snd_front_evtchnl *evtchnl,
570 				       u64 pos_bytes)
571 {
572 	struct snd_pcm_substream *substream = evtchnl->u.evt.substream;
573 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
574 	snd_pcm_uframes_t delta, new_hw_ptr, cur_frame;
575 
576 	cur_frame = bytes_to_frames(substream->runtime, pos_bytes);
577 
578 	delta = cur_frame - stream->be_cur_frame;
579 	stream->be_cur_frame = cur_frame;
580 
581 	new_hw_ptr = (snd_pcm_uframes_t)atomic_read(&stream->hw_ptr);
582 	new_hw_ptr = (new_hw_ptr + delta) % substream->runtime->buffer_size;
583 	atomic_set(&stream->hw_ptr, (int)new_hw_ptr);
584 
585 	stream->out_frames += delta;
586 	if (stream->out_frames > substream->runtime->period_size) {
587 		stream->out_frames %= substream->runtime->period_size;
588 		snd_pcm_period_elapsed(substream);
589 	}
590 }
591 
alsa_pointer(struct snd_pcm_substream * substream)592 static snd_pcm_uframes_t alsa_pointer(struct snd_pcm_substream *substream)
593 {
594 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
595 
596 	return (snd_pcm_uframes_t)atomic_read(&stream->hw_ptr);
597 }
598 
alsa_pb_copy(struct snd_pcm_substream * substream,int channel,unsigned long pos,struct iov_iter * src,unsigned long count)599 static int alsa_pb_copy(struct snd_pcm_substream *substream,
600 			int channel, unsigned long pos, struct iov_iter *src,
601 			unsigned long count)
602 {
603 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
604 
605 	if (unlikely(pos + count > stream->buffer_sz))
606 		return -EINVAL;
607 
608 	if (copy_from_iter(stream->buffer + pos, count, src) != count)
609 		return -EFAULT;
610 
611 	return xen_snd_front_stream_write(&stream->evt_pair->req, pos, count);
612 }
613 
alsa_cap_copy(struct snd_pcm_substream * substream,int channel,unsigned long pos,struct iov_iter * dst,unsigned long count)614 static int alsa_cap_copy(struct snd_pcm_substream *substream,
615 			 int channel, unsigned long pos, struct iov_iter *dst,
616 			 unsigned long count)
617 {
618 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
619 	int ret;
620 
621 	if (unlikely(pos + count > stream->buffer_sz))
622 		return -EINVAL;
623 
624 	ret = xen_snd_front_stream_read(&stream->evt_pair->req, pos, count);
625 	if (ret < 0)
626 		return ret;
627 
628 	if (copy_to_iter(stream->buffer + pos, count, dst) != count)
629 		return -EFAULT;
630 	return 0;
631 }
632 
alsa_pb_fill_silence(struct snd_pcm_substream * substream,int channel,unsigned long pos,unsigned long count)633 static int alsa_pb_fill_silence(struct snd_pcm_substream *substream,
634 				int channel, unsigned long pos,
635 				unsigned long count)
636 {
637 	struct xen_snd_front_pcm_stream_info *stream = stream_get(substream);
638 
639 	if (unlikely(pos + count > stream->buffer_sz))
640 		return -EINVAL;
641 
642 	memset(stream->buffer + pos, 0, count);
643 
644 	return xen_snd_front_stream_write(&stream->evt_pair->req, pos, count);
645 }
646 
647 /*
648  * FIXME: The mmaped data transfer is asynchronous and there is no
649  * ack signal from user-space when it is done. This is the
650  * reason it is not implemented in the PV driver as we do need
651  * to know when the buffer can be transferred to the backend.
652  */
653 
654 static const struct snd_pcm_ops snd_drv_alsa_playback_ops = {
655 	.open		= alsa_open,
656 	.close		= alsa_close,
657 	.hw_params	= alsa_hw_params,
658 	.hw_free	= alsa_hw_free,
659 	.prepare	= alsa_prepare,
660 	.trigger	= alsa_trigger,
661 	.pointer	= alsa_pointer,
662 	.copy		= alsa_pb_copy,
663 	.fill_silence	= alsa_pb_fill_silence,
664 };
665 
666 static const struct snd_pcm_ops snd_drv_alsa_capture_ops = {
667 	.open		= alsa_open,
668 	.close		= alsa_close,
669 	.hw_params	= alsa_hw_params,
670 	.hw_free	= alsa_hw_free,
671 	.prepare	= alsa_prepare,
672 	.trigger	= alsa_trigger,
673 	.pointer	= alsa_pointer,
674 	.copy		= alsa_cap_copy,
675 };
676 
new_pcm_instance(struct xen_snd_front_card_info * card_info,struct xen_front_cfg_pcm_instance * instance_cfg,struct xen_snd_front_pcm_instance_info * pcm_instance_info)677 static int new_pcm_instance(struct xen_snd_front_card_info *card_info,
678 			    struct xen_front_cfg_pcm_instance *instance_cfg,
679 			    struct xen_snd_front_pcm_instance_info *pcm_instance_info)
680 {
681 	struct snd_pcm *pcm;
682 	int ret, i;
683 
684 	dev_dbg(&card_info->front_info->xb_dev->dev,
685 		"New PCM device \"%s\" with id %d playback %d capture %d",
686 		instance_cfg->name,
687 		instance_cfg->device_id,
688 		instance_cfg->num_streams_pb,
689 		instance_cfg->num_streams_cap);
690 
691 	pcm_instance_info->card_info = card_info;
692 
693 	pcm_instance_info->pcm_hw = instance_cfg->pcm_hw;
694 
695 	if (instance_cfg->num_streams_pb) {
696 		pcm_instance_info->streams_pb =
697 				devm_kcalloc(&card_info->card->card_dev,
698 					     instance_cfg->num_streams_pb,
699 					     sizeof(struct xen_snd_front_pcm_stream_info),
700 					     GFP_KERNEL);
701 		if (!pcm_instance_info->streams_pb)
702 			return -ENOMEM;
703 	}
704 
705 	if (instance_cfg->num_streams_cap) {
706 		pcm_instance_info->streams_cap =
707 				devm_kcalloc(&card_info->card->card_dev,
708 					     instance_cfg->num_streams_cap,
709 					     sizeof(struct xen_snd_front_pcm_stream_info),
710 					     GFP_KERNEL);
711 		if (!pcm_instance_info->streams_cap)
712 			return -ENOMEM;
713 	}
714 
715 	pcm_instance_info->num_pcm_streams_pb =
716 			instance_cfg->num_streams_pb;
717 	pcm_instance_info->num_pcm_streams_cap =
718 			instance_cfg->num_streams_cap;
719 
720 	for (i = 0; i < pcm_instance_info->num_pcm_streams_pb; i++) {
721 		pcm_instance_info->streams_pb[i].pcm_hw =
722 			instance_cfg->streams_pb[i].pcm_hw;
723 		pcm_instance_info->streams_pb[i].index =
724 			instance_cfg->streams_pb[i].index;
725 	}
726 
727 	for (i = 0; i < pcm_instance_info->num_pcm_streams_cap; i++) {
728 		pcm_instance_info->streams_cap[i].pcm_hw =
729 			instance_cfg->streams_cap[i].pcm_hw;
730 		pcm_instance_info->streams_cap[i].index =
731 			instance_cfg->streams_cap[i].index;
732 	}
733 
734 	ret = snd_pcm_new(card_info->card, instance_cfg->name,
735 			  instance_cfg->device_id,
736 			  instance_cfg->num_streams_pb,
737 			  instance_cfg->num_streams_cap,
738 			  &pcm);
739 	if (ret < 0)
740 		return ret;
741 
742 	pcm->private_data = pcm_instance_info;
743 	pcm->info_flags = 0;
744 	/* we want to handle all PCM operations in non-atomic context */
745 	pcm->nonatomic = true;
746 	strscpy(pcm->name, "Virtual card PCM", sizeof(pcm->name));
747 
748 	if (instance_cfg->num_streams_pb)
749 		snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
750 				&snd_drv_alsa_playback_ops);
751 
752 	if (instance_cfg->num_streams_cap)
753 		snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE,
754 				&snd_drv_alsa_capture_ops);
755 
756 	pcm_instance_info->pcm = pcm;
757 	return 0;
758 }
759 
xen_snd_front_alsa_init(struct xen_snd_front_info * front_info)760 int xen_snd_front_alsa_init(struct xen_snd_front_info *front_info)
761 {
762 	struct device *dev = &front_info->xb_dev->dev;
763 	struct xen_front_cfg_card *cfg = &front_info->cfg;
764 	struct xen_snd_front_card_info *card_info;
765 	struct snd_card *card;
766 	int ret, i;
767 
768 	dev_dbg(dev, "Creating virtual sound card\n");
769 
770 	ret = snd_card_new(dev, 0, XENSND_DRIVER_NAME, THIS_MODULE,
771 			   sizeof(struct xen_snd_front_card_info), &card);
772 	if (ret < 0)
773 		return ret;
774 
775 	card_info = card->private_data;
776 	card_info->front_info = front_info;
777 	front_info->card_info = card_info;
778 	card_info->card = card;
779 	card_info->pcm_instances =
780 			devm_kcalloc(dev, cfg->num_pcm_instances,
781 				     sizeof(struct xen_snd_front_pcm_instance_info),
782 				     GFP_KERNEL);
783 	if (!card_info->pcm_instances) {
784 		ret = -ENOMEM;
785 		goto fail;
786 	}
787 
788 	card_info->num_pcm_instances = cfg->num_pcm_instances;
789 	card_info->pcm_hw = cfg->pcm_hw;
790 
791 	for (i = 0; i < cfg->num_pcm_instances; i++) {
792 		ret = new_pcm_instance(card_info, &cfg->pcm_instances[i],
793 				       &card_info->pcm_instances[i]);
794 		if (ret < 0)
795 			goto fail;
796 	}
797 
798 	strscpy(card->driver, XENSND_DRIVER_NAME, sizeof(card->driver));
799 	strscpy(card->shortname, cfg->name_short, sizeof(card->shortname));
800 	strscpy(card->longname, cfg->name_long, sizeof(card->longname));
801 
802 	ret = snd_card_register(card);
803 	if (ret < 0)
804 		goto fail;
805 
806 	return 0;
807 
808 fail:
809 	snd_card_free(card);
810 	return ret;
811 }
812 
xen_snd_front_alsa_fini(struct xen_snd_front_info * front_info)813 void xen_snd_front_alsa_fini(struct xen_snd_front_info *front_info)
814 {
815 	struct xen_snd_front_card_info *card_info;
816 	struct snd_card *card;
817 
818 	card_info = front_info->card_info;
819 	if (!card_info)
820 		return;
821 
822 	card = card_info->card;
823 	if (!card)
824 		return;
825 
826 	dev_dbg(&front_info->xb_dev->dev, "Removing virtual sound card %d\n",
827 		card->number);
828 	snd_card_free(card);
829 
830 	/* Card_info will be freed when destroying front_info->xb_dev->dev. */
831 	card_info->card = NULL;
832 }
833