sound/pci/hda/hda_bind.c

   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 <sound/core.h>
  14 #include <sound/hda_codec.h>
  15 #include "hda_local.h"
  16 #include "hda_jack.h"
  17
  18 /*
  19  * find a matching codec id
  20  */
  21 static 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 */
  42 static 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  */
  63 int 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 }
  84 EXPORT_SYMBOL_GPL(snd_hda_codec_set_name);
  85
  86 static 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         codec->preset = NULL;
 147         return err;
 148 }
 149
 150 static int hda_codec_driver_remove(struct device *dev)
 151 {
 152         struct hda_codec *codec = dev_to_hda_codec(dev);
 153
 154         if (codec->bus->core.ext_ops) {
 155                 if (WARN_ON(!codec->bus->core.ext_ops->hdev_detach))
 156                         return -EINVAL;
 157                 return codec->bus->core.ext_ops->hdev_detach(&codec->core);
 158         }
 159
 160         snd_hda_codec_disconnect_pcms(codec);
 161         snd_hda_jack_tbl_disconnect(codec);
 162         if (!refcount_dec_and_test(&codec->pcm_ref))
 163                 wait_event(codec->remove_sleep, !refcount_read(&codec->pcm_ref));
 164         snd_power_sync_ref(codec->bus->card);
 165
 166         if (codec->patch_ops.free)
 167                 codec->patch_ops.free(codec);
 168         snd_hda_codec_cleanup_for_unbind(codec);
 169         codec->preset = NULL;
 170         module_put(dev->driver->owner);
 171         return 0;
 172 }
 173
 174 static void hda_codec_driver_shutdown(struct device *dev)
 175 {
 176         snd_hda_codec_shutdown(dev_to_hda_codec(dev));
 177 }
 178
 179 int __hda_codec_driver_register(struct hda_codec_driver *drv, const char *name,
 180                                struct module *owner)
 181 {
 182         drv->core.driver.name = name;
 183         drv->core.driver.owner = owner;
 184         drv->core.driver.bus = &snd_hda_bus_type;
 185         drv->core.driver.probe = hda_codec_driver_probe;
 186         drv->core.driver.remove = hda_codec_driver_remove;
 187         drv->core.driver.shutdown = hda_codec_driver_shutdown;
 188         drv->core.driver.pm = &hda_codec_driver_pm;
 189         drv->core.type = HDA_DEV_LEGACY;
 190         drv->core.match = hda_codec_match;
 191         drv->core.unsol_event = hda_codec_unsol_event;
 192         return driver_register(&drv->core.driver);
 193 }
 194 EXPORT_SYMBOL_GPL(__hda_codec_driver_register);
 195
 196 void hda_codec_driver_unregister(struct hda_codec_driver *drv)
 197 {
 198         driver_unregister(&drv->core.driver);
 199 }
 200 EXPORT_SYMBOL_GPL(hda_codec_driver_unregister);
 201
 202 static inline bool codec_probed(struct hda_codec *codec)
 203 {
 204         return device_attach(hda_codec_dev(codec)) > 0 && codec->preset;
 205 }
 206
 207 /* try to auto-load codec module */
 208 static void request_codec_module(struct hda_codec *codec)
 209 {
 210 #ifdef MODULE
 211         char modalias[32];
 212         const char *mod = NULL;
 213
 214         switch (codec->probe_id) {
 215         case HDA_CODEC_ID_GENERIC_HDMI:
 216 #if IS_MODULE(CONFIG_SND_HDA_CODEC_HDMI)
 217                 mod = "snd-hda-codec-hdmi";
 218 #endif
 219                 break;
 220         case HDA_CODEC_ID_GENERIC:
 221 #if IS_MODULE(CONFIG_SND_HDA_GENERIC)
 222                 mod = "snd-hda-codec-generic";
 223 #endif
 224                 break;
 225         default:
 226                 snd_hdac_codec_modalias(&codec->core, modalias, sizeof(modalias));
 227                 mod = modalias;
 228                 break;
 229         }
 230
 231         if (mod)
 232                 request_module(mod);
 233 #endif /* MODULE */
 234 }
 235
 236 /* try to auto-load and bind the codec module */
 237 static void codec_bind_module(struct hda_codec *codec)
 238 {
 239 #ifdef MODULE
 240         request_codec_module(codec);
 241         if (codec_probed(codec))
 242                 return;
 243 #endif
 244 }
 245
 246 #if IS_ENABLED(CONFIG_SND_HDA_CODEC_HDMI)
 247 /* if all audio out widgets are digital, let's assume the codec as a HDMI/DP */
 248 static bool is_likely_hdmi_codec(struct hda_codec *codec)
 249 {
 250         hda_nid_t nid;
 251
 252         /*
 253          * For ASoC users, if snd_hda_hdmi_codec module is denylisted and any
 254          * event causes i915 enumeration to fail, ->wcaps remains uninitialized.
 255          */
 256         if (!codec->wcaps)
 257                 return true;
 258
 259         for_each_hda_codec_node(nid, codec) {
 260                 unsigned int wcaps = get_wcaps(codec, nid);
 261                 switch (get_wcaps_type(wcaps)) {
 262                 case AC_WID_AUD_IN:
 263                         return false; /* HDMI parser supports only HDMI out */
 264                 case AC_WID_AUD_OUT:
 265                         if (!(wcaps & AC_WCAP_DIGITAL))
 266                                 return false;
 267                         break;
 268                 }
 269         }
 270         return true;
 271 }
 272 #else
 273 /* no HDMI codec parser support */
 274 #define is_likely_hdmi_codec(codec)     false
 275 #endif /* CONFIG_SND_HDA_CODEC_HDMI */
 276
 277 static int codec_bind_generic(struct hda_codec *codec)
 278 {
 279         if (codec->probe_id)
 280                 return -ENODEV;
 281
 282         if (is_likely_hdmi_codec(codec)) {
 283                 codec->probe_id = HDA_CODEC_ID_GENERIC_HDMI;
 284                 request_codec_module(codec);
 285                 if (codec_probed(codec))
 286                         return 0;
 287         }
 288
 289         codec->probe_id = HDA_CODEC_ID_GENERIC;
 290         request_codec_module(codec);
 291         if (codec_probed(codec))
 292                 return 0;
 293         return -ENODEV;
 294 }
 295
 296 #if IS_ENABLED(CONFIG_SND_HDA_GENERIC)
 297 #define is_generic_config(codec) \
 298         (codec->modelname && !strcmp(codec->modelname, "generic"))
 299 #else
 300 #define is_generic_config(codec)        0
 301 #endif
 302
 303 /**
 304  * snd_hda_codec_configure - (Re-)configure the HD-audio codec
 305  * @codec: the HDA codec
 306  *
 307  * Start parsing of the given codec tree and (re-)initialize the whole
 308  * patch instance.
 309  *
 310  * Returns 0 if successful or a negative error code.
 311  */
 312 int snd_hda_codec_configure(struct hda_codec *codec)
 313 {
 314         int err;
 315
 316         if (codec->configured)
 317                 return 0;
 318
 319         if (is_generic_config(codec))
 320                 codec->probe_id = HDA_CODEC_ID_GENERIC;
 321         else
 322                 codec->probe_id = 0;
 323
 324         if (!device_is_registered(&codec->core.dev)) {
 325                 err = snd_hdac_device_register(&codec->core);
 326                 if (err < 0)
 327                         return err;
 328         }
 329
 330         if (!codec->preset)
 331                 codec_bind_module(codec);
 332         if (!codec->preset) {
 333                 err = codec_bind_generic(codec);
 334                 if (err < 0) {
 335                         codec_dbg(codec, "Unable to bind the codec\n");
 336                         return err;
 337                 }
 338         }
 339
 340         codec->configured = 1;
 341         return 0;
 342 }
 343 EXPORT_SYMBOL_GPL(snd_hda_codec_configure);