linux 2.6.16.38 w/ vs2.0.3-rc1
[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/pci.h>
23 #include <linux/delay.h>
24 #include <linux/fs.h>
25 #include <linux/miscdevice.h>
26 #include <linux/platform_device.h>
27
28 enum tpm_timeout {
29         TPM_TIMEOUT = 5,        /* msecs */
30 };
31
32 /* TPM addresses */
33 enum tpm_addr {
34         TPM_SUPERIO_ADDR = 0x2E,
35         TPM_ADDR = 0x4E,
36 };
37
38 extern ssize_t tpm_show_pubek(struct device *, struct device_attribute *attr,
39                                 char *);
40 extern ssize_t tpm_show_pcrs(struct device *, struct device_attribute *attr,
41                                 char *);
42 extern ssize_t tpm_show_caps(struct device *, struct device_attribute *attr,
43                                 char *);
44 extern ssize_t tpm_store_cancel(struct device *, struct device_attribute *attr,
45                                 const char *, size_t);
46
47 struct tpm_chip;
48
49 struct tpm_vendor_specific {
50         u8 req_complete_mask;
51         u8 req_complete_val;
52         u8 req_canceled;
53         void __iomem *iobase;           /* ioremapped address */
54         unsigned long base;             /* TPM base address */
55
56         int region_size;
57         int have_region;
58
59         int (*recv) (struct tpm_chip *, u8 *, size_t);
60         int (*send) (struct tpm_chip *, u8 *, size_t);
61         void (*cancel) (struct tpm_chip *);
62         u8 (*status) (struct tpm_chip *);
63         struct miscdevice miscdev;
64         struct attribute_group *attr_group;
65 };
66
67 struct tpm_chip {
68         struct device *dev;     /* Device stuff */
69
70         int dev_num;            /* /dev/tpm# */
71         int num_opens;          /* only one allowed */
72         int time_expired;
73
74         /* Data passed to and from the tpm via the read/write calls */
75         u8 *data_buffer;
76         atomic_t data_pending;
77         struct semaphore buffer_mutex;
78
79         struct timer_list user_read_timer;      /* user needs to claim result */
80         struct work_struct work;
81         struct semaphore tpm_mutex;     /* tpm is processing */
82
83         struct tpm_vendor_specific *vendor;
84
85         struct dentry **bios_dir;
86
87         struct list_head list;
88 };
89
90 static inline int tpm_read_index(int base, int index)
91 {
92         outb(index, base);
93         return inb(base+1) & 0xFF;
94 }
95
96 static inline void tpm_write_index(int base, int index, int value)
97 {
98         outb(index, base);
99         outb(value & 0xFF, base+1);
100 }
101
102 extern int tpm_register_hardware(struct device *,
103                                  struct tpm_vendor_specific *);
104 extern int tpm_open(struct inode *, struct file *);
105 extern int tpm_release(struct inode *, struct file *);
106 extern ssize_t tpm_write(struct file *, const char __user *, size_t,
107                          loff_t *);
108 extern ssize_t tpm_read(struct file *, char __user *, size_t, loff_t *);
109 extern void tpm_remove_hardware(struct device *);
110 extern int tpm_pm_suspend(struct device *, pm_message_t);
111 extern int tpm_pm_resume(struct device *);
112
113 #ifdef CONFIG_ACPI
114 extern struct dentry ** tpm_bios_log_setup(char *);
115 extern void tpm_bios_log_teardown(struct dentry **);
116 #else
117 static inline struct dentry* tpm_bios_log_setup(char *name)
118 {
119         return NULL;
120 }
121 static inline void tpm_bios_log_teardown(struct dentry **dir)
122 {
123 }
124 #endif