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