stm32h7xx_hal_ramecc.c File Reference

RAMECC HAL module driver. This file provides firmware functions to manage the following functionalities of the RAM ECC monitoring (RAMECC) peripheral: + Initialization and de-initialization functions + Monitoring operation functions + Error information functions + State and error functions. More...

#include "stm32h7xx_hal.h"

Go to the source code of this file.

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.
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.
void	HAL_RAMECC_IRQHandler (RAMECC_HandleTypeDef *hramecc)
	Handles RAMECC interrupt request.
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

RAMECC HAL module driver. This file provides firmware functions to manage the following functionalities of the RAM ECC monitoring (RAMECC) peripheral: + Initialization and de-initialization functions + Monitoring operation functions + Error information functions + State and error functions.

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.

  ==============================================================================
                        ##### How to use this driver #####
  ==============================================================================
  [..]
   (#) Enable and latch error information through HAL_RAMECC_Init().

   (#) For a given Monitor, enable and disable interrupt through
       HAL_RAMECC_EnableNotification().
       To enable a notification for a given RAMECC instance, use global
       interrupts.
       To enable a notification for only RAMECC monitor, use monitor interrupts.
       All possible notifications are defined in the driver header file under
       RAMECC_Interrupt group.

     *** Silent mode ***
     ===================
    [..]
          (+) Use HAL_RAMECC_StartMonitor() to start RAMECC latch failing
              information without enabling any notification.

     *** Interrupt mode ***
     ======================
    [..]
          (+) Use HAL_RAMECC_EnableNotification() to enable interrupts for a
              given error.
          (+) Configure the RAMECC interrupt priority using
              HAL_NVIC_SetPriority().
          (+) Enable the RAMECC IRQ handler using HAL_NVIC_EnableIRQ().
          (+) Start RAMECC latch failing information using HAL_RAMECC_StartMonitor().

     *** Failing information ***
     ======================
    [..]
     (#) Use HAL_RAMECC_GetFailingAddress() function to return the RAMECC
         failing address.
     (#) Use HAL_RAMECC_GetFailingDataLow() function to return the RAMECC
         failing data low.
     (#) Use HAL_RAMECC_GetFailingDataHigh() function to return the RAMECC
         failing data high.
     (#) Use HAL_RAMECC_GetHammingErrorCode() function to return the RAMECC
         Hamming bits injected.
     (#) Use HAL_RAMECC_IsECCSingleErrorDetected() function to check if a single
         error was detected and corrected.
     (#) Use HAL_RAMECC_IsECCDoubleErrorDetected() function to check if a double
         error was dedetected.

     *** RAMECC HAL driver macros list ***
     =============================================
     [..]
       Below the list of used macros in RAMECC HAL driver.

      (+) __HAL_RAMECC_ENABLE_IT  : Enable the specified ECCRAM Monitor
                                    interrupts.
      (+) __HAL_RAMECC_DISABLE_IT : Disable the specified ECCRAM Monitor
                                    interrupts.
      (+) __HAL_RAMECC_GET_FLAG   : Return the current RAMECC Monitor selected
                                    flag.
      (+) __HAL_RAMECC_CLEAR_FLAG : Clear the current RAMECC Monitor selected
                                    flag.
  

Definition in file stm32h7xx_hal_ramecc.c.