[people/arne_f/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,
};

struct tpm_chip;

struct tpm_vendor_specific {
	void __iomem *iobase;		/* ioremapped address */
	unsigned long base;		/* TPM base address */

	int irq;

	struct list_head list;
	int locality;
	unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
	bool timeout_adjusted;
	unsigned long duration[3]; /* jiffies */
	bool duration_adjusted;
	void *priv;

	wait_queue_head_t read_queue;
};

#define TPM_VPRIV(c)     ((c)->vendor.priv)

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

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 */
	int time_expired;

	struct mutex tpm_mutex;	/* tpm is processing */

	struct tpm_vendor_specific vendor;

	struct dentry **bios_dir;

#ifdef CONFIG_ACPI
	const struct attribute_group *groups[2];
	unsigned int groups_cnt;
	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 device *, __be32, cap_t *, const char *);
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);

int tpm_sysfs_add_device(struct tpm_chip *chip);
void tpm_sysfs_del_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
1da177e4 LT	131	struct tpm_chip;
	132
	133	struct tpm_vendor_specific {
ad5ea3cc KJH	134	void __iomem iobase; / ioremapped address */
	135	unsigned long base; /* TPM base address */
	136
27084efe LD	137	int irq;
27084efe LD	138
27084efe LD	139	struct list_head list;
27084efe LD	140	int locality;
36b20020	141	unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
62592101	142	bool timeout_adjusted;
36b20020	143	unsigned long duration[3]; /* jiffies */
04ab2293	144	bool duration_adjusted;
775585e4	145	void *priv;
27084efe LD	146
27084efe LD	147	wait_queue_head_t read_queue;
1da177e4 LT	148	};
1da177e4 LT	149
3b09825d	150	#define TPM_VPRIV(c) ((c)->vendor.priv)
775585e4	151
4e401fb0	152	#define TPM_VID_INTEL 0x8086
1f866057 SB	153	#define TPM_VID_WINBOND 0x1050
1f866057 SB	154	#define TPM_VID_STM 0x104A
4e401fb0	155
0dc55365 JS	156	#define TPM_PPI_VERSION_LEN 3
0dc55365 JS	157
afb5abc2 JS	158	enum tpm_chip_flags {
afb5abc2 JS	159	TPM_CHIP_FLAG_REGISTERED = BIT(0),
9b774d5c	160	TPM_CHIP_FLAG_TPM2 = BIT(1),
afb5abc2 JS	161	};
afb5abc2 JS	162
1da177e4	163	struct tpm_chip {
313d21ee JS	164	struct device dev;
	165	struct cdev cdev;
	166
4e26195f JG	167	/* A driver callback under ops cannot be run unless ops_sem is held
	168	* (sometimes implicitly, eg for the sysfs code). ops becomes null
	169	* when the driver is unregistered, see tpm_try_get_ops.
	170	*/
	171	struct rw_semaphore ops_sem;
5f82e9f0	172	const struct tpm_class_ops *ops;
4e26195f	173
afb5abc2	174	unsigned int flags;
1da177e4 LT	175
1da177e4 LT	176	int dev_num; /* /dev/tpm# */
dc36d32c	177	unsigned long is_open; /* only one allowed */
1da177e4 LT	178	int time_expired;
1da177e4 LT	179
d081d470	180	struct mutex tpm_mutex; /* tpm is processing */
1da177e4	181
90dda520	182	struct tpm_vendor_specific vendor;
1da177e4	183
55a82ab3 KJH	184	struct dentry **bios_dir;
55a82ab3 KJH	185
0dc55365	186	#ifdef CONFIG_ACPI
9b774d5c JS	187	const struct attribute_group *groups[2];
9b774d5c JS	188	unsigned int groups_cnt;
0dc55365 JS	189	acpi_handle acpi_dev_handle;
	190	char ppi_version[TPM_PPI_VERSION_LEN + 1];
	191	#endif /* CONFIG_ACPI */
1da177e4 LT	192	};
1da177e4 LT	193
9b774d5c	194	#define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
27084efe	195
daacdfa6	196	static inline int tpm_read_index(int base, int index)
1da177e4	197	{
daacdfa6 KJH	198	outb(index, base);
daacdfa6 KJH	199	return inb(base+1) & 0xFF;
1da177e4 LT	200	}
1da177e4 LT	201
daacdfa6	202	static inline void tpm_write_index(int base, int index, int value)
1da177e4	203	{
daacdfa6 KJH	204	outb(index, base);
daacdfa6 KJH	205	outb(value & 0xFF, base+1);
1da177e4	206	}
08837438 RA	207	struct tpm_input_header {
	208	__be16 tag;
	209	__be32 length;
	210	__be32 ordinal;
348df8db	211	} __packed;
08837438 RA	212
	213	struct tpm_output_header {
	214	__be16 tag;
	215	__be32 length;
	216	__be32 return_code;
348df8db	217	} __packed;
08837438	218
000a07b0 JG	219	#define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
000a07b0 JG	220
08837438 RA	221	struct stclear_flags_t {
	222	__be16 tag;
	223	u8 deactivated;
	224	u8 disableForceClear;
	225	u8 physicalPresence;
	226	u8 physicalPresenceLock;
	227	u8 bGlobalLock;
348df8db	228	} __packed;
08837438 RA	229
	230	struct tpm_version_t {
	231	u8 Major;
	232	u8 Minor;
	233	u8 revMajor;
	234	u8 revMinor;
348df8db	235	} __packed;
08837438 RA	236
	237	struct tpm_version_1_2_t {
	238	__be16 tag;
	239	u8 Major;
	240	u8 Minor;
	241	u8 revMajor;
	242	u8 revMinor;
348df8db	243	} __packed;
08837438 RA	244
	245	struct timeout_t {
	246	__be32 a;
	247	__be32 b;
	248	__be32 c;
	249	__be32 d;
348df8db	250	} __packed;
08837438 RA	251
	252	struct duration_t {
	253	__be32 tpm_short;
	254	__be32 tpm_medium;
	255	__be32 tpm_long;
348df8db	256	} __packed;
08837438 RA	257
	258	struct permanent_flags_t {
	259	__be16 tag;
	260	u8 disable;
	261	u8 ownership;
	262	u8 deactivated;
	263	u8 readPubek;
	264	u8 disableOwnerClear;
	265	u8 allowMaintenance;
	266	u8 physicalPresenceLifetimeLock;
	267	u8 physicalPresenceHWEnable;
	268	u8 physicalPresenceCMDEnable;
	269	u8 CEKPUsed;
	270	u8 TPMpost;
	271	u8 TPMpostLock;
	272	u8 FIPS;
	273	u8 operator;
	274	u8 enableRevokeEK;
	275	u8 nvLocked;
	276	u8 readSRKPub;
	277	u8 tpmEstablished;
	278	u8 maintenanceDone;
	279	u8 disableFullDALogicInfo;
348df8db	280	} __packed;
08837438 RA	281
	282	typedef union {
	283	struct permanent_flags_t perm_flags;
	284	struct stclear_flags_t stclear_flags;
	285	bool owned;
	286	__be32 num_pcrs;
	287	struct tpm_version_t tpm_version;
	288	struct tpm_version_1_2_t tpm_version_1_2;
	289	__be32 manufacturer_id;
	290	struct timeout_t timeout;
	291	struct duration_t duration;
	292	} cap_t;
	293
