drivers/char/tpm/tpm-chip.c

   1 /*
   2  * Copyright (C) 2004 IBM Corporation
   3  * Copyright (C) 2014 Intel Corporation
   4  *
   5  * Authors:
   6  * Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>
   7  * Leendert van Doorn <leendert@watson.ibm.com>
   8  * Dave Safford <safford@watson.ibm.com>
   9  * Reiner Sailer <sailer@watson.ibm.com>
  10  * Kylene Hall <kjhall@us.ibm.com>
  11  *
  12  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
  13  *
  14  * TPM chip management routines.
  15  *
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License as
  18  * published by the Free Software Foundation, version 2 of the
  19  * License.
  20  *
  21  */
  22
  23 #include <linux/poll.h>
  24 #include <linux/slab.h>
  25 #include <linux/mutex.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/freezer.h>
  28 #include <linux/major.h>
  29 #include "tpm.h"
  30 #include "tpm_eventlog.h"
  31
  32 static DECLARE_BITMAP(dev_mask, TPM_NUM_DEVICES);
  33 static LIST_HEAD(tpm_chip_list);
  34 static DEFINE_SPINLOCK(driver_lock);
  35
  36 struct class *tpm_class;
  37 dev_t tpm_devt;
  38
  39 /*
  40  * tpm_chip_find_get - return tpm_chip for a given chip number
  41  * @chip_num the device number for the chip
  42  */
  43 struct tpm_chip *tpm_chip_find_get(int chip_num)
  44 {
  45         struct tpm_chip *pos, *chip = NULL;
  46
  47         rcu_read_lock();
  48         list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
  49                 if (chip_num != TPM_ANY_NUM && chip_num != pos->dev_num)
  50                         continue;
  51
  52                 if (try_module_get(pos->pdev->driver->owner)) {
  53                         chip = pos;
  54                         break;
  55                 }
  56         }
  57         rcu_read_unlock();
  58         return chip;
  59 }
  60
  61 /**
  62  * tpm_dev_release() - free chip memory and the device number
  63  * @dev: the character device for the TPM chip
  64  *
  65  * This is used as the release function for the character device.
  66  */
  67 static void tpm_dev_release(struct device *dev)
  68 {
  69         struct tpm_chip *chip = container_of(dev, struct tpm_chip, dev);
  70
  71         spin_lock(&driver_lock);
  72         clear_bit(chip->dev_num, dev_mask);
  73         spin_unlock(&driver_lock);
  74         kfree(chip);
  75 }
  76
  77 /**
  78  * tpmm_chip_alloc() - allocate a new struct tpm_chip instance
  79  * @dev: device to which the chip is associated
  80  * @ops: struct tpm_class_ops instance
  81  *
  82  * Allocates a new struct tpm_chip instance and assigns a free
  83  * device number for it. Caller does not have to worry about
  84  * freeing the allocated resources. When the devices is removed
  85  * devres calls tpmm_chip_remove() to do the job.
  86  */
  87 struct tpm_chip *tpmm_chip_alloc(struct device *dev,
  88                                  const struct tpm_class_ops *ops)
  89 {
  90         struct tpm_chip *chip;
  91
  92         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
  93         if (chip == NULL)
  94                 return ERR_PTR(-ENOMEM);
  95
  96         mutex_init(&chip->tpm_mutex);
  97         INIT_LIST_HEAD(&chip->list);
  98
  99         chip->ops = ops;
 100
 101         spin_lock(&driver_lock);
 102         chip->dev_num = find_first_zero_bit(dev_mask, TPM_NUM_DEVICES);
 103         spin_unlock(&driver_lock);
 104
 105         if (chip->dev_num >= TPM_NUM_DEVICES) {
 106                 dev_err(dev, "No available tpm device numbers\n");
 107                 kfree(chip);
 108                 return ERR_PTR(-ENOMEM);
 109         }
 110
 111         set_bit(chip->dev_num, dev_mask);
 112
 113         scnprintf(chip->devname, sizeof(chip->devname), "tpm%d", chip->dev_num);
 114
 115         chip->pdev = dev;
 116
 117         dev_set_drvdata(dev, chip);
 118
 119         chip->dev.class = tpm_class;
 120         chip->dev.release = tpm_dev_release;
 121         chip->dev.parent = chip->pdev;
 122
 123         if (chip->dev_num == 0)
 124                 chip->dev.devt = MKDEV(MISC_MAJOR, TPM_MINOR);
 125         else
 126                 chip->dev.devt = MKDEV(MAJOR(tpm_devt), chip->dev_num);
 127
 128         dev_set_name(&chip->dev, "%s", chip->devname);
 129
 130         device_initialize(&chip->dev);
 131
 132         chip->cdev.owner = chip->pdev->driver->owner;
 133         cdev_init(&chip->cdev, &tpm_fops);
 134
 135         return chip;
 136 }
 137 EXPORT_SYMBOL_GPL(tpmm_chip_alloc);
 138
 139 static int tpm_dev_add_device(struct tpm_chip *chip)
 140 {
 141         int rc;
 142
 143         rc = device_add(&chip->dev);
 144         if (rc) {
 145                 dev_err(&chip->dev,
 146                         "unable to device_register() %s, major %d, minor %d, err=%d\n",
 147                         chip->devname, MAJOR(chip->dev.devt),
 148                         MINOR(chip->dev.devt), rc);
 149
 150                 return rc;
 151         }
 152
 153         rc = cdev_add(&chip->cdev, chip->dev.devt, 1);
 154         if (rc) {
 155                 dev_err(&chip->dev,
 156                         "unable to cdev_add() %s, major %d, minor %d, err=%d\n",
 157                         chip->devname, MAJOR(chip->dev.devt),
 158                         MINOR(chip->dev.devt), rc);
 159
 160                 device_unregister(&chip->dev);
 161                 return rc;
 162         }
 163
 164         return rc;
 165 }
 166
 167 static void tpm_dev_del_device(struct tpm_chip *chip)
 168 {
 169         cdev_del(&chip->cdev);
 170         device_unregister(&chip->dev);
 171 }
 172
 173 /*
 174  * tpm_chip_register() - create a character device for the TPM chip
 175  * @chip: TPM chip to use.
 176  *
 177  * Creates a character device for the TPM chip and adds sysfs interfaces for
 178  * the device, PPI and TCPA. As the last step this function adds the
 179  * chip to the list of TPM chips available for use.
 180  *
 181  * NOTE: This function should be only called after the chip initialization
 182  * is complete.
 183  *
 184  * Called from tpm_<specific>.c probe function only for devices
 185  * the driver has determined it should claim.  Prior to calling
 186  * this function the specific probe function has called pci_enable_device
 187  * upon errant exit from this function specific probe function should call
 188  * pci_disable_device
 189  */
 190 int tpm_chip_register(struct tpm_chip *chip)
 191 {
 192         int rc;
 193
 194         rc = tpm_dev_add_device(chip);
 195         if (rc)
 196                 return rc;
 197
 198         /* Populate sysfs for TPM1 devices. */
 199         if (!(chip->flags & TPM_CHIP_FLAG_TPM2)) {
 200                 rc = tpm_sysfs_add_device(chip);
 201                 if (rc)
 202                         goto del_misc;
 203
 204                 rc = tpm_add_ppi(chip);
 205                 if (rc)
 206                         goto del_sysfs;
 207
 208                 chip->bios_dir = tpm_bios_log_setup(chip->devname);
 209         }
 210
 211         /* Make the chip available. */
 212         spin_lock(&driver_lock);
 213         list_add_rcu(&chip->list, &tpm_chip_list);
 214         spin_unlock(&driver_lock);
 215
 216         chip->flags |= TPM_CHIP_FLAG_REGISTERED;
 217
 218         return 0;
 219 del_sysfs:
 220         tpm_sysfs_del_device(chip);
 221 del_misc:
 222         tpm_dev_del_device(chip);
 223         return rc;
 224 }
 225 EXPORT_SYMBOL_GPL(tpm_chip_register);
 226
 227 /*
 228  * tpm_chip_unregister() - release the TPM driver
 229  * @chip: TPM chip to use.
 230  *
 231  * Takes the chip first away from the list of available TPM chips and then
 232  * cleans up all the resources reserved by tpm_chip_register().
 233  *
 234  * NOTE: This function should be only called before deinitializing chip
 235  * resources.
 236  */
 237 void tpm_chip_unregister(struct tpm_chip *chip)
 238 {
 239         if (!(chip->flags & TPM_CHIP_FLAG_REGISTERED))
 240                 return;
 241
 242         spin_lock(&driver_lock);
 243         list_del_rcu(&chip->list);
 244         spin_unlock(&driver_lock);
 245         synchronize_rcu();
 246
 247         if (!(chip->flags & TPM_CHIP_FLAG_TPM2)) {
 248                 if (chip->bios_dir)
 249                         tpm_bios_log_teardown(chip->bios_dir);
 250                 tpm_remove_ppi(chip);
 251                 tpm_sysfs_del_device(chip);
 252         }
 253
 254         tpm_dev_del_device(chip);
 255 }
 256 EXPORT_SYMBOL_GPL(tpm_chip_unregister);