[linux-2.6-block.git] / sound / firewire / tascam / amdtp-tascam.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * amdtp-tascam.c - a part of driver for TASCAM FireWire series
 *
 * Copyright (c) 2015 Takashi Sakamoto
 */

#include <sound/pcm.h>
#include "tascam.h"

#define AMDTP_FMT_TSCM_TX	0x1e
#define AMDTP_FMT_TSCM_RX	0x3e

struct amdtp_tscm {
	unsigned int pcm_channels;
};

int amdtp_tscm_set_parameters(struct amdtp_stream *s, unsigned int rate)
{
	struct amdtp_tscm *p = s->protocol;
	unsigned int data_channels;

	if (amdtp_stream_running(s))
		return -EBUSY;

	data_channels = p->pcm_channels;

	/* Packets in in-stream have extra 2 data channels. */
	if (s->direction == AMDTP_IN_STREAM)
		data_channels += 2;

	return amdtp_stream_set_parameters(s, rate, data_channels);
}

static void write_pcm_s32(struct amdtp_stream *s, struct snd_pcm_substream *pcm,
			  __be32 *buffer, unsigned int frames,
			  unsigned int pcm_frames)
{
	struct amdtp_tscm *p = s->protocol;
	unsigned int channels = p->pcm_channels;
	struct snd_pcm_runtime *runtime = pcm->runtime;
	unsigned int pcm_buffer_pointer;
	int remaining_frames;
	const u32 *src;
	int i, c;

	pcm_buffer_pointer = s->pcm_buffer_pointer + pcm_frames;
	pcm_buffer_pointer %= runtime->buffer_size;

	src = (void *)runtime->dma_area +
				frames_to_bytes(runtime, pcm_buffer_pointer);
	remaining_frames = runtime->buffer_size - pcm_buffer_pointer;

	for (i = 0; i < frames; ++i) {
		for (c = 0; c < channels; ++c) {
			buffer[c] = cpu_to_be32(*src);
			src++;
		}
		buffer += s->data_block_quadlets;
		if (--remaining_frames == 0)
			src = (void *)runtime->dma_area;
	}
}

static void read_pcm_s32(struct amdtp_stream *s, struct snd_pcm_substream *pcm,
			 __be32 *buffer, unsigned int frames,
			 unsigned int pcm_frames)
{
	struct amdtp_tscm *p = s->protocol;
	unsigned int channels = p->pcm_channels;
	struct snd_pcm_runtime *runtime = pcm->runtime;
	unsigned int pcm_buffer_pointer;
	int remaining_frames;
	u32 *dst;
	int i, c;

	pcm_buffer_pointer = s->pcm_buffer_pointer + pcm_frames;
	pcm_buffer_pointer %= runtime->buffer_size;

	dst  = (void *)runtime->dma_area +
				frames_to_bytes(runtime, pcm_buffer_pointer);
	remaining_frames = runtime->buffer_size - pcm_buffer_pointer;

	/* The first data channel is for event counter. */
	buffer += 1;

	for (i = 0; i < frames; ++i) {
		for (c = 0; c < channels; ++c) {
			*dst = be32_to_cpu(buffer[c]);
			dst++;
		}
		buffer += s->data_block_quadlets;
		if (--remaining_frames == 0)
			dst = (void *)runtime->dma_area;
	}
}

static void write_pcm_silence(struct amdtp_stream *s, __be32 *buffer,
			      unsigned int data_blocks)
{
	struct amdtp_tscm *p = s->protocol;
	unsigned int channels, i, c;

	channels = p->pcm_channels;

	for (i = 0; i < data_blocks; ++i) {
		for (c = 0; c < channels; ++c)
			buffer[c] = 0x00000000;
		buffer += s->data_block_quadlets;
	}
}

int amdtp_tscm_add_pcm_hw_constraints(struct amdtp_stream *s,
				      struct snd_pcm_runtime *runtime)
{
	int err;

