[mirror_ubuntu-artful-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_const {
	TPM_MINOR = 224,	/* officially assigned */
	TPM_BUFSIZE = 4096,
	TPM_NUM_DEVICES = 256,
};

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;
	void *data;

	wait_queue_head_t read_queue;
	wait_queue_head_t int_queue;
};

#define TPM_VID_INTEL    0x8086

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

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

struct tpm_getrandom_in {
	__be32 num_bytes;
}__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;
	struct	tpm_getrandom_in getrandom_in;
	struct	tpm_getrandom_out getrandom_out;
} 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 *);
extern int tpm_pm_resume(struct device *);
extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
			     wait_queue_head_t *);
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
41ab999c KY	31	enum tpm_const {
	32	TPM_MINOR = 224, /* officially assigned */
	33	TPM_BUFSIZE = 4096,
	34	TPM_NUM_DEVICES = 256,
	35	};
	36
3122a88a KH	37	enum tpm_timeout {
	38	TPM_TIMEOUT = 5, /* msecs */
	39	};
1da177e4 LT	40
1da177e4 LT	41	/* TPM addresses */
3122a88a	42	enum tpm_addr {
daacdfa6	43	TPM_SUPERIO_ADDR = 0x2E,
3122a88a	44	TPM_ADDR = 0x4E,
3122a88a KH	45	};
3122a88a KH	46
68d6e671	47	#define TPM_WARN_DOING_SELFTEST 0x802
be405411 SB	48	#define TPM_ERR_DEACTIVATED 0x6
	49	#define TPM_ERR_DISABLED 0x7
	50
b9e3238a	51	#define TPM_HEADER_SIZE 10
6659ca2a KH	52	extern ssize_t tpm_show_pubek(struct device , struct device_attribute attr,
	53	char *);
	54	extern ssize_t tpm_show_pcrs(struct device , struct device_attribute attr,
	55	char *);
	56	extern ssize_t tpm_show_caps(struct device , struct device_attribute attr,
	57	char *);
08e96e48 KJH	58	extern ssize_t tpm_show_caps_1_2(struct device , struct device_attribute attr,
08e96e48 KJH	59	char *);
6659ca2a KH	60	extern ssize_t tpm_store_cancel(struct device , struct device_attribute attr,
6659ca2a KH	61	const char *, size_t);
08e96e48 KJH	62	extern ssize_t tpm_show_enabled(struct device , struct device_attribute attr,
	63	char *);
	64	extern ssize_t tpm_show_active(struct device , struct device_attribute attr,
	65	char *);
	66	extern ssize_t tpm_show_owned(struct device , struct device_attribute attr,
	67	char *);
	68	extern ssize_t tpm_show_temp_deactivated(struct device *,
	69	struct device_attribute attr, char );
04ab2293 SB	70	extern ssize_t tpm_show_durations(struct device *,
04ab2293 SB	71	struct device_attribute attr, char );
62592101 SB	72	extern ssize_t tpm_show_timeouts(struct device *,
62592101 SB	73	struct device_attribute attr, char );
1da177e4 LT	74
	75	struct tpm_chip;
	76
	77	struct tpm_vendor_specific {
e0dd03ca KJH	78	const u8 req_complete_mask;
	79	const u8 req_complete_val;
	80	const u8 req_canceled;
ad5ea3cc KJH	81	void __iomem iobase; / ioremapped address */
	82	unsigned long base; /* TPM base address */
	83
27084efe	84	int irq;
a7b66822	85	int probed_irq;
27084efe	86
ad5ea3cc KJH	87	int region_size;
ad5ea3cc KJH	88	int have_region;
1da177e4 LT	89
	90	int (recv) (struct tpm_chip , u8 *, size_t);
	91	int (send) (struct tpm_chip , u8 *, size_t);
	92	void (cancel) (struct tpm_chip );
b4ed3e3c	93	u8 (status) (struct tpm_chip );
5bd91f18	94	void (release) (struct device );
1da177e4	95	struct miscdevice miscdev;
6659ca2a	96	struct attribute_group *attr_group;
27084efe LD	97	struct list_head list;
27084efe LD	98	int locality;
36b20020	99	unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
62592101	100	bool timeout_adjusted;
36b20020	101	unsigned long duration[3]; /* jiffies */
04ab2293	102	bool duration_adjusted;
132f7629	103	void *data;
27084efe LD	104
	105	wait_queue_head_t read_queue;
	106	wait_queue_head_t int_queue;
1da177e4 LT	107	};
1da177e4 LT	108
4e401fb0 SB	109	#define TPM_VID_INTEL 0x8086
4e401fb0 SB	110
1da177e4	111	struct tpm_chip {
e659a3fe	112	struct device dev; / Device stuff */
1da177e4 LT	113
1da177e4 LT	114	int dev_num; /* /dev/tpm# */
dc36d32c	115	unsigned long is_open; /* only one allowed */
1da177e4 LT	116	int time_expired;
	117
	118	/* Data passed to and from the tpm via the read/write calls */
	119	u8 *data_buffer;
	120	atomic_t data_pending;
d081d470	121	struct mutex buffer_mutex;
1da177e4 LT	122
1da177e4 LT	123	struct timer_list user_read_timer; /* user needs to claim result */
09e12f9f	124	struct work_struct work;
d081d470	125	struct mutex tpm_mutex; /* tpm is processing */
1da177e4	126
90dda520	127	struct tpm_vendor_specific vendor;
1da177e4	128
55a82ab3 KJH	129	struct dentry **bios_dir;
55a82ab3 KJH	130
1da177e4	131	struct list_head list;
5bd91f18	132	void (release) (struct device );
1da177e4 LT	133	};
1da177e4 LT	134
27084efe LD	135	#define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
27084efe LD	136
a0e39349 MZ	137	static inline void tpm_chip_put(struct tpm_chip *chip)
	138	{
	139	module_put(chip->dev->driver->owner);
	140	}
	141
