[deliverable/linux.git] / sound / firewire / tascam / tascam-transaction.c

/*
 * tascam-transaction.c - a part of driver for TASCAM FireWire series
 *
 * Copyright (c) 2015 Takashi Sakamoto
 *
 * Licensed under the terms of the GNU General Public License, version 2.
 */

#include "tascam.h"

/*
 * When return minus value, given argument is not MIDI status.
 * When return 0, given argument is a beginning of system exclusive.
 * When return the others, given argument is MIDI data.
 */
static inline int calculate_message_bytes(u8 status)
{
	switch (status) {
	case 0xf6:	/* Tune request. */
	case 0xf8:	/* Timing clock. */
	case 0xfa:	/* Start. */
	case 0xfb:	/* Continue. */
	case 0xfc:	/* Stop. */
	case 0xfe:	/* Active sensing. */
	case 0xff:	/* System reset. */
		return 1;
	case 0xf1:	/* MIDI time code quarter frame. */
	case 0xf3:	/* Song select. */
		return 2;
	case 0xf2:	/* Song position pointer. */
		return 3;
	case 0xf0:	/* Exclusive. */
		return 0;
	case 0xf7:	/* End of exclusive. */
		break;
	case 0xf4:	/* Undefined. */
	case 0xf5:	/* Undefined. */
	case 0xf9:	/* Undefined. */
	case 0xfd:	/* Undefined. */
		break;
	default:
		switch (status & 0xf0) {
		case 0x80:	/* Note on. */
		case 0x90:	/* Note off. */
		case 0xa0:	/* Polyphonic key pressure. */
		case 0xb0:	/* Control change and Mode change. */
		case 0xe0:	/* Pitch bend change. */
			return 3;
		case 0xc0:	/* Program change. */
		case 0xd0:	/* Channel pressure. */
			return 2;
		default:
		break;
		}
	break;
	}

	return -EINVAL;
}

static int fill_message(struct snd_rawmidi_substream *substream, u8 *buf)
{
	struct snd_tscm *tscm = substream->rmidi->private_data;
	unsigned int port = substream->number;
	int i, len, consume;
	u8 *label, *msg;
	u8 status;

	/* The first byte is used for label, the rest for MIDI bytes. */
	label = buf;
	msg = buf + 1;

	consume = snd_rawmidi_transmit_peek(substream, msg, 3);
	if (consume == 0)
		return 0;

	/* On exclusive message. */
	if (tscm->on_sysex[port]) {
		/* Seek the end of exclusives. */
		for (i = 0; i < consume; ++i) {
			if (msg[i] == 0xf7) {
				tscm->on_sysex[port] = false;
				break;
			}
		}

		/* At the end of exclusive message, use label 0x07. */
		if (!tscm->on_sysex[port]) {
			consume = i + 1;
			*label = (port << 4) | 0x07;
		/* During exclusive message, use label 0x04. */
		} else if (consume == 3) {
			*label = (port << 4) | 0x04;
		/* We need to fill whole 3 bytes. Go to next change. */
		} else {
			consume = 0;
		}
	} else {
		/* The beginning of exclusives. */
		if (msg[0] == 0xf0) {
			/* Transfer it in next chance in another condition. */
			tscm->on_sysex[port] = true;
			return 0;
		} else {
			/* On running-status. */
			if ((msg[0] & 0x80) != 0x80)
				status = tscm->running_status[port];
			else
				status = msg[0];

			/* Calculate consume bytes. */
			len = calculate_message_bytes(status);
			if (len <= 0)
				return 0;

			/* On running-status. */
			if ((msg[0] & 0x80) != 0x80) {
				msg[2] = msg[1];
				msg[1] = msg[0];
				msg[0] = tscm->running_status[port];
				consume--;
			} else {
				tscm->running_status[port] = msg[0];
			}

			/* Confirm length. */
			if (consume < len)
				return 0;
			if (consume > len)
				consume = len;
		}

		*label = (port << 4) | (msg[0] >> 4);
	}

	return consume;
}

