Quelle  wm8994-core.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * wm8994-core.c  --  Device access for Wolfson WM8994
 *
 * Copyright 2009 Wolfson Microelectronics PLC.
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/err.h>
#include <linux/delay.h>
#include <linux/mfd/core.h>
#include <linux/of.h>
#include <linux/pm_runtime.h>
#include <linux/regmap.h>
#include <linux/regulator/consumer.h>
#include <linux/regulator/machine.h>

#include <linux/mfd/wm8994/core.h>
#include <linux/mfd/wm8994/pdata.h>
#include <linux/mfd/wm8994/registers.h>

#include "wm8994.h"

static const struct mfd_cell wm8994_regulator_devs[] = {
 {
  .name = "wm8994-ldo",
  .id = 0,
  .pm_runtime_no_callbacks = true,
 },
 {
  .name = "wm8994-ldo",
  .id = 1,
  .pm_runtime_no_callbacks = true,
 },
};

static const struct resource wm8994_codec_resources[] = {
 {
  .start = WM8994_IRQ_TEMP_SHUT,
  .end   = WM8994_IRQ_TEMP_WARN,
  .flags = IORESOURCE_IRQ,
 },
};

static const struct resource wm8994_gpio_resources[] = {
 {
  .start = WM8994_IRQ_GPIO(1),
  .end   = WM8994_IRQ_GPIO(11),
  .flags = IORESOURCE_IRQ,
 },
};

static const struct mfd_cell wm8994_devs[] = {
 {
  .name = "wm8994-codec",
  .num_resources = ARRAY_SIZE(wm8994_codec_resources),
  .resources = wm8994_codec_resources,
 },

 {
  .name = "wm8994-gpio",
  .num_resources = ARRAY_SIZE(wm8994_gpio_resources),
  .resources = wm8994_gpio_resources,
  .pm_runtime_no_callbacks = true,
 },
};

/*
 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
 * and should be handled via the standard regulator API supply
 * management.
 */
static const char *wm1811_main_supplies[] = {
 "DBVDD1",
 "DBVDD2",
 "DBVDD3",
 "DCVDD",
 "AVDD1",
 "AVDD2",
 "CPVDD",
 "SPKVDD1",
 "SPKVDD2",
};

static const char *wm8994_main_supplies[] = {
 "DBVDD",
 "DCVDD",
 "AVDD1",
 "AVDD2",
 "CPVDD",
 "SPKVDD1",
 "SPKVDD2",
};

static const char *wm8958_main_supplies[] = {
 "DBVDD1",
 "DBVDD2",
 "DBVDD3",
 "DCVDD",
 "AVDD1",
 "AVDD2",
 "CPVDD",
 "SPKVDD1",
 "SPKVDD2",
};

static int wm8994_suspend(struct device *dev)
{
 struct wm8994 *wm8994 = dev_get_drvdata(dev);
 int ret;

 /* Don't actually go through with the suspend if the CODEC is
 * still active for accessory detect. */
 switch (wm8994->type) {
 case WM8958:
 case WM1811:
  ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
  if (ret < 0) {
   dev_err(dev, "Failed to read power status: %d\n", ret);
  } else if (ret & WM8958_MICD_ENA) {
   dev_dbg(dev, "CODEC still active, ignoring suspend\n");
   return 0;
  }
  break;
 default:
  break;
 }

 /* Disable LDO pulldowns while the device is suspended if we
 * don't know that something will be driving them. */
 if (!wm8994->ldo_ena_always_driven)
  wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
    WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
    WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);

 /* Explicitly put the device into reset in case regulators
 * don't get disabled in order to ensure consistent restart.
 */
 wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
    wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));

 regcache_mark_dirty(wm8994->regmap);

 /* Restore GPIO registers to prevent problems with mismatched
 * pin configurations.
 */
 ret = regcache_sync_region(wm8994->regmap, WM8994_GPIO_1,
       WM8994_GPIO_11);
 if (ret != 0)
  dev_err(dev, "Failed to restore GPIO registers: %d\n", ret);

 /* In case one of the GPIOs is used as a wake input. */
 ret = regcache_sync_region(wm8994->regmap,
       WM8994_INTERRUPT_STATUS_1_MASK,
       WM8994_INTERRUPT_STATUS_1_MASK);
 if (ret != 0)
  dev_err(dev, "Failed to restore interrupt mask: %d\n", ret);

 regcache_cache_only(wm8994->regmap, true);
 wm8994->suspended = true;

 ret = regulator_bulk_disable(wm8994->num_supplies,
         wm8994->supplies);
 if (ret != 0) {
  dev_err(dev, "Failed to disable supplies: %d\n", ret);
  return ret;
 }

 return 0;
}

