[linux-block.git] / sound / virtio / virtio_card.h

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

#include <linux/slab.h>
#include <linux/virtio.h>
#include <sound/core.h>
#include <uapi/linux/virtio_snd.h>

#include "virtio_ctl_msg.h"
#include "virtio_pcm.h"

#define VIRTIO_SND_CARD_DRIVER	"virtio-snd"
#define VIRTIO_SND_CARD_NAME	"VirtIO SoundCard"
#define VIRTIO_SND_PCM_NAME	"VirtIO PCM"

struct virtio_jack;
struct virtio_pcm_substream;

/**
 * struct virtio_snd_queue - Virtqueue wrapper structure.
 * @lock: Used to synchronize access to a virtqueue.
 * @vqueue: Underlying virtqueue.
 */
struct virtio_snd_queue {
	spinlock_t lock;
	struct virtqueue *vqueue;
};

/**
 * struct virtio_kctl - VirtIO control element.
 * @kctl: ALSA control element.
 * @items: Items for the ENUMERATED element type.
 */
struct virtio_kctl {
	struct snd_kcontrol *kctl;
	struct virtio_snd_ctl_enum_item *items;
};

/**
 * struct virtio_snd - VirtIO sound card device.
 * @vdev: Underlying virtio device.
 * @queues: Virtqueue wrappers.
 * @card: ALSA sound card.
 * @ctl_msgs: Pending control request list.
 * @event_msgs: Device events.
 * @pcm_list: VirtIO PCM device list.
 * @jacks: VirtIO jacks.
 * @njacks: Number of jacks.
 * @substreams: VirtIO PCM substreams.
 * @nsubstreams: Number of PCM substreams.
 * @chmaps: VirtIO channel maps.
 * @nchmaps: Number of channel maps.
 * @kctl_infos: VirtIO control element information.
 * @kctls: VirtIO control elements.
 * @nkctls: Number of control elements.
 */
struct virtio_snd {
	struct virtio_device *vdev;
	struct virtio_snd_queue queues[VIRTIO_SND_VQ_MAX];
	struct snd_card *card;
	struct list_head ctl_msgs;
	struct virtio_snd_event *event_msgs;
	struct list_head pcm_list;
	struct virtio_jack *jacks;
	u32 njacks;
	struct virtio_pcm_substream *substreams;
	u32 nsubstreams;
	struct virtio_snd_chmap_info *chmaps;
	u32 nchmaps;
	struct virtio_snd_ctl_info *kctl_infos;
	struct virtio_kctl *kctls;
	u32 nkctls;
};

/* Message completion timeout in milliseconds (module parameter). */
extern u32 virtsnd_msg_timeout_ms;

static inline struct virtio_snd_queue *
virtsnd_control_queue(struct virtio_snd *snd)
{
	return &snd->queues[VIRTIO_SND_VQ_CONTROL];
}

static inline struct virtio_snd_queue *
virtsnd_event_queue(struct virtio_snd *snd)
{
	return &snd->queues[VIRTIO_SND_VQ_EVENT];
}

static inline struct virtio_snd_queue *
virtsnd_tx_queue(struct virtio_snd *snd)
{
	return &snd->queues[VIRTIO_SND_VQ_TX];
}

static inline struct virtio_snd_queue *
virtsnd_rx_queue(struct virtio_snd *snd)
{
	return &snd->queues[VIRTIO_SND_VQ_RX];
}

static inline struct virtio_snd_queue *
virtsnd_pcm_queue(struct virtio_pcm_substream *vss)
{
	if (vss->direction == SNDRV_PCM_STREAM_PLAYBACK)
		return virtsnd_tx_queue(vss->snd);
	else
		return virtsnd_rx_queue(vss->snd);
}

int virtsnd_jack_parse_cfg(struct virtio_snd *snd);

int virtsnd_jack_build_devs(struct virtio_snd *snd);

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

int virtsnd_chmap_parse_cfg(struct virtio_snd *snd);

int virtsnd_chmap_build_devs(struct virtio_snd *snd);

int virtsnd_kctl_parse_cfg(struct virtio_snd *snd);

int virtsnd_kctl_build_devs(struct virtio_snd *snd);

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

#endif /* VIRTIO_SND_CARD_H */
Commit	Line	Data
de3a9980 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_CARD_H
	7	#define VIRTIO_SND_CARD_H
	8
	9	#include <linux/slab.h>
	10	#include <linux/virtio.h>
	11	#include <sound/core.h>
	12	#include <uapi/linux/virtio_snd.h>
	13
9d45e514	14	#include "virtio_ctl_msg.h"
29b96bf5	15	#include "virtio_pcm.h"
9d45e514	16
de3a9980 AY	17	#define VIRTIO_SND_CARD_DRIVER "virtio-snd"
de3a9980 AY	18	#define VIRTIO_SND_CARD_NAME "VirtIO SoundCard"
29b96bf5 AY	19	#define VIRTIO_SND_PCM_NAME "VirtIO PCM"
29b96bf5 AY	20
ca61a41f	21	struct virtio_jack;
29b96bf5	22	struct virtio_pcm_substream;
de3a9980 AY	23
	24	/**
	25	* struct virtio_snd_queue - Virtqueue wrapper structure.
	26	* @lock: Used to synchronize access to a virtqueue.
	27	* @vqueue: Underlying virtqueue.
	28	*/
	29	struct virtio_snd_queue {
	30	spinlock_t lock;
	31	struct virtqueue *vqueue;
	32	};
	33
