2 * ACPI support for Intel Lynxpoint LPSS.
4 * Copyright (C) 2013, Intel Corporation
5 * Authors: Mika Westerberg <mika.westerberg@linux.intel.com>
6 * Rafael J. Wysocki <rafael.j.wysocki@intel.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/acpi.h>
14 #include <linux/clkdev.h>
15 #include <linux/clk-provider.h>
16 #include <linux/err.h>
18 #include <linux/mutex.h>
19 #include <linux/platform_device.h>
20 #include <linux/platform_data/clk-lpss.h>
21 #include <linux/platform_data/x86/pmc_atom.h>
22 #include <linux/pm_domain.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/pwm.h>
25 #include <linux/suspend.h>
26 #include <linux/delay.h>
30 ACPI_MODULE_NAME("acpi_lpss");
32 #ifdef CONFIG_X86_INTEL_LPSS
34 #include <asm/cpu_device_id.h>
35 #include <asm/intel-family.h>
36 #include <asm/iosf_mbi.h>
38 #define LPSS_ADDR(desc) ((unsigned long)&desc)
40 #define LPSS_CLK_SIZE 0x04
41 #define LPSS_LTR_SIZE 0x18
43 /* Offsets relative to LPSS_PRIVATE_OFFSET */
44 #define LPSS_CLK_DIVIDER_DEF_MASK (BIT(1) | BIT(16))
45 #define LPSS_RESETS 0x04
46 #define LPSS_RESETS_RESET_FUNC BIT(0)
47 #define LPSS_RESETS_RESET_APB BIT(1)
48 #define LPSS_GENERAL 0x08
49 #define LPSS_GENERAL_LTR_MODE_SW BIT(2)
50 #define LPSS_GENERAL_UART_RTS_OVRD BIT(3)
51 #define LPSS_SW_LTR 0x10
52 #define LPSS_AUTO_LTR 0x14
53 #define LPSS_LTR_SNOOP_REQ BIT(15)
54 #define LPSS_LTR_SNOOP_MASK 0x0000FFFF
55 #define LPSS_LTR_SNOOP_LAT_1US 0x800
56 #define LPSS_LTR_SNOOP_LAT_32US 0xC00
57 #define LPSS_LTR_SNOOP_LAT_SHIFT 5
58 #define LPSS_LTR_SNOOP_LAT_CUTOFF 3000
59 #define LPSS_LTR_MAX_VAL 0x3FF
60 #define LPSS_TX_INT 0x20
61 #define LPSS_TX_INT_MASK BIT(1)
63 #define LPSS_PRV_REG_COUNT 9
66 #define LPSS_CLK BIT(0)
67 #define LPSS_CLK_GATE BIT(1)
68 #define LPSS_CLK_DIVIDER BIT(2)
69 #define LPSS_LTR BIT(3)
70 #define LPSS_SAVE_CTX BIT(4)
71 #define LPSS_NO_D3_DELAY BIT(5)
73 /* Crystal Cove PMIC shares same ACPI ID between different platforms */
77 struct lpss_private_data;
79 struct lpss_device_desc {
81 const char *clk_con_id;
82 unsigned int prv_offset;
83 size_t prv_size_override;
84 struct property_entry *properties;
85 void (*setup)(struct lpss_private_data *pdata);
88 static const struct lpss_device_desc lpss_dma_desc = {
92 struct lpss_private_data {
93 struct acpi_device *adev;
94 void __iomem *mmio_base;
95 resource_size_t mmio_size;
96 unsigned int fixed_clk_rate;
98 const struct lpss_device_desc *dev_desc;
99 u32 prv_reg_ctx[LPSS_PRV_REG_COUNT];
102 /* Devices which need to be in D3 before lpss_iosf_enter_d3_state() proceeds */
103 static u32 pmc_atom_d3_mask = 0xfe000ffe;
105 /* LPSS run time quirks */
106 static unsigned int lpss_quirks;
109 * LPSS_QUIRK_ALWAYS_POWER_ON: override power state for LPSS DMA device.
111 * The LPSS DMA controller has neither _PS0 nor _PS3 method. Moreover
112 * it can be powered off automatically whenever the last LPSS device goes down.
113 * In case of no power any access to the DMA controller will hang the system.
114 * The behaviour is reproduced on some HP laptops based on Intel BayTrail as
115 * well as on ASuS T100TA transformer.
117 * This quirk overrides power state of entire LPSS island to keep DMA powered
118 * on whenever we have at least one other device in use.
120 #define LPSS_QUIRK_ALWAYS_POWER_ON BIT(0)
122 /* UART Component Parameter Register */
123 #define LPSS_UART_CPR 0xF4
124 #define LPSS_UART_CPR_AFCE BIT(4)
126 static void lpss_uart_setup(struct lpss_private_data *pdata)
131 offset = pdata->dev_desc->prv_offset + LPSS_TX_INT;
132 val = readl(pdata->mmio_base + offset);
133 writel(val | LPSS_TX_INT_MASK, pdata->mmio_base + offset);
135 val = readl(pdata->mmio_base + LPSS_UART_CPR);
136 if (!(val & LPSS_UART_CPR_AFCE)) {
137 offset = pdata->dev_desc->prv_offset + LPSS_GENERAL;
138 val = readl(pdata->mmio_base + offset);
139 val |= LPSS_GENERAL_UART_RTS_OVRD;
140 writel(val, pdata->mmio_base + offset);
144 static void lpss_deassert_reset(struct lpss_private_data *pdata)
149 offset = pdata->dev_desc->prv_offset + LPSS_RESETS;
150 val = readl(pdata->mmio_base + offset);
151 val |= LPSS_RESETS_RESET_APB | LPSS_RESETS_RESET_FUNC;
152 writel(val, pdata->mmio_base + offset);
156 * BYT PWM used for backlight control by the i915 driver on systems without
157 * the Crystal Cove PMIC.
159 static struct pwm_lookup byt_pwm_lookup[] = {
160 PWM_LOOKUP_WITH_MODULE("80860F09:00", 0, "0000:00:02.0",
161 "pwm_backlight", 0, PWM_POLARITY_NORMAL,
162 "pwm-lpss-platform"),
165 static void byt_pwm_setup(struct lpss_private_data *pdata)
167 struct acpi_device *adev = pdata->adev;
169 /* Only call pwm_add_table for the first PWM controller */
170 if (!adev->pnp.unique_id || strcmp(adev->pnp.unique_id, "1"))
173 if (!acpi_dev_present("INT33FD", NULL, BYT_CRC_HRV))
174 pwm_add_table(byt_pwm_lookup, ARRAY_SIZE(byt_pwm_lookup));
177 #define LPSS_I2C_ENABLE 0x6c
179 static void byt_i2c_setup(struct lpss_private_data *pdata)
181 const char *uid_str = acpi_device_uid(pdata->adev);
182 acpi_handle handle = pdata->adev->handle;
183 unsigned long long shared_host = 0;
187 /* Expected to always be true, but better safe then sorry */
189 uid = simple_strtol(uid_str, NULL, 10);
191 /* Detect I2C bus shared with PUNIT and ignore its d3 status */
192 status = acpi_evaluate_integer(handle, "_SEM", NULL, &shared_host);
193 if (ACPI_SUCCESS(status) && shared_host && uid)
194 pmc_atom_d3_mask &= ~(BIT_LPSS2_F1_I2C1 << (uid - 1));
196 lpss_deassert_reset(pdata);
198 if (readl(pdata->mmio_base + pdata->dev_desc->prv_offset))
199 pdata->fixed_clk_rate = 133000000;
201 writel(0, pdata->mmio_base + LPSS_I2C_ENABLE);
204 /* BSW PWM used for backlight control by the i915 driver */
205 static struct pwm_lookup bsw_pwm_lookup[] = {
206 PWM_LOOKUP_WITH_MODULE("80862288:00", 0, "0000:00:02.0",
207 "pwm_backlight", 0, PWM_POLARITY_NORMAL,
208 "pwm-lpss-platform"),
211 static void bsw_pwm_setup(struct lpss_private_data *pdata)
213 struct acpi_device *adev = pdata->adev;
215 /* Only call pwm_add_table for the first PWM controller */
216 if (!adev->pnp.unique_id || strcmp(adev->pnp.unique_id, "1"))
219 pwm_add_table(bsw_pwm_lookup, ARRAY_SIZE(bsw_pwm_lookup));
222 static const struct lpss_device_desc lpt_dev_desc = {
223 .flags = LPSS_CLK | LPSS_CLK_GATE | LPSS_CLK_DIVIDER | LPSS_LTR,
227 static const struct lpss_device_desc lpt_i2c_dev_desc = {
228 .flags = LPSS_CLK | LPSS_CLK_GATE | LPSS_LTR,
232 static struct property_entry uart_properties[] = {
233 PROPERTY_ENTRY_U32("reg-io-width", 4),
234 PROPERTY_ENTRY_U32("reg-shift", 2),
235 PROPERTY_ENTRY_BOOL("snps,uart-16550-compatible"),
239 static const struct lpss_device_desc lpt_uart_dev_desc = {
240 .flags = LPSS_CLK | LPSS_CLK_GATE | LPSS_CLK_DIVIDER | LPSS_LTR,
241 .clk_con_id = "baudclk",
243 .setup = lpss_uart_setup,
244 .properties = uart_properties,
247 static const struct lpss_device_desc lpt_sdio_dev_desc = {
249 .prv_offset = 0x1000,
250 .prv_size_override = 0x1018,
253 static const struct lpss_device_desc byt_pwm_dev_desc = {
254 .flags = LPSS_SAVE_CTX,
256 .setup = byt_pwm_setup,
259 static const struct lpss_device_desc bsw_pwm_dev_desc = {
260 .flags = LPSS_SAVE_CTX | LPSS_NO_D3_DELAY,
262 .setup = bsw_pwm_setup,
265 static const struct lpss_device_desc byt_uart_dev_desc = {
266 .flags = LPSS_CLK | LPSS_CLK_GATE | LPSS_CLK_DIVIDER | LPSS_SAVE_CTX,
267 .clk_con_id = "baudclk",
269 .setup = lpss_uart_setup,
270 .properties = uart_properties,
273 static const struct lpss_device_desc bsw_uart_dev_desc = {
274 .flags = LPSS_CLK | LPSS_CLK_GATE | LPSS_CLK_DIVIDER | LPSS_SAVE_CTX
276 .clk_con_id = "baudclk",
278 .setup = lpss_uart_setup,
279 .properties = uart_properties,
282 static const struct lpss_device_desc byt_spi_dev_desc = {
283 .flags = LPSS_CLK | LPSS_CLK_GATE | LPSS_CLK_DIVIDER | LPSS_SAVE_CTX,
287 static const struct lpss_device_desc byt_sdio_dev_desc = {
291 static const struct lpss_device_desc byt_i2c_dev_desc = {
292 .flags = LPSS_CLK | LPSS_SAVE_CTX,
294 .setup = byt_i2c_setup,
297 static const struct lpss_device_desc bsw_i2c_dev_desc = {
298 .flags = LPSS_CLK | LPSS_SAVE_CTX | LPSS_NO_D3_DELAY,
300 .setup = byt_i2c_setup,
303 static const struct lpss_device_desc bsw_spi_dev_desc = {
304 .flags = LPSS_CLK | LPSS_CLK_GATE | LPSS_CLK_DIVIDER | LPSS_SAVE_CTX
307 .setup = lpss_deassert_reset,
310 #define ICPU(model) { X86_VENDOR_INTEL, 6, model, X86_FEATURE_ANY, }
312 static const struct x86_cpu_id lpss_cpu_ids[] = {
313 ICPU(INTEL_FAM6_ATOM_SILVERMONT1), /* Valleyview, Bay Trail */
314 ICPU(INTEL_FAM6_ATOM_AIRMONT), /* Braswell, Cherry Trail */
320 #define LPSS_ADDR(desc) (0UL)
322 #endif /* CONFIG_X86_INTEL_LPSS */
324 static const struct acpi_device_id acpi_lpss_device_ids[] = {
325 /* Generic LPSS devices */
326 { "INTL9C60", LPSS_ADDR(lpss_dma_desc) },
328 /* Lynxpoint LPSS devices */
329 { "INT33C0", LPSS_ADDR(lpt_dev_desc) },
330 { "INT33C1", LPSS_ADDR(lpt_dev_desc) },
331 { "INT33C2", LPSS_ADDR(lpt_i2c_dev_desc) },
332 { "INT33C3", LPSS_ADDR(lpt_i2c_dev_desc) },
333 { "INT33C4", LPSS_ADDR(lpt_uart_dev_desc) },
334 { "INT33C5", LPSS_ADDR(lpt_uart_dev_desc) },
335 { "INT33C6", LPSS_ADDR(lpt_sdio_dev_desc) },
338 /* BayTrail LPSS devices */
339 { "80860F09", LPSS_ADDR(byt_pwm_dev_desc) },
340 { "80860F0A", LPSS_ADDR(byt_uart_dev_desc) },
341 { "80860F0E", LPSS_ADDR(byt_spi_dev_desc) },
342 { "80860F14", LPSS_ADDR(byt_sdio_dev_desc) },
343 { "80860F41", LPSS_ADDR(byt_i2c_dev_desc) },
347 /* Braswell LPSS devices */
348 { "80862286", LPSS_ADDR(lpss_dma_desc) },
349 { "80862288", LPSS_ADDR(bsw_pwm_dev_desc) },
350 { "8086228A", LPSS_ADDR(bsw_uart_dev_desc) },
351 { "8086228E", LPSS_ADDR(bsw_spi_dev_desc) },
352 { "808622C0", LPSS_ADDR(lpss_dma_desc) },
353 { "808622C1", LPSS_ADDR(bsw_i2c_dev_desc) },
355 /* Broadwell LPSS devices */
356 { "INT3430", LPSS_ADDR(lpt_dev_desc) },
357 { "INT3431", LPSS_ADDR(lpt_dev_desc) },
358 { "INT3432", LPSS_ADDR(lpt_i2c_dev_desc) },
359 { "INT3433", LPSS_ADDR(lpt_i2c_dev_desc) },
360 { "INT3434", LPSS_ADDR(lpt_uart_dev_desc) },
361 { "INT3435", LPSS_ADDR(lpt_uart_dev_desc) },
362 { "INT3436", LPSS_ADDR(lpt_sdio_dev_desc) },
365 /* Wildcat Point LPSS devices */
366 { "INT3438", LPSS_ADDR(lpt_dev_desc) },
371 #ifdef CONFIG_X86_INTEL_LPSS
373 static int is_memory(struct acpi_resource *res, void *not_used)
376 return !acpi_dev_resource_memory(res, &r);
379 /* LPSS main clock device. */
380 static struct platform_device *lpss_clk_dev;
382 static inline void lpt_register_clock_device(void)
384 lpss_clk_dev = platform_device_register_simple("clk-lpt", -1, NULL, 0);
387 static int register_device_clock(struct acpi_device *adev,
388 struct lpss_private_data *pdata)
390 const struct lpss_device_desc *dev_desc = pdata->dev_desc;
391 const char *devname = dev_name(&adev->dev);
393 struct lpss_clk_data *clk_data;
394 const char *parent, *clk_name;
395 void __iomem *prv_base;
398 lpt_register_clock_device();
400 clk_data = platform_get_drvdata(lpss_clk_dev);
405 if (!pdata->mmio_base
406 || pdata->mmio_size < dev_desc->prv_offset + LPSS_CLK_SIZE)
409 parent = clk_data->name;
410 prv_base = pdata->mmio_base + dev_desc->prv_offset;
412 if (pdata->fixed_clk_rate) {
413 clk = clk_register_fixed_rate(NULL, devname, parent, 0,
414 pdata->fixed_clk_rate);
418 if (dev_desc->flags & LPSS_CLK_GATE) {
419 clk = clk_register_gate(NULL, devname, parent, 0,
420 prv_base, 0, 0, NULL);
424 if (dev_desc->flags & LPSS_CLK_DIVIDER) {
425 /* Prevent division by zero */
426 if (!readl(prv_base))
427 writel(LPSS_CLK_DIVIDER_DEF_MASK, prv_base);
429 clk_name = kasprintf(GFP_KERNEL, "%s-div", devname);
432 clk = clk_register_fractional_divider(NULL, clk_name, parent,
434 1, 15, 16, 15, 0, NULL);
437 clk_name = kasprintf(GFP_KERNEL, "%s-update", devname);
442 clk = clk_register_gate(NULL, clk_name, parent,
443 CLK_SET_RATE_PARENT | CLK_SET_RATE_GATE,
444 prv_base, 31, 0, NULL);
453 clk_register_clkdev(clk, dev_desc->clk_con_id, devname);
457 struct lpss_device_links {
458 const char *supplier_hid;
459 const char *supplier_uid;
460 const char *consumer_hid;
461 const char *consumer_uid;
466 * The _DEP method is used to identify dependencies but instead of creating
467 * device links for every handle in _DEP, only links in the following list are
468 * created. That is necessary because, in the general case, _DEP can refer to
469 * devices that might not have drivers, or that are on different buses, or where
470 * the supplier is not enumerated until after the consumer is probed.
472 static const struct lpss_device_links lpss_device_links[] = {
473 {"808622C1", "7", "80860F14", "3", DL_FLAG_PM_RUNTIME},
476 static bool hid_uid_match(struct acpi_device *adev,
477 const char *hid2, const char *uid2)
479 const char *hid1 = acpi_device_hid(adev);
480 const char *uid1 = acpi_device_uid(adev);
482 if (strcmp(hid1, hid2))
488 return uid1 && !strcmp(uid1, uid2);
491 static bool acpi_lpss_is_supplier(struct acpi_device *adev,
492 const struct lpss_device_links *link)
494 return hid_uid_match(adev, link->supplier_hid, link->supplier_uid);
497 static bool acpi_lpss_is_consumer(struct acpi_device *adev,
498 const struct lpss_device_links *link)
500 return hid_uid_match(adev, link->consumer_hid, link->consumer_uid);
508 static int match_hid_uid(struct device *dev, void *data)
510 struct acpi_device *adev = ACPI_COMPANION(dev);
511 struct hid_uid *id = data;
516 return hid_uid_match(adev, id->hid, id->uid);
519 static struct device *acpi_lpss_find_device(const char *hid, const char *uid)
521 struct hid_uid data = {
526 return bus_find_device(&platform_bus_type, NULL, &data, match_hid_uid);
529 static bool acpi_lpss_dep(struct acpi_device *adev, acpi_handle handle)
531 struct acpi_handle_list dep_devices;
535 if (!acpi_has_method(adev->handle, "_DEP"))
538 status = acpi_evaluate_reference(adev->handle, "_DEP", NULL,
540 if (ACPI_FAILURE(status)) {
541 dev_dbg(&adev->dev, "Failed to evaluate _DEP.\n");
545 for (i = 0; i < dep_devices.count; i++) {
546 if (dep_devices.handles[i] == handle)
553 static void acpi_lpss_link_consumer(struct device *dev1,
554 const struct lpss_device_links *link)
558 dev2 = acpi_lpss_find_device(link->consumer_hid, link->consumer_uid);
562 if (acpi_lpss_dep(ACPI_COMPANION(dev2), ACPI_HANDLE(dev1)))
563 device_link_add(dev2, dev1, link->flags);
568 static void acpi_lpss_link_supplier(struct device *dev1,
569 const struct lpss_device_links *link)
573 dev2 = acpi_lpss_find_device(link->supplier_hid, link->supplier_uid);
577 if (acpi_lpss_dep(ACPI_COMPANION(dev1), ACPI_HANDLE(dev2)))
578 device_link_add(dev1, dev2, link->flags);
583 static void acpi_lpss_create_device_links(struct acpi_device *adev,
584 struct platform_device *pdev)
588 for (i = 0; i < ARRAY_SIZE(lpss_device_links); i++) {
589 const struct lpss_device_links *link = &lpss_device_links[i];
591 if (acpi_lpss_is_supplier(adev, link))
592 acpi_lpss_link_consumer(&pdev->dev, link);
594 if (acpi_lpss_is_consumer(adev, link))
595 acpi_lpss_link_supplier(&pdev->dev, link);
599 static int acpi_lpss_create_device(struct acpi_device *adev,
600 const struct acpi_device_id *id)
602 const struct lpss_device_desc *dev_desc;
603 struct lpss_private_data *pdata;
604 struct resource_entry *rentry;
605 struct list_head resource_list;
606 struct platform_device *pdev;
609 dev_desc = (const struct lpss_device_desc *)id->driver_data;
611 pdev = acpi_create_platform_device(adev, NULL);
612 return IS_ERR_OR_NULL(pdev) ? PTR_ERR(pdev) : 1;
614 pdata = kzalloc(sizeof(*pdata), GFP_KERNEL);
618 INIT_LIST_HEAD(&resource_list);
619 ret = acpi_dev_get_resources(adev, &resource_list, is_memory, NULL);
623 list_for_each_entry(rentry, &resource_list, node)
624 if (resource_type(rentry->res) == IORESOURCE_MEM) {
625 if (dev_desc->prv_size_override)
626 pdata->mmio_size = dev_desc->prv_size_override;
628 pdata->mmio_size = resource_size(rentry->res);
629 pdata->mmio_base = ioremap(rentry->res->start,
634 acpi_dev_free_resource_list(&resource_list);
636 if (!pdata->mmio_base) {
637 /* Avoid acpi_bus_attach() instantiating a pdev for this dev. */
638 adev->pnp.type.platform_id = 0;
639 /* Skip the device, but continue the namespace scan. */
645 pdata->dev_desc = dev_desc;
648 dev_desc->setup(pdata);
650 if (dev_desc->flags & LPSS_CLK) {
651 ret = register_device_clock(adev, pdata);
653 /* Skip the device, but continue the namespace scan. */
660 * This works around a known issue in ACPI tables where LPSS devices
661 * have _PS0 and _PS3 without _PSC (and no power resources), so
662 * acpi_bus_init_power() will assume that the BIOS has put them into D0.
664 ret = acpi_device_fix_up_power(adev);
666 /* Skip the device, but continue the namespace scan. */
671 adev->driver_data = pdata;
672 pdev = acpi_create_platform_device(adev, dev_desc->properties);
673 if (!IS_ERR_OR_NULL(pdev)) {
674 acpi_lpss_create_device_links(adev, pdev);
679 adev->driver_data = NULL;
686 static u32 __lpss_reg_read(struct lpss_private_data *pdata, unsigned int reg)
688 return readl(pdata->mmio_base + pdata->dev_desc->prv_offset + reg);
691 static void __lpss_reg_write(u32 val, struct lpss_private_data *pdata,
694 writel(val, pdata->mmio_base + pdata->dev_desc->prv_offset + reg);
697 static int lpss_reg_read(struct device *dev, unsigned int reg, u32 *val)
699 struct acpi_device *adev;
700 struct lpss_private_data *pdata;
704 ret = acpi_bus_get_device(ACPI_HANDLE(dev), &adev);
708 spin_lock_irqsave(&dev->power.lock, flags);
709 if (pm_runtime_suspended(dev)) {
713 pdata = acpi_driver_data(adev);
714 if (WARN_ON(!pdata || !pdata->mmio_base)) {
718 *val = __lpss_reg_read(pdata, reg);
721 spin_unlock_irqrestore(&dev->power.lock, flags);
725 static ssize_t lpss_ltr_show(struct device *dev, struct device_attribute *attr,
732 reg = strcmp(attr->attr.name, "auto_ltr") ? LPSS_SW_LTR : LPSS_AUTO_LTR;
733 ret = lpss_reg_read(dev, reg, <r_value);
737 return snprintf(buf, PAGE_SIZE, "%08x\n", ltr_value);
740 static ssize_t lpss_ltr_mode_show(struct device *dev,
741 struct device_attribute *attr, char *buf)
747 ret = lpss_reg_read(dev, LPSS_GENERAL, <r_mode);
751 outstr = (ltr_mode & LPSS_GENERAL_LTR_MODE_SW) ? "sw" : "auto";
752 return sprintf(buf, "%s\n", outstr);
755 static DEVICE_ATTR(auto_ltr, S_IRUSR, lpss_ltr_show, NULL);
756 static DEVICE_ATTR(sw_ltr, S_IRUSR, lpss_ltr_show, NULL);
757 static DEVICE_ATTR(ltr_mode, S_IRUSR, lpss_ltr_mode_show, NULL);
759 static struct attribute *lpss_attrs[] = {
760 &dev_attr_auto_ltr.attr,
761 &dev_attr_sw_ltr.attr,
762 &dev_attr_ltr_mode.attr,
766 static const struct attribute_group lpss_attr_group = {
771 static void acpi_lpss_set_ltr(struct device *dev, s32 val)
773 struct lpss_private_data *pdata = acpi_driver_data(ACPI_COMPANION(dev));
774 u32 ltr_mode, ltr_val;
776 ltr_mode = __lpss_reg_read(pdata, LPSS_GENERAL);
778 if (ltr_mode & LPSS_GENERAL_LTR_MODE_SW) {
779 ltr_mode &= ~LPSS_GENERAL_LTR_MODE_SW;
780 __lpss_reg_write(ltr_mode, pdata, LPSS_GENERAL);
784 ltr_val = __lpss_reg_read(pdata, LPSS_SW_LTR) & ~LPSS_LTR_SNOOP_MASK;
785 if (val >= LPSS_LTR_SNOOP_LAT_CUTOFF) {
786 ltr_val |= LPSS_LTR_SNOOP_LAT_32US;
787 val = LPSS_LTR_MAX_VAL;
788 } else if (val > LPSS_LTR_MAX_VAL) {
789 ltr_val |= LPSS_LTR_SNOOP_LAT_32US | LPSS_LTR_SNOOP_REQ;
790 val >>= LPSS_LTR_SNOOP_LAT_SHIFT;
792 ltr_val |= LPSS_LTR_SNOOP_LAT_1US | LPSS_LTR_SNOOP_REQ;
795 __lpss_reg_write(ltr_val, pdata, LPSS_SW_LTR);
796 if (!(ltr_mode & LPSS_GENERAL_LTR_MODE_SW)) {
797 ltr_mode |= LPSS_GENERAL_LTR_MODE_SW;
798 __lpss_reg_write(ltr_mode, pdata, LPSS_GENERAL);
804 * acpi_lpss_save_ctx() - Save the private registers of LPSS device
806 * @pdata: pointer to the private data of the LPSS device
808 * Most LPSS devices have private registers which may loose their context when
809 * the device is powered down. acpi_lpss_save_ctx() saves those registers into
812 static void acpi_lpss_save_ctx(struct device *dev,
813 struct lpss_private_data *pdata)
817 for (i = 0; i < LPSS_PRV_REG_COUNT; i++) {
818 unsigned long offset = i * sizeof(u32);
820 pdata->prv_reg_ctx[i] = __lpss_reg_read(pdata, offset);
821 dev_dbg(dev, "saving 0x%08x from LPSS reg at offset 0x%02lx\n",
822 pdata->prv_reg_ctx[i], offset);
827 * acpi_lpss_restore_ctx() - Restore the private registers of LPSS device
829 * @pdata: pointer to the private data of the LPSS device
831 * Restores the registers that were previously stored with acpi_lpss_save_ctx().
833 static void acpi_lpss_restore_ctx(struct device *dev,
834 struct lpss_private_data *pdata)
838 for (i = 0; i < LPSS_PRV_REG_COUNT; i++) {
839 unsigned long offset = i * sizeof(u32);
841 __lpss_reg_write(pdata->prv_reg_ctx[i], pdata, offset);
842 dev_dbg(dev, "restoring 0x%08x to LPSS reg at offset 0x%02lx\n",
843 pdata->prv_reg_ctx[i], offset);
847 static void acpi_lpss_d3_to_d0_delay(struct lpss_private_data *pdata)
850 * The following delay is needed or the subsequent write operations may
851 * fail. The LPSS devices are actually PCI devices and the PCI spec
852 * expects 10ms delay before the device can be accessed after D3 to D0
853 * transition. However some platforms like BSW does not need this delay.
855 unsigned int delay = 10; /* default 10ms delay */
857 if (pdata->dev_desc->flags & LPSS_NO_D3_DELAY)
863 static int acpi_lpss_activate(struct device *dev)
865 struct lpss_private_data *pdata = acpi_driver_data(ACPI_COMPANION(dev));
868 ret = acpi_dev_resume(dev);
872 acpi_lpss_d3_to_d0_delay(pdata);
875 * This is called only on ->probe() stage where a device is either in
876 * known state defined by BIOS or most likely powered off. Due to this
877 * we have to deassert reset line to be sure that ->probe() will
878 * recognize the device.
880 if (pdata->dev_desc->flags & LPSS_SAVE_CTX)
881 lpss_deassert_reset(pdata);
886 static void acpi_lpss_dismiss(struct device *dev)
888 acpi_dev_suspend(dev, false);
891 /* IOSF SB for LPSS island */
892 #define LPSS_IOSF_UNIT_LPIOEP 0xA0
893 #define LPSS_IOSF_UNIT_LPIO1 0xAB
894 #define LPSS_IOSF_UNIT_LPIO2 0xAC
896 #define LPSS_IOSF_PMCSR 0x84
897 #define LPSS_PMCSR_D0 0
898 #define LPSS_PMCSR_D3hot 3
899 #define LPSS_PMCSR_Dx_MASK GENMASK(1, 0)
901 #define LPSS_IOSF_GPIODEF0 0x154
902 #define LPSS_GPIODEF0_DMA1_D3 BIT(2)
903 #define LPSS_GPIODEF0_DMA2_D3 BIT(3)
904 #define LPSS_GPIODEF0_DMA_D3_MASK GENMASK(3, 2)
905 #define LPSS_GPIODEF0_DMA_LLP BIT(13)
907 static DEFINE_MUTEX(lpss_iosf_mutex);
908 static bool lpss_iosf_d3_entered = true;
910 static void lpss_iosf_enter_d3_state(void)
913 u32 mask1 = LPSS_GPIODEF0_DMA_D3_MASK | LPSS_GPIODEF0_DMA_LLP;
914 u32 value2 = LPSS_PMCSR_D3hot;
915 u32 mask2 = LPSS_PMCSR_Dx_MASK;
917 * PMC provides an information about actual status of the LPSS devices.
918 * Here we read the values related to LPSS power island, i.e. LPSS
919 * devices, excluding both LPSS DMA controllers, along with SCC domain.
921 u32 func_dis, d3_sts_0, pmc_status;
924 ret = pmc_atom_read(PMC_FUNC_DIS, &func_dis);
928 mutex_lock(&lpss_iosf_mutex);
930 ret = pmc_atom_read(PMC_D3_STS_0, &d3_sts_0);
935 * Get the status of entire LPSS power island per device basis.
936 * Shutdown both LPSS DMA controllers if and only if all other devices
937 * are already in D3hot.
939 pmc_status = (~(d3_sts_0 | func_dis)) & pmc_atom_d3_mask;
943 iosf_mbi_modify(LPSS_IOSF_UNIT_LPIO1, MBI_CFG_WRITE,
944 LPSS_IOSF_PMCSR, value2, mask2);
946 iosf_mbi_modify(LPSS_IOSF_UNIT_LPIO2, MBI_CFG_WRITE,
947 LPSS_IOSF_PMCSR, value2, mask2);
949 iosf_mbi_modify(LPSS_IOSF_UNIT_LPIOEP, MBI_CR_WRITE,
950 LPSS_IOSF_GPIODEF0, value1, mask1);
952 lpss_iosf_d3_entered = true;
955 mutex_unlock(&lpss_iosf_mutex);
958 static void lpss_iosf_exit_d3_state(void)
960 u32 value1 = LPSS_GPIODEF0_DMA1_D3 | LPSS_GPIODEF0_DMA2_D3 |
961 LPSS_GPIODEF0_DMA_LLP;
962 u32 mask1 = LPSS_GPIODEF0_DMA_D3_MASK | LPSS_GPIODEF0_DMA_LLP;
963 u32 value2 = LPSS_PMCSR_D0;
964 u32 mask2 = LPSS_PMCSR_Dx_MASK;
966 mutex_lock(&lpss_iosf_mutex);
968 if (!lpss_iosf_d3_entered)
971 lpss_iosf_d3_entered = false;
973 iosf_mbi_modify(LPSS_IOSF_UNIT_LPIOEP, MBI_CR_WRITE,
974 LPSS_IOSF_GPIODEF0, value1, mask1);
976 iosf_mbi_modify(LPSS_IOSF_UNIT_LPIO2, MBI_CFG_WRITE,
977 LPSS_IOSF_PMCSR, value2, mask2);
979 iosf_mbi_modify(LPSS_IOSF_UNIT_LPIO1, MBI_CFG_WRITE,
980 LPSS_IOSF_PMCSR, value2, mask2);
983 mutex_unlock(&lpss_iosf_mutex);
986 static int acpi_lpss_suspend(struct device *dev, bool wakeup)
988 struct lpss_private_data *pdata = acpi_driver_data(ACPI_COMPANION(dev));
991 if (pdata->dev_desc->flags & LPSS_SAVE_CTX)
992 acpi_lpss_save_ctx(dev, pdata);
994 ret = acpi_dev_suspend(dev, wakeup);
997 * This call must be last in the sequence, otherwise PMC will return
998 * wrong status for devices being about to be powered off. See
999 * lpss_iosf_enter_d3_state() for further information.
1001 if (acpi_target_system_state() == ACPI_STATE_S0 &&
1002 lpss_quirks & LPSS_QUIRK_ALWAYS_POWER_ON && iosf_mbi_available())
1003 lpss_iosf_enter_d3_state();
1008 static int acpi_lpss_resume(struct device *dev)
1010 struct lpss_private_data *pdata = acpi_driver_data(ACPI_COMPANION(dev));
1014 * This call is kept first to be in symmetry with
1015 * acpi_lpss_runtime_suspend() one.
1017 if (lpss_quirks & LPSS_QUIRK_ALWAYS_POWER_ON && iosf_mbi_available())
1018 lpss_iosf_exit_d3_state();
1020 ret = acpi_dev_resume(dev);
1024 acpi_lpss_d3_to_d0_delay(pdata);
1026 if (pdata->dev_desc->flags & LPSS_SAVE_CTX)
1027 acpi_lpss_restore_ctx(dev, pdata);
1032 #ifdef CONFIG_PM_SLEEP
1033 static int acpi_lpss_suspend_late(struct device *dev)
1037 if (dev_pm_smart_suspend_and_suspended(dev))
1040 ret = pm_generic_suspend_late(dev);
1041 return ret ? ret : acpi_lpss_suspend(dev, device_may_wakeup(dev));
1044 static int acpi_lpss_resume_early(struct device *dev)
1046 int ret = acpi_lpss_resume(dev);
1048 return ret ? ret : pm_generic_resume_early(dev);
1050 #endif /* CONFIG_PM_SLEEP */
1052 static int acpi_lpss_runtime_suspend(struct device *dev)
1054 int ret = pm_generic_runtime_suspend(dev);
1056 return ret ? ret : acpi_lpss_suspend(dev, true);
1059 static int acpi_lpss_runtime_resume(struct device *dev)
1061 int ret = acpi_lpss_resume(dev);
1063 return ret ? ret : pm_generic_runtime_resume(dev);
1065 #endif /* CONFIG_PM */
1067 static struct dev_pm_domain acpi_lpss_pm_domain = {
1069 .activate = acpi_lpss_activate,
1070 .dismiss = acpi_lpss_dismiss,
1074 #ifdef CONFIG_PM_SLEEP
1075 .prepare = acpi_subsys_prepare,
1076 .complete = acpi_subsys_complete,
1077 .suspend = acpi_subsys_suspend,
1078 .suspend_late = acpi_lpss_suspend_late,
1079 .suspend_noirq = acpi_subsys_suspend_noirq,
1080 .resume_noirq = acpi_subsys_resume_noirq,
1081 .resume_early = acpi_lpss_resume_early,
1082 .freeze = acpi_subsys_freeze,
1083 .freeze_late = acpi_subsys_freeze_late,
1084 .freeze_noirq = acpi_subsys_freeze_noirq,
1085 .thaw_noirq = acpi_subsys_thaw_noirq,
1086 .poweroff = acpi_subsys_suspend,
1087 .poweroff_late = acpi_lpss_suspend_late,
1088 .poweroff_noirq = acpi_subsys_suspend_noirq,
1089 .restore_noirq = acpi_subsys_resume_noirq,
1090 .restore_early = acpi_lpss_resume_early,
1092 .runtime_suspend = acpi_lpss_runtime_suspend,
1093 .runtime_resume = acpi_lpss_runtime_resume,
1098 static int acpi_lpss_platform_notify(struct notifier_block *nb,
1099 unsigned long action, void *data)
1101 struct platform_device *pdev = to_platform_device(data);
1102 struct lpss_private_data *pdata;
1103 struct acpi_device *adev;
1104 const struct acpi_device_id *id;
1106 id = acpi_match_device(acpi_lpss_device_ids, &pdev->dev);
1107 if (!id || !id->driver_data)
1110 if (acpi_bus_get_device(ACPI_HANDLE(&pdev->dev), &adev))
1113 pdata = acpi_driver_data(adev);
1117 if (pdata->mmio_base &&
1118 pdata->mmio_size < pdata->dev_desc->prv_offset + LPSS_LTR_SIZE) {
1119 dev_err(&pdev->dev, "MMIO size insufficient to access LTR\n");
1124 case BUS_NOTIFY_BIND_DRIVER:
1125 dev_pm_domain_set(&pdev->dev, &acpi_lpss_pm_domain);
1127 case BUS_NOTIFY_DRIVER_NOT_BOUND:
1128 case BUS_NOTIFY_UNBOUND_DRIVER:
1129 dev_pm_domain_set(&pdev->dev, NULL);
1131 case BUS_NOTIFY_ADD_DEVICE:
1132 dev_pm_domain_set(&pdev->dev, &acpi_lpss_pm_domain);
1133 if (pdata->dev_desc->flags & LPSS_LTR)
1134 return sysfs_create_group(&pdev->dev.kobj,
1137 case BUS_NOTIFY_DEL_DEVICE:
1138 if (pdata->dev_desc->flags & LPSS_LTR)
1139 sysfs_remove_group(&pdev->dev.kobj, &lpss_attr_group);
1140 dev_pm_domain_set(&pdev->dev, NULL);
1149 static struct notifier_block acpi_lpss_nb = {
1150 .notifier_call = acpi_lpss_platform_notify,
1153 static void acpi_lpss_bind(struct device *dev)
1155 struct lpss_private_data *pdata = acpi_driver_data(ACPI_COMPANION(dev));
1157 if (!pdata || !pdata->mmio_base || !(pdata->dev_desc->flags & LPSS_LTR))
1160 if (pdata->mmio_size >= pdata->dev_desc->prv_offset + LPSS_LTR_SIZE)
1161 dev->power.set_latency_tolerance = acpi_lpss_set_ltr;
1163 dev_err(dev, "MMIO size insufficient to access LTR\n");
1166 static void acpi_lpss_unbind(struct device *dev)
1168 dev->power.set_latency_tolerance = NULL;
1171 static struct acpi_scan_handler lpss_handler = {
1172 .ids = acpi_lpss_device_ids,
1173 .attach = acpi_lpss_create_device,
1174 .bind = acpi_lpss_bind,
1175 .unbind = acpi_lpss_unbind,
1178 void __init acpi_lpss_init(void)
1180 const struct x86_cpu_id *id;
1183 ret = lpt_clk_init();
1187 id = x86_match_cpu(lpss_cpu_ids);
1189 lpss_quirks |= LPSS_QUIRK_ALWAYS_POWER_ON;
1191 bus_register_notifier(&platform_bus_type, &acpi_lpss_nb);
1192 acpi_scan_add_handler(&lpss_handler);
1197 static struct acpi_scan_handler lpss_handler = {
1198 .ids = acpi_lpss_device_ids,
1201 void __init acpi_lpss_init(void)
1203 acpi_scan_add_handler(&lpss_handler);
1206 #endif /* CONFIG_X86_INTEL_LPSS */