[mirror_ubuntu-zesty-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 "tpm_eventlog.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_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_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_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;
#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)

static inline int tpm_read_index(int base, int index)
{
	outb(index, base);
	return inb(base+1) & 0xFF;
}

static inline void tpm_write_index(int base, int index, int value)
{
	outb(index, base);
	outb(value & 0xFF, base+1);
}
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;
	bool	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;

/* 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 *cmd, int len,
			 unsigned int flags, const char *desc);
ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
		   const char *desc);
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

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