xref: /OK3568_Linux_fs/kernel/sound/usb/line6/midibuf.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Line 6 Linux USB driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/slab.h>
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include "midibuf.h"
11*4882a593Smuzhiyun 
midibuf_message_length(unsigned char code)12*4882a593Smuzhiyun static int midibuf_message_length(unsigned char code)
13*4882a593Smuzhiyun {
14*4882a593Smuzhiyun 	int message_length;
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun 	if (code < 0x80)
17*4882a593Smuzhiyun 		message_length = -1;
18*4882a593Smuzhiyun 	else if (code < 0xf0) {
19*4882a593Smuzhiyun 		static const int length[] = { 3, 3, 3, 3, 2, 2, 3 };
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun 		message_length = length[(code >> 4) - 8];
22*4882a593Smuzhiyun 	} else {
23*4882a593Smuzhiyun 		/*
24*4882a593Smuzhiyun 		   Note that according to the MIDI specification 0xf2 is
25*4882a593Smuzhiyun 		   the "Song Position Pointer", but this is used by Line 6
26*4882a593Smuzhiyun 		   to send sysex messages to the host.
27*4882a593Smuzhiyun 		 */
28*4882a593Smuzhiyun 		static const int length[] = { -1, 2, -1, 2, -1, -1, 1, 1, 1, 1,
29*4882a593Smuzhiyun 			1, 1, 1, -1, 1, 1
30*4882a593Smuzhiyun 		};
31*4882a593Smuzhiyun 		message_length = length[code & 0x0f];
32*4882a593Smuzhiyun 	}
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 	return message_length;
35*4882a593Smuzhiyun }
36*4882a593Smuzhiyun 
midibuf_is_empty(struct midi_buffer * this)37*4882a593Smuzhiyun static int midibuf_is_empty(struct midi_buffer *this)
38*4882a593Smuzhiyun {
39*4882a593Smuzhiyun 	return (this->pos_read == this->pos_write) && !this->full;
40*4882a593Smuzhiyun }
41*4882a593Smuzhiyun 
midibuf_is_full(struct midi_buffer * this)42*4882a593Smuzhiyun static int midibuf_is_full(struct midi_buffer *this)
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun 	return this->full;
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun 
line6_midibuf_reset(struct midi_buffer * this)47*4882a593Smuzhiyun void line6_midibuf_reset(struct midi_buffer *this)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun 	this->pos_read = this->pos_write = this->full = 0;
50*4882a593Smuzhiyun 	this->command_prev = -1;
51*4882a593Smuzhiyun }
52*4882a593Smuzhiyun 
line6_midibuf_init(struct midi_buffer * this,int size,int split)53*4882a593Smuzhiyun int line6_midibuf_init(struct midi_buffer *this, int size, int split)
54*4882a593Smuzhiyun {
55*4882a593Smuzhiyun 	this->buf = kmalloc(size, GFP_KERNEL);
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	if (this->buf == NULL)
58*4882a593Smuzhiyun 		return -ENOMEM;
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	this->size = size;
61*4882a593Smuzhiyun 	this->split = split;
62*4882a593Smuzhiyun 	line6_midibuf_reset(this);
63*4882a593Smuzhiyun 	return 0;
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun 
line6_midibuf_bytes_free(struct midi_buffer * this)66*4882a593Smuzhiyun int line6_midibuf_bytes_free(struct midi_buffer *this)
67*4882a593Smuzhiyun {
68*4882a593Smuzhiyun 	return
69*4882a593Smuzhiyun 	    midibuf_is_full(this) ?
70*4882a593Smuzhiyun 	    0 :
71*4882a593Smuzhiyun 	    (this->pos_read - this->pos_write + this->size - 1) % this->size +
72*4882a593Smuzhiyun 	    1;
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun 
line6_midibuf_bytes_used(struct midi_buffer * this)75*4882a593Smuzhiyun int line6_midibuf_bytes_used(struct midi_buffer *this)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun 	return
78*4882a593Smuzhiyun 	    midibuf_is_empty(this) ?
79*4882a593Smuzhiyun 	    0 :
80*4882a593Smuzhiyun 	    (this->pos_write - this->pos_read + this->size - 1) % this->size +
81*4882a593Smuzhiyun 	    1;
82*4882a593Smuzhiyun }
83*4882a593Smuzhiyun 
line6_midibuf_write(struct midi_buffer * this,unsigned char * data,int length)84*4882a593Smuzhiyun int line6_midibuf_write(struct midi_buffer *this, unsigned char *data,
85*4882a593Smuzhiyun 			int length)
86*4882a593Smuzhiyun {
87*4882a593Smuzhiyun 	int bytes_free;
88*4882a593Smuzhiyun 	int length1, length2;
89*4882a593Smuzhiyun 	int skip_active_sense = 0;
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun 	if (midibuf_is_full(this) || (length <= 0))
92*4882a593Smuzhiyun 		return 0;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	/* skip trailing active sense */
95*4882a593Smuzhiyun 	if (data[length - 1] == 0xfe) {
96*4882a593Smuzhiyun 		--length;
97*4882a593Smuzhiyun 		skip_active_sense = 1;
98*4882a593Smuzhiyun 	}
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	bytes_free = line6_midibuf_bytes_free(this);
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	if (length > bytes_free)
103*4882a593Smuzhiyun 		length = bytes_free;
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 	if (length > 0) {
106*4882a593Smuzhiyun 		length1 = this->size - this->pos_write;
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 		if (length < length1) {
109*4882a593Smuzhiyun 			/* no buffer wraparound */
110*4882a593Smuzhiyun 			memcpy(this->buf + this->pos_write, data, length);
111*4882a593Smuzhiyun 			this->pos_write += length;
112*4882a593Smuzhiyun 		} else {
113*4882a593Smuzhiyun 			/* buffer wraparound */
114*4882a593Smuzhiyun 			length2 = length - length1;
115*4882a593Smuzhiyun 			memcpy(this->buf + this->pos_write, data, length1);
116*4882a593Smuzhiyun 			memcpy(this->buf, data + length1, length2);
117*4882a593Smuzhiyun 			this->pos_write = length2;
118*4882a593Smuzhiyun 		}
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 		if (this->pos_write == this->pos_read)
121*4882a593Smuzhiyun 			this->full = 1;
122*4882a593Smuzhiyun 	}
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun 	return length + skip_active_sense;
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun 
line6_midibuf_read(struct midi_buffer * this,unsigned char * data,int length)127*4882a593Smuzhiyun int line6_midibuf_read(struct midi_buffer *this, unsigned char *data,
128*4882a593Smuzhiyun 		       int length)
129*4882a593Smuzhiyun {
130*4882a593Smuzhiyun 	int bytes_used;
131*4882a593Smuzhiyun 	int length1, length2;
132*4882a593Smuzhiyun 	int command;
133*4882a593Smuzhiyun 	int midi_length;
134*4882a593Smuzhiyun 	int repeat = 0;
135*4882a593Smuzhiyun 	int i;
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	/* we need to be able to store at least a 3 byte MIDI message */
138*4882a593Smuzhiyun 	if (length < 3)
139*4882a593Smuzhiyun 		return -EINVAL;
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	if (midibuf_is_empty(this))
142*4882a593Smuzhiyun 		return 0;
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun 	bytes_used = line6_midibuf_bytes_used(this);
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun 	if (length > bytes_used)
147*4882a593Smuzhiyun 		length = bytes_used;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 	length1 = this->size - this->pos_read;
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun 	/* check MIDI command length */
152*4882a593Smuzhiyun 	command = this->buf[this->pos_read];
153*4882a593Smuzhiyun 
154*4882a593Smuzhiyun 	if (command & 0x80) {
155*4882a593Smuzhiyun 		midi_length = midibuf_message_length(command);
156*4882a593Smuzhiyun 		this->command_prev = command;
157*4882a593Smuzhiyun 	} else {
158*4882a593Smuzhiyun 		if (this->command_prev > 0) {
159*4882a593Smuzhiyun 			int midi_length_prev =
160*4882a593Smuzhiyun 			    midibuf_message_length(this->command_prev);
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun 			if (midi_length_prev > 1) {
163*4882a593Smuzhiyun 				midi_length = midi_length_prev - 1;
164*4882a593Smuzhiyun 				repeat = 1;
165*4882a593Smuzhiyun 			} else
166*4882a593Smuzhiyun 				midi_length = -1;
167*4882a593Smuzhiyun 		} else
168*4882a593Smuzhiyun 			midi_length = -1;
169*4882a593Smuzhiyun 	}
170*4882a593Smuzhiyun 
171*4882a593Smuzhiyun 	if (midi_length < 0) {
172*4882a593Smuzhiyun 		/* search for end of message */
173*4882a593Smuzhiyun 		if (length < length1) {
174*4882a593Smuzhiyun 			/* no buffer wraparound */
175*4882a593Smuzhiyun 			for (i = 1; i < length; ++i)
176*4882a593Smuzhiyun 				if (this->buf[this->pos_read + i] & 0x80)
177*4882a593Smuzhiyun 					break;
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 			midi_length = i;
180*4882a593Smuzhiyun 		} else {
181*4882a593Smuzhiyun 			/* buffer wraparound */
182*4882a593Smuzhiyun 			length2 = length - length1;
183*4882a593Smuzhiyun 
184*4882a593Smuzhiyun 			for (i = 1; i < length1; ++i)
185*4882a593Smuzhiyun 				if (this->buf[this->pos_read + i] & 0x80)
186*4882a593Smuzhiyun 					break;
187*4882a593Smuzhiyun 
188*4882a593Smuzhiyun 			if (i < length1)
189*4882a593Smuzhiyun 				midi_length = i;
190*4882a593Smuzhiyun 			else {
191*4882a593Smuzhiyun 				for (i = 0; i < length2; ++i)
192*4882a593Smuzhiyun 					if (this->buf[i] & 0x80)
193*4882a593Smuzhiyun 						break;
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun 				midi_length = length1 + i;
196*4882a593Smuzhiyun 			}
197*4882a593Smuzhiyun 		}
198*4882a593Smuzhiyun 
199*4882a593Smuzhiyun 		if (midi_length == length)
200*4882a593Smuzhiyun 			midi_length = -1;	/* end of message not found */
201*4882a593Smuzhiyun 	}
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun 	if (midi_length < 0) {
204*4882a593Smuzhiyun 		if (!this->split)
205*4882a593Smuzhiyun 			return 0;	/* command is not yet complete */
206*4882a593Smuzhiyun 	} else {
207*4882a593Smuzhiyun 		if (length < midi_length)
208*4882a593Smuzhiyun 			return 0;	/* command is not yet complete */
209*4882a593Smuzhiyun 
210*4882a593Smuzhiyun 		length = midi_length;
211*4882a593Smuzhiyun 	}
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun 	if (length < length1) {
214*4882a593Smuzhiyun 		/* no buffer wraparound */
215*4882a593Smuzhiyun 		memcpy(data + repeat, this->buf + this->pos_read, length);
216*4882a593Smuzhiyun 		this->pos_read += length;
217*4882a593Smuzhiyun 	} else {
218*4882a593Smuzhiyun 		/* buffer wraparound */
219*4882a593Smuzhiyun 		length2 = length - length1;
220*4882a593Smuzhiyun 		memcpy(data + repeat, this->buf + this->pos_read, length1);
221*4882a593Smuzhiyun 		memcpy(data + repeat + length1, this->buf, length2);
222*4882a593Smuzhiyun 		this->pos_read = length2;
223*4882a593Smuzhiyun 	}
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun 	if (repeat)
226*4882a593Smuzhiyun 		data[0] = this->command_prev;
227*4882a593Smuzhiyun 
228*4882a593Smuzhiyun 	this->full = 0;
229*4882a593Smuzhiyun 	return length + repeat;
230*4882a593Smuzhiyun }
231*4882a593Smuzhiyun 
line6_midibuf_ignore(struct midi_buffer * this,int length)232*4882a593Smuzhiyun int line6_midibuf_ignore(struct midi_buffer *this, int length)
233*4882a593Smuzhiyun {
234*4882a593Smuzhiyun 	int bytes_used = line6_midibuf_bytes_used(this);
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun 	if (length > bytes_used)
237*4882a593Smuzhiyun 		length = bytes_used;
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 	this->pos_read = (this->pos_read + length) % this->size;
240*4882a593Smuzhiyun 	this->full = 0;
241*4882a593Smuzhiyun 	return length;
242*4882a593Smuzhiyun }
243*4882a593Smuzhiyun 
line6_midibuf_destroy(struct midi_buffer * this)244*4882a593Smuzhiyun void line6_midibuf_destroy(struct midi_buffer *this)
245*4882a593Smuzhiyun {
246*4882a593Smuzhiyun 	kfree(this->buf);
247*4882a593Smuzhiyun 	this->buf = NULL;
248*4882a593Smuzhiyun }
249