sound/hda/hdac_device.c

   1 /*
   2  * HD-audio codec core device
   3  */
   4
   5 #include <linux/init.h>
   6 #include <linux/device.h>
   7 #include <linux/slab.h>
   8 #include <linux/module.h>
   9 #include <linux/export.h>
  10 #include <linux/pm_runtime.h>
  11 #include <sound/hdaudio.h>
  12 #include <sound/hda_regmap.h>
  13 #include "local.h"
  14
  15 static void setup_fg_nodes(struct hdac_device *codec);
  16 static int get_codec_vendor_name(struct hdac_device *codec);
  17
  18 static void default_release(struct device *dev)
  19 {
  20         snd_hdac_device_exit(container_of(dev, struct hdac_device, dev));
  21 }
  22
  23 /**
  24  * snd_hdac_device_init - initialize the HD-audio codec base device
  25  * @codec: device to initialize
  26  * @bus: but to attach
  27  * @name: device name string
  28  * @addr: codec address
  29  *
  30  * Returns zero for success or a negative error code.
  31  *
  32  * This function increments the runtime PM counter and marks it active.
  33  * The caller needs to turn it off appropriately later.
  34  *
  35  * The caller needs to set the device's release op properly by itself.
  36  */
  37 int snd_hdac_device_init(struct hdac_device *codec, struct hdac_bus *bus,
  38                          const char *name, unsigned int addr)
  39 {
  40         struct device *dev;
  41         hda_nid_t fg;
  42         int err;
  43
  44         dev = &codec->dev;
  45         device_initialize(dev);
  46         dev->parent = bus->dev;
  47         dev->bus = &snd_hda_bus_type;
  48         dev->release = default_release;
  49         dev->groups = hdac_dev_attr_groups;
  50         dev_set_name(dev, "%s", name);
  51         device_enable_async_suspend(dev);
  52
  53         codec->bus = bus;
  54         codec->addr = addr;
  55         codec->type = HDA_DEV_CORE;
  56         pm_runtime_set_active(&codec->dev);
  57         pm_runtime_get_noresume(&codec->dev);
  58         atomic_set(&codec->in_pm, 0);
  59
  60         err = snd_hdac_bus_add_device(bus, codec);
  61         if (err < 0)
  62                 goto error;
  63
  64         /* fill parameters */
  65         codec->vendor_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  66                                               AC_PAR_VENDOR_ID);
  67         if (codec->vendor_id == -1) {
  68                 /* read again, hopefully the access method was corrected
  69                  * in the last read...
  70                  */
  71                 codec->vendor_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  72                                                       AC_PAR_VENDOR_ID);
  73         }
  74
  75         codec->subsystem_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  76                                                  AC_PAR_SUBSYSTEM_ID);
  77         codec->revision_id = snd_hdac_read_parm(codec, AC_NODE_ROOT,
  78                                                 AC_PAR_REV_ID);
  79
  80         setup_fg_nodes(codec);
  81         if (!codec->afg && !codec->mfg) {
  82                 dev_err(dev, "no AFG or MFG node found\n");
  83                 err = -ENODEV;
  84                 goto error;
  85         }
  86
  87         fg = codec->afg ? codec->afg : codec->mfg;
  88
  89         err = snd_hdac_refresh_widgets(codec);
  90         if (err < 0)
  91                 goto error;
  92
  93         codec->power_caps = snd_hdac_read_parm(codec, fg, AC_PAR_POWER_STATE);
  94         /* reread ssid if not set by parameter */
  95         if (codec->subsystem_id == -1 || codec->subsystem_id == 0)
  96                 snd_hdac_read(codec, fg, AC_VERB_GET_SUBSYSTEM_ID, 0,
  97                               &codec->subsystem_id);
  98
  99         err = get_codec_vendor_name(codec);
 100         if (err < 0)
 101                 goto error;
 102
 103         codec->chip_name = kasprintf(GFP_KERNEL, "ID %x",
 104                                      codec->vendor_id & 0xffff);
 105         if (!codec->chip_name) {
 106                 err = -ENOMEM;
 107                 goto error;
 108         }
 109
 110         return 0;
 111
 112  error:
 113         put_device(&codec->dev);
 114         return err;
 115 }
 116 EXPORT_SYMBOL_GPL(snd_hdac_device_init);
 117
 118 /**
 119  * snd_hdac_device_exit - clean up the HD-audio codec base device
 120  * @codec: device to clean up
 121  */
 122 void snd_hdac_device_exit(struct hdac_device *codec)
 123 {
 124         pm_runtime_put_noidle(&codec->dev);
 125         snd_hdac_bus_remove_device(codec->bus, codec);
 126         kfree(codec->vendor_name);
 127         kfree(codec->chip_name);
 128 }
 129 EXPORT_SYMBOL_GPL(snd_hdac_device_exit);
 130
 131 /**
 132  * snd_hdac_device_register - register the hd-audio codec base device
 133  * codec: the device to register
 134  */
 135 int snd_hdac_device_register(struct hdac_device *codec)
 136 {
 137         int err;
 138
 139         err = device_add(&codec->dev);
 140         if (err < 0)
 141                 return err;
 142         err = hda_widget_sysfs_init(codec);
 143         if (err < 0) {
 144                 device_del(&codec->dev);
 145                 return err;
 146         }
 147
 148         return 0;
 149 }
 150 EXPORT_SYMBOL_GPL(snd_hdac_device_register);
 151
 152 /**
 153  * snd_hdac_device_unregister - unregister the hd-audio codec base device
 154  * codec: the device to unregister
 155  */
 156 void snd_hdac_device_unregister(struct hdac_device *codec)
 157 {
 158         if (device_is_registered(&codec->dev)) {
 159                 hda_widget_sysfs_exit(codec);
 160                 device_del(&codec->dev);
 161         }
 162 }
 163 EXPORT_SYMBOL_GPL(snd_hdac_device_unregister);
 164
 165 /**
 166  * snd_hdac_make_cmd - compose a 32bit command word to be sent to the
 167  *      HD-audio controller
 168  * @codec: the codec object
 169  * @nid: NID to encode
 170  * @verb: verb to encode
 171  * @parm: parameter to encode
 172  *
 173  * Return an encoded command verb or -1 for error.
 174  */
 175 unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
 176                                unsigned int verb, unsigned int parm)
 177 {
 178         u32 val, addr;
 179
 180         addr = codec->addr;
 181         if ((addr & ~0xf) || (nid & ~0x7f) ||
 182             (verb & ~0xfff) || (parm & ~0xffff)) {
 183                 dev_err(&codec->dev, "out of range cmd %x:%x:%x:%x\n",
 184                         addr, nid, verb, parm);
 185                 return -1;
 186         }
 187
 188         val = addr << 28;
 189         val |= (u32)nid << 20;
 190         val |= verb << 8;
 191         val |= parm;
 192         return val;
 193 }
 194 EXPORT_SYMBOL_GPL(snd_hdac_make_cmd);
 195
 196 /**
 197  * snd_hdac_exec_verb - execute an encoded verb
 198  * @codec: the codec object
 199  * @cmd: encoded verb to execute
 200  * @flags: optional flags, pass zero for default
 201  * @res: the pointer to store the result, NULL if running async
 202  *
 203  * Returns zero if successful, or a negative error code.
 204  *
 205  * This calls the exec_verb op when set in hdac_codec.  If not,
 206  * call the default snd_hdac_bus_exec_verb().
 207  */
 208 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
 209                        unsigned int flags, unsigned int *res)
 210 {
 211         if (codec->exec_verb)
 212                 return codec->exec_verb(codec, cmd, flags, res);
 213         return snd_hdac_bus_exec_verb(codec->bus, codec->addr, cmd, res);
 214 }
 215 EXPORT_SYMBOL_GPL(snd_hdac_exec_verb);
 216
 217
 218 /**
 219  * snd_hdac_read - execute a verb
 220  * @codec: the codec object
 221  * @nid: NID to execute a verb
 222  * @verb: verb to execute
 223  * @parm: parameter for a verb
 224  * @res: the pointer to store the result, NULL if running async
 225  *
 226  * Returns zero if successful, or a negative error code.
 227  */
 228 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
 229                   unsigned int verb, unsigned int parm, unsigned int *res)
 230 {
 231         unsigned int cmd = snd_hdac_make_cmd(codec, nid, verb, parm);
 232
 233         return snd_hdac_exec_verb(codec, cmd, 0, res);
 234 }
 235 EXPORT_SYMBOL_GPL(snd_hdac_read);
 236
 237 /**
 238  * _snd_hdac_read_parm - read a parmeter
 239  *
 240  * This function returns zero or an error unlike snd_hdac_read_parm().
 241  */
 242 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
 243                         unsigned int *res)
 244 {
 245         unsigned int cmd;
 246
 247         cmd = snd_hdac_regmap_encode_verb(nid, AC_VERB_PARAMETERS) | parm;
 248         return snd_hdac_regmap_read_raw(codec, cmd, res);
 249 }
 250 EXPORT_SYMBOL_GPL(_snd_hdac_read_parm);
 251
 252 /**
 253  * snd_hdac_read_parm_uncached - read a codec parameter without caching
 254  * @codec: the codec object
 255  * @nid: NID to read a parameter
 256  * @parm: parameter to read
 257  *
 258  * Returns -1 for error.  If you need to distinguish the error more
 259  * strictly, use snd_hdac_read() directly.
 260  */
 261 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
 262                                 int parm)
 263 {
 264         unsigned int cmd, val;
 265
 266         cmd = snd_hdac_regmap_encode_verb(nid, AC_VERB_PARAMETERS) | parm;
 267         if (snd_hdac_regmap_read_raw_uncached(codec, cmd, &val) < 0)
 268                 return -1;
 269         return val;
 270 }
 271 EXPORT_SYMBOL_GPL(snd_hdac_read_parm_uncached);
 272
 273 /**
 274  * snd_hdac_override_parm - override read-only parameters
 275  * @codec: the codec object
 276  * @nid: NID for the parameter
 277  * @parm: the parameter to change
 278  * @val: the parameter value to overwrite
 279  */
 280 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
 281                            unsigned int parm, unsigned int val)
 282 {
 283         unsigned int verb = (AC_VERB_PARAMETERS << 8) | (nid << 20) | parm;
 284         int err;
 285
 286         if (!codec->regmap)
 287                 return -EINVAL;
 288
 289         codec->caps_overwriting = true;
 290         err = snd_hdac_regmap_write_raw(codec, verb, val);
 291         codec->caps_overwriting = false;
 292         return err;
 293 }
 294 EXPORT_SYMBOL_GPL(snd_hdac_override_parm);
 295
 296 /**
 297  * snd_hdac_get_sub_nodes - get start NID and number of subtree nodes
 298  * @codec: the codec object
 299  * @nid: NID to inspect
 300  * @start_id: the pointer to store the starting NID
 301  *
 302  * Returns the number of subtree nodes or zero if not found.
 303  * This function reads parameters always without caching.
 304  */
 305 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
 306                            hda_nid_t *start_id)
 307 {
 308         unsigned int parm;
 309
 310         parm = snd_hdac_read_parm_uncached(codec, nid, AC_PAR_NODE_COUNT);
 311         if (parm == -1) {
 312                 *start_id = 0;
 313                 return 0;
 314         }
 315         *start_id = (parm >> 16) & 0x7fff;
 316         return (int)(parm & 0x7fff);
 317 }
 318 EXPORT_SYMBOL_GPL(snd_hdac_get_sub_nodes);
 319
 320 /*
 321  * look for an AFG and MFG nodes
 322  */
 323 static void setup_fg_nodes(struct hdac_device *codec)
 324 {
 325         int i, total_nodes, function_id;
 326         hda_nid_t nid;
 327
 328         total_nodes = snd_hdac_get_sub_nodes(codec, AC_NODE_ROOT, &nid);
 329         for (i = 0; i < total_nodes; i++, nid++) {
 330                 function_id = snd_hdac_read_parm(codec, nid,
 331                                                  AC_PAR_FUNCTION_TYPE);
 332                 switch (function_id & 0xff) {
 333                 case AC_GRP_AUDIO_FUNCTION:
 334                         codec->afg = nid;
 335                         codec->afg_function_id = function_id & 0xff;
 336                         codec->afg_unsol = (function_id >> 8) & 1;
 337                         break;
 338                 case AC_GRP_MODEM_FUNCTION:
 339                         codec->mfg = nid;
 340                         codec->mfg_function_id = function_id & 0xff;
 341                         codec->mfg_unsol = (function_id >> 8) & 1;
 342                         break;
 343                 default:
 344                         break;
 345                 }
 346         }
 347 }
 348
 349 /**
 350  * snd_hdac_refresh_widgets - Reset the widget start/end nodes
 351  * @codec: the codec object
 352  */
 353 int snd_hdac_refresh_widgets(struct hdac_device *codec)
 354 {
 355         hda_nid_t start_nid;
 356         int nums;
 357
 358         nums = snd_hdac_get_sub_nodes(codec, codec->afg, &start_nid);
 359         if (!start_nid || nums <= 0 || nums >= 0xff) {
 360                 dev_err(&codec->dev, "cannot read sub nodes for FG 0x%02x\n",
 361                         codec->afg);
 362                 return -EINVAL;
 363         }
 364
 365         codec->num_nodes = nums;
 366         codec->start_nid = start_nid;
 367         codec->end_nid = start_nid + nums;
 368         return 0;
 369 }
 370 EXPORT_SYMBOL_GPL(snd_hdac_refresh_widgets);
 371
 372 /* return CONNLIST_LEN parameter of the given widget */
 373 static unsigned int get_num_conns(struct hdac_device *codec, hda_nid_t nid)
 374 {
 375         unsigned int wcaps = get_wcaps(codec, nid);
 376         unsigned int parm;
 377
 378         if (!(wcaps & AC_WCAP_CONN_LIST) &&
 379             get_wcaps_type(wcaps) != AC_WID_VOL_KNB)
 380                 return 0;
 381
 382         parm = snd_hdac_read_parm(codec, nid, AC_PAR_CONNLIST_LEN);
 383         if (parm == -1)
 384                 parm = 0;
 385         return parm;
 386 }
 387
 388 /**
 389  * snd_hdac_get_connections - get a widget connection list
 390  * @codec: the codec object
 391  * @nid: NID
 392  * @conn_list: the array to store the results, can be NULL
 393  * @max_conns: the max size of the given array
 394  *
 395  * Returns the number of connected widgets, zero for no connection, or a
 396  * negative error code.  When the number of elements don't fit with the
 397  * given array size, it returns -ENOSPC.
 398  *
 399  * When @conn_list is NULL, it just checks the number of connections.
 400  */
 401 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
 402                              hda_nid_t *conn_list, int max_conns)
 403 {
 404         unsigned int parm;
 405         int i, conn_len, conns, err;
 406         unsigned int shift, num_elems, mask;
 407         hda_nid_t prev_nid;
 408         int null_count = 0;
 409
 410         parm = get_num_conns(codec, nid);
 411         if (!parm)
 412                 return 0;
 413
 414         if (parm & AC_CLIST_LONG) {
 415                 /* long form */
 416                 shift = 16;
 417                 num_elems = 2;
 418         } else {
 419                 /* short form */
 420                 shift = 8;
 421                 num_elems = 4;
 422         }
 423         conn_len = parm & AC_CLIST_LENGTH;
 424         mask = (1 << (shift-1)) - 1;
 425
 426         if (!conn_len)
 427                 return 0; /* no connection */
 428
 429         if (conn_len == 1) {
 430                 /* single connection */
 431                 err = snd_hdac_read(codec, nid, AC_VERB_GET_CONNECT_LIST, 0,
 432                                     &parm);
 433                 if (err < 0)
 434                         return err;
 435                 if (conn_list)
 436                         conn_list[0] = parm & mask;
 437                 return 1;
 438         }
 439
 440         /* multi connection */
 441         conns = 0;
 442         prev_nid = 0;
 443         for (i = 0; i < conn_len; i++) {
 444                 int range_val;
 445                 hda_nid_t val, n;
 446
 447                 if (i % num_elems == 0) {
 448                         err = snd_hdac_read(codec, nid,
 449                                             AC_VERB_GET_CONNECT_LIST, i,
 450                                             &parm);
 451                         if (err < 0)
 452                                 return -EIO;
 453                 }
 454                 range_val = !!(parm & (1 << (shift-1))); /* ranges */
 455                 val = parm & mask;
 456                 if (val == 0 && null_count++) {  /* no second chance */
 457                         dev_dbg(&codec->dev,
 458                                 "invalid CONNECT_LIST verb %x[%i]:%x\n",
 459                                 nid, i, parm);
 460                         return 0;
 461                 }
 462                 parm >>= shift;
 463                 if (range_val) {
 464                         /* ranges between the previous and this one */
 465                         if (!prev_nid || prev_nid >= val) {
 466                                 dev_warn(&codec->dev,
 467                                          "invalid dep_range_val %x:%x\n",
 468                                          prev_nid, val);
 469                                 continue;
 470                         }
 471                         for (n = prev_nid + 1; n <= val; n++) {
 472                                 if (conn_list) {
 473                                         if (conns >= max_conns)
 474                                                 return -ENOSPC;
 475                                         conn_list[conns] = n;
 476                                 }
 477                                 conns++;
 478                         }
 479                 } else {
 480                         if (conn_list) {
 481                                 if (conns >= max_conns)
 482                                         return -ENOSPC;
 483                                 conn_list[conns] = val;
 484                         }
 485                         conns++;
 486                 }
 487                 prev_nid = val;
 488         }
 489         return conns;
 490 }
 491 EXPORT_SYMBOL_GPL(snd_hdac_get_connections);
 492
 493 #ifdef CONFIG_PM
 494 /**
 495  * snd_hdac_power_up - power up the codec
 496  * @codec: the codec object
 497  *
 498  * This function calls the runtime PM helper to power up the given codec.
 499  * Unlike snd_hdac_power_up_pm(), you should call this only for the code
 500  * path that isn't included in PM path.  Otherwise it gets stuck.
 501  *
 502  * Returns zero if successful, or a negative error code.
 503  */
 504 int snd_hdac_power_up(struct hdac_device *codec)
 505 {
 506         return pm_runtime_get_sync(&codec->dev);
 507 }
 508 EXPORT_SYMBOL_GPL(snd_hdac_power_up);
 509
 510 /**
 511  * snd_hdac_power_down - power down the codec
 512  * @codec: the codec object
 513  *
 514  * Returns zero if successful, or a negative error code.
 515  */
 516 int snd_hdac_power_down(struct hdac_device *codec)
 517 {
 518         struct device *dev = &codec->dev;
 519
 520         pm_runtime_mark_last_busy(dev);
 521         return pm_runtime_put_autosuspend(dev);
 522 }
 523 EXPORT_SYMBOL_GPL(snd_hdac_power_down);
 524
 525 /**
 526  * snd_hdac_power_up_pm - power up the codec
 527  * @codec: the codec object
 528  *
 529  * This function can be called in a recursive code path like init code
 530  * which may be called by PM suspend/resume again.  OTOH, if a power-up
 531  * call must wake up the sleeper (e.g. in a kctl callback), use
 532  * snd_hdac_power_up() instead.
 533  *
 534  * Returns zero if successful, or a negative error code.
 535  */
 536 int snd_hdac_power_up_pm(struct hdac_device *codec)
 537 {
 538         if (!atomic_inc_not_zero(&codec->in_pm))
 539                 return snd_hdac_power_up(codec);
 540         return 0;
 541 }
 542 EXPORT_SYMBOL_GPL(snd_hdac_power_up_pm);
 543
 544 /**
 545  * snd_hdac_power_down_pm - power down the codec
 546  * @codec: the codec object
 547  *
 548  * Like snd_hdac_power_up_pm(), this function is used in a recursive
 549  * code path like init code which may be called by PM suspend/resume again.
 550  *
 551  * Returns zero if successful, or a negative error code.
 552  */
 553 int snd_hdac_power_down_pm(struct hdac_device *codec)
 554 {
 555         if (atomic_dec_if_positive(&codec->in_pm) < 0)
 556                 return snd_hdac_power_down(codec);
 557         return 0;
 558 }
 559 EXPORT_SYMBOL_GPL(snd_hdac_power_down_pm);
 560 #endif
 561
 562 /* codec vendor labels */
 563 struct hda_vendor_id {
 564         unsigned int id;
 565         const char *name;
 566 };
 567
 568 static struct hda_vendor_id hda_vendor_ids[] = {
 569         { 0x1002, "ATI" },
 570         { 0x1013, "Cirrus Logic" },
 571         { 0x1057, "Motorola" },
 572         { 0x1095, "Silicon Image" },
 573         { 0x10de, "Nvidia" },
 574         { 0x10ec, "Realtek" },
 575         { 0x1102, "Creative" },
 576         { 0x1106, "VIA" },
 577         { 0x111d, "IDT" },
 578         { 0x11c1, "LSI" },
 579         { 0x11d4, "Analog Devices" },
 580         { 0x13f6, "C-Media" },
 581         { 0x14f1, "Conexant" },
 582         { 0x17e8, "Chrontel" },
 583         { 0x1854, "LG" },
 584         { 0x1aec, "Wolfson Microelectronics" },
 585         { 0x1af4, "QEMU" },
 586         { 0x434d, "C-Media" },
 587         { 0x8086, "Intel" },
 588         { 0x8384, "SigmaTel" },
 589         {} /* terminator */
 590 };
 591
 592 /* store the codec vendor name */
 593 static int get_codec_vendor_name(struct hdac_device *codec)
 594 {
 595         const struct hda_vendor_id *c;
 596         u16 vendor_id = codec->vendor_id >> 16;
 597
 598         for (c = hda_vendor_ids; c->id; c++) {
 599                 if (c->id == vendor_id) {
 600                         codec->vendor_name = kstrdup(c->name, GFP_KERNEL);
 601                         return codec->vendor_name ? 0 : -ENOMEM;
 602                 }
 603         }
 604
 605         codec->vendor_name = kasprintf(GFP_KERNEL, "Generic %04x", vendor_id);
 606         return codec->vendor_name ? 0 : -ENOMEM;
 607 }