[mirror_ubuntu-artful-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/fs.h>
#include <linux/mutex.h>
#include <linux/sched.h>
#include <linux/platform_device.h>
#include <linux/io.h>
#include <linux/tpm.h>
#include <linux/acpi.h>
#include <linux/cdev.h>
#include <linux/highmem.h>
#include <crypto/hash_info.h>

enum tpm_const {
	TPM_MINOR = 224,	/* officially assigned */
	TPM_BUFSIZE = 4096,
	TPM_NUM_DEVICES = 65536,
	TPM_RETRY = 50,		/* 5 seconds */
	TPM_NUM_EVENT_LOG_FILES = 3,
};

enum tpm_timeout {
	TPM_TIMEOUT = 5,	/* msecs */
	TPM_TIMEOUT_RETRY = 100 /* msecs */
};

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

/* Indexes the duration array */
enum tpm_duration {
	TPM_SHORT = 0,
	TPM_MEDIUM = 1,
	TPM_LONG = 2,
	TPM_UNDEFINED,
};

#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),
	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,
};

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

enum tpm2_return_codes {
	TPM2_RC_HASH		= 0x0083, /* RC_FMT1 */
	TPM2_RC_INITIALIZE	= 0x0100, /* RC_VER1 */
	TPM2_RC_DISABLED	= 0x0120,
	TPM2_RC_TESTING		= 0x090A, /* RC_WARN */
};

enum tpm2_algorithms {
	TPM2_ALG_ERROR		= 0x0000,
	TPM2_ALG_SHA1		= 0x0004,
	TPM2_ALG_KEYEDHASH	= 0x0008,
	TPM2_ALG_SHA256		= 0x000B,
	TPM2_ALG_SHA384		= 0x000C,
	TPM2_ALG_SHA512		= 0x000D,
	TPM2_ALG_NULL		= 0x0010,
	TPM2_ALG_SM3_256	= 0x0012,
};

enum tpm2_command_codes {
	TPM2_CC_FIRST		= 0x011F,
	TPM2_CC_SELF_TEST	= 0x0143,
	TPM2_CC_STARTUP		= 0x0144,
	TPM2_CC_SHUTDOWN	= 0x0145,
	TPM2_CC_CREATE		= 0x0153,
	TPM2_CC_LOAD		= 0x0157,
	TPM2_CC_UNSEAL		= 0x015E,
	TPM2_CC_FLUSH_CONTEXT	= 0x0165,
	TPM2_CC_GET_CAPABILITY	= 0x017A,
	TPM2_CC_GET_RANDOM	= 0x017B,
	TPM2_CC_PCR_READ	= 0x017E,
	TPM2_CC_PCR_EXTEND	= 0x0182,
	TPM2_CC_LAST		= 0x018F,
};

enum tpm2_permanent_handles {
	TPM2_RS_PW		= 0x40000009,
};

enum tpm2_capabilities {
	TPM2_CAP_PCRS		= 5,
	TPM2_CAP_TPM_PROPERTIES = 6,
};

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

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

#define TPM_PPI_VERSION_LEN		3

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),
};

struct tpm_bios_log {
	void *bios_event_log;
	void *bios_event_log_end;
};

struct tpm_chip_seqops {
	struct tpm_chip *chip;
	const struct seq_operations *seqops;
};

struct tpm_chip {
	struct device dev;
	struct cdev cdev;

	/* A driver callback under ops cannot be run unless ops_sem is held
	 * (sometimes implicitly, eg for the sysfs code). ops becomes null
	 * when the driver is unregistered, see tpm_try_get_ops.
	 */
	struct rw_semaphore ops_sem;
	const struct tpm_class_ops *ops;

	struct tpm_bios_log log;
	struct tpm_chip_seqops bin_log_seqops;
	struct tpm_chip_seqops ascii_log_seqops;

	unsigned int flags;

	int dev_num;		/* /dev/tpm# */
	unsigned long is_open;	/* only one allowed */

	struct mutex tpm_mutex;	/* tpm is processing */

