ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #9917 from kfnta/attest_doxy 

Add attestation doxygen
pull/10043/head
Martin Kojtal 2019-03-06 09:14:26 +01:00 committed by GitHub
parent 26920fe0cc 064dc7d154
commit bb61ea1433
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
components/TARGET_PSA/services/attestation/attestation.h
View File

@ -5,6 +5,11 @@
* *
*/ */
/** @addtogroup PSA-Attestation
* @{
*/
#ifndef __ATTESTATION_H__ #ifndef __ATTESTATION_H__
#define __ATTESTATION_H__ #define __ATTESTATION_H__
@ -15,7 +20,7 @@
extern "C" { extern "C" {
#endif #endif
/*! /**
* \brief Type of memory access * \brief Type of memory access
*/ */
enum attest_memory_access_t { enum attest_memory_access_t {
@ -23,7 +28,7 @@ enum attest_memory_access_t {
TFM_ATTEST_ACCESS_RW = 2, TFM_ATTEST_ACCESS_RW = 2,
}; };
/*! /**
* \brief Copy the boot data (coming from boot loader) from shared memory area * \brief Copy the boot data (coming from boot loader) from shared memory area
* to service memory area * to service memory area
* *
@ -36,7 +41,7 @@ enum attest_memory_access_t {
enum psa_attest_err_t enum psa_attest_err_t
attest_get_boot_data(uint8_t major_type, void *ptr, uint32_t len); attest_get_boot_data(uint8_t major_type, void *ptr, uint32_t len);
/*! /**
* \brief Get the ID of the caller thread. * \brief Get the ID of the caller thread.
* *
* \param[out] caller_id Pointer where to store caller ID * \param[out] caller_id Pointer where to store caller ID
@ -46,7 +51,7 @@ attest_get_boot_data(uint8_t major_type, void *ptr, uint32_t len);
enum psa_attest_err_t enum psa_attest_err_t
attest_get_caller_client_id(int32_t *caller_id); attest_get_caller_client_id(int32_t *caller_id);
/*! /**
* \brief Verify memory access rights * \brief Verify memory access rights
* *
* \param[in] addr Pointer to the base of the address range to check * \param[in] addr Pointer to the base of the address range to check
@ -61,7 +66,7 @@ attest_check_memory_access(void *addr,
uint32_t size, uint32_t size,
enum attest_memory_access_t access); enum attest_memory_access_t access);
/*! /**
* \brief Initialise the initial attestation service during the TF-M boot up * \brief Initialise the initial attestation service during the TF-M boot up
* process. * process.
* *
@ -70,7 +75,7 @@ attest_check_memory_access(void *addr,
*/ */
enum psa_attest_err_t attest_init(void); enum psa_attest_err_t attest_init(void);
/*! /**
* \brief Get initial attestation token * \brief Get initial attestation token
* *
* \param[in] in_vec Pointer to in_vec array, which contains input data * \param[in] in_vec Pointer to in_vec array, which contains input data
@ -105,4 +110,6 @@ initial_attest_get_token_size(const psa_invec *in_vec, uint32_t num_invec,
} }
#endif #endif
/** @}*/ // PSA-Attestation
#endif /* __ATTESTATION_H__ */ #endif /* __ATTESTATION_H__ */

6
components/TARGET_PSA/services/attestation/psa_attest_inject_key.h
View File

@ -16,6 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup PSA-Attestation
* @{
*/
#ifndef __PSA_INJECT_KEY_H__ #ifndef __PSA_INJECT_KEY_H__
#define __PSA_INJECT_KEY_H__ #define __PSA_INJECT_KEY_H__
@ -78,4 +82,6 @@ psa_attestation_inject_key(const uint8_t *key_data,
} }
#endif #endif
/** @}*/ // PSA-Attestation
#endif /* __PSA_INJECT_KEY_H__ */ #endif /* __PSA_INJECT_KEY_H__ */