Skip to content

Add enable_interrupts() and disable_interrupts() #2276

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 2 commits into from
Feb 17, 2025
Merged

Add enable_interrupts() and disable_interrupts() #2276

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87fa313
add enable/disable_interrupts to hardware_sync
kilograham Feb 14, 2025
4bf9881
oops
kilograham Feb 15, 2025
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
41 changes: 36 additions & 5 deletions src/rp2_common/hardware_sync/include/hardware/sync.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,41 @@ __force_inline static void __mem_fence_release(void) {
//#endif
}

/*! \brief Save and disable interrupts
/*! \brief Explicitly disable interrupts on the calling core
* \ingroup hardware_sync
*/
__force_inline static uint32_t disable_interrupts(void) {
#ifdef __riscv
__compiler_memory_barrier();
riscv_clear_csr(mstatus, 8);
__compiler_memory_barrier();
#else
pico_default_asm_volatile ( "cpsid i" : : : "memory");
#endif
}

/*! \brief Explicitly enable interrupts on the calling core
* \ingroup hardware_sync
*/
__force_inline static uint32_t enable_interrupts(void) {
#ifdef __riscv
__compiler_memory_barrier();
riscv_set_csr(mstatus, 8);
__compiler_memory_barrier();
#else
pico_default_asm_volatile ( "cpsie i" : : : "memory");
#endif
}

/*! \brief Disable interrupts on the calling core, returning the previous interrupt state
* \ingroup hardware_sync
*
* This method is commonly paired with \ref restore_interrupts_from_disabled() to temporarily
* disable interrupts around a piece of code, without needing to care whether interrupts
* were previously enabled
*
* \return The prior interrupt enable status for restoration later via restore_interrupts()
* \return The prior interrupt enable status for restoration later via \ref restore_interrupts_from_disabled()
* or \ref restore_interrupts()
*/
__force_inline static uint32_t save_and_disable_interrupts(void) {
uint32_t status;
Expand All @@ -219,7 +250,7 @@ __force_inline static uint32_t save_and_disable_interrupts(void) {
return status;
}

/*! \brief Restore interrupts to a specified state
/*! \brief Restore interrupts to a specified state on the calling core
* \ingroup hardware_sync
*
* \param status Previous interrupt status from save_and_disable_interrupts()
Expand All @@ -238,10 +269,10 @@ __force_inline static void restore_interrupts(uint32_t status) {
#endif
}

/*! \brief Restore interrupts to a specified state with restricted transitions
/*! \brief Restore interrupts to a specified state on the calling core with restricted transitions
* \ingroup hardware_sync
*
* This method should only be used when the interrupt state is known to be disabled,
* This method should only be used when the current interrupt state is known to be disabled,
* e.g. when paired with \ref save_and_disable_interrupts()
*
* \param status Previous interrupt status from save_and_disable_interrupts()
Expand Down