	unsigned long timeout_a; /* jiffies */
	unsigned long timeout_b; /* jiffies */
	unsigned long timeout_c; /* jiffies */
	unsigned long timeout_d; /* jiffies */
	bool timeout_adjusted;
	unsigned long duration[3]; /* jiffies */
	bool duration_adjusted;

	struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];

	const struct attribute_group *groups[3];
	unsigned int groups_cnt;

	u16 active_banks[7];
#ifdef CONFIG_ACPI
	acpi_handle acpi_dev_handle;
	char ppi_version[TPM_PPI_VERSION_LEN + 1];
#endif /* CONFIG_ACPI */
};

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

struct tpm_input_header {
	__be16	tag;
	__be32	length;
	__be32	ordinal;
} __packed;

struct tpm_output_header {
	__be16	tag;
	__be32	length;
	__be32	return_code;
} __packed;

#define TPM_TAG_RQU_COMMAND cpu_to_be16(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,
};

struct	tpm_getcap_params_in {
	__be32	cap;
	__be32	subcap_size;
	__be32	subcap;
} __packed;

struct	tpm_getcap_params_out {
	__be32	cap_size;
	cap_t	cap;
} __packed;

struct	tpm_readpubek_params_out {
	u8	algorithm[4];
	u8	encscheme[2];
	u8	sigscheme[2];
	__be32	paramsize;
	u8	parameters[12]; /*assuming RSA*/
	__be32	keysize;
	u8	modulus[256];
	u8	checksum[20];
} __packed;

typedef union {
	struct	tpm_input_header in;
	struct	tpm_output_header out;
} tpm_cmd_header;

struct tpm_pcrread_out {
	u8	pcr_result[TPM_DIGEST_SIZE];
} __packed;

struct tpm_pcrread_in {
	__be32	pcr_idx;
} __packed;

struct tpm_pcrextend_in {
	__be32	pcr_idx;
	u8	hash[TPM_DIGEST_SIZE];
} __packed;

/* 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

struct tpm_getrandom_out {
	__be32 rng_data_len;
	u8     rng_data[TPM_MAX_RNG_DATA];
} __packed;

struct tpm_getrandom_in {
	__be32 num_bytes;
} __packed;

struct tpm_startup_in {
	__be16	startup_type;
} __packed;

typedef union {
	struct	tpm_getcap_params_out getcap_out;
	struct	tpm_readpubek_params_out readpubek_out;
	u8	readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
	struct	tpm_getcap_params_in getcap_in;
	struct	tpm_pcrread_in	pcrread_in;
	struct	tpm_pcrread_out	pcrread_out;
	struct	tpm_pcrextend_in pcrextend_in;
	struct	tpm_getrandom_in getrandom_in;
	struct	tpm_getrandom_out getrandom_out;
	struct tpm_startup_in startup_in;
} tpm_cmd_params;

struct tpm_cmd_t {
	tpm_cmd_header	header;
	tpm_cmd_params	params;
} __packed;

struct tpm2_digest {
	u16 alg_id;
	u8 digest[SHA512_DIGEST_SIZE];
} __packed;

/* 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 int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
{
	struct tpm_input_header *head;

	buf->data_page = alloc_page(GFP_HIGHUSER);
	if (!buf->data_page)
		return -ENOMEM;

	buf->flags = 0;
	buf->data = kmap(buf->data_page);

	head = (struct tpm_input_header *) buf->data;

	head->tag = cpu_to_be16(tag);
	head->length = cpu_to_be32(sizeof(*head));
	head->ordinal = cpu_to_be32(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_input_header *head = (struct tpm_input_header *) buf->data;

	return be32_to_cpu(head->length);
}

static inline u16 tpm_buf_tag(struct tpm_buf *buf)
{
	struct tpm_input_header *head = (struct tpm_input_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_input_header *head = (struct tpm_input_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 dev_t tpm_devt;
extern const struct file_operations tpm_fops;
extern struct idr dev_nums_idr;

enum tpm_transmit_flags {
	TPM_TRANSMIT_UNLOCKED	= BIT(0),
};

ssize_t tpm_transmit(struct tpm_chip *chip, const u8 *buf, size_t bufsiz,
		     unsigned int flags);
ssize_t tpm_transmit_cmd(struct tpm_chip *chip, const void *buf, size_t bufsiz,
			 size_t min_rsp_body_len, unsigned int flags,
			 const char *desc);
ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
		   const char *desc, size_t min_cap_length);
int tpm_get_timeouts(struct tpm_chip *);
int tpm1_auto_startup(struct tpm_chip *chip);
int tpm_do_selftest(struct tpm_chip *chip);
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);
int wait_for_tpm_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
		      wait_queue_head_t *queue, bool check_cancel);

struct tpm_chip *tpm_chip_find_get(int chip_num);
__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);

int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);

#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 inline u32 tpm2_rc_value(u32 rc)
{
	return (rc & BIT(7)) ? rc & 0xff : rc;
}

int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, u32 count,
		    struct tpm2_digest *digests);
int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max);
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);
#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 LT	27	#include <linux/delay.h>
1da177e4 LT	28	#include <linux/fs.h>
d081d470	29	#include <linux/mutex.h>
914e2637	30	#include <linux/sched.h>
bbc5b212	31	#include <linux/platform_device.h>
276ad0c1	32	#include <linux/io.h>
659aaf2b	33	#include <linux/tpm.h>
0dc55365	34	#include <linux/acpi.h>
313d21ee	35	#include <linux/cdev.h>
a74f8b36	36	#include <linux/highmem.h>
c1f92b4b	37	#include <crypto/hash_info.h>
1da177e4	38
41ab999c KY	39	enum tpm_const {
	40	TPM_MINOR = 224, /* officially assigned */
	41	TPM_BUFSIZE = 4096,
