This file provides firmware functions to manage the following functionalities of the Graphic MMU (GFXMMU) peripheral: More...

Functions
HAL_StatusTypeDef	HAL_GFXMMU_Init (GFXMMU_HandleTypeDef *hgfxmmu)
	Initialize the GFXMMU according to the specified parameters in the GFXMMU_InitTypeDef structure and initialize the associated handle. More...

HAL_StatusTypeDef	HAL_GFXMMU_DeInit (GFXMMU_HandleTypeDef *hgfxmmu)
	De-initialize the GFXMMU. More...

void	HAL_GFXMMU_MspInit (GFXMMU_HandleTypeDef *hgfxmmu)
	Initialize the GFXMMU MSP. More...

void	HAL_GFXMMU_MspDeInit (GFXMMU_HandleTypeDef *hgfxmmu)
	De-initialize the GFXMMU MSP. More...

HAL_StatusTypeDef	HAL_GFXMMU_RegisterCallback (GFXMMU_HandleTypeDef *hgfxmmu, HAL_GFXMMU_CallbackIDTypeDef CallbackID, pGFXMMU_CallbackTypeDef pCallback)
	Register a user GFXMMU callback to be used instead of the weak predefined callback. More...

HAL_StatusTypeDef	HAL_GFXMMU_UnRegisterCallback (GFXMMU_HandleTypeDef *hgfxmmu, HAL_GFXMMU_CallbackIDTypeDef CallbackID)
	Unregister a user GFXMMU callback. GFXMMU callback is redirected to the weak predefined callback. More...

HAL_StatusTypeDef	HAL_GFXMMU_ConfigLut (GFXMMU_HandleTypeDef *hgfxmmu, uint32_t FirstLine, uint32_t LinesNumber, uint32_t Address)
	This function allows to copy LUT from flash to look up RAM. More...

HAL_StatusTypeDef	HAL_GFXMMU_DisableLutLines (GFXMMU_HandleTypeDef *hgfxmmu, uint32_t FirstLine, uint32_t LinesNumber)
	This function allows to disable a range of LUT lines. More...

HAL_StatusTypeDef	HAL_GFXMMU_ConfigLutLine (GFXMMU_HandleTypeDef hgfxmmu, GFXMMU_LutLineTypeDef lutLine)
	This function allows to configure one line of LUT. More...

HAL_StatusTypeDef	HAL_GFXMMU_ModifyBuffers (GFXMMU_HandleTypeDef hgfxmmu, GFXMMU_BuffersTypeDef Buffers)
	This function allows to modify physical buffer addresses. More...

void	HAL_GFXMMU_IRQHandler (GFXMMU_HandleTypeDef *hgfxmmu)
	This function handles the GFXMMU interrupts. More...

void	HAL_GFXMMU_ErrorCallback (GFXMMU_HandleTypeDef *hgfxmmu)
	Error callback. More...

HAL_GFXMMU_StateTypeDef	HAL_GFXMMU_GetState (GFXMMU_HandleTypeDef *hgfxmmu)
	This function allows to get the current GFXMMU handle state. More...

uint32_t	HAL_GFXMMU_GetError (GFXMMU_HandleTypeDef *hgfxmmu)
	This function allows to get the current GFXMMU error code. More...

Detailed Description

This file provides firmware functions to manage the following functionalities of the Graphic MMU (GFXMMU) peripheral:

Author

MCD Application Team

Initialization and De-initialization.
LUT configuration.
Modify physical buffer adresses.
Error management.

==============================================================================
                   ##### How to use this driver #####
