Quelle  rt715-sdw.c

// SPDX-License-Identifier: GPL-2.0
/*
 * rt715-sdw.c -- rt715 ALSA SoC audio driver
 *
 * Copyright(c) 2019 Realtek Semiconductor Corp.
 *
 * ALC715 ASoC Codec Driver based Intel Dummy SdW codec driver
 *
 */
#include <linux/delay.h>
#include <linux/device.h>
#include <linux/mod_devicetable.h>
#include <linux/soundwire/sdw.h>
#include <linux/soundwire/sdw_type.h>
#include <linux/soundwire/sdw_registers.h>
#include <linux/module.h>
#include <linux/pm_runtime.h>
#include <linux/of.h>
#include <linux/regmap.h>
#include <sound/soc.h>
#include "rt715.h"
#include "rt715-sdw.h"

static bool rt715_readable_register(struct device *dev, unsigned int reg)
{
 switch (reg) {
 case 0x00e0 ... 0x00e5:
 case 0x00ee ... 0x00ef:
 case 0x00f0 ... 0x00f5:
 case 0x00fe ... 0x00ff:
 case 0x02e0:
 case 0x02f0:
 case 0x04e0:
 case 0x04f0:
 case 0x06e0:
 case 0x06f0:
 case 0x2000 ... 0x2016:
 case 0x201a ... 0x2027:
 case 0x2029 ... 0x202a:
 case 0x202d ... 0x2034:
 case 0x2200 ... 0x2204:
 case 0x2206 ... 0x2212:
 case 0x2220 ... 0x2223:
 case 0x2230 ... 0x2239:
 case 0x22f0 ... 0x22f3:
 case 0x3122:
 case 0x3123:
 case 0x3124:
 case 0x3125:
 case 0x3607:
 case 0x3608:
 case 0x3609:
 case 0x3610:
 case 0x3611:
 case 0x3627:
 case 0x3712:
 case 0x3713:
 case 0x3718:
 case 0x3719:
 case 0x371a:
 case 0x371b:
 case 0x371d:
 case 0x3729:
 case 0x385e:
 case 0x3859:
 case 0x4c12:
 case 0x4c13:
 case 0x4c1d:
 case 0x4c29:
 case 0x4d12:
 case 0x4d13:
 case 0x4d1d:
 case 0x4d29:
 case 0x4e12:
 case 0x4e13:
 case 0x4e1d:
 case 0x4e29:
 case 0x4f12:
 case 0x4f13:
 case 0x4f1d:
 case 0x4f29:
 case 0x7207:
 case 0x7208:
 case 0x7209:
 case 0x7227:
 case 0x7307:
 case 0x7308:
 case 0x7309:
 case 0x7312:
 case 0x7313:
 case 0x7318:
 case 0x7319:
 case 0x731a:
 case 0x731b:
 case 0x731d:
 case 0x7327:
 case 0x7329:
 case 0x8287:
 case 0x8288:
 case 0x8289:
 case 0x82a7:
 case 0x8387:
 case 0x8388:
 case 0x8389:
 case 0x8392:
 case 0x8393:
 case 0x8398:
 case 0x8399:
 case 0x839a:
 case 0x839b:
 case 0x839d:
 case 0x83a7:
 case 0x83a9:
 case 0x752001:
 case 0x752039:
  return true;
 default:
  return false;
 }
}

static bool rt715_volatile_register(struct device *dev, unsigned int reg)
{
 switch (reg) {
 case 0x00e5:
 case 0x00f0:
 case 0x00f3:
 case 0x00f5:
 case 0x2009:
 case 0x2016:
 case 0x201b:
 case 0x201c:
 case 0x201d:
 case 0x201f:
 case 0x2023:
 case 0x2230:
 case 0x200b ... 0x200e: /* i2c read */
 case 0x2012 ... 0x2015: /* HD-A read */
 case 0x202d ... 0x202f: /* BRA */
 case 0x2201 ... 0x2212: /* i2c debug */
 case 0x2220 ... 0x2223: /* decoded HD-A */
  return true;
 default:
  return false;
 }
}

