1 // SPDX-License-Identifier: GPL-2.0
4 * Miquel Raynal <miquel.raynal@bootlin.com>
7 * SPI-level driver for TCG/TIS TPM (trusted platform module).
8 * Specifications at www.trustedcomputinggroup.org
10 * This device driver implements the TPM interface as defined in
11 * the TCG SPI protocol stack version 2.0.
13 * It is based on the U-Boot driver tpm_tis_infineon_i2c.c.
22 #include <linux/errno.h>
23 #include <linux/compiler.h>
24 #include <linux/types.h>
25 #include <linux/unaligned/be_byteshift.h>
28 #include "tpm_internal.h"
30 DECLARE_GLOBAL_DATA_PTR;
32 #define TPM_ACCESS(l) (0x0000 | ((l) << 12))
33 #define TPM_INT_ENABLE(l) (0x0008 | ((l) << 12))
34 #define TPM_STS(l) (0x0018 | ((l) << 12))
35 #define TPM_DATA_FIFO(l) (0x0024 | ((l) << 12))
36 #define TPM_DID_VID(l) (0x0F00 | ((l) << 12))
37 #define TPM_RID(l) (0x0F04 | ((l) << 12))
39 #define MAX_SPI_FRAMESIZE 64
41 /* Number of wait states to wait for */
42 #define TPM_WAIT_STATES 100
45 * struct tpm_tis_chip_data - Non-discoverable TPM information
47 * @pcr_count: Number of PCR per bank
48 * @pcr_select_min: Size in octets of the pcrSelect array
50 struct tpm_tis_chip_data {
51 unsigned int pcr_count;
52 unsigned int pcr_select_min;
53 unsigned int time_before_first_cmd_ms;
57 * tpm_tis_spi_read() - Read from TPM register
59 * @addr: register address to read from
60 * @buffer: provided by caller
61 * @len: number of bytes to read
63 * Read len bytes from TPM register and put them into
64 * buffer (little-endian format, i.e. first byte is put into buffer[0]).
66 * NOTE: TPM is big-endian for multi-byte values. Multi-byte
67 * values have to be swapped.
69 * @return -EIO on error, 0 on success.
71 static int tpm_tis_spi_xfer(struct udevice *dev, u32 addr, const u8 *out,
74 struct spi_slave *slave = dev_get_parent_priv(dev);
75 int transfer_len, ret;
76 u8 tx_buf[MAX_SPI_FRAMESIZE];
77 u8 rx_buf[MAX_SPI_FRAMESIZE];
80 log(LOGC_NONE, LOGL_ERR, "%s: can't do full duplex\n",
85 ret = spi_claim_bus(slave);
87 log(LOGC_NONE, LOGL_ERR, "%s: could not claim bus\n", __func__);
93 transfer_len = min_t(u16, len, MAX_SPI_FRAMESIZE);
94 tx_buf[0] = (in ? BIT(7) : 0) | (transfer_len - 1);
96 tx_buf[2] = addr >> 8;
99 ret = spi_xfer(slave, 4 * 8, tx_buf, rx_buf, SPI_XFER_BEGIN);
101 log(LOGC_NONE, LOGL_ERR,
102 "%s: spi request transfer failed (err: %d)\n",
108 if (!(rx_buf[3] & 0x1)) {
111 for (i = 0; i < TPM_WAIT_STATES; i++) {
112 ret = spi_xfer(slave, 1 * 8, NULL, rx_buf, 0);
114 log(LOGC_NONE, LOGL_ERR,
115 "%s: wait state failed: %d\n",
124 if (i == TPM_WAIT_STATES) {
125 log(LOGC_NONE, LOGL_ERR,
126 "%s: timeout on wait state\n", __func__);
134 memcpy(tx_buf, out, transfer_len);
138 ret = spi_xfer(slave, transfer_len * 8,
143 log(LOGC_NONE, LOGL_ERR,
144 "%s: spi read transfer failed (err: %d)\n",
150 memcpy(in, rx_buf, transfer_len);
158 /* If an error occurred, release the chip by deasserting the CS */
160 spi_xfer(slave, 0, NULL, NULL, SPI_XFER_END);
162 spi_release_bus(slave);
167 static int tpm_tis_spi_read(struct udevice *dev, u16 addr, u8 *in, u16 len)
169 return tpm_tis_spi_xfer(dev, addr, NULL, in, len);
172 static int tpm_tis_spi_read32(struct udevice *dev, u32 addr, u32 *result)
177 ret = tpm_tis_spi_read(dev, addr, (u8 *)&result_le, sizeof(u32));
179 *result = le32_to_cpu(result_le);
184 static int tpm_tis_spi_write(struct udevice *dev, u16 addr, const u8 *out,
187 return tpm_tis_spi_xfer(dev, addr, out, NULL, len);
190 static int tpm_tis_spi_check_locality(struct udevice *dev, int loc)
192 const u8 mask = TPM_ACCESS_ACTIVE_LOCALITY | TPM_ACCESS_VALID;
193 struct tpm_chip *chip = dev_get_priv(dev);
197 ret = tpm_tis_spi_read(dev, TPM_ACCESS(loc), &buf, 1);
201 if ((buf & mask) == mask) {
202 chip->locality = loc;
209 static void tpm_tis_spi_release_locality(struct udevice *dev, int loc,
212 const u8 mask = TPM_ACCESS_REQUEST_PENDING | TPM_ACCESS_VALID;
215 if (tpm_tis_spi_read(dev, TPM_ACCESS(loc), &buf, 1) < 0)
218 if (force || (buf & mask) == mask) {
219 buf = TPM_ACCESS_ACTIVE_LOCALITY;
220 tpm_tis_spi_write(dev, TPM_ACCESS(loc), &buf, 1);
224 static int tpm_tis_spi_request_locality(struct udevice *dev, int loc)
226 struct tpm_chip *chip = dev_get_priv(dev);
227 unsigned long start, stop;
228 u8 buf = TPM_ACCESS_REQUEST_USE;
231 ret = tpm_tis_spi_check_locality(dev, loc);
235 if (ret != -ENOENT) {
236 log(LOGC_NONE, LOGL_ERR, "%s: Failed to get locality: %d\n",
241 ret = tpm_tis_spi_write(dev, TPM_ACCESS(loc), &buf, 1);
243 log(LOGC_NONE, LOGL_ERR, "%s: Failed to write to TPM: %d\n",
248 start = get_timer(0);
249 stop = chip->timeout_a;
251 ret = tpm_tis_spi_check_locality(dev, loc);
255 if (ret != -ENOENT) {
256 log(LOGC_NONE, LOGL_ERR,
257 "%s: Failed to get locality: %d\n", __func__, ret);
261 mdelay(TPM_TIMEOUT_MS);
262 } while (get_timer(start) < stop);
264 log(LOGC_NONE, LOGL_ERR, "%s: Timeout getting locality: %d\n", __func__,
270 static u8 tpm_tis_spi_status(struct udevice *dev, u8 *status)
272 struct tpm_chip *chip = dev_get_priv(dev);
274 return tpm_tis_spi_read(dev, TPM_STS(chip->locality), status, 1);
277 static int tpm_tis_spi_wait_for_stat(struct udevice *dev, u8 mask,
278 unsigned long timeout, u8 *status)
280 unsigned long start = get_timer(0);
281 unsigned long stop = timeout;
285 mdelay(TPM_TIMEOUT_MS);
286 ret = tpm_tis_spi_status(dev, status);
290 if ((*status & mask) == mask)
292 } while (get_timer(start) < stop);
297 static int tpm_tis_spi_get_burstcount(struct udevice *dev)
299 struct tpm_chip *chip = dev_get_priv(dev);
300 unsigned long start, stop;
303 /* wait for burstcount */
304 start = get_timer(0);
305 stop = chip->timeout_d;
307 ret = tpm_tis_spi_read32(dev, TPM_STS(chip->locality),
312 burstcount = (burstcount >> 8) & 0xFFFF;
316 mdelay(TPM_TIMEOUT_MS);
317 } while (get_timer(start) < stop);
322 static int tpm_tis_spi_cancel(struct udevice *dev)
324 struct tpm_chip *chip = dev_get_priv(dev);
325 u8 data = TPM_STS_COMMAND_READY;
327 return tpm_tis_spi_write(dev, TPM_STS(chip->locality), &data, 1);
330 static int tpm_tis_spi_recv_data(struct udevice *dev, u8 *buf, size_t count)
332 struct tpm_chip *chip = dev_get_priv(dev);
333 int size = 0, burstcnt, len, ret;
336 while (size < count &&
337 tpm_tis_spi_wait_for_stat(dev,
338 TPM_STS_DATA_AVAIL | TPM_STS_VALID,
339 chip->timeout_c, &status) == 0) {
340 burstcnt = tpm_tis_spi_get_burstcount(dev);
344 len = min_t(int, burstcnt, count - size);
345 ret = tpm_tis_spi_read(dev, TPM_DATA_FIFO(chip->locality),
356 static int tpm_tis_spi_recv(struct udevice *dev, u8 *buf, size_t count)
358 struct tpm_chip *chip = dev_get_priv(dev);
364 if (count < TPM_HEADER_SIZE) {
369 size = tpm_tis_spi_recv_data(dev, buf, TPM_HEADER_SIZE);
370 if (size < TPM_HEADER_SIZE) {
371 log(LOGC_NONE, LOGL_ERR, "TPM error, unable to read header\n");
375 expected = get_unaligned_be32(buf + 2);
376 if (expected > count) {
381 size += tpm_tis_spi_recv_data(dev, &buf[TPM_HEADER_SIZE],
382 expected - TPM_HEADER_SIZE);
383 if (size < expected) {
384 log(LOGC_NONE, LOGL_ERR,
385 "TPM error, unable to read remaining bytes of result\n");
391 tpm_tis_spi_cancel(dev);
392 tpm_tis_spi_release_locality(dev, chip->locality, false);
397 static int tpm_tis_spi_send(struct udevice *dev, const u8 *buf, size_t len)
399 struct tpm_chip *chip = dev_get_priv(dev);
408 if (len > TPM_DEV_BUFSIZE)
409 return -E2BIG; /* Command is too long for our tpm, sorry */
411 ret = tpm_tis_spi_request_locality(dev, 0);
416 * Check if the TPM is ready. If not, if not, cancel the pending command
417 * and poll on the status to be finally ready.
419 ret = tpm_tis_spi_status(dev, &status);
423 if (!(status & TPM_STS_COMMAND_READY)) {
424 /* Force the transition, usually this will be done at startup */
425 ret = tpm_tis_spi_cancel(dev);
427 log(LOGC_NONE, LOGL_ERR,
428 "%s: Could not cancel previous operation\n",
433 ret = tpm_tis_spi_wait_for_stat(dev, TPM_STS_COMMAND_READY,
434 chip->timeout_b, &status);
435 if (ret < 0 || !(status & TPM_STS_COMMAND_READY)) {
436 log(LOGC_NONE, LOGL_ERR,
437 "status %d after wait for stat returned %d\n",
443 for (i = 0; i < len - 1;) {
444 burstcnt = tpm_tis_spi_get_burstcount(dev);
448 size = min_t(int, len - i - 1, burstcnt);
449 ret = tpm_tis_spi_write(dev, TPM_DATA_FIFO(chip->locality),
457 ret = tpm_tis_spi_status(dev, &status);
461 if ((status & TPM_STS_DATA_EXPECT) == 0) {
466 ret = tpm_tis_spi_write(dev, TPM_DATA_FIFO(chip->locality),
471 ret = tpm_tis_spi_status(dev, &status);
475 if ((status & TPM_STS_DATA_EXPECT) != 0) {
481 ret = tpm_tis_spi_write(dev, TPM_STS(chip->locality), &data, 1);
488 tpm_tis_spi_cancel(dev);
489 tpm_tis_spi_release_locality(dev, chip->locality, false);
494 static int tpm_tis_spi_cleanup(struct udevice *dev)
496 struct tpm_chip *chip = dev_get_priv(dev);
498 tpm_tis_spi_cancel(dev);
500 * The TPM needs some time to clean up here,
501 * so we sleep rather than keeping the bus busy
504 tpm_tis_spi_release_locality(dev, chip->locality, false);
509 static int tpm_tis_spi_open(struct udevice *dev)
511 struct tpm_chip *chip = dev_get_priv(dev);
521 static int tpm_tis_spi_close(struct udevice *dev)
523 struct tpm_chip *chip = dev_get_priv(dev);
526 tpm_tis_spi_release_locality(dev, chip->locality, true);
533 static int tpm_tis_get_desc(struct udevice *dev, char *buf, int size)
535 struct tpm_chip *chip = dev_get_priv(dev);
540 return snprintf(buf, size,
541 "%s v2.0: VendorID 0x%04x, DeviceID 0x%04x, RevisionID 0x%02x [%s]",
542 dev->name, chip->vend_dev & 0xFFFF,
543 chip->vend_dev >> 16, chip->rid,
544 (chip->is_open ? "open" : "closed"));
547 static int tpm_tis_wait_init(struct udevice *dev, int loc)
549 struct tpm_chip *chip = dev_get_priv(dev);
550 unsigned long start, stop;
554 start = get_timer(0);
555 stop = chip->timeout_b;
557 mdelay(TPM_TIMEOUT_MS);
559 ret = tpm_tis_spi_read(dev, TPM_ACCESS(loc), &status, 1);
563 if (status & TPM_ACCESS_VALID)
565 } while (get_timer(start) < stop);
570 static int tpm_tis_spi_probe(struct udevice *dev)
572 struct tpm_tis_chip_data *drv_data = (void *)dev_get_driver_data(dev);
573 struct tpm_chip_priv *priv = dev_get_uclass_priv(dev);
574 struct tpm_chip *chip = dev_get_priv(dev);
577 /* Ensure a minimum amount of time elapsed since reset of the TPM */
578 mdelay(drv_data->time_before_first_cmd_ms);
581 chip->timeout_a = TIS_SHORT_TIMEOUT_MS;
582 chip->timeout_b = TIS_LONG_TIMEOUT_MS;
583 chip->timeout_c = TIS_SHORT_TIMEOUT_MS;
584 chip->timeout_d = TIS_SHORT_TIMEOUT_MS;
585 priv->pcr_count = drv_data->pcr_count;
586 priv->pcr_select_min = drv_data->pcr_select_min;
588 ret = tpm_tis_wait_init(dev, chip->locality);
590 log(LOGC_DM, LOGL_ERR, "%s: no device found\n", __func__);
594 ret = tpm_tis_spi_request_locality(dev, chip->locality);
596 log(LOGC_NONE, LOGL_ERR, "%s: could not request locality %d\n",
597 __func__, chip->locality);
601 ret = tpm_tis_spi_read32(dev, TPM_DID_VID(chip->locality),
604 log(LOGC_NONE, LOGL_ERR,
605 "%s: could not retrieve VendorID/DeviceID\n", __func__);
609 ret = tpm_tis_spi_read(dev, TPM_RID(chip->locality), &chip->rid, 1);
611 log(LOGC_NONE, LOGL_ERR, "%s: could not retrieve RevisionID\n",
616 log(LOGC_NONE, LOGL_ERR,
617 "SPI TPMv2.0 found (vid:%04x, did:%04x, rid:%02x)\n",
618 chip->vend_dev & 0xFFFF, chip->vend_dev >> 16, chip->rid);
623 static int tpm_tis_spi_remove(struct udevice *dev)
625 struct tpm_chip *chip = dev_get_priv(dev);
627 tpm_tis_spi_release_locality(dev, chip->locality, true);
632 static const struct tpm_ops tpm_tis_spi_ops = {
633 .open = tpm_tis_spi_open,
634 .close = tpm_tis_spi_close,
635 .get_desc = tpm_tis_get_desc,
636 .send = tpm_tis_spi_send,
637 .recv = tpm_tis_spi_recv,
638 .cleanup = tpm_tis_spi_cleanup,
641 static const struct tpm_tis_chip_data tpm_tis_std_chip_data = {
644 .time_before_first_cmd_ms = 30,
647 static const struct udevice_id tpm_tis_spi_ids[] = {
649 .compatible = "tis,tpm2-spi",
650 .data = (ulong)&tpm_tis_std_chip_data,
655 U_BOOT_DRIVER(tpm_tis_spi) = {
656 .name = "tpm_tis_spi",
658 .of_match = tpm_tis_spi_ids,
659 .ops = &tpm_tis_spi_ops,
660 .probe = tpm_tis_spi_probe,
661 .remove = tpm_tis_spi_remove,
662 .priv_auto_alloc_size = sizeof(struct tpm_chip),