locking.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  locking.h
00025 * @brief   Lock 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 LOCKING_H
00033 #define LOCKING_H
00034 
00035 
00036 /******************************************************************************
00037 Includes   <System Includes> , "Project Includes"
00038 ******************************************************************************/
00039 #include "Project_Config.h"
00040 #if BSP_CFG_USER_LOCKING_ENABLED
00041 #include "locking_user.h"
00042 #endif
00043 #include "r_typedefs.h"
00044 #include "locking_typedef.h"
00045 
00046 #ifdef __cplusplus
00047 extern "C" {
00048 #endif /* __cplusplus */
00049 
00050 
00051 /******************************************************************************
00052 Typedef definitions
00053 ******************************************************************************/
00054 /* In "locking_typedef.h" */
00055 
00056 /******************************************************************************
00057 Macro definitions
00058 ******************************************************************************/
00059 /* In "locking_typedef.h" */
00060 
00061 /******************************************************************************
00062 Variable Externs
00063 ******************************************************************************/
00064 /* In "locking_typedef.h" */
00065 
00066 /******************************************************************************
00067 Functions Prototypes
00068 ******************************************************************************/
00069 
00070 
00071 /**
00072 * @brief   Attempts to reserve a hardware peripheral lock.
00073 *
00074 * @param   HardwareIndex Index of lock to acquire from the hardware lock array.
00075 * @return  true = Successful, false = Failure
00076 */
00077 bool_t  R_BSP_HardwareLock( mcu_lock_t const  HardwareIndex );
00078 
00079 
00080 /**
00081 * @brief   Releases a hardware peripheral lock.
00082 *
00083 * @param   HardwareIndex Index of lock to release from the hardware lock array.
00084 * @return  true = Successful, false = Failure
00085 */
00086 bool_t  R_BSP_HardwareUnlock( mcu_lock_t const  HardwareIndex );
00087 
00088 
00089 /**
00090 * @brief   Attempts to reserve a lock.
00091 *
00092 * @param   LockObject Pointer to lock structure with lock to try and acquire.
00093 * @return  true = Successful, false = Failure
00094 */
00095 bool_t  R_BSP_SoftwareLock( BSP_CFG_USER_LOCKING_TYPE *const  LockObject );
00096 
00097 
00098 /**
00099 * @brief   Releases a lock.
00100 *
00101 * @param   LockObject Pointer to lock structure with lock to release.
00102 * @return  true = Successful, false = Failure
00103 */
00104 bool_t  R_BSP_SoftwareUnlock( BSP_CFG_USER_LOCKING_TYPE *const  LockObject );
00105 
00106 
00107 /***********************************************************************
00108 * End of File:
00109 ************************************************************************/
00110 #ifdef __cplusplus
00111 }  /* extern "C" */
00112 #endif /* __cplusplus */
00113 
00114 #endif /* LOCKING_H */
00115