STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_hal_gfxmmu.h File Reference

Header file of GFXMMU HAL module. More...

Go to the source code of this file.

Data Structures

struct  GFXMMU_BuffersTypeDef
 GFXMMU buffers structure definition. More...
 
struct  GFXMMU_InterruptsTypeDef
 GFXMMU interrupts structure definition. More...
 
struct  GFXMMU_InitTypeDef
 GFXMMU init structure definition. More...
 
struct  endif
 ADC handle Structure definition. More...
 
struct  GFXMMU_LutLineTypeDef
 GFXMMU LUT line structure definition. More...
 

Typedefs

typedef struct __GFXMMU_HandleTypeDef else typedef struct endif GFXMMU_HandleTypeDef
 GFXMMU handle structure definition. More...
 
typedef void(* pGFXMMU_CallbackTypeDef) (GFXMMU_HandleTypeDef *hgfxmmu)
 GFXMMU callback pointer definition. More...
 

Enumerations

enum  HAL_GFXMMU_CallbackIDTypeDef { HAL_GFXMMU_ERROR_CB_ID = 0x00U, HAL_GFXMMU_MSPINIT_CB_ID = 0x01U, HAL_GFXMMU_MSPDEINIT_CB_ID = 0x02U }
 GFXMMU callback ID enumeration definition. 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...
 

Variables

 C
 

Detailed Description

Header file of GFXMMU HAL module.

Author
MCD Application Team
Attention

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

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.h.


Data Structure Documentation

◆ GFXMMU_BuffersTypeDef

struct GFXMMU_BuffersTypeDef

GFXMMU buffers structure definition.

Definition at line 58 of file stm32l4xx_hal_gfxmmu.h.

Data Fields
uint32_t Buf0Address

Physical address of buffer 0.

uint32_t Buf1Address

Physical address of buffer 1.

uint32_t Buf2Address

Physical address of buffer 2.

uint32_t Buf3Address

Physical address of buffer 3.

◆ GFXMMU_InterruptsTypeDef

struct GFXMMU_InterruptsTypeDef

GFXMMU interrupts structure definition.

Definition at line 69 of file stm32l4xx_hal_gfxmmu.h.

Data Fields
FunctionalState Activation

Interrupts enable/disable

uint32_t UsedInterrupts

Interrupts used. This parameter can be a values combination of GFXMMU interrupts.

Note
: Usefull only when interrupts are enabled.

◆ GFXMMU_InitTypeDef

struct GFXMMU_InitTypeDef

GFXMMU init structure definition.

Definition at line 80 of file stm32l4xx_hal_gfxmmu.h.

Data Fields
uint32_t BlocksPerLine

Number of blocks of 16 bytes per line. This parameter can be a value of GFXMMU blocks per line.

GFXMMU_BuffersTypeDef Buffers

Physical buffers addresses.

uint32_t DefaultValue

Value returned when virtual memory location not physically mapped.

GFXMMU_InterruptsTypeDef Interrupts

Interrupts parameters.

◆ GFXMMU_LutLineTypeDef

struct GFXMMU_LutLineTypeDef

GFXMMU LUT line structure definition.

Definition at line 112 of file stm32l4xx_hal_gfxmmu.h.

Data Fields
uint32_t FirstVisibleBlock

First visible block on this line. This parameter must be a number between Min_Data = 0 and Max_Data = 255.

uint32_t LastVisibleBlock

Last visible block on this line. This parameter must be a number between Min_Data = 0 and Max_Data = 255.

uint32_t LineNumber

LUT line number. This parameter must be a number between Min_Data = 0 and Max_Data = 1023.

int32_t LineOffset

Offset of block 0 of the current line in physical buffer. This parameter must be a number between Min_Data = -4080 and Max_Data = 4190208.

Note
: Line offset has to be computed with the following formula: LineOffset = [(Blocks already used) - (1st visible block)]*BlockSize.
uint32_t LineStatus

LUT line enable/disable. This parameter can be a value of GFXMMU LUT line status.

Typedef Documentation

◆ GFXMMU_HandleTypeDef

typedef struct __GFXMMU_HandleTypeDef else typedef struct endif GFXMMU_HandleTypeDef

GFXMMU handle structure definition.

◆ pGFXMMU_CallbackTypeDef

typedef void(* pGFXMMU_CallbackTypeDef) (GFXMMU_HandleTypeDef *hgfxmmu)

GFXMMU callback pointer definition.

Definition at line 142 of file stm32l4xx_hal_gfxmmu.h.

Enumeration Type Documentation

◆ HAL_GFXMMU_CallbackIDTypeDef

GFXMMU callback ID enumeration definition.

Enumerator
HAL_GFXMMU_ERROR_CB_ID 

GFXMMU error callback ID

HAL_GFXMMU_MSPINIT_CB_ID 

GFXMMU MSP init callback ID

HAL_GFXMMU_MSPDEINIT_CB_ID 

GFXMMU MSP de-init callback ID

Definition at line 132 of file stm32l4xx_hal_gfxmmu.h.

Variable Documentation

◆ C

C
Initial value:
{
#endif
#if defined(GFXMMU)
typedef enum
{
HAL_GFXMMU_STATE_RESET = 0x00U,
HAL_GFXMMU_STATE_READY = 0x01U,
}HAL_GFXMMU_StateTypeDef
This file contains HAL common defines, enumeration, macros and structures definitions.