	/*
	 * Our implementation allows this protocol to deliver 24 bit sample in
	 * 32bit data channel.
	 */
	err = snd_pcm_hw_constraint_msbits(runtime, 0, 32, 24);
	if (err < 0)
		return err;

	return amdtp_stream_add_pcm_hw_constraints(s, runtime);
}

static void read_status_messages(struct amdtp_stream *s,
				 __be32 *buffer, unsigned int data_blocks)
{
	struct snd_tscm *tscm = container_of(s, struct snd_tscm, tx_stream);
	bool used = READ_ONCE(tscm->hwdep->used);
	int i;

	for (i = 0; i < data_blocks; i++) {
		unsigned int index;
		__be32 before;
		__be32 after;

		index = be32_to_cpu(buffer[0]) % SNDRV_FIREWIRE_TASCAM_STATE_COUNT;
		before = tscm->state[index];
		after = buffer[s->data_block_quadlets - 1];

		if (used && index > 4 && index < 16) {
			__be32 mask;

			if (index == 5)
				mask = cpu_to_be32(~0x0000ffff);
			else if (index == 6)
				mask = cpu_to_be32(~0x0000ffff);
			else if (index == 8)
				mask = cpu_to_be32(~0x000f0f00);
			else
				mask = cpu_to_be32(~0x00000000);

			if ((before ^ after) & mask) {
				struct snd_firewire_tascam_change *entry =
						&tscm->queue[tscm->push_pos];

				spin_lock_irq(&tscm->lock);
				entry->index = index;
				entry->before = before;
				entry->after = after;
				if (++tscm->push_pos >= SND_TSCM_QUEUE_COUNT)
					tscm->push_pos = 0;
				spin_unlock_irq(&tscm->lock);

				wake_up(&tscm->hwdep_wait);
			}
		}

		tscm->state[index] = after;
		buffer += s->data_block_quadlets;
	}
}

static unsigned int process_ir_ctx_payloads(struct amdtp_stream *s,
					    const struct pkt_desc *descs,
					    unsigned int packets,
					    struct snd_pcm_substream *pcm)
{
	unsigned int pcm_frames = 0;
	int i;

	for (i = 0; i < packets; ++i) {
		const struct pkt_desc *desc = descs + i;
		__be32 *buf = desc->ctx_payload;
		unsigned int data_blocks = desc->data_blocks;

		if (pcm) {
			read_pcm_s32(s, pcm, buf, data_blocks, pcm_frames);
			pcm_frames += data_blocks;
		}

		read_status_messages(s, buf, data_blocks);
	}

	return pcm_frames;
}

static unsigned int process_it_ctx_payloads(struct amdtp_stream *s,
					    const struct pkt_desc *descs,
					    unsigned int packets,
					    struct snd_pcm_substream *pcm)
{
	unsigned int pcm_frames = 0;
	int i;

	for (i = 0; i < packets; ++i) {
		const struct pkt_desc *desc = descs + i;
		__be32 *buf = desc->ctx_payload;
		unsigned int data_blocks = desc->data_blocks;

		if (pcm) {
			write_pcm_s32(s, pcm, buf, data_blocks, pcm_frames);
			pcm_frames += data_blocks;
		} else {
			write_pcm_silence(s, buf, data_blocks);
		}
	}

	return pcm_frames;
}

int amdtp_tscm_init(struct amdtp_stream *s, struct fw_unit *unit,
		    enum amdtp_stream_direction dir, unsigned int pcm_channels)
{
	amdtp_stream_process_ctx_payloads_t process_ctx_payloads;
	struct amdtp_tscm *p;
	unsigned int fmt;
	int err;

	if (dir == AMDTP_IN_STREAM) {
		fmt = AMDTP_FMT_TSCM_TX;
		process_ctx_payloads = process_ir_ctx_payloads;
	} else {
		fmt = AMDTP_FMT_TSCM_RX;
		process_ctx_payloads = process_it_ctx_payloads;
	}

