[mirror_ubuntu-jammy-kernel.git] / drivers / char / tpm / tpm.h

/*
 * Copyright (C) 2004 IBM Corporation
 * Copyright (C) 2015 Intel Corporation
 *
 * Authors:
 * Leendert van Doorn <leendert@watson.ibm.com>
 * Dave Safford <safford@watson.ibm.com>
 * Reiner Sailer <sailer@watson.ibm.com>
 * Kylene Hall <kjhall@us.ibm.com>
 *
 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
 *
 * Device driver for TCG/TCPA TPM (trusted platform module).
 * Specifications at www.trustedcomputinggroup.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, version 2 of the
 * License.
 *
 */

#ifndef __TPM_H__
#define __TPM_H__

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/mutex.h>
#include <linux/sched.h>
#include <linux/platform_device.h>
#include <linux/io.h>
#include <linux/tpm.h>
#include <linux/highmem.h>
#include <linux/tpm_eventlog.h>

#ifdef CONFIG_X86
#include <asm/intel-family.h>
#endif

#define TPM_MINOR		224	/* officially assigned */
#define TPM_BUFSIZE		4096
#define TPM_NUM_DEVICES		65536
#define TPM_RETRY		50

enum tpm_timeout {
	TPM_TIMEOUT = 5,	/* msecs */
	TPM_TIMEOUT_RETRY = 100, /* msecs */
	TPM_TIMEOUT_RANGE_US = 300,	/* usecs */
	TPM_TIMEOUT_POLL = 1,	/* msecs */
	TPM_TIMEOUT_USECS_MIN = 100,      /* usecs */
	TPM_TIMEOUT_USECS_MAX = 500      /* usecs */
};

/* TPM addresses */
enum tpm_addr {
	TPM_SUPERIO_ADDR = 0x2E,
	TPM_ADDR = 0x4E,
};

#define TPM_WARN_RETRY          0x800
#define TPM_WARN_DOING_SELFTEST 0x802
#define TPM_ERR_DEACTIVATED     0x6
#define TPM_ERR_DISABLED        0x7
#define TPM_ERR_INVALID_POSTINIT 38

#define TPM_HEADER_SIZE		10

enum tpm2_const {
	TPM2_PLATFORM_PCR       =     24,
	TPM2_PCR_SELECT_MIN     = ((TPM2_PLATFORM_PCR + 7) / 8),
};

enum tpm2_timeouts {
	TPM2_TIMEOUT_A          =    750,
	TPM2_TIMEOUT_B          =   2000,
	TPM2_TIMEOUT_C          =    200,
	TPM2_TIMEOUT_D          =     30,
	TPM2_DURATION_SHORT     =     20,
	TPM2_DURATION_MEDIUM    =    750,
	TPM2_DURATION_LONG      =   2000,
	TPM2_DURATION_LONG_LONG = 300000,
	TPM2_DURATION_DEFAULT   = 120000,
};

enum tpm2_structures {
	TPM2_ST_NO_SESSIONS	= 0x8001,
	TPM2_ST_SESSIONS	= 0x8002,
};

/* Indicates from what layer of the software stack the error comes from */
#define TSS2_RC_LAYER_SHIFT	 16
#define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)

enum tpm2_return_codes {
	TPM2_RC_SUCCESS		= 0x0000,
	TPM2_RC_HASH		= 0x0083, /* RC_FMT1 */
	TPM2_RC_HANDLE		= 0x008B,
	TPM2_RC_INITIALIZE	= 0x0100, /* RC_VER1 */
	TPM2_RC_FAILURE		= 0x0101,
	TPM2_RC_DISABLED	= 0x0120,
	TPM2_RC_COMMAND_CODE    = 0x0143,
	TPM2_RC_TESTING		= 0x090A, /* RC_WARN */
	TPM2_RC_REFERENCE_H0	= 0x0910,
	TPM2_RC_RETRY		= 0x0922,
};

enum tpm2_command_codes {
	TPM2_CC_FIRST		        = 0x011F,
	TPM2_CC_HIERARCHY_CONTROL       = 0x0121,
	TPM2_CC_HIERARCHY_CHANGE_AUTH   = 0x0129,
	TPM2_CC_CREATE_PRIMARY          = 0x0131,
	TPM2_CC_SEQUENCE_COMPLETE       = 0x013E,
	TPM2_CC_SELF_TEST	        = 0x0143,
	TPM2_CC_STARTUP		        = 0x0144,
	TPM2_CC_SHUTDOWN	        = 0x0145,
	TPM2_CC_NV_READ                 = 0x014E,
	TPM2_CC_CREATE		        = 0x0153,
	TPM2_CC_LOAD		        = 0x0157,
	TPM2_CC_SEQUENCE_UPDATE         = 0x015C,
	TPM2_CC_UNSEAL		        = 0x015E,
	TPM2_CC_CONTEXT_LOAD	        = 0x0161,
	TPM2_CC_CONTEXT_SAVE	        = 0x0162,
	TPM2_CC_FLUSH_CONTEXT	        = 0x0165,
	TPM2_CC_VERIFY_SIGNATURE        = 0x0177,
	TPM2_CC_GET_CAPABILITY	        = 0x017A,
	TPM2_CC_GET_RANDOM	        = 0x017B,
	TPM2_CC_PCR_READ	        = 0x017E,
	TPM2_CC_PCR_EXTEND	        = 0x0182,
	TPM2_CC_EVENT_SEQUENCE_COMPLETE = 0x0185,
	TPM2_CC_HASH_SEQUENCE_START     = 0x0186,
	TPM2_CC_CREATE_LOADED           = 0x0191,
	TPM2_CC_LAST		        = 0x0193, /* Spec 1.36 */
};

