stm32h7xx_hal_ramecc.h File Reference

Header file of RAMECC HAL module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	__RAMECC_HandleTypeDef
	RAMECC handle Structure definition. More...
Defines
#define	HAL_RAMECC_ERROR_NONE   0x00000000U
#define	HAL_RAMECC_ERROR_TIMEOUT   0x00000001U
#define	HAL_RAMECC_ERROR_BUSY   0x00000002U
#define	HAL_RAMECC_ERROR_INVALID_CALLBACK   0x00000003U
#define	RAMECC_IT_GLOBAL_ID   0x10000000UL
#define	RAMECC_IT_MONITOR_ID   0x20000000UL
#define	RAMECC_IT_GLOBAL_ENABLE   (RAMECC_IT_GLOBAL_ID | RAMECC_IER_GIE)
#define	RAMECC_IT_GLOBAL_SINGLEERR_R   (RAMECC_IT_GLOBAL_ID | RAMECC_IER_GECCSEIE)
#define	RAMECC_IT_GLOBAL_DOUBLEERR_R   (RAMECC_IT_GLOBAL_ID | RAMECC_IER_GECCDEIE)
#define	RAMECC_IT_GLOBAL_DOUBLEERR_W   (RAMECC_IT_GLOBAL_ID | RAMECC_IER_GECCDEBWIE)
#define	RAMECC_IT_GLOBAL_ALL   (RAMECC_IT_GLOBAL_ID | RAMECC_IER_GIE | RAMECC_IER_GECCSEIE | RAMECC_IER_GECCDEIE | RAMECC_IER_GECCDEBWIE)
#define	RAMECC_IT_MONITOR_SINGLEERR_R   (RAMECC_IT_MONITOR_ID | RAMECC_CR_ECCSEIE)
#define	RAMECC_IT_MONITOR_DOUBLEERR_R   (RAMECC_IT_MONITOR_ID | RAMECC_CR_ECCDEIE)
#define	RAMECC_IT_MONITOR_DOUBLEERR_W   (RAMECC_IT_MONITOR_ID | RAMECC_CR_ECCDEBWIE)
#define	RAMECC_IT_MONITOR_ALL   (RAMECC_IT_MONITOR_ID | RAMECC_CR_ECCDEBWIE | RAMECC_CR_ECCDEIE | RAMECC_CR_ECCSEIE)
#define	RAMECC_FLAG_SINGLEERR_R   RAMECC_SR_SEDCF
#define	RAMECC_FLAG_DOUBLEERR_R   RAMECC_SR_DEDF
#define	RAMECC_FLAG_DOUBLEERR_W   RAMECC_SR_DEBWDF
#define	RAMECC_FLAGS_ALL   (RAMECC_SR_SEDCF | RAMECC_SR_DEDF | RAMECC_SR_DEBWDF)
#define	__HAL_RAMECC_ENABLE_GLOBAL_IT(__HANDLE__, __INTERRUPT__)   ((((RAMECC_TypeDef *)((uint32_t)(__HANDLE__)->Instance & 0xFFFFFF00U))->IER) |= ((__INTERRUPT__) & ~RAMECC_IT_GLOBAL_ID))
#define	__HAL_RAMECC_ENABLE_MONITOR_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR |= ((__INTERRUPT__) & ~RAMECC_IT_MONITOR_ID))
#define	__HAL_RAMECC_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified RAMECC interrupts.
#define	__HAL_RAMECC_DISABLE_GLOBAL_IT(__HANDLE__, __INTERRUPT__)   ((((RAMECC_TypeDef *)((uint32_t)(__HANDLE__)->Instance & 0xFFFFFF00U))->IER) &= ~((__INTERRUPT__) & ~RAMECC_IT_GLOBAL_ID))
#define	__HAL_RAMECC_DISABLE_MONITOR_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR &= ~((__INTERRUPT__) & ~RAMECC_IT_MONITOR_ID))
#define	__HAL_RAMECC_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the specified RAMECC interrupts.
#define	__HAL_RAMECC_GET_GLOBAL_IT_SOURCE(__HANDLE__, __INTERRUPT__)   (((((RAMECC_TypeDef *)((uint32_t)(__HANDLE__)->Instance & 0xFFFFFF00U))->IER) & ((__INTERRUPT__) & ~RAMECC_IT_GLOBAL_ID)) ? SET : RESET)
#define	__HAL_RAMECC_GET_MONITOR_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((__HANDLE__)->Instance->CR) & ((__INTERRUPT__) & ~RAMECC_IT_GLOBAL_ID)) ? SET : RESET)
#define	__HAL_RAMECC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified RAMECC interrupt source is enabled or not.
#define	__HAL_RAMECC_GET_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->SR &= (__FLAG__))
	Get the RAMECC pending flags.