	err = amdtp_stream_init(s, unit, dir,
			CIP_NONBLOCKING | CIP_SKIP_DBC_ZERO_CHECK, fmt,
			process_ctx_payloads, sizeof(struct amdtp_tscm));
	if (err < 0)
		return 0;

	if (dir == AMDTP_OUT_STREAM) {
		// Use fixed value for FDF field.
		s->ctx_data.rx.fdf = 0x00;
		// Not used.
		s->ctx_data.rx.syt_override = 0x0000;
	}

	/* This protocol uses fixed number of data channels for PCM samples. */
	p = s->protocol;
	p->pcm_channels = pcm_channels;

	return 0;
}
Commit	Line	Data
da607e19	1	// SPDX-License-Identifier: GPL-2.0-only
47faeea2 TS	2	/*
	3	* amdtp-tascam.c - a part of driver for TASCAM FireWire series
	4	*
	5	* Copyright (c) 2015 Takashi Sakamoto
47faeea2 TS	6	*/
	7
	8	#include <sound/pcm.h>
	9	#include "tascam.h"
	10
	11	#define AMDTP_FMT_TSCM_TX 0x1e
	12	#define AMDTP_FMT_TSCM_RX 0x3e
	13
	14	struct amdtp_tscm {
	15	unsigned int pcm_channels;
47faeea2 TS	16	};
	17
	18	int amdtp_tscm_set_parameters(struct amdtp_stream *s, unsigned int rate)
	19	{
	20	struct amdtp_tscm *p = s->protocol;
	21	unsigned int data_channels;
	22
	23	if (amdtp_stream_running(s))
	24	return -EBUSY;
	25
	26	data_channels = p->pcm_channels;
	27
	28	/* Packets in in-stream have extra 2 data channels. */
	29	if (s->direction == AMDTP_IN_STREAM)
	30	data_channels += 2;
	31
	32	return amdtp_stream_set_parameters(s, rate, data_channels);
	33	}
	34
806653b7 TS	35	static void write_pcm_s32(struct amdtp_stream s, struct snd_pcm_substream pcm,
	36	__be32 *buffer, unsigned int frames,
	37	unsigned int pcm_frames)
47faeea2 TS	38	{
47faeea2 TS	39	struct amdtp_tscm *p = s->protocol;
806653b7	40	unsigned int channels = p->pcm_channels;
47faeea2	41	struct snd_pcm_runtime *runtime = pcm->runtime;
806653b7 TS	42	unsigned int pcm_buffer_pointer;
806653b7 TS	43	int remaining_frames;
47faeea2	44	const u32 *src;
806653b7 TS	45	int i, c;
	46
	47	pcm_buffer_pointer = s->pcm_buffer_pointer + pcm_frames;
	48	pcm_buffer_pointer %= runtime->buffer_size;
47faeea2	49
47faeea2	50	src = (void *)runtime->dma_area +
806653b7 TS	51	frames_to_bytes(runtime, pcm_buffer_pointer);
806653b7 TS	52	remaining_frames = runtime->buffer_size - pcm_buffer_pointer;
47faeea2 TS	53
	54	for (i = 0; i < frames; ++i) {
	55	for (c = 0; c < channels; ++c) {
	56	buffer[c] = cpu_to_be32(*src);
	57	src++;
	58	}
	59	buffer += s->data_block_quadlets;
	60	if (--remaining_frames == 0)
	61	src = (void *)runtime->dma_area;
	62	}
	63	}
	64
806653b7 TS	65	static void read_pcm_s32(struct amdtp_stream s, struct snd_pcm_substream pcm,
	66	__be32 *buffer, unsigned int frames,
	67	unsigned int pcm_frames)
