1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2007, 2008 Karsten Wiese <fzu@wemgehoertderstaat.de>
9 #include "usb_stream.h"
14 static unsigned usb_stream_next_packet_size(struct usb_stream_kernel *sk)
16 struct usb_stream *s = sk->s;
17 sk->out_phase_peeked = (sk->out_phase & 0xffff) + sk->freqn;
18 return (sk->out_phase_peeked >> 16) * s->cfg.frame_size;
21 static void playback_prep_freqn(struct usb_stream_kernel *sk, struct urb *urb)
23 struct usb_stream *s = sk->s;
26 for (pack = 0; pack < sk->n_o_ps; pack++) {
27 int l = usb_stream_next_packet_size(sk);
28 if (s->idle_outsize + lb + l > s->period_size)
31 sk->out_phase = sk->out_phase_peeked;
32 urb->iso_frame_desc[pack].offset = lb;
33 urb->iso_frame_desc[pack].length = l;
36 snd_printdd(KERN_DEBUG "%i\n", lb);
39 urb->number_of_packets = pack;
40 urb->transfer_buffer_length = lb;
41 s->idle_outsize += lb - s->period_size;
42 snd_printdd(KERN_DEBUG "idle=%i ul=%i ps=%i\n", s->idle_outsize,
46 static int init_pipe_urbs(struct usb_stream_kernel *sk, unsigned use_packsize,
47 struct urb **urbs, char *transfer,
48 struct usb_device *dev, int pipe)
51 int maxpacket = use_packsize ?
52 use_packsize : usb_maxpacket(dev, pipe, usb_pipeout(pipe));
53 int transfer_length = maxpacket * sk->n_o_ps;
55 for (u = 0; u < USB_STREAM_NURBS;
56 ++u, transfer += transfer_length) {
57 struct urb *urb = urbs[u];
58 struct usb_iso_packet_descriptor *desc;
59 urb->transfer_buffer = transfer;
62 urb->number_of_packets = sk->n_o_ps;
65 if (usb_pipeout(pipe))
67 if (usb_urb_ep_type_check(urb))
70 urb->transfer_buffer_length = transfer_length;
71 desc = urb->iso_frame_desc;
73 desc->length = maxpacket;
74 for (p = 1; p < sk->n_o_ps; ++p) {
75 desc[p].offset = desc[p - 1].offset + maxpacket;
76 desc[p].length = maxpacket;
83 static int init_urbs(struct usb_stream_kernel *sk, unsigned use_packsize,
84 struct usb_device *dev, int in_pipe, int out_pipe)
86 struct usb_stream *s = sk->s;
87 char *indata = (char *)s + sizeof(*s) +
88 sizeof(struct usb_stream_packet) *
92 for (u = 0; u < USB_STREAM_NURBS; ++u) {
93 sk->inurb[u] = usb_alloc_urb(sk->n_o_ps, GFP_KERNEL);
97 sk->outurb[u] = usb_alloc_urb(sk->n_o_ps, GFP_KERNEL);
102 if (init_pipe_urbs(sk, use_packsize, sk->inurb, indata, dev, in_pipe) ||
103 init_pipe_urbs(sk, use_packsize, sk->outurb, sk->write_page, dev,
112 * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
113 * this will overflow at approx 524 kHz
115 static inline unsigned get_usb_full_speed_rate(unsigned rate)
117 return ((rate << 13) + 62) / 125;
121 * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
122 * this will overflow at approx 4 MHz
124 static inline unsigned get_usb_high_speed_rate(unsigned rate)
126 return ((rate << 10) + 62) / 125;
129 void usb_stream_free(struct usb_stream_kernel *sk)
131 struct usb_stream *s;
134 for (u = 0; u < USB_STREAM_NURBS; ++u) {
135 usb_free_urb(sk->inurb[u]);
137 usb_free_urb(sk->outurb[u]);
138 sk->outurb[u] = NULL;
145 if (sk->write_page) {
146 free_pages_exact(sk->write_page, s->write_size);
147 sk->write_page = NULL;
150 free_pages_exact(s, s->read_size);
154 struct usb_stream *usb_stream_new(struct usb_stream_kernel *sk,
155 struct usb_device *dev,
156 unsigned in_endpoint, unsigned out_endpoint,
157 unsigned sample_rate, unsigned use_packsize,
158 unsigned period_frames, unsigned frame_size)
160 int packets, max_packsize;
161 int in_pipe, out_pipe;
162 int read_size = sizeof(struct usb_stream);
164 int usb_frames = dev->speed == USB_SPEED_HIGH ? 8000 : 1000;
166 in_pipe = usb_rcvisocpipe(dev, in_endpoint);
167 out_pipe = usb_sndisocpipe(dev, out_endpoint);
169 max_packsize = use_packsize ?
170 use_packsize : usb_maxpacket(dev, in_pipe, 0);
173 t_period = period_frames / sample_rate
174 iso_packs = t_period / t_iso_frame
175 = (period_frames / sample_rate) * (1 / t_iso_frame)
178 packets = period_frames * usb_frames / sample_rate + 1;
180 if (dev->speed == USB_SPEED_HIGH)
181 packets = (packets + 7) & ~7;
183 read_size += packets * USB_STREAM_URBDEPTH *
184 (max_packsize + sizeof(struct usb_stream_packet));
186 max_packsize = usb_maxpacket(dev, out_pipe, 1);
187 write_size = max_packsize * packets * USB_STREAM_URBDEPTH;
189 if (read_size >= 256*PAGE_SIZE || write_size >= 256*PAGE_SIZE) {
190 snd_printk(KERN_WARNING "a size exceeds 128*PAGE_SIZE\n");
194 sk->s = alloc_pages_exact(read_size,
195 GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN);
197 pr_warn("us122l: couldn't allocate read buffer\n");
200 sk->s->cfg.version = USB_STREAM_INTERFACE_VERSION;
202 sk->s->read_size = read_size;
204 sk->s->cfg.sample_rate = sample_rate;
205 sk->s->cfg.frame_size = frame_size;
206 sk->n_o_ps = packets;
207 sk->s->inpackets = packets * USB_STREAM_URBDEPTH;
208 sk->s->cfg.period_frames = period_frames;
209 sk->s->period_size = frame_size * period_frames;
211 sk->s->write_size = write_size;
213 sk->write_page = alloc_pages_exact(write_size,
214 GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN);
215 if (!sk->write_page) {
216 pr_warn("us122l: couldn't allocate write buffer\n");
221 /* calculate the frequency in 16.16 format */
222 if (dev->speed == USB_SPEED_FULL)
223 sk->freqn = get_usb_full_speed_rate(sample_rate);
225 sk->freqn = get_usb_high_speed_rate(sample_rate);
227 if (init_urbs(sk, use_packsize, dev, in_pipe, out_pipe) < 0) {
232 sk->s->state = usb_stream_stopped;
240 static bool balance_check(struct usb_stream_kernel *sk, struct urb *urb)
243 if (unlikely(urb->status)) {
244 if (urb->status != -ESHUTDOWN && urb->status != -ENOENT)
245 snd_printk(KERN_WARNING "status=%i\n", urb->status);
246 sk->iso_frame_balance = 0x7FFFFFFF;
249 r = sk->iso_frame_balance == 0;
255 static bool balance_playback(struct usb_stream_kernel *sk, struct urb *urb)
257 sk->iso_frame_balance += urb->number_of_packets;
258 return balance_check(sk, urb);
261 static bool balance_capture(struct usb_stream_kernel *sk, struct urb *urb)
263 sk->iso_frame_balance -= urb->number_of_packets;
264 return balance_check(sk, urb);
267 static void subs_set_complete(struct urb **urbs, void (*complete)(struct urb *))
271 for (u = 0; u < USB_STREAM_NURBS; u++) {
272 struct urb *urb = urbs[u];
273 urb->complete = complete;
277 static int usb_stream_prepare_playback(struct usb_stream_kernel *sk,
280 struct usb_stream *s = sk->s;
282 struct usb_iso_packet_descriptor *id, *od;
283 int p = 0, lb = 0, l = 0;
285 io = sk->idle_outurb;
286 od = io->iso_frame_desc;
288 for (; s->sync_packet < 0; ++p, ++s->sync_packet) {
289 struct urb *ii = sk->completed_inurb;
290 id = ii->iso_frame_desc +
291 ii->number_of_packets + s->sync_packet;
292 l = id->actual_length;
300 s->sync_packet < inurb->number_of_packets && p < sk->n_o_ps;
301 ++p, ++s->sync_packet) {
302 l = inurb->iso_frame_desc[s->sync_packet].actual_length;
304 if (s->idle_outsize + lb + l > s->period_size)
313 s->sync_packet -= inurb->number_of_packets;
314 if (unlikely(s->sync_packet < -2 || s->sync_packet > 0)) {
315 snd_printk(KERN_WARNING "invalid sync_packet = %i;"
316 " p=%i nop=%i %i %x %x %x > %x\n",
317 s->sync_packet, p, inurb->number_of_packets,
318 s->idle_outsize + lb + l,
319 s->idle_outsize, lb, l,
323 if (unlikely(lb % s->cfg.frame_size)) {
324 snd_printk(KERN_WARNING"invalid outsize = %i\n",
328 s->idle_outsize += lb - s->period_size;
329 io->number_of_packets = p;
330 io->transfer_buffer_length = lb;
331 if (s->idle_outsize <= 0)
334 snd_printk(KERN_WARNING "idle=%i\n", s->idle_outsize);
338 static void prepare_inurb(int number_of_packets, struct urb *iu)
340 struct usb_iso_packet_descriptor *id;
343 iu->number_of_packets = number_of_packets;
344 id = iu->iso_frame_desc;
346 for (p = 0; p < iu->number_of_packets - 1; ++p)
347 id[p + 1].offset = id[p].offset + id[p].length;
349 iu->transfer_buffer_length =
350 id[0].length * iu->number_of_packets;
353 static int submit_urbs(struct usb_stream_kernel *sk,
354 struct urb *inurb, struct urb *outurb)
357 prepare_inurb(sk->idle_outurb->number_of_packets, sk->idle_inurb);
358 err = usb_submit_urb(sk->idle_inurb, GFP_ATOMIC);
362 sk->idle_inurb = sk->completed_inurb;
363 sk->completed_inurb = inurb;
364 err = usb_submit_urb(sk->idle_outurb, GFP_ATOMIC);
368 sk->idle_outurb = sk->completed_outurb;
369 sk->completed_outurb = outurb;
373 snd_printk(KERN_ERR "%i\n", err);
377 #ifdef DEBUG_LOOP_BACK
379 This loop_back() shows how to read/write the period data.
381 static void loop_back(struct usb_stream *s)
386 struct usb_iso_packet_descriptor *id;
388 o = s->playback1st_to;
389 ol = s->playback1st_size;
392 if (s->insplit_pack >= 0) {
394 id = iu->iso_frame_desc;
399 for (; p < iu->number_of_packets && l < s->period_size; ++p) {
400 i = iu->transfer_buffer + id[p].offset;
401 il = id[p].actual_length;
402 if (l + il > s->period_size)
403 il = s->period_size - l;
412 memcpy(o, i + ol, il - ol);
414 ol = s->period_size - s->playback1st_size;
418 if (iu == sk->completed_inurb) {
419 if (l != s->period_size)
420 printk(KERN_DEBUG"%s:%i %i\n", __func__, __LINE__,
421 l/(int)s->cfg.frame_size);
426 iu = sk->completed_inurb;
427 id = iu->iso_frame_desc;
433 static void loop_back(struct usb_stream *s)
438 static void stream_idle(struct usb_stream_kernel *sk,
439 struct urb *inurb, struct urb *outurb)
441 struct usb_stream *s = sk->s;
443 int insize = s->idle_insize;
446 s->inpacket_split = s->next_inpacket_split;
447 s->inpacket_split_at = s->next_inpacket_split_at;
448 s->next_inpacket_split = -1;
449 s->next_inpacket_split_at = 0;
451 for (p = 0; p < inurb->number_of_packets; ++p) {
452 struct usb_iso_packet_descriptor *id = inurb->iso_frame_desc;
453 l = id[p].actual_length;
454 if (unlikely(l == 0 || id[p].status)) {
455 snd_printk(KERN_WARNING "underrun, status=%u\n",
460 s->inpacket_head %= s->inpackets;
461 if (s->inpacket_split == -1)
462 s->inpacket_split = s->inpacket_head;
464 s->inpacket[s->inpacket_head].offset =
465 id[p].offset + (inurb->transfer_buffer - (void *)s);
466 s->inpacket[s->inpacket_head].length = l;
467 if (insize + l > s->period_size &&
468 s->next_inpacket_split == -1) {
469 s->next_inpacket_split = s->inpacket_head;
470 s->next_inpacket_split_at = s->period_size - insize;
475 s->idle_insize += urb_size - s->period_size;
476 if (s->idle_insize < 0) {
477 snd_printk(KERN_WARNING "%i\n",
478 (s->idle_insize)/(int)s->cfg.frame_size);
481 s->insize_done += urb_size;
484 s->outpacket[0].offset = (sk->idle_outurb->transfer_buffer -
487 if (usb_stream_prepare_playback(sk, inurb) < 0)
490 s->outpacket[0].length = sk->idle_outurb->transfer_buffer_length + l;
491 s->outpacket[1].offset = sk->completed_outurb->transfer_buffer -
494 if (submit_urbs(sk, inurb, outurb) < 0)
499 wake_up_all(&sk->sleep);
502 s->state = usb_stream_xrun;
503 wake_up_all(&sk->sleep);
506 static void i_capture_idle(struct urb *urb)
508 struct usb_stream_kernel *sk = urb->context;
509 if (balance_capture(sk, urb))
510 stream_idle(sk, urb, sk->i_urb);
513 static void i_playback_idle(struct urb *urb)
515 struct usb_stream_kernel *sk = urb->context;
516 if (balance_playback(sk, urb))
517 stream_idle(sk, sk->i_urb, urb);
520 static void stream_start(struct usb_stream_kernel *sk,
521 struct urb *inurb, struct urb *outurb)
523 struct usb_stream *s = sk->s;
524 if (s->state >= usb_stream_sync1) {
525 int l, p, max_diff, max_diff_0;
527 unsigned frames_per_packet, min_frames = 0;
528 frames_per_packet = (s->period_size - s->idle_insize);
529 frames_per_packet <<= 8;
531 s->cfg.frame_size * inurb->number_of_packets;
534 max_diff_0 = s->cfg.frame_size;
535 if (s->cfg.period_frames >= 256)
537 if (s->cfg.period_frames >= 1024)
539 max_diff = max_diff_0;
540 for (p = 0; p < inurb->number_of_packets; ++p) {
542 l = inurb->iso_frame_desc[p].actual_length;
545 min_frames += frames_per_packet;
547 (min_frames >> 8) * s->cfg.frame_size;
548 if (diff < max_diff) {
549 snd_printdd(KERN_DEBUG "%i %i %i %i\n",
551 urb_size / (int)s->cfg.frame_size,
552 inurb->number_of_packets, diff);
556 s->idle_insize -= max_diff - max_diff_0;
557 s->idle_insize += urb_size - s->period_size;
558 if (s->idle_insize < 0) {
559 snd_printk(KERN_WARNING "%i %i %i\n",
560 s->idle_insize, urb_size, s->period_size);
562 } else if (s->idle_insize == 0) {
563 s->next_inpacket_split =
564 (s->inpacket_head + 1) % s->inpackets;
565 s->next_inpacket_split_at = 0;
567 unsigned split = s->inpacket_head;
569 while (l > s->inpacket[split].length) {
570 l -= s->inpacket[split].length;
572 split = s->inpackets - 1;
576 s->next_inpacket_split = split;
577 s->next_inpacket_split_at =
578 s->inpacket[split].length - l;
581 s->insize_done += urb_size;
583 if (usb_stream_prepare_playback(sk, inurb) < 0)
587 playback_prep_freqn(sk, sk->idle_outurb);
589 if (submit_urbs(sk, inurb, outurb) < 0)
592 if (s->state == usb_stream_sync1 && s->insize_done > 360000) {
593 /* just guesswork ^^^^^^ */
594 s->state = usb_stream_ready;
595 subs_set_complete(sk->inurb, i_capture_idle);
596 subs_set_complete(sk->outurb, i_playback_idle);
600 static void i_capture_start(struct urb *urb)
602 struct usb_iso_packet_descriptor *id = urb->iso_frame_desc;
603 struct usb_stream_kernel *sk = urb->context;
604 struct usb_stream *s = sk->s;
609 snd_printk(KERN_WARNING "status=%i\n", urb->status);
613 for (p = 0; p < urb->number_of_packets; ++p) {
614 int l = id[p].actual_length;
615 if (l < s->cfg.frame_size) {
617 if (s->state >= usb_stream_sync0) {
618 snd_printk(KERN_WARNING "%i\n", l);
623 s->inpacket_head %= s->inpackets;
624 s->inpacket[s->inpacket_head].offset =
625 id[p].offset + (urb->transfer_buffer - (void *)s);
626 s->inpacket[s->inpacket_head].length = l;
630 printk(KERN_DEBUG"%s:%i: %i", __func__, __LINE__,
631 urb->iso_frame_desc[0].actual_length);
632 for (pack = 1; pack < urb->number_of_packets; ++pack) {
633 int l = urb->iso_frame_desc[pack].actual_length;
634 printk(KERN_CONT " %i", l);
636 printk(KERN_CONT "\n");
639 if (!empty && s->state < usb_stream_sync1)
642 if (balance_capture(sk, urb))
643 stream_start(sk, urb, sk->i_urb);
646 static void i_playback_start(struct urb *urb)
648 struct usb_stream_kernel *sk = urb->context;
649 if (balance_playback(sk, urb))
650 stream_start(sk, sk->i_urb, urb);
653 int usb_stream_start(struct usb_stream_kernel *sk)
655 struct usb_stream *s = sk->s;
656 int frame = 0, iters = 0;
660 if (s->state != usb_stream_stopped)
663 subs_set_complete(sk->inurb, i_capture_start);
664 subs_set_complete(sk->outurb, i_playback_start);
665 memset(sk->write_page, 0, s->write_size);
671 s->inpacket_head = -1;
672 sk->iso_frame_balance = 0;
674 for (u = 0; u < 2; u++) {
675 struct urb *inurb = sk->inurb[u];
676 struct urb *outurb = sk->outurb[u];
677 playback_prep_freqn(sk, outurb);
678 inurb->number_of_packets = outurb->number_of_packets;
679 inurb->transfer_buffer_length =
680 inurb->number_of_packets *
681 inurb->iso_frame_desc[0].length;
685 struct usb_device *dev = inurb->dev;
686 frame = usb_get_current_frame_number(dev);
688 now = usb_get_current_frame_number(dev);
690 } while (now > -1 && now == frame);
692 err = usb_submit_urb(inurb, GFP_ATOMIC);
694 snd_printk(KERN_ERR"usb_submit_urb(sk->inurb[%i])"
695 " returned %i\n", u, err);
698 err = usb_submit_urb(outurb, GFP_ATOMIC);
700 snd_printk(KERN_ERR"usb_submit_urb(sk->outurb[%i])"
701 " returned %i\n", u, err);
705 if (inurb->start_frame != outurb->start_frame) {
706 snd_printd(KERN_DEBUG
707 "u[%i] start_frames differ in:%u out:%u\n",
708 u, inurb->start_frame, outurb->start_frame);
712 snd_printdd(KERN_DEBUG "%i %i\n", frame, iters);
719 snd_printd(KERN_DEBUG "goto dotry;\n");
722 snd_printk(KERN_WARNING"couldn't start"
723 " all urbs on the same start_frame.\n");
727 sk->idle_inurb = sk->inurb[USB_STREAM_NURBS - 2];
728 sk->idle_outurb = sk->outurb[USB_STREAM_NURBS - 2];
729 sk->completed_inurb = sk->inurb[USB_STREAM_NURBS - 1];
730 sk->completed_outurb = sk->outurb[USB_STREAM_NURBS - 1];
735 while (s->state != usb_stream_ready && wait_ms > 0) {
736 snd_printdd(KERN_DEBUG "%i\n", s->state);
742 return s->state == usb_stream_ready ? 0 : -EFAULT;
748 void usb_stream_stop(struct usb_stream_kernel *sk)
753 for (u = 0; u < USB_STREAM_NURBS; ++u) {
754 usb_kill_urb(sk->inurb[u]);
755 usb_kill_urb(sk->outurb[u]);
757 sk->s->state = usb_stream_stopped;