STM32CubeF4/Projects/STM32446E_EVAL/Examples/QSPI/QSPI_MemoryMapped/readme.txt

/**
  @page QSPI_MemoryMapped QSPI memory mapped example
  
  @verbatim
  ******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
  * @file    QSPI/QSPI_MemoryMapped/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the QSPI memory mapped mode example.
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2017 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 Example Description

How to use a QSPI memory in memory-mapped mode.

This example describes how to erase a part of a QSPI memory, write data in DMA mode and access the QSPI memory 
in memory-mapped mode to check the data in an infinite loop.

LED1 toggles each time the data have been checked
LED3 is on as soon as a data is wrong
LED3 toggles as soon as an error is returned by HAL API

In this example, HCLK is configured at 180 MHz.
QSPI CLKDIV is set to 1, so QSPI frequency is = 180 MHz/(1+1) = 90MHz for Write
and Read operations.

@note  In order to account for external signal delays, SampleShifting parameter should be set to
       HALFCYCLE. This bit allows the data is to be sampled correctly at 90MHZ. Otherwise
       Read operation will not work at frequency greater than 60MHz.
 
@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 need to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.

@par Keywords

Memory, QUADSPI, Erase, Write, DMA, sector, memory-mapped mode

@par Directory contents 

  - QSPI/QSPI_MemoryMapped/Inc/stm32f4xx_hal_conf.h HAL configuration file
  - QSPI/QSPI_MemoryMapped/Inc/stm32f4xx_it.h       Interrupt handlers header file
  - QSPI/QSPI_MemoryMapped/Inc/main.h               Header for main.c module  
  - QSPI/QSPI_MemoryMapped/Src/stm32f4xx_it.c       Interrupt handlers
  - QSPI/QSPI_MemoryMapped/Src/main.c               Main program
  - QSPI/QSPI_MemoryMapped/Src/system_stm32f4xx.c   STM32F4xx system source file
  - QSPI/QSPI_MemoryMapped/Src/stm32f4xx_hal_msp.c  HAL MSP file    

@par Hardware and Software environment

  - This example runs on STM32F446xx devices.
    
  - This example has been tested with STM32446E-EVAL board and can be
    easily tailored to any other supported device and development board.

  - STM32446E-EVAL Set-up :
     Make sure that board is configured for QuadSPI memory interface as 
      described in MB1162_UM.pdf

@par How to use it ? 

In order to make the program work, you must do the following :
 - Open your preferred toolchain
 - Rebuild all files and load your image into target memory
 - Run the example


 */