xref: /openbmc/linux/drivers/char/tpm/tpm.h (revision 367b8112)
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  *
10  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
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>
22 #include <linux/delay.h>
23 #include <linux/fs.h>
24 #include <linux/mutex.h>
25 #include <linux/sched.h>
26 #include <linux/miscdevice.h>
27 #include <linux/platform_device.h>
28 #include <linux/io.h>
29 
30 enum tpm_timeout {
31 	TPM_TIMEOUT = 5,	/* msecs */
32 };
33 
34 /* TPM addresses */
35 enum tpm_addr {
36 	TPM_SUPERIO_ADDR = 0x2E,
37 	TPM_ADDR = 0x4E,
38 };
39 
40 extern ssize_t tpm_show_pubek(struct device *, struct device_attribute *attr,
41 				char *);
42 extern ssize_t tpm_show_pcrs(struct device *, struct device_attribute *attr,
43 				char *);
44 extern ssize_t tpm_show_caps(struct device *, struct device_attribute *attr,
45 				char *);
46 extern ssize_t tpm_show_caps_1_2(struct device *, struct device_attribute *attr,
47 				char *);
48 extern ssize_t tpm_store_cancel(struct device *, struct device_attribute *attr,
49 				const char *, size_t);
50 extern ssize_t tpm_show_enabled(struct device *, struct device_attribute *attr,
51 				char *);
52 extern ssize_t tpm_show_active(struct device *, struct device_attribute *attr,
53 				char *);
54 extern ssize_t tpm_show_owned(struct device *, struct device_attribute *attr,
55 				char *);
56 extern ssize_t tpm_show_temp_deactivated(struct device *,
57 					 struct device_attribute *attr, char *);
58 
59 struct tpm_chip;
60 
61 struct tpm_vendor_specific {
62 	const u8 req_complete_mask;
63 	const u8 req_complete_val;
64 	const u8 req_canceled;
65 	void __iomem *iobase;		/* ioremapped address */
66 	unsigned long base;		/* TPM base address */
67 
68 	int irq;
69 
70 	int region_size;
71 	int have_region;
72 
73 	int (*recv) (struct tpm_chip *, u8 *, size_t);
74 	int (*send) (struct tpm_chip *, u8 *, size_t);
75 	void (*cancel) (struct tpm_chip *);
76 	u8 (*status) (struct tpm_chip *);
77 	void (*release) (struct device *);
78 	struct miscdevice miscdev;
79 	struct attribute_group *attr_group;
80 	struct list_head list;
81 	int locality;
82 	unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
83 	unsigned long duration[3]; /* jiffies */
84 
85 	wait_queue_head_t read_queue;
86 	wait_queue_head_t int_queue;
87 };
88 
89 struct tpm_chip {
90 	struct device *dev;	/* Device stuff */
91 
92 	int dev_num;		/* /dev/tpm# */
93 	unsigned long is_open;	/* only one allowed */
94 	int time_expired;
95 
96 	/* Data passed to and from the tpm via the read/write calls */
97 	u8 *data_buffer;
98 	atomic_t data_pending;
99 	struct mutex buffer_mutex;
100 
101 	struct timer_list user_read_timer;	/* user needs to claim result */
102 	struct work_struct work;
103 	struct mutex tpm_mutex;	/* tpm is processing */
104 
105 	struct tpm_vendor_specific vendor;
106 
107 	struct dentry **bios_dir;
108 
109 	struct list_head list;
110 	void (*release) (struct device *);
111 };
112 
113 #define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
114 
115 static inline int tpm_read_index(int base, int index)
116 {
117 	outb(index, base);
118 	return inb(base+1) & 0xFF;
119 }
120 
121 static inline void tpm_write_index(int base, int index, int value)
122 {
123 	outb(index, base);
124 	outb(value & 0xFF, base+1);
125 }
126 
127 extern void tpm_get_timeouts(struct tpm_chip *);
128 extern void tpm_gen_interrupt(struct tpm_chip *);
129 extern void tpm_continue_selftest(struct tpm_chip *);
130 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
131 extern struct tpm_chip* tpm_register_hardware(struct device *,
132 				 const struct tpm_vendor_specific *);
133 extern int tpm_open(struct inode *, struct file *);
134 extern int tpm_release(struct inode *, struct file *);
135 extern void tpm_dev_vendor_release(struct tpm_chip *);
136 extern ssize_t tpm_write(struct file *, const char __user *, size_t,
137 			 loff_t *);
138 extern ssize_t tpm_read(struct file *, char __user *, size_t, loff_t *);
139 extern void tpm_remove_hardware(struct device *);
140 extern int tpm_pm_suspend(struct device *, pm_message_t);
141 extern int tpm_pm_resume(struct device *);
142 
143 #ifdef CONFIG_ACPI
144 extern struct dentry ** tpm_bios_log_setup(char *);
145 extern void tpm_bios_log_teardown(struct dentry **);
146 #else
147 static inline struct dentry ** tpm_bios_log_setup(char *name)
148 {
149 	return NULL;
150 }
151 static inline void tpm_bios_log_teardown(struct dentry **dir)
152 {
153 }
154 #endif
155