static int wm8994_resume(struct device *dev)
{
 struct wm8994 *wm8994 = dev_get_drvdata(dev);
 int ret;

 /* We may have lied to the PM core about suspending */
 if (!wm8994->suspended)
  return 0;

 ret = regulator_bulk_enable(wm8994->num_supplies,
        wm8994->supplies);
 if (ret != 0) {
  dev_err(dev, "Failed to enable supplies: %d\n", ret);
  return ret;
 }

 regcache_cache_only(wm8994->regmap, false);
 ret = regcache_sync(wm8994->regmap);
 if (ret != 0) {
  dev_err(dev, "Failed to restore register map: %d\n", ret);
  goto err_enable;
 }

 /* Disable LDO pulldowns while the device is active */
 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
   WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
   0);

 wm8994->suspended = false;

 return 0;

err_enable:
 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);

 return ret;
}

#ifdef CONFIG_REGULATOR
static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
{
 struct wm8994_ldo_pdata *ldo_pdata;

 if (!pdata)
  return 0;

 ldo_pdata = &pdata->ldo[ldo];

 if (!ldo_pdata->init_data)
  return 0;

 return ldo_pdata->init_data->num_consumer_supplies != 0;
}
#else
static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
{
 return 0;
}
#endif

static const struct reg_sequence wm8994_revc_patch[] = {
 { 0x102, 0x3 },
 { 0x56, 0x3 },
 { 0x817, 0x0 },
 { 0x102, 0x0 },
};

static const struct reg_sequence wm8958_reva_patch[] = {
 { 0x102, 0x3 },
 { 0xcb, 0x81 },
 { 0x817, 0x0 },
 { 0x102, 0x0 },
};

static const struct reg_sequence wm1811_reva_patch[] = {
 { 0x102, 0x3 },
 { 0x56, 0xc07 },
 { 0x5d, 0x7e },
 { 0x5e, 0x0 },
 { 0x102, 0x0 },
};

#ifdef CONFIG_OF
static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
{
 struct device_node *np = wm8994->dev->of_node;
 struct wm8994_pdata *pdata = &wm8994->pdata;
 int i;

 if (!np)
  return 0;

 if (of_property_read_u32_array(np, "wlf,gpio-cfg", pdata->gpio_defaults,
           ARRAY_SIZE(pdata->gpio_defaults)) >= 0) {
  for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
   if (wm8994->pdata.gpio_defaults[i] == 0)
    pdata->gpio_defaults[i]
     = WM8994_CONFIGURE_GPIO;
  }
 }

 of_property_read_u32_array(np, "wlf,micbias-cfg", pdata->micbias,
       ARRAY_SIZE(pdata->micbias));

 pdata->lineout1_diff = !of_property_read_bool(np, "wlf,lineout1-se");
 pdata->lineout2_diff = !of_property_read_bool(np, "wlf,lineout2-se");
 pdata->lineout1fb = of_property_read_bool(np, "wlf,lineout1-feedback");
 pdata->lineout2fb = of_property_read_bool(np, "wlf,lineout2-feedback") ||
  of_property_read_bool(np, "wlf,ldoena-always-driven");

 pdata->spkmode_pu = of_property_read_bool(np, "wlf,spkmode-pu");

 pdata->csnaddr_pd = of_property_read_bool(np, "wlf,csnaddr-pd");

 return 0;
}
#else
static int wm8994_set_pdata_from_of(struct wm8994 *wm8994)
{
 return 0;
}
#endif

/*
 * Instantiate the generic non-control parts of the device.
 */
