Skip to content

Add attestation doxygen #9917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2019
Merged

Add attestation doxygen #9917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions components/TARGET_PSA/services/attestation/attestation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
*
*/

/** @addtogroup PSA-Attestation
* @{
*/


#ifndef __ATTESTATION_H__
#define __ATTESTATION_H__

Expand All @@ -15,15 +20,15 @@
extern "C" {
#endif

/*!
/**
* \brief Type of memory access
*/
enum attest_memory_access_t {
TFM_ATTEST_ACCESS_RO = 1,
TFM_ATTEST_ACCESS_RW = 2,
};

/*!
/**
* \brief Copy the boot data (coming from boot loader) from shared memory area
* to service memory area
*
Expand All @@ -36,7 +41,7 @@ enum attest_memory_access_t {
enum psa_attest_err_t
attest_get_boot_data(uint8_t major_type, void *ptr, uint32_t len);

/*!
/**
* \brief Get the ID of the caller thread.
*
* \param[out] caller_id Pointer where to store caller ID
Expand All @@ -46,7 +51,7 @@ attest_get_boot_data(uint8_t major_type, void *ptr, uint32_t len);
enum psa_attest_err_t
attest_get_caller_client_id(int32_t *caller_id);

/*!
/**
* \brief Verify memory access rights
*
* \param[in] addr Pointer to the base of the address range to check
Expand All @@ -61,7 +66,7 @@ attest_check_memory_access(void *addr,
uint32_t size,
enum attest_memory_access_t access);

/*!
/**
* \brief Initialise the initial attestation service during the TF-M boot up
* process.
*
Expand All @@ -70,7 +75,7 @@ attest_check_memory_access(void *addr,
*/
enum psa_attest_err_t attest_init(void);

/*!
/**
* \brief Get initial attestation token
*
* \param[in] in_vec Pointer to in_vec array, which contains input data
Expand Down Expand Up @@ -105,4 +110,6 @@ initial_attest_get_token_size(const psa_invec *in_vec, uint32_t num_invec,
}
#endif

/** @}*/ // PSA-Attestation

#endif /* __ATTESTATION_H__ */
6 changes: 6 additions & 0 deletions components/TARGET_PSA/services/attestation/psa_attest_inject_key.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
* limitations under the License.
*/

/** @addtogroup PSA-Attestation
* @{
*/

#ifndef __PSA_INJECT_KEY_H__
#define __PSA_INJECT_KEY_H__

Expand Down Expand Up @@ -78,4 +82,6 @@ psa_attestation_inject_key(const uint8_t *key_data,
}
#endif

/** @}*/ // PSA-Attestation

#endif /* __PSA_INJECT_KEY_H__ */