[mirror_ubuntu-zesty-kernel.git] / drivers / char / tpm / tpm.h

/*
 * Copyright (C) 2004 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>
 *
 * 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/miscdevice.h>
#include <linux/platform_device.h>
#include <linux/io.h>
#include <linux/tpm.h>

enum tpm_timeout {
	TPM_TIMEOUT = 5,	/* msecs */
};

/* TPM addresses */
enum tpm_addr {
	TPM_SUPERIO_ADDR = 0x2E,
	TPM_ADDR = 0x4E,
};

#define TPM_WARN_DOING_SELFTEST 0x802
#define TPM_ERR_DEACTIVATED     0x6
#define TPM_ERR_DISABLED        0x7

#define TPM_HEADER_SIZE		10
extern ssize_t tpm_show_pubek(struct device *, struct device_attribute *attr,
				char *);
extern ssize_t tpm_show_pcrs(struct device *, struct device_attribute *attr,
				char *);
extern ssize_t tpm_show_caps(struct device *, struct device_attribute *attr,
				char *);
extern ssize_t tpm_show_caps_1_2(struct device *, struct device_attribute *attr,
				char *);
extern ssize_t tpm_store_cancel(struct device *, struct device_attribute *attr,
				const char *, size_t);
extern ssize_t tpm_show_enabled(struct device *, struct device_attribute *attr,
				char *);
extern ssize_t tpm_show_active(struct device *, struct device_attribute *attr,
				char *);
extern ssize_t tpm_show_owned(struct device *, struct device_attribute *attr,
				char *);
extern ssize_t tpm_show_temp_deactivated(struct device *,
					 struct device_attribute *attr, char *);
extern ssize_t tpm_show_durations(struct device *,
				  struct device_attribute *attr, char *);
extern ssize_t tpm_show_timeouts(struct device *,
				 struct device_attribute *attr, char *);

struct tpm_chip;

struct tpm_vendor_specific {
	const u8 req_complete_mask;
	const u8 req_complete_val;
	const u8 req_canceled;
	void __iomem *iobase;		/* ioremapped address */
	unsigned long base;		/* TPM base address */

	int irq;
	int probed_irq;

	int region_size;
	int have_region;

	int (*recv) (struct tpm_chip *, u8 *, size_t);
	int (*send) (struct tpm_chip *, u8 *, size_t);
	void (*cancel) (struct tpm_chip *);
	u8 (*status) (struct tpm_chip *);
	void (*release) (struct device *);
	struct miscdevice miscdev;
	struct attribute_group *attr_group;
	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;

	wait_queue_head_t read_queue;
	wait_queue_head_t int_queue;
};

struct tpm_chip {
	struct device *dev;	/* Device stuff */

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

	/* Data passed to and from the tpm via the read/write calls */
	u8 *data_buffer;
	atomic_t data_pending;
	struct mutex buffer_mutex;

	struct timer_list user_read_timer;	/* user needs to claim result */
	struct work_struct work;
	struct mutex tpm_mutex;	/* tpm is processing */

	struct tpm_vendor_specific vendor;

	struct dentry **bios_dir;

	struct list_head list;
	void (*release) (struct device *);
};

#define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)

static inline void tpm_chip_put(struct tpm_chip *chip)
{
	module_put(chip->dev->driver->owner);
}

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;
}__attribute__((packed));

struct tpm_output_header {
	__be16	tag;
	__be32	length;
	__be32	return_code;
}__attribute__((packed));

struct	stclear_flags_t {
	__be16	tag;
	u8	deactivated;
	u8	disableForceClear;
	u8	physicalPresence;
	u8	physicalPresenceLock;
	u8	bGlobalLock;
}__attribute__((packed));

struct	tpm_version_t {
	u8	Major;
	u8	Minor;
	u8	revMajor;
	u8	revMinor;
}__attribute__((packed));

struct	tpm_version_1_2_t {
	__be16	tag;
	u8	Major;
	u8	Minor;
	u8	revMajor;
	u8	revMinor;
}__attribute__((packed));

