1 /** 2 * \file 3 * 4 * \brief External IRQ related 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 _HPL_EXT_IRQ_H_INCLUDED 45 #define _HPL_EXT_IRQ_H_INCLUDED 46 47 /** 48 * \addtogroup HPL EXT IRQ 49 * 50 * \section hpl_ext_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 * \name HPL functions 64 */ 65 //@{ 66 /** 67 * \brief Initialize external interrupt module 68 * 69 * This function does low level external interrupt configuration. 70 * 71 * \param[in] cb The pointer to callback function from external interrupt 72 * 73 * \return Initialization status. 74 * \retval -1 External irq module is already initialized 75 * \retval 0 The initialization is completed successfully 76 */ 77 int32_t _ext_irq_init(void (*cb)(const uint32_t pin)); 78 79 /** 80 * \brief Deinitialize external interrupt module 81 * 82 * \return Initialization status. 83 * \retval -1 External irq module is already deinitialized 84 * \retval 0 The de-initialization is completed successfully 85 */ 86 int32_t _ext_irq_deinit(void); 87 88 /** 89 * \brief Enable / disable external irq 90 * 91 * \param[in] pin Pin to enable external irq on 92 * \param[in] enable True to enable, false to disable 93 * 94 * \return Status of external irq enabling / disabling 95 * \retval -1 External irq module can't be enabled / disabled 96 * \retval 0 External irq module is enabled / disabled successfully 97 */ 98 int32_t _ext_irq_enable(const uint32_t pin, const bool enable); 99 //@} 100 101 #ifdef __cplusplus 102 } 103 #endif 104 /**@}*/ 105 #endif /* _HPL_EXT_IRQ_H_INCLUDED */ 106