47faeea2 TS	68	{
47faeea2 TS	69	struct amdtp_tscm *p = s->protocol;
806653b7	70	unsigned int channels = p->pcm_channels;
47faeea2	71	struct snd_pcm_runtime *runtime = pcm->runtime;
806653b7 TS	72	unsigned int pcm_buffer_pointer;
806653b7 TS	73	int remaining_frames;
47faeea2	74	u32 *dst;
806653b7 TS	75	int i, c;
	76
	77	pcm_buffer_pointer = s->pcm_buffer_pointer + pcm_frames;
	78	pcm_buffer_pointer %= runtime->buffer_size;
47faeea2	79
47faeea2	80	dst = (void *)runtime->dma_area +
806653b7 TS	81	frames_to_bytes(runtime, pcm_buffer_pointer);
806653b7 TS	82	remaining_frames = runtime->buffer_size - pcm_buffer_pointer;
47faeea2 TS	83
	84	/* The first data channel is for event counter. */
	85	buffer += 1;
	86
	87	for (i = 0; i < frames; ++i) {
	88	for (c = 0; c < channels; ++c) {
	89	*dst = be32_to_cpu(buffer[c]);
	90	dst++;
	91	}
	92	buffer += s->data_block_quadlets;
	93	if (--remaining_frames == 0)
	94	dst = (void *)runtime->dma_area;
	95	}
	96	}
	97
	98	static void write_pcm_silence(struct amdtp_stream s, __be32 buffer,
	99	unsigned int data_blocks)
	100	{
	101	struct amdtp_tscm *p = s->protocol;
	102	unsigned int channels, i, c;
	103
	104	channels = p->pcm_channels;
	105
	106	for (i = 0; i < data_blocks; ++i) {
	107	for (c = 0; c < channels; ++c)
	108	buffer[c] = 0x00000000;
	109	buffer += s->data_block_quadlets;
	110	}
	111	}
	112
	113	int amdtp_tscm_add_pcm_hw_constraints(struct amdtp_stream *s,
	114	struct snd_pcm_runtime *runtime)
	115	{
	116	int err;
	117
	118	/*
	119	* Our implementation allows this protocol to deliver 24 bit sample in
	120	* 32bit data channel.
	121	*/
	122	err = snd_pcm_hw_constraint_msbits(runtime, 0, 32, 24);
	123	if (err < 0)
	124	return err;
	125
	126	return amdtp_stream_add_pcm_hw_constraints(s, runtime);
	127	}
	128
33b2e144 TS	129	static void read_status_messages(struct amdtp_stream *s,
	130	__be32 *buffer, unsigned int data_blocks)
	131	{
	132	struct snd_tscm *tscm = container_of(s, struct snd_tscm, tx_stream);
d7167422	133	bool used = READ_ONCE(tscm->hwdep->used);
33b2e144 TS	134	int i;
	135
	136	for (i = 0; i < data_blocks; i++) {
	137	unsigned int index;
d7167422 TS	138	__be32 before;
d7167422 TS	139	__be32 after;
33b2e144 TS	140
33b2e144 TS	141	index = be32_to_cpu(buffer[0]) % SNDRV_FIREWIRE_TASCAM_STATE_COUNT;
d7167422 TS	142	before = tscm->state[index];
	143	after = buffer[s->data_block_quadlets - 1];
	144
	145	if (used && index > 4 && index < 16) {
	146	__be32 mask;
	147
	148	if (index == 5)
	149	mask = cpu_to_be32(~0x0000ffff);
	150	else if (index == 6)
	151	mask = cpu_to_be32(~0x0000ffff);
	152	else if (index == 8)
	153	mask = cpu_to_be32(~0x000f0f00);
	154	else
	155	mask = cpu_to_be32(~0x00000000);
	156
	157	if ((before ^ after) & mask) {
	158	struct snd_firewire_tascam_change *entry =
	159	&tscm->queue[tscm->push_pos];
	160
	161	spin_lock_irq(&tscm->lock);
	162	entry->index = index;
	163	entry->before = before;
	164	entry->after = after;
	165	if (++tscm->push_pos >= SND_TSCM_QUEUE_COUNT)
	166	tscm->push_pos = 0;
	167	spin_unlock_irq(&tscm->lock);
a8c0d132 TS	168
a8c0d132 TS	169	wake_up(&tscm->hwdep_wait);
d7167422 TS	170	}
	171	}
	172
	173	tscm->state[index] = after;
33b2e144 TS	174	buffer += s->data_block_quadlets;
	175	}
	176	}
	177
