[linux-block.git] / include / linux / tpm.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2004,2007,2008 IBM 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>
 * Debora Velarde <dvelarde@us.ibm.com>
 *
 * Maintained by: <tpmdd_devel@lists.sourceforge.net>
 *
 * Device driver for TCG/TCPA TPM (trusted platform module).
 * Specifications at www.trustedcomputinggroup.org
 */
#ifndef __LINUX_TPM_H__
#define __LINUX_TPM_H__

#include <linux/hw_random.h>
#include <linux/acpi.h>
#include <linux/cdev.h>
#include <linux/fs.h>
#include <crypto/hash_info.h>

#define TPM_DIGEST_SIZE 20	/* Max TPM v1.2 PCR size */
#define TPM_MAX_DIGEST_SIZE SHA512_DIGEST_SIZE

struct tpm_chip;
struct trusted_key_payload;
struct trusted_key_options;

enum tpm_algorithms {
	TPM_ALG_ERROR		= 0x0000,
	TPM_ALG_SHA1		= 0x0004,
	TPM_ALG_KEYEDHASH	= 0x0008,
	TPM_ALG_SHA256		= 0x000B,
	TPM_ALG_SHA384		= 0x000C,
	TPM_ALG_SHA512		= 0x000D,
	TPM_ALG_NULL		= 0x0010,
	TPM_ALG_SM3_256		= 0x0012,
};

struct tpm_digest {
	u16 alg_id;
	u8 digest[TPM_MAX_DIGEST_SIZE];
} __packed;

struct tpm_bank_info {
	u16 alg_id;
	u16 digest_size;
	u16 crypto_id;
};

enum TPM_OPS_FLAGS {
	TPM_OPS_AUTO_STARTUP = BIT(0),
};

struct tpm_class_ops {
	unsigned int flags;
	const u8 req_complete_mask;
	const u8 req_complete_val;
	bool (*req_canceled)(struct tpm_chip *chip, u8 status);
	int (*recv) (struct tpm_chip *chip, u8 *buf, size_t len);
	int (*send) (struct tpm_chip *chip, u8 *buf, size_t len);
	void (*cancel) (struct tpm_chip *chip);
	u8 (*status) (struct tpm_chip *chip);
	void (*update_timeouts)(struct tpm_chip *chip,
				unsigned long *timeout_cap);
	int (*go_idle)(struct tpm_chip *chip);
	int (*cmd_ready)(struct tpm_chip *chip);
	int (*request_locality)(struct tpm_chip *chip, int loc);
	int (*relinquish_locality)(struct tpm_chip *chip, int loc);
	void (*clk_enable)(struct tpm_chip *chip, bool value);
};

#define TPM_NUM_EVENT_LOG_FILES		3

/* Indexes the duration array */
enum tpm_duration {
	TPM_SHORT = 0,
	TPM_MEDIUM = 1,
	TPM_LONG = 2,
	TPM_LONG_LONG = 3,
	TPM_UNDEFINED,
	TPM_NUM_DURATIONS = TPM_UNDEFINED,
};

#define TPM_PPI_VERSION_LEN		3

struct tpm_space {
	u32 context_tbl[3];
	u8 *context_buf;
	u32 session_tbl[3];
	u8 *session_buf;
};

struct tpm_bios_log {
	void *bios_event_log;
	void *bios_event_log_end;
};

struct tpm_chip_seqops {
	struct tpm_chip *chip;
	const struct seq_operations *seqops;
};

struct tpm_chip {
	struct device dev;
	struct device devs;
	struct cdev cdev;
	struct cdev cdevs;

	/* A driver callback under ops cannot be run unless ops_sem is held
	 * (sometimes implicitly, eg for the sysfs code). ops becomes null
	 * when the driver is unregistered, see tpm_try_get_ops.
	 */
	struct rw_semaphore ops_sem;
	const struct tpm_class_ops *ops;

	struct tpm_bios_log log;
	struct tpm_chip_seqops bin_log_seqops;
	struct tpm_chip_seqops ascii_log_seqops;

	unsigned int flags;