static int rt715_sdw_read(void *context, unsigned int reg, unsigned int *val)
{
 struct device *dev = context;
 struct rt715_priv *rt715 = dev_get_drvdata(dev);
 unsigned int sdw_data_3, sdw_data_2, sdw_data_1, sdw_data_0;
 unsigned int reg2 = 0, reg3 = 0, reg4 = 0, mask, nid, val2;
 unsigned int is_hda_reg = 1, is_index_reg = 0;
 int ret;

 if (reg > 0xffff)
  is_index_reg = 1;

 mask = reg & 0xf000;

 if (is_index_reg) { /* index registers */
  val2 = reg & 0xff;
  reg = reg >> 8;
  nid = reg & 0xff;
  ret = regmap_write(rt715->sdw_regmap, reg, 0);
  if (ret < 0)
   return ret;
  reg2 = reg + 0x1000;
  reg2 |= 0x80;
  ret = regmap_write(rt715->sdw_regmap, reg2, val2);
  if (ret < 0)
   return ret;

  reg3 = RT715_PRIV_DATA_R_H | nid;
  ret = regmap_write(rt715->sdw_regmap, reg3,
   ((*val >> 8) & 0xff));
  if (ret < 0)
   return ret;
  reg4 = reg3 + 0x1000;
  reg4 |= 0x80;
  ret = regmap_write(rt715->sdw_regmap, reg4, (*val & 0xff));
  if (ret < 0)
   return ret;
 } else if (mask   == 0x3000) {
  reg += 0x8000;
  ret = regmap_write(rt715->sdw_regmap, reg, *val);
  if (ret < 0)
   return ret;
 } else if (mask == 0x7000) {
  reg += 0x2000;
  reg |= 0x800;
  ret = regmap_write(rt715->sdw_regmap, reg,
   ((*val >> 8) & 0xff));
  if (ret < 0)
   return ret;
  reg2 = reg + 0x1000;
  reg2 |= 0x80;
  ret = regmap_write(rt715->sdw_regmap, reg2, (*val & 0xff));
  if (ret < 0)
   return ret;
 } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
  reg2 = reg - 0x1000;
  reg2 &= ~0x80;
  ret = regmap_write(rt715->sdw_regmap, reg2,
   ((*val >> 8) & 0xff));
  if (ret < 0)
   return ret;
  ret = regmap_write(rt715->sdw_regmap, reg, (*val & 0xff));
  if (ret < 0)
   return ret;
 } else if (mask == 0x9000) {
  ret = regmap_write(rt715->sdw_regmap, reg,
   ((*val >> 8) & 0xff));
  if (ret < 0)
   return ret;
  reg2 = reg + 0x1000;
  reg2 |= 0x80;
  ret = regmap_write(rt715->sdw_regmap, reg2, (*val & 0xff));
  if (ret < 0)
   return ret;
 } else if (mask == 0xb000) {
  ret = regmap_write(rt715->sdw_regmap, reg, *val);
  if (ret < 0)
   return ret;
 } else {
  ret = regmap_read(rt715->sdw_regmap, reg, val);
  if (ret < 0)
   return ret;
  is_hda_reg = 0;
 }

 if (is_hda_reg || is_index_reg) {
  sdw_data_3 = 0;
  sdw_data_2 = 0;
  sdw_data_1 = 0;
  sdw_data_0 = 0;
  ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_3,
   &sdw_data_3);
  if (ret < 0)
   return ret;
  ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_2,
   &sdw_data_2);
  if (ret < 0)
   return ret;
  ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_1,
   &sdw_data_1);
  if (ret < 0)
   return ret;
  ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_0,
   &sdw_data_0);
  if (ret < 0)
   return ret;
  *val = ((sdw_data_3 & 0xff) << 24) |
   ((sdw_data_2 & 0xff) << 16) |
   ((sdw_data_1 & 0xff) << 8) | (sdw_data_0 & 0xff);
 }

 if (is_hda_reg == 0)
  dev_dbg(dev, "[%s] %04x => %08x\n", __func__, reg, *val);
 else if (is_index_reg)
  dev_dbg(dev, "[%s] %04x %04x %04x %04x => %08x\n", __func__,
   reg, reg2, reg3, reg4, *val);
 else
  dev_dbg(dev, "[%s] %04x %04x => %08x\n",
  __func__, reg, reg2, *val);

 return 0;
}