000a07b0 JG	294	enum tpm_capabilities {
	295	TPM_CAP_FLAG = cpu_to_be32(4),
	296	TPM_CAP_PROP = cpu_to_be32(5),
	297	CAP_VERSION_1_1 = cpu_to_be32(0x06),
	298	CAP_VERSION_1_2 = cpu_to_be32(0x1A)
	299	};
	300
	301	enum tpm_sub_capabilities {
	302	TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
	303	TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
	304	TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
	305	TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
	306	TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
	307	TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
	308	TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
	309
	310	};
	311
08837438 RA	312	struct tpm_getcap_params_in {
	313	__be32 cap;
	314	__be32 subcap_size;
	315	__be32 subcap;
348df8db	316	} __packed;
08837438 RA	317
	318	struct tpm_getcap_params_out {
	319	__be32 cap_size;
	320	cap_t cap;
348df8db	321	} __packed;
08837438 RA	322
	323	struct tpm_readpubek_params_out {
	324	u8 algorithm[4];
	325	u8 encscheme[2];
	326	u8 sigscheme[2];
02a077c5	327	__be32 paramsize;
08837438 RA	328	u8 parameters[12]; /assuming RSA/
	329	__be32 keysize;
	330	u8 modulus[256];
	331	u8 checksum[20];
348df8db	332	} __packed;
08837438 RA	333
	334	typedef union {
	335	struct tpm_input_header in;
	336	struct tpm_output_header out;
	337	} tpm_cmd_header;
	338
