250 lines
7.3 KiB
C
250 lines
7.3 KiB
C
/**
|
|
******************************************************************************
|
|
* @file stm32h7xx_hal_hsem.h
|
|
* @author MCD Application Team
|
|
* @version V1.2.0
|
|
* @date 29-December-2017
|
|
* @brief Header file of HSEM HAL module.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* 3. Neither the name of STMicroelectronics nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef __STM32H7xx_HAL_HSEM_H
|
|
#define __STM32H7xx_HAL_HSEM_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
#include "stm32h7xx_hal_def.h"
|
|
|
|
|
|
/** @addtogroup STM32H7xx_HAL_Driver
|
|
* @{
|
|
*/
|
|
|
|
/** @addtogroup HSEM
|
|
* @{
|
|
*/
|
|
|
|
/* Exported types ------------------------------------------------------------*/
|
|
|
|
/** @defgroup HSEM_Exported_Types HSEM Exported Types
|
|
* @{
|
|
*/
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported constants --------------------------------------------------------*/
|
|
|
|
/** @defgroup HSEM_Exported_Constants HSEM Exported Constants
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported macro ------------------------------------------------------------*/
|
|
/** @defgroup HSEM_Exported_Macros HSEM Exported Macros
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief SemID to mask helper Macro.
|
|
* @param __SEMID__: semaphore ID from 0 to 31
|
|
* @retval Semaphore Mask.
|
|
*/
|
|
#define __HAL_HSEM_SEMID_TO_MASK(__SEMID__) (1 << (__SEMID__))
|
|
|
|
|
|
/**
|
|
* @brief Enables the specified HSEM interrupts.
|
|
* @param __SEM_MASK__: semaphores Mask
|
|
* @retval None.
|
|
*/
|
|
#define __HAL_HSEM_ENABLE_IT(__SEM_MASK__) (HSEM->IER |= (__SEM_MASK__))
|
|
/**
|
|
* @brief Disables the specified HSEM interrupts.
|
|
* @param __SEM_MASK__: semaphores Mask
|
|
* @retval None.
|
|
*/
|
|
#define __HAL_HSEM_DISABLE_IT(__SEM_MASK__) (HSEM->IER &= ~(__SEM_MASK__))
|
|
|
|
/**
|
|
* @brief Checks whether interrupt has occurred or not for semaphores specified by a mask.
|
|
* @param __SEM_MASK__: semaphores Mask
|
|
* @retval semaphores Mask : Semaphores where an interrupt occurred.
|
|
*/
|
|
#define __HAL_HSEM_GET_IT(__SEM_MASK__) ((__SEM_MASK__) & HSEM->MISR)
|
|
|
|
/**
|
|
* @brief Get the semaphores release status flags.
|
|
* @param __SEM_MASK__: semaphores Mask
|
|
* @retval semaphores Mask : Semaphores where Release flags rise.
|
|
*/
|
|
#define __HAL_HSEM_GET_FLAG(__SEM_MASK__) ((__SEM_MASK__) & HSEM->ISR)
|
|
|
|
/**
|
|
* @brief Clears the HSEM Interrupt flags.
|
|
* @param __SEM_MASK__: semaphores Mask
|
|
* @retval None.
|
|
*/
|
|
#define __HAL_HSEM_CLEAR_FLAG(__SEM_MASK__) (HSEM->ICR |= (__SEM_MASK__))
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported functions --------------------------------------------------------*/
|
|
/** @defgroup HSEM_Exported_Functions HSEM Exported Functions
|
|
* @{
|
|
*/
|
|
|
|
|
|
/** @addtogroup HSEM_Exported_Functions_Group1 Take and Release functions
|
|
* @brief HSEM Take and Release functions
|
|
* @{
|
|
*/
|
|
|
|
/* HSEM semaphore take (lock) using 2-Step method ****************************/
|
|
HAL_StatusTypeDef HAL_HSEM_Take(uint32_t SemID, uint32_t ProcessID);
|
|
/* HSEM semaphore fast take (lock) using 1-Step method ***********************/
|
|
HAL_StatusTypeDef HAL_HSEM_FastTake(uint32_t SemID);
|
|
/* HSEM Check semaphore state Taken or not **********************************/
|
|
uint32_t HAL_HSEM_IsSemTaken(uint32_t SemID);
|
|
/* HSEM Release **************************************************************/
|
|
void HAL_HSEM_Release(uint32_t SemID, uint32_t ProcessID);
|
|
/* HSEM Release All************************************************************/
|
|
void HAL_HSEM_ReleaseAll(uint32_t Key, uint32_t MasterID);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @addtogroup HSEM_Exported_Functions_Group2 HSEM Set and Get Key functions
|
|
* @brief HSEM Set and Get Key functions.
|
|
* @{
|
|
*/
|
|
/* HSEM Set Clear Key *********************************************************/
|
|
void HAL_HSEM_SetClearKey(uint32_t Key);
|
|
/* HSEM Get Clear Key *********************************************************/
|
|
uint32_t HAL_HSEM_GetClearKey(void);
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/** @addtogroup HSEM_Exported_Functions_Group3
|
|
* @brief HSEM Notification functions
|
|
* @{
|
|
*/
|
|
/* HSEM Activate HSEM Notification (When a semaphore is released) ) *****************/
|
|
void HAL_HSEM_ActivateNotification(uint32_t SemMask);
|
|
/* HSEM Deactivate HSEM Notification (When a semaphore is released) ****************/
|
|
void HAL_HSEM_DeactivateNotification(uint32_t SemMask);
|
|
/* HSEM Free Callback (When a semaphore is released) *******************************/
|
|
void HAL_HSEM_FreeCallback(uint32_t SemMask);
|
|
/* HSEM IRQ Handler **********************************************************/
|
|
void HAL_HSEM_IRQHandler(void);
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private types -------------------------------------------------------------*/
|
|
/** @defgroup HSEM_Private_Types HSEM Private Types
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private variables ---------------------------------------------------------*/
|
|
/** @defgroup HSEM_Private_Variables HSEM Private Variables
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private constants ---------------------------------------------------------*/
|
|
/** @defgroup HSEM_Private_Constants HSEM Private Constants
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private macros ------------------------------------------------------------*/
|
|
/** @defgroup HSEM_Private_Macros HSEM Private Macros
|
|
* @{
|
|
*/
|
|
|
|
#define IS_HSEM_SEMID(__SEMID__) ((__SEMID__) <= HSEM_SEMID_MAX )
|
|
|
|
#define IS_HSEM_PROCESSID(__PROCESSID__) ((__PROCESSID__) <= HSEM_PROCESSID_MAX )
|
|
|
|
#define IS_HSEM_KEY(__KEY__) ((__KEY__) <= HSEM_CLEAR_KEY_MAX )
|
|
|
|
#define IS_HSEM_MASTERID(__MASTERID__) (((__MASTERID__) == HSEM_CM7_MASTERID))
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __STM32H7xx_HAL_HSEM_H */
|
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|