git.gag.com Git - fw/stlink/blob - example/stm32f4/Projects/IO_Toggle/readme.txt

   1 /**
   2   @page GPIO_IOToggle GPIO IO Toggle example
   3
   4   @verbatim
   5   ******************** (C) COPYRIGHT 2011 STMicroelectronics *******************
   6   * @file    IO_Toggle/readme.txt
   7   * @author  MCD Application Team
   8   * @version V1.0.0
   9   * @date    19-September-2011
  10   * @brief   Description of the GPIO IO Toggle example.
  11   ******************************************************************************
  12   * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
  13   * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
  14   * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
  15   * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
  16   * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
  17   * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  18   ******************************************************************************
  19    @endverbatim
  20
  21 @par Example Description
  22
  23 This example describes how to toggle the GPIO pins connected on AHB bus.
  24
  25 PD12, PD13, PD14 and PD15 (configured in output pushpull mode) toggles in a forever loop.
  26  - Set PD12, PD13, PD14 and PD15 by setting corresponding bits in BSRRL register
  27  - Reset PD12, PD13, PD14 and PD15  by setting corresponding bits in BSRRH register
  28
  29 In this example, HCLK is configured at 168 MHz.
  30
  31 @par Directory contents
  32
  33   - IO_Toggle/stm32f4xx_conf.h    Library Configuration file
  34   - IO_Toggle/stm32f4xx_it.c      Interrupt handlers
  35   - IO_Toggle/stm32f4xx_it.h      Interrupt handlers header file
  36   - IO_Toggle/main.c              Main program
  37   - IO_Toggle/system_stm32f4xx.c  STM32F4xx system source file
  38
  39 @par Hardware and Software environment
  40
  41   - This example runs on STM32F4xx Devices Revision A.
  42
  43   - This example has been tested with STM32F4-Discovery (MB997) RevA and can be
  44     easily tailored to any other development board
  45
  46   - STM32F4-Discovery
  47     - LED4, LED3, LED5 and LED6 are connected respectively to PD.12, PD.13, PD.14 and PD.15.
  48
  49
  50 @par How to use it ?
  51
  52 In order to make the program work, you must do the following :
  53
  54  + EWARM
  55     - Open the IO_Toggle.eww workspace
  56     - Rebuild all files: Project->Rebuild all
  57     - Load project image: Project->Debug
  58     - Run program: Debug->Go(F5)
  59
  60  + MDK-ARM
  61     - Open the IO_Toggle.uvproj project
  62     - Rebuild all files: Project->Rebuild all target files
  63     - Load project image: Debug->Start/Stop Debug Session
  64     - Run program: Debug->Run (F5)
  65
  66  + TASKING
  67     - Open TASKING toolchain.
  68     - Click on File->Import, select General->'Existing Projects into Workspace'
  69       and then click "Next".
  70     - Browse to  TASKING workspace directory and select the project "IO_Toggle"
  71     - Rebuild all project files: Select the project in the "Project explorer"
  72       window then click on Project->build project menu.
  73     - Run program: Select the project in the "Project explorer" window then click
  74       Run->Debug (F11)
  75
  76  + TrueSTUDIO
  77     - Open the TrueSTUDIO toolchain.
  78     - Click on File->Switch Workspace->Other and browse to TrueSTUDIO workspace
  79       directory.
  80     - Click on File->Import, select General->'Existing Projects into Workspace'
  81       and then click "Next".
  82     - Browse to the TrueSTUDIO workspace directory and select the project "IO_Toggle"
  83     - Rebuild all project files: Select the project in the "Project explorer"
  84       window then click on Project->build project menu.
  85     - Run program: Select the project in the "Project explorer" window then click
  86       Run->Debug (F11)
  87
  88
  89
  90  * <h3><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h3>
  91  */