15516788	42	TPM_NUM_DEVICES = 65536,
32d33b29	43	TPM_RETRY = 50, /* 5 seconds */
cd9b7631	44	TPM_NUM_EVENT_LOG_FILES = 3,
41ab999c KY	45	};
41ab999c KY	46
3122a88a KH	47	enum tpm_timeout {
3122a88a KH	48	TPM_TIMEOUT = 5, /* msecs */
32d33b29	49	TPM_TIMEOUT_RETRY = 100 /* msecs */
3122a88a	50	};
1da177e4 LT	51
1da177e4 LT	52	/* TPM addresses */
3122a88a	53	enum tpm_addr {
daacdfa6	54	TPM_SUPERIO_ADDR = 0x2E,
3122a88a	55	TPM_ADDR = 0x4E,
3122a88a KH	56	};
3122a88a KH	57
000a07b0 JG	58	/* Indexes the duration array */
	59	enum tpm_duration {
	60	TPM_SHORT = 0,
	61	TPM_MEDIUM = 1,
	62	TPM_LONG = 2,
	63	TPM_UNDEFINED,
	64	};
	65
32d33b29	66	#define TPM_WARN_RETRY 0x800
68d6e671	67	#define TPM_WARN_DOING_SELFTEST 0x802
be405411 SB	68	#define TPM_ERR_DEACTIVATED 0x6
be405411 SB	69	#define TPM_ERR_DISABLED 0x7
c584af19	70	#define TPM_ERR_INVALID_POSTINIT 38
be405411	71
b9e3238a	72	#define TPM_HEADER_SIZE 10
7a1d7e6d JS	73
	74	enum tpm2_const {
	75	TPM2_PLATFORM_PCR = 24,
	76	TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8),
	77	TPM2_TIMEOUT_A = 750,
	78	TPM2_TIMEOUT_B = 2000,
	79	TPM2_TIMEOUT_C = 200,
	80	TPM2_TIMEOUT_D = 30,
	81	TPM2_DURATION_SHORT = 20,
	82	TPM2_DURATION_MEDIUM = 750,
	83	TPM2_DURATION_LONG = 2000,
	84	};
	85
	86	enum tpm2_structures {
	87	TPM2_ST_NO_SESSIONS = 0x8001,
	88	TPM2_ST_SESSIONS = 0x8002,
	89	};
	90
	91	enum tpm2_return_codes {
5ca4c20c JS	92	TPM2_RC_HASH = 0x0083, /* RC_FMT1 */
5ca4c20c JS	93	TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */
7a1d7e6d	94	TPM2_RC_DISABLED = 0x0120,
5ca4c20c	95	TPM2_RC_TESTING = 0x090A, /* RC_WARN */
7a1d7e6d JS	96	};
	97
	98	enum tpm2_algorithms {
1db15344	99	TPM2_ALG_ERROR = 0x0000,
7a1d7e6d	100	TPM2_ALG_SHA1 = 0x0004,
954650ef JS	101	TPM2_ALG_KEYEDHASH = 0x0008,
954650ef JS	102	TPM2_ALG_SHA256 = 0x000B,
5ca4c20c JS	103	TPM2_ALG_SHA384 = 0x000C,
	104	TPM2_ALG_SHA512 = 0x000D,
	105	TPM2_ALG_NULL = 0x0010,
	106	TPM2_ALG_SM3_256 = 0x0012,
7a1d7e6d JS	107	};
	108
	109	enum tpm2_command_codes {
	110	TPM2_CC_FIRST = 0x011F,
	111	TPM2_CC_SELF_TEST = 0x0143,
	112	TPM2_CC_STARTUP = 0x0144,
	113	TPM2_CC_SHUTDOWN = 0x0145,
954650ef JS	114	TPM2_CC_CREATE = 0x0153,
	115	TPM2_CC_LOAD = 0x0157,
	116	TPM2_CC_UNSEAL = 0x015E,
	117	TPM2_CC_FLUSH_CONTEXT = 0x0165,
7a1d7e6d JS	118	TPM2_CC_GET_CAPABILITY = 0x017A,
	119	TPM2_CC_GET_RANDOM = 0x017B,
	120	TPM2_CC_PCR_READ = 0x017E,
	121	TPM2_CC_PCR_EXTEND = 0x0182,
	122	TPM2_CC_LAST = 0x018F,
	123	};
	124
	125	enum tpm2_permanent_handles {
	126	TPM2_RS_PW = 0x40000009,
	127	};
	128
	129	enum tpm2_capabilities {
1db15344	130	TPM2_CAP_PCRS = 5,
7a1d7e6d JS	131	TPM2_CAP_TPM_PROPERTIES = 6,
	132	};
	133
	134	enum tpm2_startup_types {
	135	TPM2_SU_CLEAR = 0x0000,
	136	TPM2_SU_STATE = 0x0001,
	137	};
	138
