sound/hda/hdac_device.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * HD-audio codec core device
   4  */
   5
   6 #include <linux/init.h>
   7 #include <linux/delay.h>
   8 #include <linux/device.h>
   9 #include <linux/slab.h>
  10 #include <linux/module.h>
  11 #include <linux/export.h>
  12 #include <linux/pm_runtime.h>
  13 #include <sound/hdaudio.h>
  14 #include <sound/hda_regmap.h>
  15 #include <sound/pcm.h>
  16 #include "local.h"
  17
  18 static void setup_fg_nodes(struct hdac_device *codec);
  19 static int get_codec_vendor_name(struct hdac_device *codec);
  20
  21 static void default_release(struct device *dev)
  22 {
  23         snd_hdac_device_exit(dev_to_hdac_dev(dev));
  24 }
  25
  26 /**
  27  * snd_hdac_device_init - initialize the HD-audio codec base device
  28  * @codec: device to initialize
  29  * @bus: but to attach
  30  * @name: device name string
  31  * @addr: codec address
  32  *
  33  * Returns zero for success or a negative error code.
  34  *
  35  * This function increments the runtime PM counter and marks it active.
  36  * The caller needs to turn it off appropriately later.
  37  *
  38  * The caller needs to set the device's release op properly by itself.
  39  */
  40 int snd_hdac_device_init(struct hdac_device *codec, struct hdac_bus *bus,
  41                          const char *name, unsigned int addr)
  42 {
  43         struct device *dev;
  44         hda_nid_t fg;
  45         int err;
  46
  47         dev = &codec->dev;
  48         device_initialize(dev);
  49         dev->parent = bus->dev;
  50         dev->bus = &snd_hda_bus_type;
  51         dev->release = default_release;
  52         dev->groups = hdac_dev_attr_groups;
  53         dev_set_name(dev, "%s", name);
  54         device_enable_async_suspend(dev);
  55
  56         codec->bus = bus;
  57         codec->addr = addr;
  58         codec->type = HDA_DEV_CORE;
  59         mutex_init(&codec->widget_lock);
  60         mutex_init(&codec->regmap_lock);
  61         pm_runtime_set_active(&codec->dev);
  62         pm_runtime_get_noresume(&codec->dev);
  63         atomic_set(&codec->in_pm, 0);
  64
  65         err = snd_hdac_bus_add_device(bus, codec);
  66         if (err < 0)
  67                 goto error;
  68
  69         /* fill parameters */
  70         codec->vendor_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  71                                               AC_PAR_VENDOR_ID);
  72         if (codec->vendor_id == -1) {
  73                 /* read again, hopefully the access method was corrected
  74                  * in the last read...
  75                  */
  76                 codec->vendor_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  77                                                       AC_PAR_VENDOR_ID);
  78         }
  79
  80         codec->subsystem_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  81                                                  AC_PAR_SUBSYSTEM_ID);
  82         codec->revision_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  83                                                 AC_PAR_REV_ID);
  84
  85         setup_fg_nodes(codec);
  86         if (!codec->afg && !codec->mfg) {
  87                 dev_err(dev, "no AFG or MFG node found\n");
  88                 err = -ENODEV;
  89                 goto error;
  90         }
  91
  92         fg = codec->afg ? codec->afg : codec->mfg;
  93
  94         err = snd_hdac_refresh_widgets(codec);
  95         if (err < 0)
  96                 goto error;
  97
  98         codec->power_caps = snd_hdac_read_parm(codec, fg, AC_PAR_POWER_STATE);
  99         /* reread ssid if not set by parameter */
 100         if (codec->subsystem_id == -1 || codec->subsystem_id == 0)
 101                 snd_hdac_read(codec, fg, AC_VERB_GET_SUBSYSTEM_ID, 0,
 102                               &codec->subsystem_id);
 103
 104         err = get_codec_vendor_name(codec);
 105         if (err < 0)
 106                 goto error;
 107
 108         codec->chip_name = kasprintf(GFP_KERNEL, "ID %x",
 109                                      codec->vendor_id & 0xffff);
 110         if (!codec->chip_name) {
 111                 err = -ENOMEM;
 112                 goto error;
 113         }
 114
 115         return 0;
 116
 117  error:
 118         put_device(&codec->dev);
 119         return err;
 120 }
 121 EXPORT_SYMBOL_GPL(snd_hdac_device_init);
 122
 123 /**
 124  * snd_hdac_device_exit - clean up the HD-audio codec base device
 125  * @codec: device to clean up
 126  */
 127 void snd_hdac_device_exit(struct hdac_device *codec)
 128 {
 129         pm_runtime_put_noidle(&codec->dev);
 130         /* keep balance of runtime PM child_count in parent device */
 131         pm_runtime_set_suspended(&codec->dev);
 132         snd_hdac_bus_remove_device(codec->bus, codec);
 133         kfree(codec->vendor_name);
 134         kfree(codec->chip_name);
 135 }
 136 EXPORT_SYMBOL_GPL(snd_hdac_device_exit);
 137
 138 /**
 139  * snd_hdac_device_register - register the hd-audio codec base device
 140  * @codec: the device to register
 141  */
 142 int snd_hdac_device_register(struct hdac_device *codec)
 143 {
 144         int err;
 145
 146         err = device_add(&codec->dev);
 147         if (err < 0)
 148                 return err;
 149         mutex_lock(&codec->widget_lock);
 150         err = hda_widget_sysfs_init(codec);
 151         mutex_unlock(&codec->widget_lock);
 152         if (err < 0) {
 153                 device_del(&codec->dev);
 154                 return err;
 155         }
 156
 157         return 0;
 158 }
 159 EXPORT_SYMBOL_GPL(snd_hdac_device_register);
 160
 161 /**
 162  * snd_hdac_device_unregister - unregister the hd-audio codec base device
 163  * @codec: the device to unregister
 164  */
 165 void snd_hdac_device_unregister(struct hdac_device *codec)
 166 {
 167         if (device_is_registered(&codec->dev)) {
 168                 mutex_lock(&codec->widget_lock);
 169                 hda_widget_sysfs_exit(codec);
 170                 mutex_unlock(&codec->widget_lock);
 171                 device_del(&codec->dev);
 172                 snd_hdac_bus_remove_device(codec->bus, codec);
 173         }
 174 }
 175 EXPORT_SYMBOL_GPL(snd_hdac_device_unregister);
 176
 177 /**
 178  * snd_hdac_device_set_chip_name - set/update the codec name
 179  * @codec: the HDAC device
 180  * @name: name string to set
 181  *
 182  * Returns 0 if the name is set or updated, or a negative error code.
 183  */
 184 int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name)
 185 {
 186         char *newname;
 187
 188         if (!name)
 189                 return 0;
 190         newname = kstrdup(name, GFP_KERNEL);
 191         if (!newname)
 192                 return -ENOMEM;
 193         kfree(codec->chip_name);
 194         codec->chip_name = newname;
 195         return 0;
 196 }
 197 EXPORT_SYMBOL_GPL(snd_hdac_device_set_chip_name);
 198
 199 /**
 200  * snd_hdac_codec_modalias - give the module alias name
 201  * @codec: HDAC device
 202  * @buf: string buffer to store
 203  * @size: string buffer size
 204  *
 205  * Returns the size of string, like snprintf(), or a negative error code.
 206  */
 207 int snd_hdac_codec_modalias(const struct hdac_device *codec, char *buf, size_t size)
 208 {
 209         return scnprintf(buf, size, "hdaudio:v%08Xr%08Xa%02X\n",
 210                         codec->vendor_id, codec->revision_id, codec->type);
 211 }
 212 EXPORT_SYMBOL_GPL(snd_hdac_codec_modalias);
 213
 214 /**
 215  * snd_hdac_make_cmd - compose a 32bit command word to be sent to the
 216  *      HD-audio controller
 217  * @codec: the codec object
 218  * @nid: NID to encode
 219  * @verb: verb to encode
 220  * @parm: parameter to encode
 221  *
 222  * Return an encoded command verb or -1 for error.
 223  */
 224 static unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
 225                                       unsigned int verb, unsigned int parm)
 226 {
 227         u32 val, addr;
 228
 229         addr = codec->addr;
 230         if ((addr & ~0xf) || (nid & ~0x7f) ||
 231             (verb & ~0xfff) || (parm & ~0xffff)) {
 232                 dev_err(&codec->dev, "out of range cmd %x:%x:%x:%x\n",
 233                         addr, nid, verb, parm);
 234                 return -1;
 235         }
 236
 237         val = addr << 28;
 238         val |= (u32)nid << 20;
 239         val |= verb << 8;
 240         val |= parm;
 241         return val;
 242 }
 243
 244 /**
 245  * snd_hdac_exec_verb - execute an encoded verb
 246  * @codec: the codec object
 247  * @cmd: encoded verb to execute
 248  * @flags: optional flags, pass zero for default
 249  * @res: the pointer to store the result, NULL if running async
 250  *
 251  * Returns zero if successful, or a negative error code.
 252  *
 253  * This calls the exec_verb op when set in hdac_codec.  If not,
 254  * call the default snd_hdac_bus_exec_verb().
 255  */
 256 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
 257                        unsigned int flags, unsigned int *res)
 258 {
 259         if (codec->exec_verb)
 260                 return codec->exec_verb(codec, cmd, flags, res);
 261         return snd_hdac_bus_exec_verb(codec->bus, codec->addr, cmd, res);
 262 }
 263
 264
 265 /**
 266  * snd_hdac_read - execute a verb
 267  * @codec: the codec object
 268  * @nid: NID to execute a verb
 269  * @verb: verb to execute
 270  * @parm: parameter for a verb
 271  * @res: the pointer to store the result, NULL if running async
 272  *
 273  * Returns zero if successful, or a negative error code.
 274  */
 275 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
 276                   unsigned int verb, unsigned int parm, unsigned int *res)
 277 {
 278         unsigned int cmd = snd_hdac_make_cmd(codec, nid, verb, parm);
 279
 280         return snd_hdac_exec_verb(codec, cmd, 0, res);
 281 }
 282 EXPORT_SYMBOL_GPL(snd_hdac_read);
 283
 284 /**
 285  * _snd_hdac_read_parm - read a parmeter
 286  * @codec: the codec object
 287  * @nid: NID to read a parameter
 288  * @parm: parameter to read
 289  * @res: pointer to store the read value
 290  *
 291  * This function returns zero or an error unlike snd_hdac_read_parm().
 292  */
 293 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
 294                         unsigned int *res)
 295 {
 296         unsigned int cmd;
 297
 298         cmd = snd_hdac_regmap_encode_verb(nid, AC_VERB_PARAMETERS) | parm;
 299         return snd_hdac_regmap_read_raw(codec, cmd, res);
 300 }
 301 EXPORT_SYMBOL_GPL(_snd_hdac_read_parm);
 302
 303 /**
 304  * snd_hdac_read_parm_uncached - read a codec parameter without caching
 305  * @codec: the codec object
 306  * @nid: NID to read a parameter
 307  * @parm: parameter to read
 308  *
 309  * Returns -1 for error.  If you need to distinguish the error more
 310  * strictly, use snd_hdac_read() directly.
 311  */
 312 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
 313                                 int parm)
 314 {
 315         unsigned int cmd, val;
 316
 317         cmd = snd_hdac_regmap_encode_verb(nid, AC_VERB_PARAMETERS) | parm;
 318         if (snd_hdac_regmap_read_raw_uncached(codec, cmd, &val) < 0)
 319                 return -1;
 320         return val;
 321 }
 322 EXPORT_SYMBOL_GPL(snd_hdac_read_parm_uncached);
 323
 324 /**
 325  * snd_hdac_override_parm - override read-only parameters
 326  * @codec: the codec object
 327  * @nid: NID for the parameter
 328  * @parm: the parameter to change
 329  * @val: the parameter value to overwrite
 330  */
 331 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
 332                            unsigned int parm, unsigned int val)
 333 {
 334         unsigned int verb = (AC_VERB_PARAMETERS << 8) | (nid << 20) | parm;
 335         int err;
 336
 337         if (!codec->regmap)
 338                 return -EINVAL;
 339
 340         codec->caps_overwriting = true;
 341         err = snd_hdac_regmap_write_raw(codec, verb, val);
 342         codec->caps_overwriting = false;
 343         return err;
 344 }
 345 EXPORT_SYMBOL_GPL(snd_hdac_override_parm);
 346
 347 /**
 348  * snd_hdac_get_sub_nodes - get start NID and number of subtree nodes
 349  * @codec: the codec object
 350  * @nid: NID to inspect
 351  * @start_id: the pointer to store the starting NID
 352  *
 353  * Returns the number of subtree nodes or zero if not found.
 354  * This function reads parameters always without caching.
 355  */
 356 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
 357                            hda_nid_t *start_id)
 358 {
 359         unsigned int parm;
 360
 361         parm = snd_hdac_read_parm_uncached(codec, nid, AC_PAR_NODE_COUNT);
 362         if (parm == -1) {
 363                 *start_id = 0;
 364                 return 0;
 365         }
 366         *start_id = (parm >> 16) & 0x7fff;
 367         return (int)(parm & 0x7fff);
 368 }
 369 EXPORT_SYMBOL_GPL(snd_hdac_get_sub_nodes);
 370
 371 /*
 372  * look for an AFG and MFG nodes
 373  */
 374 static void setup_fg_nodes(struct hdac_device *codec)
 375 {
 376         int i, total_nodes, function_id;
 377         hda_nid_t nid;
 378
 379         total_nodes = snd_hdac_get_sub_nodes(codec, AC_NODE_ROOT, &nid);
 380         for (i = 0; i < total_nodes; i++, nid++) {
 381                 function_id = snd_hdac_read_parm(codec, nid,
 382                                                  AC_PAR_FUNCTION_TYPE);
 383                 switch (function_id & 0xff) {
 384                 case AC_GRP_AUDIO_FUNCTION:
 385                         codec->afg = nid;
 386                         codec->afg_function_id = function_id & 0xff;
 387                         codec->afg_unsol = (function_id >> 8) & 1;
 388                         break;
 389                 case AC_GRP_MODEM_FUNCTION:
 390                         codec->mfg = nid;
 391                         codec->mfg_function_id = function_id & 0xff;
 392                         codec->mfg_unsol = (function_id >> 8) & 1;
 393                         break;
 394                 default:
 395                         break;
 396                 }
 397         }
 398 }
 399
 400 /**
 401  * snd_hdac_refresh_widgets - Reset the widget start/end nodes
 402  * @codec: the codec object
 403  */
 404 int snd_hdac_refresh_widgets(struct hdac_device *codec)
 405 {
 406         hda_nid_t start_nid;
 407         int nums, err = 0;
 408
 409         /*
 410          * Serialize against multiple threads trying to update the sysfs
 411          * widgets array.
 412          */
 413         mutex_lock(&codec->widget_lock);
 414         nums = snd_hdac_get_sub_nodes(codec, codec->afg, &start_nid);
 415         if (!start_nid || nums <= 0 || nums >= 0xff) {
 416                 dev_err(&codec->dev, "cannot read sub nodes for FG 0x%02x\n",
 417                         codec->afg);
 418                 err = -EINVAL;
 419                 goto unlock;
 420         }
 421
 422         err = hda_widget_sysfs_reinit(codec, start_nid, nums);
 423         if (err < 0)
 424                 goto unlock;
 425
 426         codec->num_nodes = nums;
 427         codec->start_nid = start_nid;
 428         codec->end_nid = start_nid + nums;
 429 unlock:
 430         mutex_unlock(&codec->widget_lock);
 431         return err;
 432 }
 433 EXPORT_SYMBOL_GPL(snd_hdac_refresh_widgets);
 434
 435 /* return CONNLIST_LEN parameter of the given widget */
 436 static unsigned int get_num_conns(struct hdac_device *codec, hda_nid_t nid)
 437 {
 438         unsigned int wcaps = get_wcaps(codec, nid);
 439         unsigned int parm;
 440
 441         if (!(wcaps & AC_WCAP_CONN_LIST) &&
 442             get_wcaps_type(wcaps) != AC_WID_VOL_KNB)
 443                 return 0;
 444
 445         parm = snd_hdac_read_parm(codec, nid, AC_PAR_CONNLIST_LEN);
 446         if (parm == -1)
 447                 parm = 0;
 448         return parm;
 449 }
 450
 451 /**
 452  * snd_hdac_get_connections - get a widget connection list
 453  * @codec: the codec object
 454  * @nid: NID
 455  * @conn_list: the array to store the results, can be NULL
 456  * @max_conns: the max size of the given array
 457  *
 458  * Returns the number of connected widgets, zero for no connection, or a
 459  * negative error code.  When the number of elements don't fit with the
 460  * given array size, it returns -ENOSPC.
 461  *
 462  * When @conn_list is NULL, it just checks the number of connections.
 463  */
 464 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
 465                              hda_nid_t *conn_list, int max_conns)
 466 {
 467         unsigned int parm;
 468         int i, conn_len, conns, err;
 469         unsigned int shift, num_elems, mask;
 470         hda_nid_t prev_nid;
 471         int null_count = 0;
 472
 473         parm = get_num_conns(codec, nid);
 474         if (!parm)
 475                 return 0;
 476
 477         if (parm & AC_CLIST_LONG) {
 478                 /* long form */
 479                 shift = 16;
 480                 num_elems = 2;
 481         } else {
 482                 /* short form */
 483                 shift = 8;
 484                 num_elems = 4;
 485         }
 486         conn_len = parm & AC_CLIST_LENGTH;
 487         mask = (1 << (shift-1)) - 1;
 488
 489         if (!conn_len)
 490                 return 0; /* no connection */
 491
 492         if (conn_len == 1) {
 493                 /* single connection */
 494                 err = snd_hdac_read(codec, nid, AC_VERB_GET_CONNECT_LIST, 0,
 495                                     &parm);
 496                 if (err < 0)
 497                         return err;
 498                 if (conn_list)
 499                         conn_list[0] = parm & mask;
 500                 return 1;
 501         }
 502
 503         /* multi connection */
 504         conns = 0;
 505         prev_nid = 0;
 506         for (i = 0; i < conn_len; i++) {
 507                 int range_val;
 508                 hda_nid_t val, n;
 509
 510                 if (i % num_elems == 0) {
 511                         err = snd_hdac_read(codec, nid,
 512                                             AC_VERB_GET_CONNECT_LIST, i,
 513                                             &parm);
 514                         if (err < 0)
 515                                 return -EIO;
 516                 }
 517                 range_val = !!(parm & (1 << (shift-1))); /* ranges */
 518                 val = parm & mask;
 519                 if (val == 0 && null_count++) {  /* no second chance */
 520                         dev_dbg(&codec->dev,
 521                                 "invalid CONNECT_LIST verb %x[%i]:%x\n",
 522                                 nid, i, parm);
 523                         return 0;
 524                 }
 525                 parm >>= shift;
 526                 if (range_val) {
 527                         /* ranges between the previous and this one */
 528                         if (!prev_nid || prev_nid >= val) {
 529                                 dev_warn(&codec->dev,
 530                                          "invalid dep_range_val %x:%x\n",
 531                                          prev_nid, val);
 532                                 continue;
 533                         }
 534                         for (n = prev_nid + 1; n <= val; n++) {
 535                                 if (conn_list) {
 536                                         if (conns >= max_conns)
 537                                                 return -ENOSPC;
 538                                         conn_list[conns] = n;
 539                                 }
 540                                 conns++;
 541                         }
 542                 } else {
 543                         if (conn_list) {
 544                                 if (conns >= max_conns)
 545                                         return -ENOSPC;
 546                                 conn_list[conns] = val;
 547                         }
 548                         conns++;
 549                 }
 550                 prev_nid = val;
 551         }
 552         return conns;
 553 }
 554 EXPORT_SYMBOL_GPL(snd_hdac_get_connections);
 555
 556 #ifdef CONFIG_PM
 557 /**
 558  * snd_hdac_power_up - power up the codec
 559  * @codec: the codec object
 560  *
 561  * This function calls the runtime PM helper to power up the given codec.
 562  * Unlike snd_hdac_power_up_pm(), you should call this only for the code
 563  * path that isn't included in PM path.  Otherwise it gets stuck.
 564  *
 565  * Returns zero if successful, or a negative error code.
 566  */
 567 int snd_hdac_power_up(struct hdac_device *codec)
 568 {
 569         return pm_runtime_get_sync(&codec->dev);
 570 }
 571 EXPORT_SYMBOL_GPL(snd_hdac_power_up);
 572
 573 /**
 574  * snd_hdac_power_down - power down the codec
 575  * @codec: the codec object
 576  *
 577  * Returns zero if successful, or a negative error code.
 578  */
 579 int snd_hdac_power_down(struct hdac_device *codec)
 580 {
 581         struct device *dev = &codec->dev;
 582
 583         pm_runtime_mark_last_busy(dev);
 584         return pm_runtime_put_autosuspend(dev);
 585 }
 586 EXPORT_SYMBOL_GPL(snd_hdac_power_down);
 587
 588 /**
 589  * snd_hdac_power_up_pm - power up the codec
 590  * @codec: the codec object
 591  *
 592  * This function can be called in a recursive code path like init code
 593  * which may be called by PM suspend/resume again.  OTOH, if a power-up
 594  * call must wake up the sleeper (e.g. in a kctl callback), use
 595  * snd_hdac_power_up() instead.
 596  *
 597  * Returns zero if successful, or a negative error code.
 598  */
 599 int snd_hdac_power_up_pm(struct hdac_device *codec)
 600 {
 601         if (!atomic_inc_not_zero(&codec->in_pm))
 602                 return snd_hdac_power_up(codec);
 603         return 0;
 604 }
 605 EXPORT_SYMBOL_GPL(snd_hdac_power_up_pm);
 606
 607 /* like snd_hdac_power_up_pm(), but only increment the pm count when
 608  * already powered up.  Returns -1 if not powered up, 1 if incremented
 609  * or 0 if unchanged.  Only used in hdac_regmap.c
 610  */
 611 int snd_hdac_keep_power_up(struct hdac_device *codec)
 612 {
 613         if (!atomic_inc_not_zero(&codec->in_pm)) {
 614                 int ret = pm_runtime_get_if_in_use(&codec->dev);
 615                 if (!ret)
 616                         return -1;
 617                 if (ret < 0)
 618                         return 0;
 619         }
 620         return 1;
 621 }
 622
 623 /**
 624  * snd_hdac_power_down_pm - power down the codec
 625  * @codec: the codec object
 626  *
 627  * Like snd_hdac_power_up_pm(), this function is used in a recursive
 628  * code path like init code which may be called by PM suspend/resume again.
 629  *
 630  * Returns zero if successful, or a negative error code.
 631  */
 632 int snd_hdac_power_down_pm(struct hdac_device *codec)
 633 {
 634         if (atomic_dec_if_positive(&codec->in_pm) < 0)
 635                 return snd_hdac_power_down(codec);
 636         return 0;
 637 }
 638 EXPORT_SYMBOL_GPL(snd_hdac_power_down_pm);
 639 #endif
 640
 641 /* codec vendor labels */
 642 struct hda_vendor_id {
 643         unsigned int id;
 644         const char *name;
 645 };
 646
 647 static const struct hda_vendor_id hda_vendor_ids[] = {
 648         { 0x1002, "ATI" },
 649         { 0x1013, "Cirrus Logic" },
 650         { 0x1057, "Motorola" },
 651         { 0x1095, "Silicon Image" },
 652         { 0x10de, "Nvidia" },
 653         { 0x10ec, "Realtek" },
 654         { 0x1102, "Creative" },
 655         { 0x1106, "VIA" },
 656         { 0x111d, "IDT" },
 657         { 0x11c1, "LSI" },
 658         { 0x11d4, "Analog Devices" },
 659         { 0x13f6, "C-Media" },
 660         { 0x14f1, "Conexant" },
 661         { 0x17e8, "Chrontel" },
 662         { 0x1854, "LG" },
 663         { 0x19e5, "Huawei" },
 664         { 0x1aec, "Wolfson Microelectronics" },
 665         { 0x1af4, "QEMU" },
 666         { 0x434d, "C-Media" },
 667         { 0x8086, "Intel" },
 668         { 0x8384, "SigmaTel" },
 669         {} /* terminator */
 670 };
 671
 672 /* store the codec vendor name */
 673 static int get_codec_vendor_name(struct hdac_device *codec)
 674 {
 675         const struct hda_vendor_id *c;
 676         u16 vendor_id = codec->vendor_id >> 16;
 677
 678         for (c = hda_vendor_ids; c->id; c++) {
 679                 if (c->id == vendor_id) {
 680                         codec->vendor_name = kstrdup(c->name, GFP_KERNEL);
 681                         return codec->vendor_name ? 0 : -ENOMEM;
 682                 }
 683         }
 684
 685         codec->vendor_name = kasprintf(GFP_KERNEL, "Generic %04x", vendor_id);
 686         return codec->vendor_name ? 0 : -ENOMEM;
 687 }
 688
 689 /*
 690  * stream formats
 691  */
 692 struct hda_rate_tbl {
 693         unsigned int hz;
 694         unsigned int alsa_bits;
 695         unsigned int hda_fmt;
 696 };
 697
 698 /* rate = base * mult / div */
 699 #define HDA_RATE(base, mult, div) \
 700         (AC_FMT_BASE_##base##K | (((mult) - 1) << AC_FMT_MULT_SHIFT) | \
 701          (((div) - 1) << AC_FMT_DIV_SHIFT))
 702
 703 static const struct hda_rate_tbl rate_bits[] = {
 704         /* rate in Hz, ALSA rate bitmask, HDA format value */
 705
 706         /* autodetected value used in snd_hda_query_supported_pcm */
 707         { 8000, SNDRV_PCM_RATE_8000, HDA_RATE(48, 1, 6) },
 708         { 11025, SNDRV_PCM_RATE_11025, HDA_RATE(44, 1, 4) },
 709         { 16000, SNDRV_PCM_RATE_16000, HDA_RATE(48, 1, 3) },
 710         { 22050, SNDRV_PCM_RATE_22050, HDA_RATE(44, 1, 2) },
 711         { 32000, SNDRV_PCM_RATE_32000, HDA_RATE(48, 2, 3) },
 712         { 44100, SNDRV_PCM_RATE_44100, HDA_RATE(44, 1, 1) },
 713         { 48000, SNDRV_PCM_RATE_48000, HDA_RATE(48, 1, 1) },
 714         { 88200, SNDRV_PCM_RATE_88200, HDA_RATE(44, 2, 1) },
 715         { 96000, SNDRV_PCM_RATE_96000, HDA_RATE(48, 2, 1) },
 716         { 176400, SNDRV_PCM_RATE_176400, HDA_RATE(44, 4, 1) },
 717         { 192000, SNDRV_PCM_RATE_192000, HDA_RATE(48, 4, 1) },
 718 #define AC_PAR_PCM_RATE_BITS    11
 719         /* up to bits 10, 384kHZ isn't supported properly */
 720
 721         /* not autodetected value */
 722         { 9600, SNDRV_PCM_RATE_KNOT, HDA_RATE(48, 1, 5) },
 723
 724         { 0 } /* terminator */
 725 };
 726
 727 /**
 728  * snd_hdac_calc_stream_format - calculate the format bitset
 729  * @rate: the sample rate
 730  * @channels: the number of channels
 731  * @format: the PCM format (SNDRV_PCM_FORMAT_XXX)
 732  * @maxbps: the max. bps
 733  * @spdif_ctls: HD-audio SPDIF status bits (0 if irrelevant)
 734  *
 735  * Calculate the format bitset from the given rate, channels and th PCM format.
 736  *
 737  * Return zero if invalid.
 738  */
 739 unsigned int snd_hdac_calc_stream_format(unsigned int rate,
 740                                          unsigned int channels,
 741                                          snd_pcm_format_t format,
 742                                          unsigned int maxbps,
 743                                          unsigned short spdif_ctls)
 744 {
 745         int i;
 746         unsigned int val = 0;
 747
 748         for (i = 0; rate_bits[i].hz; i++)
 749                 if (rate_bits[i].hz == rate) {
 750                         val = rate_bits[i].hda_fmt;
 751                         break;
 752                 }
 753         if (!rate_bits[i].hz)
 754                 return 0;
 755
 756         if (channels == 0 || channels > 8)
 757                 return 0;
 758         val |= channels - 1;
 759
 760         switch (snd_pcm_format_width(format)) {
 761         case 8:
 762                 val |= AC_FMT_BITS_8;
 763                 break;
 764         case 16:
 765                 val |= AC_FMT_BITS_16;
 766                 break;
 767         case 20:
 768         case 24:
 769         case 32:
 770                 if (maxbps >= 32 || format == SNDRV_PCM_FORMAT_FLOAT_LE)
 771                         val |= AC_FMT_BITS_32;
 772                 else if (maxbps >= 24)
 773                         val |= AC_FMT_BITS_24;
 774                 else
 775                         val |= AC_FMT_BITS_20;
 776                 break;
 777         default:
 778                 return 0;
 779         }
 780
 781         if (spdif_ctls & AC_DIG1_NONAUDIO)
 782                 val |= AC_FMT_TYPE_NON_PCM;
 783
 784         return val;
 785 }
 786 EXPORT_SYMBOL_GPL(snd_hdac_calc_stream_format);
 787
 788 static unsigned int query_pcm_param(struct hdac_device *codec, hda_nid_t nid)
 789 {
 790         unsigned int val = 0;
 791
 792         if (nid != codec->afg &&
 793             (get_wcaps(codec, nid) & AC_WCAP_FORMAT_OVRD))
 794                 val = snd_hdac_read_parm(codec, nid, AC_PAR_PCM);
 795         if (!val || val == -1)
 796                 val = snd_hdac_read_parm(codec, codec->afg, AC_PAR_PCM);
 797         if (!val || val == -1)
 798                 return 0;
 799         return val;
 800 }
 801
 802 static unsigned int query_stream_param(struct hdac_device *codec, hda_nid_t nid)
 803 {
 804         unsigned int streams = snd_hdac_read_parm(codec, nid, AC_PAR_STREAM);
 805
 806         if (!streams || streams == -1)
 807                 streams = snd_hdac_read_parm(codec, codec->afg, AC_PAR_STREAM);
 808         if (!streams || streams == -1)
 809                 return 0;
 810         return streams;
 811 }
 812
 813 /**
 814  * snd_hdac_query_supported_pcm - query the supported PCM rates and formats
 815  * @codec: the codec object
 816  * @nid: NID to query
 817  * @ratesp: the pointer to store the detected rate bitflags
 818  * @formatsp: the pointer to store the detected formats
 819  * @bpsp: the pointer to store the detected format widths
 820  *
 821  * Queries the supported PCM rates and formats.  The NULL @ratesp, @formatsp
 822  * or @bsps argument is ignored.
 823  *
 824  * Returns 0 if successful, otherwise a negative error code.
 825  */
 826 int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
 827                                  u32 *ratesp, u64 *formatsp, unsigned int *bpsp)
 828 {
 829         unsigned int i, val, wcaps;
 830
 831         wcaps = get_wcaps(codec, nid);
 832         val = query_pcm_param(codec, nid);
 833
 834         if (ratesp) {
 835                 u32 rates = 0;
 836                 for (i = 0; i < AC_PAR_PCM_RATE_BITS; i++) {
 837                         if (val & (1 << i))
 838                                 rates |= rate_bits[i].alsa_bits;
 839                 }
 840                 if (rates == 0) {
 841                         dev_err(&codec->dev,
 842                                 "rates == 0 (nid=0x%x, val=0x%x, ovrd=%i)\n",
 843                                 nid, val,
 844                                 (wcaps & AC_WCAP_FORMAT_OVRD) ? 1 : 0);
 845                         return -EIO;
 846                 }
 847                 *ratesp = rates;
 848         }
 849
 850         if (formatsp || bpsp) {
 851                 u64 formats = 0;
 852                 unsigned int streams, bps;
 853
 854                 streams = query_stream_param(codec, nid);
 855                 if (!streams)
 856                         return -EIO;
 857
 858                 bps = 0;
 859                 if (streams & AC_SUPFMT_PCM) {
 860                         if (val & AC_SUPPCM_BITS_8) {
 861                                 formats |= SNDRV_PCM_FMTBIT_U8;
 862                                 bps = 8;
 863                         }
 864                         if (val & AC_SUPPCM_BITS_16) {
 865                                 formats |= SNDRV_PCM_FMTBIT_S16_LE;
 866                                 bps = 16;
 867                         }
 868                         if (wcaps & AC_WCAP_DIGITAL) {
 869                                 if (val & AC_SUPPCM_BITS_32)
 870                                         formats |= SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE;
 871                                 if (val & (AC_SUPPCM_BITS_20|AC_SUPPCM_BITS_24))
 872                                         formats |= SNDRV_PCM_FMTBIT_S32_LE;
 873                                 if (val & AC_SUPPCM_BITS_24)
 874                                         bps = 24;
 875                                 else if (val & AC_SUPPCM_BITS_20)
 876                                         bps = 20;
 877                         } else if (val & (AC_SUPPCM_BITS_20|AC_SUPPCM_BITS_24|
 878                                           AC_SUPPCM_BITS_32)) {
 879                                 formats |= SNDRV_PCM_FMTBIT_S32_LE;
 880                                 if (val & AC_SUPPCM_BITS_32)
 881                                         bps = 32;
 882                                 else if (val & AC_SUPPCM_BITS_24)
 883                                         bps = 24;
 884                                 else if (val & AC_SUPPCM_BITS_20)
 885                                         bps = 20;
 886                         }
 887                 }
 888 #if 0 /* FIXME: CS4206 doesn't work, which is the only codec supporting float */
 889                 if (streams & AC_SUPFMT_FLOAT32) {
 890                         formats |= SNDRV_PCM_FMTBIT_FLOAT_LE;
 891                         if (!bps)
 892                                 bps = 32;
 893                 }
 894 #endif
 895                 if (streams == AC_SUPFMT_AC3) {
 896                         /* should be exclusive */
 897                         /* temporary hack: we have still no proper support
 898                          * for the direct AC3 stream...
 899                          */
 900                         formats |= SNDRV_PCM_FMTBIT_U8;
 901                         bps = 8;
 902                 }
 903                 if (formats == 0) {
 904                         dev_err(&codec->dev,
 905                                 "formats == 0 (nid=0x%x, val=0x%x, ovrd=%i, streams=0x%x)\n",
 906                                 nid, val,
 907                                 (wcaps & AC_WCAP_FORMAT_OVRD) ? 1 : 0,
 908                                 streams);
 909                         return -EIO;
 910                 }
 911                 if (formatsp)
 912                         *formatsp = formats;
 913                 if (bpsp)
 914                         *bpsp = bps;
 915         }
 916
 917         return 0;
 918 }
 919 EXPORT_SYMBOL_GPL(snd_hdac_query_supported_pcm);
 920
 921 /**
 922  * snd_hdac_is_supported_format - Check the validity of the format
 923  * @codec: the codec object
 924  * @nid: NID to check
 925  * @format: the HD-audio format value to check
 926  *
 927  * Check whether the given node supports the format value.
 928  *
 929  * Returns true if supported, false if not.
 930  */
 931 bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
 932                                   unsigned int format)
 933 {
 934         int i;
 935         unsigned int val = 0, rate, stream;
 936
 937         val = query_pcm_param(codec, nid);
 938         if (!val)
 939                 return false;
 940
 941         rate = format & 0xff00;
 942         for (i = 0; i < AC_PAR_PCM_RATE_BITS; i++)
 943                 if (rate_bits[i].hda_fmt == rate) {
 944                         if (val & (1 << i))
 945                                 break;
 946                         return false;
 947                 }
 948         if (i >= AC_PAR_PCM_RATE_BITS)
 949                 return false;
 950
 951         stream = query_stream_param(codec, nid);
 952         if (!stream)
 953                 return false;
 954
 955         if (stream & AC_SUPFMT_PCM) {
 956                 switch (format & 0xf0) {
 957                 case 0x00:
 958                         if (!(val & AC_SUPPCM_BITS_8))
 959                                 return false;
 960                         break;
 961                 case 0x10:
 962                         if (!(val & AC_SUPPCM_BITS_16))
 963                                 return false;
 964                         break;
 965                 case 0x20:
 966                         if (!(val & AC_SUPPCM_BITS_20))
 967                                 return false;
 968                         break;
 969                 case 0x30:
 970                         if (!(val & AC_SUPPCM_BITS_24))
 971                                 return false;
 972                         break;
 973                 case 0x40:
 974                         if (!(val & AC_SUPPCM_BITS_32))
 975                                 return false;
 976                         break;
 977                 default:
 978                         return false;
 979                 }
 980         } else {
 981                 /* FIXME: check for float32 and AC3? */
 982         }
 983
 984         return true;
 985 }
 986 EXPORT_SYMBOL_GPL(snd_hdac_is_supported_format);
 987
 988 static unsigned int codec_read(struct hdac_device *hdac, hda_nid_t nid,
 989                         int flags, unsigned int verb, unsigned int parm)
 990 {
 991         unsigned int cmd = snd_hdac_make_cmd(hdac, nid, verb, parm);
 992         unsigned int res;
 993
 994         if (snd_hdac_exec_verb(hdac, cmd, flags, &res))
 995                 return -1;
 996
 997         return res;
 998 }
 999