9a738ad1 TS	178	static unsigned int process_ir_ctx_payloads(struct amdtp_stream *s,
	179	const struct pkt_desc *descs,
	180	unsigned int packets,
	181	struct snd_pcm_substream *pcm)
47faeea2	182	{
806653b7	183	unsigned int pcm_frames = 0;
9a738ad1	184	int i;
47faeea2	185
9a738ad1 TS	186	for (i = 0; i < packets; ++i) {
	187	const struct pkt_desc *desc = descs + i;
	188	__be32 *buf = desc->ctx_payload;
	189	unsigned int data_blocks = desc->data_blocks;
47faeea2	190
9a738ad1 TS	191	if (pcm) {
	192	read_pcm_s32(s, pcm, buf, data_blocks, pcm_frames);
	193	pcm_frames += data_blocks;
	194	}
	195
	196	read_status_messages(s, buf, data_blocks);
	197	}
47faeea2	198
d2c104a3	199	return pcm_frames;
47faeea2 TS	200	}
47faeea2 TS	201
9a738ad1 TS	202	static unsigned int process_it_ctx_payloads(struct amdtp_stream *s,
	203	const struct pkt_desc *descs,
	204	unsigned int packets,
	205	struct snd_pcm_substream *pcm)
47faeea2	206	{
806653b7	207	unsigned int pcm_frames = 0;
9a738ad1	208	int i;
47faeea2	209
9a738ad1 TS	210	for (i = 0; i < packets; ++i) {
	211	const struct pkt_desc *desc = descs + i;
	212	__be32 *buf = desc->ctx_payload;
	213	unsigned int data_blocks = desc->data_blocks;
	214
	215	if (pcm) {
	216	write_pcm_s32(s, pcm, buf, data_blocks, pcm_frames);
	217	pcm_frames += data_blocks;
	218	} else {
	219	write_pcm_silence(s, buf, data_blocks);
	220	}
d2c104a3	221	}
47faeea2	222
d2c104a3	223	return pcm_frames;
47faeea2 TS	224	}
	225
	226	int amdtp_tscm_init(struct amdtp_stream s, struct fw_unit unit,
	227	enum amdtp_stream_direction dir, unsigned int pcm_channels)
	228	{
9a738ad1	229	amdtp_stream_process_ctx_payloads_t process_ctx_payloads;
47faeea2 TS	230	struct amdtp_tscm *p;
	231	unsigned int fmt;
	232	int err;
	233
	234	if (dir == AMDTP_IN_STREAM) {
	235	fmt = AMDTP_FMT_TSCM_TX;
9a738ad1	236	process_ctx_payloads = process_ir_ctx_payloads;
47faeea2 TS	237	} else {
47faeea2 TS	238	fmt = AMDTP_FMT_TSCM_RX;
9a738ad1	239	process_ctx_payloads = process_it_ctx_payloads;
47faeea2 TS	240	}
	241
	242	err = amdtp_stream_init(s, unit, dir,
9a738ad1 TS	243	CIP_NONBLOCKING \| CIP_SKIP_DBC_ZERO_CHECK, fmt,
9a738ad1 TS	244	process_ctx_payloads, sizeof(struct amdtp_tscm));
47faeea2 TS	245	if (err < 0)
	246	return 0;
	247
3baf3053 TS	248	if (dir == AMDTP_OUT_STREAM) {
	249	// Use fixed value for FDF field.
	250	s->ctx_data.rx.fdf = 0x00;
	251	// Not used.
	252	s->ctx_data.rx.syt_override = 0x0000;
	253	}
47faeea2 TS	254
	255	/* This protocol uses fixed number of data channels for PCM samples. */
	256	p = s->protocol;
	257	p->pcm_channels = pcm_channels;
	258
	259	return 0;
	260	}