659aaf2b RA	339	struct tpm_pcrread_out {
659aaf2b RA	340	u8 pcr_result[TPM_DIGEST_SIZE];
348df8db	341	} __packed;
659aaf2b RA	342
	343	struct tpm_pcrread_in {
	344	__be32 pcr_idx;
348df8db	345	} __packed;
659aaf2b RA	346
	347	struct tpm_pcrextend_in {
	348	__be32 pcr_idx;
	349	u8 hash[TPM_DIGEST_SIZE];
348df8db	350	} __packed;
659aaf2b	351
41ab999c KY	352	/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
	353	* bytes, but 128 is still a relatively large number of random bytes and
	354	* anything much bigger causes users of struct tpm_cmd_t to start getting
	355	* compiler warnings about stack frame size. */
	356	#define TPM_MAX_RNG_DATA 128
	357
	358	struct tpm_getrandom_out {
	359	__be32 rng_data_len;
	360	u8 rng_data[TPM_MAX_RNG_DATA];
348df8db	361	} __packed;
41ab999c KY	362
	363	struct tpm_getrandom_in {
	364	__be32 num_bytes;
348df8db	365	} __packed;
41ab999c	366
c584af19 JG	367	struct tpm_startup_in {
	368	__be16 startup_type;
	369	} __packed;
	370
08837438 RA	371	typedef union {
	372	struct tpm_getcap_params_out getcap_out;
	373	struct tpm_readpubek_params_out readpubek_out;
	374	u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
	375	struct tpm_getcap_params_in getcap_in;
659aaf2b RA	376	struct tpm_pcrread_in pcrread_in;
	377	struct tpm_pcrread_out pcrread_out;
	378	struct tpm_pcrextend_in pcrextend_in;
41ab999c KY	379	struct tpm_getrandom_in getrandom_in;
41ab999c KY	380	struct tpm_getrandom_out getrandom_out;
c584af19	381	struct tpm_startup_in startup_in;
08837438 RA	382	} tpm_cmd_params;
	383
	384	struct tpm_cmd_t {
	385	tpm_cmd_header header;
	386	tpm_cmd_params params;
348df8db	387	} __packed;
08837438	388
a74f8b36 JS	389	/* A string buffer type for constructing TPM commands. This is based on the
	390	* ideas of string buffer code in security/keys/trusted.h but is heap based
	391	* in order to keep the stack usage minimal.
	392	*/
	393
	394	enum tpm_buf_flags {
	395	TPM_BUF_OVERFLOW = BIT(0),
	396	};
	397
	398	struct tpm_buf {
	399	struct page *data_page;
	400	unsigned int flags;
	401	u8 *data;
	402	};
	403
954650ef	404	static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
a74f8b36 JS	405	{
	406	struct tpm_input_header *head;
	407
	408	buf->data_page = alloc_page(GFP_HIGHUSER);
	409	if (!buf->data_page)
	410	return -ENOMEM;
	411
	412	buf->flags = 0;
	413	buf->data = kmap(buf->data_page);
	414
	415	head = (struct tpm_input_header *) buf->data;
	416
	417	head->tag = cpu_to_be16(tag);
	418	head->length = cpu_to_be32(sizeof(*head));
	419	head->ordinal = cpu_to_be32(ordinal);
	420
	421	return 0;
	422	}
	423
	424	static inline void tpm_buf_destroy(struct tpm_buf *buf)
	425	{
	426	kunmap(buf->data_page);
	427	__free_page(buf->data_page);
	428	}
	429
	430	static inline u32 tpm_buf_length(struct tpm_buf *buf)
	431	{
	432	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	433
	434	return be32_to_cpu(head->length);
	435	}
	436
	437	static inline u16 tpm_buf_tag(struct tpm_buf *buf)
	438	{
	439	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	440
	441	return be16_to_cpu(head->tag);
	442	}
	443
	444	static inline void tpm_buf_append(struct tpm_buf *buf,
	445	const unsigned char *new_data,
	446	unsigned int new_len)
	447	{
	448	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	449	u32 len = tpm_buf_length(buf);
	450
	451	/* Return silently if overflow has already happened. */
	452	if (buf->flags & TPM_BUF_OVERFLOW)
	453	return;
	454
	455	if ((len + new_len) > PAGE_SIZE) {
	456	WARN(1, "tpm_buf: overflow\n");
	457	buf->flags \|= TPM_BUF_OVERFLOW;
	458	return;
	459	}
	460
	461	memcpy(&buf->data[len], new_data, new_len);
	462	head->length = cpu_to_be32(len + new_len);
	463	}
	464
	465	static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
	466	{
	467	tpm_buf_append(buf, &value, 1);
	468	}