	int dev_num;		/* /dev/tpm# */
	unsigned long is_open;	/* only one allowed */

	char hwrng_name[64];
	struct hwrng hwrng;

	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[TPM_NUM_DURATIONS]; /* jiffies */
	bool duration_adjusted;

	struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];

	const struct attribute_group *groups[3];
	unsigned int groups_cnt;

	u32 nr_allocated_banks;
	struct tpm_bank_info *allocated_banks;
#ifdef CONFIG_ACPI
	acpi_handle acpi_dev_handle;
	char ppi_version[TPM_PPI_VERSION_LEN + 1];
#endif /* CONFIG_ACPI */

	struct tpm_space work_space;
	u32 last_cc;
	u32 nr_commands;
	u32 *cc_attrs_tbl;

	/* active locality */
	int locality;
};

#if defined(CONFIG_TCG_TPM) || defined(CONFIG_TCG_TPM_MODULE)

extern int tpm_is_tpm2(struct tpm_chip *chip);
extern int tpm_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
			struct tpm_digest *digest);
extern int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
			  struct tpm_digest *digests);
extern int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen);
extern int tpm_get_random(struct tpm_chip *chip, u8 *data, size_t max);
extern int tpm_seal_trusted(struct tpm_chip *chip,
			    struct trusted_key_payload *payload,
			    struct trusted_key_options *options);
extern int tpm_unseal_trusted(struct tpm_chip *chip,
			      struct trusted_key_payload *payload,
			      struct trusted_key_options *options);
extern struct tpm_chip *tpm_default_chip(void);
#else
static inline int tpm_is_tpm2(struct tpm_chip *chip)
{
	return -ENODEV;
}

static inline int tpm_pcr_read(struct tpm_chip *chip, int pcr_idx,
			       struct tpm_digest *digest)
{
	return -ENODEV;
}

static inline int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
				 struct tpm_digest *digests)
{
	return -ENODEV;
}

static inline int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen)
{
	return -ENODEV;
}
static inline int tpm_get_random(struct tpm_chip *chip, u8 *data, size_t max)
{
	return -ENODEV;
}

static inline int tpm_seal_trusted(struct tpm_chip *chip,
				   struct trusted_key_payload *payload,
				   struct trusted_key_options *options)
{
	return -ENODEV;
}
static inline int tpm_unseal_trusted(struct tpm_chip *chip,
				     struct trusted_key_payload *payload,
				     struct trusted_key_options *options)
{
	return -ENODEV;
}
static inline struct tpm_chip *tpm_default_chip(void)
{
	return NULL;
}
#endif
#endif
Commit	Line	Data
b886d83c	1	/* SPDX-License-Identifier: GPL-2.0-only */
659aaf2b RA	2	/*
	3	* Copyright (C) 2004,2007,2008 IBM 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	* Debora Velarde <dvelarde@us.ibm.com>
	11	*
	12	* Maintained by: <tpmdd_devel@lists.sourceforge.net>
	13	*
	14	* Device driver for TCG/TCPA TPM (trusted platform module).
	15	* Specifications at www.trustedcomputinggroup.org
659aaf2b RA	16	*/
	17	#ifndef __LINUX_TPM_H__
	18	#define __LINUX_TPM_H__
	19
901615cb RS	20	#include <linux/hw_random.h>
	21	#include <linux/acpi.h>
	22	#include <linux/cdev.h>
	23	#include <linux/fs.h>
aa042475 RS	24	#include <crypto/hash_info.h>
aa042475 RS	25
1c16c963	26	#define TPM_DIGEST_SIZE 20 /* Max TPM v1.2 PCR size */
aa042475	27	#define TPM_MAX_DIGEST_SIZE SHA512_DIGEST_SIZE
1c16c963	28
01ad1fa7	29	struct tpm_chip;
954650ef JS	30	struct trusted_key_payload;
954650ef JS	31	struct trusted_key_options;
01ad1fa7	32
aa042475 RS	33	enum tpm_algorithms {
	34	TPM_ALG_ERROR = 0x0000,
	35	TPM_ALG_SHA1 = 0x0004,
	36	TPM_ALG_KEYEDHASH = 0x0008,
	37	TPM_ALG_SHA256 = 0x000B,
	38	TPM_ALG_SHA384 = 0x000C,
	39	TPM_ALG_SHA512 = 0x000D,
	40	TPM_ALG_NULL = 0x0010,
	41	TPM_ALG_SM3_256 = 0x0012,
	42	};
	43
	44	struct tpm_digest {
	45	u16 alg_id;
	46	u8 digest[TPM_MAX_DIGEST_SIZE];
	47	} __packed;
	48
