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