[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>

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),
	TPM_CHIP_FLAG_VIRTUAL		= BIT(3),
};

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 *);
int tpm1_auto_startup(struct tpm_chip *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);

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