tpm: Store TPM vendor ID
[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,
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;
775585e4 104 void *priv;
27084efe
LD
105
106 wait_queue_head_t read_queue;
107 wait_queue_head_t int_queue;
3e3a5e90
SB
108
109 u16 manufacturer_id;
1da177e4
LT
110};
111
775585e4
KY
112#define TPM_VPRIV(c) (c)->vendor.priv
113
4e401fb0
SB
114#define TPM_VID_INTEL 0x8086
115
1da177e4 116struct tpm_chip {
e659a3fe 117 struct device *dev; /* Device stuff */
1da177e4
LT
118
119 int dev_num; /* /dev/tpm# */
dc36d32c 120 unsigned long is_open; /* only one allowed */
1da177e4
LT
121 int time_expired;
122
123 /* Data passed to and from the tpm via the read/write calls */
124 u8 *data_buffer;
125 atomic_t data_pending;
d081d470 126 struct mutex buffer_mutex;
1da177e4
LT
127
128 struct timer_list user_read_timer; /* user needs to claim result */
09e12f9f 129 struct work_struct work;
d081d470 130 struct mutex tpm_mutex; /* tpm is processing */
1da177e4 131
90dda520 132 struct tpm_vendor_specific vendor;
1da177e4 133
55a82ab3
KJH
134 struct dentry **bios_dir;
135
1da177e4 136 struct list_head list;
5bd91f18 137 void (*release) (struct device *);
1da177e4
LT
138};
139
27084efe
LD
140#define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
141
a0e39349
MZ
142static inline void tpm_chip_put(struct tpm_chip *chip)
143{
144 module_put(chip->dev->driver->owner);
145}
146
daacdfa6 147static inline int tpm_read_index(int base, int index)
1da177e4 148{
daacdfa6
KJH
149 outb(index, base);
150 return inb(base+1) & 0xFF;
1da177e4
LT
151}
152
daacdfa6 153static inline void tpm_write_index(int base, int index, int value)
1da177e4 154{
daacdfa6
KJH
155 outb(index, base);
156 outb(value & 0xFF, base+1);
1da177e4 157}
08837438
RA
158struct tpm_input_header {
159 __be16 tag;
160 __be32 length;
161 __be32 ordinal;
348df8db 162} __packed;
08837438
RA
163
164struct tpm_output_header {
165 __be16 tag;
166 __be32 length;
167 __be32 return_code;
348df8db 168} __packed;
08837438
RA
169
170struct stclear_flags_t {
171 __be16 tag;
172 u8 deactivated;
173 u8 disableForceClear;
174 u8 physicalPresence;
175 u8 physicalPresenceLock;
176 u8 bGlobalLock;
348df8db 177} __packed;
08837438
RA
178
179struct tpm_version_t {
180 u8 Major;
181 u8 Minor;
182 u8 revMajor;
183 u8 revMinor;
348df8db 184} __packed;
08837438
RA
185
186struct tpm_version_1_2_t {
187 __be16 tag;
188 u8 Major;
189 u8 Minor;
190 u8 revMajor;
191 u8 revMinor;
348df8db 192} __packed;
08837438
RA
193
194struct timeout_t {
195 __be32 a;
196 __be32 b;
197 __be32 c;
198 __be32 d;
348df8db 199} __packed;
08837438
RA
200
201struct duration_t {
202 __be32 tpm_short;
203 __be32 tpm_medium;
204 __be32 tpm_long;
348df8db 205} __packed;
08837438
RA
206
207struct permanent_flags_t {
208 __be16 tag;
209 u8 disable;
210 u8 ownership;
211 u8 deactivated;
212 u8 readPubek;
213 u8 disableOwnerClear;
214 u8 allowMaintenance;
215 u8 physicalPresenceLifetimeLock;
216 u8 physicalPresenceHWEnable;
217 u8 physicalPresenceCMDEnable;
218 u8 CEKPUsed;
219 u8 TPMpost;
220 u8 TPMpostLock;
221 u8 FIPS;
222 u8 operator;
223 u8 enableRevokeEK;
224 u8 nvLocked;
225 u8 readSRKPub;
226 u8 tpmEstablished;
227 u8 maintenanceDone;
228 u8 disableFullDALogicInfo;
348df8db 229} __packed;
08837438
RA
230
231typedef union {
232 struct permanent_flags_t perm_flags;
233 struct stclear_flags_t stclear_flags;
234 bool owned;
235 __be32 num_pcrs;
236 struct tpm_version_t tpm_version;
237 struct tpm_version_1_2_t tpm_version_1_2;
238 __be32 manufacturer_id;
239 struct timeout_t timeout;
240 struct duration_t duration;
241} cap_t;
242
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
270#define TPM_DIGEST_SIZE 20
271struct tpm_pcrread_out {
272 u8 pcr_result[TPM_DIGEST_SIZE];
348df8db 273} __packed;
659aaf2b
RA
274
275struct tpm_pcrread_in {
276 __be32 pcr_idx;
348df8db 277} __packed;
659aaf2b
RA
278
279struct tpm_pcrextend_in {
280 __be32 pcr_idx;
281 u8 hash[TPM_DIGEST_SIZE];
348df8db 282} __packed;
659aaf2b 283
41ab999c
KY
284/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
285 * bytes, but 128 is still a relatively large number of random bytes and
286 * anything much bigger causes users of struct tpm_cmd_t to start getting
287 * compiler warnings about stack frame size. */
288#define TPM_MAX_RNG_DATA 128
289
290struct tpm_getrandom_out {
291 __be32 rng_data_len;
292 u8 rng_data[TPM_MAX_RNG_DATA];
348df8db 293} __packed;
41ab999c
KY
294
295struct tpm_getrandom_in {
296 __be32 num_bytes;
348df8db 297} __packed;
41ab999c 298
c584af19
JG
299struct tpm_startup_in {
300 __be16 startup_type;
301} __packed;
302
08837438
RA
303typedef union {
304 struct tpm_getcap_params_out getcap_out;
305 struct tpm_readpubek_params_out readpubek_out;
306 u8 readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
307 struct tpm_getcap_params_in getcap_in;
659aaf2b
RA
308 struct tpm_pcrread_in pcrread_in;
309 struct tpm_pcrread_out pcrread_out;
310 struct tpm_pcrextend_in pcrextend_in;
41ab999c
KY
311 struct tpm_getrandom_in getrandom_in;
312 struct tpm_getrandom_out getrandom_out;
c584af19 313 struct tpm_startup_in startup_in;
08837438
RA
314} tpm_cmd_params;
315
316struct tpm_cmd_t {
317 tpm_cmd_header header;
318 tpm_cmd_params params;
348df8db 319} __packed;
08837438
RA
320
321ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
1da177e4 322
2b30a90f 323extern int tpm_get_timeouts(struct tpm_chip *);
08e96e48 324extern void tpm_gen_interrupt(struct tpm_chip *);
68d6e671 325extern int tpm_do_selftest(struct tpm_chip *);
9e18ee19 326extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
e0dd03ca
KJH
327extern struct tpm_chip* tpm_register_hardware(struct device *,
328 const struct tpm_vendor_specific *);
1da177e4
LT
329extern int tpm_open(struct inode *, struct file *);
330extern int tpm_release(struct inode *, struct file *);
253115b7 331extern void tpm_dev_vendor_release(struct tpm_chip *);
1da177e4
LT
332extern ssize_t tpm_write(struct file *, const char __user *, size_t,
333 loff_t *);
334extern ssize_t tpm_read(struct file *, char __user *, size_t, loff_t *);
e659a3fe 335extern void tpm_remove_hardware(struct device *);
035e2ce8 336extern int tpm_pm_suspend(struct device *);
ce2c87d4 337extern int tpm_pm_resume(struct device *);
fd048866
RA
338extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
339 wait_queue_head_t *);
f84fdff0
XZ
340
341#ifdef CONFIG_ACPI
1631cfb7
GW
342extern int tpm_add_ppi(struct kobject *);
343extern void tpm_remove_ppi(struct kobject *);
f84fdff0 344#else
1631cfb7 345static inline int tpm_add_ppi(struct kobject *parent)
f84fdff0
XZ
346{
347 return 0;
348}
1631cfb7
GW
349
350static inline void tpm_remove_ppi(struct kobject *parent)
351{
352}
f84fdff0 353#endif
This page took 0.680931 seconds and 5 git commands to generate.