469
470	static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
471	{
472	__be16 value2 = cpu_to_be16(value);
473
474	tpm_buf_append(buf, (u8 *) &value2, 2);
475	}
476
477	static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
478	{
479	__be32 value2 = cpu_to_be32(value);
480
481	tpm_buf_append(buf, (u8 *) &value2, 4);
482	}
483
313d21ee JS	484	extern struct class *tpm_class;
	485	extern dev_t tpm_devt;
	486	extern const struct file_operations tpm_fops;
15516788	487	extern struct idr dev_nums_idr;
313d21ee	488
08837438	489	ssize_t tpm_getcap(struct device , __be32, cap_t , const char *);
afdba32e JG	490	ssize_t tpm_transmit(struct tpm_chip chip, const char buf,
afdba32e JG	491	size_t bufsiz);
87155b73 JS	492	ssize_t tpm_transmit_cmd(struct tpm_chip chip, void cmd, int len,
87155b73 JS	493	const char *desc);
2b30a90f	494	extern int tpm_get_timeouts(struct tpm_chip *);
08e96e48	495	extern void tpm_gen_interrupt(struct tpm_chip *);
68d6e671	496	extern int tpm_do_selftest(struct tpm_chip *);
9e18ee19	497	extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
035e2ce8	498	extern int tpm_pm_suspend(struct device *);
ce2c87d4	499	extern int tpm_pm_resume(struct device *);
fd048866	500	extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
78f09cc2	501	wait_queue_head_t *, bool);
f84fdff0	502
afb5abc2	503	struct tpm_chip *tpm_chip_find_get(int chip_num);
4e26195f JG	504	__must_check int tpm_try_get_ops(struct tpm_chip *chip);
	505	void tpm_put_ops(struct tpm_chip *chip);
	506
3897cd9c JG	507	extern struct tpm_chip tpm_chip_alloc(struct device dev,
	508	const struct tpm_class_ops *ops);
	509	extern struct tpm_chip tpmm_chip_alloc(struct device pdev,
afb5abc2 JS	510	const struct tpm_class_ops *ops);
	511	extern int tpm_chip_register(struct tpm_chip *chip);
	512	extern void tpm_chip_unregister(struct tpm_chip *chip);
	513
1e3b73a9 JG	514	int tpm_sysfs_add_device(struct tpm_chip *chip);
1e3b73a9 JG	515	void tpm_sysfs_del_device(struct tpm_chip *chip);
afdba32e	516
000a07b0 JG	517	int tpm_pcr_read_dev(struct tpm_chip chip, int pcr_idx, u8 res_buf);
000a07b0 JG	518
f84fdff0	519	#ifdef CONFIG_ACPI
9b774d5c	520	extern void tpm_add_ppi(struct tpm_chip *chip);
f84fdff0	521	#else
9b774d5c	522	static inline void tpm_add_ppi(struct tpm_chip *chip)
1631cfb7 GW	523	{
1631cfb7 GW	524	}
f84fdff0	525	#endif
7a1d7e6d JS	526
	527	int tpm2_pcr_read(struct tpm_chip chip, int pcr_idx, u8 res_buf);
	528	int tpm2_pcr_extend(struct tpm_chip chip, int pcr_idx, const u8 hash);
	529	int tpm2_get_random(struct tpm_chip chip, u8 out, size_t max);
954650ef JS	530	int tpm2_seal_trusted(struct tpm_chip *chip,
	531	struct trusted_key_payload *payload,
	532	struct trusted_key_options *options);
	533	int tpm2_unseal_trusted(struct tpm_chip *chip,
	534	struct trusted_key_payload *payload,
	535	struct trusted_key_options *options);
7a1d7e6d JS	536	ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
	537	u32 value, const char desc);
	538
	539	extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type);
74d6b3ce	540	extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
7a1d7e6d JS	541	extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32);
7a1d7e6d JS	542	extern int tpm2_do_selftest(struct tpm_chip *chip);
4d5f2051 JS	543	extern int tpm2_gen_interrupt(struct tpm_chip *chip);
4d5f2051 JS	544	extern int tpm2_probe(struct tpm_chip *chip);