123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466 |
- /* SPDX-License-Identifier: GPL-2.0-only */
- /*
- * Copyright (C) 2004,2007,2008 IBM Corporation
- *
- * Authors:
- * Leendert van Doorn <[email protected]>
- * Dave Safford <[email protected]>
- * Reiner Sailer <[email protected]>
- * Kylene Hall <[email protected]>
- * Debora Velarde <[email protected]>
- *
- * Maintained by: <[email protected]>
- *
- * Device driver for TCG/TCPA TPM (trusted platform module).
- * Specifications at www.trustedcomputinggroup.org
- */
- #ifndef __LINUX_TPM_H__
- #define __LINUX_TPM_H__
- #include <linux/hw_random.h>
- #include <linux/acpi.h>
- #include <linux/cdev.h>
- #include <linux/fs.h>
- #include <linux/highmem.h>
- #include <crypto/hash_info.h>
- #define TPM_DIGEST_SIZE 20 /* Max TPM v1.2 PCR size */
- #define TPM_MAX_DIGEST_SIZE SHA512_DIGEST_SIZE
- struct tpm_chip;
- struct trusted_key_payload;
- struct trusted_key_options;
- /* if you add a new hash to this, increment TPM_MAX_HASHES below */
- enum tpm_algorithms {
- TPM_ALG_ERROR = 0x0000,
- TPM_ALG_SHA1 = 0x0004,
- TPM_ALG_KEYEDHASH = 0x0008,
- TPM_ALG_SHA256 = 0x000B,
- TPM_ALG_SHA384 = 0x000C,
- TPM_ALG_SHA512 = 0x000D,
- TPM_ALG_NULL = 0x0010,
- TPM_ALG_SM3_256 = 0x0012,
- };
- /*
- * maximum number of hashing algorithms a TPM can have. This is
- * basically a count of every hash in tpm_algorithms above
- */
- #define TPM_MAX_HASHES 5
- struct tpm_digest {
- u16 alg_id;
- u8 digest[TPM_MAX_DIGEST_SIZE];
- } __packed;
- struct tpm_bank_info {
- u16 alg_id;
- u16 digest_size;
- u16 crypto_id;
- };
- enum TPM_OPS_FLAGS {
- TPM_OPS_AUTO_STARTUP = BIT(0),
- };
- struct tpm_class_ops {
- unsigned int flags;
- const u8 req_complete_mask;
- const u8 req_complete_val;
- bool (*req_canceled)(struct tpm_chip *chip, u8 status);
- int (*recv) (struct tpm_chip *chip, u8 *buf, size_t len);
- int (*send) (struct tpm_chip *chip, u8 *buf, size_t len);
- void (*cancel) (struct tpm_chip *chip);
- u8 (*status) (struct tpm_chip *chip);
- void (*update_timeouts)(struct tpm_chip *chip,
- unsigned long *timeout_cap);
- void (*update_durations)(struct tpm_chip *chip,
- unsigned long *duration_cap);
- int (*go_idle)(struct tpm_chip *chip);
- int (*cmd_ready)(struct tpm_chip *chip);
- int (*request_locality)(struct tpm_chip *chip, int loc);
- int (*relinquish_locality)(struct tpm_chip *chip, int loc);
- void (*clk_enable)(struct tpm_chip *chip, bool value);
- };
- #define TPM_NUM_EVENT_LOG_FILES 3
- /* Indexes the duration array */
- enum tpm_duration {
- TPM_SHORT = 0,
- TPM_MEDIUM = 1,
- TPM_LONG = 2,
- TPM_LONG_LONG = 3,
- TPM_UNDEFINED,
- TPM_NUM_DURATIONS = TPM_UNDEFINED,
- };
- #define TPM_PPI_VERSION_LEN 3
- struct tpm_space {
- u32 context_tbl[3];
- u8 *context_buf;
- u32 session_tbl[3];
- u8 *session_buf;
- u32 buf_size;
- };
- struct tpm_bios_log {
- void *bios_event_log;
- void *bios_event_log_end;
- };
- struct tpm_chip_seqops {
- struct tpm_chip *chip;
- const struct seq_operations *seqops;
- };
- struct tpm_chip {
- struct device dev;
- struct device devs;
- struct cdev cdev;
- struct cdev cdevs;
- /* A driver callback under ops cannot be run unless ops_sem is held
- * (sometimes implicitly, eg for the sysfs code). ops becomes null
- * when the driver is unregistered, see tpm_try_get_ops.
- */
- struct rw_semaphore ops_sem;
- const struct tpm_class_ops *ops;
- struct tpm_bios_log log;
- struct tpm_chip_seqops bin_log_seqops;
- struct tpm_chip_seqops ascii_log_seqops;
- unsigned int flags;
- int dev_num; /* /dev/tpm# */
- unsigned long is_open; /* only one allowed */
- char hwrng_name[64];
- struct hwrng hwrng;
- struct mutex tpm_mutex; /* tpm is processing */
- unsigned long timeout_a; /* jiffies */
- unsigned long timeout_b; /* jiffies */
- unsigned long timeout_c; /* jiffies */
- unsigned long timeout_d; /* jiffies */
- bool timeout_adjusted;
- unsigned long duration[TPM_NUM_DURATIONS]; /* jiffies */
- bool duration_adjusted;
- struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
- const struct attribute_group *groups[3 + TPM_MAX_HASHES];
- unsigned int groups_cnt;
- u32 nr_allocated_banks;
- struct tpm_bank_info *allocated_banks;
- #ifdef CONFIG_ACPI
- acpi_handle acpi_dev_handle;
- char ppi_version[TPM_PPI_VERSION_LEN + 1];
- #endif /* CONFIG_ACPI */
- struct tpm_space work_space;
- u32 last_cc;
- u32 nr_commands;
- u32 *cc_attrs_tbl;
- /* active locality */
- int locality;
- };
- #define TPM_HEADER_SIZE 10
- enum tpm2_const {
- TPM2_PLATFORM_PCR = 24,
- TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8),
- };
- enum tpm2_timeouts {
- TPM2_TIMEOUT_A = 750,
- TPM2_TIMEOUT_B = 2000,
- TPM2_TIMEOUT_C = 200,
- TPM2_TIMEOUT_D = 30,
- TPM2_DURATION_SHORT = 20,
- TPM2_DURATION_MEDIUM = 750,
- TPM2_DURATION_LONG = 2000,
- TPM2_DURATION_LONG_LONG = 300000,
- TPM2_DURATION_DEFAULT = 120000,
- };
- enum tpm2_structures {
- TPM2_ST_NO_SESSIONS = 0x8001,
- TPM2_ST_SESSIONS = 0x8002,
- };
- /* Indicates from what layer of the software stack the error comes from */
- #define TSS2_RC_LAYER_SHIFT 16
- #define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)
- enum tpm2_return_codes {
- TPM2_RC_SUCCESS = 0x0000,
- TPM2_RC_HASH = 0x0083, /* RC_FMT1 */
- TPM2_RC_HANDLE = 0x008B,
- TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */
- TPM2_RC_FAILURE = 0x0101,
- TPM2_RC_DISABLED = 0x0120,
- TPM2_RC_UPGRADE = 0x012D,
- TPM2_RC_COMMAND_CODE = 0x0143,
- TPM2_RC_TESTING = 0x090A, /* RC_WARN */
- TPM2_RC_REFERENCE_H0 = 0x0910,
- TPM2_RC_RETRY = 0x0922,
- };
- enum tpm2_command_codes {
- TPM2_CC_FIRST = 0x011F,
- TPM2_CC_HIERARCHY_CONTROL = 0x0121,
- TPM2_CC_HIERARCHY_CHANGE_AUTH = 0x0129,
- TPM2_CC_CREATE_PRIMARY = 0x0131,
- TPM2_CC_SEQUENCE_COMPLETE = 0x013E,
- TPM2_CC_SELF_TEST = 0x0143,
- TPM2_CC_STARTUP = 0x0144,
- TPM2_CC_SHUTDOWN = 0x0145,
- TPM2_CC_NV_READ = 0x014E,
- TPM2_CC_CREATE = 0x0153,
- TPM2_CC_LOAD = 0x0157,
- TPM2_CC_SEQUENCE_UPDATE = 0x015C,
- TPM2_CC_UNSEAL = 0x015E,
- TPM2_CC_CONTEXT_LOAD = 0x0161,
- TPM2_CC_CONTEXT_SAVE = 0x0162,
- TPM2_CC_FLUSH_CONTEXT = 0x0165,
- TPM2_CC_VERIFY_SIGNATURE = 0x0177,
- TPM2_CC_GET_CAPABILITY = 0x017A,
- TPM2_CC_GET_RANDOM = 0x017B,
- TPM2_CC_PCR_READ = 0x017E,
- TPM2_CC_PCR_EXTEND = 0x0182,
- TPM2_CC_EVENT_SEQUENCE_COMPLETE = 0x0185,
- TPM2_CC_HASH_SEQUENCE_START = 0x0186,
- TPM2_CC_CREATE_LOADED = 0x0191,
- TPM2_CC_LAST = 0x0193, /* Spec 1.36 */
- };
- enum tpm2_permanent_handles {
- TPM2_RS_PW = 0x40000009,
- };
- enum tpm2_capabilities {
- TPM2_CAP_HANDLES = 1,
- TPM2_CAP_COMMANDS = 2,
- TPM2_CAP_PCRS = 5,
- TPM2_CAP_TPM_PROPERTIES = 6,
- };
- enum tpm2_properties {
- TPM_PT_TOTAL_COMMANDS = 0x0129,
- };
- enum tpm2_startup_types {
- TPM2_SU_CLEAR = 0x0000,
- TPM2_SU_STATE = 0x0001,
- };
- enum tpm2_cc_attrs {
- TPM2_CC_ATTR_CHANDLES = 25,
- TPM2_CC_ATTR_RHANDLE = 28,
- };
- #define TPM_VID_INTEL 0x8086
- #define TPM_VID_WINBOND 0x1050
- #define TPM_VID_STM 0x104A
- #define TPM_VID_ATML 0x1114
- enum tpm_chip_flags {
- TPM_CHIP_FLAG_BOOTSTRAPPED = BIT(0),
- TPM_CHIP_FLAG_TPM2 = BIT(1),
- TPM_CHIP_FLAG_IRQ = BIT(2),
- TPM_CHIP_FLAG_VIRTUAL = BIT(3),
- TPM_CHIP_FLAG_HAVE_TIMEOUTS = BIT(4),
- TPM_CHIP_FLAG_ALWAYS_POWERED = BIT(5),
- TPM_CHIP_FLAG_FIRMWARE_POWER_MANAGED = BIT(6),
- TPM_CHIP_FLAG_FIRMWARE_UPGRADE = BIT(7),
- TPM_CHIP_FLAG_SUSPENDED = BIT(8),
- TPM_CHIP_FLAG_HWRNG_DISABLED = BIT(9),
- };
- #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
- struct tpm_header {
- __be16 tag;
- __be32 length;
- union {
- __be32 ordinal;
- __be32 return_code;
- };
- } __packed;
- /* A string buffer type for constructing TPM commands. This is based on the
- * ideas of string buffer code in security/keys/trusted.h but is heap based
- * in order to keep the stack usage minimal.
- */
- enum tpm_buf_flags {
- TPM_BUF_OVERFLOW = BIT(0),
- };
- struct tpm_buf {
- unsigned int flags;
- u8 *data;
- };
- enum tpm2_object_attributes {
- TPM2_OA_FIXED_TPM = BIT(1),
- TPM2_OA_FIXED_PARENT = BIT(4),
- TPM2_OA_USER_WITH_AUTH = BIT(6),
- };
- enum tpm2_session_attributes {
- TPM2_SA_CONTINUE_SESSION = BIT(0),
- };
- struct tpm2_hash {
- unsigned int crypto_id;
- unsigned int tpm_id;
- };
- static inline void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal)
- {
- struct tpm_header *head = (struct tpm_header *)buf->data;
- head->tag = cpu_to_be16(tag);
- head->length = cpu_to_be32(sizeof(*head));
- head->ordinal = cpu_to_be32(ordinal);
- }
- static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
- {
- buf->data = (u8 *)__get_free_page(GFP_KERNEL);
- if (!buf->data)
- return -ENOMEM;
- buf->flags = 0;
- tpm_buf_reset(buf, tag, ordinal);
- return 0;
- }
- static inline void tpm_buf_destroy(struct tpm_buf *buf)
- {
- free_page((unsigned long)buf->data);
- }
- static inline u32 tpm_buf_length(struct tpm_buf *buf)
- {
- struct tpm_header *head = (struct tpm_header *)buf->data;
- return be32_to_cpu(head->length);
- }
- static inline u16 tpm_buf_tag(struct tpm_buf *buf)
- {
- struct tpm_header *head = (struct tpm_header *)buf->data;
- return be16_to_cpu(head->tag);
- }
- static inline void tpm_buf_append(struct tpm_buf *buf,
- const unsigned char *new_data,
- unsigned int new_len)
- {
- struct tpm_header *head = (struct tpm_header *)buf->data;
- u32 len = tpm_buf_length(buf);
- /* Return silently if overflow has already happened. */
- if (buf->flags & TPM_BUF_OVERFLOW)
- return;
- if ((len + new_len) > PAGE_SIZE) {
- WARN(1, "tpm_buf: overflow\n");
- buf->flags |= TPM_BUF_OVERFLOW;
- return;
- }
- memcpy(&buf->data[len], new_data, new_len);
- head->length = cpu_to_be32(len + new_len);
- }
- static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
- {
- tpm_buf_append(buf, &value, 1);
- }
- static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
- {
- __be16 value2 = cpu_to_be16(value);
- tpm_buf_append(buf, (u8 *) &value2, 2);
- }
- static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
- {
- __be32 value2 = cpu_to_be32(value);
- tpm_buf_append(buf, (u8 *) &value2, 4);
- }
- /*
- * Check if TPM device is in the firmware upgrade mode.
- */
- static inline bool tpm_is_firmware_upgrade(struct tpm_chip *chip)
- {
- return chip->flags & TPM_CHIP_FLAG_FIRMWARE_UPGRADE;
- }
- static inline u32 tpm2_rc_value(u32 rc)
- {
- return (rc & BIT(7)) ? rc & 0xff : rc;
- }
- #if defined(CONFIG_TCG_TPM) || defined(CONFIG_TCG_TPM_MODULE)
- extern int tpm_is_tpm2(struct tpm_chip *chip);
- extern __must_check int tpm_try_get_ops(struct tpm_chip *chip);
- extern void tpm_put_ops(struct tpm_chip *chip);
- extern ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_buf *buf,
- size_t min_rsp_body_length, const char *desc);
- extern int tpm_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
- struct tpm_digest *digest);
- extern int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
- struct tpm_digest *digests);
- extern int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen);
- extern int tpm_get_random(struct tpm_chip *chip, u8 *data, size_t max);
- extern struct tpm_chip *tpm_default_chip(void);
- void tpm2_flush_context(struct tpm_chip *chip, u32 handle);
- #else
- static inline int tpm_is_tpm2(struct tpm_chip *chip)
- {
- return -ENODEV;
- }
- static inline int tpm_pcr_read(struct tpm_chip *chip, int pcr_idx,
- struct tpm_digest *digest)
- {
- return -ENODEV;
- }
- static inline int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
- struct tpm_digest *digests)
- {
- return -ENODEV;
- }
- static inline int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen)
- {
- return -ENODEV;
- }
- static inline int tpm_get_random(struct tpm_chip *chip, u8 *data, size_t max)
- {
- return -ENODEV;
- }
- static inline struct tpm_chip *tpm_default_chip(void)
- {
- return NULL;
- }
- #endif
- #endif
|