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 #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_show_caps_1_2(struct device *, struct device_attribute *attr,
  46                                 char *);
  47 extern ssize_t tpm_store_cancel(struct device *, struct device_attribute *attr,
  48                                 const char *, size_t);
  49 extern ssize_t tpm_show_enabled(struct device *, struct device_attribute *attr,
  50                                 char *);
  51 extern ssize_t tpm_show_active(struct device *, struct device_attribute *attr,
  52                                 char *);
  53 extern ssize_t tpm_show_owned(struct device *, struct device_attribute *attr,
  54                                 char *);
  55 extern ssize_t tpm_show_temp_deactivated(struct device *,
  56                                          struct device_attribute *attr, char *);
  57
  58 struct tpm_chip;
  59
  60 struct tpm_vendor_specific {
  61         const u8 req_complete_mask;
  62         const u8 req_complete_val;
  63         const u8 req_canceled;
  64         void __iomem *iobase;           /* ioremapped address */
  65         unsigned long base;             /* TPM base address */
  66
  67         int irq;
  68
  69         int region_size;
  70         int have_region;
  71
  72         int (*recv) (struct tpm_chip *, u8 *, size_t);
  73         int (*send) (struct tpm_chip *, u8 *, size_t);
  74         void (*cancel) (struct tpm_chip *);
  75         u8 (*status) (struct tpm_chip *);
  76         struct miscdevice miscdev;
  77         struct attribute_group *attr_group;
  78         struct list_head list;
  79         int locality;
  80         unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
  81         unsigned long duration[3]; /* jiffies */
  82
  83         wait_queue_head_t read_queue;
  84         wait_queue_head_t int_queue;
  85 };
  86
  87 struct tpm_chip {
  88         struct device *dev;     /* Device stuff */
  89
  90         int dev_num;            /* /dev/tpm# */
  91         int num_opens;          /* only one allowed */
  92         int time_expired;
  93
  94         /* Data passed to and from the tpm via the read/write calls */
  95         u8 *data_buffer;
  96         atomic_t data_pending;
  97         struct semaphore buffer_mutex;
  98
  99         struct timer_list user_read_timer;      /* user needs to claim result */
 100         struct work_struct work;
 101         struct semaphore tpm_mutex;     /* tpm is processing */
 102
 103         struct tpm_vendor_specific vendor;
 104
 105         struct dentry **bios_dir;
 106
 107         struct list_head list;
 108 };
 109
 110 #define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
 111
 112 static inline int tpm_read_index(int base, int index)
 113 {
 114         outb(index, base);
 115         return inb(base+1) & 0xFF;
 116 }
 117
 118 static inline void tpm_write_index(int base, int index, int value)
 119 {
 120         outb(index, base);
 121         outb(value & 0xFF, base+1);
 122 }
 123
 124 extern void tpm_get_timeouts(struct tpm_chip *);
 125 extern void tpm_gen_interrupt(struct tpm_chip *);
 126 extern void tpm_continue_selftest(struct tpm_chip *);
 127 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
 128 extern struct tpm_chip* tpm_register_hardware(struct device *,
 129                                  const struct tpm_vendor_specific *);
 130 extern int tpm_open(struct inode *, struct file *);
 131 extern int tpm_release(struct inode *, struct file *);
 132 extern ssize_t tpm_write(struct file *, const char __user *, size_t,
 133                          loff_t *);
 134 extern ssize_t tpm_read(struct file *, char __user *, size_t, loff_t *);
 135 extern void tpm_remove_hardware(struct device *);
 136 extern int tpm_pm_suspend(struct device *, pm_message_t);
 137 extern int tpm_pm_resume(struct device *);
 138
 139 #ifdef CONFIG_ACPI
 140 extern struct dentry ** tpm_bios_log_setup(char *);
 141 extern void tpm_bios_log_teardown(struct dentry **);
 142 #else
 143 static inline struct dentry* tpm_bios_log_setup(char *name)
 144 {
 145         return NULL;
 146 }
 147 static inline void tpm_bios_log_teardown(struct dentry **dir)
 148 {
 149 }
 150 #endif