X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Ftpm-v1.h;h=33d53fb695ee203f14f76168d5e7a3dcdc1f92c9;hb=46b5c8ed017958fc387ab86c71ae6c90abb6793c;hp=59ad4aecf42cfdaa37c8c963c74ddd935624cecf;hpb=c2279d784e35fa25ee3a9fa28a74a1ba545f8c1e;p=platform%2Fkernel%2Fu-boot.git diff --git a/include/tpm-v1.h b/include/tpm-v1.h index 59ad4ae..33d53fb 100644 --- a/include/tpm-v1.h +++ b/include/tpm-v1.h @@ -10,6 +10,8 @@ #include #include +struct udevice; + /* Useful constants */ enum { TPM_REQUEST_HEADER_LENGTH = 10, @@ -285,25 +287,25 @@ struct __packed tpm_nv_data_public { * * @param dev TPM device * @param mode TPM startup mode - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_startup(struct udevice *dev, enum tpm_startup_type mode); +u32 tpm1_startup(struct udevice *dev, enum tpm_startup_type mode); /** * Issue a TPM_SelfTestFull command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_self_test_full(struct udevice *dev); +u32 tpm1_self_test_full(struct udevice *dev); /** * Issue a TPM_ContinueSelfTest command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_continue_self_test(struct udevice *dev); +u32 tpm1_continue_self_test(struct udevice *dev); /** * Issue a TPM_NV_DefineSpace command. The implementation is limited @@ -314,9 +316,9 @@ u32 tpm_continue_self_test(struct udevice *dev); * @param index index of the area * @param perm TPM_NV_ATTRIBUTES of the area * @param size size of the area - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); +u32 tpm1_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); /** * Issue a TPM_NV_ReadValue command. This implementation is limited @@ -327,9 +329,9 @@ u32 tpm_nv_define_space(struct udevice *dev, u32 index, u32 perm, u32 size); * @param index index of the area * @param data output buffer of the area contents * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); +u32 tpm1_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); /** * Issue a TPM_NV_WriteValue command. This implementation is limited @@ -340,10 +342,10 @@ u32 tpm_nv_read_value(struct udevice *dev, u32 index, void *data, u32 count); * @param index index of the area * @param data input buffer to be wrote to the area * @param length length of data bytes of input buffer - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data, - u32 length); +u32 tpm1_nv_write_value(struct udevice *dev, u32 index, const void *data, + u32 length); /** * Issue a TPM_Extend command. @@ -354,10 +356,10 @@ u32 tpm_nv_write_value(struct udevice *dev, u32 index, const void *data, * recorded * @param out_digest 160-bit PCR value after execution of the * command - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_extend(struct udevice *dev, u32 index, const void *in_digest, - void *out_digest); +u32 tpm1_extend(struct udevice *dev, u32 index, const void *in_digest, + void *out_digest); /** * Issue a TPM_PCRRead command. @@ -366,9 +368,9 @@ u32 tpm_extend(struct udevice *dev, u32 index, const void *in_digest, * @param index index of the PCR * @param data output buffer for contents of the named PCR * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); +u32 tpm1_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); /** * Issue a TSC_PhysicalPresence command. TPM physical presence flag @@ -376,9 +378,9 @@ u32 tpm_pcr_read(struct udevice *dev, u32 index, void *data, size_t count); * * @param dev TPM device * @param presence TPM physical presence flag - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence); +u32 tpm1_tsc_physical_presence(struct udevice *dev, u16 presence); /** * Issue a TPM_ReadPubek command. @@ -386,42 +388,42 @@ u32 tpm_tsc_physical_presence(struct udevice *dev, u16 presence); * @param dev TPM device * @param data output buffer for the public endorsement key * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_read_pubek(struct udevice *dev, void *data, size_t count); +u32 tpm1_read_pubek(struct udevice *dev, void *data, size_t count); /** * Issue a TPM_ForceClear command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_force_clear(struct udevice *dev); +u32 tpm1_force_clear(struct udevice *dev); /** * Issue a TPM_PhysicalEnable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_physical_enable(struct udevice *dev); +u32 tpm1_physical_enable(struct udevice *dev); /** * Issue a TPM_PhysicalDisable command. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_physical_disable(struct udevice *dev); +u32 tpm1_physical_disable(struct udevice *dev); /** * Issue a TPM_PhysicalSetDeactivated command. * * @param dev TPM device * @param state boolean state of the deactivated flag - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state); +u32 tpm1_physical_set_deactivated(struct udevice *dev, u8 state); /** * Issue a TPM_GetCapability command. This implementation is limited @@ -433,19 +435,19 @@ u32 tpm_physical_set_deactivated(struct udevice *dev, u8 state); * limited to be 4-byte wide * @param cap output buffer for capability information * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, - void *cap, size_t count); +u32 tpm1_get_capability(struct udevice *dev, u32 cap_area, u32 sub_cap, + void *cap, size_t count); /** * Issue a TPM_FlushSpecific command for a AUTH resource. * * @param dev TPM device * @param auth_handle handle of the auth session - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle); +u32 tpm1_terminate_auth_session(struct udevice *dev, u32 auth_handle); /** * Issue a TPM_OIAP command to setup an object independent authorization @@ -456,17 +458,17 @@ u32 tpm_terminate_auth_session(struct udevice *dev, u32 auth_handle); * * @param dev TPM device * @param auth_handle pointer to the (new) auth handle or NULL. - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_oiap(struct udevice *dev, u32 *auth_handle); +u32 tpm1_oiap(struct udevice *dev, u32 *auth_handle); /** * Ends an active OIAP session. * * @param dev TPM device - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_end_oiap(struct udevice *dev); +u32 tpm1_end_oiap(struct udevice *dev); /** * Issue a TPM_LoadKey2 (Auth1) command using an OIAP session for authenticating @@ -478,11 +480,11 @@ u32 tpm_end_oiap(struct udevice *dev); * @param key_length size of the key structure * @param parent_key_usage_auth usage auth for the parent key * @param key_handle pointer to the key handle - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, - size_t key_length, const void *parent_key_usage_auth, - u32 *key_handle); +u32 tpm1_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, + size_t key_length, const void *parent_key_usage_auth, + u32 *key_handle); /** * Issue a TPM_GetPubKey (Auth1) command using an OIAP session for @@ -496,30 +498,30 @@ u32 tpm_load_key2_oiap(struct udevice *dev, u32 parent_handle, const void *key, * @param pubkey_len pointer to the pub key buffer len. On entry: the size of * the provided pubkey buffer. On successful exit: the size * of the stored TPM_PUBKEY structure (iff pubkey != NULL). - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_get_pub_key_oiap(struct udevice *dev, u32 key_handle, - const void *usage_auth, void *pubkey, - size_t *pubkey_len); +u32 tpm1_get_pub_key_oiap(struct udevice *dev, u32 key_handle, + const void *usage_auth, void *pubkey, + size_t *pubkey_len); /** * Get the TPM permanent flags value * * @param dev TPM device * @param pflags Place to put permanent flags - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_get_permanent_flags(struct udevice *dev, - struct tpm_permanent_flags *pflags); +u32 tpm1_get_permanent_flags(struct udevice *dev, + struct tpm_permanent_flags *pflags); /** * Get the TPM permissions * * @param dev TPM device * @param perm Returns permissions value - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm); +u32 tpm1_get_permissions(struct udevice *dev, u32 index, u32 *perm); /** * Flush a resource with a given handle and type from the TPM @@ -527,9 +529,9 @@ u32 tpm_get_permissions(struct udevice *dev, u32 index, u32 *perm); * @param dev TPM device * @param key_handle handle of the resource * @param resource_type type of the resource - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); +u32 tpm1_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); #ifdef CONFIG_TPM_LOAD_KEY_BY_SHA1 /** @@ -539,10 +541,10 @@ u32 tpm_flush_specific(struct udevice *dev, u32 key_handle, u32 resource_type); * @param auth Usage auth of the key to search for * @param pubkey_digest SHA1 hash of the pub key structure of the key * @param[out] handle The handle of the key (Non-null iff found) - * @return 0 if key was found in TPM; != 0 if not. + * Return: 0 if key was found in TPM; != 0 if not. */ -u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20], - const u8 pubkey_digest[20], u32 *handle); +u32 tpm1_find_key_sha1(struct udevice *dev, const u8 auth[20], + const u8 pubkey_digest[20], u32 *handle); #endif /* CONFIG_TPM_LOAD_KEY_BY_SHA1 */ /** @@ -553,31 +555,31 @@ u32 tpm_find_key_sha1(struct udevice *dev, const u8 auth[20], * @param dev TPM device * @param data output buffer for the random bytes * @param count size of output buffer - * @return return code of the operation + * Return: return code of the operation */ -u32 tpm_get_random(struct udevice *dev, void *data, u32 count); +u32 tpm1_get_random(struct udevice *dev, void *data, u32 count); /** * tpm_finalise_physical_presence() - Finalise physical presence * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ -u32 tpm_finalise_physical_presence(struct udevice *dev); +u32 tpm1_finalise_physical_presence(struct udevice *dev); /** - * tpm_nv_set_locked() - lock the non-volatile space + * tpm_nv_enable_locking() - lock the non-volatile space * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ -u32 tpm_nv_set_locked(struct udevice *dev); +u32 tpm1_nv_set_locked(struct udevice *dev); /** * tpm_set_global_lock() - set the global lock * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ u32 tpm_set_global_lock(struct udevice *dev); @@ -585,8 +587,8 @@ u32 tpm_set_global_lock(struct udevice *dev); * tpm_resume() - start up the TPM from resume (after suspend) * * @param dev TPM device - * @return return code of the operation (0 = success) + * Return: return code of the operation (0 = success) */ -u32 tpm_resume(struct udevice *dev); +u32 tpm1_resume(struct udevice *dev); #endif /* __TPM_V1_H */