tpm.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (C) 2004,2007,2008 IBM Corporation
  4. *
  5. * Authors:
  6. * Leendert van Doorn <leendert@watson.ibm.com>
  7. * Dave Safford <safford@watson.ibm.com>
  8. * Reiner Sailer <sailer@watson.ibm.com>
  9. * Kylene Hall <kjhall@us.ibm.com>
  10. * Debora Velarde <dvelarde@us.ibm.com>
  11. *
  12. * Maintained by: <tpmdd_devel@lists.sourceforge.net>
  13. *
  14. * Device driver for TCG/TCPA TPM (trusted platform module).
  15. * Specifications at www.trustedcomputinggroup.org
  16. */
  17. #ifndef __LINUX_TPM_H__
  18. #define __LINUX_TPM_H__
  19. #include <linux/hw_random.h>
  20. #include <linux/acpi.h>
  21. #include <linux/cdev.h>
  22. #include <linux/fs.h>
  23. #include <linux/highmem.h>
  24. #include <crypto/hash_info.h>
  25. #define TPM_DIGEST_SIZE 20 /* Max TPM v1.2 PCR size */
  26. #define TPM_MAX_DIGEST_SIZE SHA512_DIGEST_SIZE
  27. struct tpm_chip;
  28. struct trusted_key_payload;
  29. struct trusted_key_options;
  30. enum tpm_algorithms {
  31. TPM_ALG_ERROR = 0x0000,
  32. TPM_ALG_SHA1 = 0x0004,
  33. TPM_ALG_KEYEDHASH = 0x0008,
  34. TPM_ALG_SHA256 = 0x000B,
  35. TPM_ALG_SHA384 = 0x000C,
  36. TPM_ALG_SHA512 = 0x000D,
  37. TPM_ALG_NULL = 0x0010,
  38. TPM_ALG_SM3_256 = 0x0012,
  39. };
  40. struct tpm_digest {
  41. u16 alg_id;
  42. u8 digest[TPM_MAX_DIGEST_SIZE];
  43. } __packed;
  44. struct tpm_bank_info {
  45. u16 alg_id;
  46. u16 digest_size;
  47. u16 crypto_id;
  48. };
  49. enum TPM_OPS_FLAGS {
  50. TPM_OPS_AUTO_STARTUP = BIT(0),
  51. };
  52. struct tpm_class_ops {
  53. unsigned int flags;
  54. const u8 req_complete_mask;
  55. const u8 req_complete_val;
  56. bool (*req_canceled)(struct tpm_chip *chip, u8 status);
  57. int (*recv) (struct tpm_chip *chip, u8 *buf, size_t len);
  58. int (*send) (struct tpm_chip *chip, u8 *buf, size_t len);
  59. void (*cancel) (struct tpm_chip *chip);
  60. u8 (*status) (struct tpm_chip *chip);
  61. void (*update_timeouts)(struct tpm_chip *chip,
  62. unsigned long *timeout_cap);
  63. void (*update_durations)(struct tpm_chip *chip,
  64. unsigned long *duration_cap);
  65. int (*go_idle)(struct tpm_chip *chip);
  66. int (*cmd_ready)(struct tpm_chip *chip);
  67. int (*request_locality)(struct tpm_chip *chip, int loc);
  68. int (*relinquish_locality)(struct tpm_chip *chip, int loc);
  69. void (*clk_enable)(struct tpm_chip *chip, bool value);
  70. };
  71. #define TPM_NUM_EVENT_LOG_FILES 3
  72. /* Indexes the duration array */
  73. enum tpm_duration {
  74. TPM_SHORT = 0,
  75. TPM_MEDIUM = 1,
  76. TPM_LONG = 2,
  77. TPM_LONG_LONG = 3,
  78. TPM_UNDEFINED,
  79. TPM_NUM_DURATIONS = TPM_UNDEFINED,
  80. };
  81. #define TPM_PPI_VERSION_LEN 3
  82. struct tpm_space {
  83. u32 context_tbl[3];
  84. u8 *context_buf;
  85. u32 session_tbl[3];
  86. u8 *session_buf;
  87. u32 buf_size;
  88. };
  89. struct tpm_bios_log {
  90. void *bios_event_log;
  91. void *bios_event_log_end;
  92. };
  93. struct tpm_chip_seqops {
  94. struct tpm_chip *chip;
  95. const struct seq_operations *seqops;
  96. };
  97. struct tpm_chip {
  98. struct device dev;
  99. struct device devs;
  100. struct cdev cdev;
  101. struct cdev cdevs;
  102. /* A driver callback under ops cannot be run unless ops_sem is held
  103. * (sometimes implicitly, eg for the sysfs code). ops becomes null
  104. * when the driver is unregistered, see tpm_try_get_ops.
  105. */
  106. struct rw_semaphore ops_sem;
  107. const struct tpm_class_ops *ops;
  108. struct tpm_bios_log log;
  109. struct tpm_chip_seqops bin_log_seqops;
  110. struct tpm_chip_seqops ascii_log_seqops;
  111. unsigned int flags;
  112. int dev_num; /* /dev/tpm# */
  113. unsigned long is_open; /* only one allowed */
  114. char hwrng_name[64];
  115. struct hwrng hwrng;
  116. struct mutex tpm_mutex; /* tpm is processing */
  117. unsigned long timeout_a; /* jiffies */
  118. unsigned long timeout_b; /* jiffies */
  119. unsigned long timeout_c; /* jiffies */
  120. unsigned long timeout_d; /* jiffies */
  121. bool timeout_adjusted;
  122. unsigned long duration[TPM_NUM_DURATIONS]; /* jiffies */
  123. bool duration_adjusted;
  124. struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
  125. const struct attribute_group *groups[3];
  126. unsigned int groups_cnt;
  127. u32 nr_allocated_banks;
  128. struct tpm_bank_info *allocated_banks;
  129. #ifdef CONFIG_ACPI
  130. acpi_handle acpi_dev_handle;
  131. char ppi_version[TPM_PPI_VERSION_LEN + 1];
  132. #endif /* CONFIG_ACPI */
  133. struct tpm_space work_space;
  134. u32 last_cc;
  135. u32 nr_commands;
  136. u32 *cc_attrs_tbl;
  137. /* active locality */
  138. int locality;
  139. };
  140. #define TPM_HEADER_SIZE 10
  141. enum tpm2_const {
  142. TPM2_PLATFORM_PCR = 24,
  143. TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8),
  144. };
  145. enum tpm2_timeouts {
  146. TPM2_TIMEOUT_A = 750,
  147. TPM2_TIMEOUT_B = 2000,
  148. TPM2_TIMEOUT_C = 200,
  149. TPM2_TIMEOUT_D = 30,
  150. TPM2_DURATION_SHORT = 20,
  151. TPM2_DURATION_MEDIUM = 750,
  152. TPM2_DURATION_LONG = 2000,
  153. TPM2_DURATION_LONG_LONG = 300000,
  154. TPM2_DURATION_DEFAULT = 120000,
  155. };
  156. enum tpm2_structures {
  157. TPM2_ST_NO_SESSIONS = 0x8001,
  158. TPM2_ST_SESSIONS = 0x8002,
  159. };
  160. /* Indicates from what layer of the software stack the error comes from */
  161. #define TSS2_RC_LAYER_SHIFT 16
  162. #define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)
  163. enum tpm2_return_codes {
  164. TPM2_RC_SUCCESS = 0x0000,
  165. TPM2_RC_HASH = 0x0083, /* RC_FMT1 */
  166. TPM2_RC_HANDLE = 0x008B,
  167. TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */
  168. TPM2_RC_FAILURE = 0x0101,
  169. TPM2_RC_DISABLED = 0x0120,
  170. TPM2_RC_COMMAND_CODE = 0x0143,
  171. TPM2_RC_TESTING = 0x090A, /* RC_WARN */
  172. TPM2_RC_REFERENCE_H0 = 0x0910,
  173. TPM2_RC_RETRY = 0x0922,
  174. };
  175. enum tpm2_command_codes {
  176. TPM2_CC_FIRST = 0x011F,
  177. TPM2_CC_HIERARCHY_CONTROL = 0x0121,
  178. TPM2_CC_HIERARCHY_CHANGE_AUTH = 0x0129,
  179. TPM2_CC_CREATE_PRIMARY = 0x0131,
  180. TPM2_CC_SEQUENCE_COMPLETE = 0x013E,
  181. TPM2_CC_SELF_TEST = 0x0143,
  182. TPM2_CC_STARTUP = 0x0144,
  183. TPM2_CC_SHUTDOWN = 0x0145,
  184. TPM2_CC_NV_READ = 0x014E,
  185. TPM2_CC_CREATE = 0x0153,
  186. TPM2_CC_LOAD = 0x0157,
  187. TPM2_CC_SEQUENCE_UPDATE = 0x015C,
  188. TPM2_CC_UNSEAL = 0x015E,
  189. TPM2_CC_CONTEXT_LOAD = 0x0161,
  190. TPM2_CC_CONTEXT_SAVE = 0x0162,
  191. TPM2_CC_FLUSH_CONTEXT = 0x0165,
  192. TPM2_CC_VERIFY_SIGNATURE = 0x0177,
  193. TPM2_CC_GET_CAPABILITY = 0x017A,
  194. TPM2_CC_GET_RANDOM = 0x017B,
  195. TPM2_CC_PCR_READ = 0x017E,
  196. TPM2_CC_PCR_EXTEND = 0x0182,
  197. TPM2_CC_EVENT_SEQUENCE_COMPLETE = 0x0185,
  198. TPM2_CC_HASH_SEQUENCE_START = 0x0186,
  199. TPM2_CC_CREATE_LOADED = 0x0191,
  200. TPM2_CC_LAST = 0x0193, /* Spec 1.36 */
  201. };
  202. enum tpm2_permanent_handles {
  203. TPM2_RS_PW = 0x40000009,
  204. };
  205. enum tpm2_capabilities {
  206. TPM2_CAP_HANDLES = 1,
  207. TPM2_CAP_COMMANDS = 2,
  208. TPM2_CAP_PCRS = 5,
  209. TPM2_CAP_TPM_PROPERTIES = 6,
  210. };
  211. enum tpm2_properties {
  212. TPM_PT_TOTAL_COMMANDS = 0x0129,
  213. };
  214. enum tpm2_startup_types {
  215. TPM2_SU_CLEAR = 0x0000,
  216. TPM2_SU_STATE = 0x0001,
  217. };
  218. enum tpm2_cc_attrs {
  219. TPM2_CC_ATTR_CHANDLES = 25,
  220. TPM2_CC_ATTR_RHANDLE = 28,
  221. };
  222. #define TPM_VID_INTEL 0x8086
  223. #define TPM_VID_WINBOND 0x1050
  224. #define TPM_VID_STM 0x104A
  225. #define TPM_VID_ATML 0x1114
  226. enum tpm_chip_flags {
  227. TPM_CHIP_FLAG_TPM2 = BIT(1),
  228. TPM_CHIP_FLAG_IRQ = BIT(2),
  229. TPM_CHIP_FLAG_VIRTUAL = BIT(3),
  230. TPM_CHIP_FLAG_HAVE_TIMEOUTS = BIT(4),
  231. TPM_CHIP_FLAG_ALWAYS_POWERED = BIT(5),
  232. TPM_CHIP_FLAG_FIRMWARE_POWER_MANAGED = BIT(6),
  233. };
  234. #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
  235. struct tpm_header {
  236. __be16 tag;
  237. __be32 length;
  238. union {
  239. __be32 ordinal;
  240. __be32 return_code;
  241. };
  242. } __packed;
  243. /* A string buffer type for constructing TPM commands. This is based on the
  244. * ideas of string buffer code in security/keys/trusted.h but is heap based
  245. * in order to keep the stack usage minimal.
  246. */
  247. enum tpm_buf_flags {
  248. TPM_BUF_OVERFLOW = BIT(0),
  249. };
  250. struct tpm_buf {
  251. unsigned int flags;
  252. u8 *data;
  253. };
  254. enum tpm2_object_attributes {
  255. TPM2_OA_USER_WITH_AUTH = BIT(6),
  256. };
  257. enum tpm2_session_attributes {
  258. TPM2_SA_CONTINUE_SESSION = BIT(0),
  259. };
  260. struct tpm2_hash {
  261. unsigned int crypto_id;
  262. unsigned int tpm_id;
  263. };
  264. static inline void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal)
  265. {
  266. struct tpm_header *head = (struct tpm_header *)buf->data;
  267. head->tag = cpu_to_be16(tag);
  268. head->length = cpu_to_be32(sizeof(*head));
  269. head->ordinal = cpu_to_be32(ordinal);
  270. }
  271. static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
  272. {
  273. buf->data = (u8 *)__get_free_page(GFP_KERNEL);
  274. if (!buf->data)
  275. return -ENOMEM;
  276. buf->flags = 0;
  277. tpm_buf_reset(buf, tag, ordinal);
  278. return 0;
  279. }
  280. static inline void tpm_buf_destroy(struct tpm_buf *buf)
  281. {
  282. free_page((unsigned long)buf->data);
  283. }
  284. static inline u32 tpm_buf_length(struct tpm_buf *buf)
  285. {
  286. struct tpm_header *head = (struct tpm_header *)buf->data;
  287. return be32_to_cpu(head->length);
  288. }
  289. static inline u16 tpm_buf_tag(struct tpm_buf *buf)
  290. {
  291. struct tpm_header *head = (struct tpm_header *)buf->data;
  292. return be16_to_cpu(head->tag);
  293. }
  294. static inline void tpm_buf_append(struct tpm_buf *buf,
  295. const unsigned char *new_data,
  296. unsigned int new_len)
  297. {
  298. struct tpm_header *head = (struct tpm_header *)buf->data;
  299. u32 len = tpm_buf_length(buf);
  300. /* Return silently if overflow has already happened. */
  301. if (buf->flags & TPM_BUF_OVERFLOW)
  302. return;
  303. if ((len + new_len) > PAGE_SIZE) {
  304. WARN(1, "tpm_buf: overflow\n");
  305. buf->flags |= TPM_BUF_OVERFLOW;
  306. return;
  307. }
  308. memcpy(&buf->data[len], new_data, new_len);
  309. head->length = cpu_to_be32(len + new_len);
  310. }
  311. static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
  312. {
  313. tpm_buf_append(buf, &value, 1);
  314. }
  315. static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
  316. {
  317. __be16 value2 = cpu_to_be16(value);
  318. tpm_buf_append(buf, (u8 *) &value2, 2);
  319. }
  320. static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
  321. {
  322. __be32 value2 = cpu_to_be32(value);
  323. tpm_buf_append(buf, (u8 *) &value2, 4);
  324. }
  325. static inline u32 tpm2_rc_value(u32 rc)
  326. {
  327. return (rc & BIT(7)) ? rc & 0xff : rc;
  328. }
  329. #if defined(CONFIG_TCG_TPM) || defined(CONFIG_TCG_TPM_MODULE)
  330. extern int tpm_is_tpm2(struct tpm_chip *chip);
  331. extern __must_check int tpm_try_get_ops(struct tpm_chip *chip);
  332. extern void tpm_put_ops(struct tpm_chip *chip);
  333. extern ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_buf *buf,
  334. size_t min_rsp_body_length, const char *desc);
  335. extern int tpm_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
  336. struct tpm_digest *digest);
  337. extern int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
  338. struct tpm_digest *digests);
  339. extern int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen);
  340. extern int tpm_get_random(struct tpm_chip *chip, u8 *data, size_t max);
  341. extern struct tpm_chip *tpm_default_chip(void);
  342. void tpm2_flush_context(struct tpm_chip *chip, u32 handle);
  343. #else
  344. static inline int tpm_is_tpm2(struct tpm_chip *chip)
  345. {
  346. return -ENODEV;
  347. }
  348. static inline int tpm_pcr_read(struct tpm_chip *chip, int pcr_idx,
  349. struct tpm_digest *digest)
  350. {
  351. return -ENODEV;
  352. }
  353. static inline int tpm_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
  354. struct tpm_digest *digests)
  355. {
  356. return -ENODEV;
  357. }
  358. static inline int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen)
  359. {
  360. return -ENODEV;
  361. }
  362. static inline int tpm_get_random(struct tpm_chip *chip, u8 *data, size_t max)
  363. {
  364. return -ENODEV;
  365. }
  366. static inline struct tpm_chip *tpm_default_chip(void)
  367. {
  368. return NULL;
  369. }
  370. #endif
  371. #endif