==============================================================================
[..]
  *** Initialization ***
  ======================
  [..]
    (#) As prerequisite, fill in the HAL_GFXMMU_MspInit() :
      (++) Enable GFXMMU clock interface with __HAL_RCC_GFXMMU_CLK_ENABLE().
      (++) If interrupts are used, enable and configure GFXMMU global
          interrupt with HAL_NVIC_SetPriority() and HAL_NVIC_EnableIRQ().
    (#) Configure the number of blocks per line, default value, physical 
        buffer addresses and interrupts using the HAL_GFXMMU_Init() function.

  *** LUT configuration ***
  =========================
  [..]
    (#) Use HAL_GFXMMU_DisableLutLines() to deactivate all LUT lines (or a
        range of lines).
    (#) Use HAL_GFXMMU_ConfigLut() to copy LUT from flash to look up RAM.
    (#) Use HAL_GFXMMU_ConfigLutLine() to configure one line of LUT.

  *** Modify physical buffer adresses ***
  =======================================
  [..]    
    (#) Use HAL_GFXMMU_ModifyBuffers() to modify physical buffer addresses.

  *** Error management ***
  ========================
  [..]
    (#) If interrupts are used, HAL_GFXMMU_IRQHandler() will be called when
        an error occurs. This function will call HAL_GFXMMU_ErrorCallback().
        Use HAL_GFXMMU_GetError() to get the error code.

  *** De-initialization ***
  =========================
  [..]    
    (#) As prerequisite, fill in the HAL_GFXMMU_MspDeInit() :
      (++) Disable GFXMMU clock interface with __HAL_RCC_GFXMMU_CLK_ENABLE().
      (++) If interrupts has been used, disable GFXMMU global interrupt with
           HAL_NVIC_DisableIRQ().
    (#) De-initialize GFXMMU using the HAL_GFXMMU_DeInit() function.

  *** Callback registration ***
  =============================
  [..]
  The compilation define USE_HAL_GFXMMU_REGISTER_CALLBACKS when set to 1
  allows the user to configure dynamically the driver callbacks.
  Use functions HAL_GFXMMU_RegisterCallback() to register a user callback.

  [..]
  Function HAL_GFXMMU_RegisterCallback() allows to register following callbacks:
    (+) ErrorCallback      : GFXMMU error.
    (+) MspInitCallback    : GFXMMU MspInit.
    (+) MspDeInitCallback  : GFXMMU MspDeInit.
  [..]
  This function takes as parameters the HAL peripheral handle, the callback ID
  and a pointer to the user callback function.

  [..]
  Use function HAL_GFXMMU_UnRegisterCallback() to reset a callback to the default
  weak (surcharged) function.
  HAL_GFXMMU_UnRegisterCallback() takes as parameters the HAL peripheral handle,
  and the callback ID.
  [..]
  This function allows to reset following callbacks:
    (+) ErrorCallback      : GFXMMU error.
    (+) MspInitCallback    : GFXMMU MspInit.
    (+) MspDeInitCallback  : GFXMMU MspDeInit.

  [..]
  By default, after the HAL_GFXMMU_Init and if the state is HAL_GFXMMU_STATE_RESET
  all callbacks are reset to the corresponding legacy weak (surcharged) functions:
  examples HAL_GFXMMU_ErrorCallback().
  Exception done for MspInit and MspDeInit callbacks that are respectively
  reset to the legacy weak (surcharged) functions in the HAL_GFXMMU_Init
  and HAL_GFXMMU_DeInit only when these callbacks are null (not registered beforehand).
  If not, MspInit or MspDeInit are not null, the HAL_GFXMMU_Init and HAL_GFXMMU_DeInit
  keep and use the user MspInit/MspDeInit callbacks (registered beforehand).

  [..]
  Callbacks can be registered/unregistered in READY state only.
  Exception done for MspInit/MspDeInit callbacks that can be registered/unregistered
  in READY or RESET state, thus registered (user) MspInit/DeInit callbacks can be used
  during the Init/DeInit.
  In that case first register the MspInit/MspDeInit user callbacks
  using HAL_GFXMMU_RegisterCallback before calling HAL_GFXMMU_DeInit
  or HAL_GFXMMU_Init function.

  [..]
  When the compilation define USE_HAL_GFXMMU_REGISTER_CALLBACKS is set to 0 or
  not defined, the callback registering feature is not available
  and weak (surcharged) callbacks are used.

Attention

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_gfxmmu.c.

Functions

Detailed Description

© Copyright (c) 2017 STMicroelectronics. All rights reserved.