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