[linux-2.6-block.git] / sound / virtio / virtio_pcm.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * virtio-snd: Virtio sound device
 * Copyright (C) 2021 OpenSynergy GmbH
 */
#ifndef VIRTIO_SND_PCM_H
#define VIRTIO_SND_PCM_H

#include <linux/atomic.h>
#include <linux/virtio_config.h>
#include <sound/pcm.h>
#include <sound/pcm-indirect.h>

struct virtio_pcm;
struct virtio_pcm_msg;

/**
 * struct virtio_pcm_substream - VirtIO PCM substream.
 * @snd: VirtIO sound device.
 * @nid: Function group node identifier.
 * @sid: Stream identifier.
 * @direction: Stream data flow direction (SNDRV_PCM_STREAM_XXX).
 * @features: Stream VirtIO feature bit map (1 << VIRTIO_SND_PCM_F_XXX).
 * @substream: Kernel ALSA substream.
 * @pcm_indirect: Kernel indirect pcm structure.
 * @hw: Kernel ALSA substream hardware descriptor.
 * @elapsed_period: Kernel work to handle the elapsed period state.
 * @lock: Spinlock that protects fields shared by interrupt handlers and
 *        substream operators.
 * @buffer_bytes: Current buffer size in bytes.
 * @hw_ptr: Substream hardware pointer value in bytes [0 ... buffer_bytes).
 * @xfer_enabled: Data transfer state (0 - off, 1 - on).
 * @xfer_xrun: Data underflow/overflow state (0 - no xrun, 1 - xrun).
 * @stopped: True if the substream is stopped and must be released on the device
 *           side.
 * @suspended: True if the substream is suspended and must be reconfigured on
 *             the device side at resume.
 * @msgs: Allocated I/O messages.
 * @nmsgs: Number of allocated I/O messages.
 * @msg_last_enqueued: Index of the last I/O message added to the virtqueue.
 * @msg_count: Number of pending I/O messages in the virtqueue.
 * @msg_empty: Notify when msg_count is zero.
 */
struct virtio_pcm_substream {
	struct virtio_snd *snd;
	u32 nid;
	u32 sid;
	u32 direction;
	u32 features;
	struct snd_pcm_substream *substream;
	struct snd_pcm_indirect pcm_indirect;
	struct snd_pcm_hardware hw;
	struct work_struct elapsed_period;
	spinlock_t lock;
	size_t buffer_bytes;
	size_t hw_ptr;
	bool xfer_enabled;
	bool xfer_xrun;
	bool stopped;
	bool suspended;
	struct virtio_pcm_msg **msgs;
	unsigned int nmsgs;
	unsigned int msg_count;
	wait_queue_head_t msg_empty;
};

/**
 * struct virtio_pcm_stream - VirtIO PCM stream.
 * @substreams: VirtIO substreams belonging to the stream.
 * @nsubstreams: Number of substreams.
 * @chmaps: Kernel channel maps belonging to the stream.
 * @nchmaps: Number of channel maps.
 */
struct virtio_pcm_stream {
	struct virtio_pcm_substream **substreams;
	u32 nsubstreams;
	struct snd_pcm_chmap_elem *chmaps;
	u32 nchmaps;
};

/**
 * struct virtio_pcm - VirtIO PCM device.
 * @list: VirtIO PCM list entry.
 * @nid: Function group node identifier.
 * @pcm: Kernel PCM device.
 * @streams: VirtIO PCM streams (playback and capture).
 */
struct virtio_pcm {
	struct list_head list;
	u32 nid;
	struct snd_pcm *pcm;
	struct virtio_pcm_stream streams[SNDRV_PCM_STREAM_LAST + 1];
};

extern const struct snd_pcm_ops virtsnd_pcm_ops[];

int virtsnd_pcm_validate(struct virtio_device *vdev);

int virtsnd_pcm_parse_cfg(struct virtio_snd *snd);

int virtsnd_pcm_build_devs(struct virtio_snd *snd);