enum tpm2_permanent_handles {
	TPM2_RS_PW		= 0x40000009,
};

enum tpm2_capabilities {
	TPM2_CAP_HANDLES	= 1,
	TPM2_CAP_COMMANDS	= 2,
	TPM2_CAP_PCRS		= 5,
	TPM2_CAP_TPM_PROPERTIES = 6,
};

enum tpm2_properties {
	TPM_PT_TOTAL_COMMANDS	= 0x0129,
};

enum tpm2_startup_types {
	TPM2_SU_CLEAR	= 0x0000,
	TPM2_SU_STATE	= 0x0001,
};

enum tpm2_cc_attrs {
	TPM2_CC_ATTR_CHANDLES	= 25,
	TPM2_CC_ATTR_RHANDLE	= 28,
};

#define TPM_VID_INTEL    0x8086
#define TPM_VID_WINBOND  0x1050
#define TPM_VID_STM      0x104A

enum tpm_chip_flags {
	TPM_CHIP_FLAG_TPM2		= BIT(1),
	TPM_CHIP_FLAG_IRQ		= BIT(2),
	TPM_CHIP_FLAG_VIRTUAL		= BIT(3),
	TPM_CHIP_FLAG_HAVE_TIMEOUTS	= BIT(4),
	TPM_CHIP_FLAG_ALWAYS_POWERED	= BIT(5),
};

#define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)

struct tpm_header {
	__be16 tag;
	__be32 length;
	union {
		__be32 ordinal;
		__be32 return_code;
	};
} __packed;

#define TPM_TAG_RQU_COMMAND 193

struct	stclear_flags_t {
	__be16	tag;
	u8	deactivated;
	u8	disableForceClear;
	u8	physicalPresence;
	u8	physicalPresenceLock;
	u8	bGlobalLock;
} __packed;

struct	tpm_version_t {
	u8	Major;
	u8	Minor;
	u8	revMajor;
	u8	revMinor;
} __packed;

struct	tpm_version_1_2_t {
	__be16	tag;
	u8	Major;
	u8	Minor;
	u8	revMajor;
	u8	revMinor;
} __packed;

struct	timeout_t {
	__be32	a;
	__be32	b;
	__be32	c;
	__be32	d;
} __packed;

struct duration_t {
	__be32	tpm_short;
	__be32	tpm_medium;
	__be32	tpm_long;
} __packed;

struct permanent_flags_t {
	__be16	tag;
	u8	disable;
	u8	ownership;
	u8	deactivated;
	u8	readPubek;
	u8	disableOwnerClear;
	u8	allowMaintenance;
	u8	physicalPresenceLifetimeLock;
	u8	physicalPresenceHWEnable;
	u8	physicalPresenceCMDEnable;
	u8	CEKPUsed;
	u8	TPMpost;
	u8	TPMpostLock;
	u8	FIPS;
	u8	operator;
	u8	enableRevokeEK;
	u8	nvLocked;
	u8	readSRKPub;
	u8	tpmEstablished;
	u8	maintenanceDone;
	u8	disableFullDALogicInfo;
} __packed;

typedef union {
	struct	permanent_flags_t perm_flags;
	struct	stclear_flags_t	stclear_flags;
	__u8	owned;
	__be32	num_pcrs;
	struct	tpm_version_t	tpm_version;
	struct	tpm_version_1_2_t tpm_version_1_2;
	__be32	manufacturer_id;
	struct timeout_t  timeout;
	struct duration_t duration;
} cap_t;

enum tpm_capabilities {
	TPM_CAP_FLAG = 4,
	TPM_CAP_PROP = 5,
	TPM_CAP_VERSION_1_1 = 0x06,
	TPM_CAP_VERSION_1_2 = 0x1A,
};

enum tpm_sub_capabilities {
	TPM_CAP_PROP_PCR = 0x101,
	TPM_CAP_PROP_MANUFACTURER = 0x103,
	TPM_CAP_FLAG_PERM = 0x108,
	TPM_CAP_FLAG_VOL = 0x109,
	TPM_CAP_PROP_OWNER = 0x111,
	TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
	TPM_CAP_PROP_TIS_DURATION = 0x120,
};


