Zhi7 Li has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/56929 )
Change subject: src/drivers/i2c: Add rt5682 driver for codec ALC5682I-VD & VS compatibility ......................................................................
src/drivers/i2c: Add rt5682 driver for codec ALC5682I-VD & VS compatibility
For codec ALC5682I-VD & VS compatibility, add a new driver to dynamically report HID instead of using generic i2c driver.
BUG=b:193623380 BRANCH=dedede TEST=Codec ALC5682I-VD & VS can work normally
Signed-off-by: Zhi Li lizhi7@huaqin.corp-partner.google.com Change-Id: I6d0a73d5fdef09df33e8a6feab34bcf14eb46d8a --- A src/drivers/i2c/rt5682/Kconfig A src/drivers/i2c/rt5682/Makefile.inc A src/drivers/i2c/rt5682/chip.h A src/drivers/i2c/rt5682/rt5682.c 4 files changed, 305 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/29/56929/1
diff --git a/src/drivers/i2c/rt5682/Kconfig b/src/drivers/i2c/rt5682/Kconfig new file mode 100644 index 0000000..030cc2e --- /dev/null +++ b/src/drivers/i2c/rt5682/Kconfig @@ -0,0 +1,4 @@ +config DRIVERS_I2C_RT5682 + bool + default n + depends on HAVE_ACPI_TABLES diff --git a/src/drivers/i2c/rt5682/Makefile.inc b/src/drivers/i2c/rt5682/Makefile.inc new file mode 100644 index 0000000..f8b3c12 --- /dev/null +++ b/src/drivers/i2c/rt5682/Makefile.inc @@ -0,0 +1 @@ +ramstage-$(CONFIG_DRIVERS_I2C_RT5682) += rt5682.c diff --git a/src/drivers/i2c/rt5682/chip.h b/src/drivers/i2c/rt5682/chip.h new file mode 100644 index 0000000..8432775 --- /dev/null +++ b/src/drivers/i2c/rt5682/chip.h @@ -0,0 +1,82 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ + +#ifndef __I2C_RT5682_CHIP_H__ +#define __I2C_RT5682_CHIP_H__ + +#include <acpi/acpi_device.h> +#include <device/i2c_simple.h> + +#define MAX_RT5682_PROPERTY_LIST 10 + +struct drivers_i2c_rt5682_config { + const char *hid; /* ACPI _HID (required) */ + const char *cid; /* ACPI _CID */ + const char *name; /* ACPI Device Name */ + const char *desc; /* Device Description */ + unsigned int uid; /* ACPI _UID */ + enum i2c_speed speed; /* Bus speed in Hz, default is I2C_SPEED_FAST */ + const char *compat_string; /* Compatible string for _HID=PRP0001 */ + unsigned int wake; /* Wake GPE */ + struct acpi_irq irq; /* Interrupt */ + + /* Use GPIO based interrupt instead of PIRQ */ + struct acpi_gpio irq_gpio; + + /* + * This flag will add a device property which will indicate + * to the OS that it should probe this device before adding it. + * + * This can be used to declare a device that may not exist on + * the board, for example to support multiple trackpad vendors. + */ + int probed; + + /* GPIO used to indicate if this device is present */ + unsigned int device_present_gpio; + unsigned int device_present_gpio_invert; + + /* Disable reset and enable GPIO export in _CRS */ + bool disable_gpio_export_in_crs; + + /* Does the device have a power resource? */ + bool has_power_resource; + + /* GPIO used to take device out of reset or to put it into reset. */ + struct acpi_gpio reset_gpio; + /* Delay to be inserted after device is taken out of reset. */ + unsigned int reset_delay_ms; + /* Delay to be inserted after device is put into reset. */ + unsigned int reset_off_delay_ms; + /* GPIO used to enable device. */ + struct acpi_gpio enable_gpio; + /* Delay to be inserted after device is enabled. */ + unsigned int enable_delay_ms; + /* Delay to be inserted after device is disabled. */ + unsigned int enable_off_delay_ms; + /* GPIO used to stop operation of device. */ + struct acpi_gpio stop_gpio; + /* Delay to be inserted after disabling stop. */ + unsigned int stop_delay_ms; + /* Delay to be inserted after enabling stop. */ + unsigned int stop_off_delay_ms; + + /* Generic properties for exporting device-specific data to the OS */ + struct acpi_dp property_list[MAX_RT5682_PROPERTY_LIST]; + int property_count; +}; + +/* + * Fills in rt5682 information about i2c device from device-tree + * properties. Callback can be provided to fill in any + * device-specific information in SSDT. + * + * Parameters: + * dev: Device requesting i2c rt5682 information to be filled + * callback: Callback to fill in device-specific information + * config: Pointer to drivers_i2c_rt5682_config structure + */ +void i2c_rt5682_fill_ssdt(const struct device *dev, + void (*callback)(const struct device *dev), + struct drivers_i2c_rt5682_config *config); + +#endif /* __I2C_RT5682_CHIP_H__ */ diff --git a/src/drivers/i2c/rt5682/rt5682.c b/src/drivers/i2c/rt5682/rt5682.c new file mode 100644 index 0000000..0a3c4ce --- /dev/null +++ b/src/drivers/i2c/rt5682/rt5682.c @@ -0,0 +1,218 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ + +#include <acpi/acpi_device.h> +#include <acpi/acpigen.h> +#include <console/console.h> +#include <device/i2c_simple.h> +#include <device/device.h> +#include <device/path.h> +#include <gpio.h> +#include <string.h> +#include "chip.h" +#include <fw_config.h> + +#if CONFIG(HAVE_ACPI_TABLES) + +static bool i2c_rt5682_add_gpios_to_crs(struct drivers_i2c_rt5682_config *cfg) +{ + /* + * Return false if: + * 1. Request to explicitly disable export of GPIOs in CRS, or + * 2. Both reset and enable GPIOs are not provided. + */ + if (cfg->disable_gpio_export_in_crs || + ((cfg->reset_gpio.pin_count == 0) && + (cfg->enable_gpio.pin_count == 0))) + return false; + + return true; +} + +static int i2c_rt5682_write_gpio(struct acpi_gpio *gpio, int *curr_index) +{ + int ret = -1; + + if (gpio->pin_count == 0) + return ret; + + acpi_device_write_gpio(gpio); + ret = *curr_index; + (*curr_index)++; + + return ret; +} + +void i2c_rt5682_fill_ssdt(const struct device *dev, + void (*callback)(const struct device *dev), + struct drivers_i2c_rt5682_config *config) +{ + const char *scope = acpi_device_scope(dev); + struct acpi_i2c i2c = { + .address = dev->path.i2c.device, + .mode_10bit = dev->path.i2c.mode_10bit, + .speed = config->speed ? : I2C_SPEED_FAST, + .resource = scope, + }; + struct acpi_dp *dsd = NULL; + int curr_index = 0; + int reset_gpio_index = -1, enable_gpio_index = -1, irq_gpio_index = -1; + const char *path = acpi_device_path(dev); + if (!scope) + return; + + /* Device */ + acpigen_write_scope(scope); + acpigen_write_device(acpi_device_name(dev)); + if (fw_config_probe(FW_CONFIG(AUDIO_CODEC_SOURCE, AUDIO_CODEC_ALC5682))) + acpigen_write_name_string("_HID", "10EC5682"); + else if (fw_config_probe(FW_CONFIG(AUDIO_CODEC_SOURCE, AUDIO_CODEC_ALC5682I_VS))) + acpigen_write_name_string("_HID", "RTL5682"); + if (config->cid) + acpigen_write_name_string("_CID", config->cid); + acpigen_write_name_integer("_UID", config->uid); + if (config->desc) + acpigen_write_name_string("_DDN", config->desc); + acpigen_write_STA(acpi_device_status(dev)); + + /* Resources */ + acpigen_write_name("_CRS"); + acpigen_write_resourcetemplate_header(); + acpi_device_write_i2c(&i2c); + + /* Use either Interrupt() or GpioInt() */ + if (config->irq_gpio.pin_count) + irq_gpio_index = i2c_rt5682_write_gpio(&config->irq_gpio, + &curr_index); + else + acpi_device_write_interrupt(&config->irq); + + if (i2c_rt5682_add_gpios_to_crs(config) == true) { + reset_gpio_index = i2c_rt5682_write_gpio(&config->reset_gpio, + &curr_index); + enable_gpio_index = i2c_rt5682_write_gpio(&config->enable_gpio, + &curr_index); + } + acpigen_write_resourcetemplate_footer(); + + /* Wake capabilities */ + if (config->wake) { + acpigen_write_name_integer("_S0W", ACPI_DEVICE_SLEEP_D3_HOT); + acpigen_write_PRW(config->wake, 3); + } + + /* DSD */ + if (config->probed || config->property_count || config->compat_string || + (reset_gpio_index != -1) || + (enable_gpio_index != -1) || (irq_gpio_index != -1)) { + dsd = acpi_dp_new_table("_DSD"); + if (config->compat_string) + acpi_dp_add_string(dsd, "compatible", + config->compat_string); + if (config->probed) + acpi_dp_add_integer(dsd, "linux,probed", 1); + if (irq_gpio_index != -1) + acpi_dp_add_gpio(dsd, "irq-gpios", path, + irq_gpio_index, 0, + config->irq_gpio.active_low); + if (reset_gpio_index != -1) + acpi_dp_add_gpio(dsd, "reset-gpios", path, + reset_gpio_index, 0, + config->reset_gpio.active_low); + if (enable_gpio_index != -1) + acpi_dp_add_gpio(dsd, "enable-gpios", path, + enable_gpio_index, 0, + config->enable_gpio.active_low); + /* Add rt5682 property list */ + acpi_dp_add_property_list(dsd, config->property_list, + config->property_count); + acpi_dp_write(dsd); + } + + /* Power Resource */ + if (config->has_power_resource) { + const struct acpi_power_res_params power_res_params = { + &config->reset_gpio, + config->reset_delay_ms, + config->reset_off_delay_ms, + &config->enable_gpio, + config->enable_delay_ms, + config->enable_off_delay_ms, + &config->stop_gpio, + config->stop_delay_ms, + config->stop_off_delay_ms + }; + acpi_device_add_power_res(&power_res_params); + } + + /* Callback if any. */ + if (callback) + callback(dev); + + acpigen_pop_len(); /* Device */ + acpigen_pop_len(); /* Scope */ + + printk(BIOS_INFO, "%s: %s at %s\n", path, + config->desc ? : dev->chip_ops->name, dev_path(dev)); +} + +static void i2c_rt5682_fill_ssdt_generator(const struct device *dev) +{ + i2c_rt5682_fill_ssdt(dev, NULL, dev->chip_info); +} + +/* Use name specified in config or build one from I2C address */ +static const char *i2c_rt5682_acpi_name(const struct device *dev) +{ + struct drivers_i2c_rt5682_config *config = dev->chip_info; + static char name[5]; + + if (config->name) + return config->name; + + snprintf(name, sizeof(name), "D%03.3X", dev->path.i2c.device); + name[4] = '\0'; + return name; +} +#endif + +static struct device_operations i2c_rt5682_ops = { + .read_resources = noop_read_resources, + .set_resources = noop_set_resources, +#if CONFIG(HAVE_ACPI_TABLES) + .acpi_name = i2c_rt5682_acpi_name, + .acpi_fill_ssdt = i2c_rt5682_fill_ssdt_generator, +#endif +}; + +static void i2c_rt5682_enable(struct device *dev) +{ + struct drivers_i2c_rt5682_config *config = dev->chip_info; + + if (!config) + return; + + /* Check if device is present by reading GPIO */ + if (config->device_present_gpio) { + int present = gpio_get(config->device_present_gpio); + present ^= config->device_present_gpio_invert; + + printk(BIOS_INFO, "%s is %spresent\n", + dev->chip_ops->name, present ? "" : "not "); + + if (!present) { + dev->enabled = 0; + return; + } + } + + dev->ops = &i2c_rt5682_ops; + + /* Name the device as per description provided in devicetree */ + if (config->desc) + dev->name = config->desc; +} + +struct chip_operations drivers_i2c_rt5682_ops = { + CHIP_NAME("I2C Device") + .enable_dev = i2c_rt5682_enable +};