lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_gfxmmu.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32h7xx_hal_gfxmmu.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of GFXMMU HAL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under BSD 3-Clause license,
  13   * the "License"; You may not use this file except in compliance with the
  14   * License. You may obtain a copy of the License at:
  15   *                        opensource.org/licenses/BSD-3-Clause
  16   *
  17   ******************************************************************************
  18   */
  19
  20 /* Define to prevent recursive inclusion -------------------------------------*/
  21 #ifndef STM32H7xx_HAL_GFXMMU_H
  22 #define STM32H7xx_HAL_GFXMMU_H
  23
  24 #ifdef __cplusplus
  25  extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include "stm32h7xx_hal_def.h"
  30
  31 #if defined(GFXMMU)
  32
  33 /** @addtogroup STM32H7xx_HAL_Driver
  34   * @{
  35   */
  36
  37 /** @addtogroup GFXMMU
  38   * @{
  39   */
  40
  41 /* Exported types ------------------------------------------------------------*/
  42 /** @defgroup GFXMMU_Exported_Types GFXMMU Exported Types
  43   * @{
  44   */
  45
  46 /**
  47   * @brief  HAL GFXMMU states definition
  48   */
  49 typedef enum
  50 {
  51   HAL_GFXMMU_STATE_RESET = 0x00U, /*!< GFXMMU not initialized */
  52   HAL_GFXMMU_STATE_READY = 0x01U, /*!< GFXMMU initialized and ready for use */
  53 }HAL_GFXMMU_StateTypeDef;
  54
  55 /**
  56   * @brief  GFXMMU buffers structure definition
  57   */
  58 typedef struct
  59 {
  60   uint32_t Buf0Address; /*!< Physical address of buffer 0. */
  61   uint32_t Buf1Address; /*!< Physical address of buffer 1. */
  62   uint32_t Buf2Address; /*!< Physical address of buffer 2. */
  63   uint32_t Buf3Address; /*!< Physical address of buffer 3. */
  64 }GFXMMU_BuffersTypeDef;
  65
  66 /**
  67   * @brief  GFXMMU cache and pre-fetch structure definition
  68   */
  69 typedef struct
  70 {
  71   FunctionalState Activation;          /*!< Cache and pre-fetch enable/disable.
  72                                             @note: All following parameters are usefull only if cache and pre-fetch are enabled. */
  73   uint32_t        CacheLock;           /*!< Locking the cache to a buffer.
  74                                             This parameter can be a value of @ref GFXMMU_CacheLock. */
  75   uint32_t        CacheLockBuffer;     /*!< Buffer on which the cache is locked.
  76                                             This parameter can be a value of @ref GFXMMU_CacheLockBuffer.
  77                                             @note: Usefull only when lock of the cache is enabled. */
  78   uint32_t        CacheForce;          /*!< Forcing the cache regardless MPU attributes.
  79                                             This parameter can be a value of @ref GFXMMU_CacheForce.
  80                                             @note: Usefull only when lock of the cache is enabled. */
  81   uint32_t        OutterBufferability; /*!< Bufferability of an access generated by the GFXMMU cache.
  82                                             This parameter can be a value of @ref GFXMMU_OutterBufferability. */
  83   uint32_t        OutterCachability;   /*!< Cachability of an access generated by the GFXMMU cache.
  84                                             This parameter can be a value of @ref GFXMMU_OutterCachability. */
  85   uint32_t        Prefetch;            /*!< Pre-fetch enable/disable.
  86                                             This parameter can be a value of @ref GFXMMU_Prefetch. */
  87 }GFXMMU_CachePrefetchTypeDef;
  88
  89 /**
  90   * @brief  GFXMMU interrupts structure definition
  91   */
  92 typedef struct
  93 {
  94   FunctionalState Activation;     /*!< Interrupts enable/disable */
  95   uint32_t        UsedInterrupts; /*!< Interrupts used.
  96                                        This parameter can be a values combination of @ref GFXMMU_Interrupts.
  97                                        @note: Usefull only when interrupts are enabled. */
  98 }GFXMMU_InterruptsTypeDef;
  99
 100 /**
 101   * @brief  GFXMMU init structure definition
 102   */
 103 typedef struct
 104 {
 105   uint32_t                    BlocksPerLine; /*!< Number of blocks of 16 bytes per line.
 106                                                   This parameter can be a value of @ref GFXMMU_BlocksPerLine. */
 107   uint32_t                    DefaultValue;  /*!< Value returned when virtual memory location not physically mapped. */
 108   GFXMMU_BuffersTypeDef       Buffers;       /*!< Physical buffers addresses. */
 109   GFXMMU_CachePrefetchTypeDef CachePrefetch; /*!< Cache and pre-fetch parameters. */
 110   GFXMMU_InterruptsTypeDef    Interrupts;    /*!< Interrupts parameters. */
 111 }GFXMMU_InitTypeDef;
 112
 113 /**
 114   * @brief  GFXMMU handle structure definition
 115   */
 116 #if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
 117 typedef struct __GFXMMU_HandleTypeDef
 118 #else
 119 typedef struct
 120 #endif
 121 {
 122   GFXMMU_TypeDef          *Instance; /*!< GFXMMU instance */
 123   GFXMMU_InitTypeDef      Init;      /*!< GFXMMU init parameters */
 124   HAL_GFXMMU_StateTypeDef State;     /*!< GFXMMU state */
 125   __IO uint32_t           ErrorCode; /*!< GFXMMU error code */
 126 #if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
 127   void (*ErrorCallback)     (struct __GFXMMU_HandleTypeDef *hgfxmmu); /*!< GFXMMU error callback */
 128   void (*MspInitCallback)   (struct __GFXMMU_HandleTypeDef *hgfxmmu); /*!< GFXMMU MSP init callback */
 129   void (*MspDeInitCallback) (struct __GFXMMU_HandleTypeDef *hgfxmmu); /*!< GFXMMU MSP de-init callback */
 130 #endif
 131 }GFXMMU_HandleTypeDef;
 132
 133 /**
 134   * @brief  GFXMMU LUT line structure definition
 135   */
 136 typedef struct
 137 {
 138   uint32_t LineNumber;        /*!< LUT line number.
 139                                    This parameter must be a number between Min_Data = 0 and Max_Data = 1023. */
 140   uint32_t LineStatus;        /*!< LUT line enable/disable.
 141                                    This parameter can be a value of @ref GFXMMU_LutLineStatus. */
 142   uint32_t FirstVisibleBlock; /*!< First visible block on this line.
 143                                    This parameter must be a number between Min_Data = 0 and Max_Data = 255. */
 144   uint32_t LastVisibleBlock;  /*!< Last visible block on this line.
 145                                    This parameter must be a number between Min_Data = 0 and Max_Data = 255. */
 146   int32_t  LineOffset;        /*!< Offset of block 0 of the current line in physical buffer.
 147                                    This parameter must be a number between Min_Data = -4080 and Max_Data = 4190208.
 148                                    @note: Line offset has to be computed with the following formula:
 149                                           LineOffset = [(Blocks already used) - (1st visible block)]*BlockSize. */
 150 }GFXMMU_LutLineTypeDef;
 151
 152 #if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
 153 /**
 154   * @brief  GFXMMU callback ID enumeration definition
 155   */
 156 typedef enum
 157 {
 158   HAL_GFXMMU_ERROR_CB_ID     = 0x00U, /*!< GFXMMU error callback ID */
 159   HAL_GFXMMU_MSPINIT_CB_ID   = 0x01U, /*!< GFXMMU MSP init callback ID */
 160   HAL_GFXMMU_MSPDEINIT_CB_ID = 0x02U  /*!< GFXMMU MSP de-init callback ID */
 161 }HAL_GFXMMU_CallbackIDTypeDef;
 162
 163 /**
 164   * @brief  GFXMMU callback pointer definition
 165   */
 166 typedef void (*pGFXMMU_CallbackTypeDef)(GFXMMU_HandleTypeDef *hgfxmmu);
 167 #endif
 168
 169 /**
 170   * @}
 171   */
 172 /* End of exported types -----------------------------------------------------*/
 173
 174 /* Exported constants --------------------------------------------------------*/
 175 /** @defgroup GFXMMU_Exported_Constants GFXMMU Exported Constants
 176   * @{
 177   */
 178
 179 /** @defgroup GFXMMU_BlocksPerLine GFXMMU blocks per line
 180   * @{
 181   */
 182 #define GFXMMU_256BLOCKS 0x00000000U     /*!< 256 blocks of 16 bytes per line */
 183 #define GFXMMU_192BLOCKS GFXMMU_CR_192BM /*!< 192 blocks of 16 bytes per line */
 184 /**
 185   * @}
 186   */
 187
 188 /** @defgroup GFXMMU_CacheLock GFXMMU cache lock
 189   * @{
 190   */
 191 #define GFXMMU_CACHE_LOCK_DISABLE 0x00000000U  /*!< Cache not locked to a buffer */
 192 #define GFXMMU_CACHE_LOCK_ENABLE  GFXMMU_CR_CL /*!< Cache locked to a buffer */
 193 /**
 194   * @}
 195   */
 196
 197 /** @defgroup GFXMMU_CacheLockBuffer GFXMMU cache lock buffer
 198   * @{
 199   */
 200 #define GFXMMU_CACHE_LOCK_BUFFER0 0x00000000U     /*!< Cache locked to buffer 0 */
 201 #define GFXMMU_CACHE_LOCK_BUFFER1 GFXMMU_CR_CLB_0 /*!< Cache locked to buffer 1 */
 202 #define GFXMMU_CACHE_LOCK_BUFFER2 GFXMMU_CR_CLB_1 /*!< Cache locked to buffer 2 */
 203 #define GFXMMU_CACHE_LOCK_BUFFER3 GFXMMU_CR_CLB   /*!< Cache locked to buffer 3 */
 204 /**
 205   * @}
 206   */
 207
 208 /** @defgroup GFXMMU_CacheForce GFXMMU cache force
 209   * @{
 210   */
 211 #define GFXMMU_CACHE_FORCE_DISABLE 0x00000000U  /*!< Caching not forced */
 212 #define GFXMMU_CACHE_FORCE_ENABLE  GFXMMU_CR_FC /*!< Caching forced */
 213 /**
 214   * @}
 215   */
 216
 217 /** @defgroup GFXMMU_OutterBufferability GFXMMU outter bufferability
 218   * @{
 219   */
 220 #define GFXMMU_OUTTER_BUFFERABILITY_DISABLE 0x00000000U  /*!< No bufferable */
 221 #define GFXMMU_OUTTER_BUFFERABILITY_ENABLE  GFXMMU_CR_OB /*!< Bufferable */
 222 /**
 223   * @}
 224   */
 225
 226 /** @defgroup GFXMMU_OutterCachability GFXMMU outter cachability
 227   * @{
 228   */
 229 #define GFXMMU_OUTTER_CACHABILITY_DISABLE 0x00000000U  /*!< No cachable */
 230 #define GFXMMU_OUTTER_CACHABILITY_ENABLE  GFXMMU_CR_OC /*!< Cachable */
 231 /**
 232   * @}
 233   */
 234
 235 /** @defgroup GFXMMU_Prefetch GFXMMU pre-fetch
 236   * @{
 237   */
 238 #define GFXMMU_PREFETCH_DISABLE GFXMMU_CR_PD /*!< Pre-fetch disable */
 239 #define GFXMMU_PREFETCH_ENABLE  0x00000000U  /*!< Pre-fetch enable */
 240 /**
 241   * @}
 242   */
 243
 244 /** @defgroup GFXMMU_Interrupts GFXMMU interrupts
 245   * @{
 246   */
 247 #define GFXMMU_AHB_MASTER_ERROR_IT GFXMMU_CR_AMEIE /*!< AHB master error interrupt */
 248 #define GFXMMU_BUFFER0_OVERFLOW_IT GFXMMU_CR_B0OIE /*!< Buffer 0 overflow interrupt */
 249 #define GFXMMU_BUFFER1_OVERFLOW_IT GFXMMU_CR_B1OIE /*!< Buffer 1 overflow interrupt */
 250 #define GFXMMU_BUFFER2_OVERFLOW_IT GFXMMU_CR_B2OIE /*!< Buffer 2 overflow interrupt */
 251 #define GFXMMU_BUFFER3_OVERFLOW_IT GFXMMU_CR_B3OIE /*!< Buffer 3 overflow interrupt */
 252 /**
 253   * @}
 254   */
 255
 256 /** @defgroup GFXMMU_Error_Code GFXMMU Error Code
 257   * @{
 258   */
 259 #define GFXMMU_ERROR_NONE             0x00000000U    /*!< No error */
 260 #define GFXMMU_ERROR_BUFFER0_OVERFLOW GFXMMU_SR_B0OF /*!< Buffer 0 overflow */
 261 #define GFXMMU_ERROR_BUFFER1_OVERFLOW GFXMMU_SR_B1OF /*!< Buffer 1 overflow */
 262 #define GFXMMU_ERROR_BUFFER2_OVERFLOW GFXMMU_SR_B2OF /*!< Buffer 2 overflow */
 263 #define GFXMMU_ERROR_BUFFER3_OVERFLOW GFXMMU_SR_B3OF /*!< Buffer 3 overflow */
 264 #define GFXMMU_ERROR_AHB_MASTER       GFXMMU_SR_AMEF /*!< AHB master error */
 265 #if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
 266 #define GFXMMU_ERROR_INVALID_CALLBACK 0x00000100U    /*!< Invalid callback error */
 267 #endif
 268 /**
 269   * @}
 270   */
 271
 272 /** @defgroup GFXMMU_LutLineStatus GFXMMU LUT line status
 273   * @{
 274   */
 275 #define GFXMMU_LUT_LINE_DISABLE 0x00000000U     /*!< LUT line disabled */
 276 #define GFXMMU_LUT_LINE_ENABLE  GFXMMU_LUTxL_EN /*!< LUT line enabled */
 277 /**
 278   * @}
 279   */
 280
 281 /** @defgroup GFXMMU_CacheForceParam GFXMMU cache force parameter
 282   * @{
 283   */
 284 #define GFXMMU_CACHE_FORCE_FLUSH      GFXMMU_CCR_FF /*!< Force cache flush */
 285 #define GFXMMU_CACHE_FORCE_INVALIDATE GFXMMU_CCR_FI /*!< Force cache invalidate */
 286 /**
 287   * @}
 288   */
 289
 290 /**
 291   * @}
 292   */
 293 /* End of exported constants -------------------------------------------------*/
 294
 295 /* Exported macros -----------------------------------------------------------*/
 296 /** @defgroup GFXMMU_Exported_Macros GFXMMU Exported Macros
 297  * @{
 298  */
 299
 300 /** @brief  Reset GFXMMU handle state.
 301   * @param  __HANDLE__ GFXMMU handle.
 302   * @retval None
 303   */
 304 #if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
 305 #define __HAL_GFXMMU_RESET_HANDLE_STATE(__HANDLE__) do{                                               \
 306                                                         (__HANDLE__)->State = HAL_GFXMMU_STATE_RESET; \
 307                                                         (__HANDLE__)->MspInitCallback = NULL;         \
 308                                                         (__HANDLE__)->MspDeInitCallback = NULL;       \
 309                                                       } while(0)
 310 #else
 311 #define __HAL_GFXMMU_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_GFXMMU_STATE_RESET)
 312 #endif
 313
 314 /**
 315   * @}
 316   */
 317 /* End of exported macros ----------------------------------------------------*/
 318
 319 /* Exported functions --------------------------------------------------------*/
 320 /** @addtogroup GFXMMU_Exported_Functions GFXMMU Exported Functions
 321   * @{
 322   */
 323
 324 /** @addtogroup GFXMMU_Exported_Functions_Group1 Initialization and de-initialization functions
 325   * @{
 326   */
 327 /* Initialization and de-initialization functions *****************************/
 328 HAL_StatusTypeDef HAL_GFXMMU_Init(GFXMMU_HandleTypeDef *hgfxmmu);
 329 HAL_StatusTypeDef HAL_GFXMMU_DeInit(GFXMMU_HandleTypeDef *hgfxmmu);
 330 void HAL_GFXMMU_MspInit(GFXMMU_HandleTypeDef *hgfxmmu);
 331 void HAL_GFXMMU_MspDeInit(GFXMMU_HandleTypeDef *hgfxmmu);
 332 #if (USE_HAL_GFXMMU_REGISTER_CALLBACKS == 1)
 333 /* GFXMMU callbacks register/unregister functions *****************************/
 334 HAL_StatusTypeDef HAL_GFXMMU_RegisterCallback(GFXMMU_HandleTypeDef        *hgfxmmu,
 335                                               HAL_GFXMMU_CallbackIDTypeDef CallbackID,
 336                                               pGFXMMU_CallbackTypeDef      pCallback);
 337 HAL_StatusTypeDef HAL_GFXMMU_UnRegisterCallback(GFXMMU_HandleTypeDef        *hgfxmmu,
 338                                                 HAL_GFXMMU_CallbackIDTypeDef CallbackID);
 339 #endif
 340 /**
 341   * @}
 342   */
 343
 344 /** @addtogroup GFXMMU_Exported_Functions_Group2 Operations functions
 345   * @{
 346   */
 347 /* Operation functions ********************************************************/
 348 HAL_StatusTypeDef HAL_GFXMMU_ConfigLut(GFXMMU_HandleTypeDef *hgfxmmu,
 349                                        uint32_t FirstLine,
 350                                        uint32_t LinesNumber,
 351                                        uint32_t Address);
 352
 353 HAL_StatusTypeDef HAL_GFXMMU_DisableLutLines(GFXMMU_HandleTypeDef *hgfxmmu,
 354                                              uint32_t FirstLine,
 355                                              uint32_t LinesNumber);
 356
 357 HAL_StatusTypeDef HAL_GFXMMU_ConfigLutLine(GFXMMU_HandleTypeDef *hgfxmmu, GFXMMU_LutLineTypeDef *lutLine);
 358
 359 HAL_StatusTypeDef HAL_GFXMMU_ConfigForceCache(GFXMMU_HandleTypeDef *hgfxmmu, uint32_t ForceParam);
 360
 361 HAL_StatusTypeDef HAL_GFXMMU_ModifyBuffers(GFXMMU_HandleTypeDef *hgfxmmu, GFXMMU_BuffersTypeDef *Buffers);
 362
 363 HAL_StatusTypeDef HAL_GFXMMU_ModifyCachePrefetch(GFXMMU_HandleTypeDef *hgfxmmu,
 364                                                  GFXMMU_CachePrefetchTypeDef *CachePrefetch);
 365
 366 void HAL_GFXMMU_IRQHandler(GFXMMU_HandleTypeDef *hgfxmmu);
 367
 368 void HAL_GFXMMU_ErrorCallback(GFXMMU_HandleTypeDef *hgfxmmu);
 369 /**
 370   * @}
 371   */
 372
 373 /** @defgroup GFXMMU_Exported_Functions_Group3 State functions
 374   * @{
 375   */
 376 /* State function *************************************************************/
 377 HAL_GFXMMU_StateTypeDef HAL_GFXMMU_GetState(GFXMMU_HandleTypeDef *hgfxmmu);
 378
 379 uint32_t HAL_GFXMMU_GetError(GFXMMU_HandleTypeDef *hgfxmmu);
 380 /**
 381   * @}
 382   */
 383
 384 /**
 385   * @}
 386   */
 387 /* End of exported functions -------------------------------------------------*/
 388
 389 /* Private macros ------------------------------------------------------------*/
 390 /** @defgroup GFXMMU_Private_Macros GFXMMU Private Macros
 391 * @{
 392 */
 393 #define IS_GFXMMU_BLOCKS_PER_LINE(VALUE) (((VALUE) == GFXMMU_256BLOCKS) || \
 394                                           ((VALUE) == GFXMMU_192BLOCKS))
 395
 396 #define IS_GFXMMU_BUFFER_ADDRESS(VALUE) (((VALUE) & 0xFU) == 0U)
 397
 398 #define IS_GFXMMU_CACHE_LOCK(VALUE) (((VALUE) == GFXMMU_CACHE_LOCK_DISABLE) || \
 399                                      ((VALUE) == GFXMMU_CACHE_LOCK_ENABLE))
 400
 401 #define IS_GFXMMU_CACHE_LOCK_BUFFER(VALUE) (((VALUE) == GFXMMU_CACHE_LOCK_BUFFER0) || \
 402                                             ((VALUE) == GFXMMU_CACHE_LOCK_BUFFER1) || \
 403                                             ((VALUE) == GFXMMU_CACHE_LOCK_BUFFER2) || \
 404                                             ((VALUE) == GFXMMU_CACHE_LOCK_BUFFER3))
 405
 406 #define IS_GFXMMU_CACHE_FORCE(VALUE) (((VALUE) == GFXMMU_CACHE_FORCE_DISABLE) || \
 407                                       ((VALUE) == GFXMMU_CACHE_FORCE_ENABLE))
 408
 409 #define IS_GFXMMU_OUTTER_BUFFERABILITY(VALUE) (((VALUE) == GFXMMU_OUTTER_BUFFERABILITY_DISABLE) || \
 410                                                ((VALUE) == GFXMMU_OUTTER_BUFFERABILITY_ENABLE))
 411
 412 #define IS_GFXMMU_OUTTER_CACHABILITY(VALUE) (((VALUE) == GFXMMU_OUTTER_CACHABILITY_DISABLE) || \
 413                                              ((VALUE) == GFXMMU_OUTTER_CACHABILITY_ENABLE))
 414
 415 #define IS_GFXMMU_PREFETCH(VALUE) (((VALUE) == GFXMMU_PREFETCH_DISABLE) || \
 416                                    ((VALUE) == GFXMMU_PREFETCH_ENABLE))
 417
 418 #define IS_GFXMMU_INTERRUPTS(VALUE) (((VALUE) & 0x1FU) != 0U)
 419
 420 #define IS_GFXMMU_LUT_LINE(VALUE) ((VALUE) < 1024U)
 421
 422 #define IS_GFXMMU_LUT_LINES_NUMBER(VALUE) (((VALUE) > 0U) && ((VALUE) <= 1024U))
 423
 424 #define IS_GFXMMU_LUT_LINE_STATUS(VALUE) (((VALUE) == GFXMMU_LUT_LINE_DISABLE) || \
 425                                           ((VALUE) == GFXMMU_LUT_LINE_ENABLE))
 426
 427 #define IS_GFXMMU_LUT_BLOCK(VALUE) ((VALUE) < 256U)
 428
 429 #define IS_GFXMMU_LUT_LINE_OFFSET(VALUE) (((VALUE) >= -4080) && ((VALUE) <= 4190208))
 430
 431 #define IS_GFXMMU_CACHE_FORCE_ACTION(VALUE) (((VALUE) == GFXMMU_CACHE_FORCE_FLUSH) || \
 432                                              ((VALUE) == GFXMMU_CACHE_FORCE_INVALIDATE) || \
 433                                              ((VALUE) == (GFXMMU_CACHE_FORCE_FLUSH | GFXMMU_CACHE_FORCE_INVALIDATE)))
 434 /**
 435   * @}
 436   */
 437 /* End of private macros -----------------------------------------------------*/
 438
 439 /**
 440   * @}
 441   */
 442
 443 /**
 444   * @}
 445   */
 446 #endif /* GFXMMU */
 447 #ifdef __cplusplus
 448 }
 449 #endif
 450
 451 #endif /* STM32H7xx_HAL_GFXMMU_H */
 452
 453 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/