1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2005, 2006 IBM Corporation
4 * Copyright (C) 2014, 2015 Intel Corporation
7 * Leendert van Doorn <leendert@watson.ibm.com>
8 * Kylene Hall <kjhall@us.ibm.com>
10 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
12 * Device driver for TCG/TCPA TPM (trusted platform module).
13 * Specifications at www.trustedcomputinggroup.org
15 * This device driver implements the TPM interface as defined in
16 * the TCG TPM Interface Spec version 1.2, revision 1.0.
18 #include <linux/init.h>
19 #include <linux/module.h>
20 #include <linux/moduleparam.h>
21 #include <linux/pnp.h>
22 #include <linux/slab.h>
23 #include <linux/interrupt.h>
24 #include <linux/wait.h>
25 #include <linux/acpi.h>
26 #include <linux/freezer.h>
28 #include <linux/of_device.h>
29 #include <linux/kernel.h>
30 #include <linux/dmi.h>
32 #include "tpm_tis_core.h"
36 /* irq > 0 means: use irq $irq;
37 * irq = 0 means: autoprobe for an irq;
38 * irq = -1 means: no irq support
43 struct tpm_tis_tcg_phy {
44 struct tpm_tis_data priv;
48 static inline struct tpm_tis_tcg_phy *to_tpm_tis_tcg_phy(struct tpm_tis_data *data)
50 return container_of(data, struct tpm_tis_tcg_phy, priv);
53 static int interrupts = -1;
54 module_param(interrupts, int, 0444);
55 MODULE_PARM_DESC(interrupts, "Enable interrupts");
58 module_param(itpm, bool, 0444);
59 MODULE_PARM_DESC(itpm, "Force iTPM workarounds (found on some Lenovo laptops)");
63 module_param(force, bool, 0444);
64 MODULE_PARM_DESC(force, "Force device probe rather than using ACPI entry");
67 static int tpm_tis_disable_irq(const struct dmi_system_id *d)
69 if (interrupts == -1) {
70 pr_notice("tpm_tis: %s detected: disabling interrupts.\n", d->ident);
77 static const struct dmi_system_id tpm_tis_dmi_table[] = {
79 .callback = tpm_tis_disable_irq,
80 .ident = "ThinkPad T490s",
82 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
83 DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkPad T490s"),
87 .callback = tpm_tis_disable_irq,
88 .ident = "ThinkStation P360 Tiny",
90 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
91 DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkStation P360 Tiny"),
95 .callback = tpm_tis_disable_irq,
96 .ident = "ThinkPad L490",
98 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
99 DMI_MATCH(DMI_PRODUCT_VERSION, "ThinkPad L490"),
105 #if defined(CONFIG_PNP) && defined(CONFIG_ACPI)
106 static int has_hid(struct acpi_device *dev, const char *hid)
108 struct acpi_hardware_id *id;
110 list_for_each_entry(id, &dev->pnp.ids, list)
111 if (!strcmp(hid, id->id))
117 static inline int is_itpm(struct acpi_device *dev)
121 return has_hid(dev, "INTC0102");
124 static inline int is_itpm(struct acpi_device *dev)
130 #if defined(CONFIG_ACPI)
131 #define DEVICE_IS_TPM2 1
133 static const struct acpi_device_id tpm_acpi_tbl[] = {
134 {"MSFT0101", DEVICE_IS_TPM2},
137 MODULE_DEVICE_TABLE(acpi, tpm_acpi_tbl);
139 static int check_acpi_tpm2(struct device *dev)
141 const struct acpi_device_id *aid = acpi_match_device(tpm_acpi_tbl, dev);
142 struct acpi_table_tpm2 *tbl;
146 if (!aid || aid->driver_data != DEVICE_IS_TPM2)
149 /* If the ACPI TPM2 signature is matched then a global ACPI_SIG_TPM2
152 st = acpi_get_table(ACPI_SIG_TPM2, 1, (struct acpi_table_header **)&tbl);
153 if (ACPI_FAILURE(st) || tbl->header.length < sizeof(*tbl)) {
154 dev_err(dev, FW_BUG "failed to get TPM2 ACPI table\n");
158 /* The tpm2_crb driver handles this device */
159 if (tbl->start_method != ACPI_TPM2_MEMORY_MAPPED)
162 acpi_put_table((struct acpi_table_header *)tbl);
166 static int check_acpi_tpm2(struct device *dev)
172 static int tpm_tcg_read_bytes(struct tpm_tis_data *data, u32 addr, u16 len,
175 struct tpm_tis_tcg_phy *phy = to_tpm_tis_tcg_phy(data);
178 *result++ = ioread8(phy->iobase + addr);
183 static int tpm_tcg_write_bytes(struct tpm_tis_data *data, u32 addr, u16 len,
186 struct tpm_tis_tcg_phy *phy = to_tpm_tis_tcg_phy(data);
189 iowrite8(*value++, phy->iobase + addr);
194 static int tpm_tcg_read16(struct tpm_tis_data *data, u32 addr, u16 *result)
196 struct tpm_tis_tcg_phy *phy = to_tpm_tis_tcg_phy(data);
198 *result = ioread16(phy->iobase + addr);
203 static int tpm_tcg_read32(struct tpm_tis_data *data, u32 addr, u32 *result)
205 struct tpm_tis_tcg_phy *phy = to_tpm_tis_tcg_phy(data);
207 *result = ioread32(phy->iobase + addr);
212 static int tpm_tcg_write32(struct tpm_tis_data *data, u32 addr, u32 value)
214 struct tpm_tis_tcg_phy *phy = to_tpm_tis_tcg_phy(data);
216 iowrite32(value, phy->iobase + addr);
221 static const struct tpm_tis_phy_ops tpm_tcg = {
222 .read_bytes = tpm_tcg_read_bytes,
223 .write_bytes = tpm_tcg_write_bytes,
224 .read16 = tpm_tcg_read16,
225 .read32 = tpm_tcg_read32,
226 .write32 = tpm_tcg_write32,
229 static int tpm_tis_init(struct device *dev, struct tpm_info *tpm_info)
231 struct tpm_tis_tcg_phy *phy;
235 dmi_check_system(tpm_tis_dmi_table);
237 rc = check_acpi_tpm2(dev);
241 phy = devm_kzalloc(dev, sizeof(struct tpm_tis_tcg_phy), GFP_KERNEL);
245 phy->iobase = devm_ioremap_resource(dev, &tpm_info->res);
246 if (IS_ERR(phy->iobase))
247 return PTR_ERR(phy->iobase);
252 if (itpm || is_itpm(ACPI_COMPANION(dev)))
253 phy->priv.flags |= TPM_TIS_ITPM_WORKAROUND;
255 return tpm_tis_core_init(dev, &phy->priv, irq, &tpm_tcg,
259 static SIMPLE_DEV_PM_OPS(tpm_tis_pm, tpm_pm_suspend, tpm_tis_resume);
261 static int tpm_tis_pnp_init(struct pnp_dev *pnp_dev,
262 const struct pnp_device_id *pnp_id)
264 struct tpm_info tpm_info = {};
265 struct resource *res;
267 res = pnp_get_resource(pnp_dev, IORESOURCE_MEM, 0);
272 if (pnp_irq_valid(pnp_dev, 0))
273 tpm_info.irq = pnp_irq(pnp_dev, 0);
277 return tpm_tis_init(&pnp_dev->dev, &tpm_info);
281 * There is a known bug caused by 93e1b7d42e1e ("[PATCH] tpm: add HID module
282 * parameter"). This commit added IFX0102 device ID, which is also used by
283 * tpm_infineon but ignored to add quirks to probe which driver ought to be
287 static struct pnp_device_id tpm_pnp_tbl[] = {
288 {"PNP0C31", 0}, /* TPM */
289 {"ATM1200", 0}, /* Atmel */
290 {"IFX0102", 0}, /* Infineon */
291 {"BCM0101", 0}, /* Broadcom */
292 {"BCM0102", 0}, /* Broadcom */
293 {"NSC1200", 0}, /* National */
294 {"ICO0102", 0}, /* Intel */
296 {"", 0}, /* User Specified */
297 {"", 0} /* Terminator */
299 MODULE_DEVICE_TABLE(pnp, tpm_pnp_tbl);
301 static void tpm_tis_pnp_remove(struct pnp_dev *dev)
303 struct tpm_chip *chip = pnp_get_drvdata(dev);
305 tpm_chip_unregister(chip);
306 tpm_tis_remove(chip);
309 static struct pnp_driver tis_pnp_driver = {
311 .id_table = tpm_pnp_tbl,
312 .probe = tpm_tis_pnp_init,
313 .remove = tpm_tis_pnp_remove,
319 #define TIS_HID_USR_IDX (ARRAY_SIZE(tpm_pnp_tbl) - 2)
320 module_param_string(hid, tpm_pnp_tbl[TIS_HID_USR_IDX].id,
321 sizeof(tpm_pnp_tbl[TIS_HID_USR_IDX].id), 0444);
322 MODULE_PARM_DESC(hid, "Set additional specific HID for this driver to probe");
324 static struct platform_device *force_pdev;
326 static int tpm_tis_plat_probe(struct platform_device *pdev)
328 struct tpm_info tpm_info = {};
329 struct resource *res;
331 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
333 dev_err(&pdev->dev, "no memory resource defined\n");
338 tpm_info.irq = platform_get_irq_optional(pdev, 0);
339 if (tpm_info.irq <= 0) {
340 if (pdev != force_pdev)
343 /* When forcing auto probe the IRQ */
347 return tpm_tis_init(&pdev->dev, &tpm_info);
350 static int tpm_tis_plat_remove(struct platform_device *pdev)
352 struct tpm_chip *chip = dev_get_drvdata(&pdev->dev);
354 tpm_chip_unregister(chip);
355 tpm_tis_remove(chip);
361 static const struct of_device_id tis_of_platform_match[] = {
362 {.compatible = "tcg,tpm-tis-mmio"},
365 MODULE_DEVICE_TABLE(of, tis_of_platform_match);
368 static struct platform_driver tis_drv = {
369 .probe = tpm_tis_plat_probe,
370 .remove = tpm_tis_plat_remove,
374 .of_match_table = of_match_ptr(tis_of_platform_match),
375 .acpi_match_table = ACPI_PTR(tpm_acpi_tbl),
379 static int tpm_tis_force_device(void)
381 struct platform_device *pdev;
382 static const struct resource x86_resources[] = {
385 .end = 0xFED40000 + TIS_MEM_LEN - 1,
386 .flags = IORESOURCE_MEM,
393 /* The driver core will match the name tpm_tis of the device to
394 * the tpm_tis platform driver and complete the setup via
397 pdev = platform_device_register_simple("tpm_tis", -1, x86_resources,
398 ARRAY_SIZE(x86_resources));
400 return PTR_ERR(pdev);
406 static int __init init_tis(void)
410 rc = tpm_tis_force_device();
414 rc = platform_driver_register(&tis_drv);
419 if (IS_ENABLED(CONFIG_PNP)) {
420 rc = pnp_register_driver(&tis_pnp_driver);
428 platform_driver_unregister(&tis_drv);
431 platform_device_unregister(force_pdev);
436 static void __exit cleanup_tis(void)
438 pnp_unregister_driver(&tis_pnp_driver);
439 platform_driver_unregister(&tis_drv);
442 platform_device_unregister(force_pdev);
445 module_init(init_tis);
446 module_exit(cleanup_tis);
447 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
448 MODULE_DESCRIPTION("TPM Driver");
449 MODULE_VERSION("2.0");
450 MODULE_LICENSE("GPL");