879b5892 RS	49	struct tpm_bank_info {
	50	u16 alg_id;
	51	u16 digest_size;
	52	u16 crypto_id;
	53	};
	54
cae8b441 JG	55	enum TPM_OPS_FLAGS {
	56	TPM_OPS_AUTO_STARTUP = BIT(0),
	57	};
	58
01ad1fa7	59	struct tpm_class_ops {
cae8b441	60	unsigned int flags;
01ad1fa7 JG	61	const u8 req_complete_mask;
	62	const u8 req_complete_val;
	63	bool (req_canceled)(struct tpm_chip chip, u8 status);
	64	int (recv) (struct tpm_chip chip, u8 *buf, size_t len);
	65	int (send) (struct tpm_chip chip, u8 *buf, size_t len);
	66	void (cancel) (struct tpm_chip chip);
	67	u8 (status) (struct tpm_chip chip);
36ce0897	68	void (update_timeouts)(struct tpm_chip chip,
8e54caf4	69	unsigned long *timeout_cap);
627448e8 TW	70	int (go_idle)(struct tpm_chip chip);
627448e8 TW	71	int (cmd_ready)(struct tpm_chip chip);
877c57d0	72	int (request_locality)(struct tpm_chip chip, int loc);
888d867d	73	int (relinquish_locality)(struct tpm_chip chip, int loc);
b3e958ce	74	void (clk_enable)(struct tpm_chip chip, bool value);
01ad1fa7 JG	75	};
01ad1fa7 JG	76
901615cb RS	77	#define TPM_NUM_EVENT_LOG_FILES 3
	78
	79	/* Indexes the duration array */
	80	enum tpm_duration {
	81	TPM_SHORT = 0,
	82	TPM_MEDIUM = 1,
	83	TPM_LONG = 2,
	84	TPM_LONG_LONG = 3,
	85	TPM_UNDEFINED,
	86	TPM_NUM_DURATIONS = TPM_UNDEFINED,
	87	};
	88
	89	#define TPM_PPI_VERSION_LEN 3
	90
	91	struct tpm_space {
	92	u32 context_tbl[3];
	93	u8 *context_buf;
	94	u32 session_tbl[3];
	95	u8 *session_buf;
	96	};
	97
	98	struct tpm_bios_log {
	99	void *bios_event_log;
	100	void *bios_event_log_end;
	101	};
	102
	103	struct tpm_chip_seqops {
	104	struct tpm_chip *chip;
	105	const struct seq_operations *seqops;
	106	};
	107
	108	struct tpm_chip {
	109	struct device dev;
	110	struct device devs;
	111	struct cdev cdev;
	112	struct cdev cdevs;
	113
	114	/* A driver callback under ops cannot be run unless ops_sem is held
	115	* (sometimes implicitly, eg for the sysfs code). ops becomes null
	116	* when the driver is unregistered, see tpm_try_get_ops.
	117	*/
	118	struct rw_semaphore ops_sem;
	119	const struct tpm_class_ops *ops;
	120
	121	struct tpm_bios_log log;
	122	struct tpm_chip_seqops bin_log_seqops;
	123	struct tpm_chip_seqops ascii_log_seqops;
	124
	125	unsigned int flags;
	126
	127	int dev_num; /* /dev/tpm# */
	128	unsigned long is_open; /* only one allowed */
	129
	130	char hwrng_name[64];
	131	struct hwrng hwrng;
	132
	133	struct mutex tpm_mutex; /* tpm is processing */
	134
	135	unsigned long timeout_a; /* jiffies */
	136	unsigned long timeout_b; /* jiffies */
	137	unsigned long timeout_c; /* jiffies */
	138	unsigned long timeout_d; /* jiffies */
	139	bool timeout_adjusted;
	140	unsigned long duration[TPM_NUM_DURATIONS]; /* jiffies */
141	bool duration_adjusted;
142
143	struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
144
145	const struct attribute_group *groups[3];
146	unsigned int groups_cnt;
147
148	u32 nr_allocated_banks;
149	struct tpm_bank_info *allocated_banks;
150	#ifdef CONFIG_ACPI
151	acpi_handle acpi_dev_handle;
152	char ppi_version[TPM_PPI_VERSION_LEN + 1];
153	#endif /* CONFIG_ACPI */
154
155	struct tpm_space work_space;
156	u32 last_cc;
157	u32 nr_commands;
158	u32 *cc_attrs_tbl;
159
160	/* active locality */
161	int locality;
162	};
163
ff76ec18	164	#if defined(CONFIG_TCG_TPM) \|\| defined(CONFIG_TCG_TPM_MODULE)
659aaf2b	165
aad887f6	166	extern int tpm_is_tpm2(struct tpm_chip *chip);
879b5892 RS	167	extern int tpm_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
879b5892 RS	168	struct tpm_digest *digest);
0b6cf6b9 RS	169	extern int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
0b6cf6b9 RS	170	struct tpm_digest *digests);
aad887f6 JS	171	extern int tpm_send(struct tpm_chip chip, void cmd, size_t buflen);
	172	extern int tpm_get_random(struct tpm_chip chip, u8 data, size_t max);
	173	extern int tpm_seal_trusted(struct tpm_chip *chip,
954650ef JS	174	struct trusted_key_payload *payload,
954650ef JS	175	struct trusted_key_options *options);
aad887f6	176	extern int tpm_unseal_trusted(struct tpm_chip *chip,
954650ef JS	177	struct trusted_key_payload *payload,
954650ef JS	178	struct trusted_key_options *options);
aaae8153	179	extern struct tpm_chip *tpm_default_chip(void);
d6ba4521	180	#else
aad887f6	181	static inline int tpm_is_tpm2(struct tpm_chip *chip)
954650ef JS	182	{
	183	return -ENODEV;
	184	}
