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