source: trunk/hal/generic/hal_irqmask.h @ 110

Last change on this file since 110 was 17, checked in by max@…, 7 years ago

Typos, and cosmetic.

File size: 2.8 KB
Line 
1/*
2 * hal_irqmask.h - Generic Interrupt Masking API definition
3 *
4 * Authors   Ghassan Almaless (2008,2009,2010,2011,2012)
5 *           Alain Greiner    (2016)
6 *
7 * Copyright (c)  UPMC Sorbonne Universites
8 *
9 * This file is part of ALMOS-MKH.
10 *
11 * ALMOS-MKH is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2.0 of the License.
14 *
15 * ALMOS-MKH is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24
25#ifndef  _HAL_IRQMASK_H_
26#define  _HAL_IRQMASK_H_
27
28#include <hal_types.h>
29
30
31//////////////////////////////////////////////////////////////////////////////////////////
32//       Generic IRQ Masking API (implementation in hal_irqmask.c)
33//
34// Interrupt Enabling / disabling for a given core depends on the hardware architecture.
35// ALMOS-MKH uses the following API.
36//////////////////////////////////////////////////////////////////////////////////////////
37
38/*****************************************************************************************
39 * This function disables all IRQs, and saves the CPU SR state if required.
40 * TODO : Warning this function discards the CU3 access bit
41 *****************************************************************************************
42 * @ old    : address of buffer to save the SR (no save if NULL).
43 ****************************************************************************************/
44extern inline void hal_disable_irq( reg_t * old );
45
46/*****************************************************************************************
47 * This function enables all IRQs, and saves the CPU SR state if required.
48 *****************************************************************************************
49 * @ old    : address of buffer to save the SR (no save if NULL).
50 ****************************************************************************************/
51extern inline void hal_enable_irq( reg_t * old );
52
53/*****************************************************************************************
54 * This function restores a previously saved SR state.
55 *****************************************************************************************
56 * @ old    : value to be written in CPU SR register
57 ****************************************************************************************/
58extern inline void hal_restore_irq( reg_t old );
59
60
61#endif  /* _HAL_IRQ_MASK_H_ */
Note: See TracBrowser for help on using the repository browser.