tpm-v2.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Defines APIs and structures that allow software to interact with a
  4. * TPM2 device
  5. *
  6. * Copyright (c) 2020 Linaro
  7. * Copyright (c) 2018 Bootlin
  8. *
  9. * https://trustedcomputinggroup.org/resource/tss-overview-common-structures-specification/
  10. *
  11. * Author: Miquel Raynal <miquel.raynal@bootlin.com>
  12. */
  13. #ifndef __TPM_V2_H
  14. #define __TPM_V2_H
  15. #include <tpm-common.h>
  16. struct udevice;
  17. #define TPM2_DIGEST_LEN 32
  18. #define TPM2_SHA1_DIGEST_SIZE 20
  19. #define TPM2_SHA256_DIGEST_SIZE 32
  20. #define TPM2_SHA384_DIGEST_SIZE 48
  21. #define TPM2_SHA512_DIGEST_SIZE 64
  22. #define TPM2_SM3_256_DIGEST_SIZE 32
  23. #define TPM2_MAX_PCRS 32
  24. #define TPM2_PCR_SELECT_MAX ((TPM2_MAX_PCRS + 7) / 8)
  25. #define TPM2_MAX_CAP_BUFFER 1024
  26. #define TPM2_MAX_TPM_PROPERTIES ((TPM2_MAX_CAP_BUFFER - sizeof(u32) /* TPM2_CAP */ - \
  27. sizeof(u32)) / sizeof(struct tpms_tagged_property))
  28. #define TPM2_HDR_LEN 10
  29. /*
  30. * We deviate from this draft of the specification by increasing the value of
  31. * TPM2_NUM_PCR_BANKS from 3 to 16 to ensure compatibility with TPM2
  32. * implementations that have enabled a larger than typical number of PCR
  33. * banks. This larger value for TPM2_NUM_PCR_BANKS is expected to be included
  34. * in a future revision of the specification.
  35. */
  36. #define TPM2_NUM_PCR_BANKS 16
  37. /* Definition of (UINT32) TPM2_CAP Constants */
  38. #define TPM2_CAP_PCRS 0x00000005U
  39. #define TPM2_CAP_TPM_PROPERTIES 0x00000006U
  40. /* Definition of (UINT32) TPM2_PT Constants */
  41. #define TPM2_PT_GROUP (u32)(0x00000100)
  42. #define TPM2_PT_FIXED (u32)(TPM2_PT_GROUP * 1)
  43. #define TPM2_PT_MANUFACTURER (u32)(TPM2_PT_FIXED + 5)
  44. #define TPM2_PT_PCR_COUNT (u32)(TPM2_PT_FIXED + 18)
  45. #define TPM2_PT_MAX_COMMAND_SIZE (u32)(TPM2_PT_FIXED + 30)
  46. #define TPM2_PT_MAX_RESPONSE_SIZE (u32)(TPM2_PT_FIXED + 31)
  47. /*
  48. * event types, cf.
  49. * "TCG Server Management Domain Firmware Profile Specification",
  50. * rev 1.00, 2020-05-01
  51. */
  52. #define EV_POST_CODE ((u32)0x00000001)
  53. #define EV_NO_ACTION ((u32)0x00000003)
  54. #define EV_SEPARATOR ((u32)0x00000004)
  55. #define EV_ACTION ((u32)0x00000005)
  56. #define EV_TAG ((u32)0x00000006)
  57. #define EV_S_CRTM_CONTENTS ((u32)0x00000007)
  58. #define EV_S_CRTM_VERSION ((u32)0x00000008)
  59. #define EV_CPU_MICROCODE ((u32)0x00000009)
  60. #define EV_PLATFORM_CONFIG_FLAGS ((u32)0x0000000A)
  61. #define EV_TABLE_OF_DEVICES ((u32)0x0000000B)
  62. #define EV_COMPACT_HASH ((u32)0x0000000C)
  63. /*
  64. * event types, cf.
  65. * "TCG PC Client Platform Firmware Profile Specification", Family "2.0"
  66. * Level 00 Version 1.05 Revision 23, May 7, 2021
  67. */
  68. #define EV_EFI_EVENT_BASE ((u32)0x80000000)
  69. #define EV_EFI_VARIABLE_DRIVER_CONFIG ((u32)0x80000001)
  70. #define EV_EFI_VARIABLE_BOOT ((u32)0x80000002)
  71. #define EV_EFI_BOOT_SERVICES_APPLICATION ((u32)0x80000003)
  72. #define EV_EFI_BOOT_SERVICES_DRIVER ((u32)0x80000004)
  73. #define EV_EFI_RUNTIME_SERVICES_DRIVER ((u32)0x80000005)
  74. #define EV_EFI_GPT_EVENT ((u32)0x80000006)
  75. #define EV_EFI_ACTION ((u32)0x80000007)
  76. #define EV_EFI_PLATFORM_FIRMWARE_BLOB ((u32)0x80000008)
  77. #define EV_EFI_HANDOFF_TABLES ((u32)0x80000009)
  78. #define EV_EFI_PLATFORM_FIRMWARE_BLOB2 ((u32)0x8000000A)
  79. #define EV_EFI_HANDOFF_TABLES2 ((u32)0x8000000B)
  80. #define EV_EFI_VARIABLE_BOOT2 ((u32)0x8000000C)
  81. #define EV_EFI_HCRTM_EVENT ((u32)0x80000010)
  82. #define EV_EFI_VARIABLE_AUTHORITY ((u32)0x800000E0)
  83. #define EV_EFI_SPDM_FIRMWARE_BLOB ((u32)0x800000E1)
  84. #define EV_EFI_SPDM_FIRMWARE_CONFIG ((u32)0x800000E2)
  85. #define EFI_CALLING_EFI_APPLICATION \
  86. "Calling EFI Application from Boot Option"
  87. #define EFI_RETURNING_FROM_EFI_APPLICATION \
  88. "Returning from EFI Application from Boot Option"
  89. #define EFI_EXIT_BOOT_SERVICES_INVOCATION \
  90. "Exit Boot Services Invocation"
  91. #define EFI_EXIT_BOOT_SERVICES_FAILED \
  92. "Exit Boot Services Returned with Failure"
  93. #define EFI_EXIT_BOOT_SERVICES_SUCCEEDED \
  94. "Exit Boot Services Returned with Success"
  95. #define EFI_DTB_EVENT_STRING \
  96. "DTB DATA"
  97. /* TPMS_TAGGED_PROPERTY Structure */
  98. struct tpms_tagged_property {
  99. u32 property;
  100. u32 value;
  101. } __packed;
  102. /* TPMS_PCR_SELECTION Structure */
  103. struct tpms_pcr_selection {
  104. u16 hash;
  105. u8 size_of_select;
  106. u8 pcr_select[TPM2_PCR_SELECT_MAX];
  107. } __packed;
  108. /* TPML_PCR_SELECTION Structure */
  109. struct tpml_pcr_selection {
  110. u32 count;
  111. struct tpms_pcr_selection selection[TPM2_NUM_PCR_BANKS];
  112. } __packed;
  113. /* TPML_TAGGED_TPM_PROPERTY Structure */
  114. struct tpml_tagged_tpm_property {
  115. u32 count;
  116. struct tpms_tagged_property tpm_property[TPM2_MAX_TPM_PROPERTIES];
  117. } __packed;
  118. /* TPMU_CAPABILITIES Union */
  119. union tpmu_capabilities {
  120. /*
  121. * Non exhaustive. Only added the structs needed for our
  122. * current code
  123. */
  124. struct tpml_pcr_selection assigned_pcr;
  125. struct tpml_tagged_tpm_property tpm_properties;
  126. } __packed;
  127. /* TPMS_CAPABILITY_DATA Structure */
  128. struct tpms_capability_data {
  129. u32 capability;
  130. union tpmu_capabilities data;
  131. } __packed;
  132. /**
  133. * SHA1 Event Log Entry Format
  134. *
  135. * @pcr_index: PCRIndex event extended to
  136. * @event_type: Type of event (see EFI specs)
  137. * @digest: Value extended into PCR index
  138. * @event_size: Size of event
  139. * @event: Event data
  140. */
  141. struct tcg_pcr_event {
  142. u32 pcr_index;
  143. u32 event_type;
  144. u8 digest[TPM2_SHA1_DIGEST_SIZE];
  145. u32 event_size;
  146. u8 event[];
  147. } __packed;
  148. /**
  149. * Definition of TPMU_HA Union
  150. */
  151. union tmpu_ha {
  152. u8 sha1[TPM2_SHA1_DIGEST_SIZE];
  153. u8 sha256[TPM2_SHA256_DIGEST_SIZE];
  154. u8 sm3_256[TPM2_SM3_256_DIGEST_SIZE];
  155. u8 sha384[TPM2_SHA384_DIGEST_SIZE];
  156. u8 sha512[TPM2_SHA512_DIGEST_SIZE];
  157. } __packed;
  158. /**
  159. * Definition of TPMT_HA Structure
  160. *
  161. * @hash_alg: Hash algorithm defined in enum tpm2_algorithms
  162. * @digest: Digest value for a given algorithm
  163. */
  164. struct tpmt_ha {
  165. u16 hash_alg;
  166. union tmpu_ha digest;
  167. } __packed;
  168. /**
  169. * Definition of TPML_DIGEST_VALUES Structure
  170. *
  171. * @count: Number of algorithms supported by hardware
  172. * @digests: struct for algorithm id and hash value
  173. */
  174. struct tpml_digest_values {
  175. u32 count;
  176. struct tpmt_ha digests[TPM2_NUM_PCR_BANKS];
  177. } __packed;
  178. /**
  179. * Crypto Agile Log Entry Format
  180. *
  181. * @pcr_index: PCRIndex event extended to
  182. * @event_type: Type of event
  183. * @digests: List of digestsextended to PCR index
  184. * @event_size: Size of the event data
  185. * @event: Event data
  186. */
  187. struct tcg_pcr_event2 {
  188. u32 pcr_index;
  189. u32 event_type;
  190. struct tpml_digest_values digests;
  191. u32 event_size;
  192. u8 event[];
  193. } __packed;
  194. /**
  195. * TPM2 Structure Tags for command/response buffers.
  196. *
  197. * @TPM2_ST_NO_SESSIONS: the command does not need an authentication.
  198. * @TPM2_ST_SESSIONS: the command needs an authentication.
  199. */
  200. enum tpm2_structures {
  201. TPM2_ST_NO_SESSIONS = 0x8001,
  202. TPM2_ST_SESSIONS = 0x8002,
  203. };
  204. /**
  205. * TPM2 type of boolean.
  206. */
  207. enum tpm2_yes_no {
  208. TPMI_YES = 1,
  209. TPMI_NO = 0,
  210. };
  211. /**
  212. * TPM2 startup values.
  213. *
  214. * @TPM2_SU_CLEAR: reset the internal state.
  215. * @TPM2_SU_STATE: restore saved state (if any).
  216. */
  217. enum tpm2_startup_types {
  218. TPM2_SU_CLEAR = 0x0000,
  219. TPM2_SU_STATE = 0x0001,
  220. };
  221. /**
  222. * TPM2 permanent handles.
  223. *
  224. * @TPM2_RH_OWNER: refers to the 'owner' hierarchy.
  225. * @TPM2_RS_PW: indicates a password.
  226. * @TPM2_RH_LOCKOUT: refers to the 'lockout' hierarchy.
  227. * @TPM2_RH_ENDORSEMENT: refers to the 'endorsement' hierarchy.
  228. * @TPM2_RH_PLATFORM: refers to the 'platform' hierarchy.
  229. */
  230. enum tpm2_handles {
  231. TPM2_RH_OWNER = 0x40000001,
  232. TPM2_RS_PW = 0x40000009,
  233. TPM2_RH_LOCKOUT = 0x4000000A,
  234. TPM2_RH_ENDORSEMENT = 0x4000000B,
  235. TPM2_RH_PLATFORM = 0x4000000C,
  236. };
  237. /**
  238. * TPM2 command codes used at the beginning of a buffer, gives the command.
  239. *
  240. * @TPM2_CC_STARTUP: TPM2_Startup().
  241. * @TPM2_CC_SELF_TEST: TPM2_SelfTest().
  242. * @TPM2_CC_CLEAR: TPM2_Clear().
  243. * @TPM2_CC_CLEARCONTROL: TPM2_ClearControl().
  244. * @TPM2_CC_HIERCHANGEAUTH: TPM2_HierarchyChangeAuth().
  245. * @TPM2_CC_PCR_SETAUTHPOL: TPM2_PCR_SetAuthPolicy().
  246. * @TPM2_CC_DAM_RESET: TPM2_DictionaryAttackLockReset().
  247. * @TPM2_CC_DAM_PARAMETERS: TPM2_DictionaryAttackParameters().
  248. * @TPM2_CC_GET_CAPABILITY: TPM2_GetCapibility().
  249. * @TPM2_CC_GET_RANDOM: TPM2_GetRandom().
  250. * @TPM2_CC_PCR_READ: TPM2_PCR_Read().
  251. * @TPM2_CC_PCR_EXTEND: TPM2_PCR_Extend().
  252. * @TPM2_CC_PCR_SETAUTHVAL: TPM2_PCR_SetAuthValue().
  253. */
  254. enum tpm2_command_codes {
  255. TPM2_CC_STARTUP = 0x0144,
  256. TPM2_CC_SELF_TEST = 0x0143,
  257. TPM2_CC_HIER_CONTROL = 0x0121,
  258. TPM2_CC_CLEAR = 0x0126,
  259. TPM2_CC_CLEARCONTROL = 0x0127,
  260. TPM2_CC_HIERCHANGEAUTH = 0x0129,
  261. TPM2_CC_NV_DEFINE_SPACE = 0x012a,
  262. TPM2_CC_PCR_SETAUTHPOL = 0x012C,
  263. TPM2_CC_NV_WRITE = 0x0137,
  264. TPM2_CC_NV_WRITELOCK = 0x0138,
  265. TPM2_CC_DAM_RESET = 0x0139,
  266. TPM2_CC_DAM_PARAMETERS = 0x013A,
  267. TPM2_CC_NV_READ = 0x014E,
  268. TPM2_CC_GET_CAPABILITY = 0x017A,
  269. TPM2_CC_GET_RANDOM = 0x017B,
  270. TPM2_CC_PCR_READ = 0x017E,
  271. TPM2_CC_PCR_EXTEND = 0x0182,
  272. TPM2_CC_PCR_SETAUTHVAL = 0x0183,
  273. };
  274. /**
  275. * TPM2 return codes.
  276. */
  277. enum tpm2_return_codes {
  278. TPM2_RC_SUCCESS = 0x0000,
  279. TPM2_RC_BAD_TAG = 0x001E,
  280. TPM2_RC_FMT1 = 0x0080,
  281. TPM2_RC_HASH = TPM2_RC_FMT1 + 0x0003,
  282. TPM2_RC_VALUE = TPM2_RC_FMT1 + 0x0004,
  283. TPM2_RC_SIZE = TPM2_RC_FMT1 + 0x0015,
  284. TPM2_RC_BAD_AUTH = TPM2_RC_FMT1 + 0x0022,
  285. TPM2_RC_HANDLE = TPM2_RC_FMT1 + 0x000B,
  286. TPM2_RC_VER1 = 0x0100,
  287. TPM2_RC_INITIALIZE = TPM2_RC_VER1 + 0x0000,
  288. TPM2_RC_FAILURE = TPM2_RC_VER1 + 0x0001,
  289. TPM2_RC_DISABLED = TPM2_RC_VER1 + 0x0020,
  290. TPM2_RC_AUTH_MISSING = TPM2_RC_VER1 + 0x0025,
  291. TPM2_RC_COMMAND_CODE = TPM2_RC_VER1 + 0x0043,
  292. TPM2_RC_AUTHSIZE = TPM2_RC_VER1 + 0x0044,
  293. TPM2_RC_AUTH_CONTEXT = TPM2_RC_VER1 + 0x0045,
  294. TPM2_RC_NV_DEFINED = TPM2_RC_VER1 + 0x004c,
  295. TPM2_RC_NEEDS_TEST = TPM2_RC_VER1 + 0x0053,
  296. TPM2_RC_WARN = 0x0900,
  297. TPM2_RC_TESTING = TPM2_RC_WARN + 0x000A,
  298. TPM2_RC_REFERENCE_H0 = TPM2_RC_WARN + 0x0010,
  299. TPM2_RC_LOCKOUT = TPM2_RC_WARN + 0x0021,
  300. };
  301. /**
  302. * TPM2 algorithms.
  303. */
  304. enum tpm2_algorithms {
  305. TPM2_ALG_SHA1 = 0x04,
  306. TPM2_ALG_XOR = 0x0A,
  307. TPM2_ALG_SHA256 = 0x0B,
  308. TPM2_ALG_SHA384 = 0x0C,
  309. TPM2_ALG_SHA512 = 0x0D,
  310. TPM2_ALG_NULL = 0x10,
  311. TPM2_ALG_SM3_256 = 0x12,
  312. };
  313. /* NV index attributes */
  314. enum tpm_index_attrs {
  315. TPMA_NV_PPWRITE = 1UL << 0,
  316. TPMA_NV_OWNERWRITE = 1UL << 1,
  317. TPMA_NV_AUTHWRITE = 1UL << 2,
  318. TPMA_NV_POLICYWRITE = 1UL << 3,
  319. TPMA_NV_COUNTER = 1UL << 4,
  320. TPMA_NV_BITS = 1UL << 5,
  321. TPMA_NV_EXTEND = 1UL << 6,
  322. TPMA_NV_POLICY_DELETE = 1UL << 10,
  323. TPMA_NV_WRITELOCKED = 1UL << 11,
  324. TPMA_NV_WRITEALL = 1UL << 12,
  325. TPMA_NV_WRITEDEFINE = 1UL << 13,
  326. TPMA_NV_WRITE_STCLEAR = 1UL << 14,
  327. TPMA_NV_GLOBALLOCK = 1UL << 15,
  328. TPMA_NV_PPREAD = 1UL << 16,
  329. TPMA_NV_OWNERREAD = 1UL << 17,
  330. TPMA_NV_AUTHREAD = 1UL << 18,
  331. TPMA_NV_POLICYREAD = 1UL << 19,
  332. TPMA_NV_NO_DA = 1UL << 25,
  333. TPMA_NV_ORDERLY = 1UL << 26,
  334. TPMA_NV_CLEAR_STCLEAR = 1UL << 27,
  335. TPMA_NV_READLOCKED = 1UL << 28,
  336. TPMA_NV_WRITTEN = 1UL << 29,
  337. TPMA_NV_PLATFORMCREATE = 1UL << 30,
  338. TPMA_NV_READ_STCLEAR = 1UL << 31,
  339. TPMA_NV_MASK_READ = TPMA_NV_PPREAD | TPMA_NV_OWNERREAD |
  340. TPMA_NV_AUTHREAD | TPMA_NV_POLICYREAD,
  341. TPMA_NV_MASK_WRITE = TPMA_NV_PPWRITE | TPMA_NV_OWNERWRITE |
  342. TPMA_NV_AUTHWRITE | TPMA_NV_POLICYWRITE,
  343. };
  344. enum {
  345. TPM_ACCESS_VALID = 1 << 7,
  346. TPM_ACCESS_ACTIVE_LOCALITY = 1 << 5,
  347. TPM_ACCESS_REQUEST_PENDING = 1 << 2,
  348. TPM_ACCESS_REQUEST_USE = 1 << 1,
  349. TPM_ACCESS_ESTABLISHMENT = 1 << 0,
  350. };
  351. enum {
  352. TPM_STS_FAMILY_SHIFT = 26,
  353. TPM_STS_FAMILY_MASK = 0x3 << TPM_STS_FAMILY_SHIFT,
  354. TPM_STS_FAMILY_TPM2 = 1 << TPM_STS_FAMILY_SHIFT,
  355. TPM_STS_RESE_TESTABLISMENT_BIT = 1 << 25,
  356. TPM_STS_COMMAND_CANCEL = 1 << 24,
  357. TPM_STS_BURST_COUNT_SHIFT = 8,
  358. TPM_STS_BURST_COUNT_MASK = 0xffff << TPM_STS_BURST_COUNT_SHIFT,
  359. TPM_STS_VALID = 1 << 7,
  360. TPM_STS_COMMAND_READY = 1 << 6,
  361. TPM_STS_GO = 1 << 5,
  362. TPM_STS_DATA_AVAIL = 1 << 4,
  363. TPM_STS_DATA_EXPECT = 1 << 3,
  364. TPM_STS_SELF_TEST_DONE = 1 << 2,
  365. TPM_STS_RESPONSE_RETRY = 1 << 1,
  366. TPM_STS_READ_ZERO = 0x23
  367. };
  368. enum {
  369. TPM_CMD_COUNT_OFFSET = 2,
  370. TPM_CMD_ORDINAL_OFFSET = 6,
  371. TPM_MAX_BUF_SIZE = 1260,
  372. };
  373. enum {
  374. /* Secure storage for firmware settings */
  375. TPM_HT_PCR = 0,
  376. TPM_HT_NV_INDEX,
  377. TPM_HT_HMAC_SESSION,
  378. TPM_HT_POLICY_SESSION,
  379. HR_SHIFT = 24,
  380. HR_PCR = TPM_HT_PCR << HR_SHIFT,
  381. HR_HMAC_SESSION = TPM_HT_HMAC_SESSION << HR_SHIFT,
  382. HR_POLICY_SESSION = TPM_HT_POLICY_SESSION << HR_SHIFT,
  383. HR_NV_INDEX = TPM_HT_NV_INDEX << HR_SHIFT,
  384. };
  385. /**
  386. * Issue a TPM2_Startup command.
  387. *
  388. * @dev TPM device
  389. * @mode TPM startup mode
  390. *
  391. * Return: code of the operation
  392. */
  393. u32 tpm2_startup(struct udevice *dev, enum tpm2_startup_types mode);
  394. /**
  395. * Issue a TPM2_SelfTest command.
  396. *
  397. * @dev TPM device
  398. * @full_test Asking to perform all tests or only the untested ones
  399. *
  400. * Return: code of the operation
  401. */
  402. u32 tpm2_self_test(struct udevice *dev, enum tpm2_yes_no full_test);
  403. /**
  404. * Issue a TPM2_Clear command.
  405. *
  406. * @dev TPM device
  407. * @handle Handle
  408. * @pw Password
  409. * @pw_sz Length of the password
  410. *
  411. * Return: code of the operation
  412. */
  413. u32 tpm2_clear(struct udevice *dev, u32 handle, const char *pw,
  414. const ssize_t pw_sz);
  415. /**
  416. * Issue a TPM_NV_DefineSpace command
  417. *
  418. * This allows a space to be defined with given attributes and policy
  419. *
  420. * @dev TPM device
  421. * @space_index index of the area
  422. * @space_size size of area in bytes
  423. * @nv_attributes TPM_NV_ATTRIBUTES of the area
  424. * @nv_policy policy to use
  425. * @nv_policy_size size of the policy
  426. * Return: return code of the operation
  427. */
  428. u32 tpm2_nv_define_space(struct udevice *dev, u32 space_index,
  429. size_t space_size, u32 nv_attributes,
  430. const u8 *nv_policy, size_t nv_policy_size);
  431. /**
  432. * Issue a TPM2_PCR_Extend command.
  433. *
  434. * @dev TPM device
  435. * @index Index of the PCR
  436. * @algorithm Algorithm used, defined in 'enum tpm2_algorithms'
  437. * @digest Value representing the event to be recorded
  438. * @digest_len len of the hash
  439. *
  440. * Return: code of the operation
  441. */
  442. u32 tpm2_pcr_extend(struct udevice *dev, u32 index, u32 algorithm,
  443. const u8 *digest, u32 digest_len);
  444. /**
  445. * Read data from the secure storage
  446. *
  447. * @dev TPM device
  448. * @index Index of data to read
  449. * @data Place to put data
  450. * @count Number of bytes of data
  451. * Return: code of the operation
  452. */
  453. u32 tpm2_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count);
  454. /**
  455. * Write data to the secure storage
  456. *
  457. * @dev TPM device
  458. * @index Index of data to write
  459. * @data Data to write
  460. * @count Number of bytes of data
  461. * Return: code of the operation
  462. */
  463. u32 tpm2_nv_write_value(struct udevice *dev, u32 index, const void *data,
  464. u32 count);
  465. /**
  466. * Issue a TPM2_PCR_Read command.
  467. *
  468. * @dev TPM device
  469. * @idx Index of the PCR
  470. * @idx_min_sz Minimum size in bytes of the pcrSelect array
  471. * @algorithm Algorithm used, defined in 'enum tpm2_algorithms'
  472. * @data Output buffer for contents of the named PCR
  473. * @digest_len len of the data
  474. * @updates Optional out parameter: number of updates for this PCR
  475. *
  476. * Return: code of the operation
  477. */
  478. u32 tpm2_pcr_read(struct udevice *dev, u32 idx, unsigned int idx_min_sz,
  479. u16 algorithm, void *data, u32 digest_len,
  480. unsigned int *updates);
  481. /**
  482. * Issue a TPM2_GetCapability command. This implementation is limited
  483. * to query property index that is 4-byte wide.
  484. *
  485. * @dev TPM device
  486. * @capability Partition of capabilities
  487. * @property Further definition of capability, limited to be 4 bytes wide
  488. * @buf Output buffer for capability information
  489. * @prop_count Size of output buffer
  490. *
  491. * Return: code of the operation
  492. */
  493. u32 tpm2_get_capability(struct udevice *dev, u32 capability, u32 property,
  494. void *buf, size_t prop_count);
  495. /**
  496. * Issue a TPM2_DictionaryAttackLockReset command.
  497. *
  498. * @dev TPM device
  499. * @pw Password
  500. * @pw_sz Length of the password
  501. *
  502. * Return: code of the operation
  503. */
  504. u32 tpm2_dam_reset(struct udevice *dev, const char *pw, const ssize_t pw_sz);
  505. /**
  506. * Issue a TPM2_DictionaryAttackParameters command.
  507. *
  508. * @dev TPM device
  509. * @pw Password
  510. * @pw_sz Length of the password
  511. * @max_tries Count of authorizations before lockout
  512. * @recovery_time Time before decrementation of the failure count
  513. * @lockout_recovery Time to wait after a lockout
  514. *
  515. * Return: code of the operation
  516. */
  517. u32 tpm2_dam_parameters(struct udevice *dev, const char *pw,
  518. const ssize_t pw_sz, unsigned int max_tries,
  519. unsigned int recovery_time,
  520. unsigned int lockout_recovery);
  521. /**
  522. * Issue a TPM2_HierarchyChangeAuth command.
  523. *
  524. * @dev TPM device
  525. * @handle Handle
  526. * @newpw New password
  527. * @newpw_sz Length of the new password
  528. * @oldpw Old password
  529. * @oldpw_sz Length of the old password
  530. *
  531. * Return: code of the operation
  532. */
  533. int tpm2_change_auth(struct udevice *dev, u32 handle, const char *newpw,
  534. const ssize_t newpw_sz, const char *oldpw,
  535. const ssize_t oldpw_sz);
  536. /**
  537. * Issue a TPM_PCR_SetAuthPolicy command.
  538. *
  539. * @dev TPM device
  540. * @pw Platform password
  541. * @pw_sz Length of the password
  542. * @index Index of the PCR
  543. * @digest New key to access the PCR
  544. *
  545. * Return: code of the operation
  546. */
  547. u32 tpm2_pcr_setauthpolicy(struct udevice *dev, const char *pw,
  548. const ssize_t pw_sz, u32 index, const char *key);
  549. /**
  550. * Issue a TPM_PCR_SetAuthValue command.
  551. *
  552. * @dev TPM device
  553. * @pw Platform password
  554. * @pw_sz Length of the password
  555. * @index Index of the PCR
  556. * @digest New key to access the PCR
  557. * @key_sz Length of the new key
  558. *
  559. * Return: code of the operation
  560. */
  561. u32 tpm2_pcr_setauthvalue(struct udevice *dev, const char *pw,
  562. const ssize_t pw_sz, u32 index, const char *key,
  563. const ssize_t key_sz);
  564. /**
  565. * Issue a TPM2_GetRandom command.
  566. *
  567. * @dev TPM device
  568. * @param data output buffer for the random bytes
  569. * @param count size of output buffer
  570. *
  571. * Return: return code of the operation
  572. */
  573. u32 tpm2_get_random(struct udevice *dev, void *data, u32 count);
  574. /**
  575. * Lock data in the TPM
  576. *
  577. * Once locked the data cannot be written until after a reboot
  578. *
  579. * @dev TPM device
  580. * @index Index of data to lock
  581. * Return: code of the operation
  582. */
  583. u32 tpm2_write_lock(struct udevice *dev, u32 index);
  584. /**
  585. * Disable access to any platform data
  586. *
  587. * This can be called to close off access to the firmware data in the data,
  588. * before calling the kernel.
  589. *
  590. * @dev TPM device
  591. * Return: code of the operation
  592. */
  593. u32 tpm2_disable_platform_hierarchy(struct udevice *dev);
  594. /**
  595. * submit user specified data to the TPM and get response
  596. *
  597. * @dev TPM device
  598. * @sendbuf: Buffer of the data to send
  599. * @recvbuf: Buffer to save the response to
  600. * @recv_size: Pointer to the size of the response buffer
  601. *
  602. * Return: code of the operation
  603. */
  604. u32 tpm2_submit_command(struct udevice *dev, const u8 *sendbuf,
  605. u8 *recvbuf, size_t *recv_size);
  606. /**
  607. * tpm_cr50_report_state() - Report the Cr50 internal state
  608. *
  609. * @dev: TPM device
  610. * @vendor_cmd: Vendor command number to send
  611. * @vendor_subcmd: Vendor sub-command number to send
  612. * @recvbuf: Buffer to save the response to
  613. * @recv_size: Pointer to the size of the response buffer
  614. * Return: result of the operation
  615. */
  616. u32 tpm2_report_state(struct udevice *dev, uint vendor_cmd, uint vendor_subcmd,
  617. u8 *recvbuf, size_t *recv_size);
  618. /**
  619. * tpm2_enable_nvcommits() - Tell TPM to commit NV data immediately
  620. *
  621. * For Chromium OS verified boot, we may reboot or reset at different times,
  622. * possibly leaving non-volatile data unwritten by the TPM.
  623. *
  624. * This vendor command is used to indicate that non-volatile data should be
  625. * written to its store immediately.
  626. *
  627. * @dev TPM device
  628. * @vendor_cmd: Vendor command number to send
  629. * @vendor_subcmd: Vendor sub-command number to send
  630. * Return: result of the operation
  631. */
  632. u32 tpm2_enable_nvcommits(struct udevice *dev, uint vendor_cmd,
  633. uint vendor_subcmd);
  634. /**
  635. * tpm2_auto_start() - start up the TPM and perform selftests.
  636. * If a testable function has not been tested and is
  637. * requested the TPM2 will return TPM_RC_NEEDS_TEST.
  638. *
  639. * @param dev TPM device
  640. * Return: TPM2_RC_TESTING, if TPM2 self-test is in progress.
  641. * TPM2_RC_SUCCESS, if testing of all functions is complete without
  642. * functional failures.
  643. * TPM2_RC_FAILURE, if any test failed.
  644. * TPM2_RC_INITIALIZE, if the TPM has not gone through the Startup
  645. * sequence
  646. */
  647. u32 tpm2_auto_start(struct udevice *dev);
  648. #endif /* __TPM_V2_H */