STM32CubeF7/Projects/STM32F7308-DISCO/Applications/Display/LCD_PicturesFromUSB
Ali Labbene 3600603267 Release v1.15.0 2019-08-05 13:14:59 +01:00
..
EWARM Release v1.15.0 2019-08-05 13:14:59 +01:00
Inc Release v1.15.0 2019-08-05 13:14:59 +01:00
MDK-ARM Release v1.15.0 2019-08-05 13:14:59 +01:00
SW4STM32 Release v1.15.0 2019-08-05 13:14:59 +01:00
Src Release v1.15.0 2019-08-05 13:14:59 +01:00
readme.txt Release v1.15.0 2019-08-05 13:14:59 +01:00

readme.txt

/**
  @page LCD_PicturesFromUSB LCD pictures from USBapplication
  
  @verbatim
  ******************************************************************************
  * @file    Display/LCD_PicturesFromUSB/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the LCD pictures from USB card application.
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; Copyright (c) 2018 STMicroelectronics.
  * All rights reserved.</center></h2>
  *
  * This software component is licensed by ST under Ultimate Liberty license
  * SLA0044, the "License"; You may not use this file except in compliance with
  * the License. You may obtain a copy of the License at:
  *                             www.st.com/SLA0044
  *
  ******************************************************************************
   @endverbatim

@par Application Description

This application describes how to display pictures on LCD saved under USB disk.
In this application, the code is executed from QSPI external memory while data are 
in internal SRAM memory.

Prior to starting the application, the user has to create a "/Media" directory under the USB disk 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 240x240.
     pixel format : RGB565
     file name    : up to 7 characters
 
@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, USB 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 discovery 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 USB memory space.

  The following steps are performed to scroll all the images stored in the 
  USB disk :
 
  Step1 :
  ------
  The image copied from USB disk to LCD frame buffer located in PSRAM memory. The
  image is the displayed when the lCD memory is refreshed.
  Each image is displayed 2 seconds
 
  Step2 :
  ------
  When all image are displayed, the image counter is reset and the images are
  displayed again.
      
@note 
  => If the "Media" directory is empty, a warning message is displayed on 
     the 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... "

   
@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<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_PicturesFromUSB/Inc/main.h                             Main configuration file
    - Display/LCD_PicturesFromUSB/Inc/stm32f7xx_it.h                     Interrupt handlers header file
    - Display/LCD_PicturesFromUSB/Inc/stm32f7xx_hal_conf.h               HAL Configuration file 
    - Display/LCD_PicturesFromUSB/Inc/ffconf.h                           FAT file system module configuration file
    - Display/LCD_PicturesFromUSB/Inc/fatfs_storage.h                    Header for fatfs_storage.c
    - Display/LCD_PicturesFromUSB/Inc/lcd_log_conf.h                     LCD log configuration file
    - Display/LCD_PicturesFromUSB/Src/usbh_diskio.h                      USB diskio interface header file  
    - Display/LCD_PicturesFromUSB/Inc/usbh_conf.h                        USB Host driver Configuration file    
    - Display/LCD_PicturesFromUSB/Src/main.c                             Main program 
    - Display/LCD_PicturesFromUSB/Src/fatfs_storage.c                    Storage (FatFs) driver
    - Display/LCD_PicturesFromUSB/Src/file_operations.c                  Write/read file on the disk
    - Display/LCD_PicturesFromUSB/Src/usbh_diskio.c                      USB diskio interface for FatFs 
    - Display/LCD_PicturesFromUSB/Src/usbh_conf.c                        General low level driver configuration
    - Display/LCD_PicturesFromUSB/Src/stm32f7xx_it.c                     Interrupt handlers
    - Display/LCD_PicturesFromUSB/Src/system_stm32f7xx.c                 STM32F7xx system clock configuration file


@par Hardware and Software environment  

  - This application runs on STM32F730xx devices.
    
  - This application has been tested with STMicroelectronics STM32F7308-DISCO
    board and can be easily tailored to any other supported device 
    and development board.
    
  - STM32F7308-DISCO Set-up
    - Plug the USB key into the STM32F7308-DISCO board through 'USB micro A-Male 
      to A-Female' cable (HS mode: connector CN19).
    - USB_HS jumper should be fitted on CN8 connector.


@par How to use it ?

In order to make the program work, you must do the following :

  1. The bitmap images, available under ".Media/" 
     should be copied inside a  dedicated directory named "Media" at USB key root.
     The images should have the following properties:
       file type    : *.bmp
       resolution   : up to 240x240
       pixel format : RGB565    

  2. Select required configuration in memory.h in Templates\ExtMem_Boot\Inc.
  3. Program the internal Flash with the ExtMem_Boot (see below).
  4. Program the external QSPI memory with this application (see below).
  5. Start debugging user application or reset for free running.

In order to load the ExtMem_Boot code :
   - Open your preferred toolchain :
      - Open the Project
      - Rebuild all files
      - Load project image

In order to load this application to the external memory:
   - Open your preferred toolchain
      - Open the Project
      - Rebuild all files:
      - Run & debug the program:
      - For an XiP configuration (eXecute in Place from QSPI):
          - Using EWARM or MDK-ARM : Load project image from the IDE: Project->Debug
          - Using SW4STM32 :
            - Open the STM32CubeProgrammer tool
            - Select the QSPI external flash loader "MX25L512G_STM32F7308-DISCO"
            - From Erasing & Programming menu, browse and open the output binary file relative to your application
            - Load the file into the external QSPI flash using "Start Programming" at the address APPLICATION_ADDRESS (0x90000000)
                
 * <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */