LXR linux/sound/pci/hda/hda

   1// SPDX-License-Identifier: GPL-2.0-only
   2/*
   3 * HD-audio codec driver binding
   4 * Copyright (c) Takashi Iwai <tiwai@suse.de>
   5 */
   6
   7#include <linux/init.h>
   8#include <linux/slab.h>
   9#include <linux/mutex.h>
  10#include <linux/module.h>
  11#include <linux/export.h>
  12#include <linux/pm.h>
  13#include <linux/pm_runtime.h>
  14#include <sound/core.h>
  15#include <sound/hda_codec.h>
  16#include "hda_local.h"
  17
  18/*
  19 * find a matching codec id
  20 */
  21static int hda_codec_match(struct hdac_device *dev, struct hdac_driver *drv)
  22{
  23        struct hda_codec *codec = container_of(dev, struct hda_codec, core);
  24        struct hda_codec_driver *driver =
  25                container_of(drv, struct hda_codec_driver, core);
  26        const struct hda_device_id *list;
  27        /* check probe_id instead of vendor_id if set */
  28        u32 id = codec->probe_id ? codec->probe_id : codec->core.vendor_id;
  29        u32 rev_id = codec->core.revision_id;
  30
  31        for (list = driver->id; list->vendor_id; list++) {
  32                if (list->vendor_id == id &&
  33                    (!list->rev_id || list->rev_id == rev_id)) {
  34                        codec->preset = list;
  35                        return 1;
  36                }
  37        }
  38        return 0;
  39}
  40
  41/* process an unsolicited event */
  42static void hda_codec_unsol_event(struct hdac_device *dev, unsigned int ev)
  43{
  44        struct hda_codec *codec = container_of(dev, struct hda_codec, core);
  45
  46        /* ignore unsol events during shutdown */
  47        if (codec->bus->shutdown)
  48                return;
  49
  50        /* ignore unsol events during system suspend/resume */
  51        if (codec->core.dev.power.power_state.event != PM_EVENT_ON)
  52                return;
  53
  54        if (codec->patch_ops.unsol_event)
  55                codec->patch_ops.unsol_event(codec, ev);
  56}
  57
  58/**
  59 * snd_hda_codec_set_name - set the codec name
  60 * @codec: the HDA codec
  61 * @name: name string to set
  62 */
  63int snd_hda_codec_set_name(struct hda_codec *codec, const char *name)
  64{
  65        int err;
  66
  67        if (!name)
  68                return 0;
  69        err = snd_hdac_device_set_chip_name(&codec->core, name);
  70        if (err < 0)
  71                return err;
  72
  73        /* update the mixer name */
  74        if (!*codec->card->mixername ||
  75            codec->bus->mixer_assigned >= codec->core.addr) {
  76                snprintf(codec->card->mixername,
  77                         sizeof(codec->card->mixername), "%s %s",
  78                         codec->core.vendor_name, codec->core.chip_name);
  79                codec->bus->mixer_assigned = codec->core.addr;
  80        }
  81
  82        return 0;
  83}
  84EXPORT_SYMBOL_GPL(snd_hda_codec_set_name);
  85
  86static int hda_codec_driver_probe(struct device *dev)
  87{
  88        struct hda_codec *codec = dev_to_hda_codec(dev);
  89        struct module *owner = dev->driver->owner;
  90        hda_codec_patch_t patch;
  91        int err;
  92
  93        if (codec->bus->core.ext_ops) {
  94                if (WARN_ON(!codec->bus->core.ext_ops->hdev_attach))
  95                        return -EINVAL;
  96                return codec->bus->core.ext_ops->hdev_attach(&codec->core);
  97        }
  98
  99        if (WARN_ON(!codec->preset))
 100                return -EINVAL;
 101
 102        err = snd_hda_codec_set_name(codec, codec->preset->name);
 103        if (err < 0)
 104                goto error;
 105        err = snd_hdac_regmap_init(&codec->core);
 106        if (err < 0)
 107                goto error;
 108
 109        if (!try_module_get(owner)) {
 110                err = -EINVAL;
 111                goto error;
 112        }
 113
 114        patch = (hda_codec_patch_t)codec->preset->driver_data;
 115        if (patch) {
 116                err = patch(codec);
 117                if (err < 0)
 118                        goto error_module_put;
 119        }
 120
 121        err = snd_hda_codec_build_pcms(codec);
 122        if (err < 0)
 123                goto error_module;
 124        err = snd_hda_codec_build_controls(codec);
 125        if (err < 0)
 126                goto error_module;
 127        /* only register after the bus probe finished; otherwise it's racy */
 128        if (!codec->bus->bus_probing && codec->card->registered) {
 129                err = snd_card_register(codec->card);
 130                if (err < 0)
 131                        goto error_module;
 132                snd_hda_codec_register(codec);
 133        }
 134
 135        codec->core.lazy_cache = true;
 136        return 0;
 137
 138 error_module:
 139        if (codec->patch_ops.free)
 140                codec->patch_ops.free(codec);
 141 error_module_put:
 142        module_put(owner);
 143
 144 error:
 145        snd_hda_codec_cleanup_for_unbind(codec);
 146        return err;
 147}
 148
 149static int hda_codec_driver_remove(struct device *dev)
 150{
 151        struct hda_codec *codec = dev_to_hda_codec(dev);
 152
 153        if (codec->bus->core.ext_ops) {
 154                if (WARN_ON(!codec->bus->core.ext_ops->hdev_detach))
 155                        return -EINVAL;
 156                return codec->bus->core.ext_ops->hdev_detach(&codec->core);
 157        }
 158
 159        if (codec->patch_ops.free)
 160                codec->patch_ops.free(codec);
 161        snd_hda_codec_cleanup_for_unbind(codec);
 162        module_put(dev->driver->owner);
 163        return 0;
 164}
 165
 166static void hda_codec_driver_shutdown(struct device *dev)
 167{
 168        snd_hda_codec_shutdown(dev_to_hda_codec(dev));
 169}
 170
 171int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
 172                               struct module *owner)
 173{
 174        drv->core.driver.name = name;
 175        drv->core.driver.owner = owner;
 176        drv->core.driver.bus = &snd_hda_bus_type;
 177        drv->core.driver.probe = hda_codec_driver_probe;
 178        drv->core.driver.remove = hda_codec_driver_remove;
 179        drv->core.driver.shutdown = hda_codec_driver_shutdown;
 180        drv->core.driver.pm = &hda_codec_driver_pm;
 181        drv->core.type = HDA_DEV_LEGACY;
 182        drv->core.match = hda_codec_match;
 183        drv->core.unsol_event = hda_codec_unsol_event;
 184        return driver_register(&drv->core.driver);
 185}
 186EXPORT_SYMBOL_GPL(__hda_codec_driver_register);
 187
 188void hda_codec_driver_unregister(struct hda_codec_driver *drv)
 189{
 190        driver_unregister(&drv->core.driver);
 191}
 192EXPORT_SYMBOL_GPL(hda_codec_driver_unregister);
 193
 194static inline bool codec_probed(struct hda_codec *codec)
 195{
 196        return device_attach(hda_codec_dev(codec)) > 0 && codec->preset;
 197}
 198
 199/* try to auto-load codec module */
 200static void request_codec_module(struct hda_codec *codec)
 201{
 202#ifdef MODULE
 203        char modalias[32];
 204        const char *mod = NULL;
 205
 206        switch (codec->probe_id) {
 207        case HDA_CODEC_ID_GENERIC_HDMI:
 208#if IS_MODULE(CONFIG_SND_HDA_CODEC_HDMI)
 209                mod = "snd-hda-codec-hdmi";
 210#endif
 211                break;
 212        case HDA_CODEC_ID_GENERIC:
 213#if IS_MODULE(CONFIG_SND_HDA_GENERIC)
 214                mod = "snd-hda-codec-generic";
 215#endif
 216                break;
 217        default:
 218                snd_hdac_codec_modalias(&codec->core, modalias, sizeof(modalias));
 219                mod = modalias;
 220                break;
 221        }
 222
 223        if (mod)
 224                request_module(mod);
 225#endif /* MODULE */
 226}
 227
 228/* try to auto-load and bind the codec module */
 229static void codec_bind_module(struct hda_codec *codec)
 230{
 231#ifdef MODULE
 232        request_codec_module(codec);
 233        if (codec_probed(codec))
 234                return;
 235#endif
 236}
 237
 238#if IS_ENABLED(CONFIG_SND_HDA_CODEC_HDMI)
 239/* if all audio out widgets are digital, let's assume the codec as a HDMI/DP */
 240static bool is_likely_hdmi_codec(struct hda_codec *codec)
 241{
 242        hda_nid_t nid;
 243
 244        for_each_hda_codec_node(nid, codec) {
 245                unsigned int wcaps = get_wcaps(codec, nid);
 246                switch (get_wcaps_type(wcaps)) {
 247                case AC_WID_AUD_IN:
 248                        return false; /* HDMI parser supports only HDMI out */
 249                case AC_WID_AUD_OUT:
 250                        if (!(wcaps & AC_WCAP_DIGITAL))
 251                                return false;
 252                        break;
 253                }
 254        }
 255        return true;
 256}
 257#else
 258/* no HDMI codec parser support */
 259#define is_likely_hdmi_codec(codec)     false
 260#endif /* CONFIG_SND_HDA_CODEC_HDMI */
 261
 262static int codec_bind_generic(struct hda_codec *codec)
 263{
 264        if (codec->probe_id)
 265                return -ENODEV;
 266
 267        if (is_likely_hdmi_codec(codec)) {
 268                codec->probe_id = HDA_CODEC_ID_GENERIC_HDMI;
 269                request_codec_module(codec);
 270                if (codec_probed(codec))
 271                        return 0;
 272        }
 273
 274        codec->probe_id = HDA_CODEC_ID_GENERIC;
 275        request_codec_module(codec);
 276        if (codec_probed(codec))
 277                return 0;
 278        return -ENODEV;
 279}
 280
 281#if IS_ENABLED(CONFIG_SND_HDA_GENERIC)
 282#define is_generic_config(codec) \
 283        (codec->modelname && !strcmp(codec->modelname, "generic"))
 284#else
 285#define is_generic_config(codec)        0
 286#endif
 287
 288/**
 289 * snd_hda_codec_configure - (Re-)configure the HD-audio codec
 290 * @codec: the HDA codec
 291 *
 292 * Start parsing of the given codec tree and (re-)initialize the whole
 293 * patch instance.
 294 *
 295 * Returns 0 if successful or a negative error code.
 296 */
 297int snd_hda_codec_configure(struct hda_codec *codec)
 298{
 299        int err;
 300
 301        if (codec->configured)
 302                return 0;
 303
 304        if (is_generic_config(codec))
 305                codec->probe_id = HDA_CODEC_ID_GENERIC;
 306        else
 307                codec->probe_id = 0;
 308
 309        if (!device_is_registered(&codec->core.dev)) {
 310                err = snd_hdac_device_register(&codec->core);
 311                if (err < 0)
 312                        return err;
 313        }
 314
 315        if (!codec->preset)
 316                codec_bind_module(codec);
 317        if (!codec->preset) {
 318                err = codec_bind_generic(codec);
 319                if (err < 0) {
 320                        codec_dbg(codec, "Unable to bind the codec\n");
 321                        return err;
 322                }
 323        }
 324
 325        codec->configured = 1;
 326        return 0;
 327}
 328EXPORT_SYMBOL_GPL(snd_hda_codec_configure);
 329