arm_hal_interrupt.h

00001 /*
00002  * Copyright (c) 2014-2015 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef ARM_HAL_API_H_
00018 #define ARM_HAL_API_H_
00019 #ifdef __cplusplus
00020 extern "C" {
00021 #endif
00022 #include <stdint.h>
00023 
00024 /**
00025  * \brief This function disable global interrupts.
00026  */
00027 extern void platform_enter_critical(void);
00028 /**
00029  * \brief This function enable global interrupts.
00030  */
00031 extern void platform_exit_critical(void);
00032 
00033 /**
00034  * \brief This function increments the disable IRQ counter.
00035  * The function must be called inside interrupt routines
00036  * before any routine that uses platform_enter_critical()
00037  * is called.
00038  *
00039  * This routine may not be need to do anything on some platforms,
00040  * but requiring the call to be made before using
00041  * platform_enter_critical() in an interrupt can simplify some
00042  * implementations of platform_enter/exit_critical().
00043  */
00044 extern void platform_interrupts_disabled(void);
00045 
00046 /**
00047  * \brief This function decrements the disable IRQ counter.
00048  */
00049 extern void platform_interrupts_enabling(void);
00050 
00051 #ifdef __cplusplus
00052 }
00053 #endif
00054 
00055 #endif /* ARM_HAL_API_H_ */