endpoint.c 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221
  1. /*
  2. * This program is free software; you can redistribute it and/or modify
  3. * it under the terms of the GNU General Public License as published by
  4. * the Free Software Foundation; either version 2 of the License, or
  5. * (at your option) any later version.
  6. *
  7. * This program is distributed in the hope that it will be useful,
  8. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. * GNU General Public License for more details.
  11. *
  12. * You should have received a copy of the GNU General Public License
  13. * along with this program; if not, write to the Free Software
  14. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  15. *
  16. */
  17. #include <linux/gfp.h>
  18. #include <linux/init.h>
  19. #include <linux/ratelimit.h>
  20. #include <linux/usb.h>
  21. #include <linux/usb/audio.h>
  22. #include <linux/slab.h>
  23. #include <sound/core.h>
  24. #include <sound/pcm.h>
  25. #include <sound/pcm_params.h>
  26. #include "usbaudio.h"
  27. #include "helper.h"
  28. #include "card.h"
  29. #include "endpoint.h"
  30. #include "pcm.h"
  31. #include "quirks.h"
  32. #define EP_FLAG_RUNNING 1
  33. #define EP_FLAG_STOPPING 2
  34. /*
  35. * snd_usb_endpoint is a model that abstracts everything related to an
  36. * USB endpoint and its streaming.
  37. *
  38. * There are functions to activate and deactivate the streaming URBs and
  39. * optional callbacks to let the pcm logic handle the actual content of the
  40. * packets for playback and record. Thus, the bus streaming and the audio
  41. * handlers are fully decoupled.
  42. *
  43. * There are two different types of endpoints in audio applications.
  44. *
  45. * SND_USB_ENDPOINT_TYPE_DATA handles full audio data payload for both
  46. * inbound and outbound traffic.
  47. *
  48. * SND_USB_ENDPOINT_TYPE_SYNC endpoints are for inbound traffic only and
  49. * expect the payload to carry Q10.14 / Q16.16 formatted sync information
  50. * (3 or 4 bytes).
  51. *
  52. * Each endpoint has to be configured prior to being used by calling
  53. * snd_usb_endpoint_set_params().
  54. *
  55. * The model incorporates a reference counting, so that multiple users
  56. * can call snd_usb_endpoint_start() and snd_usb_endpoint_stop(), and
  57. * only the first user will effectively start the URBs, and only the last
  58. * one to stop it will tear the URBs down again.
  59. */
  60. /*
  61. * convert a sampling rate into our full speed format (fs/1000 in Q16.16)
  62. * this will overflow at approx 524 kHz
  63. */
  64. static inline unsigned get_usb_full_speed_rate(unsigned int rate)
  65. {
  66. return ((rate << 13) + 62) / 125;
  67. }
  68. /*
  69. * convert a sampling rate into USB high speed format (fs/8000 in Q16.16)
  70. * this will overflow at approx 4 MHz
  71. */
  72. static inline unsigned get_usb_high_speed_rate(unsigned int rate)
  73. {
  74. return ((rate << 10) + 62) / 125;
  75. }
  76. /*
  77. * release a urb data
  78. */
  79. static void release_urb_ctx(struct snd_urb_ctx *u)
  80. {
  81. if (u->buffer_size)
  82. usb_free_coherent(u->ep->chip->dev, u->buffer_size,
  83. u->urb->transfer_buffer,
  84. u->urb->transfer_dma);
  85. usb_free_urb(u->urb);
  86. u->urb = NULL;
  87. }
  88. static const char *usb_error_string(int err)
  89. {
  90. switch (err) {
  91. case -ENODEV:
  92. return "no device";
  93. case -ENOENT:
  94. return "endpoint not enabled";
  95. case -EPIPE:
  96. return "endpoint stalled";
  97. case -ENOSPC:
  98. return "not enough bandwidth";
  99. case -ESHUTDOWN:
  100. return "device disabled";
  101. case -EHOSTUNREACH:
  102. return "device suspended";
  103. case -EINVAL:
  104. case -EAGAIN:
  105. case -EFBIG:
  106. case -EMSGSIZE:
  107. return "internal error";
  108. default:
  109. return "unknown error";
  110. }
  111. }
  112. /**
  113. * snd_usb_endpoint_implicit_feedback_sink: Report endpoint usage type
  114. *
  115. * @ep: The snd_usb_endpoint
  116. *
  117. * Determine whether an endpoint is driven by an implicit feedback
  118. * data endpoint source.
  119. */
  120. int snd_usb_endpoint_implicit_feedback_sink(struct snd_usb_endpoint *ep)
  121. {
  122. return ep->sync_master &&
  123. ep->sync_master->type == SND_USB_ENDPOINT_TYPE_DATA &&
  124. ep->type == SND_USB_ENDPOINT_TYPE_DATA &&
  125. usb_pipeout(ep->pipe);
  126. }
  127. /*
  128. * For streaming based on information derived from sync endpoints,
  129. * prepare_outbound_urb_sizes() will call next_packet_size() to
  130. * determine the number of samples to be sent in the next packet.
  131. *
  132. * For implicit feedback, next_packet_size() is unused.
  133. */
  134. int snd_usb_endpoint_next_packet_size(struct snd_usb_endpoint *ep)
  135. {
  136. unsigned long flags;
  137. int ret;
  138. if (ep->fill_max)
  139. return ep->maxframesize;
  140. spin_lock_irqsave(&ep->lock, flags);
  141. ep->phase = (ep->phase & 0xffff)
  142. + (ep->freqm << ep->datainterval);
  143. ret = min(ep->phase >> 16, ep->maxframesize);
  144. spin_unlock_irqrestore(&ep->lock, flags);
  145. return ret;
  146. }
  147. static void retire_outbound_urb(struct snd_usb_endpoint *ep,
  148. struct snd_urb_ctx *urb_ctx)
  149. {
  150. if (ep->retire_data_urb)
  151. ep->retire_data_urb(ep->data_subs, urb_ctx->urb);
  152. }
  153. static void retire_inbound_urb(struct snd_usb_endpoint *ep,
  154. struct snd_urb_ctx *urb_ctx)
  155. {
  156. struct urb *urb = urb_ctx->urb;
  157. if (unlikely(ep->skip_packets > 0)) {
  158. ep->skip_packets--;
  159. return;
  160. }
  161. if (ep->sync_slave)
  162. snd_usb_handle_sync_urb(ep->sync_slave, ep, urb);
  163. if (ep->retire_data_urb)
  164. ep->retire_data_urb(ep->data_subs, urb);
  165. }
  166. static void prepare_silent_urb(struct snd_usb_endpoint *ep,
  167. struct snd_urb_ctx *ctx)
  168. {
  169. struct urb *urb = ctx->urb;
  170. unsigned int offs = 0;
  171. unsigned int extra = 0;
  172. __le32 packet_length;
  173. int i;
  174. /* For tx_length_quirk, put packet length at start of packet */
  175. if (ep->chip->tx_length_quirk)
  176. extra = sizeof(packet_length);
  177. for (i = 0; i < ctx->packets; ++i) {
  178. unsigned int offset;
  179. unsigned int length;
  180. int counts;
  181. if (ctx->packet_size[i])
  182. counts = ctx->packet_size[i];
  183. else
  184. counts = snd_usb_endpoint_next_packet_size(ep);
  185. length = counts * ep->stride; /* number of silent bytes */
  186. offset = offs * ep->stride + extra * i;
  187. urb->iso_frame_desc[i].offset = offset;
  188. urb->iso_frame_desc[i].length = length + extra;
  189. if (extra) {
  190. packet_length = cpu_to_le32(length);
  191. memcpy(urb->transfer_buffer + offset,
  192. &packet_length, sizeof(packet_length));
  193. }
  194. memset(urb->transfer_buffer + offset + extra,
  195. ep->silence_value, length);
  196. offs += counts;
  197. }
  198. urb->number_of_packets = ctx->packets;
  199. urb->transfer_buffer_length = offs * ep->stride + ctx->packets * extra;
  200. }
  201. /*
  202. * Prepare a PLAYBACK urb for submission to the bus.
  203. */
  204. static void prepare_outbound_urb(struct snd_usb_endpoint *ep,
  205. struct snd_urb_ctx *ctx)
  206. {
  207. struct urb *urb = ctx->urb;
  208. unsigned char *cp = urb->transfer_buffer;
  209. urb->dev = ep->chip->dev; /* we need to set this at each time */
  210. switch (ep->type) {
  211. case SND_USB_ENDPOINT_TYPE_DATA:
  212. if (ep->prepare_data_urb) {
  213. ep->prepare_data_urb(ep->data_subs, urb);
  214. } else {
  215. /* no data provider, so send silence */
  216. prepare_silent_urb(ep, ctx);
  217. }
  218. break;
  219. case SND_USB_ENDPOINT_TYPE_SYNC:
  220. if (snd_usb_get_speed(ep->chip->dev) >= USB_SPEED_HIGH) {
  221. /*
  222. * fill the length and offset of each urb descriptor.
  223. * the fixed 12.13 frequency is passed as 16.16 through the pipe.
  224. */
  225. urb->iso_frame_desc[0].length = 4;
  226. urb->iso_frame_desc[0].offset = 0;
  227. cp[0] = ep->freqn;
  228. cp[1] = ep->freqn >> 8;
  229. cp[2] = ep->freqn >> 16;
  230. cp[3] = ep->freqn >> 24;
  231. } else {
  232. /*
  233. * fill the length and offset of each urb descriptor.
  234. * the fixed 10.14 frequency is passed through the pipe.
  235. */
  236. urb->iso_frame_desc[0].length = 3;
  237. urb->iso_frame_desc[0].offset = 0;
  238. cp[0] = ep->freqn >> 2;
  239. cp[1] = ep->freqn >> 10;
  240. cp[2] = ep->freqn >> 18;
  241. }
  242. break;
  243. }
  244. }
  245. /*
  246. * Prepare a CAPTURE or SYNC urb for submission to the bus.
  247. */
  248. static inline void prepare_inbound_urb(struct snd_usb_endpoint *ep,
  249. struct snd_urb_ctx *urb_ctx)
  250. {
  251. int i, offs;
  252. struct urb *urb = urb_ctx->urb;
  253. urb->dev = ep->chip->dev; /* we need to set this at each time */
  254. switch (ep->type) {
  255. case SND_USB_ENDPOINT_TYPE_DATA:
  256. offs = 0;
  257. for (i = 0; i < urb_ctx->packets; i++) {
  258. urb->iso_frame_desc[i].offset = offs;
  259. urb->iso_frame_desc[i].length = ep->curpacksize;
  260. offs += ep->curpacksize;
  261. }
  262. urb->transfer_buffer_length = offs;
  263. urb->number_of_packets = urb_ctx->packets;
  264. break;
  265. case SND_USB_ENDPOINT_TYPE_SYNC:
  266. urb->iso_frame_desc[0].length = min(4u, ep->syncmaxsize);
  267. urb->iso_frame_desc[0].offset = 0;
  268. break;
  269. }
  270. }
  271. /*
  272. * Send output urbs that have been prepared previously. URBs are dequeued
  273. * from ep->ready_playback_urbs and in case there there aren't any available
  274. * or there are no packets that have been prepared, this function does
  275. * nothing.
  276. *
  277. * The reason why the functionality of sending and preparing URBs is separated
  278. * is that host controllers don't guarantee the order in which they return
  279. * inbound and outbound packets to their submitters.
  280. *
  281. * This function is only used for implicit feedback endpoints. For endpoints
  282. * driven by dedicated sync endpoints, URBs are immediately re-submitted
  283. * from their completion handler.
  284. */
  285. static void queue_pending_output_urbs(struct snd_usb_endpoint *ep)
  286. {
  287. while (test_bit(EP_FLAG_RUNNING, &ep->flags)) {
  288. unsigned long flags;
  289. struct snd_usb_packet_info *uninitialized_var(packet);
  290. struct snd_urb_ctx *ctx = NULL;
  291. struct urb *urb;
  292. int err, i;
  293. spin_lock_irqsave(&ep->lock, flags);
  294. if (ep->next_packet_read_pos != ep->next_packet_write_pos) {
  295. packet = ep->next_packet + ep->next_packet_read_pos;
  296. ep->next_packet_read_pos++;
  297. ep->next_packet_read_pos %= MAX_URBS;
  298. /* take URB out of FIFO */
  299. if (!list_empty(&ep->ready_playback_urbs))
  300. ctx = list_first_entry(&ep->ready_playback_urbs,
  301. struct snd_urb_ctx, ready_list);
  302. }
  303. spin_unlock_irqrestore(&ep->lock, flags);
  304. if (ctx == NULL)
  305. return;
  306. list_del_init(&ctx->ready_list);
  307. urb = ctx->urb;
  308. /* copy over the length information */
  309. for (i = 0; i < packet->packets; i++)
  310. ctx->packet_size[i] = packet->packet_size[i];
  311. /* call the data handler to fill in playback data */
  312. prepare_outbound_urb(ep, ctx);
  313. err = usb_submit_urb(ctx->urb, GFP_ATOMIC);
  314. if (err < 0)
  315. usb_audio_err(ep->chip,
  316. "Unable to submit urb #%d: %d (urb %p)\n",
  317. ctx->index, err, ctx->urb);
  318. else
  319. set_bit(ctx->index, &ep->active_mask);
  320. }
  321. }
  322. /*
  323. * complete callback for urbs
  324. */
  325. static void snd_complete_urb(struct urb *urb)
  326. {
  327. struct snd_urb_ctx *ctx = urb->context;
  328. struct snd_usb_endpoint *ep = ctx->ep;
  329. struct snd_pcm_substream *substream;
  330. unsigned long flags;
  331. int err;
  332. if (unlikely(urb->status == -ENOENT || /* unlinked */
  333. urb->status == -ENODEV || /* device removed */
  334. urb->status == -ECONNRESET || /* unlinked */
  335. urb->status == -ESHUTDOWN)) /* device disabled */
  336. goto exit_clear;
  337. /* device disconnected */
  338. if (unlikely(atomic_read(&ep->chip->shutdown)))
  339. goto exit_clear;
  340. if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
  341. goto exit_clear;
  342. if (usb_pipeout(ep->pipe)) {
  343. retire_outbound_urb(ep, ctx);
  344. /* can be stopped during retire callback */
  345. if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
  346. goto exit_clear;
  347. if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
  348. spin_lock_irqsave(&ep->lock, flags);
  349. list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
  350. spin_unlock_irqrestore(&ep->lock, flags);
  351. queue_pending_output_urbs(ep);
  352. goto exit_clear;
  353. }
  354. prepare_outbound_urb(ep, ctx);
  355. } else {
  356. retire_inbound_urb(ep, ctx);
  357. /* can be stopped during retire callback */
  358. if (unlikely(!test_bit(EP_FLAG_RUNNING, &ep->flags)))
  359. goto exit_clear;
  360. prepare_inbound_urb(ep, ctx);
  361. }
  362. err = usb_submit_urb(urb, GFP_ATOMIC);
  363. if (err == 0)
  364. return;
  365. usb_audio_err(ep->chip, "cannot submit urb (err = %d)\n", err);
  366. if (ep->data_subs && ep->data_subs->pcm_substream) {
  367. substream = ep->data_subs->pcm_substream;
  368. snd_pcm_stop_xrun(substream);
  369. }
  370. exit_clear:
  371. clear_bit(ctx->index, &ep->active_mask);
  372. }
  373. /**
  374. * snd_usb_add_endpoint: Add an endpoint to an USB audio chip
  375. *
  376. * @chip: The chip
  377. * @alts: The USB host interface
  378. * @ep_num: The number of the endpoint to use
  379. * @direction: SNDRV_PCM_STREAM_PLAYBACK or SNDRV_PCM_STREAM_CAPTURE
  380. * @type: SND_USB_ENDPOINT_TYPE_DATA or SND_USB_ENDPOINT_TYPE_SYNC
  381. *
  382. * If the requested endpoint has not been added to the given chip before,
  383. * a new instance is created. Otherwise, a pointer to the previoulsy
  384. * created instance is returned. In case of any error, NULL is returned.
  385. *
  386. * New endpoints will be added to chip->ep_list and must be freed by
  387. * calling snd_usb_endpoint_free().
  388. *
  389. * For SND_USB_ENDPOINT_TYPE_SYNC, the caller needs to guarantee that
  390. * bNumEndpoints > 1 beforehand.
  391. */
  392. struct snd_usb_endpoint *snd_usb_add_endpoint(struct snd_usb_audio *chip,
  393. struct usb_host_interface *alts,
  394. int ep_num, int direction, int type)
  395. {
  396. struct snd_usb_endpoint *ep;
  397. int is_playback = direction == SNDRV_PCM_STREAM_PLAYBACK;
  398. if (WARN_ON(!alts))
  399. return NULL;
  400. mutex_lock(&chip->mutex);
  401. list_for_each_entry(ep, &chip->ep_list, list) {
  402. if (ep->ep_num == ep_num &&
  403. ep->iface == alts->desc.bInterfaceNumber &&
  404. ep->altsetting == alts->desc.bAlternateSetting) {
  405. usb_audio_dbg(ep->chip,
  406. "Re-using EP %x in iface %d,%d @%p\n",
  407. ep_num, ep->iface, ep->altsetting, ep);
  408. goto __exit_unlock;
  409. }
  410. }
  411. usb_audio_dbg(chip, "Creating new %s %s endpoint #%x\n",
  412. is_playback ? "playback" : "capture",
  413. type == SND_USB_ENDPOINT_TYPE_DATA ? "data" : "sync",
  414. ep_num);
  415. ep = kzalloc(sizeof(*ep), GFP_KERNEL);
  416. if (!ep)
  417. goto __exit_unlock;
  418. ep->chip = chip;
  419. spin_lock_init(&ep->lock);
  420. ep->type = type;
  421. ep->ep_num = ep_num;
  422. ep->iface = alts->desc.bInterfaceNumber;
  423. ep->altsetting = alts->desc.bAlternateSetting;
  424. INIT_LIST_HEAD(&ep->ready_playback_urbs);
  425. ep_num &= USB_ENDPOINT_NUMBER_MASK;
  426. if (is_playback)
  427. ep->pipe = usb_sndisocpipe(chip->dev, ep_num);
  428. else
  429. ep->pipe = usb_rcvisocpipe(chip->dev, ep_num);
  430. if (type == SND_USB_ENDPOINT_TYPE_SYNC) {
  431. if (get_endpoint(alts, 1)->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE &&
  432. get_endpoint(alts, 1)->bRefresh >= 1 &&
  433. get_endpoint(alts, 1)->bRefresh <= 9)
  434. ep->syncinterval = get_endpoint(alts, 1)->bRefresh;
  435. else if (snd_usb_get_speed(chip->dev) == USB_SPEED_FULL)
  436. ep->syncinterval = 1;
  437. else if (get_endpoint(alts, 1)->bInterval >= 1 &&
  438. get_endpoint(alts, 1)->bInterval <= 16)
  439. ep->syncinterval = get_endpoint(alts, 1)->bInterval - 1;
  440. else
  441. ep->syncinterval = 3;
  442. ep->syncmaxsize = le16_to_cpu(get_endpoint(alts, 1)->wMaxPacketSize);
  443. if (chip->usb_id == USB_ID(0x0644, 0x8038) /* TEAC UD-H01 */ &&
  444. ep->syncmaxsize == 4)
  445. ep->udh01_fb_quirk = 1;
  446. }
  447. list_add_tail(&ep->list, &chip->ep_list);
  448. __exit_unlock:
  449. mutex_unlock(&chip->mutex);
  450. return ep;
  451. }
  452. /*
  453. * wait until all urbs are processed.
  454. */
  455. static int wait_clear_urbs(struct snd_usb_endpoint *ep)
  456. {
  457. unsigned long end_time = jiffies + msecs_to_jiffies(1000);
  458. int alive;
  459. do {
  460. alive = bitmap_weight(&ep->active_mask, ep->nurbs);
  461. if (!alive)
  462. break;
  463. schedule_timeout_uninterruptible(1);
  464. } while (time_before(jiffies, end_time));
  465. if (alive)
  466. usb_audio_err(ep->chip,
  467. "timeout: still %d active urbs on EP #%x\n",
  468. alive, ep->ep_num);
  469. clear_bit(EP_FLAG_STOPPING, &ep->flags);
  470. ep->data_subs = NULL;
  471. ep->sync_slave = NULL;
  472. ep->retire_data_urb = NULL;
  473. ep->prepare_data_urb = NULL;
  474. return 0;
  475. }
  476. /* sync the pending stop operation;
  477. * this function itself doesn't trigger the stop operation
  478. */
  479. void snd_usb_endpoint_sync_pending_stop(struct snd_usb_endpoint *ep)
  480. {
  481. if (ep && test_bit(EP_FLAG_STOPPING, &ep->flags))
  482. wait_clear_urbs(ep);
  483. }
  484. /*
  485. * unlink active urbs.
  486. */
  487. static int deactivate_urbs(struct snd_usb_endpoint *ep, bool force)
  488. {
  489. unsigned int i;
  490. if (!force && atomic_read(&ep->chip->shutdown)) /* to be sure... */
  491. return -EBADFD;
  492. clear_bit(EP_FLAG_RUNNING, &ep->flags);
  493. INIT_LIST_HEAD(&ep->ready_playback_urbs);
  494. ep->next_packet_read_pos = 0;
  495. ep->next_packet_write_pos = 0;
  496. for (i = 0; i < ep->nurbs; i++) {
  497. if (test_bit(i, &ep->active_mask)) {
  498. if (!test_and_set_bit(i, &ep->unlink_mask)) {
  499. struct urb *u = ep->urb[i].urb;
  500. usb_unlink_urb(u);
  501. }
  502. }
  503. }
  504. return 0;
  505. }
  506. /*
  507. * release an endpoint's urbs
  508. */
  509. static void release_urbs(struct snd_usb_endpoint *ep, int force)
  510. {
  511. int i;
  512. /* route incoming urbs to nirvana */
  513. ep->retire_data_urb = NULL;
  514. ep->prepare_data_urb = NULL;
  515. /* stop urbs */
  516. deactivate_urbs(ep, force);
  517. wait_clear_urbs(ep);
  518. for (i = 0; i < ep->nurbs; i++)
  519. release_urb_ctx(&ep->urb[i]);
  520. if (ep->syncbuf)
  521. usb_free_coherent(ep->chip->dev, SYNC_URBS * 4,
  522. ep->syncbuf, ep->sync_dma);
  523. ep->syncbuf = NULL;
  524. ep->nurbs = 0;
  525. }
  526. /*
  527. * configure a data endpoint
  528. */
  529. static int data_ep_set_params(struct snd_usb_endpoint *ep,
  530. snd_pcm_format_t pcm_format,
  531. unsigned int channels,
  532. unsigned int period_bytes,
  533. unsigned int frames_per_period,
  534. unsigned int periods_per_buffer,
  535. struct audioformat *fmt,
  536. struct snd_usb_endpoint *sync_ep)
  537. {
  538. unsigned int maxsize, minsize, packs_per_ms, max_packs_per_urb;
  539. unsigned int max_packs_per_period, urbs_per_period, urb_packs;
  540. unsigned int max_urbs, i;
  541. int frame_bits = snd_pcm_format_physical_width(pcm_format) * channels;
  542. int tx_length_quirk = (ep->chip->tx_length_quirk &&
  543. usb_pipeout(ep->pipe));
  544. if (pcm_format == SNDRV_PCM_FORMAT_DSD_U16_LE && fmt->dsd_dop) {
  545. /*
  546. * When operating in DSD DOP mode, the size of a sample frame
  547. * in hardware differs from the actual physical format width
  548. * because we need to make room for the DOP markers.
  549. */
  550. frame_bits += channels << 3;
  551. }
  552. ep->datainterval = fmt->datainterval;
  553. ep->stride = frame_bits >> 3;
  554. ep->silence_value = pcm_format == SNDRV_PCM_FORMAT_U8 ? 0x80 : 0;
  555. /* assume max. frequency is 25% higher than nominal */
  556. ep->freqmax = ep->freqn + (ep->freqn >> 2);
  557. /* Round up freqmax to nearest integer in order to calculate maximum
  558. * packet size, which must represent a whole number of frames.
  559. * This is accomplished by adding 0x0.ffff before converting the
  560. * Q16.16 format into integer.
  561. * In order to accurately calculate the maximum packet size when
  562. * the data interval is more than 1 (i.e. ep->datainterval > 0),
  563. * multiply by the data interval prior to rounding. For instance,
  564. * a freqmax of 41 kHz will result in a max packet size of 6 (5.125)
  565. * frames with a data interval of 1, but 11 (10.25) frames with a
  566. * data interval of 2.
  567. * (ep->freqmax << ep->datainterval overflows at 8.192 MHz for the
  568. * maximum datainterval value of 3, at USB full speed, higher for
  569. * USB high speed, noting that ep->freqmax is in units of
  570. * frames per packet in Q16.16 format.)
  571. */
  572. maxsize = (((ep->freqmax << ep->datainterval) + 0xffff) >> 16) *
  573. (frame_bits >> 3);
  574. if (tx_length_quirk)
  575. maxsize += sizeof(__le32); /* Space for length descriptor */
  576. /* but wMaxPacketSize might reduce this */
  577. if (ep->maxpacksize && ep->maxpacksize < maxsize) {
  578. /* whatever fits into a max. size packet */
  579. unsigned int data_maxsize = maxsize = ep->maxpacksize;
  580. if (tx_length_quirk)
  581. /* Need to remove the length descriptor to calc freq */
  582. data_maxsize -= sizeof(__le32);
  583. ep->freqmax = (data_maxsize / (frame_bits >> 3))
  584. << (16 - ep->datainterval);
  585. }
  586. if (ep->fill_max)
  587. ep->curpacksize = ep->maxpacksize;
  588. else
  589. ep->curpacksize = maxsize;
  590. if (snd_usb_get_speed(ep->chip->dev) != USB_SPEED_FULL) {
  591. packs_per_ms = 8 >> ep->datainterval;
  592. max_packs_per_urb = MAX_PACKS_HS;
  593. } else {
  594. packs_per_ms = 1;
  595. max_packs_per_urb = MAX_PACKS;
  596. }
  597. if (sync_ep && !snd_usb_endpoint_implicit_feedback_sink(ep))
  598. max_packs_per_urb = min(max_packs_per_urb,
  599. 1U << sync_ep->syncinterval);
  600. max_packs_per_urb = max(1u, max_packs_per_urb >> ep->datainterval);
  601. /*
  602. * Capture endpoints need to use small URBs because there's no way
  603. * to tell in advance where the next period will end, and we don't
  604. * want the next URB to complete much after the period ends.
  605. *
  606. * Playback endpoints with implicit sync much use the same parameters
  607. * as their corresponding capture endpoint.
  608. */
  609. if (usb_pipein(ep->pipe) ||
  610. snd_usb_endpoint_implicit_feedback_sink(ep)) {
  611. urb_packs = packs_per_ms;
  612. /*
  613. * Wireless devices can poll at a max rate of once per 4ms.
  614. * For dataintervals less than 5, increase the packet count to
  615. * allow the host controller to use bursting to fill in the
  616. * gaps.
  617. */
  618. if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_WIRELESS) {
  619. int interval = ep->datainterval;
  620. while (interval < 5) {
  621. urb_packs <<= 1;
  622. ++interval;
  623. }
  624. }
  625. /* make capture URBs <= 1 ms and smaller than a period */
  626. urb_packs = min(max_packs_per_urb, urb_packs);
  627. while (urb_packs > 1 && urb_packs * maxsize >= period_bytes)
  628. urb_packs >>= 1;
  629. ep->nurbs = MAX_URBS;
  630. /*
  631. * Playback endpoints without implicit sync are adjusted so that
  632. * a period fits as evenly as possible in the smallest number of
  633. * URBs. The total number of URBs is adjusted to the size of the
  634. * ALSA buffer, subject to the MAX_URBS and MAX_QUEUE limits.
  635. */
  636. } else {
  637. /* determine how small a packet can be */
  638. minsize = (ep->freqn >> (16 - ep->datainterval)) *
  639. (frame_bits >> 3);
  640. /* with sync from device, assume it can be 12% lower */
  641. if (sync_ep)
  642. minsize -= minsize >> 3;
  643. minsize = max(minsize, 1u);
  644. /* how many packets will contain an entire ALSA period? */
  645. max_packs_per_period = DIV_ROUND_UP(period_bytes, minsize);
  646. /* how many URBs will contain a period? */
  647. urbs_per_period = DIV_ROUND_UP(max_packs_per_period,
  648. max_packs_per_urb);
  649. /* how many packets are needed in each URB? */
  650. urb_packs = DIV_ROUND_UP(max_packs_per_period, urbs_per_period);
  651. /* limit the number of frames in a single URB */
  652. ep->max_urb_frames = DIV_ROUND_UP(frames_per_period,
  653. urbs_per_period);
  654. /* try to use enough URBs to contain an entire ALSA buffer */
  655. max_urbs = min((unsigned) MAX_URBS,
  656. MAX_QUEUE * packs_per_ms / urb_packs);
  657. ep->nurbs = min(max_urbs, urbs_per_period * periods_per_buffer);
  658. }
  659. /* allocate and initialize data urbs */
  660. for (i = 0; i < ep->nurbs; i++) {
  661. struct snd_urb_ctx *u = &ep->urb[i];
  662. u->index = i;
  663. u->ep = ep;
  664. u->packets = urb_packs;
  665. u->buffer_size = maxsize * u->packets;
  666. if (fmt->fmt_type == UAC_FORMAT_TYPE_II)
  667. u->packets++; /* for transfer delimiter */
  668. u->urb = usb_alloc_urb(u->packets, GFP_KERNEL);
  669. if (!u->urb)
  670. goto out_of_memory;
  671. u->urb->transfer_buffer =
  672. usb_alloc_coherent(ep->chip->dev, u->buffer_size,
  673. GFP_KERNEL, &u->urb->transfer_dma);
  674. if (!u->urb->transfer_buffer)
  675. goto out_of_memory;
  676. u->urb->pipe = ep->pipe;
  677. u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
  678. u->urb->interval = 1 << ep->datainterval;
  679. u->urb->context = u;
  680. u->urb->complete = snd_complete_urb;
  681. INIT_LIST_HEAD(&u->ready_list);
  682. }
  683. return 0;
  684. out_of_memory:
  685. release_urbs(ep, 0);
  686. return -ENOMEM;
  687. }
  688. /*
  689. * configure a sync endpoint
  690. */
  691. static int sync_ep_set_params(struct snd_usb_endpoint *ep)
  692. {
  693. int i;
  694. ep->syncbuf = usb_alloc_coherent(ep->chip->dev, SYNC_URBS * 4,
  695. GFP_KERNEL, &ep->sync_dma);
  696. if (!ep->syncbuf)
  697. return -ENOMEM;
  698. for (i = 0; i < SYNC_URBS; i++) {
  699. struct snd_urb_ctx *u = &ep->urb[i];
  700. u->index = i;
  701. u->ep = ep;
  702. u->packets = 1;
  703. u->urb = usb_alloc_urb(1, GFP_KERNEL);
  704. if (!u->urb)
  705. goto out_of_memory;
  706. u->urb->transfer_buffer = ep->syncbuf + i * 4;
  707. u->urb->transfer_dma = ep->sync_dma + i * 4;
  708. u->urb->transfer_buffer_length = 4;
  709. u->urb->pipe = ep->pipe;
  710. u->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
  711. u->urb->number_of_packets = 1;
  712. u->urb->interval = 1 << ep->syncinterval;
  713. u->urb->context = u;
  714. u->urb->complete = snd_complete_urb;
  715. }
  716. ep->nurbs = SYNC_URBS;
  717. return 0;
  718. out_of_memory:
  719. release_urbs(ep, 0);
  720. return -ENOMEM;
  721. }
  722. /**
  723. * snd_usb_endpoint_set_params: configure an snd_usb_endpoint
  724. *
  725. * @ep: the snd_usb_endpoint to configure
  726. * @pcm_format: the audio fomat.
  727. * @channels: the number of audio channels.
  728. * @period_bytes: the number of bytes in one alsa period.
  729. * @period_frames: the number of frames in one alsa period.
  730. * @buffer_periods: the number of periods in one alsa buffer.
  731. * @rate: the frame rate.
  732. * @fmt: the USB audio format information
  733. * @sync_ep: the sync endpoint to use, if any
  734. *
  735. * Determine the number of URBs to be used on this endpoint.
  736. * An endpoint must be configured before it can be started.
  737. * An endpoint that is already running can not be reconfigured.
  738. */
  739. int snd_usb_endpoint_set_params(struct snd_usb_endpoint *ep,
  740. snd_pcm_format_t pcm_format,
  741. unsigned int channels,
  742. unsigned int period_bytes,
  743. unsigned int period_frames,
  744. unsigned int buffer_periods,
  745. unsigned int rate,
  746. struct audioformat *fmt,
  747. struct snd_usb_endpoint *sync_ep)
  748. {
  749. int err;
  750. if (ep->use_count != 0) {
  751. usb_audio_warn(ep->chip,
  752. "Unable to change format on ep #%x: already in use\n",
  753. ep->ep_num);
  754. return -EBUSY;
  755. }
  756. /* release old buffers, if any */
  757. release_urbs(ep, 0);
  758. ep->datainterval = fmt->datainterval;
  759. ep->maxpacksize = fmt->maxpacksize;
  760. ep->fill_max = !!(fmt->attributes & UAC_EP_CS_ATTR_FILL_MAX);
  761. if (snd_usb_get_speed(ep->chip->dev) == USB_SPEED_FULL)
  762. ep->freqn = get_usb_full_speed_rate(rate);
  763. else
  764. ep->freqn = get_usb_high_speed_rate(rate);
  765. /* calculate the frequency in 16.16 format */
  766. ep->freqm = ep->freqn;
  767. ep->freqshift = INT_MIN;
  768. ep->phase = 0;
  769. switch (ep->type) {
  770. case SND_USB_ENDPOINT_TYPE_DATA:
  771. err = data_ep_set_params(ep, pcm_format, channels,
  772. period_bytes, period_frames,
  773. buffer_periods, fmt, sync_ep);
  774. break;
  775. case SND_USB_ENDPOINT_TYPE_SYNC:
  776. err = sync_ep_set_params(ep);
  777. break;
  778. default:
  779. err = -EINVAL;
  780. }
  781. usb_audio_dbg(ep->chip,
  782. "Setting params for ep #%x (type %d, %d urbs), ret=%d\n",
  783. ep->ep_num, ep->type, ep->nurbs, err);
  784. return err;
  785. }
  786. /**
  787. * snd_usb_endpoint_start: start an snd_usb_endpoint
  788. *
  789. * @ep: the endpoint to start
  790. *
  791. * A call to this function will increment the use count of the endpoint.
  792. * In case it is not already running, the URBs for this endpoint will be
  793. * submitted. Otherwise, this function does nothing.
  794. *
  795. * Must be balanced to calls of snd_usb_endpoint_stop().
  796. *
  797. * Returns an error if the URB submission failed, 0 in all other cases.
  798. */
  799. int snd_usb_endpoint_start(struct snd_usb_endpoint *ep)
  800. {
  801. int err;
  802. unsigned int i;
  803. if (atomic_read(&ep->chip->shutdown))
  804. return -EBADFD;
  805. /* already running? */
  806. if (++ep->use_count != 1)
  807. return 0;
  808. /* just to be sure */
  809. deactivate_urbs(ep, false);
  810. ep->active_mask = 0;
  811. ep->unlink_mask = 0;
  812. ep->phase = 0;
  813. snd_usb_endpoint_start_quirk(ep);
  814. /*
  815. * If this endpoint has a data endpoint as implicit feedback source,
  816. * don't start the urbs here. Instead, mark them all as available,
  817. * wait for the record urbs to return and queue the playback urbs
  818. * from that context.
  819. */
  820. set_bit(EP_FLAG_RUNNING, &ep->flags);
  821. if (snd_usb_endpoint_implicit_feedback_sink(ep)) {
  822. for (i = 0; i < ep->nurbs; i++) {
  823. struct snd_urb_ctx *ctx = ep->urb + i;
  824. list_add_tail(&ctx->ready_list, &ep->ready_playback_urbs);
  825. }
  826. return 0;
  827. }
  828. for (i = 0; i < ep->nurbs; i++) {
  829. struct urb *urb = ep->urb[i].urb;
  830. if (snd_BUG_ON(!urb))
  831. goto __error;
  832. if (usb_pipeout(ep->pipe)) {
  833. prepare_outbound_urb(ep, urb->context);
  834. } else {
  835. prepare_inbound_urb(ep, urb->context);
  836. }
  837. err = usb_submit_urb(urb, GFP_ATOMIC);
  838. if (err < 0) {
  839. usb_audio_err(ep->chip,
  840. "cannot submit urb %d, error %d: %s\n",
  841. i, err, usb_error_string(err));
  842. goto __error;
  843. }
  844. set_bit(i, &ep->active_mask);
  845. }
  846. return 0;
  847. __error:
  848. clear_bit(EP_FLAG_RUNNING, &ep->flags);
  849. ep->use_count--;
  850. deactivate_urbs(ep, false);
  851. return -EPIPE;
  852. }
  853. /**
  854. * snd_usb_endpoint_stop: stop an snd_usb_endpoint
  855. *
  856. * @ep: the endpoint to stop (may be NULL)
  857. *
  858. * A call to this function will decrement the use count of the endpoint.
  859. * In case the last user has requested the endpoint stop, the URBs will
  860. * actually be deactivated.
  861. *
  862. * Must be balanced to calls of snd_usb_endpoint_start().
  863. *
  864. * The caller needs to synchronize the pending stop operation via
  865. * snd_usb_endpoint_sync_pending_stop().
  866. */
  867. void snd_usb_endpoint_stop(struct snd_usb_endpoint *ep)
  868. {
  869. if (!ep)
  870. return;
  871. if (snd_BUG_ON(ep->use_count == 0))
  872. return;
  873. if (--ep->use_count == 0) {
  874. deactivate_urbs(ep, false);
  875. set_bit(EP_FLAG_STOPPING, &ep->flags);
  876. }
  877. }
  878. /**
  879. * snd_usb_endpoint_deactivate: deactivate an snd_usb_endpoint
  880. *
  881. * @ep: the endpoint to deactivate
  882. *
  883. * If the endpoint is not currently in use, this functions will
  884. * deactivate its associated URBs.
  885. *
  886. * In case of any active users, this functions does nothing.
  887. */
  888. void snd_usb_endpoint_deactivate(struct snd_usb_endpoint *ep)
  889. {
  890. if (!ep)
  891. return;
  892. if (ep->use_count != 0)
  893. return;
  894. deactivate_urbs(ep, true);
  895. wait_clear_urbs(ep);
  896. }
  897. /**
  898. * snd_usb_endpoint_release: Tear down an snd_usb_endpoint
  899. *
  900. * @ep: the endpoint to release
  901. *
  902. * This function does not care for the endpoint's use count but will tear
  903. * down all the streaming URBs immediately.
  904. */
  905. void snd_usb_endpoint_release(struct snd_usb_endpoint *ep)
  906. {
  907. release_urbs(ep, 1);
  908. }
  909. /**
  910. * snd_usb_endpoint_free: Free the resources of an snd_usb_endpoint
  911. *
  912. * @ep: the endpoint to free
  913. *
  914. * This free all resources of the given ep.
  915. */
  916. void snd_usb_endpoint_free(struct snd_usb_endpoint *ep)
  917. {
  918. kfree(ep);
  919. }
  920. /**
  921. * snd_usb_handle_sync_urb: parse an USB sync packet
  922. *
  923. * @ep: the endpoint to handle the packet
  924. * @sender: the sending endpoint
  925. * @urb: the received packet
  926. *
  927. * This function is called from the context of an endpoint that received
  928. * the packet and is used to let another endpoint object handle the payload.
  929. */
  930. void snd_usb_handle_sync_urb(struct snd_usb_endpoint *ep,
  931. struct snd_usb_endpoint *sender,
  932. const struct urb *urb)
  933. {
  934. int shift;
  935. unsigned int f;
  936. unsigned long flags;
  937. snd_BUG_ON(ep == sender);
  938. /*
  939. * In case the endpoint is operating in implicit feedback mode, prepare
  940. * a new outbound URB that has the same layout as the received packet
  941. * and add it to the list of pending urbs. queue_pending_output_urbs()
  942. * will take care of them later.
  943. */
  944. if (snd_usb_endpoint_implicit_feedback_sink(ep) &&
  945. ep->use_count != 0) {
  946. /* implicit feedback case */
  947. int i, bytes = 0;
  948. struct snd_urb_ctx *in_ctx;
  949. struct snd_usb_packet_info *out_packet;
  950. in_ctx = urb->context;
  951. /* Count overall packet size */
  952. for (i = 0; i < in_ctx->packets; i++)
  953. if (urb->iso_frame_desc[i].status == 0)
  954. bytes += urb->iso_frame_desc[i].actual_length;
  955. /*
  956. * skip empty packets. At least M-Audio's Fast Track Ultra stops
  957. * streaming once it received a 0-byte OUT URB
  958. */
  959. if (bytes == 0)
  960. return;
  961. spin_lock_irqsave(&ep->lock, flags);
  962. out_packet = ep->next_packet + ep->next_packet_write_pos;
  963. /*
  964. * Iterate through the inbound packet and prepare the lengths
  965. * for the output packet. The OUT packet we are about to send
  966. * will have the same amount of payload bytes per stride as the
  967. * IN packet we just received. Since the actual size is scaled
  968. * by the stride, use the sender stride to calculate the length
  969. * in case the number of channels differ between the implicitly
  970. * fed-back endpoint and the synchronizing endpoint.
  971. */
  972. out_packet->packets = in_ctx->packets;
  973. for (i = 0; i < in_ctx->packets; i++) {
  974. if (urb->iso_frame_desc[i].status == 0)
  975. out_packet->packet_size[i] =
  976. urb->iso_frame_desc[i].actual_length / sender->stride;
  977. else
  978. out_packet->packet_size[i] = 0;
  979. }
  980. ep->next_packet_write_pos++;
  981. ep->next_packet_write_pos %= MAX_URBS;
  982. spin_unlock_irqrestore(&ep->lock, flags);
  983. queue_pending_output_urbs(ep);
  984. return;
  985. }
  986. /*
  987. * process after playback sync complete
  988. *
  989. * Full speed devices report feedback values in 10.14 format as samples
  990. * per frame, high speed devices in 16.16 format as samples per
  991. * microframe.
  992. *
  993. * Because the Audio Class 1 spec was written before USB 2.0, many high
  994. * speed devices use a wrong interpretation, some others use an
  995. * entirely different format.
  996. *
  997. * Therefore, we cannot predict what format any particular device uses
  998. * and must detect it automatically.
  999. */
  1000. if (urb->iso_frame_desc[0].status != 0 ||
  1001. urb->iso_frame_desc[0].actual_length < 3)
  1002. return;
  1003. f = le32_to_cpup(urb->transfer_buffer);
  1004. if (urb->iso_frame_desc[0].actual_length == 3)
  1005. f &= 0x00ffffff;
  1006. else
  1007. f &= 0x0fffffff;
  1008. if (f == 0)
  1009. return;
  1010. if (unlikely(sender->udh01_fb_quirk)) {
  1011. /*
  1012. * The TEAC UD-H01 firmware sometimes changes the feedback value
  1013. * by +/- 0x1.0000.
  1014. */
  1015. if (f < ep->freqn - 0x8000)
  1016. f += 0x10000;
  1017. else if (f > ep->freqn + 0x8000)
  1018. f -= 0x10000;
  1019. } else if (unlikely(ep->freqshift == INT_MIN)) {
  1020. /*
  1021. * The first time we see a feedback value, determine its format
  1022. * by shifting it left or right until it matches the nominal
  1023. * frequency value. This assumes that the feedback does not
  1024. * differ from the nominal value more than +50% or -25%.
  1025. */
  1026. shift = 0;
  1027. while (f < ep->freqn - ep->freqn / 4) {
  1028. f <<= 1;
  1029. shift++;
  1030. }
  1031. while (f > ep->freqn + ep->freqn / 2) {
  1032. f >>= 1;
  1033. shift--;
  1034. }
  1035. ep->freqshift = shift;
  1036. } else if (ep->freqshift >= 0)
  1037. f <<= ep->freqshift;
  1038. else
  1039. f >>= -ep->freqshift;
  1040. if (likely(f >= ep->freqn - ep->freqn / 8 && f <= ep->freqmax)) {
  1041. /*
  1042. * If the frequency looks valid, set it.
  1043. * This value is referred to in prepare_playback_urb().
  1044. */
  1045. spin_lock_irqsave(&ep->lock, flags);
  1046. ep->freqm = f;
  1047. spin_unlock_irqrestore(&ep->lock, flags);
  1048. } else {
  1049. /*
  1050. * Out of range; maybe the shift value is wrong.
  1051. * Reset it so that we autodetect again the next time.
  1052. */
  1053. ep->freqshift = INT_MIN;
  1054. }
  1055. }