/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
 * bytes, but 128 is still a relatively large number of random bytes and
 * anything much bigger causes users of struct tpm_cmd_t to start getting
 * compiler warnings about stack frame size. */
#define TPM_MAX_RNG_DATA	128

/* A string buffer type for constructing TPM commands. This is based on the
 * ideas of string buffer code in security/keys/trusted.h but is heap based
 * in order to keep the stack usage minimal.
 */

enum tpm_buf_flags {
	TPM_BUF_OVERFLOW	= BIT(0),
};

struct tpm_buf {
	struct page *data_page;
	unsigned int flags;
	u8 *data;
};

static inline void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal)
{
	struct tpm_header *head = (struct tpm_header *)buf->data;

	head->tag = cpu_to_be16(tag);
	head->length = cpu_to_be32(sizeof(*head));
	head->ordinal = cpu_to_be32(ordinal);
}

static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
{
	buf->data_page = alloc_page(GFP_HIGHUSER);
	if (!buf->data_page)
		return -ENOMEM;

	buf->flags = 0;
	buf->data = kmap(buf->data_page);
	tpm_buf_reset(buf, tag, ordinal);
	return 0;
}

static inline void tpm_buf_destroy(struct tpm_buf *buf)
{
	kunmap(buf->data_page);
	__free_page(buf->data_page);
}

static inline u32 tpm_buf_length(struct tpm_buf *buf)
{
	struct tpm_header *head = (struct tpm_header *)buf->data;

	return be32_to_cpu(head->length);
}

static inline u16 tpm_buf_tag(struct tpm_buf *buf)
{
	struct tpm_header *head = (struct tpm_header *)buf->data;

	return be16_to_cpu(head->tag);
}

static inline void tpm_buf_append(struct tpm_buf *buf,
				  const unsigned char *new_data,
				  unsigned int new_len)
{
	struct tpm_header *head = (struct tpm_header *)buf->data;
	u32 len = tpm_buf_length(buf);

	/* Return silently if overflow has already happened. */
	if (buf->flags & TPM_BUF_OVERFLOW)
		return;

	if ((len + new_len) > PAGE_SIZE) {
		WARN(1, "tpm_buf: overflow\n");
		buf->flags |= TPM_BUF_OVERFLOW;
		return;
	}

	memcpy(&buf->data[len], new_data, new_len);
	head->length = cpu_to_be32(len + new_len);
}

static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
{
	tpm_buf_append(buf, &value, 1);
}

static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
{
	__be16 value2 = cpu_to_be16(value);

	tpm_buf_append(buf, (u8 *) &value2, 2);
}

static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
{
	__be32 value2 = cpu_to_be32(value);

	tpm_buf_append(buf, (u8 *) &value2, 4);
}

extern struct class *tpm_class;
extern struct class *tpmrm_class;
extern dev_t tpm_devt;
extern const struct file_operations tpm_fops;
extern const struct file_operations tpmrm_fops;
extern struct idr dev_nums_idr;

ssize_t tpm_transmit(struct tpm_chip *chip, u8 *buf, size_t bufsiz);
ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_buf *buf,
			 size_t min_rsp_body_length, const char *desc);
int tpm_get_timeouts(struct tpm_chip *);
int tpm_auto_startup(struct tpm_chip *chip);

int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr);
int tpm1_auto_startup(struct tpm_chip *chip);
int tpm1_do_selftest(struct tpm_chip *chip);
int tpm1_get_timeouts(struct tpm_chip *chip);
unsigned long tpm1_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
int tpm1_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, const u8 *hash,
		    const char *log_msg);
int tpm1_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf);
ssize_t tpm1_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
		    const char *desc, size_t min_cap_length);
int tpm1_get_random(struct tpm_chip *chip, u8 *out, size_t max);
unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
int tpm_pm_suspend(struct device *dev);
int tpm_pm_resume(struct device *dev);

static inline void tpm_msleep(unsigned int delay_msec)
{
	usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
		     delay_msec * 1000);
};

int tpm_chip_start(struct tpm_chip *chip);
void tpm_chip_stop(struct tpm_chip *chip);
struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip);
__must_check int tpm_try_get_ops(struct tpm_chip *chip);
void tpm_put_ops(struct tpm_chip *chip);

struct tpm_chip *tpm_chip_alloc(struct device *dev,
				const struct tpm_class_ops *ops);
struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
				 const struct tpm_class_ops *ops);
int tpm_chip_register(struct tpm_chip *chip);
void tpm_chip_unregister(struct tpm_chip *chip);

void tpm_sysfs_add_device(struct tpm_chip *chip);


#ifdef CONFIG_ACPI
extern void tpm_add_ppi(struct tpm_chip *chip);
#else
static inline void tpm_add_ppi(struct tpm_chip *chip)
{
}
#endif

