1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /******************************************************************************
3 * Nuvoton TPM I2C Device Driver Interface for WPCT301/NPCT501/NPCT6XX,
4 * based on the TCG TPM Interface Spec version 1.2.
5 * Specifications at www.trustedcomputinggroup.org
7 * Copyright (C) 2011, Nuvoton Technology Corporation.
9 * Copyright (C) 2013, Obsidian Research Corp.
13 *****************************************************************************/
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/slab.h>
19 #include <linux/interrupt.h>
20 #include <linux/wait.h>
21 #include <linux/i2c.h>
22 #include <linux/of_device.h>
25 /* I2C interface offsets */
27 #define TPM_BURST_COUNT 0x01
28 #define TPM_DATA_FIFO_W 0x20
29 #define TPM_DATA_FIFO_R 0x40
30 #define TPM_VID_DID_RID 0x60
31 #define TPM_I2C_RETRIES 5
33 * I2C bus device maximum buffer size w/o counting I2C address or command
34 * i.e. max size required for I2C write is 34 = addr, command, 32 bytes data
36 #define TPM_I2C_MAX_BUF_SIZE 32
37 #define TPM_I2C_RETRY_COUNT 32
38 #define TPM_I2C_BUS_DELAY 1000 /* usec */
39 #define TPM_I2C_RETRY_DELAY_SHORT (2 * 1000) /* usec */
40 #define TPM_I2C_RETRY_DELAY_LONG (10 * 1000) /* usec */
41 #define TPM_I2C_DELAY_RANGE 300 /* usec */
43 #define OF_IS_TPM2 ((void *)1)
49 wait_queue_head_t read_queue;
52 static s32 i2c_nuvoton_read_buf(struct i2c_client *client, u8 offset, u8 size,
57 status = i2c_smbus_read_i2c_block_data(client, offset, size, data);
59 "%s(offset=%u size=%u data=%*ph) -> sts=%d\n", __func__,
60 offset, size, (int)size, data, status);
64 static s32 i2c_nuvoton_write_buf(struct i2c_client *client, u8 offset, u8 size,
69 status = i2c_smbus_write_i2c_block_data(client, offset, size, data);
71 "%s(offset=%u size=%u data=%*ph) -> sts=%d\n", __func__,
72 offset, size, (int)size, data, status);
76 #define TPM_STS_VALID 0x80
77 #define TPM_STS_COMMAND_READY 0x40
78 #define TPM_STS_GO 0x20
79 #define TPM_STS_DATA_AVAIL 0x10
80 #define TPM_STS_EXPECT 0x08
81 #define TPM_STS_RESPONSE_RETRY 0x02
82 #define TPM_STS_ERR_VAL 0x07 /* bit2...bit0 reads always 0 */
84 #define TPM_I2C_SHORT_TIMEOUT 750 /* ms */
85 #define TPM_I2C_LONG_TIMEOUT 2000 /* 2 sec */
87 /* read TPM_STS register */
88 static u8 i2c_nuvoton_read_status(struct tpm_chip *chip)
90 struct i2c_client *client = to_i2c_client(chip->dev.parent);
94 status = i2c_nuvoton_read_buf(client, TPM_STS, 1, &data);
96 dev_err(&chip->dev, "%s() error return %d\n", __func__,
98 data = TPM_STS_ERR_VAL;
104 /* write byte to TPM_STS register */
105 static s32 i2c_nuvoton_write_status(struct i2c_client *client, u8 data)
110 /* this causes the current command to be aborted */
111 for (i = 0, status = -1; i < TPM_I2C_RETRY_COUNT && status < 0; i++) {
112 status = i2c_nuvoton_write_buf(client, TPM_STS, 1, &data);
114 usleep_range(TPM_I2C_BUS_DELAY, TPM_I2C_BUS_DELAY
115 + TPM_I2C_DELAY_RANGE);
120 /* write commandReady to TPM_STS register */
121 static void i2c_nuvoton_ready(struct tpm_chip *chip)
123 struct i2c_client *client = to_i2c_client(chip->dev.parent);
126 /* this causes the current command to be aborted */
127 status = i2c_nuvoton_write_status(client, TPM_STS_COMMAND_READY);
130 "%s() fail to write TPM_STS.commandReady\n", __func__);
133 /* read burstCount field from TPM_STS register
134 * return -1 on fail to read */
135 static int i2c_nuvoton_get_burstcount(struct i2c_client *client,
136 struct tpm_chip *chip)
138 unsigned long stop = jiffies + chip->timeout_d;
140 int burst_count = -1;
143 /* wait for burstcount to be non-zero */
145 /* in I2C burstCount is 1 byte */
146 status = i2c_nuvoton_read_buf(client, TPM_BURST_COUNT, 1,
148 if (status > 0 && data > 0) {
149 burst_count = min_t(u8, TPM_I2C_MAX_BUF_SIZE, data);
152 usleep_range(TPM_I2C_BUS_DELAY, TPM_I2C_BUS_DELAY
153 + TPM_I2C_DELAY_RANGE);
154 } while (time_before(jiffies, stop));
160 * WPCT301/NPCT501/NPCT6XX SINT# supports only dataAvail
161 * any call to this function which is not waiting for dataAvail will
162 * set queue to NULL to avoid waiting for interrupt
164 static bool i2c_nuvoton_check_status(struct tpm_chip *chip, u8 mask, u8 value)
166 u8 status = i2c_nuvoton_read_status(chip);
167 return (status != TPM_STS_ERR_VAL) && ((status & mask) == value);
170 static int i2c_nuvoton_wait_for_stat(struct tpm_chip *chip, u8 mask, u8 value,
171 u32 timeout, wait_queue_head_t *queue)
173 if ((chip->flags & TPM_CHIP_FLAG_IRQ) && queue) {
175 struct priv_data *priv = dev_get_drvdata(&chip->dev);
176 unsigned int cur_intrs = priv->intrs;
178 enable_irq(priv->irq);
179 rc = wait_event_interruptible_timeout(*queue,
180 cur_intrs != priv->intrs,
184 /* At this point we know that the SINT pin is asserted, so we
185 * do not need to do i2c_nuvoton_check_status */
187 unsigned long ten_msec, stop;
190 /* check current status */
191 status_valid = i2c_nuvoton_check_status(chip, mask, value);
195 /* use polling to wait for the event */
196 ten_msec = jiffies + usecs_to_jiffies(TPM_I2C_RETRY_DELAY_LONG);
197 stop = jiffies + timeout;
199 if (time_before(jiffies, ten_msec))
200 usleep_range(TPM_I2C_RETRY_DELAY_SHORT,
201 TPM_I2C_RETRY_DELAY_SHORT
202 + TPM_I2C_DELAY_RANGE);
204 usleep_range(TPM_I2C_RETRY_DELAY_LONG,
205 TPM_I2C_RETRY_DELAY_LONG
206 + TPM_I2C_DELAY_RANGE);
207 status_valid = i2c_nuvoton_check_status(chip, mask,
211 } while (time_before(jiffies, stop));
213 dev_err(&chip->dev, "%s(%02x, %02x) -> timeout\n", __func__, mask,
218 /* wait for dataAvail field to be set in the TPM_STS register */
219 static int i2c_nuvoton_wait_for_data_avail(struct tpm_chip *chip, u32 timeout,
220 wait_queue_head_t *queue)
222 return i2c_nuvoton_wait_for_stat(chip,
223 TPM_STS_DATA_AVAIL | TPM_STS_VALID,
224 TPM_STS_DATA_AVAIL | TPM_STS_VALID,
228 /* Read @count bytes into @buf from TPM_RD_FIFO register */
229 static int i2c_nuvoton_recv_data(struct i2c_client *client,
230 struct tpm_chip *chip, u8 *buf, size_t count)
232 struct priv_data *priv = dev_get_drvdata(&chip->dev);
234 int burst_count, bytes2read, size = 0;
236 while (size < count &&
237 i2c_nuvoton_wait_for_data_avail(chip,
239 &priv->read_queue) == 0) {
240 burst_count = i2c_nuvoton_get_burstcount(client, chip);
241 if (burst_count < 0) {
243 "%s() fail to read burstCount=%d\n", __func__,
247 bytes2read = min_t(size_t, burst_count, count - size);
248 rc = i2c_nuvoton_read_buf(client, TPM_DATA_FIFO_R,
249 bytes2read, &buf[size]);
252 "%s() fail on i2c_nuvoton_read_buf()=%d\n",
256 dev_dbg(&chip->dev, "%s(%d):", __func__, bytes2read);
263 /* Read TPM command results */
264 static int i2c_nuvoton_recv(struct tpm_chip *chip, u8 *buf, size_t count)
266 struct priv_data *priv = dev_get_drvdata(&chip->dev);
267 struct device *dev = chip->dev.parent;
268 struct i2c_client *client = to_i2c_client(dev);
276 if (count < TPM_HEADER_SIZE) {
277 i2c_nuvoton_ready(chip); /* return to idle */
278 dev_err(dev, "%s() count < header size\n", __func__);
281 for (retries = 0; retries < TPM_I2C_RETRIES; retries++) {
283 /* if this is not the first trial, set responseRetry */
284 i2c_nuvoton_write_status(client,
285 TPM_STS_RESPONSE_RETRY);
288 * read first available (> 10 bytes), including:
289 * tag, paramsize, and result
291 status = i2c_nuvoton_wait_for_data_avail(
292 chip, chip->timeout_c, &priv->read_queue);
294 dev_err(dev, "%s() timeout on dataAvail\n", __func__);
298 burst_count = i2c_nuvoton_get_burstcount(client, chip);
299 if (burst_count < 0) {
300 dev_err(dev, "%s() fail to get burstCount\n", __func__);
304 size = i2c_nuvoton_recv_data(client, chip, buf,
306 if (size < TPM_HEADER_SIZE) {
307 dev_err(dev, "%s() fail to read header\n", __func__);
312 * convert number of expected bytes field from big endian 32 bit
315 expected = be32_to_cpu(*(__be32 *) (buf + 2));
316 if (expected > count || expected < size) {
317 dev_err(dev, "%s() expected > count\n", __func__);
321 rc = i2c_nuvoton_recv_data(client, chip, &buf[size],
324 if (rc < 0 || size < expected) {
325 dev_err(dev, "%s() fail to read remainder of result\n",
330 if (i2c_nuvoton_wait_for_stat(
331 chip, TPM_STS_VALID | TPM_STS_DATA_AVAIL,
332 TPM_STS_VALID, chip->timeout_c,
334 dev_err(dev, "%s() error left over data\n", __func__);
340 i2c_nuvoton_ready(chip);
341 dev_dbg(&chip->dev, "%s() -> %d\n", __func__, size);
348 * If interrupts are used (signaled by an irq set in the vendor structure)
349 * tpm.c can skip polling for the data to be available as the interrupt is
352 static int i2c_nuvoton_send(struct tpm_chip *chip, u8 *buf, size_t len)
354 struct priv_data *priv = dev_get_drvdata(&chip->dev);
355 struct device *dev = chip->dev.parent;
356 struct i2c_client *client = to_i2c_client(dev);
358 unsigned long duration;
360 int burst_count, bytes2write, retries, rc = -EIO;
362 for (retries = 0; retries < TPM_RETRY; retries++) {
363 i2c_nuvoton_ready(chip);
364 if (i2c_nuvoton_wait_for_stat(chip, TPM_STS_COMMAND_READY,
365 TPM_STS_COMMAND_READY,
366 chip->timeout_b, NULL)) {
367 dev_err(dev, "%s() timeout on commandReady\n",
373 while (count < len - 1) {
374 burst_count = i2c_nuvoton_get_burstcount(client,
376 if (burst_count < 0) {
377 dev_err(dev, "%s() fail get burstCount\n",
382 bytes2write = min_t(size_t, burst_count,
384 rc = i2c_nuvoton_write_buf(client, TPM_DATA_FIFO_W,
385 bytes2write, &buf[count]);
387 dev_err(dev, "%s() fail i2cWriteBuf\n",
391 dev_dbg(dev, "%s(%d):", __func__, bytes2write);
392 count += bytes2write;
393 rc = i2c_nuvoton_wait_for_stat(chip,
401 dev_err(dev, "%s() timeout on Expect\n",
410 /* write last byte */
411 rc = i2c_nuvoton_write_buf(client, TPM_DATA_FIFO_W, 1,
414 dev_err(dev, "%s() fail to write last byte\n",
419 dev_dbg(dev, "%s(last): %02x", __func__, buf[count]);
420 rc = i2c_nuvoton_wait_for_stat(chip,
421 TPM_STS_VALID | TPM_STS_EXPECT,
423 chip->timeout_c, NULL);
425 dev_err(dev, "%s() timeout on Expect to clear\n",
433 /* retries == TPM_RETRY */
434 i2c_nuvoton_ready(chip);
437 /* execute the TPM command */
438 rc = i2c_nuvoton_write_status(client, TPM_STS_GO);
440 dev_err(dev, "%s() fail to write Go\n", __func__);
441 i2c_nuvoton_ready(chip);
444 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
445 duration = tpm_calc_ordinal_duration(chip, ordinal);
447 rc = i2c_nuvoton_wait_for_data_avail(chip, duration, &priv->read_queue);
449 dev_err(dev, "%s() timeout command duration %ld\n",
451 i2c_nuvoton_ready(chip);
455 dev_dbg(dev, "%s() -> %zd\n", __func__, len);
459 static bool i2c_nuvoton_req_canceled(struct tpm_chip *chip, u8 status)
461 return (status == TPM_STS_COMMAND_READY);
464 static const struct tpm_class_ops tpm_i2c = {
465 .flags = TPM_OPS_AUTO_STARTUP,
466 .status = i2c_nuvoton_read_status,
467 .recv = i2c_nuvoton_recv,
468 .send = i2c_nuvoton_send,
469 .cancel = i2c_nuvoton_ready,
470 .req_complete_mask = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
471 .req_complete_val = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
472 .req_canceled = i2c_nuvoton_req_canceled,
475 /* The only purpose for the handler is to signal to any waiting threads that
476 * the interrupt is currently being asserted. The driver does not do any
477 * processing triggered by interrupts, and the chip provides no way to mask at
478 * the source (plus that would be slow over I2C). Run the IRQ as a one-shot,
479 * this means it cannot be shared. */
480 static irqreturn_t i2c_nuvoton_int_handler(int dummy, void *dev_id)
482 struct tpm_chip *chip = dev_id;
483 struct priv_data *priv = dev_get_drvdata(&chip->dev);
486 wake_up(&priv->read_queue);
487 disable_irq_nosync(priv->irq);
491 static int get_vid(struct i2c_client *client, u32 *res)
493 static const u8 vid_did_rid_value[] = { 0x50, 0x10, 0xfe };
497 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
499 rc = i2c_nuvoton_read_buf(client, TPM_VID_DID_RID, 4, (u8 *)&temp);
503 /* check WPCT301 values - ignore RID */
504 if (memcmp(&temp, vid_did_rid_value, sizeof(vid_did_rid_value))) {
506 * f/w rev 2.81 has an issue where the VID_DID_RID is not
507 * reporting the right value. so give it another chance at
508 * offset 0x20 (FIFO_W).
510 rc = i2c_nuvoton_read_buf(client, TPM_DATA_FIFO_W, 4,
515 /* check WPCT301 values - ignore RID */
516 if (memcmp(&temp, vid_did_rid_value,
517 sizeof(vid_did_rid_value)))
525 static int i2c_nuvoton_probe(struct i2c_client *client)
527 const struct i2c_device_id *id = i2c_client_get_device_id(client);
529 struct tpm_chip *chip;
530 struct device *dev = &client->dev;
531 struct priv_data *priv;
534 rc = get_vid(client, &vid);
538 dev_info(dev, "VID: %04X DID: %02X RID: %02X\n", (u16) vid,
539 (u8) (vid >> 16), (u8) (vid >> 24));
541 chip = tpmm_chip_alloc(dev, &tpm_i2c);
543 return PTR_ERR(chip);
545 priv = devm_kzalloc(dev, sizeof(struct priv_data), GFP_KERNEL);
550 const struct of_device_id *of_id;
552 of_id = of_match_device(dev->driver->of_match_table, dev);
553 if (of_id && of_id->data == OF_IS_TPM2)
554 chip->flags |= TPM_CHIP_FLAG_TPM2;
556 if (id->driver_data == I2C_IS_TPM2)
557 chip->flags |= TPM_CHIP_FLAG_TPM2;
559 init_waitqueue_head(&priv->read_queue);
561 /* Default timeouts */
562 chip->timeout_a = msecs_to_jiffies(TPM_I2C_SHORT_TIMEOUT);
563 chip->timeout_b = msecs_to_jiffies(TPM_I2C_LONG_TIMEOUT);
564 chip->timeout_c = msecs_to_jiffies(TPM_I2C_SHORT_TIMEOUT);
565 chip->timeout_d = msecs_to_jiffies(TPM_I2C_SHORT_TIMEOUT);
567 dev_set_drvdata(&chip->dev, priv);
570 * I2C intfcaps (interrupt capabilitieis) in the chip are hard coded to:
571 * TPM_INTF_INT_LEVEL_LOW | TPM_INTF_DATA_AVAIL_INT
572 * The IRQ should be set in the i2c_board_info (which is done
573 * automatically in of_i2c_register_devices, for device tree users */
574 priv->irq = client->irq;
576 dev_dbg(dev, "%s() priv->irq\n", __func__);
577 rc = devm_request_irq(dev, client->irq,
578 i2c_nuvoton_int_handler,
580 dev_name(&chip->dev),
583 dev_err(dev, "%s() Unable to request irq: %d for use\n",
584 __func__, priv->irq);
587 chip->flags |= TPM_CHIP_FLAG_IRQ;
588 /* Clear any pending interrupt */
589 i2c_nuvoton_ready(chip);
590 /* - wait for TPM_STS==0xA0 (stsValid, commandReady) */
591 rc = i2c_nuvoton_wait_for_stat(chip,
592 TPM_STS_COMMAND_READY,
593 TPM_STS_COMMAND_READY,
598 * TIS is in ready state
599 * write dummy byte to enter reception state
600 * TPM_DATA_FIFO_W <- rc (0)
602 rc = i2c_nuvoton_write_buf(client,
607 /* TPM_STS <- 0x40 (commandReady) */
608 i2c_nuvoton_ready(chip);
611 * timeout_b reached - command was
612 * aborted. TIS should now be in idle state -
613 * only TPM_STS_VALID should be set
615 if (i2c_nuvoton_read_status(chip) !=
622 return tpm_chip_register(chip);
625 static void i2c_nuvoton_remove(struct i2c_client *client)
627 struct tpm_chip *chip = i2c_get_clientdata(client);
629 tpm_chip_unregister(chip);
632 static const struct i2c_device_id i2c_nuvoton_id[] = {
634 {"tpm2_i2c_nuvoton", .driver_data = I2C_IS_TPM2},
637 MODULE_DEVICE_TABLE(i2c, i2c_nuvoton_id);
640 static const struct of_device_id i2c_nuvoton_of_match[] = {
641 {.compatible = "nuvoton,npct501"},
642 {.compatible = "winbond,wpct301"},
643 {.compatible = "nuvoton,npct601", .data = OF_IS_TPM2},
646 MODULE_DEVICE_TABLE(of, i2c_nuvoton_of_match);
649 static SIMPLE_DEV_PM_OPS(i2c_nuvoton_pm_ops, tpm_pm_suspend, tpm_pm_resume);
651 static struct i2c_driver i2c_nuvoton_driver = {
652 .id_table = i2c_nuvoton_id,
653 .probe_new = i2c_nuvoton_probe,
654 .remove = i2c_nuvoton_remove,
656 .name = "tpm_i2c_nuvoton",
657 .pm = &i2c_nuvoton_pm_ops,
658 .of_match_table = of_match_ptr(i2c_nuvoton_of_match),
662 module_i2c_driver(i2c_nuvoton_driver);
665 MODULE_DESCRIPTION("Nuvoton TPM I2C Driver");
666 MODULE_LICENSE("GPL");