void virtsnd_pcm_event(struct virtio_snd *snd, struct virtio_snd_event *event);

void virtsnd_pcm_tx_notify_cb(struct virtqueue *vqueue);

void virtsnd_pcm_rx_notify_cb(struct virtqueue *vqueue);

struct virtio_pcm *virtsnd_pcm_find(struct virtio_snd *snd, u32 nid);

struct virtio_pcm *virtsnd_pcm_find_or_create(struct virtio_snd *snd, u32 nid);

struct virtio_snd_msg *
virtsnd_pcm_ctl_msg_alloc(struct virtio_pcm_substream *vss,
			  unsigned int command, gfp_t gfp);

int virtsnd_pcm_msg_alloc(struct virtio_pcm_substream *vss,
			  unsigned int periods, unsigned int period_bytes);

void virtsnd_pcm_msg_free(struct virtio_pcm_substream *vss);

int virtsnd_pcm_msg_send(struct virtio_pcm_substream *vss, unsigned long offset,
			 unsigned long bytes);

unsigned int virtsnd_pcm_msg_pending_num(struct virtio_pcm_substream *vss);

#endif /* VIRTIO_SND_PCM_H */
Commit	Line	Data
29b96bf5 AY	1	/* SPDX-License-Identifier: GPL-2.0+ */
	2	/*
	3	* virtio-snd: Virtio sound device
	4	* Copyright (C) 2021 OpenSynergy GmbH
	5	*/
	6	#ifndef VIRTIO_SND_PCM_H
	7	#define VIRTIO_SND_PCM_H
	8
	9	#include <linux/atomic.h>
	10	#include <linux/virtio_config.h>
	11	#include <sound/pcm.h>
fe981e67	12	#include <sound/pcm-indirect.h>
29b96bf5 AY	13
	14	struct virtio_pcm;
	15	struct virtio_pcm_msg;
	16
	17	/**
	18	* struct virtio_pcm_substream - VirtIO PCM substream.
	19	* @snd: VirtIO sound device.
	20	* @nid: Function group node identifier.
	21	* @sid: Stream identifier.
	22	* @direction: Stream data flow direction (SNDRV_PCM_STREAM_XXX).
	23	* @features: Stream VirtIO feature bit map (1 << VIRTIO_SND_PCM_F_XXX).
	24	* @substream: Kernel ALSA substream.
fe981e67	25	* @pcm_indirect: Kernel indirect pcm structure.
29b96bf5 AY	26	* @hw: Kernel ALSA substream hardware descriptor.
29b96bf5 AY	27	* @elapsed_period: Kernel work to handle the elapsed period state.
f40a2867 AY	28	* @lock: Spinlock that protects fields shared by interrupt handlers and
	29	* substream operators.
	30	* @buffer_bytes: Current buffer size in bytes.
	31	* @hw_ptr: Substream hardware pointer value in bytes [0 ... buffer_bytes).
	32	* @xfer_enabled: Data transfer state (0 - off, 1 - on).
	33	* @xfer_xrun: Data underflow/overflow state (0 - no xrun, 1 - xrun).
da76e9f3 AY	34	* @stopped: True if the substream is stopped and must be released on the device
da76e9f3 AY	35	* side.
575483e9 AY	36	* @suspended: True if the substream is suspended and must be reconfigured on
575483e9 AY	37	* the device side at resume.
f40a2867 AY	38	* @msgs: Allocated I/O messages.
	39	* @nmsgs: Number of allocated I/O messages.
	40	* @msg_last_enqueued: Index of the last I/O message added to the virtqueue.
	41	* @msg_count: Number of pending I/O messages in the virtqueue.
	42	* @msg_empty: Notify when msg_count is zero.
29b96bf5 AY	43	*/
	44	struct virtio_pcm_substream {
	45	struct virtio_snd *snd;
	46	u32 nid;
	47	u32 sid;
	48	u32 direction;
	49	u32 features;
	50	struct snd_pcm_substream *substream;
fe981e67	51	struct snd_pcm_indirect pcm_indirect;
29b96bf5 AY	52	struct snd_pcm_hardware hw;
29b96bf5 AY	53	struct work_struct elapsed_period;
f40a2867 AY	54	spinlock_t lock;
	55	size_t buffer_bytes;
	56	size_t hw_ptr;
	57	bool xfer_enabled;
	58	bool xfer_xrun;
da76e9f3	59	bool stopped;
575483e9	60	bool suspended;
f40a2867 AY	61	struct virtio_pcm_msg **msgs;
f40a2867 AY	62	unsigned int nmsgs;
f40a2867 AY	63	unsigned int msg_count;
f40a2867 AY	64	wait_queue_head_t msg_empty;
29b96bf5 AY	65	};
	66
	67	/**
	68	* struct virtio_pcm_stream - VirtIO PCM stream.
	69	* @substreams: VirtIO substreams belonging to the stream.
	70	* @nsubstreams: Number of substreams.
19325fed AY	71	* @chmaps: Kernel channel maps belonging to the stream.
19325fed AY	72	* @nchmaps: Number of channel maps.
29b96bf5 AY	73	*/
	74	struct virtio_pcm_stream {
	75	struct virtio_pcm_substream **substreams;
	76	u32 nsubstreams;
19325fed AY	77	struct snd_pcm_chmap_elem *chmaps;
19325fed AY	78	u32 nchmaps;
29b96bf5 AY	79	};
	80
	81	/**
	82	* struct virtio_pcm - VirtIO PCM device.
	83	* @list: VirtIO PCM list entry.
	84	* @nid: Function group node identifier.
	85	* @pcm: Kernel PCM device.
	86	* @streams: VirtIO PCM streams (playback and capture).
	87	*/
	88	struct virtio_pcm {
	89	struct list_head list;
	90	u32 nid;
	91	struct snd_pcm *pcm;
	92	struct virtio_pcm_stream streams[SNDRV_PCM_STREAM_LAST + 1];
	93	};
	94
