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