static void handle_midi_tx(struct fw_card *card, struct fw_request *request,
			   int tcode, int destination, int source,
			   int generation, unsigned long long offset,
			   void *data, size_t length, void *callback_data)
{
	struct snd_tscm *tscm = callback_data;
	u32 *buf = (u32 *)data;
	unsigned int messages;
	unsigned int i;
	unsigned int port;
	struct snd_rawmidi_substream *substream;
	u8 *b;
	int bytes;

	if (offset != tscm->async_handler.offset)
		goto end;

	messages = length / 8;
	for (i = 0; i < messages; i++) {
		b = (u8 *)(buf + i * 2);

		port = b[0] >> 4;
		/* TODO: support virtual MIDI ports. */
		if (port >= tscm->spec->midi_capture_ports)
			goto end;

		/* Assume the message length. */
		bytes = calculate_message_bytes(b[1]);
		/* On MIDI data or exclusives. */
		if (bytes <= 0) {
			/* Seek the end of exclusives. */
			for (bytes = 1; bytes < 4; bytes++) {
				if (b[bytes] == 0xf7)
					break;
			}
			if (bytes == 4)
				bytes = 3;
		}

		substream = ACCESS_ONCE(tscm->tx_midi_substreams[port]);
		if (substream != NULL)
			snd_rawmidi_receive(substream, b + 1, bytes);
	}
end:
	fw_send_response(card, request, RCODE_COMPLETE);
}

int snd_tscm_transaction_register(struct snd_tscm *tscm)
{
	static const struct fw_address_region resp_register_region = {
		.start	= 0xffffe0000000ull,
		.end	= 0xffffe000ffffull,
	};
	unsigned int i;
	int err;

	/*
	 * Usually, two quadlets are transferred by one transaction. The first
	 * quadlet has MIDI messages, the rest includes timestamp.
	 * Sometimes, 8 set of the data is transferred by a block transaction.
	 */
	tscm->async_handler.length = 8 * 8;
	tscm->async_handler.address_callback = handle_midi_tx;
	tscm->async_handler.callback_data = tscm;

	err = fw_core_add_address_handler(&tscm->async_handler,
					  &resp_register_region);
	if (err < 0)
		return err;

	err = snd_tscm_transaction_reregister(tscm);
	if (err < 0)
		goto error;

	for (i = 0; i < TSCM_MIDI_OUT_PORT_MAX; i++) {
		err = snd_fw_async_midi_port_init(
				&tscm->out_ports[i], tscm->unit,
				TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_RX_QUAD,
				4, fill_message);
		if (err < 0)
			goto error;
	}

	return err;
error:
	fw_core_remove_address_handler(&tscm->async_handler);
	return err;
}

/* At bus reset, these registers are cleared. */
int snd_tscm_transaction_reregister(struct snd_tscm *tscm)
{
	struct fw_device *device = fw_parent_device(tscm->unit);
	__be32 reg;
	int err;

	/* Register messaging address. Block transaction is not allowed. */
	reg = cpu_to_be32((device->card->node_id << 16) |
			  (tscm->async_handler.offset >> 32));
	err = snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
				 TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_HI,
				 &reg, sizeof(reg), 0);
	if (err < 0)
		return err;

	reg = cpu_to_be32(tscm->async_handler.offset);
	err = snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
				 TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_LO,
				 &reg, sizeof(reg), 0);
	if (err < 0)
		return err;

	/* Turn on messaging. */
	reg = cpu_to_be32(0x00000001);
	err = snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
				  TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ON,
				  &reg, sizeof(reg), 0);
	if (err < 0)
		return err;

	/* Turn on FireWire LED. */
	reg = cpu_to_be32(0x0001008e);
	return snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
				  TSCM_ADDR_BASE + TSCM_OFFSET_LED_POWER,
				  &reg, sizeof(reg), 0);
}