static inline u32 tpm2_rc_value(u32 rc)
{
	return (rc & BIT(7)) ? rc & 0xff : rc;
}

int tpm2_get_timeouts(struct tpm_chip *chip);
int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
		  struct tpm_digest *digest, u16 *digest_size_ptr);
int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, u32 count,
		    struct tpm_digest *digests);
int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max);
void tpm2_flush_context(struct tpm_chip *chip, u32 handle);
int tpm2_seal_trusted(struct tpm_chip *chip,
		      struct trusted_key_payload *payload,
		      struct trusted_key_options *options);
int tpm2_unseal_trusted(struct tpm_chip *chip,
			struct trusted_key_payload *payload,
			struct trusted_key_options *options);
ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
			u32 *value, const char *desc);

int tpm2_auto_startup(struct tpm_chip *chip);
void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
int tpm2_probe(struct tpm_chip *chip);
int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
int tpm2_init_space(struct tpm_space *space);
void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
void tpm2_flush_space(struct tpm_chip *chip);
int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u8 *cmd,
		       size_t cmdsiz);
int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space, void *buf,
		      size_t *bufsiz);

int tpm_bios_log_setup(struct tpm_chip *chip);
void tpm_bios_log_teardown(struct tpm_chip *chip);
int tpm_dev_common_init(void);
void tpm_dev_common_exit(void);
#endif
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* Copyright (C) 2004 IBM Corporation
a74f8b36	3	* Copyright (C) 2015 Intel Corporation
1da177e4 LT	4	*
	5	* Authors:
	6	* Leendert van Doorn <leendert@watson.ibm.com>
	7	* Dave Safford <safford@watson.ibm.com>
	8	* Reiner Sailer <sailer@watson.ibm.com>
	9	* Kylene Hall <kjhall@us.ibm.com>
	10	*
8e81cc13	11	* Maintained by: <tpmdd-devel@lists.sourceforge.net>
1da177e4 LT	12	*
1da177e4 LT	13	* Device driver for TCG/TCPA TPM (trusted platform module).
3b09825d	14	* Specifications at www.trustedcomputinggroup.org
1da177e4 LT	15	*
	16	* This program is free software; you can redistribute it and/or
	17	* modify it under the terms of the GNU General Public License as
	18	* published by the Free Software Foundation, version 2 of the
	19	* License.
3b09825d	20	*
1da177e4	21	*/
d2efee6e CR	22
	23	#ifndef __TPM_H__
	24	#define __TPM_H__
	25
1da177e4	26	#include <linux/module.h>
1da177e4	27	#include <linux/delay.h>
d081d470	28	#include <linux/mutex.h>
914e2637	29	#include <linux/sched.h>
bbc5b212	30	#include <linux/platform_device.h>
276ad0c1	31	#include <linux/io.h>
659aaf2b	32	#include <linux/tpm.h>
a74f8b36	33	#include <linux/highmem.h>
fd3ec366	34	#include <linux/tpm_eventlog.h>
1da177e4	35
5e572cab AS	36	#ifdef CONFIG_X86
	37	#include <asm/intel-family.h>
	38	#endif
	39
901615cb RS	40	#define TPM_MINOR 224 /* officially assigned */
	41	#define TPM_BUFSIZE 4096
	42	#define TPM_NUM_DEVICES 65536
	43	#define TPM_RETRY 50
41ab999c	44
3122a88a KH	45	enum tpm_timeout {
3122a88a KH	46	TPM_TIMEOUT = 5, /* msecs */
9f3fc7bc	47	TPM_TIMEOUT_RETRY = 100, /* msecs */
59f5a6b0	48	TPM_TIMEOUT_RANGE_US = 300, /* usecs */
424eaf91 NJ	49	TPM_TIMEOUT_POLL = 1, /* msecs */
	50	TPM_TIMEOUT_USECS_MIN = 100, /* usecs */
	51	TPM_TIMEOUT_USECS_MAX = 500 /* usecs */
3122a88a	52	};
1da177e4 LT	53
1da177e4 LT	54	/* TPM addresses */
3122a88a	55	enum tpm_addr {
daacdfa6	56	TPM_SUPERIO_ADDR = 0x2E,
3122a88a	57	TPM_ADDR = 0x4E,
3122a88a KH	58	};
3122a88a KH	59
32d33b29	60	#define TPM_WARN_RETRY 0x800
68d6e671	61	#define TPM_WARN_DOING_SELFTEST 0x802
be405411 SB	62	#define TPM_ERR_DEACTIVATED 0x6
be405411 SB	63	#define TPM_ERR_DISABLED 0x7
c584af19	64	#define TPM_ERR_INVALID_POSTINIT 38
be405411	65
b9e3238a	66	#define TPM_HEADER_SIZE 10
7a1d7e6d JS	67
7a1d7e6d JS	68	enum tpm2_const {
076d3564 TW	69	TPM2_PLATFORM_PCR = 24,
	70	TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8),
	71	};
	72
	73	enum tpm2_timeouts {
	74	TPM2_TIMEOUT_A = 750,
	75	TPM2_TIMEOUT_B = 2000,
	76	TPM2_TIMEOUT_C = 200,
	77	TPM2_TIMEOUT_D = 30,
	78	TPM2_DURATION_SHORT = 20,
	79	TPM2_DURATION_MEDIUM = 750,
	80	TPM2_DURATION_LONG = 2000,
	81	TPM2_DURATION_LONG_LONG = 300000,
	82	TPM2_DURATION_DEFAULT = 120000,
7a1d7e6d JS	83	};
	84
	85	enum tpm2_structures {
	86	TPM2_ST_NO_SESSIONS = 0x8001,
	87	TPM2_ST_SESSIONS = 0x8002,
	88	};
	89
