Angel Pons | 8a3453f | 2020-04-02 23:48:19 +0200 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 2 | |
Furquan Shaikh | 76cedd2 | 2020-05-02 10:24:23 -0700 | [diff] [blame] | 3 | #include <acpi/acpi_device.h> |
| 4 | #include <acpi/acpigen.h> |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 5 | #include <console/console.h> |
Matt DeVillier | c636142 | 2022-03-28 22:35:42 -0500 | [diff] [blame] | 6 | #include <device/i2c_bus.h> |
Nico Huber | 0f2dd1e | 2017-08-01 14:02:40 +0200 | [diff] [blame] | 7 | #include <device/i2c_simple.h> |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 8 | #include <device/device.h> |
| 9 | #include <device/path.h> |
| 10 | #include <gpio.h> |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 11 | #include <string.h> |
| 12 | #include "chip.h" |
| 13 | |
Julius Werner | cd49cce | 2019-03-05 16:53:33 -0800 | [diff] [blame] | 14 | #if CONFIG(HAVE_ACPI_TABLES) |
Furquan Shaikh | 626ad20 | 2016-10-20 16:01:04 -0700 | [diff] [blame] | 15 | |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 16 | static bool i2c_generic_add_gpios_to_crs(struct drivers_i2c_generic_config *cfg) |
| 17 | { |
Furquan Shaikh | 71d830f | 2017-01-25 17:53:01 -0800 | [diff] [blame] | 18 | /* |
| 19 | * Return false if: |
| 20 | * 1. Request to explicitly disable export of GPIOs in CRS, or |
| 21 | * 2. Both reset and enable GPIOs are not provided. |
| 22 | */ |
| 23 | if (cfg->disable_gpio_export_in_crs || |
| 24 | ((cfg->reset_gpio.pin_count == 0) && |
| 25 | (cfg->enable_gpio.pin_count == 0))) |
| 26 | return false; |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 27 | |
Furquan Shaikh | 71d830f | 2017-01-25 17:53:01 -0800 | [diff] [blame] | 28 | return true; |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 29 | } |
| 30 | |
| 31 | static int i2c_generic_write_gpio(struct acpi_gpio *gpio, int *curr_index) |
| 32 | { |
| 33 | int ret = -1; |
| 34 | |
| 35 | if (gpio->pin_count == 0) |
| 36 | return ret; |
| 37 | |
| 38 | acpi_device_write_gpio(gpio); |
| 39 | ret = *curr_index; |
| 40 | (*curr_index)++; |
| 41 | |
| 42 | return ret; |
| 43 | } |
| 44 | |
Furquan Shaikh | 7536a39 | 2020-04-24 21:59:21 -0700 | [diff] [blame] | 45 | void i2c_generic_fill_ssdt(const struct device *dev, |
Furquan Shaikh | 8220c4b | 2020-04-24 21:44:27 -0700 | [diff] [blame] | 46 | void (*callback)(const struct device *dev), |
Furquan Shaikh | fdc1b2e | 2016-12-13 21:50:32 -0800 | [diff] [blame] | 47 | struct drivers_i2c_generic_config *config) |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 48 | { |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 49 | const char *scope = acpi_device_scope(dev); |
| 50 | struct acpi_i2c i2c = { |
| 51 | .address = dev->path.i2c.device, |
| 52 | .mode_10bit = dev->path.i2c.mode_10bit, |
Duncan Laurie | 14b2a4d | 2016-06-08 13:49:40 -0700 | [diff] [blame] | 53 | .speed = config->speed ? : I2C_SPEED_FAST, |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 54 | .resource = scope, |
| 55 | }; |
Duncan Laurie | fbf2c79b | 2016-09-26 10:31:22 -0700 | [diff] [blame] | 56 | struct acpi_dp *dsd = NULL; |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 57 | int curr_index = 0; |
Duncan Laurie | b94e935 | 2017-03-15 11:25:31 -0700 | [diff] [blame] | 58 | int reset_gpio_index = -1, enable_gpio_index = -1, irq_gpio_index = -1; |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 59 | const char *path = acpi_device_path(dev); |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 60 | |
Karthikeyan Ramasubramanian | d1c0f95 | 2020-11-02 16:26:52 -0700 | [diff] [blame] | 61 | if (!scope) |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 62 | return; |
| 63 | |
| 64 | if (!config->hid) { |
Matt DeVillier | 2494e93 | 2022-10-31 14:59:31 -0500 | [diff] [blame] | 65 | printk(BIOS_ERR, "%s: HID required but not set\n", dev_path(dev)); |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 66 | return; |
| 67 | } |
| 68 | |
Matt DeVillier | c636142 | 2022-03-28 22:35:42 -0500 | [diff] [blame] | 69 | if (config->detect) { |
| 70 | struct device *const busdev = i2c_busdev(dev); |
| 71 | if (!i2c_dev_detect(busdev, dev->path.i2c.device)) { |
| 72 | printk(BIOS_SPEW, "%s: %s at %s -- NOT FOUND, skipping\n", |
| 73 | path, |
| 74 | config->desc ? : dev->chip_ops->name, |
| 75 | dev_path(dev)); |
| 76 | return; |
| 77 | } |
| 78 | } |
| 79 | |
Raul E Rangel | ae129fc | 2021-12-14 12:55:36 -0700 | [diff] [blame] | 80 | if (config->has_power_resource && !config->disable_gpio_export_in_crs) { |
| 81 | /* |
| 82 | * This case will most likely cause timing problems. The OS driver might be |
| 83 | * controlling the GPIOs, but the ACPI Power Resource will also be controlling |
| 84 | * them. This will result in the two fighting and stomping on each other. |
| 85 | */ |
| 86 | printk(BIOS_ERR, "%s: Exposing GPIOs in Power Resource and _CRS\n", |
| 87 | dev_path(dev)); |
| 88 | } |
| 89 | |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 90 | /* Device */ |
| 91 | acpigen_write_scope(scope); |
| 92 | acpigen_write_device(acpi_device_name(dev)); |
| 93 | acpigen_write_name_string("_HID", config->hid); |
Furquan Shaikh | 1d33488 | 2016-10-21 16:24:07 -0700 | [diff] [blame] | 94 | if (config->cid) |
| 95 | acpigen_write_name_string("_CID", config->cid); |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 96 | acpigen_write_name_integer("_UID", config->uid); |
Matt DeVillier | 86dce8f | 2020-11-19 18:29:44 -0600 | [diff] [blame] | 97 | if (config->desc) |
| 98 | acpigen_write_name_string("_DDN", config->desc); |
Hung-Te Lin | b4be50c | 2018-09-10 10:55:49 +0800 | [diff] [blame] | 99 | acpigen_write_STA(acpi_device_status(dev)); |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 100 | |
| 101 | /* Resources */ |
| 102 | acpigen_write_name("_CRS"); |
| 103 | acpigen_write_resourcetemplate_header(); |
| 104 | acpi_device_write_i2c(&i2c); |
Duncan Laurie | b94e935 | 2017-03-15 11:25:31 -0700 | [diff] [blame] | 105 | |
| 106 | /* Use either Interrupt() or GpioInt() */ |
| 107 | if (config->irq_gpio.pin_count) |
| 108 | irq_gpio_index = i2c_generic_write_gpio(&config->irq_gpio, |
| 109 | &curr_index); |
| 110 | else |
| 111 | acpi_device_write_interrupt(&config->irq); |
| 112 | |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 113 | if (i2c_generic_add_gpios_to_crs(config) == true) { |
| 114 | reset_gpio_index = i2c_generic_write_gpio(&config->reset_gpio, |
| 115 | &curr_index); |
| 116 | enable_gpio_index = i2c_generic_write_gpio(&config->enable_gpio, |
| 117 | &curr_index); |
| 118 | } |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 119 | acpigen_write_resourcetemplate_footer(); |
| 120 | |
| 121 | /* Wake capabilities */ |
| 122 | if (config->wake) { |
Tony Huang | 1282b00 | 2021-05-03 09:35:56 +0800 | [diff] [blame] | 123 | acpigen_write_name_integer("_S0W", ACPI_DEVICE_SLEEP_D3_HOT); |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 124 | acpigen_write_PRW(config->wake, 3); |
| 125 | } |
| 126 | |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 127 | /* DSD */ |
Furquan Shaikh | 8ce36ac | 2019-08-09 07:59:06 -0700 | [diff] [blame] | 128 | if (config->probed || config->property_count || config->compat_string || |
Duncan Laurie | 1533a3c | 2017-08-29 08:28:58 -0700 | [diff] [blame] | 129 | (reset_gpio_index != -1) || |
Duncan Laurie | b94e935 | 2017-03-15 11:25:31 -0700 | [diff] [blame] | 130 | (enable_gpio_index != -1) || (irq_gpio_index != -1)) { |
Duncan Laurie | fbf2c79b | 2016-09-26 10:31:22 -0700 | [diff] [blame] | 131 | dsd = acpi_dp_new_table("_DSD"); |
Furquan Shaikh | 8ce36ac | 2019-08-09 07:59:06 -0700 | [diff] [blame] | 132 | if (config->compat_string) |
| 133 | acpi_dp_add_string(dsd, "compatible", |
| 134 | config->compat_string); |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 135 | if (config->probed) |
| 136 | acpi_dp_add_integer(dsd, "linux,probed", 1); |
Duncan Laurie | b94e935 | 2017-03-15 11:25:31 -0700 | [diff] [blame] | 137 | if (irq_gpio_index != -1) |
| 138 | acpi_dp_add_gpio(dsd, "irq-gpios", path, |
| 139 | irq_gpio_index, 0, |
Furquan Shaikh | d2d5e44 | 2020-07-01 01:37:13 -0700 | [diff] [blame] | 140 | config->irq_gpio.active_low); |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 141 | if (reset_gpio_index != -1) |
| 142 | acpi_dp_add_gpio(dsd, "reset-gpios", path, |
| 143 | reset_gpio_index, 0, |
Furquan Shaikh | d2d5e44 | 2020-07-01 01:37:13 -0700 | [diff] [blame] | 144 | config->reset_gpio.active_low); |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 145 | if (enable_gpio_index != -1) |
| 146 | acpi_dp_add_gpio(dsd, "enable-gpios", path, |
| 147 | enable_gpio_index, 0, |
Furquan Shaikh | d2d5e44 | 2020-07-01 01:37:13 -0700 | [diff] [blame] | 148 | config->enable_gpio.active_low); |
Duncan Laurie | 1533a3c | 2017-08-29 08:28:58 -0700 | [diff] [blame] | 149 | /* Add generic property list */ |
| 150 | acpi_dp_add_property_list(dsd, config->property_list, |
| 151 | config->property_count); |
Duncan Laurie | fbf2c79b | 2016-09-26 10:31:22 -0700 | [diff] [blame] | 152 | acpi_dp_write(dsd); |
| 153 | } |
| 154 | |
Furquan Shaikh | 626ad20 | 2016-10-20 16:01:04 -0700 | [diff] [blame] | 155 | /* Power Resource */ |
Shelley Chen | a060339 | 2018-04-26 13:52:30 -0700 | [diff] [blame] | 156 | if (config->has_power_resource) { |
| 157 | const struct acpi_power_res_params power_res_params = { |
| 158 | &config->reset_gpio, |
| 159 | config->reset_delay_ms, |
| 160 | config->reset_off_delay_ms, |
| 161 | &config->enable_gpio, |
| 162 | config->enable_delay_ms, |
| 163 | config->enable_off_delay_ms, |
| 164 | &config->stop_gpio, |
| 165 | config->stop_delay_ms, |
| 166 | config->stop_off_delay_ms |
| 167 | }; |
| 168 | acpi_device_add_power_res(&power_res_params); |
| 169 | } |
Furquan Shaikh | 626ad20 | 2016-10-20 16:01:04 -0700 | [diff] [blame] | 170 | |
Furquan Shaikh | 1d33488 | 2016-10-21 16:24:07 -0700 | [diff] [blame] | 171 | /* Callback if any. */ |
| 172 | if (callback) |
| 173 | callback(dev); |
| 174 | |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 175 | acpigen_pop_len(); /* Device */ |
| 176 | acpigen_pop_len(); /* Scope */ |
| 177 | |
Furquan Shaikh | 98915bb | 2016-12-12 09:23:01 -0800 | [diff] [blame] | 178 | printk(BIOS_INFO, "%s: %s at %s\n", path, |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 179 | config->desc ? : dev->chip_ops->name, dev_path(dev)); |
| 180 | } |
| 181 | |
Furquan Shaikh | 7536a39 | 2020-04-24 21:59:21 -0700 | [diff] [blame] | 182 | static void i2c_generic_fill_ssdt_generator(const struct device *dev) |
Furquan Shaikh | 1d33488 | 2016-10-21 16:24:07 -0700 | [diff] [blame] | 183 | { |
Furquan Shaikh | fdc1b2e | 2016-12-13 21:50:32 -0800 | [diff] [blame] | 184 | i2c_generic_fill_ssdt(dev, NULL, dev->chip_info); |
Furquan Shaikh | 1d33488 | 2016-10-21 16:24:07 -0700 | [diff] [blame] | 185 | } |
| 186 | |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 187 | /* Use name specified in config or build one from I2C address */ |
Aaron Durbin | aa090cb | 2017-09-13 16:01:52 -0600 | [diff] [blame] | 188 | static const char *i2c_generic_acpi_name(const struct device *dev) |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 189 | { |
| 190 | struct drivers_i2c_generic_config *config = dev->chip_info; |
| 191 | static char name[5]; |
| 192 | |
| 193 | if (config->name) |
Furquan Shaikh | 3f4e627 | 2016-10-18 15:11:32 -0700 | [diff] [blame] | 194 | return config->name; |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 195 | |
| 196 | snprintf(name, sizeof(name), "D%03.3X", dev->path.i2c.device); |
| 197 | name[4] = '\0'; |
| 198 | return name; |
| 199 | } |
| 200 | #endif |
| 201 | |
| 202 | static struct device_operations i2c_generic_ops = { |
Nico Huber | 2f8ba69 | 2020-04-05 14:05:24 +0200 | [diff] [blame] | 203 | .read_resources = noop_read_resources, |
| 204 | .set_resources = noop_set_resources, |
Julius Werner | cd49cce | 2019-03-05 16:53:33 -0800 | [diff] [blame] | 205 | #if CONFIG(HAVE_ACPI_TABLES) |
Nico Huber | 68680dd | 2020-03-31 17:34:52 +0200 | [diff] [blame] | 206 | .acpi_name = i2c_generic_acpi_name, |
| 207 | .acpi_fill_ssdt = i2c_generic_fill_ssdt_generator, |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 208 | #endif |
| 209 | }; |
| 210 | |
| 211 | static void i2c_generic_enable(struct device *dev) |
| 212 | { |
| 213 | struct drivers_i2c_generic_config *config = dev->chip_info; |
| 214 | |
Furquan Shaikh | 24681f1 | 2018-06-10 13:33:44 -0700 | [diff] [blame] | 215 | if (!config) |
| 216 | return; |
| 217 | |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 218 | /* Check if device is present by reading GPIO */ |
| 219 | if (config->device_present_gpio) { |
| 220 | int present = gpio_get(config->device_present_gpio); |
| 221 | present ^= config->device_present_gpio_invert; |
| 222 | |
| 223 | printk(BIOS_INFO, "%s is %spresent\n", |
| 224 | dev->chip_ops->name, present ? "" : "not "); |
| 225 | |
| 226 | if (!present) { |
| 227 | dev->enabled = 0; |
| 228 | return; |
| 229 | } |
| 230 | } |
| 231 | |
| 232 | dev->ops = &i2c_generic_ops; |
Naresh G Solanki | 69e9e71 | 2018-06-04 17:45:19 +0530 | [diff] [blame] | 233 | |
| 234 | /* Name the device as per description provided in devicetree */ |
Furquan Shaikh | 24681f1 | 2018-06-10 13:33:44 -0700 | [diff] [blame] | 235 | if (config->desc) |
Naresh G Solanki | 69e9e71 | 2018-06-04 17:45:19 +0530 | [diff] [blame] | 236 | dev->name = config->desc; |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 237 | } |
| 238 | |
| 239 | struct chip_operations drivers_i2c_generic_ops = { |
| 240 | CHIP_NAME("I2C Device") |
Elyes HAOUAS | 2aa3b16 | 2018-11-27 17:02:10 +0100 | [diff] [blame] | 241 | .enable_dev = i2c_generic_enable |
Duncan Laurie | 21a097a | 2016-05-11 09:50:59 -0700 | [diff] [blame] | 242 | }; |