8c1df302fbb6ce17cd9580cca1aaeca84f785745
[linux-2.6.git] / drivers / char / tpm / tpm.h
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  *
10  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
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>
22 #include <linux/delay.h>
23 #include <linux/fs.h>
24 #include <linux/mutex.h>
25 #include <linux/sched.h>
26 #include <linux/miscdevice.h>
27 #include <linux/platform_device.h>
28 #include <linux/io.h>
29 #include <linux/tpm.h>
30
31 enum tpm_timeout {
32         TPM_TIMEOUT = 5,        /* msecs */
33 };
34
35 /* TPM addresses */
36 enum tpm_addr {
37         TPM_SUPERIO_ADDR = 0x2E,
38         TPM_ADDR = 0x4E,
39 };
40
41 #define TPM_WARN_DOING_SELFTEST 0x802
42 #define TPM_HEADER_SIZE         10
43 extern ssize_t tpm_show_pubek(struct device *, struct device_attribute *attr,
44                                 char *);
45 extern ssize_t tpm_show_pcrs(struct device *, struct device_attribute *attr,
46                                 char *);
47 extern ssize_t tpm_show_caps(struct device *, struct device_attribute *attr,
48                                 char *);
49 extern ssize_t tpm_show_caps_1_2(struct device *, struct device_attribute *attr,
50                                 char *);
51 extern ssize_t tpm_store_cancel(struct device *, struct device_attribute *attr,
52                                 const char *, size_t);
53 extern ssize_t tpm_show_enabled(struct device *, struct device_attribute *attr,
54                                 char *);
55 extern ssize_t tpm_show_active(struct device *, struct device_attribute *attr,
56                                 char *);
57 extern ssize_t tpm_show_owned(struct device *, struct device_attribute *attr,
58                                 char *);
59 extern ssize_t tpm_show_temp_deactivated(struct device *,
60                                          struct device_attribute *attr, char *);
61 extern ssize_t tpm_show_durations(struct device *,
62                                   struct device_attribute *attr, char *);
63 extern ssize_t tpm_show_timeouts(struct device *,
64                                  struct device_attribute *attr, char *);
65
66 struct tpm_chip;
67
68 struct tpm_vendor_specific {
69         const u8 req_complete_mask;
70         const u8 req_complete_val;
71         const u8 req_canceled;
72         void __iomem *iobase;           /* ioremapped address */
73         unsigned long base;             /* TPM base address */
74
75         int irq;
76         int probed_irq;
77
78         int region_size;
79         int have_region;
80
81         int (*recv) (struct tpm_chip *, u8 *, size_t);
82         int (*send) (struct tpm_chip *, u8 *, size_t);
83         void (*cancel) (struct tpm_chip *);
84         u8 (*status) (struct tpm_chip *);
85         void (*release) (struct device *);
86         struct miscdevice miscdev;
87         struct attribute_group *attr_group;
88         struct list_head list;
89         int locality;
90         unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
91         bool timeout_adjusted;
92         unsigned long duration[3]; /* jiffies */
93         bool duration_adjusted;
94
95         wait_queue_head_t read_queue;
96         wait_queue_head_t int_queue;
97 };
98
99 struct tpm_chip {
100         struct device *dev;     /* Device stuff */
101
102         int dev_num;            /* /dev/tpm# */
103         unsigned long is_open;  /* only one allowed */
104         int time_expired;
105
106         /* Data passed to and from the tpm via the read/write calls */
107         u8 *data_buffer;
108         atomic_t data_pending;
109         struct mutex buffer_mutex;
110
111         struct timer_list user_read_timer;      /* user needs to claim result */
112         struct work_struct work;
113         struct mutex tpm_mutex; /* tpm is processing */
114
115         struct tpm_vendor_specific vendor;
116
117         struct dentry **bios_dir;
118
119         struct list_head list;
120         void (*release) (struct device *);
121 };
122
123 #define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
124
125 static inline void tpm_chip_put(struct tpm_chip *chip)
126 {
127         module_put(chip->dev->driver->owner);
128 }
129
130 static inline int tpm_read_index(int base, int index)
131 {
132         outb(index, base);
133         return inb(base+1) & 0xFF;
134 }
135
136 static inline void tpm_write_index(int base, int index, int value)
137 {
138         outb(index, base);
139         outb(value & 0xFF, base+1);
140 }
141 struct tpm_input_header {
142         __be16  tag;
143         __be32  length;
144         __be32  ordinal;
145 }__attribute__((packed));
146
147 struct tpm_output_header {
148         __be16  tag;
149         __be32  length;
150         __be32  return_code;
151 }__attribute__((packed));
152
153 struct  stclear_flags_t {
154         __be16  tag;
155         u8      deactivated;
156         u8      disableForceClear;
157         u8      physicalPresence;
158         u8      physicalPresenceLock;
159         u8      bGlobalLock;
160 }__attribute__((packed));
161
162 struct  tpm_version_t {
163         u8      Major;
164         u8      Minor;
165         u8      revMajor;
166         u8      revMinor;
167 }__attribute__((packed));
168
169 struct  tpm_version_1_2_t {
170         __be16  tag;
171         u8      Major;
172         u8      Minor;
173         u8      revMajor;
174         u8      revMinor;
175 }__attribute__((packed));
176
177 struct  timeout_t {
178         __be32  a;
179         __be32  b;
180         __be32  c;
181         __be32  d;
182 }__attribute__((packed));
183
184 struct duration_t {
185         __be32  tpm_short;
186         __be32  tpm_medium;
187         __be32  tpm_long;
188 }__attribute__((packed));
189
190 struct permanent_flags_t {
191         __be16  tag;
192         u8      disable;
193         u8      ownership;
194         u8      deactivated;
195         u8      readPubek;
196         u8      disableOwnerClear;
197         u8      allowMaintenance;
198         u8      physicalPresenceLifetimeLock;
199         u8      physicalPresenceHWEnable;
200         u8      physicalPresenceCMDEnable;
201         u8      CEKPUsed;
202         u8      TPMpost;
203         u8      TPMpostLock;
204         u8      FIPS;
205         u8      operator;
206         u8      enableRevokeEK;
207         u8      nvLocked;
208         u8      readSRKPub;
209         u8      tpmEstablished;
210         u8      maintenanceDone;
211         u8      disableFullDALogicInfo;
212 }__attribute__((packed));
213
214 typedef union {
215         struct  permanent_flags_t perm_flags;
216         struct  stclear_flags_t stclear_flags;
217         bool    owned;
218         __be32  num_pcrs;
219         struct  tpm_version_t   tpm_version;
220         struct  tpm_version_1_2_t tpm_version_1_2;
221         __be32  manufacturer_id;
222         struct timeout_t  timeout;
223         struct duration_t duration;
224 } cap_t;
225
226 struct  tpm_getcap_params_in {
227         __be32  cap;
228         __be32  subcap_size;
229         __be32  subcap;
230 }__attribute__((packed));
231
232 struct  tpm_getcap_params_out {
233         __be32  cap_size;
234         cap_t   cap;
235 }__attribute__((packed));
236
237 struct  tpm_readpubek_params_out {
238         u8      algorithm[4];
239         u8      encscheme[2];
240         u8      sigscheme[2];
241         __be32  paramsize;
242         u8      parameters[12]; /*assuming RSA*/
243         __be32  keysize;
244         u8      modulus[256];
245         u8      checksum[20];
246 }__attribute__((packed));
247
248 typedef union {
249         struct  tpm_input_header in;
250         struct  tpm_output_header out;
251 } tpm_cmd_header;
252
253 #define TPM_DIGEST_SIZE 20
254 struct tpm_pcrread_out {
255         u8      pcr_result[TPM_DIGEST_SIZE];
256 }__attribute__((packed));
257
258 struct tpm_pcrread_in {
259         __be32  pcr_idx;
260 }__attribute__((packed));
261
262 struct tpm_pcrextend_in {
263         __be32  pcr_idx;
264         u8      hash[TPM_DIGEST_SIZE];
265 }__attribute__((packed));
266
267 typedef union {
268         struct  tpm_getcap_params_out getcap_out;
269         struct  tpm_readpubek_params_out readpubek_out;
270         u8      readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
271         struct  tpm_getcap_params_in getcap_in;
272         struct  tpm_pcrread_in  pcrread_in;
273         struct  tpm_pcrread_out pcrread_out;
274         struct  tpm_pcrextend_in pcrextend_in;
275 } tpm_cmd_params;
276
277 struct tpm_cmd_t {
278         tpm_cmd_header  header;
279         tpm_cmd_params  params;
280 }__attribute__((packed));
281
282 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
283
284 extern int tpm_get_timeouts(struct tpm_chip *);
285 extern void tpm_gen_interrupt(struct tpm_chip *);
286 extern int tpm_do_selftest(struct tpm_chip *);
287 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
288 extern struct tpm_chip* tpm_register_hardware(struct device *,
289                                  const struct tpm_vendor_specific *);
290 extern int tpm_open(struct inode *, struct file *);
291 extern int tpm_release(struct inode *, struct file *);
292 extern void tpm_dev_vendor_release(struct tpm_chip *);
293 extern ssize_t tpm_write(struct file *, const char __user *, size_t,
294                          loff_t *);
295 extern ssize_t tpm_read(struct file *, char __user *, size_t, loff_t *);
296 extern void tpm_remove_hardware(struct device *);
297 extern int tpm_pm_suspend(struct device *, pm_message_t);
298 extern int tpm_pm_resume(struct device *);
299 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
300                              wait_queue_head_t *);
301 #ifdef CONFIG_ACPI
302 extern struct dentry ** tpm_bios_log_setup(char *);
303 extern void tpm_bios_log_teardown(struct dentry **);
304 #else
305 static inline struct dentry ** tpm_bios_log_setup(char *name)
306 {
307         return NULL;
308 }
309 static inline void tpm_bios_log_teardown(struct dentry **dir)
310 {
311 }
312 #endif