#define	__HAL_RAMECC_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->SR &= ~(__FLAG__))
	Clear the RAMECC pending flags.
#define	__HAL_RAMECC_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_RAMECC_STATE_RESET)
	Reset the RAMECC handle state.
#define	IS_RAMECC_GLOBAL_INTERRUPT(INTERRUPT)
#define	IS_RAMECC_MONITOR_INTERRUPT(INTERRUPT)
#define	IS_RAMECC_INTERRUPT(INTERRUPT)
Typedefs
typedef struct __RAMECC_HandleTypeDef	RAMECC_HandleTypeDef
	RAMECC handle Structure definition.
Enumerations
enum	HAL_RAMECC_StateTypeDef { HAL_RAMECC_STATE_RESET = 0x00U, HAL_RAMECC_STATE_READY = 0x01U, HAL_RAMECC_STATE_BUSY = 0x02U, HAL_RAMECC_STATE_ERROR = 0x03U }
	HAL RAMECC State structures definition. More...
Functions
HAL_StatusTypeDef	HAL_RAMECC_Init (RAMECC_HandleTypeDef *hramecc)
	Initialize the RAMECC by clearing flags and disabling interrupts.
HAL_StatusTypeDef	HAL_RAMECC_DeInit (RAMECC_HandleTypeDef *hramecc)
	DeInitializes the RAMECC peripheral.
HAL_StatusTypeDef	HAL_RAMECC_StartMonitor (RAMECC_HandleTypeDef *hramecc)
	Starts the RAMECC latching error information.
HAL_StatusTypeDef	HAL_RAMECC_StopMonitor (RAMECC_HandleTypeDef *hramecc)
	Stop the RAMECC latching error information.
HAL_StatusTypeDef	HAL_RAMECC_EnableNotification (RAMECC_HandleTypeDef *hramecc, uint32_t Notifications)
	Enable the RAMECC error interrupts.
HAL_StatusTypeDef	HAL_RAMECC_DisableNotification (RAMECC_HandleTypeDef *hramecc, uint32_t Notifications)
	Disable the RAMECC error interrupts.
void	HAL_RAMECC_IRQHandler (RAMECC_HandleTypeDef *hramecc)
	Handles RAMECC interrupt request.
HAL_StatusTypeDef	HAL_RAMECC_RegisterCallback (RAMECC_HandleTypeDef *hramecc, void(*pCallback)(RAMECC_HandleTypeDef *_hramecc))
	Register callbacks.
HAL_StatusTypeDef	HAL_RAMECC_UnRegisterCallback (RAMECC_HandleTypeDef *hramecc)
	UnRegister callbacks.
uint32_t	HAL_RAMECC_GetFailingAddress (RAMECC_HandleTypeDef *hramecc)
	Return the RAMECC failing address.
uint32_t	HAL_RAMECC_GetFailingDataLow (RAMECC_HandleTypeDef *hramecc)
	Return the RAMECC data low.
uint32_t	HAL_RAMECC_GetFailingDataHigh (RAMECC_HandleTypeDef *hramecc)
	Return the RAMECC data high.
uint32_t	HAL_RAMECC_GetHammingErrorCode (RAMECC_HandleTypeDef *hramecc)
	Return the RAMECC Hamming bits injected.
uint32_t	HAL_RAMECC_IsECCSingleErrorDetected (RAMECC_HandleTypeDef *hramecc)
	Check if an ECC single error was occurred.
uint32_t	HAL_RAMECC_IsECCDoubleErrorDetected (RAMECC_HandleTypeDef *hramecc)
	Check if an ECC double error was occurred.
HAL_RAMECC_StateTypeDef	HAL_RAMECC_GetState (RAMECC_HandleTypeDef *hramecc)
	Get the RAMECC peripheral state.
uint32_t	HAL_RAMECC_GetError (RAMECC_HandleTypeDef *hramecc)
	Get the RAMECC peripheral error code.

---

Detailed Description

Header file of RAMECC HAL module.

Author:

MCD Application Team

Attention:

Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32h7xx_hal_ramecc.h.