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