static int rt715_sdw_write(void *context, unsigned int reg, unsigned int val)
{
 struct device *dev = context;
 struct rt715_priv *rt715 = dev_get_drvdata(dev);
 unsigned int reg2 = 0, reg3, reg4, nid, mask, val2;
 unsigned int is_index_reg = 0;
 int ret;

 if (reg > 0xffff)
  is_index_reg = 1;

 mask = reg & 0xf000;

 if (is_index_reg) { /* index registers */
  val2 = reg & 0xff;
  reg = reg >> 8;
  nid = reg & 0xff;
  ret = regmap_write(rt715->sdw_regmap, reg, 0);
  if (ret < 0)
   return ret;
  reg2 = reg + 0x1000;
  reg2 |= 0x80;
  ret = regmap_write(rt715->sdw_regmap, reg2, val2);
  if (ret < 0)
   return ret;

  reg3 = RT715_PRIV_DATA_W_H | nid;
  ret = regmap_write(rt715->sdw_regmap, reg3,
   ((val >> 8) & 0xff));
  if (ret < 0)
   return ret;
  reg4 = reg3 + 0x1000;
  reg4 |= 0x80;
  ret = regmap_write(rt715->sdw_regmap, reg4, (val & 0xff));
  if (ret < 0)
   return ret;
  is_index_reg = 1;
 } else if (reg < 0x4fff) {
  ret = regmap_write(rt715->sdw_regmap, reg, val);
  if (ret < 0)
   return ret;
 } else if (reg == RT715_FUNC_RESET) {
  ret = regmap_write(rt715->sdw_regmap, reg, val);
  if (ret < 0)
   return ret;
 } else if (mask == 0x7000) {
  ret = regmap_write(rt715->sdw_regmap, reg,
   ((val >> 8) & 0xff));
  if (ret < 0)
   return ret;
  reg2 = reg + 0x1000;
  reg2 |= 0x80;
  ret = regmap_write(rt715->sdw_regmap, reg2, (val & 0xff));
  if (ret < 0)
   return ret;
 } else if ((reg & 0xff00) == 0x8300) {  /* for R channel */
  reg2 = reg - 0x1000;
  reg2 &= ~0x80;
  ret = regmap_write(rt715->sdw_regmap, reg2,
   ((val >> 8) & 0xff));
  if (ret < 0)
   return ret;
  ret = regmap_write(rt715->sdw_regmap, reg, (val & 0xff));
  if (ret < 0)
   return ret;
 }

 if (reg2 == 0)
  dev_dbg(dev, "[%s] %04x <= %04x\n", __func__, reg, val);
 else if (is_index_reg)
  dev_dbg(dev, "[%s] %04x %04x %04x %04x <= %04x %04x\n",
   __func__, reg, reg2, reg3, reg4, val2, val);
 else
  dev_dbg(dev, "[%s] %04x %04x <= %04x\n",
  __func__, reg, reg2, val);

 return 0;
}

static const struct regmap_config rt715_regmap = {
 .reg_bits = 24,
 .val_bits = 32,
 .readable_reg = rt715_readable_register, /* Readable registers */
 .volatile_reg = rt715_volatile_register, /* volatile register */
 .max_register = 0x752039, /* Maximum number of register */
 .reg_defaults = rt715_reg_defaults, /* Defaults */
 .num_reg_defaults = ARRAY_SIZE(rt715_reg_defaults),
 .cache_type = REGCACHE_MAPLE,
 .use_single_read = true,
 .use_single_write = true,
 .reg_read = rt715_sdw_read,
 .reg_write = rt715_sdw_write,
};

static const struct regmap_config rt715_sdw_regmap = {
 .name = "sdw",
 .reg_bits = 32, /* Total register space for SDW */
 .val_bits = 8, /* Total number of bits in register */
 .max_register = 0xff01, /* Maximum number of register */
 .cache_type = REGCACHE_NONE,
 .use_single_read = true,
 .use_single_write = true,
};

static int rt715_update_status(struct sdw_slave *slave,
    enum sdw_slave_status status)
{
 struct rt715_priv *rt715 = dev_get_drvdata(&slave->dev);

 /*
 * Perform initialization only if slave status is present and
 * hw_init flag is false
 */
 if (rt715->hw_init || status != SDW_SLAVE_ATTACHED)
  return 0;

 /* perform I/O transfers required for Slave initialization */
 return rt715_io_init(&slave->dev, slave);
}

static int rt715_read_prop(struct sdw_slave *slave)
{
 struct sdw_slave_prop *prop = &slave->prop;
 int nval, i;
 u32 bit;
 unsigned long addr;
 struct sdw_dpn_prop *dpn;

 prop->scp_int1_mask = SDW_SCP_INT1_IMPL_DEF | SDW_SCP_INT1_BUS_CLASH |
  SDW_SCP_INT1_PARITY;
 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;

 prop->paging_support = false;

 /* first we need to allocate memory for set bits in port lists */
 prop->source_ports = 0x50;/* BITMAP: 01010000 */
 prop->sink_ports = 0x0; /* BITMAP:  00000000 */

 nval = hweight32(prop->source_ports);
 prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
     sizeof(*prop->src_dpn_prop),
     GFP_KERNEL);
 if (!prop->src_dpn_prop)
  return -ENOMEM;

 dpn = prop->src_dpn_prop;
 i = 0;
 addr = prop->source_ports;
 for_each_set_bit(bit, &addr, 32) {
  dpn[i].num = bit;
  dpn[i].simple_ch_prep_sm = true;
  dpn[i].ch_prep_timeout = 10;
  i++;
 }

 /* set the timeout values */
 prop->clk_stop_timeout = 20;

 /* wake-up event */
 prop->wake_capable = 1;

 return 0;
}