4e401fb0	139	#define TPM_VID_INTEL 0x8086
1f866057 SB	140	#define TPM_VID_WINBOND 0x1050
1f866057 SB	141	#define TPM_VID_STM 0x104A
4e401fb0	142
0dc55365 JS	143	#define TPM_PPI_VERSION_LEN 3
0dc55365 JS	144
afb5abc2	145	enum tpm_chip_flags {
9b774d5c	146	TPM_CHIP_FLAG_TPM2 = BIT(1),
570a3609	147	TPM_CHIP_FLAG_IRQ = BIT(2),
2f9f5377	148	TPM_CHIP_FLAG_VIRTUAL = BIT(3),
d1d253cf	149	TPM_CHIP_FLAG_HAVE_TIMEOUTS = BIT(4),
afb5abc2 JS	150	};
afb5abc2 JS	151
4d23cc32 NJ	152	struct tpm_bios_log {
	153	void *bios_event_log;
	154	void *bios_event_log_end;
	155	};
	156
748935ee NJ	157	struct tpm_chip_seqops {
	158	struct tpm_chip *chip;
	159	const struct seq_operations *seqops;
	160	};
	161
1da177e4	162	struct tpm_chip {
313d21ee JS	163	struct device dev;
	164	struct cdev cdev;
	165
4e26195f JG	166	/* A driver callback under ops cannot be run unless ops_sem is held
	167	* (sometimes implicitly, eg for the sysfs code). ops becomes null
	168	* when the driver is unregistered, see tpm_try_get_ops.
	169	*/
	170	struct rw_semaphore ops_sem;
5f82e9f0	171	const struct tpm_class_ops *ops;
4e26195f	172
748935ee NJ	173	struct tpm_bios_log log;
	174	struct tpm_chip_seqops bin_log_seqops;
	175	struct tpm_chip_seqops ascii_log_seqops;
	176
afb5abc2	177	unsigned int flags;
1da177e4 LT	178
1da177e4 LT	179	int dev_num; /* /dev/tpm# */
dc36d32c	180	unsigned long is_open; /* only one allowed */
1da177e4	181
d081d470	182	struct mutex tpm_mutex; /* tpm is processing */
1da177e4	183
af782f33 CR	184	unsigned long timeout_a; /* jiffies */
	185	unsigned long timeout_b; /* jiffies */
	186	unsigned long timeout_c; /* jiffies */
	187	unsigned long timeout_d; /* jiffies */
	188	bool timeout_adjusted;
	189	unsigned long duration[3]; /* jiffies */
	190	bool duration_adjusted;
1da177e4	191
cd9b7631	192	struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
55a82ab3	193
062807f2	194	const struct attribute_group *groups[3];
9b774d5c	195	unsigned int groups_cnt;
1db15344 NJ	196
1db15344 NJ	197	u16 active_banks[7];
062807f2	198	#ifdef CONFIG_ACPI
0dc55365 JS	199	acpi_handle acpi_dev_handle;
	200	char ppi_version[TPM_PPI_VERSION_LEN + 1];
	201	#endif /* CONFIG_ACPI */
1da177e4 LT	202	};
1da177e4 LT	203
9b774d5c	204	#define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
27084efe	205
08837438 RA	206	struct tpm_input_header {
	207	__be16 tag;
	208	__be32 length;
	209	__be32 ordinal;
348df8db	210	} __packed;
08837438 RA	211
	212	struct tpm_output_header {
	213	__be16 tag;
	214	__be32 length;
	215	__be32 return_code;
348df8db	216	} __packed;
08837438	217
000a07b0 JG	218	#define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
000a07b0 JG	219
08837438 RA	220	struct stclear_flags_t {
	221	__be16 tag;
	222	u8 deactivated;
	223	u8 disableForceClear;
	224	u8 physicalPresence;
	225	u8 physicalPresenceLock;
	226	u8 bGlobalLock;
348df8db	227	} __packed;
08837438 RA	228
	229	struct tpm_version_t {
	230	u8 Major;
	231	u8 Minor;
	232	u8 revMajor;
	233	u8 revMinor;
348df8db	234	} __packed;
08837438 RA	235
	236	struct tpm_version_1_2_t {
	237	__be16 tag;
	238	u8 Major;
	239	u8 Minor;
	240	u8 revMajor;
	241	u8 revMinor;
348df8db	242	} __packed;
08837438 RA	243
	244	struct timeout_t {
	245	__be32 a;
	246	__be32 b;
	247	__be32 c;
	248	__be32 d;
348df8db	249	} __packed;
08837438 RA	250
	251	struct duration_t {
	252	__be32 tpm_short;
	253	__be32 tpm_medium;
	254	__be32 tpm_long;
348df8db	255	} __packed;
08837438 RA	256
	257	struct permanent_flags_t {
	258	__be16 tag;
	259	u8 disable;
	260	u8 ownership;
	261	u8 deactivated;
	262	u8 readPubek;
	263	u8 disableOwnerClear;
	264	u8 allowMaintenance;
	265	u8 physicalPresenceLifetimeLock;
	266	u8 physicalPresenceHWEnable;
	267	u8 physicalPresenceCMDEnable;
	268	u8 CEKPUsed;
	269	u8 TPMpost;
	270	u8 TPMpostLock;
	271	u8 FIPS;
	272	u8 operator;
	273	u8 enableRevokeEK;
	274	u8 nvLocked;
	275	u8 readSRKPub;
	276	u8 tpmEstablished;
	277	u8 maintenanceDone;
	278	u8 disableFullDALogicInfo;
348df8db	279	} __packed;
08837438 RA	280
	281	typedef union {
	282	struct permanent_flags_t perm_flags;
	283	struct stclear_flags_t stclear_flags;
a118cf2a	284	__u8 owned;
08837438 RA	285	__be32 num_pcrs;
	286	struct tpm_version_t tpm_version;
	287	struct tpm_version_1_2_t tpm_version_1_2;
	288	__be32 manufacturer_id;
	289	struct timeout_t timeout;
	290	struct duration_t duration;
	291	} cap_t;
	292
