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

Edit spm_api.h 

Edit file, mostly for minor grammar and style changes.
pull/8744/head
Amanda Butler 2018-11-26 17:44:57 -06:00 committed by Oren Cohen
parent ba6fdcf494
commit 34bcf6b1f0
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
hal/spm_api.h
View File

@ -20,8 +20,8 @@
/** @addtogroup SPM /** @addtogroup SPM
* The SPM (Secure Partition Manager) is responsible for isolating software in * The Secure Partition Manager (SPM) is responsible for isolating software in
* partitions, managing the execution of software within partitions, and * partitions, managing the execution of software within partitions and
* providing IPC between partitions. * providing IPC between partitions.
* @{ * @{
*/ */
@ -47,8 +47,8 @@ extern "C" {
/** /**
* Start running the NSPE. * Start running the NSPE.
* *
* SPE (Secure Processing Environment) expected to boot first. Once all * Secure Processing Environment (SPE) expected to boot first. Once all
* the initializations are done, NSPE (Non-Secure Processing Environment) * the initializations are done, Nonsecure Processing Environment (NSPE)
* should be booted. * should be booted.
* *
* @note The function must be implemented by target specific code. * @note The function must be implemented by target specific code.
@ -60,7 +60,7 @@ void spm_hal_start_nspe(void);
* Configure memory protection mechanism. * Configure memory protection mechanism.
* *
* Apply memory protection schemes to ensure secure memory can only be accessed * Apply memory protection schemes to ensure secure memory can only be accessed
* from secure-state * from secure-state.
* *
* @note The function must be implemented by target specific code. * @note The function must be implemented by target specific code.
* *
@ -75,7 +75,7 @@ void spm_hal_memory_protection_init(void);
/** /**
* @brief Wakeup mailbox dispatcher thread * @brief Wakeup mailbox dispatcher thread
* *
* This function is implemented by ARM and expected to be called by target * Arm implements this function, which is expected to be called by target-
* specific Inter-Processor-Communication logic on mailbox interrupt handler. * specific Inter-Processor-Communication logic on mailbox interrupt handler.
* *
*/ */
@ -84,9 +84,9 @@ void spm_mailbox_irq_callback(void);
/** /**
* @brief Notify the peer processor about a general event occurrence. * @brief Notify the peer processor about a general event occurrence.
* *
* Wakeup the peer processor waiting on the mailbox driver event. * Wake up the peer processor waiting on the mailbox driver event.
* *
* @note The functions below should be implemented by target specific code. * @note Implement the functions below with target-specific code.
*/ */
void spm_hal_mailbox_notify(void); void spm_hal_mailbox_notify(void);