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