struct	timeout_t {
	__be32	a;
	__be32	b;
	__be32	c;
	__be32	d;
}__attribute__((packed));

struct duration_t {
	__be32	tpm_short;
	__be32	tpm_medium;
	__be32	tpm_long;
}__attribute__((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;
}__attribute__((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;

struct	tpm_getcap_params_in {
	__be32	cap;
	__be32	subcap_size;
	__be32	subcap;
}__attribute__((packed));

struct	tpm_getcap_params_out {
	__be32	cap_size;
	cap_t	cap;
}__attribute__((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];
}__attribute__((packed));

typedef union {
	struct	tpm_input_header in;
	struct	tpm_output_header out;
} tpm_cmd_header;

#define TPM_DIGEST_SIZE 20
struct tpm_pcrread_out {
	u8	pcr_result[TPM_DIGEST_SIZE];
}__attribute__((packed));

struct tpm_pcrread_in {
	__be32	pcr_idx;
}__attribute__((packed));

struct tpm_pcrextend_in {
	__be32	pcr_idx;
	u8	hash[TPM_DIGEST_SIZE];
}__attribute__((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;
} tpm_cmd_params;

struct tpm_cmd_t {
	tpm_cmd_header	header;
	tpm_cmd_params	params;
}__attribute__((packed));

ssize_t	tpm_getcap(struct device *, __be32, cap_t *, const char *);

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 struct tpm_chip* tpm_register_hardware(struct device *,
				 const struct tpm_vendor_specific *);
extern int tpm_open(struct inode *, struct file *);
extern int tpm_release(struct inode *, struct file *);
extern void tpm_dev_vendor_release(struct tpm_chip *);
extern ssize_t tpm_write(struct file *, const char __user *, size_t,
			 loff_t *);
extern ssize_t tpm_read(struct file *, char __user *, size_t, loff_t *);
extern void tpm_remove_hardware(struct device *);
extern int tpm_pm_suspend(struct device *, pm_message_t);
extern int tpm_pm_resume(struct device *);
extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
			     wait_queue_head_t *);
#ifdef CONFIG_ACPI
extern struct dentry ** tpm_bios_log_setup(char *);
extern void tpm_bios_log_teardown(struct dentry **);
#else
static inline struct dentry ** tpm_bios_log_setup(char *name)
{
	return NULL;
}
static inline void tpm_bios_log_teardown(struct dentry **dir)
{
}
#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright (C) 2004 IBM Corporation
	3	*
	4	* Authors:
	5	* Leendert van Doorn <leendert@watson.ibm.com>
	6	* Dave Safford <safford@watson.ibm.com>
	7	* Reiner Sailer <sailer@watson.ibm.com>
	8	* Kylene Hall <kjhall@us.ibm.com>
	9	*
8e81cc13	10	* Maintained by: <tpmdd-devel@lists.sourceforge.net>
1da177e4 LT	11	*
	12	* Device driver for TCG/TCPA TPM (trusted platform module).
	13	* Specifications at www.trustedcomputinggroup.org
	14	*
	15	* This program is free software; you can redistribute it and/or
	16	* modify it under the terms of the GNU General Public License as
	17	* published by the Free Software Foundation, version 2 of the
	18	* License.
	19	*
	20	*/
	21	#include <linux/module.h>
1da177e4 LT	22	#include <linux/delay.h>
1da177e4 LT	23	#include <linux/fs.h>
d081d470	24	#include <linux/mutex.h>
914e2637	25	#include <linux/sched.h>
1da177e4	26	#include <linux/miscdevice.h>
bbc5b212	27	#include <linux/platform_device.h>
276ad0c1	28	#include <linux/io.h>
659aaf2b	29	#include <linux/tpm.h>
1da177e4	30
3122a88a KH	31	enum tpm_timeout {
	32	TPM_TIMEOUT = 5, /* msecs */
	33	};
1da177e4 LT	34
1da177e4 LT	35	/* TPM addresses */
3122a88a	36	enum tpm_addr {
daacdfa6	37	TPM_SUPERIO_ADDR = 0x2E,
3122a88a	38	TPM_ADDR = 0x4E,
3122a88a KH	39	};
3122a88a KH	40
68d6e671	41	#define TPM_WARN_DOING_SELFTEST 0x802
be405411 SB	42	#define TPM_ERR_DEACTIVATED 0x6
	43	#define TPM_ERR_DISABLED 0x7
	44
b9e3238a	45	#define TPM_HEADER_SIZE 10
6659ca2a KH	46	extern ssize_t tpm_show_pubek(struct device , struct device_attribute attr,
	47	char *);
	48	extern ssize_t tpm_show_pcrs(struct device , struct device_attribute attr,
	49	char *);
	50	extern ssize_t tpm_show_caps(struct device , struct device_attribute attr,
	51	char *);
08e96e48 KJH	52	extern ssize_t tpm_show_caps_1_2(struct device , struct device_attribute attr,
08e96e48 KJH	53	char *);
6659ca2a KH	54	extern ssize_t tpm_store_cancel(struct device , struct device_attribute attr,
6659ca2a KH	55	const char *, size_t);
08e96e48 KJH	56	extern ssize_t tpm_show_enabled(struct device , struct device_attribute attr,
	57	char *);
	58	extern ssize_t tpm_show_active(struct device , struct device_attribute attr,
	59	char *);
	60	extern ssize_t tpm_show_owned(struct device , struct device_attribute attr,
	61	char *);
	62	extern ssize_t tpm_show_temp_deactivated(struct device *,
	63	struct device_attribute attr, char );
04ab2293 SB	64	extern ssize_t tpm_show_durations(struct device *,
04ab2293 SB	65	struct device_attribute attr, char );
62592101 SB	66	extern ssize_t tpm_show_timeouts(struct device *,
62592101 SB	67	struct device_attribute attr, char );
1da177e4 LT	68
	69	struct tpm_chip;
	70
	71	struct tpm_vendor_specific {
e0dd03ca KJH	72	const u8 req_complete_mask;
	73	const u8 req_complete_val;
	74	const u8 req_canceled;
ad5ea3cc KJH	75	void __iomem iobase; / ioremapped address */
	76	unsigned long base; /* TPM base address */
	77
27084efe	78	int irq;
a7b66822	79	int probed_irq;
27084efe	80
ad5ea3cc KJH	81	int region_size;
ad5ea3cc KJH	82	int have_region;
1da177e4 LT	83
	84	int (recv) (struct tpm_chip , u8 *, size_t);
	85	int (send) (struct tpm_chip , u8 *, size_t);
	86	void (cancel) (struct tpm_chip );
b4ed3e3c	87	u8 (status) (struct tpm_chip );
5bd91f18	88	void (release) (struct device );
1da177e4	89	struct miscdevice miscdev;
6659ca2a	90	struct attribute_group *attr_group;
27084efe LD	91	struct list_head list;
27084efe LD	92	int locality;
36b20020	93	unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
62592101	94	bool timeout_adjusted;
36b20020	95	unsigned long duration[3]; /* jiffies */
04ab2293	96	bool duration_adjusted;
27084efe LD	97
	98	wait_queue_head_t read_queue;
	99	wait_queue_head_t int_queue;
1da177e4 LT	100	};
	101
	102	struct tpm_chip {
e659a3fe	103	struct device dev; / Device stuff */
1da177e4 LT	104
1da177e4 LT	105	int dev_num; /* /dev/tpm# */
dc36d32c	106	unsigned long is_open; /* only one allowed */
1da177e4 LT	107	int time_expired;
	108
	109	/* Data passed to and from the tpm via the read/write calls */
	110	u8 *data_buffer;
	111	atomic_t data_pending;
d081d470	112	struct mutex buffer_mutex;
1da177e4 LT	113
1da177e4 LT	114	struct timer_list user_read_timer; /* user needs to claim result */
09e12f9f	115	struct work_struct work;
d081d470	116	struct mutex tpm_mutex; /* tpm is processing */
1da177e4	117
90dda520	118	struct tpm_vendor_specific vendor;
1da177e4	119
55a82ab3 KJH	120	struct dentry **bios_dir;
55a82ab3 KJH	121
1da177e4	122	struct list_head list;
5bd91f18	123	void (release) (struct device );
1da177e4 LT	124	};
1da177e4 LT	125
27084efe LD	126	#define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
27084efe LD	127
a0e39349 MZ	128	static inline void tpm_chip_put(struct tpm_chip *chip)
	129	{
	130	module_put(chip->dev->driver->owner);
	131	}
	132
daacdfa6	133	static inline int tpm_read_index(int base, int index)
1da177e4	134	{
daacdfa6 KJH	135	outb(index, base);
daacdfa6 KJH	136	return inb(base+1) & 0xFF;
1da177e4 LT	137	}
1da177e4 LT	138
daacdfa6	139	static inline void tpm_write_index(int base, int index, int value)
1da177e4	140	{
daacdfa6 KJH	141	outb(index, base);
daacdfa6 KJH	142	outb(value & 0xFF, base+1);
1da177e4	143	}
08837438 RA	144	struct tpm_input_header {
	145	__be16 tag;
	146	__be32 length;
	147	__be32 ordinal;
	148	}__attribute__((packed));
	149
	150	struct tpm_output_header {
	151	__be16 tag;
	152	__be32 length;
	153	__be32 return_code;
	154	}__attribute__((packed));
	155
	156	struct stclear_flags_t {
	157	__be16 tag;
	158	u8 deactivated;
	159	u8 disableForceClear;
	160	u8 physicalPresence;
	161	u8 physicalPresenceLock;
	162	u8 bGlobalLock;
	163	}__attribute__((packed));
	164
	165	struct tpm_version_t {
	166	u8 Major;
	167	u8 Minor;
	168	u8 revMajor;
	169	u8 revMinor;
	170	}__attribute__((packed));
	171
	172	struct tpm_version_1_2_t {
	173	__be16 tag;
	174	u8 Major;
	175	u8 Minor;
	176	u8 revMajor;
	177	u8 revMinor;
	178	}__attribute__((packed));
	179
	180	struct timeout_t {
	181	__be32 a;
	182	__be32 b;
	183	__be32 c;
	184	__be32 d;
	185	}__attribute__((packed));
	186
	187	struct duration_t {
	188	__be32 tpm_short;
	189	__be32 tpm_medium;
	190	__be32 tpm_long;
	191	}__attribute__((packed));
	192
	193	struct permanent_flags_t {
	194	__be16 tag;
	195	u8 disable;
	196	u8 ownership;
	197	u8 deactivated;
	198	u8 readPubek;
	199	u8 disableOwnerClear;
	200	u8 allowMaintenance;
	201	u8 physicalPresenceLifetimeLock;
	202	u8 physicalPresenceHWEnable;
	203	u8 physicalPresenceCMDEnable;
	204	u8 CEKPUsed;
	205	u8 TPMpost;
	206	u8 TPMpostLock;
	207	u8 FIPS;
208	u8 operator;
209	u8 enableRevokeEK;
210	u8 nvLocked;
211	u8 readSRKPub;
212	u8 tpmEstablished;
213	u8 maintenanceDone;
214	u8 disableFullDALogicInfo;
215	}__attribute__((packed));
216
217	typedef union {
218	struct permanent_flags_t perm_flags;
219	struct stclear_flags_t stclear_flags;
220	bool owned;
221	__be32 num_pcrs;
222	struct tpm_version_t tpm_version;
223	struct tpm_version_1_2_t tpm_version_1_2;
224	__be32 manufacturer_id;
225	struct timeout_t timeout;
226	struct duration_t duration;
227	} cap_t;
228
229	struct tpm_getcap_params_in {
230	__be32 cap;
231	__be32 subcap_size;
232	__be32 subcap;
233	}__attribute__((packed));
234
235	struct tpm_getcap_params_out {
236	__be32 cap_size;
237	cap_t cap;
238	}__attribute__((packed));
239
240	struct tpm_readpubek_params_out {
241	u8 algorithm[4];
242	u8 encscheme[2];
243	u8 sigscheme[2];
02a077c5	244	__be32 paramsize;
08837438 RA	245	u8 parameters[12]; /assuming RSA/
	246	__be32 keysize;
	247	u8 modulus[256];
	248	u8 checksum[20];
	249	}__attribute__((packed));
	250
	251	typedef union {
	252	struct tpm_input_header in;
	253	struct tpm_output_header out;
	254	} tpm_cmd_header;
	255
659aaf2b RA	256	#define TPM_DIGEST_SIZE 20
	257	struct tpm_pcrread_out {
	258	u8 pcr_result[TPM_DIGEST_SIZE];
	259	}__attribute__((packed));
	260
	261	struct tpm_pcrread_in {
	262	__be32 pcr_idx;
	263	}__attribute__((packed));
	264
	265	struct tpm_pcrextend_in {
	266	__be32 pcr_idx;
	267	u8 hash[TPM_DIGEST_SIZE];
	268	}__attribute__((packed));
	269
08837438 RA	270	typedef union {
	271	struct tpm_getcap_params_out getcap_out;
	272	struct tpm_readpubek_params_out readpubek_out;
	273	u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
	274	struct tpm_getcap_params_in getcap_in;
659aaf2b RA	275	struct tpm_pcrread_in pcrread_in;
	276	struct tpm_pcrread_out pcrread_out;
	277	struct tpm_pcrextend_in pcrextend_in;
08837438 RA	278	} tpm_cmd_params;
	279
	280	struct tpm_cmd_t {
	281	tpm_cmd_header header;
	282	tpm_cmd_params params;
	283	}__attribute__((packed));
	284
	285	ssize_t tpm_getcap(struct device , __be32, cap_t , const char *);
1da177e4	286
2b30a90f	287	extern int tpm_get_timeouts(struct tpm_chip *);
08e96e48	288	extern void tpm_gen_interrupt(struct tpm_chip *);
68d6e671	289	extern int tpm_do_selftest(struct tpm_chip *);
9e18ee19	290	extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
e0dd03ca KJH	291	extern struct tpm_chip* tpm_register_hardware(struct device *,
e0dd03ca KJH	292	const struct tpm_vendor_specific *);
1da177e4 LT	293	extern int tpm_open(struct inode , struct file );
1da177e4 LT	294	extern int tpm_release(struct inode , struct file );
253115b7	295	extern void tpm_dev_vendor_release(struct tpm_chip *);
1da177e4 LT	296	extern ssize_t tpm_write(struct file , const char __user , size_t,
	297	loff_t *);
	298	extern ssize_t tpm_read(struct file , char __user , size_t, loff_t *);
e659a3fe	299	extern void tpm_remove_hardware(struct device *);
ce2c87d4 KJH	300	extern int tpm_pm_suspend(struct device *, pm_message_t);
ce2c87d4 KJH	301	extern int tpm_pm_resume(struct device *);
fd048866 RA	302	extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
fd048866 RA	303	wait_queue_head_t *);
55a82ab3 KJH	304	#ifdef CONFIG_ACPI
	305	extern struct dentry ** tpm_bios_log_setup(char *);
	306	extern void tpm_bios_log_teardown(struct dentry **);
	307	#else
bb53a761	308	static inline struct dentry ** tpm_bios_log_setup(char *name)
55a82ab3 KJH	309	{
	310	return NULL;
	311	}
	312	static inline void tpm_bios_log_teardown(struct dentry **dir)
	313	{
	314	}
	315	#endif