095531f8 JMC	90	/* Indicates from what layer of the software stack the error comes from */
	91	#define TSS2_RC_LAYER_SHIFT 16
	92	#define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)
	93
7a1d7e6d	94	enum tpm2_return_codes {
745b361e	95	TPM2_RC_SUCCESS = 0x0000,
5ca4c20c	96	TPM2_RC_HASH = 0x0083, /* RC_FMT1 */
745b361e	97	TPM2_RC_HANDLE = 0x008B,
5ca4c20c	98	TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */
2be8ffed	99	TPM2_RC_FAILURE = 0x0101,
7a1d7e6d	100	TPM2_RC_DISABLED = 0x0120,
095531f8	101	TPM2_RC_COMMAND_CODE = 0x0143,
5ca4c20c	102	TPM2_RC_TESTING = 0x090A, /* RC_WARN */
745b361e	103	TPM2_RC_REFERENCE_H0 = 0x0910,
e2fb992d	104	TPM2_RC_RETRY = 0x0922,
7a1d7e6d JS	105	};
7a1d7e6d JS	106
7a1d7e6d	107	enum tpm2_command_codes {
899102bc TW	108	TPM2_CC_FIRST = 0x011F,
	109	TPM2_CC_HIERARCHY_CONTROL = 0x0121,
	110	TPM2_CC_HIERARCHY_CHANGE_AUTH = 0x0129,
	111	TPM2_CC_CREATE_PRIMARY = 0x0131,
	112	TPM2_CC_SEQUENCE_COMPLETE = 0x013E,
	113	TPM2_CC_SELF_TEST = 0x0143,
	114	TPM2_CC_STARTUP = 0x0144,
	115	TPM2_CC_SHUTDOWN = 0x0145,
	116	TPM2_CC_NV_READ = 0x014E,
	117	TPM2_CC_CREATE = 0x0153,
	118	TPM2_CC_LOAD = 0x0157,
	119	TPM2_CC_SEQUENCE_UPDATE = 0x015C,
	120	TPM2_CC_UNSEAL = 0x015E,
	121	TPM2_CC_CONTEXT_LOAD = 0x0161,
	122	TPM2_CC_CONTEXT_SAVE = 0x0162,
	123	TPM2_CC_FLUSH_CONTEXT = 0x0165,
	124	TPM2_CC_VERIFY_SIGNATURE = 0x0177,
	125	TPM2_CC_GET_CAPABILITY = 0x017A,
	126	TPM2_CC_GET_RANDOM = 0x017B,
	127	TPM2_CC_PCR_READ = 0x017E,
	128	TPM2_CC_PCR_EXTEND = 0x0182,
	129	TPM2_CC_EVENT_SEQUENCE_COMPLETE = 0x0185,
	130	TPM2_CC_HASH_SEQUENCE_START = 0x0186,
	131	TPM2_CC_CREATE_LOADED = 0x0191,
	132	TPM2_CC_LAST = 0x0193, /* Spec 1.36 */
7a1d7e6d JS	133	};
	134
	135	enum tpm2_permanent_handles {
	136	TPM2_RS_PW = 0x40000009,
	137	};
	138
	139	enum tpm2_capabilities {
745b361e	140	TPM2_CAP_HANDLES = 1,
58472f5c	141	TPM2_CAP_COMMANDS = 2,
1db15344	142	TPM2_CAP_PCRS = 5,
7a1d7e6d JS	143	TPM2_CAP_TPM_PROPERTIES = 6,
	144	};
	145
58472f5c JS	146	enum tpm2_properties {
	147	TPM_PT_TOTAL_COMMANDS = 0x0129,
	148	};
	149
7a1d7e6d JS	150	enum tpm2_startup_types {
	151	TPM2_SU_CLEAR = 0x0000,
	152	TPM2_SU_STATE = 0x0001,
	153	};
	154