daacdfa6	142	static inline int tpm_read_index(int base, int index)
1da177e4	143	{
daacdfa6 KJH	144	outb(index, base);
daacdfa6 KJH	145	return inb(base+1) & 0xFF;
1da177e4 LT	146	}
1da177e4 LT	147
daacdfa6	148	static inline void tpm_write_index(int base, int index, int value)
1da177e4	149	{
daacdfa6 KJH	150	outb(index, base);
daacdfa6 KJH	151	outb(value & 0xFF, base+1);
1da177e4	152	}
08837438 RA	153	struct tpm_input_header {
	154	__be16 tag;
	155	__be32 length;
	156	__be32 ordinal;
	157	}__attribute__((packed));
	158
	159	struct tpm_output_header {
	160	__be16 tag;
	161	__be32 length;
	162	__be32 return_code;
	163	}__attribute__((packed));
	164
	165	struct stclear_flags_t {
	166	__be16 tag;
	167	u8 deactivated;
	168	u8 disableForceClear;
	169	u8 physicalPresence;
	170	u8 physicalPresenceLock;
	171	u8 bGlobalLock;
	172	}__attribute__((packed));
	173
	174	struct tpm_version_t {
	175	u8 Major;
	176	u8 Minor;
	177	u8 revMajor;
	178	u8 revMinor;
	179	}__attribute__((packed));
	180
	181	struct tpm_version_1_2_t {
	182	__be16 tag;
	183	u8 Major;
	184	u8 Minor;
	185	u8 revMajor;
	186	u8 revMinor;
	187	}__attribute__((packed));
	188
	189	struct timeout_t {
	190	__be32 a;
	191	__be32 b;
	192	__be32 c;
	193	__be32 d;
	194	}__attribute__((packed));
	195
	196	struct duration_t {
	197	__be32 tpm_short;
	198	__be32 tpm_medium;
	199	__be32 tpm_long;
	200	}__attribute__((packed));
	201
	202	struct permanent_flags_t {
	203	__be16 tag;
	204	u8 disable;
	205	u8 ownership;
	206	u8 deactivated;
	207	u8 readPubek;
	208	u8 disableOwnerClear;
	209	u8 allowMaintenance;
	210	u8 physicalPresenceLifetimeLock;
	211	u8 physicalPresenceHWEnable;
	212	u8 physicalPresenceCMDEnable;
	213	u8 CEKPUsed;
	214	u8 TPMpost;
	215	u8 TPMpostLock;
	216	u8 FIPS;
217	u8 operator;
218	u8 enableRevokeEK;
219	u8 nvLocked;
220	u8 readSRKPub;
221	u8 tpmEstablished;
222	u8 maintenanceDone;
223	u8 disableFullDALogicInfo;
224	}__attribute__((packed));
225
226	typedef union {
227	struct permanent_flags_t perm_flags;
228	struct stclear_flags_t stclear_flags;
229	bool owned;
230	__be32 num_pcrs;
231	struct tpm_version_t tpm_version;
232	struct tpm_version_1_2_t tpm_version_1_2;
233	__be32 manufacturer_id;
234	struct timeout_t timeout;
235	struct duration_t duration;
236	} cap_t;
237
238	struct tpm_getcap_params_in {
239	__be32 cap;
240	__be32 subcap_size;
241	__be32 subcap;
242	}__attribute__((packed));
243
244	struct tpm_getcap_params_out {
245	__be32 cap_size;
246	cap_t cap;
247	}__attribute__((packed));
248
249	struct tpm_readpubek_params_out {
250	u8 algorithm[4];
251	u8 encscheme[2];
252	u8 sigscheme[2];
02a077c5	253	__be32 paramsize;
08837438 RA	254	u8 parameters[12]; /assuming RSA/
	255	__be32 keysize;
	256	u8 modulus[256];
	257	u8 checksum[20];
	258	}__attribute__((packed));
	259
	260	typedef union {
	261	struct tpm_input_header in;
	262	struct tpm_output_header out;
	263	} tpm_cmd_header;
	264