fe981e67	95	extern const struct snd_pcm_ops virtsnd_pcm_ops[];
da76e9f3	96
29b96bf5 AY	97	int virtsnd_pcm_validate(struct virtio_device *vdev);
	98
	99	int virtsnd_pcm_parse_cfg(struct virtio_snd *snd);
	100
	101	int virtsnd_pcm_build_devs(struct virtio_snd *snd);
	102
f40a2867 AY	103	void virtsnd_pcm_event(struct virtio_snd snd, struct virtio_snd_event event);
	104
	105	void virtsnd_pcm_tx_notify_cb(struct virtqueue *vqueue);
	106
	107	void virtsnd_pcm_rx_notify_cb(struct virtqueue *vqueue);
	108
29b96bf5 AY	109	struct virtio_pcm virtsnd_pcm_find(struct virtio_snd snd, u32 nid);
	110
	111	struct virtio_pcm virtsnd_pcm_find_or_create(struct virtio_snd snd, u32 nid);
	112
f40a2867 AY	113	struct virtio_snd_msg *
	114	virtsnd_pcm_ctl_msg_alloc(struct virtio_pcm_substream *vss,
	115	unsigned int command, gfp_t gfp);
	116
	117	int virtsnd_pcm_msg_alloc(struct virtio_pcm_substream *vss,
	118	unsigned int periods, unsigned int period_bytes);
	119
	120	void virtsnd_pcm_msg_free(struct virtio_pcm_substream *vss);
	121
fe981e67 MEVL	122	int virtsnd_pcm_msg_send(struct virtio_pcm_substream *vss, unsigned long offset,
fe981e67 MEVL	123	unsigned long bytes);
f40a2867 AY	124
	125	unsigned int virtsnd_pcm_msg_pending_num(struct virtio_pcm_substream *vss);
	126
29b96bf5	127	#endif /* VIRTIO_SND_PCM_H */