static int wm8994_device_init(struct wm8994 *wm8994, int irq)
{
 struct wm8994_pdata *pdata;
 struct regmap_config *regmap_config;
 const struct reg_sequence *regmap_patch = NULL;
 const char *devname;
 int ret, i, patch_regs = 0;
 int pulls = 0;

 if (dev_get_platdata(wm8994->dev)) {
  pdata = dev_get_platdata(wm8994->dev);
  wm8994->pdata = *pdata;
 }
 pdata = &wm8994->pdata;

 ret = wm8994_set_pdata_from_of(wm8994);
 if (ret != 0)
  return ret;

 /* Add the on-chip regulators first for bootstrapping */
 ret = mfd_add_devices(wm8994->dev, 0,
         wm8994_regulator_devs,
         ARRAY_SIZE(wm8994_regulator_devs),
         NULL, 0, NULL);
 if (ret != 0) {
  dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
  goto err;
 }

 switch (wm8994->type) {
 case WM1811:
  wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
  break;
 case WM8994:
  wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
  break;
 case WM8958:
  wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
  break;
 default:
  BUG();
  goto err;
 }

 wm8994->supplies = devm_kcalloc(wm8994->dev,
     wm8994->num_supplies,
     sizeof(struct regulator_bulk_data),
     GFP_KERNEL);
 if (!wm8994->supplies) {
  ret = -ENOMEM;
  goto err;
 }

 switch (wm8994->type) {
 case WM1811:
  for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
   wm8994->supplies[i].supply = wm1811_main_supplies[i];
  break;
 case WM8994:
  for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
   wm8994->supplies[i].supply = wm8994_main_supplies[i];
  break;
 case WM8958:
  for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
   wm8994->supplies[i].supply = wm8958_main_supplies[i];
  break;
 default:
  BUG();
  goto err;
 }

 /*
 * Can't use devres helper here as some of the supplies are provided by
 * wm8994->dev's children (regulators) and those regulators are
 * unregistered by the devres core before the supplies are freed.
 */
 ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
     wm8994->supplies);
 if (ret != 0) {
  if (ret != -EPROBE_DEFER)
   dev_err(wm8994->dev, "Failed to get supplies: %d\n",
    ret);
  goto err;
 }

 ret = regulator_bulk_enable(wm8994->num_supplies, wm8994->supplies);
 if (ret != 0) {
  dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
  goto err_regulator_free;
 }

 ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
 if (ret < 0) {
  dev_err(wm8994->dev, "Failed to read ID register\n");
  goto err_enable;
 }
 switch (ret) {
 case 0x1811:
  devname = "WM1811";
  if (wm8994->type != WM1811)
   dev_warn(wm8994->dev, "Device registered as type %d\n",
     wm8994->type);
  wm8994->type = WM1811;
  break;
 case 0x8994:
  devname = "WM8994";
  if (wm8994->type != WM8994)
   dev_warn(wm8994->dev, "Device registered as type %d\n",
     wm8994->type);
  wm8994->type = WM8994;
  break;
 case 0x8958:
  devname = "WM8958";
  if (wm8994->type != WM8958)
   dev_warn(wm8994->dev, "Device registered as type %d\n",
     wm8994->type);
  wm8994->type = WM8958;
  break;
 default:
  dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
   ret);
  ret = -EINVAL;
  goto err_enable;
 }

 ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
 if (ret < 0) {
  dev_err(wm8994->dev, "Failed to read revision register: %d\n",
   ret);
  goto err_enable;
 }
 wm8994->revision = ret & WM8994_CHIP_REV_MASK;
 wm8994->cust_id = (ret & WM8994_CUST_ID_MASK) >> WM8994_CUST_ID_SHIFT;

 switch (wm8994->type) {
 case WM8994:
  switch (wm8994->revision) {
  case 0:
  case 1:
   dev_warn(wm8994->dev,
     "revision %c not fully supported\n",
     'A' + wm8994->revision);
   break;
  case 2:
  case 3:
  default:
   regmap_patch = wm8994_revc_patch;
   patch_regs = ARRAY_SIZE(wm8994_revc_patch);
   break;
  }
  break;

 case WM8958:
  switch (wm8994->revision) {
  case 0:
   regmap_patch = wm8958_reva_patch;
   patch_regs = ARRAY_SIZE(wm8958_reva_patch);
   break;
  default:
   break;
  }
  break;

 case WM1811:
  /* Revision C did not change the relevant layer */
  if (wm8994->revision > 1)
   wm8994->revision++;

  regmap_patch = wm1811_reva_patch;
  patch_regs = ARRAY_SIZE(wm1811_reva_patch);
  break;

 default:
  break;
 }

 dev_info(wm8994->dev, "%s revision %c CUST_ID %02x\n", devname,
   'A' + wm8994->revision, wm8994->cust_id);

 switch (wm8994->type) {
 case WM1811:
  regmap_config = &wm1811_regmap_config;
  break;
 case WM8994:
  regmap_config = &wm8994_regmap_config;
  break;
 case WM8958:
  regmap_config = &wm8958_regmap_config;
  break;
 default:
  dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
  ret = -EINVAL;
  goto err_enable;
 }

 ret = regmap_reinit_cache(wm8994->regmap, regmap_config);
 if (ret != 0) {
  dev_err(wm8994->dev, "Failed to reinit register cache: %d\n",
   ret);
  goto err_enable;
 }

 /* Explicitly put the device into reset in case regulators
 * don't get disabled in order to ensure we know the device
 * state.
 */
 ret = wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
          wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
 if (ret != 0) {
  dev_err(wm8994->dev, "Failed to reset device: %d\n", ret);
  goto err_enable;
 }

 if (regmap_patch) {
  ret = regmap_register_patch(wm8994->regmap, regmap_patch,
         patch_regs);
  if (ret != 0) {
   dev_err(wm8994->dev, "Failed to register patch: %d\n",
    ret);
   goto err_enable;
  }
 }

 wm8994->irq_base = pdata->irq_base;
 wm8994->gpio_base = pdata->gpio_base;

 /* GPIO configuration is only applied if it's non-zero */
 for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
  if (pdata->gpio_defaults[i]) {
   wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
     0xffff, pdata->gpio_defaults[i]);
  }
 }

 wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;

 if (pdata->spkmode_pu)
  pulls |= WM8994_SPKMODE_PU;
 if (pdata->csnaddr_pd)
  pulls |= WM8994_CSNADDR_PD;

 /* Disable unneeded pulls */
 wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
   WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
   WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
   pulls);

 /* In some system designs where the regulators are not in use,
 * we can achieve a small reduction in leakage currents by
 * floating LDO outputs.  This bit makes no difference if the
 * LDOs are enabled, it only affects cases where the LDOs were
 * in operation and are then disabled.
 */
 for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
  if (wm8994_ldo_in_use(pdata, i))
   wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
     WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
  else
   wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
     WM8994_LDO1_DISCH, 0);
 }

 wm8994_irq_init(wm8994);

 ret = mfd_add_devices(wm8994->dev, -1,
         wm8994_devs, ARRAY_SIZE(wm8994_devs),
         NULL, 0, NULL);
 if (ret != 0) {
  dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
  goto err_irq;
 }

 pm_runtime_set_active(wm8994->dev);
 pm_runtime_enable(wm8994->dev);
 pm_runtime_idle(wm8994->dev);

 return 0;