1000 static int codec_write(struct hdac_device *hdac, hda_nid_t nid,
1001                         int flags, unsigned int verb, unsigned int parm)
1002 {
1003         unsigned int cmd = snd_hdac_make_cmd(hdac, nid, verb, parm);
1004
1005         return snd_hdac_exec_verb(hdac, cmd, flags, NULL);
1006 }
1007
1008 /**
1009  * snd_hdac_codec_read - send a command and get the response
1010  * @hdac: the HDAC device
1011  * @nid: NID to send the command
1012  * @flags: optional bit flags
1013  * @verb: the verb to send
1014  * @parm: the parameter for the verb
1015  *
1016  * Send a single command and read the corresponding response.
1017  *
1018  * Returns the obtained response value, or -1 for an error.
1019  */
1020 int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
1021                         int flags, unsigned int verb, unsigned int parm)
1022 {
1023         return codec_read(hdac, nid, flags, verb, parm);
1024 }
1025 EXPORT_SYMBOL_GPL(snd_hdac_codec_read);
1026
1027 /**
1028  * snd_hdac_codec_write - send a single command without waiting for response
1029  * @hdac: the HDAC device
1030  * @nid: NID to send the command
1031  * @flags: optional bit flags
1032  * @verb: the verb to send
1033  * @parm: the parameter for the verb
1034  *
1035  * Send a single command without waiting for response.
1036  *
1037  * Returns 0 if successful, or a negative error code.
1038  */
1039 int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
1040                         int flags, unsigned int verb, unsigned int parm)
1041 {
1042         return codec_write(hdac, nid, flags, verb, parm);
1043 }
1044 EXPORT_SYMBOL_GPL(snd_hdac_codec_write);
1045
1046 /**
1047  * snd_hdac_check_power_state - check whether the actual power state matches
1048  * with the target state
1049  *
1050  * @hdac: the HDAC device
1051  * @nid: NID to send the command
1052  * @target_state: target state to check for
1053  *
1054  * Return true if state matches, false if not
1055  */
1056 bool snd_hdac_check_power_state(struct hdac_device *hdac,
1057                 hda_nid_t nid, unsigned int target_state)
1058 {
1059         unsigned int state = codec_read(hdac, nid, 0,
1060                                 AC_VERB_GET_POWER_STATE, 0);
1061
1062         if (state & AC_PWRST_ERROR)
1063                 return true;
1064         state = (state >> 4) & 0x0f;
1065         return (state == target_state);
1066 }
1067 EXPORT_SYMBOL_GPL(snd_hdac_check_power_state);
1068 /**
1069  * snd_hdac_sync_power_state - wait until actual power state matches
1070  * with the target state
1071  *
1072  * @codec: the HDAC device
1073  * @nid: NID to send the command
1074  * @power_state: target power state to wait for
1075  *
1076  * Return power state or PS_ERROR if codec rejects GET verb.
1077  */
1078 unsigned int snd_hdac_sync_power_state(struct hdac_device *codec,
1079                         hda_nid_t nid, unsigned int power_state)
1080 {
1081         unsigned long end_time = jiffies + msecs_to_jiffies(500);
1082         unsigned int state, actual_state, count;
1083
1084         for (count = 0; count < 500; count++) {
1085                 state = snd_hdac_codec_read(codec, nid, 0,
1086                                 AC_VERB_GET_POWER_STATE, 0);
1087                 if (state & AC_PWRST_ERROR) {
1088                         msleep(20);
1089                         break;
1090                 }
1091                 actual_state = (state >> 4) & 0x0f;
1092                 if (actual_state == power_state)
1093                         break;
1094                 if (time_after_eq(jiffies, end_time))
1095                         break;
1096                 /* wait until the codec reachs to the target state */
1097                 msleep(1);
1098         }
1099         return state;
1100 }
1101 EXPORT_SYMBOL_GPL(snd_hdac_sync_power_state);