000a07b0	293	enum tpm_capabilities {
84fda152 JS	294	TPM_CAP_FLAG = 4,
	295	TPM_CAP_PROP = 5,
	296	TPM_CAP_VERSION_1_1 = 0x06,
	297	TPM_CAP_VERSION_1_2 = 0x1A,
000a07b0 JG	298	};
	299
	300	enum tpm_sub_capabilities {
84fda152 JS	301	TPM_CAP_PROP_PCR = 0x101,
	302	TPM_CAP_PROP_MANUFACTURER = 0x103,
	303	TPM_CAP_FLAG_PERM = 0x108,
	304	TPM_CAP_FLAG_VOL = 0x109,
	305	TPM_CAP_PROP_OWNER = 0x111,
	306	TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
	307	TPM_CAP_PROP_TIS_DURATION = 0x120,
000a07b0 JG	308	};
000a07b0 JG	309
08837438 RA	310	struct tpm_getcap_params_in {
	311	__be32 cap;
	312	__be32 subcap_size;
	313	__be32 subcap;
348df8db	314	} __packed;
08837438 RA	315
	316	struct tpm_getcap_params_out {
	317	__be32 cap_size;
	318	cap_t cap;
348df8db	319	} __packed;
08837438 RA	320
	321	struct tpm_readpubek_params_out {
	322	u8 algorithm[4];
	323	u8 encscheme[2];
	324	u8 sigscheme[2];
02a077c5	325	__be32 paramsize;
08837438 RA	326	u8 parameters[12]; /assuming RSA/
	327	__be32 keysize;
	328	u8 modulus[256];
	329	u8 checksum[20];
348df8db	330	} __packed;
08837438 RA	331
	332	typedef union {
	333	struct tpm_input_header in;
	334	struct tpm_output_header out;
	335	} tpm_cmd_header;
	336
