[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.
 *
 */
#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>

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

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_REGISTERED	= BIT(0),
	TPM_CHIP_FLAG_TPM2		= BIT(1),
	TPM_CHIP_FLAG_IRQ		= BIT(2),
};

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;

	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;

	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 = cpu_to_be32(4),
	TPM_CAP_PROP = cpu_to_be32(5),
	CAP_VERSION_1_1 = cpu_to_be32(0x06),
	CAP_VERSION_1_2 = cpu_to_be32(0x1A)
};

enum tpm_sub_capabilities {
	TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
	TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
	TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
	TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
	TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
	TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
	TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(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;

ssize_t tpm_getcap(struct tpm_chip *chip, __be32 subcap_id, cap_t *cap,
		   const char *desc);
ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
		     size_t bufsiz);
ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len,
			 const char *desc);
extern int tpm_get_timeouts(struct tpm_chip *);
extern void tpm_gen_interrupt(struct tpm_chip *);
extern int tpm_do_selftest(struct tpm_chip *);
extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
extern int tpm_pm_suspend(struct device *);
extern int tpm_pm_resume(struct device *);
extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
			     wait_queue_head_t *, bool);

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

extern struct tpm_chip *tpm_chip_alloc(struct device *dev,
				       const struct tpm_class_ops *ops);
extern struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
				       const struct tpm_class_ops *ops);
extern int tpm_chip_register(struct tpm_chip *chip);
extern 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);

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