[deliverable/linux.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 = 256,
	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;

	int region_size;
	int have_region;

	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;
	wait_queue_head_t int_queue;

	u16 manufacturer_id;
};

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

	struct list_head list;
};

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

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 *tpmm_chip_alloc(struct device *dev,
				       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
	1	/*
	2	* Copyright (C) 2004 IBM Corporation
	3	* Copyright (C) 2015 Intel Corporation
	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	*
	11	* Maintained by: <tpmdd-devel@lists.sourceforge.net>
	12	*
	13	* Device driver for TCG/TCPA TPM (trusted platform module).
	14	* Specifications at www.trustedcomputinggroup.org
	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.
	20	*
	21	*/
	22	#include <linux/module.h>
	23	#include <linux/delay.h>
	24	#include <linux/fs.h>
	25	#include <linux/mutex.h>
	26	#include <linux/sched.h>
	27	#include <linux/platform_device.h>
	28	#include <linux/io.h>
	29	#include <linux/tpm.h>
	30	#include <linux/acpi.h>
	31	#include <linux/cdev.h>
	32	#include <linux/highmem.h>
	33
	34	enum tpm_const {
	35	TPM_MINOR = 224, /* officially assigned */
	36	TPM_BUFSIZE = 4096,
	37	TPM_NUM_DEVICES = 256,
	38	TPM_RETRY = 50, /* 5 seconds */
	39	};
	40
	41	enum tpm_timeout {
	42	TPM_TIMEOUT = 5, /* msecs */
	43	TPM_TIMEOUT_RETRY = 100 /* msecs */
	44	};
	45
	46	/* TPM addresses */
	47	enum tpm_addr {
	48	TPM_SUPERIO_ADDR = 0x2E,
	49	TPM_ADDR = 0x4E,
	50	};
	51
	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
	60	#define TPM_WARN_RETRY 0x800
	61	#define TPM_WARN_DOING_SELFTEST 0x802
	62	#define TPM_ERR_DEACTIVATED 0x6
	63	#define TPM_ERR_DISABLED 0x7
	64	#define TPM_ERR_INVALID_POSTINIT 38
	65
	66	#define TPM_HEADER_SIZE 10
	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 {
	86	TPM2_RC_HASH = 0x0083, /* RC_FMT1 */
	87	TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */
	88	TPM2_RC_DISABLED = 0x0120,
	89	TPM2_RC_TESTING = 0x090A, /* RC_WARN */
	90	};
	91
	92	enum tpm2_algorithms {
	93	TPM2_ALG_SHA1 = 0x0004,
	94	TPM2_ALG_KEYEDHASH = 0x0008,
	95	TPM2_ALG_SHA256 = 0x000B,
	96	TPM2_ALG_SHA384 = 0x000C,
	97	TPM2_ALG_SHA512 = 0x000D,
	98	TPM2_ALG_NULL = 0x0010,
	99	TPM2_ALG_SM3_256 = 0x0012,
	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,
	107	TPM2_CC_CREATE = 0x0153,
	108	TPM2_CC_LOAD = 0x0157,
	109	TPM2_CC_UNSEAL = 0x015E,
	110	TPM2_CC_FLUSH_CONTEXT = 0x0165,
	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
	131	struct tpm_chip;
	132
	133	struct tpm_vendor_specific {
	134	void __iomem iobase; / ioremapped address */
	135	unsigned long base; /* TPM base address */
	136
	137	int irq;
	138
	139	int region_size;
	140	int have_region;
	141
	142	struct list_head list;
	143	int locality;
	144	unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
	145	bool timeout_adjusted;
	146	unsigned long duration[3]; /* jiffies */
	147	bool duration_adjusted;
	148	void *priv;
	149
	150	wait_queue_head_t read_queue;
	151	wait_queue_head_t int_queue;
	152
	153	u16 manufacturer_id;
	154	};
	155
	156	#define TPM_VPRIV(c) ((c)->vendor.priv)
	157
	158	#define TPM_VID_INTEL 0x8086
	159	#define TPM_VID_WINBOND 0x1050
	160	#define TPM_VID_STM 0x104A
	161
	162	#define TPM_PPI_VERSION_LEN 3
	163
	164	enum tpm_chip_flags {
	165	TPM_CHIP_FLAG_REGISTERED = BIT(0),
	166	TPM_CHIP_FLAG_TPM2 = BIT(1),
	167	};
	168
	169	struct tpm_chip {
	170	struct device dev;
	171	struct cdev cdev;
	172
	173	/* A driver callback under ops cannot be run unless ops_sem is held
	174	* (sometimes implicitly, eg for the sysfs code). ops becomes null
	175	* when the driver is unregistered, see tpm_try_get_ops.
	176	*/
	177	struct rw_semaphore ops_sem;
	178	const struct tpm_class_ops *ops;
	179
	180	unsigned int flags;
	181
	182	int dev_num; /* /dev/tpm# */
	183	unsigned long is_open; /* only one allowed */
	184	int time_expired;
	185
	186	struct mutex tpm_mutex; /* tpm is processing */
	187
	188	struct tpm_vendor_specific vendor;
	189
	190	struct dentry **bios_dir;
	191
	192	#ifdef CONFIG_ACPI
	193	const struct attribute_group *groups[2];
	194	unsigned int groups_cnt;
	195	acpi_handle acpi_dev_handle;
	196	char ppi_version[TPM_PPI_VERSION_LEN + 1];
	197	#endif /* CONFIG_ACPI */
	198
	199	struct list_head list;
	200	};
	201
	202	#define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
	203
	204	static inline int tpm_read_index(int base, int index)
	205	{
	206	outb(index, base);
	207	return inb(base+1) & 0xFF;
	208	}
	209
	210	static inline void tpm_write_index(int base, int index, int value)
	211	{
	212	outb(index, base);
	213	outb(value & 0xFF, base+1);
	214	}
	215	struct tpm_input_header {
	216	__be16 tag;
	217	__be32 length;
	218	__be32 ordinal;
	219	} __packed;
	220
	221	struct tpm_output_header {
	222	__be16 tag;
	223	__be32 length;
	224	__be32 return_code;
	225	} __packed;
	226
	227	#define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
	228
	229	struct stclear_flags_t {
	230	__be16 tag;
	231	u8 deactivated;
	232	u8 disableForceClear;
	233	u8 physicalPresence;
	234	u8 physicalPresenceLock;
	235	u8 bGlobalLock;
	236	} __packed;
	237
	238	struct tpm_version_t {
	239	u8 Major;
	240	u8 Minor;
	241	u8 revMajor;
	242	u8 revMinor;
	243	} __packed;
	244
	245	struct tpm_version_1_2_t {
	246	__be16 tag;
	247	u8 Major;
	248	u8 Minor;
	249	u8 revMajor;
	250	u8 revMinor;
	251	} __packed;
	252
	253	struct timeout_t {
	254	__be32 a;
	255	__be32 b;
	256	__be32 c;
	257	__be32 d;
	258	} __packed;
	259
	260	struct duration_t {
	261	__be32 tpm_short;
	262	__be32 tpm_medium;
	263	__be32 tpm_long;
	264	} __packed;
	265
	266	struct permanent_flags_t {
	267	__be16 tag;
	268	u8 disable;
	269	u8 ownership;
	270	u8 deactivated;
	271	u8 readPubek;
	272	u8 disableOwnerClear;
	273	u8 allowMaintenance;
	274	u8 physicalPresenceLifetimeLock;
	275	u8 physicalPresenceHWEnable;
	276	u8 physicalPresenceCMDEnable;
	277	u8 CEKPUsed;
	278	u8 TPMpost;
	279	u8 TPMpostLock;
	280	u8 FIPS;
	281	u8 operator;
	282	u8 enableRevokeEK;
	283	u8 nvLocked;
	284	u8 readSRKPub;
	285	u8 tpmEstablished;
	286	u8 maintenanceDone;
	287	u8 disableFullDALogicInfo;
	288	} __packed;
	289
	290	typedef union {
	291	struct permanent_flags_t perm_flags;
	292	struct stclear_flags_t stclear_flags;
	293	bool owned;
	294	__be32 num_pcrs;
	295	struct tpm_version_t tpm_version;
	296	struct tpm_version_1_2_t tpm_version_1_2;
	297	__be32 manufacturer_id;
	298	struct timeout_t timeout;
	299	struct duration_t duration;
	300	} cap_t;
	301
	302	enum tpm_capabilities {
	303	TPM_CAP_FLAG = cpu_to_be32(4),
	304	TPM_CAP_PROP = cpu_to_be32(5),
	305	CAP_VERSION_1_1 = cpu_to_be32(0x06),
	306	CAP_VERSION_1_2 = cpu_to_be32(0x1A)
	307	};
	308
	309	enum tpm_sub_capabilities {
	310	TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
	311	TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
	312	TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
	313	TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
	314	TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
	315	TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
	316	TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
	317
	318	};
	319
	320	struct tpm_getcap_params_in {
	321	__be32 cap;
	322	__be32 subcap_size;
	323	__be32 subcap;
	324	} __packed;
	325
	326	struct tpm_getcap_params_out {
	327	__be32 cap_size;
	328	cap_t cap;
	329	} __packed;
	330
	331	struct tpm_readpubek_params_out {
	332	u8 algorithm[4];
	333	u8 encscheme[2];
	334	u8 sigscheme[2];
	335	__be32 paramsize;
	336	u8 parameters[12]; /assuming RSA/
	337	__be32 keysize;
	338	u8 modulus[256];
	339	u8 checksum[20];
	340	} __packed;
	341
	342	typedef union {
	343	struct tpm_input_header in;
	344	struct tpm_output_header out;
	345	} tpm_cmd_header;
	346
	347	struct tpm_pcrread_out {
	348	u8 pcr_result[TPM_DIGEST_SIZE];
	349	} __packed;
	350
	351	struct tpm_pcrread_in {
	352	__be32 pcr_idx;
	353	} __packed;
	354
	355	struct tpm_pcrextend_in {
	356	__be32 pcr_idx;
	357	u8 hash[TPM_DIGEST_SIZE];
	358	} __packed;
	359
	360	/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
	361	* bytes, but 128 is still a relatively large number of random bytes and
	362	* anything much bigger causes users of struct tpm_cmd_t to start getting
	363	* compiler warnings about stack frame size. */
	364	#define TPM_MAX_RNG_DATA 128
	365
	366	struct tpm_getrandom_out {
	367	__be32 rng_data_len;
	368	u8 rng_data[TPM_MAX_RNG_DATA];
	369	} __packed;
	370
	371	struct tpm_getrandom_in {
	372	__be32 num_bytes;
	373	} __packed;
	374
	375	struct tpm_startup_in {
	376	__be16 startup_type;
	377	} __packed;
	378
	379	typedef union {
	380	struct tpm_getcap_params_out getcap_out;
	381	struct tpm_readpubek_params_out readpubek_out;
	382	u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
	383	struct tpm_getcap_params_in getcap_in;
	384	struct tpm_pcrread_in pcrread_in;
	385	struct tpm_pcrread_out pcrread_out;
	386	struct tpm_pcrextend_in pcrextend_in;
	387	struct tpm_getrandom_in getrandom_in;
	388	struct tpm_getrandom_out getrandom_out;
	389	struct tpm_startup_in startup_in;
	390	} tpm_cmd_params;
	391
	392	struct tpm_cmd_t {
	393	tpm_cmd_header header;
	394	tpm_cmd_params params;
	395	} __packed;
	396
	397	/* A string buffer type for constructing TPM commands. This is based on the
	398	* ideas of string buffer code in security/keys/trusted.h but is heap based
	399	* in order to keep the stack usage minimal.
	400	*/
	401
	402	enum tpm_buf_flags {
	403	TPM_BUF_OVERFLOW = BIT(0),
	404	};
	405
	406	struct tpm_buf {
	407	struct page *data_page;
	408	unsigned int flags;
	409	u8 *data;
	410	};
	411
	412	static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
	413	{
	414	struct tpm_input_header *head;
	415
	416	buf->data_page = alloc_page(GFP_HIGHUSER);
	417	if (!buf->data_page)
	418	return -ENOMEM;
	419
	420	buf->flags = 0;
	421	buf->data = kmap(buf->data_page);
	422
	423	head = (struct tpm_input_header *) buf->data;
	424
	425	head->tag = cpu_to_be16(tag);
	426	head->length = cpu_to_be32(sizeof(*head));
	427	head->ordinal = cpu_to_be32(ordinal);
	428
	429	return 0;
	430	}
	431
	432	static inline void tpm_buf_destroy(struct tpm_buf *buf)
	433	{
	434	kunmap(buf->data_page);
	435	__free_page(buf->data_page);
	436	}
	437
	438	static inline u32 tpm_buf_length(struct tpm_buf *buf)
	439	{
	440	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	441
	442	return be32_to_cpu(head->length);
	443	}
	444
	445	static inline u16 tpm_buf_tag(struct tpm_buf *buf)
	446	{
	447	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	448
	449	return be16_to_cpu(head->tag);
	450	}
	451
	452	static inline void tpm_buf_append(struct tpm_buf *buf,
	453	const unsigned char *new_data,
	454	unsigned int new_len)
	455	{
	456	struct tpm_input_header head = (struct tpm_input_header ) buf->data;
	457	u32 len = tpm_buf_length(buf);
	458
	459	/* Return silently if overflow has already happened. */
	460	if (buf->flags & TPM_BUF_OVERFLOW)
	461	return;
	462
	463	if ((len + new_len) > PAGE_SIZE) {
	464	WARN(1, "tpm_buf: overflow\n");
	465	buf->flags \|= TPM_BUF_OVERFLOW;
	466	return;
	467	}
	468
	469	memcpy(&buf->data[len], new_data, new_len);
	470	head->length = cpu_to_be32(len + new_len);
	471	}
	472
	473	static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
	474	{
	475	tpm_buf_append(buf, &value, 1);
	476	}
	477
	478	static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
	479	{
	480	__be16 value2 = cpu_to_be16(value);
	481
	482	tpm_buf_append(buf, (u8 *) &value2, 2);
	483	}
	484
	485	static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
	486	{
	487	__be32 value2 = cpu_to_be32(value);
	488
	489	tpm_buf_append(buf, (u8 *) &value2, 4);
	490	}
	491
	492	extern struct class *tpm_class;
	493	extern dev_t tpm_devt;
	494	extern const struct file_operations tpm_fops;
	495
	496	ssize_t tpm_getcap(struct device , __be32, cap_t , const char *);
	497	ssize_t tpm_transmit(struct tpm_chip chip, const char buf,
	498	size_t bufsiz);
	499	ssize_t tpm_transmit_cmd(struct tpm_chip chip, void cmd, int len,
	500	const char *desc);
	501	extern int tpm_get_timeouts(struct tpm_chip *);
	502	extern void tpm_gen_interrupt(struct tpm_chip *);
	503	extern int tpm_do_selftest(struct tpm_chip *);
	504	extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
	505	extern int tpm_pm_suspend(struct device *);
	506	extern int tpm_pm_resume(struct device *);
	507	extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
	508	wait_queue_head_t *, bool);
	509
	510	struct tpm_chip *tpm_chip_find_get(int chip_num);
	511	__must_check int tpm_try_get_ops(struct tpm_chip *chip);
	512	void tpm_put_ops(struct tpm_chip *chip);
	513
	514	extern struct tpm_chip tpmm_chip_alloc(struct device dev,
	515	const struct tpm_class_ops *ops);
	516	extern int tpm_chip_register(struct tpm_chip *chip);
	517	extern void tpm_chip_unregister(struct tpm_chip *chip);
	518
	519	int tpm_sysfs_add_device(struct tpm_chip *chip);
	520	void tpm_sysfs_del_device(struct tpm_chip *chip);
	521
	522	int tpm_pcr_read_dev(struct tpm_chip chip, int pcr_idx, u8 res_buf);
	523
	524	#ifdef CONFIG_ACPI
	525	extern void tpm_add_ppi(struct tpm_chip *chip);
	526	#else
	527	static inline void tpm_add_ppi(struct tpm_chip *chip)
	528	{
	529	}
	530	#endif
	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);
	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);
	541	ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
	542	u32 value, const char desc);
	543
	544	extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type);
	545	extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
	546	extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32);
	547	extern int tpm2_do_selftest(struct tpm_chip *chip);
	548	extern int tpm2_gen_interrupt(struct tpm_chip *chip);
	549	extern int tpm2_probe(struct tpm_chip *chip);