tpm: Re-enable TPM chip boostrapping non-tpm_tis TPM drivers
[sfrench/cifs-2.6.git] / drivers / char / tpm / tpm-chip.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2004 IBM Corporation
4  * Copyright (C) 2014 Intel Corporation
5  *
6  * Authors:
7  * Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>
8  * Leendert van Doorn <leendert@watson.ibm.com>
9  * Dave Safford <safford@watson.ibm.com>
10  * Reiner Sailer <sailer@watson.ibm.com>
11  * Kylene Hall <kjhall@us.ibm.com>
12  *
13  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
14  *
15  * TPM chip management routines.
16  */
17
18 #include <linux/poll.h>
19 #include <linux/slab.h>
20 #include <linux/mutex.h>
21 #include <linux/spinlock.h>
22 #include <linux/freezer.h>
23 #include <linux/major.h>
24 #include <linux/tpm_eventlog.h>
25 #include <linux/hw_random.h>
26 #include "tpm.h"
27
28 DEFINE_IDR(dev_nums_idr);
29 static DEFINE_MUTEX(idr_lock);
30
31 struct class *tpm_class;
32 struct class *tpmrm_class;
33 dev_t tpm_devt;
34
35 static int tpm_request_locality(struct tpm_chip *chip)
36 {
37         int rc;
38
39         if (!chip->ops->request_locality)
40                 return 0;
41
42         rc = chip->ops->request_locality(chip, 0);
43         if (rc < 0)
44                 return rc;
45
46         chip->locality = rc;
47         return 0;
48 }
49
50 static void tpm_relinquish_locality(struct tpm_chip *chip)
51 {
52         int rc;
53
54         if (!chip->ops->relinquish_locality)
55                 return;
56
57         rc = chip->ops->relinquish_locality(chip, chip->locality);
58         if (rc)
59                 dev_err(&chip->dev, "%s: : error %d\n", __func__, rc);
60
61         chip->locality = -1;
62 }
63
64 static int tpm_cmd_ready(struct tpm_chip *chip)
65 {
66         if (!chip->ops->cmd_ready)
67                 return 0;
68
69         return chip->ops->cmd_ready(chip);
70 }
71
72 static int tpm_go_idle(struct tpm_chip *chip)
73 {
74         if (!chip->ops->go_idle)
75                 return 0;
76
77         return chip->ops->go_idle(chip);
78 }
79
80 static void tpm_clk_enable(struct tpm_chip *chip)
81 {
82         if (chip->ops->clk_enable)
83                 chip->ops->clk_enable(chip, true);
84 }
85
86 static void tpm_clk_disable(struct tpm_chip *chip)
87 {
88         if (chip->ops->clk_enable)
89                 chip->ops->clk_enable(chip, false);
90 }
91
92 /**
93  * tpm_chip_start() - power on the TPM
94  * @chip:       a TPM chip to use
95  *
96  * Return:
97  * * The response length        - OK
98  * * -errno                     - A system error
99  */
100 int tpm_chip_start(struct tpm_chip *chip)
101 {
102         int ret;
103
104         tpm_clk_enable(chip);
105
106         if (chip->locality == -1) {
107                 ret = tpm_request_locality(chip);
108                 if (ret) {
109                         tpm_clk_disable(chip);
110                         return ret;
111                 }
112         }
113
114         ret = tpm_cmd_ready(chip);
115         if (ret) {
116                 tpm_relinquish_locality(chip);
117                 tpm_clk_disable(chip);
118                 return ret;
119         }
120
121         return 0;
122 }
123 EXPORT_SYMBOL_GPL(tpm_chip_start);
124
125 /**
126  * tpm_chip_stop() - power off the TPM
127  * @chip:       a TPM chip to use
128  *
129  * Return:
130  * * The response length        - OK
131  * * -errno                     - A system error
132  */
133 void tpm_chip_stop(struct tpm_chip *chip)
134 {
135         tpm_go_idle(chip);
136         tpm_relinquish_locality(chip);
137         tpm_clk_disable(chip);
138 }
139 EXPORT_SYMBOL_GPL(tpm_chip_stop);
140
141 /**
142  * tpm_try_get_ops() - Get a ref to the tpm_chip
143  * @chip: Chip to ref
144  *
145  * The caller must already have some kind of locking to ensure that chip is
146  * valid. This function will lock the chip so that the ops member can be
147  * accessed safely. The locking prevents tpm_chip_unregister from
148  * completing, so it should not be held for long periods.
149  *
150  * Returns -ERRNO if the chip could not be got.
151  */
152 int tpm_try_get_ops(struct tpm_chip *chip)
153 {
154         int rc = -EIO;
155
156         get_device(&chip->dev);
157
158         down_read(&chip->ops_sem);
159         if (!chip->ops)
160                 goto out_ops;
161
162         mutex_lock(&chip->tpm_mutex);
163         rc = tpm_chip_start(chip);
164         if (rc)
165                 goto out_lock;
166
167         return 0;
168 out_lock:
169         mutex_unlock(&chip->tpm_mutex);
170 out_ops:
171         up_read(&chip->ops_sem);
172         put_device(&chip->dev);
173         return rc;
174 }
175 EXPORT_SYMBOL_GPL(tpm_try_get_ops);
176
177 /**
178  * tpm_put_ops() - Release a ref to the tpm_chip
179  * @chip: Chip to put
180  *
181  * This is the opposite pair to tpm_try_get_ops(). After this returns chip may
182  * be kfree'd.
183  */
184 void tpm_put_ops(struct tpm_chip *chip)
185 {
186         tpm_chip_stop(chip);
187         mutex_unlock(&chip->tpm_mutex);
188         up_read(&chip->ops_sem);
189         put_device(&chip->dev);
190 }
191 EXPORT_SYMBOL_GPL(tpm_put_ops);
192
193 /**
194  * tpm_default_chip() - find a TPM chip and get a reference to it
195  */
196 struct tpm_chip *tpm_default_chip(void)
197 {
198         struct tpm_chip *chip, *res = NULL;
199         int chip_num = 0;
200         int chip_prev;
201
202         mutex_lock(&idr_lock);
203
204         do {
205                 chip_prev = chip_num;
206                 chip = idr_get_next(&dev_nums_idr, &chip_num);
207                 if (chip) {
208                         get_device(&chip->dev);
209                         res = chip;
210                         break;
211                 }
212         } while (chip_prev != chip_num);
213
214         mutex_unlock(&idr_lock);
215
216         return res;
217 }
218 EXPORT_SYMBOL_GPL(tpm_default_chip);
219
220 /**
221  * tpm_find_get_ops() - find and reserve a TPM chip
222  * @chip:       a &struct tpm_chip instance, %NULL for the default chip
223  *
224  * Finds a TPM chip and reserves its class device and operations. The chip must
225  * be released with tpm_put_ops() after use.
226  * This function is for internal use only. It supports existing TPM callers
227  * by accepting NULL, but those callers should be converted to pass in a chip
228  * directly.
229  *
230  * Return:
231  * A reserved &struct tpm_chip instance.
232  * %NULL if a chip is not found.
233  * %NULL if the chip is not available.
234  */
235 struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip)
236 {
237         int rc;
238
239         if (chip) {
240                 if (!tpm_try_get_ops(chip))
241                         return chip;
242                 return NULL;
243         }
244
245         chip = tpm_default_chip();
246         if (!chip)
247                 return NULL;
248         rc = tpm_try_get_ops(chip);
249         /* release additional reference we got from tpm_default_chip() */
250         put_device(&chip->dev);
251         if (rc)
252                 return NULL;
253         return chip;
254 }
255
256 /**
257  * tpm_dev_release() - free chip memory and the device number
258  * @dev: the character device for the TPM chip
259  *
260  * This is used as the release function for the character device.
261  */
262 static void tpm_dev_release(struct device *dev)
263 {
264         struct tpm_chip *chip = container_of(dev, struct tpm_chip, dev);
265
266         mutex_lock(&idr_lock);
267         idr_remove(&dev_nums_idr, chip->dev_num);
268         mutex_unlock(&idr_lock);
269
270         kfree(chip->work_space.context_buf);
271         kfree(chip->work_space.session_buf);
272         kfree(chip->allocated_banks);
273         kfree(chip);
274 }
275
276 /**
277  * tpm_class_shutdown() - prepare the TPM device for loss of power.
278  * @dev: device to which the chip is associated.
279  *
280  * Issues a TPM2_Shutdown command prior to loss of power, as required by the
281  * TPM 2.0 spec. Then, calls bus- and device- specific shutdown code.
282  *
283  * Return: always 0 (i.e. success)
284  */
285 static int tpm_class_shutdown(struct device *dev)
286 {
287         struct tpm_chip *chip = container_of(dev, struct tpm_chip, dev);
288
289         down_write(&chip->ops_sem);
290         if (chip->flags & TPM_CHIP_FLAG_TPM2) {
291                 if (!tpm_chip_start(chip)) {
292                         tpm2_shutdown(chip, TPM2_SU_CLEAR);
293                         tpm_chip_stop(chip);
294                 }
295         }
296         chip->ops = NULL;
297         up_write(&chip->ops_sem);
298
299         return 0;
300 }
301
302 /**
303  * tpm_chip_alloc() - allocate a new struct tpm_chip instance
304  * @pdev: device to which the chip is associated
305  *        At this point pdev mst be initialized, but does not have to
306  *        be registered
307  * @ops: struct tpm_class_ops instance
308  *
309  * Allocates a new struct tpm_chip instance and assigns a free
310  * device number for it. Must be paired with put_device(&chip->dev).
311  */
312 struct tpm_chip *tpm_chip_alloc(struct device *pdev,
313                                 const struct tpm_class_ops *ops)
314 {
315         struct tpm_chip *chip;
316         int rc;
317
318         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
319         if (chip == NULL)
320                 return ERR_PTR(-ENOMEM);
321
322         mutex_init(&chip->tpm_mutex);
323         init_rwsem(&chip->ops_sem);
324
325         chip->ops = ops;
326
327         mutex_lock(&idr_lock);
328         rc = idr_alloc(&dev_nums_idr, NULL, 0, TPM_NUM_DEVICES, GFP_KERNEL);
329         mutex_unlock(&idr_lock);
330         if (rc < 0) {
331                 dev_err(pdev, "No available tpm device numbers\n");
332                 kfree(chip);
333                 return ERR_PTR(rc);
334         }
335         chip->dev_num = rc;
336
337         device_initialize(&chip->dev);
338
339         chip->dev.class = tpm_class;
340         chip->dev.class->shutdown_pre = tpm_class_shutdown;
341         chip->dev.release = tpm_dev_release;
342         chip->dev.parent = pdev;
343         chip->dev.groups = chip->groups;
344
345         if (chip->dev_num == 0)
346                 chip->dev.devt = MKDEV(MISC_MAJOR, TPM_MINOR);
347         else
348                 chip->dev.devt = MKDEV(MAJOR(tpm_devt), chip->dev_num);
349
350         rc = dev_set_name(&chip->dev, "tpm%d", chip->dev_num);
351         if (rc)
352                 goto out;
353
354         if (!pdev)
355                 chip->flags |= TPM_CHIP_FLAG_VIRTUAL;
356
357         cdev_init(&chip->cdev, &tpm_fops);
358         chip->cdev.owner = THIS_MODULE;
359
360         rc = tpm2_init_space(&chip->work_space, TPM2_SPACE_BUFFER_SIZE);
361         if (rc) {
362                 rc = -ENOMEM;
363                 goto out;
364         }
365
366         chip->locality = -1;
367         return chip;
368
369 out:
370         put_device(&chip->dev);
371         return ERR_PTR(rc);
372 }
373 EXPORT_SYMBOL_GPL(tpm_chip_alloc);
374
375 static void tpm_put_device(void *dev)
376 {
377         put_device(dev);
378 }
379
380 /**
381  * tpmm_chip_alloc() - allocate a new struct tpm_chip instance
382  * @pdev: parent device to which the chip is associated
383  * @ops: struct tpm_class_ops instance
384  *
385  * Same as tpm_chip_alloc except devm is used to do the put_device
386  */
387 struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
388                                  const struct tpm_class_ops *ops)
389 {
390         struct tpm_chip *chip;
391         int rc;
392
393         chip = tpm_chip_alloc(pdev, ops);
394         if (IS_ERR(chip))
395                 return chip;
396
397         rc = devm_add_action_or_reset(pdev,
398                                       tpm_put_device,
399                                       &chip->dev);
400         if (rc)
401                 return ERR_PTR(rc);
402
403         dev_set_drvdata(pdev, chip);
404
405         return chip;
406 }
407 EXPORT_SYMBOL_GPL(tpmm_chip_alloc);
408
409 static int tpm_add_char_device(struct tpm_chip *chip)
410 {
411         int rc;
412
413         rc = cdev_device_add(&chip->cdev, &chip->dev);
414         if (rc) {
415                 dev_err(&chip->dev,
416                         "unable to cdev_device_add() %s, major %d, minor %d, err=%d\n",
417                         dev_name(&chip->dev), MAJOR(chip->dev.devt),
418                         MINOR(chip->dev.devt), rc);
419                 return rc;
420         }
421
422         if (chip->flags & TPM_CHIP_FLAG_TPM2 && !tpm_is_firmware_upgrade(chip)) {
423                 rc = tpm_devs_add(chip);
424                 if (rc)
425                         goto err_del_cdev;
426         }
427
428         /* Make the chip available. */
429         mutex_lock(&idr_lock);
430         idr_replace(&dev_nums_idr, chip, chip->dev_num);
431         mutex_unlock(&idr_lock);
432
433         return 0;
434
435 err_del_cdev:
436         cdev_device_del(&chip->cdev, &chip->dev);
437         return rc;
438 }
439
440 static void tpm_del_char_device(struct tpm_chip *chip)
441 {
442         cdev_device_del(&chip->cdev, &chip->dev);
443
444         /* Make the chip unavailable. */
445         mutex_lock(&idr_lock);
446         idr_replace(&dev_nums_idr, NULL, chip->dev_num);
447         mutex_unlock(&idr_lock);
448
449         /* Make the driver uncallable. */
450         down_write(&chip->ops_sem);
451
452         /*
453          * Check if chip->ops is still valid: In case that the controller
454          * drivers shutdown handler unregisters the controller in its
455          * shutdown handler we are called twice and chip->ops to NULL.
456          */
457         if (chip->ops) {
458                 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
459                         if (!tpm_chip_start(chip)) {
460                                 tpm2_shutdown(chip, TPM2_SU_CLEAR);
461                                 tpm_chip_stop(chip);
462                         }
463                 }
464                 chip->ops = NULL;
465         }
466         up_write(&chip->ops_sem);
467 }
468
469 static void tpm_del_legacy_sysfs(struct tpm_chip *chip)
470 {
471         struct attribute **i;
472
473         if (chip->flags & (TPM_CHIP_FLAG_TPM2 | TPM_CHIP_FLAG_VIRTUAL) ||
474             tpm_is_firmware_upgrade(chip))
475                 return;
476
477         sysfs_remove_link(&chip->dev.parent->kobj, "ppi");
478
479         for (i = chip->groups[0]->attrs; *i != NULL; ++i)
480                 sysfs_remove_link(&chip->dev.parent->kobj, (*i)->name);
481 }
482
483 /* For compatibility with legacy sysfs paths we provide symlinks from the
484  * parent dev directory to selected names within the tpm chip directory. Old
485  * kernel versions created these files directly under the parent.
486  */
487 static int tpm_add_legacy_sysfs(struct tpm_chip *chip)
488 {
489         struct attribute **i;
490         int rc;
491
492         if (chip->flags & (TPM_CHIP_FLAG_TPM2 | TPM_CHIP_FLAG_VIRTUAL) ||
493                 tpm_is_firmware_upgrade(chip))
494                 return 0;
495
496         rc = compat_only_sysfs_link_entry_to_kobj(
497                     &chip->dev.parent->kobj, &chip->dev.kobj, "ppi", NULL);
498         if (rc && rc != -ENOENT)
499                 return rc;
500
501         /* All the names from tpm-sysfs */
502         for (i = chip->groups[0]->attrs; *i != NULL; ++i) {
503                 rc = compat_only_sysfs_link_entry_to_kobj(
504                     &chip->dev.parent->kobj, &chip->dev.kobj, (*i)->name, NULL);
505                 if (rc) {
506                         tpm_del_legacy_sysfs(chip);
507                         return rc;
508                 }
509         }
510
511         return 0;
512 }
513
514 /*
515  * Some AMD fTPM versions may cause stutter
516  * https://www.amd.com/en/support/kb/faq/pa-410
517  *
518  * Fixes are available in two series of fTPM firmware:
519  * 6.x.y.z series: 6.0.18.6 +
520  * 3.x.y.z series: 3.57.y.5 +
521  */
522 static bool tpm_amd_is_rng_defective(struct tpm_chip *chip)
523 {
524         u32 val1, val2;
525         u64 version;
526         int ret;
527
528         if (!(chip->flags & TPM_CHIP_FLAG_TPM2))
529                 return false;
530
531         ret = tpm_request_locality(chip);
532         if (ret)
533                 return false;
534
535         ret = tpm2_get_tpm_pt(chip, TPM2_PT_MANUFACTURER, &val1, NULL);
536         if (ret)
537                 goto release;
538         if (val1 != 0x414D4400U /* AMD */) {
539                 ret = -ENODEV;
540                 goto release;
541         }
542         ret = tpm2_get_tpm_pt(chip, TPM2_PT_FIRMWARE_VERSION_1, &val1, NULL);
543         if (ret)
544                 goto release;
545         ret = tpm2_get_tpm_pt(chip, TPM2_PT_FIRMWARE_VERSION_2, &val2, NULL);
546
547 release:
548         tpm_relinquish_locality(chip);
549
550         if (ret)
551                 return false;
552
553         version = ((u64)val1 << 32) | val2;
554         if ((version >> 48) == 6) {
555                 if (version >= 0x0006000000180006ULL)
556                         return false;
557         } else if ((version >> 48) == 3) {
558                 if (version >= 0x0003005700000005ULL)
559                         return false;
560         } else {
561                 return false;
562         }
563
564         dev_warn(&chip->dev,
565                  "AMD fTPM version 0x%llx causes system stutter; hwrng disabled\n",
566                  version);
567
568         return true;
569 }
570
571 static int tpm_hwrng_read(struct hwrng *rng, void *data, size_t max, bool wait)
572 {
573         struct tpm_chip *chip = container_of(rng, struct tpm_chip, hwrng);
574
575         return tpm_get_random(chip, data, max);
576 }
577
578 static int tpm_add_hwrng(struct tpm_chip *chip)
579 {
580         if (!IS_ENABLED(CONFIG_HW_RANDOM_TPM) || tpm_is_firmware_upgrade(chip) ||
581             tpm_amd_is_rng_defective(chip))
582                 return 0;
583
584         snprintf(chip->hwrng_name, sizeof(chip->hwrng_name),
585                  "tpm-rng-%d", chip->dev_num);
586         chip->hwrng.name = chip->hwrng_name;
587         chip->hwrng.read = tpm_hwrng_read;
588         return hwrng_register(&chip->hwrng);
589 }
590
591 static int tpm_get_pcr_allocation(struct tpm_chip *chip)
592 {
593         int rc;
594
595         if (tpm_is_firmware_upgrade(chip))
596                 return 0;
597
598         rc = (chip->flags & TPM_CHIP_FLAG_TPM2) ?
599              tpm2_get_pcr_allocation(chip) :
600              tpm1_get_pcr_allocation(chip);
601
602         if (rc > 0)
603                 return -ENODEV;
604
605         return rc;
606 }
607
608 /*
609  * tpm_chip_bootstrap() - Boostrap TPM chip after power on
610  * @chip: TPM chip to use.
611  *
612  * Initialize TPM chip after power on. This a one-shot function: subsequent
613  * calls will have no effect.
614  */
615 int tpm_chip_bootstrap(struct tpm_chip *chip)
616 {
617         int rc;
618
619         if (chip->flags & TPM_CHIP_FLAG_BOOTSTRAPPED)
620                 return 0;
621
622         rc = tpm_chip_start(chip);
623         if (rc)
624                 return rc;
625
626         rc = tpm_auto_startup(chip);
627         if (rc)
628                 goto stop;
629
630         rc = tpm_get_pcr_allocation(chip);
631 stop:
632         tpm_chip_stop(chip);
633
634         /*
635          * Unconditionally set, as driver initialization should cease, when the
636          * boostrapping process fails.
637          */
638         chip->flags |= TPM_CHIP_FLAG_BOOTSTRAPPED;
639
640         return rc;
641 }
642 EXPORT_SYMBOL_GPL(tpm_chip_bootstrap);
643
644 /*
645  * tpm_chip_register() - create a character device for the TPM chip
646  * @chip: TPM chip to use.
647  *
648  * Creates a character device for the TPM chip and adds sysfs attributes for
649  * the device. As the last step this function adds the chip to the list of TPM
650  * chips available for in-kernel use.
651  *
652  * This function should be only called after the chip initialization is
653  * complete.
654  */
655 int tpm_chip_register(struct tpm_chip *chip)
656 {
657         int rc;
658
659         rc = tpm_chip_bootstrap(chip);
660         if (rc)
661                 return rc;
662
663         tpm_sysfs_add_device(chip);
664
665         tpm_bios_log_setup(chip);
666
667         tpm_add_ppi(chip);
668
669         rc = tpm_add_hwrng(chip);
670         if (rc)
671                 goto out_ppi;
672
673         rc = tpm_add_char_device(chip);
674         if (rc)
675                 goto out_hwrng;
676
677         rc = tpm_add_legacy_sysfs(chip);
678         if (rc) {
679                 tpm_chip_unregister(chip);
680                 return rc;
681         }
682
683         return 0;
684
685 out_hwrng:
686         if (IS_ENABLED(CONFIG_HW_RANDOM_TPM) && !tpm_is_firmware_upgrade(chip))
687                 hwrng_unregister(&chip->hwrng);
688 out_ppi:
689         tpm_bios_log_teardown(chip);
690
691         return rc;
692 }
693 EXPORT_SYMBOL_GPL(tpm_chip_register);
694
695 /*
696  * tpm_chip_unregister() - release the TPM driver
697  * @chip: TPM chip to use.
698  *
699  * Takes the chip first away from the list of available TPM chips and then
700  * cleans up all the resources reserved by tpm_chip_register().
701  *
702  * Once this function returns the driver call backs in 'op's will not be
703  * running and will no longer start.
704  *
705  * NOTE: This function should be only called before deinitializing chip
706  * resources.
707  */
708 void tpm_chip_unregister(struct tpm_chip *chip)
709 {
710         tpm_del_legacy_sysfs(chip);
711         if (IS_ENABLED(CONFIG_HW_RANDOM_TPM) && !tpm_is_firmware_upgrade(chip) &&
712             !tpm_amd_is_rng_defective(chip))
713                 hwrng_unregister(&chip->hwrng);
714         tpm_bios_log_teardown(chip);
715         if (chip->flags & TPM_CHIP_FLAG_TPM2 && !tpm_is_firmware_upgrade(chip))
716                 tpm_devs_remove(chip);
717         tpm_del_char_device(chip);
718 }
719 EXPORT_SYMBOL_GPL(tpm_chip_unregister);