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