tpm: two-phase chip management functions
[deliverable/linux.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,
32d33b29 35 TPM_RETRY = 50, /* 5 seconds */
41ab999c
KY
36};
37
3122a88a
KH
38enum tpm_timeout {
39 TPM_TIMEOUT = 5, /* msecs */
32d33b29 40 TPM_TIMEOUT_RETRY = 100 /* msecs */
3122a88a 41};
1da177e4
LT
42
43/* TPM addresses */
3122a88a 44enum tpm_addr {
daacdfa6 45 TPM_SUPERIO_ADDR = 0x2E,
3122a88a 46 TPM_ADDR = 0x4E,
3122a88a
KH
47};
48
000a07b0
JG
49/* Indexes the duration array */
50enum tpm_duration {
51 TPM_SHORT = 0,
52 TPM_MEDIUM = 1,
53 TPM_LONG = 2,
54 TPM_UNDEFINED,
55};
56
32d33b29 57#define TPM_WARN_RETRY 0x800
68d6e671 58#define TPM_WARN_DOING_SELFTEST 0x802
be405411
SB
59#define TPM_ERR_DEACTIVATED 0x6
60#define TPM_ERR_DISABLED 0x7
c584af19 61#define TPM_ERR_INVALID_POSTINIT 38
be405411 62
b9e3238a 63#define TPM_HEADER_SIZE 10
1da177e4
LT
64struct tpm_chip;
65
66struct tpm_vendor_specific {
ad5ea3cc
KJH
67 void __iomem *iobase; /* ioremapped address */
68 unsigned long base; /* TPM base address */
69
27084efe 70 int irq;
a7b66822 71 int probed_irq;
27084efe 72
ad5ea3cc
KJH
73 int region_size;
74 int have_region;
1da177e4 75
1da177e4 76 struct miscdevice miscdev;
27084efe
LD
77 struct list_head list;
78 int locality;
36b20020 79 unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
62592101 80 bool timeout_adjusted;
36b20020 81 unsigned long duration[3]; /* jiffies */
04ab2293 82 bool duration_adjusted;
775585e4 83 void *priv;
27084efe
LD
84
85 wait_queue_head_t read_queue;
86 wait_queue_head_t int_queue;
3e3a5e90
SB
87
88 u16 manufacturer_id;
1da177e4
LT
89};
90
775585e4
KY
91#define TPM_VPRIV(c) (c)->vendor.priv
92
4e401fb0 93#define TPM_VID_INTEL 0x8086
1f866057
SB
94#define TPM_VID_WINBOND 0x1050
95#define TPM_VID_STM 0x104A
4e401fb0 96
afb5abc2
JS
97enum tpm_chip_flags {
98 TPM_CHIP_FLAG_REGISTERED = BIT(0),
99};
100
1da177e4 101struct tpm_chip {
e659a3fe 102 struct device *dev; /* Device stuff */
5f82e9f0 103 const struct tpm_class_ops *ops;
afb5abc2 104 unsigned int flags;
1da177e4
LT
105
106 int dev_num; /* /dev/tpm# */
6aff1fdc 107 char devname[7];
dc36d32c 108 unsigned long is_open; /* only one allowed */
1da177e4
LT
109 int time_expired;
110
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;
116
1da177e4
LT
117 struct list_head list;
118};
119
27084efe
LD
120#define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
121
a0e39349
MZ
122static inline void tpm_chip_put(struct tpm_chip *chip)
123{
124 module_put(chip->dev->driver->owner);
125}
126
daacdfa6 127static inline int tpm_read_index(int base, int index)
1da177e4 128{
daacdfa6
KJH
129 outb(index, base);
130 return inb(base+1) & 0xFF;
1da177e4
LT
131}
132
daacdfa6 133static inline void tpm_write_index(int base, int index, int value)
1da177e4 134{
daacdfa6
KJH
135 outb(index, base);
136 outb(value & 0xFF, base+1);
1da177e4 137}
08837438
RA
138struct tpm_input_header {
139 __be16 tag;
140 __be32 length;
141 __be32 ordinal;
348df8db 142} __packed;
08837438
RA
143
144struct tpm_output_header {
145 __be16 tag;
146 __be32 length;
147 __be32 return_code;
348df8db 148} __packed;
08837438 149
000a07b0
JG
150#define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
151
08837438
RA
152struct stclear_flags_t {
153 __be16 tag;
154 u8 deactivated;
155 u8 disableForceClear;
156 u8 physicalPresence;
157 u8 physicalPresenceLock;
158 u8 bGlobalLock;
348df8db 159} __packed;
08837438
RA
160
161struct tpm_version_t {
162 u8 Major;
163 u8 Minor;
164 u8 revMajor;
165 u8 revMinor;
348df8db 166} __packed;
08837438
RA
167
168struct tpm_version_1_2_t {
169 __be16 tag;
170 u8 Major;
171 u8 Minor;
172 u8 revMajor;
173 u8 revMinor;
348df8db 174} __packed;
08837438
RA
175
176struct timeout_t {
177 __be32 a;
178 __be32 b;
179 __be32 c;
180 __be32 d;
348df8db 181} __packed;
08837438
RA
182
183struct duration_t {
184 __be32 tpm_short;
185 __be32 tpm_medium;
186 __be32 tpm_long;
348df8db 187} __packed;
08837438
RA
188
189struct permanent_flags_t {
190 __be16 tag;
191 u8 disable;
192 u8 ownership;
193 u8 deactivated;
194 u8 readPubek;
195 u8 disableOwnerClear;
196 u8 allowMaintenance;
197 u8 physicalPresenceLifetimeLock;
198 u8 physicalPresenceHWEnable;
199 u8 physicalPresenceCMDEnable;
200 u8 CEKPUsed;
201 u8 TPMpost;
202 u8 TPMpostLock;
203 u8 FIPS;
204 u8 operator;
205 u8 enableRevokeEK;
206 u8 nvLocked;
207 u8 readSRKPub;
208 u8 tpmEstablished;
209 u8 maintenanceDone;
210 u8 disableFullDALogicInfo;
348df8db 211} __packed;
08837438
RA
212
213typedef union {
214 struct permanent_flags_t perm_flags;
215 struct stclear_flags_t stclear_flags;
216 bool owned;
217 __be32 num_pcrs;
218 struct tpm_version_t tpm_version;
219 struct tpm_version_1_2_t tpm_version_1_2;
220 __be32 manufacturer_id;
221 struct timeout_t timeout;
222 struct duration_t duration;
223} cap_t;
224
000a07b0
JG
225enum tpm_capabilities {
226 TPM_CAP_FLAG = cpu_to_be32(4),
227 TPM_CAP_PROP = cpu_to_be32(5),
228 CAP_VERSION_1_1 = cpu_to_be32(0x06),
229 CAP_VERSION_1_2 = cpu_to_be32(0x1A)
230};
231
232enum tpm_sub_capabilities {
233 TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
234 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
235 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
236 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
237 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
238 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
239 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
240
241};
242
08837438
RA
243struct tpm_getcap_params_in {
244 __be32 cap;
245 __be32 subcap_size;
246 __be32 subcap;
348df8db 247} __packed;
08837438
RA
248
249struct tpm_getcap_params_out {
250 __be32 cap_size;
251 cap_t cap;
348df8db 252} __packed;
08837438
RA
253
254struct tpm_readpubek_params_out {
255 u8 algorithm[4];
256 u8 encscheme[2];
257 u8 sigscheme[2];
02a077c5 258 __be32 paramsize;
08837438
RA
259 u8 parameters[12]; /*assuming RSA*/
260 __be32 keysize;
261 u8 modulus[256];
262 u8 checksum[20];
348df8db 263} __packed;
08837438
RA
264
265typedef union {
266 struct tpm_input_header in;
267 struct tpm_output_header out;
268} tpm_cmd_header;
269
659aaf2b
RA
270struct tpm_pcrread_out {
271 u8 pcr_result[TPM_DIGEST_SIZE];
348df8db 272} __packed;
659aaf2b
RA
273
274struct tpm_pcrread_in {
275 __be32 pcr_idx;
348df8db 276} __packed;
659aaf2b
RA
277
278struct tpm_pcrextend_in {
279 __be32 pcr_idx;
280 u8 hash[TPM_DIGEST_SIZE];
348df8db 281} __packed;
659aaf2b 282
41ab999c
KY
283/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
284 * bytes, but 128 is still a relatively large number of random bytes and
285 * anything much bigger causes users of struct tpm_cmd_t to start getting
286 * compiler warnings about stack frame size. */
287#define TPM_MAX_RNG_DATA 128
288
289struct tpm_getrandom_out {
290 __be32 rng_data_len;
291 u8 rng_data[TPM_MAX_RNG_DATA];
348df8db 292} __packed;
41ab999c
KY
293
294struct tpm_getrandom_in {
295 __be32 num_bytes;
348df8db 296} __packed;
41ab999c 297
c584af19
JG
298struct tpm_startup_in {
299 __be16 startup_type;
300} __packed;
301
08837438
RA
302typedef union {
303 struct tpm_getcap_params_out getcap_out;
304 struct tpm_readpubek_params_out readpubek_out;
305 u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
306 struct tpm_getcap_params_in getcap_in;
659aaf2b
RA
307 struct tpm_pcrread_in pcrread_in;
308 struct tpm_pcrread_out pcrread_out;
309 struct tpm_pcrextend_in pcrextend_in;
41ab999c
KY
310 struct tpm_getrandom_in getrandom_in;
311 struct tpm_getrandom_out getrandom_out;
c584af19 312 struct tpm_startup_in startup_in;
08837438
RA
313} tpm_cmd_params;
314
315struct tpm_cmd_t {
316 tpm_cmd_header header;
317 tpm_cmd_params params;
348df8db 318} __packed;
08837438
RA
319
320ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
afdba32e
JG
321ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
322 size_t bufsiz);
87155b73
JS
323ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len,
324 const char *desc);
2b30a90f 325extern int tpm_get_timeouts(struct tpm_chip *);
08e96e48 326extern void tpm_gen_interrupt(struct tpm_chip *);
68d6e671 327extern int tpm_do_selftest(struct tpm_chip *);
9e18ee19 328extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
035e2ce8 329extern int tpm_pm_suspend(struct device *);
ce2c87d4 330extern int tpm_pm_resume(struct device *);
fd048866 331extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
78f09cc2 332 wait_queue_head_t *, bool);
f84fdff0 333
afb5abc2
JS
334struct tpm_chip *tpm_chip_find_get(int chip_num);
335extern struct tpm_chip *tpmm_chip_alloc(struct device *dev,
336 const struct tpm_class_ops *ops);
337extern int tpm_chip_register(struct tpm_chip *chip);
338extern void tpm_chip_unregister(struct tpm_chip *chip);
339
afdba32e
JG
340int tpm_dev_add_device(struct tpm_chip *chip);
341void tpm_dev_del_device(struct tpm_chip *chip);
1e3b73a9
JG
342int tpm_sysfs_add_device(struct tpm_chip *chip);
343void tpm_sysfs_del_device(struct tpm_chip *chip);
afdba32e 344
000a07b0
JG
345int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
346
f84fdff0 347#ifdef CONFIG_ACPI
1631cfb7
GW
348extern int tpm_add_ppi(struct kobject *);
349extern void tpm_remove_ppi(struct kobject *);
f84fdff0 350#else
1631cfb7 351static inline int tpm_add_ppi(struct kobject *parent)
f84fdff0
XZ
352{
353 return 0;
354}
1631cfb7
GW
355
356static inline void tpm_remove_ppi(struct kobject *parent)
357{
358}
f84fdff0 359#endif
This page took 0.701338 seconds and 5 git commands to generate.