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