d6568e3d AY	34	/**
	35	* struct virtio_kctl - VirtIO control element.
	36	* @kctl: ALSA control element.
	37	* @items: Items for the ENUMERATED element type.
	38	*/
	39	struct virtio_kctl {
	40	struct snd_kcontrol *kctl;
	41	struct virtio_snd_ctl_enum_item *items;
	42	};
	43
de3a9980 AY	44	/**
	45	* struct virtio_snd - VirtIO sound card device.
	46	* @vdev: Underlying virtio device.
	47	* @queues: Virtqueue wrappers.
	48	* @card: ALSA sound card.
9d45e514	49	* @ctl_msgs: Pending control request list.
de3a9980	50	* @event_msgs: Device events.
29b96bf5	51	* @pcm_list: VirtIO PCM device list.
ca61a41f AY	52	* @jacks: VirtIO jacks.
ca61a41f AY	53	* @njacks: Number of jacks.
29b96bf5 AY	54	* @substreams: VirtIO PCM substreams.
29b96bf5 AY	55	* @nsubstreams: Number of PCM substreams.
19325fed AY	56	* @chmaps: VirtIO channel maps.
19325fed AY	57	* @nchmaps: Number of channel maps.
d6568e3d AY	58	* @kctl_infos: VirtIO control element information.
	59	* @kctls: VirtIO control elements.
	60	* @nkctls: Number of control elements.
de3a9980 AY	61	*/
	62	struct virtio_snd {
	63	struct virtio_device *vdev;
	64	struct virtio_snd_queue queues[VIRTIO_SND_VQ_MAX];
	65	struct snd_card *card;
9d45e514	66	struct list_head ctl_msgs;
de3a9980	67	struct virtio_snd_event *event_msgs;
29b96bf5	68	struct list_head pcm_list;
ca61a41f AY	69	struct virtio_jack *jacks;
ca61a41f AY	70	u32 njacks;
29b96bf5 AY	71	struct virtio_pcm_substream *substreams;
29b96bf5 AY	72	u32 nsubstreams;
19325fed AY	73	struct virtio_snd_chmap_info *chmaps;
19325fed AY	74	u32 nchmaps;
d6568e3d AY	75	struct virtio_snd_ctl_info *kctl_infos;
	76	struct virtio_kctl *kctls;
	77	u32 nkctls;
de3a9980 AY	78	};
de3a9980 AY	79
9d45e514 AY	80	/* Message completion timeout in milliseconds (module parameter). */
	81	extern u32 virtsnd_msg_timeout_ms;
	82
de3a9980 AY	83	static inline struct virtio_snd_queue *
	84	virtsnd_control_queue(struct virtio_snd *snd)
	85	{
	86	return &snd->queues[VIRTIO_SND_VQ_CONTROL];
	87	}
	88
	89	static inline struct virtio_snd_queue *
	90	virtsnd_event_queue(struct virtio_snd *snd)
	91	{
	92	return &snd->queues[VIRTIO_SND_VQ_EVENT];
	93	}
	94
	95	static inline struct virtio_snd_queue *
	96	virtsnd_tx_queue(struct virtio_snd *snd)
	97	{
	98	return &snd->queues[VIRTIO_SND_VQ_TX];
	99	}
	100
	101	static inline struct virtio_snd_queue *
	102	virtsnd_rx_queue(struct virtio_snd *snd)
	103	{
	104	return &snd->queues[VIRTIO_SND_VQ_RX];
	105	}
	106
f40a2867 AY	107	static inline struct virtio_snd_queue *
	108	virtsnd_pcm_queue(struct virtio_pcm_substream *vss)
	109	{
	110	if (vss->direction == SNDRV_PCM_STREAM_PLAYBACK)
	111	return virtsnd_tx_queue(vss->snd);
	112	else
	113	return virtsnd_rx_queue(vss->snd);
	114	}
	115
ca61a41f AY	116	int virtsnd_jack_parse_cfg(struct virtio_snd *snd);
	117
	118	int virtsnd_jack_build_devs(struct virtio_snd *snd);
	119
	120	void virtsnd_jack_event(struct virtio_snd *snd,
	121	struct virtio_snd_event *event);
	122
19325fed AY	123	int virtsnd_chmap_parse_cfg(struct virtio_snd *snd);
	124
	125	int virtsnd_chmap_build_devs(struct virtio_snd *snd);
	126
d6568e3d AY	127	int virtsnd_kctl_parse_cfg(struct virtio_snd *snd);
	128
	129	int virtsnd_kctl_build_devs(struct virtio_snd *snd);
	130
	131	void virtsnd_kctl_event(struct virtio_snd snd, struct virtio_snd_event event);
	132
de3a9980	133	#endif /* VIRTIO_SND_CARD_H */