void snd_tscm_transaction_unregister(struct snd_tscm *tscm)
{
	__be32 reg;
	unsigned int i;

	/* Turn off FireWire LED. */
	reg = cpu_to_be32(0x0000008e);
	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
			   TSCM_ADDR_BASE + TSCM_OFFSET_LED_POWER,
			   &reg, sizeof(reg), 0);

	/* Turn off messaging. */
	reg = cpu_to_be32(0x00000000);
	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
			   TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ON,
			   &reg, sizeof(reg), 0);

	/* Unregister the address. */
	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
			   TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_HI,
			   &reg, sizeof(reg), 0);
	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
			   TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_LO,
			   &reg, sizeof(reg), 0);

	fw_core_remove_address_handler(&tscm->async_handler);
	for (i = 0; i < TSCM_MIDI_OUT_PORT_MAX; i++)
		snd_fw_async_midi_port_destroy(&tscm->out_ports[i]);
}
Commit	Line	Data
107cc012 TS	1	/*
	2	* tascam-transaction.c - a part of driver for TASCAM FireWire series
	3	*
	4	* Copyright (c) 2015 Takashi Sakamoto
	5	*
	6	* Licensed under the terms of the GNU General Public License, version 2.
	7	*/
	8
	9	#include "tascam.h"
	10
	11	/*
	12	* When return minus value, given argument is not MIDI status.
	13	* When return 0, given argument is a beginning of system exclusive.
	14	* When return the others, given argument is MIDI data.
	15	*/
	16	static inline int calculate_message_bytes(u8 status)
	17	{
	18	switch (status) {
	19	case 0xf6: /* Tune request. */
	20	case 0xf8: /* Timing clock. */
	21	case 0xfa: /* Start. */
	22	case 0xfb: /* Continue. */
	23	case 0xfc: /* Stop. */
	24	case 0xfe: /* Active sensing. */
	25	case 0xff: /* System reset. */
	26	return 1;
	27	case 0xf1: /* MIDI time code quarter frame. */
	28	case 0xf3: /* Song select. */
	29	return 2;
	30	case 0xf2: /* Song position pointer. */
	31	return 3;
	32	case 0xf0: /* Exclusive. */
	33	return 0;
	34	case 0xf7: /* End of exclusive. */
	35	break;
	36	case 0xf4: /* Undefined. */
	37	case 0xf5: /* Undefined. */
	38	case 0xf9: /* Undefined. */
	39	case 0xfd: /* Undefined. */
	40	break;
	41	default:
	42	switch (status & 0xf0) {
	43	case 0x80: /* Note on. */
	44	case 0x90: /* Note off. */
	45	case 0xa0: /* Polyphonic key pressure. */
	46	case 0xb0: /* Control change and Mode change. */
	47	case 0xe0: /* Pitch bend change. */
	48	return 3;
	49	case 0xc0: /* Program change. */
	50	case 0xd0: /* Channel pressure. */
	51	return 2;
	52	default:
	53	break;
	54	}
	55	break;
	56	}
	57
	58	return -EINVAL;
	59	}
	60
