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

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 void tpm_get_timeouts(struct tpm_chip *);
extern void tpm_gen_interrupt(struct tpm_chip *);
extern void tpm_continue_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 *);

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