1 /**
2  * \file
3  *
4  * \brief IRQ related functionality declaration.
5  *
6  * Copyright (C) 2014 Atmel Corporation. All rights reserved.
7  *
8  * \asf_license_start
9  *
10  * \page License
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  *    this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  *    this list of conditions and the following disclaimer in the documentation
20  *    and/or other materials provided with the distribution.
21  *
22  * 3. The name of Atmel may not be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * 4. This software may only be redistributed and used in connection with an
26  *    Atmel microcontroller product.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  *
40  * \asf_license_stop
41  *
42  */
43 
44 #ifndef _HPL_IRQ_H_INCLUDED
45 #define _HPL_IRQ_H_INCLUDED
46 
47 /**
48  * \addtogroup HPL IRQ
49  *
50  * \section hpl_irq_rev Revision History
51  * - v1.0.0 Initial Release
52  *
53  *@{
54  */
55 
56 #include <compiler.h>
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 /**
63  * \brief IRQ descriptor
64  */
65 struct _irq_descriptor {
66 	void (*handler)(void *parameter);
67 	void *parameter;
68 };
69 
70 /**
71  * \name HPL functions
72  */
73 //@{
74 /**
75  * \brief Retrieve current IRQ number
76  *
77  * \return The current IRQ number
78  */
79 uint8_t _irq_get_current(void);
80 
81 /**
82  * \brief Disable the given IRQ
83  *
84  * \param[in] n The number of IRQ to disable
85  */
86 void _irq_disable(uint8_t n);
87 
88 /**
89  * \brief Set the given IRQ
90  *
91  * \param[in] n The number of IRQ to set
92  */
93 void _irq_set(uint8_t n);
94 
95 /**
96  * \brief Clear the given IRQ
97  *
98  * \param[in] n The number of IRQ to clear
99  */
100 void _irq_clear(uint8_t n);
101 
102 /**
103  * \brief Enable the given IRQ
104  *
105  * \param[in] n The number of IRQ to enable
106  */
107 void _irq_enable(uint8_t n);
108 
109 /**
110  * \brief Register IRQ handler
111  *
112  * \param[in] number The number registered IRQ
113  * \param[in] irq The pointer to irq handler to register
114  *
115  * \return The status of IRQ handler registering
116  * \retval -1 Passed parameters were invalid
117  * \retval 0 The registering is completed successfully
118  */
119 void _irq_register(const uint8_t number, struct _irq_descriptor *const irq);
120 //@}
121 
122 #ifdef __cplusplus
123 }
124 #endif
125 /**@}*/
126 #endif /* _HPL_IRQ_H_INCLUDED */
127