58472f5c JS	155	enum tpm2_cc_attrs {
	156	TPM2_CC_ATTR_CHANDLES = 25,
	157	TPM2_CC_ATTR_RHANDLE = 28,
	158	};
	159
4e401fb0	160	#define TPM_VID_INTEL 0x8086
1f866057 SB	161	#define TPM_VID_WINBOND 0x1050
1f866057 SB	162	#define TPM_VID_STM 0x104A
4e401fb0	163
afb5abc2	164	enum tpm_chip_flags {
9b774d5c	165	TPM_CHIP_FLAG_TPM2 = BIT(1),
570a3609	166	TPM_CHIP_FLAG_IRQ = BIT(2),
2f9f5377	167	TPM_CHIP_FLAG_VIRTUAL = BIT(3),
d1d253cf	168	TPM_CHIP_FLAG_HAVE_TIMEOUTS = BIT(4),
b5d0ebc9	169	TPM_CHIP_FLAG_ALWAYS_POWERED = BIT(5),
afb5abc2 JS	170	};
afb5abc2 JS	171
9b774d5c	172	#define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
27084efe	173
b34b77a9 JS	174	struct tpm_header {
	175	__be16 tag;
	176	__be32 length;
	177	union {
	178	__be32 ordinal;
	179	__be32 return_code;
	180	};
348df8db	181	} __packed;
08837438	182
06e93279	183	#define TPM_TAG_RQU_COMMAND 193
000a07b0	184
08837438 RA	185	struct stclear_flags_t {
	186	__be16 tag;
	187	u8 deactivated;
	188	u8 disableForceClear;
	189	u8 physicalPresence;
	190	u8 physicalPresenceLock;
	191	u8 bGlobalLock;
348df8db	192	} __packed;
08837438 RA	193
	194	struct tpm_version_t {
	195	u8 Major;
	196	u8 Minor;
	197	u8 revMajor;
	198	u8 revMinor;
348df8db	199	} __packed;
08837438 RA	200
	201	struct tpm_version_1_2_t {
	202	__be16 tag;
	203	u8 Major;
	204	u8 Minor;
	205	u8 revMajor;
	206	u8 revMinor;
348df8db	207	} __packed;
08837438 RA	208
	209	struct timeout_t {
	210	__be32 a;
	211	__be32 b;
	212	__be32 c;
	213	__be32 d;
348df8db	214	} __packed;
08837438 RA	215
	216	struct duration_t {
	217	__be32 tpm_short;
	218	__be32 tpm_medium;
	219	__be32 tpm_long;
348df8db	220	} __packed;
08837438 RA	221
	222	struct permanent_flags_t {
	223	__be16 tag;
	224	u8 disable;
	225	u8 ownership;
	226	u8 deactivated;
	227	u8 readPubek;
	228	u8 disableOwnerClear;
	229	u8 allowMaintenance;
	230	u8 physicalPresenceLifetimeLock;
	231	u8 physicalPresenceHWEnable;
	232	u8 physicalPresenceCMDEnable;
	233	u8 CEKPUsed;
	234	u8 TPMpost;
	235	u8 TPMpostLock;
	236	u8 FIPS;
	237	u8 operator;
	238	u8 enableRevokeEK;
	239	u8 nvLocked;
	240	u8 readSRKPub;
	241	u8 tpmEstablished;
	242	u8 maintenanceDone;
	243	u8 disableFullDALogicInfo;
348df8db	244	} __packed;
08837438 RA	245
	246	typedef union {
	247	struct permanent_flags_t perm_flags;
	248	struct stclear_flags_t stclear_flags;
a118cf2a	249	__u8 owned;
08837438 RA	250	__be32 num_pcrs;
	251	struct tpm_version_t tpm_version;
	252	struct tpm_version_1_2_t tpm_version_1_2;
	253	__be32 manufacturer_id;
	254	struct timeout_t timeout;
	255	struct duration_t duration;
	256	} cap_t;
	257
000a07b0	258	enum tpm_capabilities {
84fda152 JS	259	TPM_CAP_FLAG = 4,
	260	TPM_CAP_PROP = 5,
	261	TPM_CAP_VERSION_1_1 = 0x06,
	262	TPM_CAP_VERSION_1_2 = 0x1A,
000a07b0 JG	263	};
	264
	265	enum tpm_sub_capabilities {
84fda152 JS	266	TPM_CAP_PROP_PCR = 0x101,
	267	TPM_CAP_PROP_MANUFACTURER = 0x103,
	268	TPM_CAP_FLAG_PERM = 0x108,
	269	TPM_CAP_FLAG_VOL = 0x109,
	270	TPM_CAP_PROP_OWNER = 0x111,
	271	TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
	272	TPM_CAP_PROP_TIS_DURATION = 0x120,
000a07b0 JG	273	};
000a07b0 JG	274
659aaf2b	275
41ab999c KY	276	/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
	277	* bytes, but 128 is still a relatively large number of random bytes and
	278	* anything much bigger causes users of struct tpm_cmd_t to start getting
	279	* compiler warnings about stack frame size. */
	280	#define TPM_MAX_RNG_DATA 128
	281
