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