3beab0f8 TS	61	static int fill_message(struct snd_rawmidi_substream substream, u8 buf)
	62	{
	63	struct snd_tscm *tscm = substream->rmidi->private_data;
	64	unsigned int port = substream->number;
516a3061	65	int i, len, consume;
123990e9	66	u8 label, msg;
3beab0f8	67	u8 status;
3beab0f8	68
123990e9 TS	69	/* The first byte is used for label, the rest for MIDI bytes. */
	70	label = buf;
	71	msg = buf + 1;
	72
	73	consume = snd_rawmidi_transmit_peek(substream, msg, 3);
b7ab614f	74	if (consume == 0)
3beab0f8 TS	75	return 0;
	76
	77	/* On exclusive message. */
	78	if (tscm->on_sysex[port]) {
	79	/* Seek the end of exclusives. */
123990e9 TS	80	for (i = 0; i < consume; ++i) {
123990e9 TS	81	if (msg[i] == 0xf7) {
3beab0f8 TS	82	tscm->on_sysex[port] = false;
	83	break;
	84	}
	85	}
	86
	87	/* At the end of exclusive message, use label 0x07. */
	88	if (!tscm->on_sysex[port]) {
123990e9 TS	89	consume = i + 1;
123990e9 TS	90	*label = (port << 4) \| 0x07;
3beab0f8	91	/* During exclusive message, use label 0x04. */
b7ab614f	92	} else if (consume == 3) {
123990e9	93	*label = (port << 4) \| 0x04;
3beab0f8 TS	94	/* We need to fill whole 3 bytes. Go to next change. */
3beab0f8 TS	95	} else {
b7ab614f	96	consume = 0;
3beab0f8 TS	97	}
	98	} else {
	99	/* The beginning of exclusives. */
123990e9	100	if (msg[0] == 0xf0) {
3beab0f8 TS	101	/* Transfer it in next chance in another condition. */
	102	tscm->on_sysex[port] = true;
	103	return 0;
	104	} else {
	105	/* On running-status. */
123990e9	106	if ((msg[0] & 0x80) != 0x80)
3beab0f8 TS	107	status = tscm->running_status[port];
3beab0f8 TS	108	else
123990e9	109	status = msg[0];
3beab0f8 TS	110
3beab0f8 TS	111	/* Calculate consume bytes. */
b7ab614f TS	112	len = calculate_message_bytes(status);
b7ab614f TS	113	if (len <= 0)
3beab0f8 TS	114	return 0;
	115
	116	/* On running-status. */
123990e9 TS	117	if ((msg[0] & 0x80) != 0x80) {
	118	msg[2] = msg[1];
	119	msg[1] = msg[0];
	120	msg[0] = tscm->running_status[port];
3beab0f8 TS	121	consume--;
3beab0f8 TS	122	} else {
123990e9	123	tscm->running_status[port] = msg[0];
3beab0f8 TS	124	}
	125
	126	/* Confirm length. */
b7ab614f	127	if (consume < len)
3beab0f8	128	return 0;
b7ab614f TS	129	if (consume > len)
b7ab614f TS	130	consume = len;
3beab0f8 TS	131	}
3beab0f8 TS	132
123990e9	133	*label = (port << 4) \| (msg[0] >> 4);
3beab0f8 TS	134	}
3beab0f8 TS	135
b7ab614f	136	return consume;
3beab0f8 TS	137	}
3beab0f8 TS	138
107cc012 TS	139	static void handle_midi_tx(struct fw_card card, struct fw_request request,
	140	int tcode, int destination, int source,
	141	int generation, unsigned long long offset,
	142	void data, size_t length, void callback_data)
	143	{
	144	struct snd_tscm *tscm = callback_data;
	145	u32 buf = (u32 )data;
	146	unsigned int messages;
	147	unsigned int i;
	148	unsigned int port;
	149	struct snd_rawmidi_substream *substream;
	150	u8 *b;
	151	int bytes;
	152
	153	if (offset != tscm->async_handler.offset)
	154	goto end;
	155
	156	messages = length / 8;
	157	for (i = 0; i < messages; i++) {
	158	b = (u8 )(buf + i 2);
	159
	160	port = b[0] >> 4;
	161	/* TODO: support virtual MIDI ports. */
72409705	162	if (port >= tscm->spec->midi_capture_ports)
107cc012 TS	163	goto end;
	164
	165	/* Assume the message length. */
	166	bytes = calculate_message_bytes(b[1]);
	167	/* On MIDI data or exclusives. */
	168	if (bytes <= 0) {
	169	/* Seek the end of exclusives. */
	170	for (bytes = 1; bytes < 4; bytes++) {
	171	if (b[bytes] == 0xf7)
	172	break;
	173	}
	174	if (bytes == 4)
	175	bytes = 3;
	176	}
	177
	178	substream = ACCESS_ONCE(tscm->tx_midi_substreams[port]);
	179	if (substream != NULL)
	180	snd_rawmidi_receive(substream, b + 1, bytes);
	181	}
	182	end:
	183	fw_send_response(card, request, RCODE_COMPLETE);
	184	}
	185
	186	int snd_tscm_transaction_register(struct snd_tscm *tscm)
	187	{
	188	static const struct fw_address_region resp_register_region = {
	189	.start = 0xffffe0000000ull,
	190	.end = 0xffffe000ffffull,
	191	};
3beab0f8	192	unsigned int i;
107cc012 TS	193	int err;
	194
	195	/*
	196	* Usually, two quadlets are transferred by one transaction. The first
	197	* quadlet has MIDI messages, the rest includes timestamp.
	198	* Sometimes, 8 set of the data is transferred by a block transaction.
	199	*/
	200	tscm->async_handler.length = 8 * 8;
	201	tscm->async_handler.address_callback = handle_midi_tx;
	202	tscm->async_handler.callback_data = tscm;
	203
	204	err = fw_core_add_address_handler(&tscm->async_handler,
	205	&resp_register_region);
	206	if (err < 0)
	207	return err;
	208
	209	err = snd_tscm_transaction_reregister(tscm);
	210	if (err < 0)
3beab0f8 TS	211	goto error;
	212
	213	for (i = 0; i < TSCM_MIDI_OUT_PORT_MAX; i++) {
	214	err = snd_fw_async_midi_port_init(
	215	&tscm->out_ports[i], tscm->unit,
	216	TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_RX_QUAD,
	217	4, fill_message);
	218	if (err < 0)
	219	goto error;
	220	}
107cc012	221
3beab0f8 TS	222	return err;
	223	error:
	224	fw_core_remove_address_handler(&tscm->async_handler);
107cc012 TS	225	return err;
	226	}
	227
	228	/* At bus reset, these registers are cleared. */
	229	int snd_tscm_transaction_reregister(struct snd_tscm *tscm)
	230	{
	231	struct fw_device *device = fw_parent_device(tscm->unit);
	232	__be32 reg;
	233	int err;
	234
	235	/* Register messaging address. Block transaction is not allowed. */
	236	reg = cpu_to_be32((device->card->node_id << 16) \|
	237	(tscm->async_handler.offset >> 32));
	238	err = snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
	239	TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_HI,
	240	&reg, sizeof(reg), 0);
	241	if (err < 0)
	242	return err;
	243
	244	reg = cpu_to_be32(tscm->async_handler.offset);
	245	err = snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
	246	TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_LO,
	247	&reg, sizeof(reg), 0);
	248	if (err < 0)
	249	return err;
	250
	251	/* Turn on messaging. */
	252	reg = cpu_to_be32(0x00000001);