a74f8b36 JS	282	/* A string buffer type for constructing TPM commands. This is based on the
	283	* ideas of string buffer code in security/keys/trusted.h but is heap based
	284	* in order to keep the stack usage minimal.
	285	*/
	286
	287	enum tpm_buf_flags {
	288	TPM_BUF_OVERFLOW = BIT(0),
	289	};
	290
	291	struct tpm_buf {
	292	struct page *data_page;
	293	unsigned int flags;
	294	u8 *data;
	295	};
	296
ce63c05b	297	static inline void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal)
a74f8b36	298	{
b34b77a9 JS	299	struct tpm_header head = (struct tpm_header )buf->data;
b34b77a9 JS	300
ce63c05b JS	301	head->tag = cpu_to_be16(tag);
	302	head->length = cpu_to_be32(sizeof(*head));
	303	head->ordinal = cpu_to_be32(ordinal);
	304	}
a74f8b36	305
ce63c05b JS	306	static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
ce63c05b JS	307	{
a74f8b36 JS	308	buf->data_page = alloc_page(GFP_HIGHUSER);
	309	if (!buf->data_page)
	310	return -ENOMEM;
	311
	312	buf->flags = 0;
	313	buf->data = kmap(buf->data_page);
ce63c05b	314	tpm_buf_reset(buf, tag, ordinal);
a74f8b36 JS	315	return 0;
	316	}
	317
	318	static inline void tpm_buf_destroy(struct tpm_buf *buf)
	319	{
	320	kunmap(buf->data_page);
	321	__free_page(buf->data_page);
	322	}
	323
	324	static inline u32 tpm_buf_length(struct tpm_buf *buf)
	325	{
b34b77a9	326	struct tpm_header head = (struct tpm_header )buf->data;
a74f8b36 JS	327
	328	return be32_to_cpu(head->length);
	329	}
	330
	331	static inline u16 tpm_buf_tag(struct tpm_buf *buf)
	332	{
b34b77a9	333	struct tpm_header head = (struct tpm_header )buf->data;
a74f8b36 JS	334
	335	return be16_to_cpu(head->tag);
	336	}
	337
	338	static inline void tpm_buf_append(struct tpm_buf *buf,
	339	const unsigned char *new_data,
	340	unsigned int new_len)
	341	{
b34b77a9	342	struct tpm_header head = (struct tpm_header )buf->data;
a74f8b36 JS	343	u32 len = tpm_buf_length(buf);
	344
	345	/* Return silently if overflow has already happened. */
	346	if (buf->flags & TPM_BUF_OVERFLOW)
	347	return;
	348
	349	if ((len + new_len) > PAGE_SIZE) {
	350	WARN(1, "tpm_buf: overflow\n");
	351	buf->flags \|= TPM_BUF_OVERFLOW;
	352	return;
	353	}
	354
	355	memcpy(&buf->data[len], new_data, new_len);
	356	head->length = cpu_to_be32(len + new_len);
	357	}
	358
	359	static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
	360	{
	361	tpm_buf_append(buf, &value, 1);
	362	}
	363
	364	static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
	365	{
	366	__be16 value2 = cpu_to_be16(value);
	367
	368	tpm_buf_append(buf, (u8 *) &value2, 2);
	369	}
	370
	371	static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
	372	{
	373	__be32 value2 = cpu_to_be32(value);
	374
	375	tpm_buf_append(buf, (u8 *) &value2, 4);
	376	}
	377