659aaf2b RA	337	struct tpm_pcrread_out {
659aaf2b RA	338	u8 pcr_result[TPM_DIGEST_SIZE];
348df8db	339	} __packed;
659aaf2b RA	340
	341	struct tpm_pcrread_in {
	342	__be32 pcr_idx;
348df8db	343	} __packed;
659aaf2b RA	344
	345	struct tpm_pcrextend_in {
	346	__be32 pcr_idx;
	347	u8 hash[TPM_DIGEST_SIZE];
348df8db	348	} __packed;
659aaf2b	349
41ab999c KY	350	/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
	351	* bytes, but 128 is still a relatively large number of random bytes and
	352	* anything much bigger causes users of struct tpm_cmd_t to start getting
	353	* compiler warnings about stack frame size. */
	354	#define TPM_MAX_RNG_DATA 128
	355
	356	struct tpm_getrandom_out {
	357	__be32 rng_data_len;
	358	u8 rng_data[TPM_MAX_RNG_DATA];
348df8db	359	} __packed;
41ab999c KY	360
	361	struct tpm_getrandom_in {
	362	__be32 num_bytes;
348df8db	363	} __packed;
41ab999c	364
c584af19 JG	365	struct tpm_startup_in {
	366	__be16 startup_type;
	367	} __packed;
	368
