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