STM32CubeF7/Projects/STM32F769I_EVAL/Applications/Display/LCD_PicturesFromSDCard
Tasnim 767d083e20 Release v1.17.2 2024-06-06 15:48:41 +01:00
..
EWARM Release v1.16.2 2021-12-14 09:57:38 +01:00
Inc Release v1.17.2 2024-06-06 15:48:41 +01:00
MDK-ARM Release v1.16.2 2021-12-14 09:57:38 +01:00
SW4STM32 Release v1.17.2 2024-06-06 15:48:41 +01:00
Src Release v1.17.2 2024-06-06 15:48:41 +01:00
readme.txt Release v1.16.2 2021-12-14 09:57:38 +01:00

readme.txt

/**
  @page LCD_PicturesFromSDCard LCD pictures from SD card application

  @verbatim
  ******************************************************************************
  * @file    Display/LCD_PicturesFromSDCard/readme.txt
  * @author  MCD Application Team
  * @brief   Description of the LCD pictures from SD card application.
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2016 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.
  *
  ******************************************************************************
  @endverbatim

@par Application Description

This application describes how to display pictures on LCD saved under SD card.

Prior to starting the application, the user has to create a "/Media" directory under the micro SD card root and
copy the pictures stored in PC directory "Utilities/Media/Pictures".
    The images should have the following properties:
     file type    : *.bmp
     resolution   : up to 800x480.
     pixel format : RGB565, RGB888 or ARGB8888

@note : The user can add pictures of his choice but the file type, resolution
        and pixel format described below must be respected.

  Once the LCD, SD card and file systems initialized and configured,
  a content check of the "Media" directory is done and the number of ".BMP" files
  is retained.

@note : An associate LCD eval driver is used in this application

@note : The maximum number of BMP files is fixed to 25. It can be raised
        until reaching the maximum of SD card memory space.

  The following steps are performed to scroll all the images stored in the
  SD Card :

  Step1 :
  ------
  The foreground layer is set, the image copied from SD card to intermediate. SDRAM
  memory and then copied to LCD frame buffer. The image is fully visible when the
  level of transparency is increased until it becomes totally opaque (reaches 255).
  The  display of next image is set after 1 s

  Step2 :
  ------
  The transparency of the foreground layer begins to decrease after 10 ms until
  becoming totally transparent and the background layer is set, the image copied
  from SD card to intermediate SDRAM memory and then copied to LCD frame buffer
  and finally the level of transparency of the background layer increases until
  it reaches 255 (totally opaque).
  The  display of next image is set after 1 s

  Step3 :
  ------
  The transparency of the background layer begins to decrease after 10 ms until
  becoming totally transparent and return to step1

@note the system clock (SYSCLK) is configured to run at 200 MHz and 50 MHz is provided
      at the output PLL divided by PLL_Q. This frequency permits to reach 25 MHz clock
      needed for SD operation and in line with microSD specification.

@note
  => If the "Media" directory is empty, a warning message is displayed on
     the LCD : "  No Bitmap files...  "

  => If no SD card is detected, a warning message is displayed on LCD : " No Bitmap files..."

  => If the file type stored in the "Media" directory is not supported,
     a warning message is displayed on the LCD : " No Bitmap files... "

  => If the SD card is removed while running the application, no warning message
     is displayed on the LCD. A reset is needed.

@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
      based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
      a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
      than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
      To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.

@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.

@note The STM32F7xx devices can reach a maximum clock frequency of 216MHz but as this application uses SDRAM,
      the system clock is limited to 200MHz. Indeed proper functioning of the SDRAM is only guaranteed
      at a maximum system clock frequency of 200MHz.

-  LED3 is ON when the uSD disk I/O driver is not Linked;

@par Keywords

Graphic, Display, LCD, Pictures, SD Card, BMP, RGB565, RGB888, ARGB8888

@Note<74>If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
 <20><><A0><A0><A0>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
<0A><><A0><A0><A0><A0>The address and the size of cacheable buffers (shared between CPU and other masters)  must be properly updated to be aligned to cache line size (32 bytes).

@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
<0A><><A0><A0><A0> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
<0A><><A0><A0><A0><A0>In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
<0A><><A0><A0><A0><A0>Even though the user must manage the cache coherence for read accesses.
<0A><><A0><A0><A0><A0>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
<0A><><A0><A0><A0><A0>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>

@par Directory contents

    - Display/LCD_PicturesFromSDCard/Inc/main.h                             Main configuration file
    - Display/LCD_PicturesFromSDCard/Inc/stm32f7xx_it.h                     Interrupt handlers header file
    - Display/LCD_PicturesFromSDCard/Inc/stm32f7xx_hal_conf.h               HAL Configuration file
    - Display/LCD_PicturesFromSDCard/Inc/ffconf.h                           FAT file system module configuration file
    - Display/LCD_PicturesFromSDCard/Inc/fatfs_storage.h                    Header for fatfs_storage.c
    - Display/LCD_PicturesFromSDCard/Inc/sd_diskio.h                        Header for FatFS sd diskio driver
    - Display/LCD_PicturesFromSDCard/Src/main.c                             Main program
    - Display/LCD_PicturesFromSDCard/Src/fatfs_storage.c                    Storage (FatFs) driver
    - Display/LCD_PicturesFromSDCard/Inc/sd_diskio.h                        FatFS SD diskio driver implementation
    - Display/LCD_PicturesFromSDCard/Src/stm32f7xx_it.c                     Interrupt handlers
    - Display/LCD_PicturesFromSDCard/Src/system_stm32f7xx.c                 STM32F7xx system clock configuration file


@par Hardware and Software environment

  - This application runs on STM32F769xx/STM32F779xx devices.

  - This application has been tested with STMicroelectronics STM32F769I-EVAL
    evaluation boards and can be easily tailored to any other supported device
    and development board.

  - STM32F769I-EVAL Set-up
    - Insert a SD card into CN17 connector


@par How to use it ?

In order to make the program work, you must do the following :
 - The bitmap images, available under ".Media/"
   should be copied inside a  dedicated directory named "Media" at the micro SD card root.
   The images should have the following properties:
     file type    : *.bmp
     resolution   : up to 800x480
     pixel format : RGB565, RGB888 or ARGB8888
 - Open your preferred toolchain
 - Rebuild all files and load your image into target memory
 - Run the application


 */