313d21ee	378	extern struct class *tpm_class;
fdc915f7	379	extern struct class *tpmrm_class;
313d21ee JS	380	extern dev_t tpm_devt;
313d21ee JS	381	extern const struct file_operations tpm_fops;
fdc915f7	382	extern const struct file_operations tpmrm_fops;
15516788	383	extern struct idr dev_nums_idr;
313d21ee	384
47a6c28b	385	ssize_t tpm_transmit(struct tpm_chip chip, u8 buf, size_t bufsiz);
5faafbab	386	ssize_t tpm_transmit_cmd(struct tpm_chip chip, struct tpm_buf buf,
47a6c28b	387	size_t min_rsp_body_length, const char *desc);
d4abd956	388	int tpm_get_timeouts(struct tpm_chip *);
b03c4370	389	int tpm_auto_startup(struct tpm_chip *chip);
c82a330c	390
95adc6b4	391	int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr);
cae8b441	392	int tpm1_auto_startup(struct tpm_chip *chip);
d4a31756	393	int tpm1_do_selftest(struct tpm_chip *chip);
70a3199a	394	int tpm1_get_timeouts(struct tpm_chip *chip);
b2d6e6de	395	unsigned long tpm1_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
95adc6b4	396	int tpm1_pcr_extend(struct tpm_chip chip, u32 pcr_idx, const u8 hash,
1ad6640c	397	const char *log_msg);
95adc6b4	398	int tpm1_pcr_read(struct tpm_chip chip, u32 pcr_idx, u8 res_buf);
f4d916b7 TW	399	ssize_t tpm1_getcap(struct tpm_chip chip, u32 subcap_id, cap_t cap,
f4d916b7 TW	400	const char *desc, size_t min_cap_length);
433d390f	401	int tpm1_get_random(struct tpm_chip chip, u8 out, size_t max);
d856c00f	402	unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
d4abd956 JS	403	int tpm_pm_suspend(struct device *dev);
d4abd956 JS	404	int tpm_pm_resume(struct device *dev);
f84fdff0	405
9f3fc7bc HA	406	static inline void tpm_msleep(unsigned int delay_msec)
9f3fc7bc HA	407	{
5ef924d9 NJ	408	usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
5ef924d9 NJ	409	delay_msec * 1000);
9f3fc7bc HA	410	};
9f3fc7bc HA	411
47a6c28b JS	412	int tpm_chip_start(struct tpm_chip *chip);
47a6c28b JS	413	void tpm_chip_stop(struct tpm_chip *chip);
fc1d52b7	414	struct tpm_chip tpm_find_get_ops(struct tpm_chip chip);
4e26195f JG	415	__must_check int tpm_try_get_ops(struct tpm_chip *chip);
	416	void tpm_put_ops(struct tpm_chip *chip);
	417
d4abd956 JS	418	struct tpm_chip tpm_chip_alloc(struct device dev,
	419	const struct tpm_class_ops *ops);
	420	struct tpm_chip tpmm_chip_alloc(struct device pdev,
	421	const struct tpm_class_ops *ops);
	422	int tpm_chip_register(struct tpm_chip *chip);
	423	void tpm_chip_unregister(struct tpm_chip *chip);
afb5abc2	424
062807f2	425	void tpm_sysfs_add_device(struct tpm_chip *chip);
afdba32e	426
000a07b0	427
f84fdff0	428	#ifdef CONFIG_ACPI
9b774d5c	429	extern void tpm_add_ppi(struct tpm_chip *chip);
f84fdff0	430	#else
9b774d5c	431	static inline void tpm_add_ppi(struct tpm_chip *chip)
1631cfb7 GW	432	{
1631cfb7 GW	433	}
f84fdff0	434	#endif
7a1d7e6d	435
2d56c718	436	static inline u32 tpm2_rc_value(u32 rc)
7d761119 JS	437	{
	438	return (rc & BIT(7)) ? rc & 0xff : rc;
	439	}
	440
70a3199a	441	int tpm2_get_timeouts(struct tpm_chip *chip);
879b5892 RS	442	int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
879b5892 RS	443	struct tpm_digest digest, u16 digest_size_ptr);
95adc6b4	444	int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, u32 count,
aa042475	445	struct tpm_digest *digests);
ce63c05b	446	int tpm2_get_random(struct tpm_chip chip, u8 dest, size_t max);
47a6c28b	447	void tpm2_flush_context(struct tpm_chip *chip, u32 handle);
954650ef JS	448	int tpm2_seal_trusted(struct tpm_chip *chip,
	449	struct trusted_key_payload *payload,
	450	struct trusted_key_options *options);
	451	int tpm2_unseal_trusted(struct tpm_chip *chip,
	452	struct trusted_key_payload *payload,
	453	struct trusted_key_options *options);
7a1d7e6d JS	454	ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
	455	u32 value, const char desc);
	456
cae8b441	457	int tpm2_auto_startup(struct tpm_chip *chip);
d4abd956 JS	458	void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
d4abd956 JS	459	unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
d4abd956	460	int tpm2_probe(struct tpm_chip *chip);
58472f5c	461	int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
745b361e	462	int tpm2_init_space(struct tpm_space *space);
4d57856a	463	void tpm2_del_space(struct tpm_chip chip, struct tpm_space space);
304ff672	464	void tpm2_flush_space(struct tpm_chip *chip);
c3465a37 JS	465	int tpm2_prepare_space(struct tpm_chip chip, struct tpm_space space, u8 *cmd,
	466	size_t cmdsiz);
	467	int tpm2_commit_space(struct tpm_chip chip, struct tpm_space space, void *buf,
	468	size_t *bufsiz);
fd3ec366	469
fd3ec366 TW	470	int tpm_bios_log_setup(struct tpm_chip *chip);
fd3ec366 TW	471	void tpm_bios_log_teardown(struct tpm_chip *chip);
9e1b74a6 TS	472	int tpm_dev_common_init(void);
9e1b74a6 TS	473	void tpm_dev_common_exit(void);
d2efee6e	474	#endif