08837438 RA	369	typedef union {
	370	struct tpm_getcap_params_out getcap_out;
	371	struct tpm_readpubek_params_out readpubek_out;
	372	u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
	373	struct tpm_getcap_params_in getcap_in;
659aaf2b RA	374	struct tpm_pcrread_in pcrread_in;
	375	struct tpm_pcrread_out pcrread_out;
	376	struct tpm_pcrextend_in pcrextend_in;
41ab999c KY	377	struct tpm_getrandom_in getrandom_in;
41ab999c KY	378	struct tpm_getrandom_out getrandom_out;
c584af19	379	struct tpm_startup_in startup_in;
08837438 RA	380	} tpm_cmd_params;
	381
	382	struct tpm_cmd_t {
	383	tpm_cmd_header header;
	384	tpm_cmd_params params;
348df8db	385	} __packed;
08837438	386
c1f92b4b NJ	387	struct tpm2_digest {
	388	u16 alg_id;
	389	u8 digest[SHA512_DIGEST_SIZE];
	390	} __packed;
	391
a74f8b36 JS	392	/* A string buffer type for constructing TPM commands. This is based on the
	393	* ideas of string buffer code in security/keys/trusted.h but is heap based
	394	* in order to keep the stack usage minimal.
	395	*/
	396
	397	enum tpm_buf_flags {
	398	TPM_BUF_OVERFLOW = BIT(0),
	399	};
	400
	401	struct tpm_buf {
	402	struct page *data_page;
	403	unsigned int flags;
	404	u8 *data;
	405	};
	406
954650ef	407	static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
a74f8b36 JS	408	{
	409	struct tpm_input_header *head;
	410
	411	buf->data_page = alloc_page(GFP_HIGHUSER);
	412	if (!buf->data_page)
	413	return -ENOMEM;
	414
	415	buf->flags = 0;
	416	buf->data = kmap(buf->data_page);
	417
	418	head = (struct tpm_input_header *) buf->data;
	419
	420	head->tag = cpu_to_be16(tag);
	421	head->length = cpu_to_be32(sizeof(*head));
	422	head->ordinal = cpu_to_be32(ordinal);
	423
	424	return 0;
	425	}
	426
	427	static inline void tpm_buf_destroy(struct tpm_buf *buf)
	428	{
	429	kunmap(buf->data_page);
	430	__free_page(buf->data_page);
	431	}
	432
	433	static inline u32 tpm_buf_length(struct tpm_buf *buf)
	434	{
	435	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	436
	437	return be32_to_cpu(head->length);
	438	}
	439
	440	static inline u16 tpm_buf_tag(struct tpm_buf *buf)
	441	{
	442	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	443
	444	return be16_to_cpu(head->tag);
	445	}
	446
	447	static inline void tpm_buf_append(struct tpm_buf *buf,
	448	const unsigned char *new_data,
	449	unsigned int new_len)
	450	{
	451	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	452	u32 len = tpm_buf_length(buf);
	453
	454	/* Return silently if overflow has already happened. */
	455	if (buf->flags & TPM_BUF_OVERFLOW)
	456	return;
	457
	458	if ((len + new_len) > PAGE_SIZE) {
	459	WARN(1, "tpm_buf: overflow\n");
	460	buf->flags \|= TPM_BUF_OVERFLOW;
	461	return;
	462	}
	463
	464	memcpy(&buf->data[len], new_data, new_len);
	465	head->length = cpu_to_be32(len + new_len);
	466	}
	467
	468	static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
	469	{
	470	tpm_buf_append(buf, &value, 1);
	471	}
472
473	static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
474	{
475	__be16 value2 = cpu_to_be16(value);
476
477	tpm_buf_append(buf, (u8 *) &value2, 2);
478	}
479
480	static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
481	{
482	__be32 value2 = cpu_to_be32(value);
483
484	tpm_buf_append(buf, (u8 *) &value2, 4);
485	}
486
313d21ee JS	487	extern struct class *tpm_class;
	488	extern dev_t tpm_devt;
	489	extern const struct file_operations tpm_fops;