err_irq:
 wm8994_irq_exit(wm8994);
err_enable:
 regulator_bulk_disable(wm8994->num_supplies,
          wm8994->supplies);
err_regulator_free:
 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
err:
 mfd_remove_devices(wm8994->dev);
 return ret;
}

static void wm8994_device_exit(struct wm8994 *wm8994)
{
 pm_runtime_get_sync(wm8994->dev);
 pm_runtime_disable(wm8994->dev);
 pm_runtime_put_noidle(wm8994->dev);
 wm8994_irq_exit(wm8994);
 regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
 regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
 mfd_remove_devices(wm8994->dev);
}

static const struct of_device_id wm8994_of_match[] = {
 { .compatible = "wlf,wm1811", .data = (void *)WM1811 },
 { .compatible = "wlf,wm8994", .data = (void *)WM8994 },
 { .compatible = "wlf,wm8958", .data = (void *)WM8958 },
 { }
};
MODULE_DEVICE_TABLE(of, wm8994_of_match);

static int wm8994_i2c_probe(struct i2c_client *i2c)
{
 struct wm8994 *wm8994;
 int ret;

 wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
 if (wm8994 == NULL)
  return -ENOMEM;

 i2c_set_clientdata(i2c, wm8994);
 wm8994->dev = &i2c->dev;
 wm8994->irq = i2c->irq;

 wm8994->type = (kernel_ulong_t)i2c_get_match_data(i2c);

 wm8994->regmap = devm_regmap_init_i2c(i2c, &wm8994_base_regmap_config);
 if (IS_ERR(wm8994->regmap)) {
  ret = PTR_ERR(wm8994->regmap);
  dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
   ret);
  return ret;
 }

 return wm8994_device_init(wm8994, i2c->irq);
}

static void wm8994_i2c_remove(struct i2c_client *i2c)
{
 struct wm8994 *wm8994 = i2c_get_clientdata(i2c);

 wm8994_device_exit(wm8994);
}

static const struct i2c_device_id wm8994_i2c_id[] = {
 { "wm1811", WM1811 },
 { "wm1811a", WM1811 },
 { "wm8994", WM8994 },
 { "wm8958", WM8958 },
 { }
};
MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);

static const struct dev_pm_ops wm8994_pm_ops = {
 RUNTIME_PM_OPS(wm8994_suspend, wm8994_resume, NULL)
};

static struct i2c_driver wm8994_i2c_driver = {
 .driver = {
  .name = "wm8994",
  .pm = pm_ptr(&wm8994_pm_ops),
  .of_match_table = wm8994_of_match,
 },
 .probe = wm8994_i2c_probe,
 .remove = wm8994_i2c_remove,
 .id_table = wm8994_i2c_id,
};

module_i2c_driver(wm8994_i2c_driver);

MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Mark Brown ");
MODULE_SOFTDEP("pre: wm8994_regulator");