static int rt715_bus_config(struct sdw_slave *slave,
    struct sdw_bus_params *params)
{
 struct rt715_priv *rt715 = dev_get_drvdata(&slave->dev);
 int ret;

 memcpy(&rt715->params, params, sizeof(*params));

 ret = rt715_clock_config(&slave->dev);
 if (ret < 0)
  dev_err(&slave->dev, "%s: Invalid clk config", __func__);

 return 0;
}

static const struct sdw_slave_ops rt715_slave_ops = {
 .read_prop = rt715_read_prop,
 .update_status = rt715_update_status,
 .bus_config = rt715_bus_config,
};

static int rt715_sdw_probe(struct sdw_slave *slave,
      const struct sdw_device_id *id)
{
 struct regmap *sdw_regmap, *regmap;

 /* Regmap Initialization */
 sdw_regmap = devm_regmap_init_sdw(slave, &rt715_sdw_regmap);
 if (IS_ERR(sdw_regmap))
  return PTR_ERR(sdw_regmap);

 regmap = devm_regmap_init(&slave->dev, NULL, &slave->dev,
  &rt715_regmap);
 if (IS_ERR(regmap))
  return PTR_ERR(regmap);

 return rt715_init(&slave->dev, sdw_regmap, regmap, slave);
}

static int rt715_sdw_remove(struct sdw_slave *slave)
{
 pm_runtime_disable(&slave->dev);

 return 0;
}

static const struct sdw_device_id rt715_id[] = {
 SDW_SLAVE_ENTRY_EXT(0x025d, 0x714, 0x2, 0, 0),
 SDW_SLAVE_ENTRY_EXT(0x025d, 0x715, 0x2, 0, 0),
 {},
};
MODULE_DEVICE_TABLE(sdw, rt715_id);

static int rt715_dev_suspend(struct device *dev)
{
 struct rt715_priv *rt715 = dev_get_drvdata(dev);

 if (!rt715->hw_init)
  return 0;

 regcache_cache_only(rt715->regmap, true);

 return 0;
}

#define RT715_PROBE_TIMEOUT 5000

static int rt715_dev_resume(struct device *dev)
{
 struct sdw_slave *slave = dev_to_sdw_dev(dev);
 struct rt715_priv *rt715 = dev_get_drvdata(dev);
 unsigned long time;

 if (!rt715->first_hw_init)
  return 0;

 if (!slave->unattach_request)
  goto regmap_sync;

 time = wait_for_completion_timeout(&slave->initialization_complete,
        msecs_to_jiffies(RT715_PROBE_TIMEOUT));
 if (!time) {
  dev_err(&slave->dev, "%s: Initialization not complete, timed out\n", __func__);
  sdw_show_ping_status(slave->bus, true);

  return -ETIMEDOUT;
 }

regmap_sync:
 slave->unattach_request = 0;
 regcache_cache_only(rt715->regmap, false);
 regcache_sync_region(rt715->regmap, 0x3000, 0x8fff);
 regcache_sync_region(rt715->regmap, 0x752039, 0x752039);

 return 0;
}

static const struct dev_pm_ops rt715_pm = {
 SYSTEM_SLEEP_PM_OPS(rt715_dev_suspend, rt715_dev_resume)
 RUNTIME_PM_OPS(rt715_dev_suspend, rt715_dev_resume, NULL)
};

static struct sdw_driver rt715_sdw_driver = {
 .driver = {
     .name = "rt715",
     .pm = pm_ptr(&rt715_pm),
     },
 .probe = rt715_sdw_probe,
 .remove = rt715_sdw_remove,
 .ops = &rt715_slave_ops,
 .id_table = rt715_id,
};
module_sdw_driver(rt715_sdw_driver);

MODULE_DESCRIPTION("ASoC RT715 driver SDW");
MODULE_AUTHOR("Jack Yu <jack.yu@realtek.com>");
MODULE_LICENSE("GPL v2");