1 /**
2  * \file
3  *
4  * \brief External interrupt functionality declaration.
5  *
6  * Copyright (C) 2015 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 _HAL_EXT_IRQ_H_INCLUDED
45 #define _HAL_EXT_IRQ_H_INCLUDED
46 
47 #include <hpl_ext_irq.h>
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 /**
54  * \addtogroup doc_driver_hal_ext_irq
55  *
56  * @{
57  */
58 
59 /**
60  * \brief External IRQ callback type
61  */
62 typedef void (*ext_irq_cb_t)(void);
63 
64 /**
65  * \brief Initialize external IRQ component, if any
66  *
67  * \return Initialization status.
68  * \retval -1 External IRQ module is already initialized
69  * \retval 0 The initialization is completed successfully
70  */
71 int32_t ext_irq_init(void);
72 
73 /**
74  * \brief Deinitialize external IRQ, if any
75  *
76  * \return De-initialization status.
77  * \retval -1 External IRQ module is already deinitialized
78  * \retval 0 The de-initialization is completed successfully
79  */
80 int32_t ext_irq_deinit(void);
81 
82 /**
83  * \brief Register callback for the given external interrupt
84  *
85  * \param[in] pin Pin to enable external IRQ on
86  * \param[in] cb Callback function
87  *
88  * \return Registration status.
89  * \retval -1 Passed parameters were invalid
90  * \retval 0 The callback registration is completed successfully
91  */
92 int32_t ext_irq_register(const uint32_t pin, ext_irq_cb_t cb);
93 
94 /**
95  * \brief Enable external IRQ
96  *
97  * \param[in] pin Pin to enable external IRQ on
98  *
99  * \return Enabling status.
100  * \retval -1 Passed parameters were invalid
101  * \retval 0 The enabling is completed successfully
102  */
103 int32_t ext_irq_enable(const uint32_t pin);
104 
105 /**
106  * \brief Disable external IRQ
107  *
108  * \param[in] pin Pin to enable external IRQ on
109  *
110  * \return Disabling status.
111  * \retval -1 Passed parameters were invalid
112  * \retval 0 The disabling is completed successfully
113  */
114 int32_t ext_irq_disable(const uint32_t pin);
115 
116 /**
117  * \brief Retrieve the current driver version
118  *
119  * \return Current driver version.
120  */
121 uint32_t ext_irq_get_version(void);
122 /**@}*/
123 
124 #ifdef __cplusplus
125 }
126 #endif
127 
128 #endif /* _HAL_EXT_IRQ_H_INCLUDED */
129