659aaf2b RA	265	#define TPM_DIGEST_SIZE 20
	266	struct tpm_pcrread_out {
	267	u8 pcr_result[TPM_DIGEST_SIZE];
	268	}__attribute__((packed));
	269
	270	struct tpm_pcrread_in {
	271	__be32 pcr_idx;
	272	}__attribute__((packed));
	273
	274	struct tpm_pcrextend_in {
	275	__be32 pcr_idx;
	276	u8 hash[TPM_DIGEST_SIZE];
	277	}__attribute__((packed));
	278
41ab999c KY	279	/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
	280	* bytes, but 128 is still a relatively large number of random bytes and
	281	* anything much bigger causes users of struct tpm_cmd_t to start getting
	282	* compiler warnings about stack frame size. */
	283	#define TPM_MAX_RNG_DATA 128
	284
	285	struct tpm_getrandom_out {
	286	__be32 rng_data_len;
	287	u8 rng_data[TPM_MAX_RNG_DATA];
	288	}__attribute__((packed));
	289
	290	struct tpm_getrandom_in {
	291	__be32 num_bytes;
	292	}__attribute__((packed));
	293
08837438 RA	294	typedef union {
	295	struct tpm_getcap_params_out getcap_out;
	296	struct tpm_readpubek_params_out readpubek_out;
	297	u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
	298	struct tpm_getcap_params_in getcap_in;
659aaf2b RA	299	struct tpm_pcrread_in pcrread_in;
	300	struct tpm_pcrread_out pcrread_out;
	301	struct tpm_pcrextend_in pcrextend_in;
41ab999c KY	302	struct tpm_getrandom_in getrandom_in;
41ab999c KY	303	struct tpm_getrandom_out getrandom_out;
08837438 RA	304	} tpm_cmd_params;
	305
	306	struct tpm_cmd_t {
	307	tpm_cmd_header header;
	308	tpm_cmd_params params;
	309	}__attribute__((packed));
	310
	311	ssize_t tpm_getcap(struct device , __be32, cap_t , const char *);
1da177e4	312
2b30a90f	313	extern int tpm_get_timeouts(struct tpm_chip *);
08e96e48	314	extern void tpm_gen_interrupt(struct tpm_chip *);
68d6e671	315	extern int tpm_do_selftest(struct tpm_chip *);
9e18ee19	316	extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
e0dd03ca KJH	317	extern struct tpm_chip* tpm_register_hardware(struct device *,
e0dd03ca KJH	318	const struct tpm_vendor_specific *);
1da177e4 LT	319	extern int tpm_open(struct inode , struct file );
1da177e4 LT	320	extern int tpm_release(struct inode , struct file );
253115b7	321	extern void tpm_dev_vendor_release(struct tpm_chip *);
1da177e4 LT	322	extern ssize_t tpm_write(struct file , const char __user , size_t,
	323	loff_t *);
	324	extern ssize_t tpm_read(struct file , char __user , size_t, loff_t *);
e659a3fe	325	extern void tpm_remove_hardware(struct device *);
035e2ce8	326	extern int tpm_pm_suspend(struct device *);
ce2c87d4	327	extern int tpm_pm_resume(struct device *);
fd048866 RA	328	extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
fd048866 RA	329	wait_queue_head_t *);