mcu_interrupts.h

00001 /*******************************************************************************
00002 * DISCLAIMER
00003 * This software is supplied by Renesas Electronics Corporation and is only
00004 * intended for use with Renesas products. No other uses are authorized. This
00005 * software is owned by Renesas Electronics Corporation and is protected under
00006 * all applicable laws, including copyright laws.
00007 * THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
00008 * THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
00009 * LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
00010 * AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
00011 * TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
00012 * ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
00013 * FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
00014 * ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
00015 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
00016 * Renesas reserves the right, without notice, to make changes to this software
00017 * and to discontinue the availability of this software. By using this software,
00018 * you agree to the additional terms and conditions found by accessing the
00019 * following link:
00020 * http://www.renesas.com/disclaimer
00021 * Copyright (C) 2012 - 2015 Renesas Electronics Corporation. All rights reserved.
00022 *******************************************************************************/
00023 /**
00024 * @file  mcu_interrupts.h
00025 * @brief   Interrupt related FIT BSP. Functions.
00026 *
00027 * $Module: OSPL $ $PublicVersion: 0.90 $ (=R_OSPL_VERSION)
00028 * $Rev: 35 $
00029 * $Date:: 2014-04-15 21:38:18 +0900#$
00030 */
00031 
00032 #ifndef MCU_INTERRUPTS_H
00033 #define MCU_INTERRUPTS_H
00034 
00035 
00036 /******************************************************************************
00037 Includes   <System Includes> , "Project Includes"
00038 ******************************************************************************/
00039 #include "Project_Config.h"
00040 #include "mcu_interrupts_typedef.h"
00041 
00042 #ifdef __cplusplus
00043 extern "C" {
00044 #endif /* __cplusplus */
00045 
00046 
00047 /******************************************************************************
00048 Typedef definitions
00049 ******************************************************************************/
00050 /* In "mcu_interrupts_typedef.h" */
00051 
00052 /******************************************************************************
00053 Macro definitions
00054 ******************************************************************************/
00055 /* In "mcu_interrupts_typedef.h" */
00056 
00057 /******************************************************************************
00058 Variable Externs
00059 ******************************************************************************/
00060 /* In "mcu_interrupts_typedef.h" */
00061 
00062 /******************************************************************************
00063 Functions Prototypes
00064 ******************************************************************************/
00065 
00066 /**
00067 * @brief   Registers a interrupt handler
00068 *
00069 * @param   IRQ_Num Interrupt request number
00070 * @param   Callback The function as interrupt handler
00071 * @return  Error code.  If there is no error, the return value is BSP_INT_SUCCESS.
00072 */
00073 bsp_int_err_t  R_BSP_InterruptWrite( bsp_int_src_t const  IRQ_Num,  bsp_int_cb_t const  Callback );
00074 
00075 
00076 /**
00077 * @brief   Returns registered interrupt handler
00078 *
00079 * @param   IRQ_Num Interrupt request number
00080 * @param   out_Callback Output: the function as interrupt handler
00081 * @return  Error code.  If there is no error, the return value is BSP_INT_SUCCESS.
00082 */
00083 bsp_int_err_t  R_BSP_InterruptRead( bsp_int_src_t const  IRQ_Num,  bsp_int_cb_t *const  out_Callback );
00084 
00085 
00086 /**
00087 * @brief   Controls related to the interrupt
00088 *
00089 * @param   IRQ_Num Interrupt request number
00090 * @param   Command Control command. See <bsp_int_cmd_t>
00091 * @param   NotUsed Depend on "Command" argument
00092 * @return  Error code.  If there is no error, the return value is BSP_INT_SUCCESS.
00093 */
00094 bsp_int_err_t  R_BSP_InterruptControl( bsp_int_src_t const  IRQ_Num,  bsp_int_cmd_t const  Command,
00095                                        void *const  NotUsed );
00096 
00097 
00098 /***********************************************************************
00099 * End of File:
00100 ************************************************************************/
00101 #ifdef __cplusplus
00102 }  /* extern "C" */
00103 #endif /* __cplusplus */
00104 
00105 #endif /* MCU_INTERRUPTS_H */
00106