95adc6b4	185
879b5892 RS	186	static inline int tpm_pcr_read(struct tpm_chip *chip, int pcr_idx,
879b5892 RS	187	struct tpm_digest *digest)
aad887f6	188	{
d6ba4521 MZ	189	return -ENODEV;
d6ba4521 MZ	190	}
95adc6b4 TW	191
95adc6b4 TW	192	static inline int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
0b6cf6b9	193	struct tpm_digest *digests)
aad887f6	194	{
d6ba4521 MZ	195	return -ENODEV;
d6ba4521 MZ	196	}
95adc6b4	197
aad887f6 JS	198	static inline int tpm_send(struct tpm_chip chip, void cmd, size_t buflen)
aad887f6 JS	199	{
c749ba91 MZ	200	return -ENODEV;
c749ba91 MZ	201	}
aad887f6 JS	202	static inline int tpm_get_random(struct tpm_chip chip, u8 data, size_t max)
aad887f6 JS	203	{
41ab999c KY	204	return -ENODEV;
41ab999c KY	205	}
954650ef	206
aad887f6	207	static inline int tpm_seal_trusted(struct tpm_chip *chip,
954650ef JS	208	struct trusted_key_payload *payload,
	209	struct trusted_key_options *options)
	210	{
	211	return -ENODEV;
	212	}
aad887f6	213	static inline int tpm_unseal_trusted(struct tpm_chip *chip,
954650ef JS	214	struct trusted_key_payload *payload,
	215	struct trusted_key_options *options)
	216	{
	217	return -ENODEV;
	218	}
aaae8153 SB	219	static inline struct tpm_chip *tpm_default_chip(void)
	220	{
	221	return NULL;
	222	}
659aaf2b RA	223	#endif
659aaf2b RA	224	#endif