sound/usb/clock.c

   1 /*
   2  *   Clock domain and sample rate management functions
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation; either version 2 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program; if not, write to the Free Software
  16  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17  *
  18  */
  19
  20 #include <linux/bitops.h>
  21 #include <linux/init.h>
  22 #include <linux/string.h>
  23 #include <linux/usb.h>
  24 #include <linux/usb/audio.h>
  25 #include <linux/usb/audio-v2.h>
  26
  27 #include <sound/core.h>
  28 #include <sound/info.h>
  29 #include <sound/pcm.h>
  30
  31 #include "usbaudio.h"
  32 #include "card.h"
  33 #include "helper.h"
  34 #include "clock.h"
  35
  36 static struct uac_clock_source_descriptor *
  37         snd_usb_find_clock_source(struct usb_host_interface *ctrl_iface,
  38                                   int clock_id)
  39 {
  40         struct uac_clock_source_descriptor *cs = NULL;
  41
  42         while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
  43                                              ctrl_iface->extralen,
  44                                              cs, UAC2_CLOCK_SOURCE))) {
  45                 if (cs->bClockID == clock_id)
  46                         return cs;
  47         }
  48
  49         return NULL;
  50 }
  51
  52 static struct uac_clock_selector_descriptor *
  53         snd_usb_find_clock_selector(struct usb_host_interface *ctrl_iface,
  54                                     int clock_id)
  55 {
  56         struct uac_clock_selector_descriptor *cs = NULL;
  57
  58         while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
  59                                              ctrl_iface->extralen,
  60                                              cs, UAC2_CLOCK_SELECTOR))) {
  61                 if (cs->bClockID == clock_id)
  62                         return cs;
  63         }
  64
  65         return NULL;
  66 }
  67
  68 static struct uac_clock_multiplier_descriptor *
  69         snd_usb_find_clock_multiplier(struct usb_host_interface *ctrl_iface,
  70                                       int clock_id)
  71 {
  72         struct uac_clock_multiplier_descriptor *cs = NULL;
  73
  74         while ((cs = snd_usb_find_csint_desc(ctrl_iface->extra,
  75                                              ctrl_iface->extralen,
  76                                              cs, UAC2_CLOCK_MULTIPLIER))) {
  77                 if (cs->bClockID == clock_id)
  78                         return cs;
  79         }
  80
  81         return NULL;
  82 }
  83
  84 static int uac_clock_selector_get_val(struct snd_usb_audio *chip, int selector_id)
  85 {
  86         unsigned char buf;
  87         int ret;
  88
  89         ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0),
  90                               UAC2_CS_CUR,
  91                               USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
  92                               UAC2_CX_CLOCK_SELECTOR << 8,
  93                               snd_usb_ctrl_intf(chip) | (selector_id << 8),
  94                               &buf, sizeof(buf), 1000);
  95
  96         if (ret < 0)
  97                 return ret;
  98
  99         return buf;
 100 }
 101
 102 static bool uac_clock_source_is_valid(struct snd_usb_audio *chip, int source_id)
 103 {
 104         int err;
 105         unsigned char data;
 106         struct usb_device *dev = chip->dev;
 107
 108         err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
 109                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 110                               UAC2_CS_CONTROL_CLOCK_VALID << 8,
 111                               snd_usb_ctrl_intf(chip) | (source_id << 8),
 112                               &data, sizeof(data), 1000);
 113
 114         if (err < 0) {
 115                 snd_printk(KERN_WARNING "%s(): cannot get clock validity for id %d\n",
 116                            __func__, source_id);
 117                 return err;
 118         }
 119
 120         return !!data;
 121 }
 122
 123 static int __uac_clock_find_source(struct snd_usb_audio *chip,
 124                                    struct usb_host_interface *host_iface,
 125                                    int entity_id, unsigned long *visited)
 126 {
 127         struct uac_clock_source_descriptor *source;
 128         struct uac_clock_selector_descriptor *selector;
 129         struct uac_clock_multiplier_descriptor *multiplier;
 130
 131         entity_id &= 0xff;
 132
 133         if (test_and_set_bit(entity_id, visited)) {
 134                 snd_printk(KERN_WARNING
 135                         "%s(): recursive clock topology detected, id %d.\n",
 136                         __func__, entity_id);
 137                 return -EINVAL;
 138         }
 139
 140         /* first, see if the ID we're looking for is a clock source already */
 141         source = snd_usb_find_clock_source(host_iface, entity_id);
 142         if (source)
 143                 return source->bClockID;
 144
 145         selector = snd_usb_find_clock_selector(host_iface, entity_id);
 146         if (selector) {
 147                 int ret;
 148
 149                 /* the entity ID we are looking for is a selector.
 150                  * find out what it currently selects */
 151                 ret = uac_clock_selector_get_val(chip, selector->bClockID);
 152                 if (ret < 0)
 153                         return ret;
 154
 155                 /* Selector values are one-based */
 156
 157                 if (ret > selector->bNrInPins || ret < 1) {
 158                         printk(KERN_ERR
 159                                 "%s(): selector reported illegal value, id %d, ret %d\n",
 160                                 __func__, selector->bClockID, ret);
 161
 162                         return -EINVAL;
 163                 }
 164
 165                 return __uac_clock_find_source(chip, host_iface,
 166                                                selector->baCSourceID[ret-1],
 167                                                visited);
 168         }
 169
 170         /* FIXME: multipliers only act as pass-thru element for now */
 171         multiplier = snd_usb_find_clock_multiplier(host_iface, entity_id);
 172         if (multiplier)
 173                 return __uac_clock_find_source(chip, host_iface,
 174                                                multiplier->bCSourceID, visited);
 175
 176         return -EINVAL;
 177 }
 178
 179 /*
 180  * For all kinds of sample rate settings and other device queries,
 181  * the clock source (end-leaf) must be used. However, clock selectors,
 182  * clock multipliers and sample rate converters may be specified as
 183  * clock source input to terminal. This functions walks the clock path
 184  * to its end and tries to find the source.
 185  *
 186  * The 'visited' bitfield is used internally to detect recursive loops.
 187  *
 188  * Returns the clock source UnitID (>=0) on success, or an error.
 189  */
 190 int snd_usb_clock_find_source(struct snd_usb_audio *chip,
 191                               struct usb_host_interface *host_iface,
 192                               int entity_id)
 193 {
 194         DECLARE_BITMAP(visited, 256);
 195         memset(visited, 0, sizeof(visited));
 196         return __uac_clock_find_source(chip, host_iface, entity_id, visited);
 197 }
 198
 199 static int set_sample_rate_v1(struct snd_usb_audio *chip, int iface,
 200                               struct usb_host_interface *alts,
 201                               struct audioformat *fmt, int rate)
 202 {
 203         struct usb_device *dev = chip->dev;
 204         unsigned int ep;
 205         unsigned char data[3];
 206         int err, crate;
 207
 208         ep = get_endpoint(alts, 0)->bEndpointAddress;
 209
 210         /* if endpoint doesn't have sampling rate control, bail out */
 211         if (!(fmt->attributes & UAC_EP_CS_ATTR_SAMPLE_RATE)) {
 212                 snd_printk(KERN_WARNING "%d:%d:%d: endpoint lacks sample rate attribute bit, cannot set.\n",
 213                                    dev->devnum, iface, fmt->altsetting);
 214                 return 0;
 215         }
 216
 217         data[0] = rate;
 218         data[1] = rate >> 8;
 219         data[2] = rate >> 16;
 220         if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC_SET_CUR,
 221                                    USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_OUT,
 222                                    UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
 223                                    data, sizeof(data), 1000)) < 0) {
 224                 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d to ep %#x\n",
 225                            dev->devnum, iface, fmt->altsetting, rate, ep);
 226                 return err;
 227         }
 228
 229         if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC_GET_CUR,
 230                                    USB_TYPE_CLASS | USB_RECIP_ENDPOINT | USB_DIR_IN,
 231                                    UAC_EP_CS_ATTR_SAMPLE_RATE << 8, ep,
 232                                    data, sizeof(data), 1000)) < 0) {
 233                 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq at ep %#x\n",
 234                            dev->devnum, iface, fmt->altsetting, ep);
 235                 return 0; /* some devices don't support reading */
 236         }
 237
 238         crate = data[0] | (data[1] << 8) | (data[2] << 16);
 239         if (crate != rate) {
 240                 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
 241                 // runtime->rate = crate;
 242         }
 243
 244         return 0;
 245 }
 246
 247 static int set_sample_rate_v2(struct snd_usb_audio *chip, int iface,
 248                               struct usb_host_interface *alts,
 249                               struct audioformat *fmt, int rate)
 250 {
 251         struct usb_device *dev = chip->dev;
 252         unsigned char data[4];
 253         int err, crate;
 254         int clock = snd_usb_clock_find_source(chip, chip->ctrl_intf, fmt->clock);
 255
 256         if (clock < 0)
 257                 return clock;
 258
 259         if (!uac_clock_source_is_valid(chip, clock)) {
 260                 /* TODO: should we try to find valid clock setups by ourself? */
 261                 snd_printk(KERN_ERR "%d:%d:%d: clock source %d is not valid, cannot use\n",
 262                            dev->devnum, iface, fmt->altsetting, clock);
 263                 return -ENXIO;
 264         }
 265
 266         data[0] = rate;
 267         data[1] = rate >> 8;
 268         data[2] = rate >> 16;
 269         data[3] = rate >> 24;
 270         if ((err = snd_usb_ctl_msg(dev, usb_sndctrlpipe(dev, 0), UAC2_CS_CUR,
 271                                    USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
 272                                    UAC2_CS_CONTROL_SAM_FREQ << 8,
 273                                    snd_usb_ctrl_intf(chip) | (clock << 8),
 274                                    data, sizeof(data), 1000)) < 0) {
 275                 snd_printk(KERN_ERR "%d:%d:%d: cannot set freq %d (v2)\n",
 276                            dev->devnum, iface, fmt->altsetting, rate);
 277                 return err;
 278         }
 279
 280         if ((err = snd_usb_ctl_msg(dev, usb_rcvctrlpipe(dev, 0), UAC2_CS_CUR,
 281                                    USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 282                                    UAC2_CS_CONTROL_SAM_FREQ << 8,
 283                                    snd_usb_ctrl_intf(chip) | (clock << 8),
 284                                    data, sizeof(data), 1000)) < 0) {
 285                 snd_printk(KERN_WARNING "%d:%d:%d: cannot get freq (v2)\n",
 286                            dev->devnum, iface, fmt->altsetting);
 287                 return err;
 288         }
 289
 290         crate = data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24);
 291         if (crate != rate)
 292                 snd_printd(KERN_WARNING "current rate %d is different from the runtime rate %d\n", crate, rate);
 293
 294         return 0;
 295 }
 296
 297 int snd_usb_init_sample_rate(struct snd_usb_audio *chip, int iface,
 298                              struct usb_host_interface *alts,
 299                              struct audioformat *fmt, int rate)
 300 {
 301         struct usb_interface_descriptor *altsd = get_iface_desc(alts);
 302
 303         switch (altsd->bInterfaceProtocol) {
 304         case UAC_VERSION_1:
 305                 return set_sample_rate_v1(chip, iface, alts, fmt, rate);
 306
 307         case UAC_VERSION_2:
 308                 return set_sample_rate_v2(chip, iface, alts, fmt, rate);
 309         }
 310
 311         return -EINVAL;
 312 }
 313