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