69ec98d7	253	err = snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
107cc012 TS	254	TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ON,
107cc012 TS	255	&reg, sizeof(reg), 0);
e65e2cb9 TS	256	if (err < 0)
	257	return err;
	258
	259	/* Turn on FireWire LED. */
	260	reg = cpu_to_be32(0x0001008e);
	261	return snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
	262	TSCM_ADDR_BASE + TSCM_OFFSET_LED_POWER,
	263	&reg, sizeof(reg), 0);
107cc012 TS	264	}
	265
	266	void snd_tscm_transaction_unregister(struct snd_tscm *tscm)
	267	{
	268	__be32 reg;
3beab0f8	269	unsigned int i;
107cc012	270
e65e2cb9 TS	271	/* Turn off FireWire LED. */
	272	reg = cpu_to_be32(0x0000008e);
	273	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
	274	TSCM_ADDR_BASE + TSCM_OFFSET_LED_POWER,
	275	&reg, sizeof(reg), 0);
	276
107cc012 TS	277	/* Turn off messaging. */
	278	reg = cpu_to_be32(0x00000000);
	279	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
	280	TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ON,
	281	&reg, sizeof(reg), 0);
	282
	283	/* Unregister the address. */
	284	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
	285	TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_HI,
	286	&reg, sizeof(reg), 0);
	287	snd_fw_transaction(tscm->unit, TCODE_WRITE_QUADLET_REQUEST,
	288	TSCM_ADDR_BASE + TSCM_OFFSET_MIDI_TX_ADDR_LO,
	289	&reg, sizeof(reg), 0);
	290
	291	fw_core_remove_address_handler(&tscm->async_handler);
3beab0f8 TS	292	for (i = 0; i < TSCM_MIDI_OUT_PORT_MAX; i++)
3beab0f8 TS	293	snd_fw_async_midi_port_destroy(&tscm->out_ports[i]);
107cc012	294	}