jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

[CM3] Add support for Cortex M interrupt masks

Browse Source 
FIX: add doxygen documentation to the module
This commit is contained in:
Frantisek Burian 2013-09-12 00:16:33 -07:00 committed by Piotr Esden-Tempski
parent 065b47f8ba
commit 17fc71a462
1 changed files with 79 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
include/libopencm3/cm3/cortex.h
View File

@ -1,7 +1,18 @@
/** @defgroup CM3_cortex_defines Cortex Core Defines
*
* @brief <b>libopencm3 Defined Constants and Types for the Cortex Core </b>
*
* @ingroup CM3_defines
*
* @version 1.0.0
*
* LGPL License Terms @ref lgpl_license
*/
/* /*
* This file is part of the libopencm3 project. * This file is part of the libopencm3 project.
* *
* Copyright (C) 2013 Ben Gamari <bgamari@gmail.com> * Copyright (C) 2013 Ben Gamari <bgamari@gmail.com>
* Copyright (C) 2013 Frantisek Burian <BuFran@seznam.cz>
* *
* This library is free software: you can redistribute it and/or modify * This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by * it under the terms of the GNU Lesser General Public License as published by
@ -20,27 +31,56 @@
#ifndef LIBOPENCM3_CORTEX_H #ifndef LIBOPENCM3_CORTEX_H
#define LIBOPENCM3_CORTEX_H #define LIBOPENCM3_CORTEX_H
/**@{*/
/*---------------------------------------------------------------------------*/
/** @brief Cortex M Enable interrupts
*
* Disable the interrupt mask and enable interrupts globally
*/
static inline void cm_enable_interrupts(void) static inline void cm_enable_interrupts(void)
{ {
__asm__("CPSIE I\n"); __asm__("CPSIE I\n");
} }
/*---------------------------------------------------------------------------*/
/** @brief Cortex M Disable interrupts
*
* Mask all interrupts globally
*/
static inline void cm_disable_interrupts(void) static inline void cm_disable_interrupts(void)
{ {
__asm__("CPSID I\n"); __asm__("CPSID I\n");
} }
/*---------------------------------------------------------------------------*/
/** @brief Cortex M Enable faults
*
* Disable the HardFault mask and enable fault interrupt globally
*/
static inline void cm_enable_faults(void) static inline void cm_enable_faults(void)
{ {
__asm__("CPSIE F\n"); __asm__("CPSIE F\n");
} }
/*---------------------------------------------------------------------------*/
/** @brief Cortex M Disable faults
*
* Mask the HardFault interrupt globally
*/
static inline void cm_disable_faults(void) static inline void cm_disable_faults(void)
{ {
__asm__("CPSID F\n"); __asm__("CPSID F\n");
} }
/* __attribute__(( always_inline )) */ /*---------------------------------------------------------------------------*/
/** @brief Cortex M Check if interrupts are masked
*
* Checks, if interrupts are masked (disabled).
*
* @returns true, if interrupts are disabled.
*/
__attribute__(( always_inline ))
static inline bool cm_is_masked_interrupts(void) static inline bool cm_is_masked_interrupts(void)
{ {
register uint32_t result; register uint32_t result;
@ -48,7 +88,14 @@ static inline bool cm_is_masked_interrupts(void)
return (result); return (result);
} }
/* __attribute__(( always_inline )) */ /*---------------------------------------------------------------------------*/
/** @brief Cortex M Check if Fault interrupt is masked
*
* Checks, if HardFault interrupt is masked (disabled).
*
* @returns bool true, if HardFault interrupt is disabled.
*/
__attribute__(( always_inline ))
static inline bool cm_is_masked_faults(void) static inline bool cm_is_masked_faults(void)
{ {
register uint32_t result; register uint32_t result;
@ -56,7 +103,17 @@ static inline bool cm_is_masked_faults(void)
return (result); return (result);
} }
/* __attribute__(( always_inline )) */ /*---------------------------------------------------------------------------*/
/** @brief Cortex M Mask interrupts
*
* This function switches the mask of the interrupts. If mask is true, the
* interrupts will be disabled. The result of this function can be used for
* restoring previous state of the mask.
*
* @param[in] mask bool New state of the interrupt mask
* @returns bool old state of the interrupt mask
*/
__attribute__(( always_inline ))
static inline bool cm_mask_interrupts(bool mask) static inline bool cm_mask_interrupts(bool mask)
{ {
register bool old; register bool old;
@ -66,7 +123,17 @@ static inline bool cm_mask_interrupts(bool mask)
return old; return old;
} }
/* __attribute__(( always_inline )) */ /*---------------------------------------------------------------------------*/
/** @brief Cortex M Mask HardFault interrupt
*
* This function switches the mask of the HardFault interrupt. If mask is true,
* the HardFault interrupt will be disabled. The result of this function can be
* used for restoring previous state of the mask.
*
* @param[in] mask bool New state of the HardFault interrupt mask
* @returns bool old state of the HardFault interrupt mask
*/
__attribute__(( always_inline ))
static inline bool cm_mask_faults(bool mask) static inline bool cm_mask_faults(bool mask)
{ {
register bool old; register bool old;
@ -76,5 +143,6 @@ static inline bool cm_mask_faults(bool mask)
return old; return old;
} }
/**@}*/
#endif #endif