2 * Copyright (C) 2011 Infineon Technologies
5 * Peter Huewe <huewe.external@infineon.com>
8 * Device driver for TCG/TCPA TPM (trusted platform module).
9 * Specifications at www.trustedcomputinggroup.org
11 * This device driver implements the TPM interface as defined in
12 * the TCG TPM Interface Spec version 1.2, revision 1.0 and the
13 * Infineon I2C Protocol Stack Specification v0.20.
15 * It is based on the Linux kernel driver tpm.c from Leendert van
16 * Dorn, Dave Safford, Reiner Sailer, and Kyleen Hall.
20 * See file CREDITS for list of people who contributed to this
23 * This program is free software; you can redistribute it and/or
24 * modify it under the terms of the GNU General Public License as
25 * published by the Free Software Foundation, version 2 of the
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program; if not, write to the Free Software
35 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
44 #include <asm-generic/errno.h>
45 #include <linux/types.h>
46 #include <linux/unaligned/be_byteshift.h>
48 #include "tpm_private.h"
50 DECLARE_GLOBAL_DATA_PTR
;
52 /* Address of the TPM on the I2C bus */
53 #define TPM_I2C_ADDR 0x20
55 /* Max buffer size supported by our tpm */
56 #define TPM_DEV_BUFSIZE 1260
58 /* Max number of iterations after i2c NAK */
62 * Max number of iterations after i2c NAK for 'long' commands
64 * We need this especially for sending TPM_READY, since the cleanup after the
65 * transtion to the ready state may take some time, but it is unpredictable
66 * how long it will take.
68 #define MAX_COUNT_LONG 50
70 #define SLEEP_DURATION 60 /* in usec */
71 #define SLEEP_DURATION_LONG 210 /* in usec */
73 #define TPM_HEADER_SIZE 10
76 * Expected value for DIDVID register
78 * The only device the system knows about at this moment is Infineon slb9635.
80 #define TPM_TIS_I2C_DID_VID 0x000b15d1L
83 TPM_ACCESS_VALID
= 0x80,
84 TPM_ACCESS_ACTIVE_LOCALITY
= 0x20,
85 TPM_ACCESS_REQUEST_PENDING
= 0x04,
86 TPM_ACCESS_REQUEST_USE
= 0x02,
91 TPM_STS_COMMAND_READY
= 0x40,
93 TPM_STS_DATA_AVAIL
= 0x10,
94 TPM_STS_DATA_EXPECT
= 0x08,
98 TIS_SHORT_TIMEOUT
= 750, /* ms */
99 TIS_LONG_TIMEOUT
= 2000, /* ms */
102 /* expected value for DIDVID register */
103 #define TPM_TIS_I2C_DID_VID_9635 0x000b15d1L
104 #define TPM_TIS_I2C_DID_VID_9645 0x001a15d1L
112 static const char * const chip_name
[] = {
113 [SLB9635
] = "slb9635tt",
114 [SLB9645
] = "slb9645tt",
115 [UNKNOWN
] = "unknown/fallback to slb9635",
118 #define TPM_ACCESS(l) (0x0000 | ((l) << 4))
119 #define TPM_STS(l) (0x0001 | ((l) << 4))
120 #define TPM_DATA_FIFO(l) (0x0005 | ((l) << 4))
121 #define TPM_DID_VID(l) (0x0006 | ((l) << 4))
123 /* Structure to store I2C TPM specific stuff */
126 u8 buf
[TPM_DEV_BUFSIZE
+ sizeof(u8
)]; /* Max buffer size + addr */
127 enum i2c_chip_type chip_type
;
130 static struct tpm_dev tpm_dev
= {
134 static struct tpm_dev tpm_dev
;
137 * iic_tpm_read() - read from TPM register
138 * @addr: register address to read from
139 * @buffer: provided by caller
140 * @len: number of bytes to read
142 * Read len bytes from TPM register and put them into
143 * buffer (little-endian format, i.e. first byte is put into buffer[0]).
145 * NOTE: TPM is big-endian for multi-byte values. Multi-byte
146 * values have to be swapped.
148 * Return -EIO on error, 0 on success.
150 static int iic_tpm_read(u8 addr
, u8
*buffer
, size_t len
)
154 uint32_t addrbuf
= addr
;
156 if ((tpm_dev
.chip_type
== SLB9635
) || (tpm_dev
.chip_type
== UNKNOWN
)) {
157 /* slb9635 protocol should work in both cases */
158 for (count
= 0; count
< MAX_COUNT
; count
++) {
159 rc
= i2c_write(tpm_dev
.addr
, 0, 0,
160 (uchar
*)&addrbuf
, 1);
162 break; /* Success, break to skip sleep */
163 udelay(SLEEP_DURATION
);
168 /* After the TPM has successfully received the register address
169 * it needs some time, thus we're sleeping here again, before
170 * retrieving the data
172 for (count
= 0; count
< MAX_COUNT
; count
++) {
173 udelay(SLEEP_DURATION
);
174 rc
= i2c_read(tpm_dev
.addr
, 0, 0, buffer
, len
);
176 break; /* success, break to skip sleep */
180 * Use a combined read for newer chips.
181 * Unfortunately the smbus functions are not suitable due to
182 * the 32 byte limit of the smbus.
183 * Retries should usually not be needed, but are kept just to
184 * be safe on the safe side.
186 for (count
= 0; count
< MAX_COUNT
; count
++) {
187 rc
= i2c_read(tpm_dev
.addr
, addr
, 1, buffer
, len
);
189 break; /* break here to skip sleep */
190 udelay(SLEEP_DURATION
);
194 /* Take care of 'guard time' */
195 udelay(SLEEP_DURATION
);
202 static int iic_tpm_write_generic(u8 addr
, u8
*buffer
, size_t len
,
203 unsigned int sleep_time
, u8 max_count
)
208 /* Prepare send buffer */
209 tpm_dev
.buf
[0] = addr
;
210 memcpy(&(tpm_dev
.buf
[1]), buffer
, len
);
212 for (count
= 0; count
< max_count
; count
++) {
213 rc
= i2c_write(tpm_dev
.addr
, 0, 0, tpm_dev
.buf
, len
+ 1);
215 break; /* Success, break to skip sleep */
219 /* take care of 'guard time' */
220 udelay(SLEEP_DURATION
);
228 * iic_tpm_write() - write to TPM register
229 * @addr: register address to write to
230 * @buffer: containing data to be written
231 * @len: number of bytes to write
233 * Write len bytes from provided buffer to TPM register (little
234 * endian format, i.e. buffer[0] is written as first byte).
236 * NOTE: TPM is big-endian for multi-byte values. Multi-byte
237 * values have to be swapped.
239 * NOTE: use this function instead of the iic_tpm_write_generic function.
241 * Return -EIO on error, 0 on success
243 static int iic_tpm_write(u8 addr
, u8
*buffer
, size_t len
)
245 return iic_tpm_write_generic(addr
, buffer
, len
, SLEEP_DURATION
,
250 * This function is needed especially for the cleanup situation after
253 static int iic_tpm_write_long(u8 addr
, u8
*buffer
, size_t len
)
255 return iic_tpm_write_generic(addr
, buffer
, len
, SLEEP_DURATION_LONG
,
259 static int check_locality(struct tpm_chip
*chip
, int loc
)
261 const u8 mask
= TPM_ACCESS_ACTIVE_LOCALITY
| TPM_ACCESS_VALID
;
265 rc
= iic_tpm_read(TPM_ACCESS(loc
), &buf
, 1);
269 if ((buf
& mask
) == mask
) {
270 chip
->vendor
.locality
= loc
;
277 static void release_locality(struct tpm_chip
*chip
, int loc
, int force
)
279 const u8 mask
= TPM_ACCESS_REQUEST_PENDING
| TPM_ACCESS_VALID
;
282 if (iic_tpm_read(TPM_ACCESS(loc
), &buf
, 1) < 0)
285 if (force
|| (buf
& mask
) == mask
) {
286 buf
= TPM_ACCESS_ACTIVE_LOCALITY
;
287 iic_tpm_write(TPM_ACCESS(loc
), &buf
, 1);
291 static int request_locality(struct tpm_chip
*chip
, int loc
)
293 unsigned long start
, stop
;
294 u8 buf
= TPM_ACCESS_REQUEST_USE
;
296 if (check_locality(chip
, loc
) >= 0)
297 return loc
; /* We already have the locality */
299 iic_tpm_write(TPM_ACCESS(loc
), &buf
, 1);
301 /* Wait for burstcount */
302 start
= get_timer(0);
303 stop
= chip
->vendor
.timeout_a
;
305 if (check_locality(chip
, loc
) >= 0)
307 udelay(TPM_TIMEOUT
* 1000);
308 } while (get_timer(start
) < stop
);
313 static u8
tpm_tis_i2c_status(struct tpm_chip
*chip
)
315 /* NOTE: Since i2c read may fail, return 0 in this case --> time-out */
318 if (iic_tpm_read(TPM_STS(chip
->vendor
.locality
), &buf
, 1) < 0)
324 static void tpm_tis_i2c_ready(struct tpm_chip
*chip
)
326 /* This causes the current command to be aborted */
327 u8 buf
= TPM_STS_COMMAND_READY
;
329 iic_tpm_write_long(TPM_STS(chip
->vendor
.locality
), &buf
, 1);
332 static ssize_t
get_burstcount(struct tpm_chip
*chip
)
334 unsigned long start
, stop
;
338 /* Wait for burstcount */
339 /* XXX: Which timeout value? Spec has 2 answers (c & d) */
340 start
= get_timer(0);
341 stop
= chip
->vendor
.timeout_d
;
343 /* Note: STS is little endian */
344 addr
= TPM_STS(chip
->vendor
.locality
) + 1;
345 if (iic_tpm_read(addr
, buf
, 3) < 0)
348 burstcnt
= (buf
[2] << 16) + (buf
[1] << 8) + buf
[0];
352 udelay(TPM_TIMEOUT
* 1000);
353 } while (get_timer(start
) < stop
);
358 static int wait_for_stat(struct tpm_chip
*chip
, u8 mask
, unsigned long timeout
,
361 unsigned long start
, stop
;
363 /* Check current status */
364 *status
= tpm_tis_i2c_status(chip
);
365 if ((*status
& mask
) == mask
)
368 start
= get_timer(0);
371 udelay(TPM_TIMEOUT
* 1000);
372 *status
= tpm_tis_i2c_status(chip
);
373 if ((*status
& mask
) == mask
)
375 } while (get_timer(start
) < stop
);
380 static int recv_data(struct tpm_chip
*chip
, u8
*buf
, size_t count
)
386 while (size
< count
) {
387 burstcnt
= get_burstcount(chip
);
389 /* burstcount < 0 -> tpm is busy */
393 /* Limit received data to max left */
394 if (burstcnt
> (count
- size
))
395 burstcnt
= count
- size
;
397 rc
= iic_tpm_read(TPM_DATA_FIFO(chip
->vendor
.locality
),
398 &(buf
[size
]), burstcnt
);
406 static int tpm_tis_i2c_recv(struct tpm_chip
*chip
, u8
*buf
, size_t count
)
409 int expected
, status
;
411 if (count
< TPM_HEADER_SIZE
) {
416 /* Read first 10 bytes, including tag, paramsize, and result */
417 size
= recv_data(chip
, buf
, TPM_HEADER_SIZE
);
418 if (size
< TPM_HEADER_SIZE
) {
419 error("Unable to read header\n");
423 expected
= get_unaligned_be32(buf
+ TPM_RSP_SIZE_BYTE
);
424 if ((size_t)expected
> count
) {
429 size
+= recv_data(chip
, &buf
[TPM_HEADER_SIZE
],
430 expected
- TPM_HEADER_SIZE
);
431 if (size
< expected
) {
432 error("Unable to read remainder of result\n");
437 wait_for_stat(chip
, TPM_STS_VALID
, chip
->vendor
.timeout_c
, &status
);
438 if (status
& TPM_STS_DATA_AVAIL
) { /* Retry? */
439 error("Error left over data\n");
445 tpm_tis_i2c_ready(chip
);
447 * The TPM needs some time to clean up here,
448 * so we sleep rather than keeping the bus busy
451 release_locality(chip
, chip
->vendor
.locality
, 0);
456 static int tpm_tis_i2c_send(struct tpm_chip
*chip
, u8
*buf
, size_t len
)
464 if (len
> TPM_DEV_BUFSIZE
)
465 return -E2BIG
; /* Command is too long for our tpm, sorry */
467 if (request_locality(chip
, 0) < 0)
470 status
= tpm_tis_i2c_status(chip
);
471 if ((status
& TPM_STS_COMMAND_READY
) == 0) {
472 tpm_tis_i2c_ready(chip
);
473 if (wait_for_stat(chip
, TPM_STS_COMMAND_READY
,
474 chip
->vendor
.timeout_b
, &status
) < 0) {
480 burstcnt
= get_burstcount(chip
);
482 /* burstcount < 0 -> tpm is busy */
486 while (count
< len
- 1) {
487 if (burstcnt
> len
- 1 - count
)
488 burstcnt
= len
- 1 - count
;
490 #ifdef CONFIG_TPM_TIS_I2C_BURST_LIMITATION
491 if (retry
&& burstcnt
> CONFIG_TPM_TIS_I2C_BURST_LIMITATION
)
492 burstcnt
= CONFIG_TPM_TIS_I2C_BURST_LIMITATION
;
493 #endif /* CONFIG_TPM_TIS_I2C_BURST_LIMITATION */
495 rc
= iic_tpm_write(TPM_DATA_FIFO(chip
->vendor
.locality
),
496 &(buf
[count
]), burstcnt
);
501 wait_for_stat(chip
, TPM_STS_VALID
,
502 chip
->vendor
.timeout_c
, &status
);
504 if ((status
& TPM_STS_DATA_EXPECT
) == 0) {
511 /* Write last byte */
512 iic_tpm_write(TPM_DATA_FIFO(chip
->vendor
.locality
), &(buf
[count
]), 1);
513 wait_for_stat(chip
, TPM_STS_VALID
, chip
->vendor
.timeout_c
, &status
);
514 if ((status
& TPM_STS_DATA_EXPECT
) != 0) {
520 iic_tpm_write(TPM_STS(chip
->vendor
.locality
), &sts
, 1);
525 tpm_tis_i2c_ready(chip
);
527 * The TPM needs some time to clean up here,
528 * so we sleep rather than keeping the bus busy
531 release_locality(chip
, chip
->vendor
.locality
, 0);
536 static struct tpm_vendor_specific tpm_tis_i2c
= {
537 .status
= tpm_tis_i2c_status
,
538 .recv
= tpm_tis_i2c_recv
,
539 .send
= tpm_tis_i2c_send
,
540 .cancel
= tpm_tis_i2c_ready
,
541 .req_complete_mask
= TPM_STS_DATA_AVAIL
| TPM_STS_VALID
,
542 .req_complete_val
= TPM_STS_DATA_AVAIL
| TPM_STS_VALID
,
543 .req_canceled
= TPM_STS_COMMAND_READY
,
547 static enum i2c_chip_type
tpm_vendor_chip_type(void)
549 #ifdef CONFIG_OF_CONTROL
550 const void *blob
= gd
->fdt_blob
;
552 if (fdtdec_next_compatible(blob
, 0, COMPAT_INFINEON_SLB9645_TPM
) >= 0)
555 if (fdtdec_next_compatible(blob
, 0, COMPAT_INFINEON_SLB9635_TPM
) >= 0)
561 /* Initialisation of i2c tpm */
562 int tpm_vendor_init(uint32_t dev_addr
)
565 u32 expected_did_vid
;
568 struct tpm_chip
*chip
;
570 old_addr
= tpm_dev
.addr
;
572 tpm_dev
.addr
= dev_addr
;
574 tpm_dev
.chip_type
= tpm_vendor_chip_type();
576 chip
= tpm_register_hardware(&tpm_tis_i2c
);
582 /* Disable interrupts (not supported) */
583 chip
->vendor
.irq
= 0;
585 /* Default timeouts */
586 chip
->vendor
.timeout_a
= TIS_SHORT_TIMEOUT
;
587 chip
->vendor
.timeout_b
= TIS_LONG_TIMEOUT
;
588 chip
->vendor
.timeout_c
= TIS_SHORT_TIMEOUT
;
589 chip
->vendor
.timeout_d
= TIS_SHORT_TIMEOUT
;
591 if (request_locality(chip
, 0) < 0) {
596 /* Read four bytes from DID_VID register */
597 if (iic_tpm_read(TPM_DID_VID(0), (uchar
*)&vendor
, 4) < 0) {
602 if (tpm_dev
.chip_type
== SLB9635
) {
603 vendor
= be32_to_cpu(vendor
);
604 expected_did_vid
= TPM_TIS_I2C_DID_VID_9635
;
606 /* device id and byte order has changed for newer i2c tpms */
607 expected_did_vid
= TPM_TIS_I2C_DID_VID_9645
;
610 if (tpm_dev
.chip_type
!= UNKNOWN
&& vendor
!= expected_did_vid
) {
611 error("Vendor id did not match! ID was %08x\n", vendor
);
616 debug("1.2 TPM (chip type %s device-id 0x%X)\n",
617 chip_name
[tpm_dev
.chip_type
], vendor
>> 16);
620 * A timeout query to TPM can be placed here.
621 * Standard timeout values are used so far
627 release_locality(chip
, 0, 1);
630 tpm_dev
.addr
= old_addr
;
634 void tpm_vendor_cleanup(struct tpm_chip
*chip
)
636 release_locality(chip
, chip
->vendor
.locality
, 1);