Skip to content

Commit 0ba9623

Browse files
Oren Cohenadbridge
authored andcommitted
Fix PSA-SPM Documentation
1 parent a107404 commit 0ba9623

File tree

6 files changed

+10
-154
lines changed

6 files changed

+10
-154
lines changed

components/TARGET_PSA/spm/doc/INTRO.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

components/TARGET_PSA/spm/doc/README.md

Lines changed: 0 additions & 23 deletions
This file was deleted.
Binary file not shown.

doxyfile_options

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2099,6 +2099,8 @@ PREDEFINED = DOXYGEN_ONLY \
20992099
DEVICE_SPISLAVE \
21002100
DEVICE_QSPI \
21012101
DEVICE_STORAGE \
2102+
COMPONENT_SPE \
2103+
COMPONENT_SPM_MAILBOX \
21022104
"MBED_DEPRECATED_SINCE(d, m)=" \
21032105
"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=" \
21042106
"MBED_DEPRECATED(s)="

doxygen_options.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"SEARCH_INCLUDES": "YES",
77
"INCLUDE_PATH": "",
88
"INCLUDE_FILE_PATTERNS": "",
9-
"PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_CRC DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_ITM DEVICE_LPTICKER DEVICE_MPU DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_QSPI DEVICE_STORAGE \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\" \"MBED_DEPRECATED(s)=\"",
9+
"PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_CRC DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_ITM DEVICE_LPTICKER DEVICE_MPU DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_QSPI DEVICE_STORAGE COMPONENT_SPE COMPONENT_SPM_MAILBOX \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\" \"MBED_DEPRECATED(s)=\"",
1010
"EXPAND_AS_DEFINED": "",
1111
"SKIP_FUNCTION_MACROS": "NO",
1212
"STRIP_CODE_COMMENTS": "NO",

hal/spm_api.h

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
/** \addtogroup hal */
3+
/** @{*/
14
/* Copyright (c) 2017-2018 ARM Limited
25
*
36
* SPDX-License-Identifier: Apache-2.0
@@ -18,14 +21,6 @@
1821
#ifndef __SPM_API_H__
1922
#define __SPM_API_H__
2023

21-
22-
/** @addtogroup SPM
23-
* The Secure Partition Manager (SPM) is responsible for isolating software in
24-
* partitions, managing the execution of software within partitions and
25-
* providing IPC between partitions.
26-
* @{
27-
*/
28-
2924
#include <stdint.h>
3025
#include <stddef.h>
3126

@@ -34,8 +29,7 @@ extern "C" {
3429
#endif
3530

3631

37-
/** @addtogroup HAL-SPE
38-
* The HAL functions for SPE.
32+
/** @defgroup SPM HAL
3933
* @{
4034
*/
4135

@@ -92,12 +86,12 @@ void spm_hal_mailbox_notify(void);
9286

9387
#endif // defined(COMPONENT_SPM_MAILBOX)
9488

95-
/** @}*/ // end of HAL-SPE group
89+
/** @}*/
9690

9791
#ifdef __cplusplus
9892
}
9993
#endif
10094

101-
/** @}*/ // end of SPM group
102-
10395
#endif // __SPM_API_H__
96+
97+
/** @}*/

0 commit comments

Comments
 (0)