15516788	490	extern struct idr dev_nums_idr;
313d21ee	491
d4816edf JS	492	enum tpm_transmit_flags {
	493	TPM_TRANSMIT_UNLOCKED = BIT(0),
	494	};
	495
	496	ssize_t tpm_transmit(struct tpm_chip chip, const u8 buf, size_t bufsiz,
	497	unsigned int flags);
c659af78 SB	498	ssize_t tpm_transmit_cmd(struct tpm_chip chip, const void buf, size_t bufsiz,
	499	size_t min_rsp_body_len, unsigned int flags,
	500	const char *desc);
84fda152	501	ssize_t tpm_getcap(struct tpm_chip chip, u32 subcap_id, cap_t cap,
c659af78	502	const char *desc, size_t min_cap_length);
d4abd956	503	int tpm_get_timeouts(struct tpm_chip *);
cae8b441	504	int tpm1_auto_startup(struct tpm_chip *chip);
d4abd956 JS	505	int tpm_do_selftest(struct tpm_chip *chip);
	506	unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
	507	int tpm_pm_suspend(struct device *dev);
	508	int tpm_pm_resume(struct device *dev);
	509	int wait_for_tpm_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
	510	wait_queue_head_t *queue, bool check_cancel);
f84fdff0	511
afb5abc2	512	struct tpm_chip *tpm_chip_find_get(int chip_num);
4e26195f JG	513	__must_check int tpm_try_get_ops(struct tpm_chip *chip);
	514	void tpm_put_ops(struct tpm_chip *chip);
	515
d4abd956 JS	516	struct tpm_chip tpm_chip_alloc(struct device dev,
	517	const struct tpm_class_ops *ops);
	518	struct tpm_chip tpmm_chip_alloc(struct device pdev,
	519	const struct tpm_class_ops *ops);
	520	int tpm_chip_register(struct tpm_chip *chip);
	521	void tpm_chip_unregister(struct tpm_chip *chip);
afb5abc2	522
062807f2	523	void tpm_sysfs_add_device(struct tpm_chip *chip);
afdba32e	524
000a07b0 JG	525	int tpm_pcr_read_dev(struct tpm_chip chip, int pcr_idx, u8 res_buf);
000a07b0 JG	526
f84fdff0	527	#ifdef CONFIG_ACPI
9b774d5c	528	extern void tpm_add_ppi(struct tpm_chip *chip);
f84fdff0	529	#else
9b774d5c	530	static inline void tpm_add_ppi(struct tpm_chip *chip)
1631cfb7 GW	531	{
1631cfb7 GW	532	}
f84fdff0	533	#endif
7a1d7e6d	534
7d761119 JS	535	static inline inline u32 tpm2_rc_value(u32 rc)
	536	{
	537	return (rc & BIT(7)) ? rc & 0xff : rc;
	538	}
	539
7a1d7e6d	540	int tpm2_pcr_read(struct tpm_chip chip, int pcr_idx, u8 res_buf);
c1f92b4b NJ	541	int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, u32 count,
c1f92b4b NJ	542	struct tpm2_digest *digests);
7a1d7e6d	543	int tpm2_get_random(struct tpm_chip chip, u8 out, size_t max);
954650ef JS	544	int tpm2_seal_trusted(struct tpm_chip *chip,
	545	struct trusted_key_payload *payload,
	546	struct trusted_key_options *options);
	547	int tpm2_unseal_trusted(struct tpm_chip *chip,
	548	struct trusted_key_payload *payload,
	549	struct trusted_key_options *options);
7a1d7e6d JS	550	ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
	551	u32 value, const char desc);
	552
cae8b441	553	int tpm2_auto_startup(struct tpm_chip *chip);
d4abd956 JS	554	void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
d4abd956 JS	555	unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
d4abd956	556	int tpm2_probe(struct tpm_chip *chip);
d2efee6e	557	#endif