Skip to content

Commit bb61ea1

Browse files
authored
Merge pull request #9917 from kfnta/attest_doxy
Add attestation doxygen
2 parents 26920fe + 064dc7d commit bb61ea1

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

components/TARGET_PSA/services/attestation/attestation.h

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
*
66
*/
77

8+
/** @addtogroup PSA-Attestation
9+
* @{
10+
*/
11+
12+
813
#ifndef __ATTESTATION_H__
914
#define __ATTESTATION_H__
1015

@@ -15,15 +20,15 @@
1520
extern "C" {
1621
#endif
1722

18-
/*!
23+
/**
1924
* \brief Type of memory access
2025
*/
2126
enum attest_memory_access_t {
2227
TFM_ATTEST_ACCESS_RO = 1,
2328
TFM_ATTEST_ACCESS_RW = 2,
2429
};
2530

26-
/*!
31+
/**
2732
* \brief Copy the boot data (coming from boot loader) from shared memory area
2833
* to service memory area
2934
*
@@ -36,7 +41,7 @@ enum attest_memory_access_t {
3641
enum psa_attest_err_t
3742
attest_get_boot_data(uint8_t major_type, void *ptr, uint32_t len);
3843

39-
/*!
44+
/**
4045
* \brief Get the ID of the caller thread.
4146
*
4247
* \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);
4651
enum psa_attest_err_t
4752
attest_get_caller_client_id(int32_t *caller_id);
4853

49-
/*!
54+
/**
5055
* \brief Verify memory access rights
5156
*
5257
* \param[in] addr Pointer to the base of the address range to check
@@ -61,7 +66,7 @@ attest_check_memory_access(void *addr,
6166
uint32_t size,
6267
enum attest_memory_access_t access);
6368

64-
/*!
69+
/**
6570
* \brief Initialise the initial attestation service during the TF-M boot up
6671
* process.
6772
*
@@ -70,7 +75,7 @@ attest_check_memory_access(void *addr,
7075
*/
7176
enum psa_attest_err_t attest_init(void);
7277

73-
/*!
78+
/**
7479
* \brief Get initial attestation token
7580
*
7681
* \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,
105110
}
106111
#endif
107112

113+
/** @}*/ // PSA-Attestation
114+
108115
#endif /* __ATTESTATION_H__ */

components/TARGET_PSA/services/attestation/psa_attest_inject_key.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@
1616
* limitations under the License.
1717
*/
1818

19+
/** @addtogroup PSA-Attestation
20+
* @{
21+
*/
22+
1923
#ifndef __PSA_INJECT_KEY_H__
2024
#define __PSA_INJECT_KEY_H__
2125

@@ -78,4 +82,6 @@ psa_attestation_inject_key(const uint8_t *key_data,
7882
}
7983
#endif
8084

85+
/** @}*/ // PSA-Attestation
86+
8187
#endif /* __PSA_INJECT_KEY_H__ */

0 commit comments

Comments
 (0)