The following document contains information on Cypress products.

Transcription

1 The following document contains information on Cypress products.

2 TEMPLATE PROJECT USAGE 32-BIT MICROCONTROLLER FM3 Family APPLICATION NOTE Publication Number FM3_AN v0-E Revision 1.0 Issue Date November 29, 2013

3 2 FM3_AN v0-E, November 29, 2013

4 Target products This application note is described about below products; (TYPE0) Series MB9B500B MB9B400A MB9B300B MB9B100A Product Number (not included Package suffix) MB9BF504NB,MB9BF505NB,MB9BF506NB MB9BF504RB,MB9BF505RB,MB9BF506RB MB9BF404NA,MB9BF405NA,MB9BF406NA MB9BF404RA,MB9BF405RA,MB9BF406RA MB9BF304NB,MB9BF305NB,MB9BF306NB MB9BF304RB,MB9BF305RB,MB9BF306RB MB9BF102NA,MB9BF104NA,MB9BF105NA,MB9BF106NA MB9BF102RA,MB9BF104RA,MB9BF105RA,MB9BF106RA (TYPE1) MB9A310A MB9A110A Series Product Number (not included Package suffix) MB9AF311LA, MB9AF311MA, MB9AF311NA, MB9AF312LA MB9AF312MA, MB9AF312NA, MB9AF314LA, MB9AF314MA MB9AF314NA, MB9AF315MA, MB9AF315NA, MB9AF316MA MB9AF316NA MB9AF111LA, MB9AF111MA, MB9AF111NA, MB9AF112LA MB9AF112MA, MB9AF112NA, MB9AF114LA, MB9AF114MA MB9AF114NA, MB9AF115MA, MB9AF115NA, MB9AF116MA MB9AF116NA (TYPE2) Series MB9BD10T MB9B610T MB9B510T MB9B410T MB9B310T MB9B210T MB9B110T Product Number (not included Package suffix) MB9BFD16T, MB9BFD16S, MB9BFD17T, MB9BFD17S, MB9BFD18T MB9BFD18S MB9BF616T, MB9BF616S, MB9BF617T, MB9BF617S, MB9BF618T MB9BF618S MB9BF516T, MB9BF516S, MB9BF517T, MB9BF517S, MB9BF518T MB9BF518S MB9BF416T, MB9BF416S, MB9BF417T, MB9BF417S, MB9BF418T MB9BF418S MB9BF316T, MB9BF316S, MB9BF317T, MB9BF317S, MB9BF318T MB9BF318S MB9BF216T, MB9BF216S, MB9BF217T, MB9BF217S, MB9BF218T MB9BF218S MB9BF116T, MB9BF116S, MB9BF117T, MB9BF117S, MB9BF118T MB9BF118S (TYPE3) Series MB9A130LA Product Number (not included Package suffix) MB9AF131LA, MB9AF131KA, MB9AF132LA, MB9AF132KA November 29, 2013, FM3_AN v0-E 3

5 (TYPE4) Series MB9B510R MB9B410R MB9B310R MB9B110R Product Number (not included Package suffix) MB9BF512N, MB9BF512R, MB9BF514N, MB9BF514R, MB9BF515N MB9BF515R, MB9BF516N, MB9BF516R MB9BF412N, MB9BF412R, MB9BF414N, MB9BF414R, MB9BF415N MB9BF415R, MB9BF416N, MB9BF416R MB9BF312N, MB9BF312R, MB9BF314N, MB9BF314R, MB9BF315N MB9BF315R, MB9BF316N, MB9BF316R MB9BF112N, MB9BF112R, MB9BF114N, MB9BF114R, MB9BF115N MB9BF115R, MB9BF116N, MB9BF116R (TYPE5) MB9A310K MB9A110K Series MB9AF311K, MB9AF312K MB9AF111K, MB9AF112K Product Number (not included Package suffix) (TYPE6) Series MB9AB40NA MB9AA40NA MB9A340NA MB9A140NA Product Number (not included Package suffix) MB9AFB41LA, MB9AFB41MA, MB9AFB41NA, MB9AFB42LA MB9AFB42MA, MB9AFB42NA, MB9AFB44LA, MB9AFB44MA MB9AFB44NA MB9AFA41LA, MB9AFA41MA, MB9AFA41NA, MB9AFA42LA MB9AFA42MA, MB9AFA42NA, MB9AFA44LA, MB9AFA44MA MB9AFA44NA MB9AF341LA, MB9AF341MA, MB9AF341NA, MB9AF342LA MB9AF342MA, MB9AF342NA, MB9AF344LA, MB9AF344MA MB9AF344NA MB9AF141LA, MB9AF141MA, MB9AF141NA, MB9AF142LA MB9AF142MA, MB9AF142NA, MB9AF144LA, MB9AF144MA MB9AF144NA (TYPE7) MB9AA30N MB9A130N Series Product Number (not included Package suffix) MB9AFA31L, MB9AFA31M, MB9AFA31N, MB9AFA32L MB9AFA32M, MB9AFA32N MB9AF131M, MB9AF131N, MB9AF132M, MB9AF132N (TYPE8) MB9A150R Series Product Number (not included Package suffix) MB9AF154M, MB9AF154N, MB9AF154R, MB9AF155M MB9AF155N, MB9AF155R, MB9AF156M, MB9AF156N MB9AF156R 4 FM3_AN v0-E, November 29, 2013

6 (TYPE9) Series MB9B520M MB9B320M MB9B120M Product Number (not included Package suffix) MB9BF521K, MB9BF521L, MB9BF521M, MB9BF522K, MB9BF522L MB9BF522M, MB9BF524K, MB9BF524L, MB9BF524M MB9BF321K, MB9BF321L, MB9BF321M, MB9BF322K, MB9BF322L MB9BF322M, MB9BF324K, MB9BF324L, MB9BF324M MB9BF121K, MB9BF121L, MB9BF121M, MB9BF122K, MB9BF122L MB9BF122M, MB9BF124K, MB9BF124L, MB9BF124M November 29, 2013, FM3_AN v0-E 5

7 Table of Contents 1. Introduction Download of Template Project File Configuration of Template Project Template Project Usage Initialization Setting in Template Project FM3_AN v0-E, November 29, 2013

8 1. Introduction This application note explains the template project for FM3. The template project has an empty main() function, also containing basic settings such as clock and watchdog settings. The template project for FM3 includes the project for the ARM development tool MDK-ARM and the project for the IAR Systems (hereinafter called IAR) development tool EWARM, respectively. The template project is useful at the starting of the development, You can jump-start your software development without deep knowledge of the tool. This application note assumes that you use MB9B500 series template project. But even when you use other series', the file configuration, usage, and so on are the same. Only few setting values and file name are partially different. November 29, 2013, FM3_AN v0-E 7

9 2. Download of Template Project This chapter explains how to get the template project. 1. Download the template project that you want to use from the following URL. 8 FM3_AN v0-E, November 29, 2013

10 November 29, 2013, FM3_AN v0-E 9

11 3. File Configuration of Template Project This chapter explains file configuration of the template project. 1. When decompressing data of the template project, the following folder configuration is provided. 2. In each folder, the following files are included. - Common folder Folder that has the IO definitions and common source codes written in C Language. - ARM folder Project folder for ARM development tool MDK-ARM. 10 FM3_AN v0-E, November 29, 2013

12 - IAR folder A P P L I C A T I O N N O T E Project folder for IAR development tool EWARM. - Source folder Folder that has the main function source code and header file. 3. When the project is opened after MDK-ARM or EWARM starts, a set of the following files is displayed in the project window. - In the case of MDK-ARM November 29, 2013, FM3_AN v0-E 11

13 - In the case of EWARM Note: Files enclosed in a red frame are included in the EWARM installation directory and automatically organized when the workspace is displayed. Take note that these files are not included when the template project is deployed. 12 FM3_AN v0-E, November 29, 2013

14 4. Template Project Usage This chapter explains the usage method of the template project. 1. Choosing the build configuration Template projects are held together in one file per each series. Therefore, choosing the configuration according to the user intention is necessary. Choosing the build configuration affects the following items. - Flash memory and RAM size When choosing from 504 to 506, the flash memory and RAM size change. See the hardware manual for actual sizes. - Storage location of program code For the project with Debug at the end, store the program code to RAM. For the project with Release at the end, store the program code to flash memory. - Definition of the symbol When Debug and Release are chosen, the definition of the symbol is changed. In the Release configuration, the preprocessor symbol, NDEBUG, is defined. When defining the NDEBUG symbol, the assert code is not included. 2. Build configuration choosing method. Two choosing methods for the configuration are provided, which are a) and b) in the following section. - In the case of MDK-ARM a) Select [Project] - [Manage] - [Components, Environment, Books] menu and choose in the dialog. November 29, 2013, FM3_AN v0-E 13

15 b) Select from the list box in the work space window. - In the case of EWARM a) Select [Project] - [Edit configurations] menu and choose from the configuration dialog. 14 FM3_AN v0-E, November 29, 2013

16 b) Choose from the list box in the Workspace window. November 29, 2013, FM3_AN v0-E 15

17 5. Initialization Setting in Template Project This section explains the file configuration of the template project. 1. Initial setting at Startup In the template project, startup program executes the following initializing processing. Correct the following values if needed. - Register initialization startup_mb9bf50x.s 124th line LDR R0, =SystemInit Use a value defined in system_mb9bf50x.h in a function SystemInit() in startup_mb9bf50x.c and initialize the register. - RAM initialization startup_mb9bf50x.s 126th line LDR R0, = iar_program_start The following processes are executed in the library iar_program_start. - RAM initialization - Copying to actual RAM See the library manual for details. 2. Register initialization in system_mb9bf50x.h The initial value is defined as follows in system_mb9bf50x.h. Correct the following values if needed. Incidentally, see the peripheral manual or the data sheet for details of setting values of different models. - Valid/Invalid setting of clock setting 109th line #define CLOCK_SETUP 1 // <<< Define clock setup here 1: Validates the clock setting (default) 0: Invalidates the clock setting - Main clock (CLKMO) setting 16 FM3_AN v0-E, November 29, 2013

18 116th line #define CLKMO ( UL) // <<< External 4MHz Crystal Set within the range from CLKMOMIN to CLKMOMAX. - Sub clock (CLKSO) setting 123rd line #define CLKSO ( 32768UL) // <<< External 32KHz Crystal Set within the range from CLKSOMIN to CLKSOMAX. - System clock mode control register (SCM_CTL) setting 158th line #define SCM_CTL_Val 0x // <<< Define SCM_CTL here Valid only when CLOCK_SETUP is 1 - Base clock prescaler register (BSC_PSR) setting 179th line #define BSC_PSR_Val 0x // <<< Define BSC_PSR here Valid only when CLOCK_SETUP is 1 - APB0 prescaler register (APBC0_PSR) setting 196th line #define APBC0_PSR_Val 0x // <<< Define APBC0_PSR here Valid only when CLOCK_SETUP is 1 - APB1 prescaler register (APBC1_PSR) setting 223rd line #define APBC1_PSR_Val 0x // <<< Define APBC1_PSR here Valid only when CLOCK_SETUP is 1 November 29, 2013, FM3_AN v0-E 17

19 - APB2 prescaler register (APBC2_PSR) setting 250th line #define APBC2_PSR_Val 0x // <<< Define APBC2_PSR here Valid only when CLOCK_SETUP is 1 - Software watchdog clock prescaler register (SWC_PSR) setting 271st line #define SWC_PSR_Val 0x // <<< Define SWC_PSR here Valid only when CLOCK_SETUP is 1 - Trace clock prescaler register (TTC_PSR) setting 286th line #define TTC_PSR_Val 0x // <<< Define TTC_PSR here Valid only when CLOCK_SETUP is 1 - Clock stabilization wait time register (CSW_TMR) setting 325th line #define CSW_TMR_Val 0x C // <<< Define CSW_TMR here Valid only when CLOCK_SETUP is 1 - PLL clock stabilization wait time setting register (PSW_TMR) setting 352nd line #define PSW_TMR_Val 0x // <<< Define PSW_TMR here Valid only when CLOCK_SETUP is 1 - PLL control register 1 (PLL_CTL1) setting 375th line #define PLL_CTL1_Val 0x // <<< Define PLL_CTL1 here Valid only when CLOCK_SETUP is 1 18 FM3_AN v0-E, November 29, 2013

20 - PLL control register 2 (PLL_CTL2) setting 393rd line #define PLL_CTL2_Val 0x // <<< Define PLL_CTL2 here Valid only when CLOCK_SETUP is 1 - Hardware watchdog valid/invalid setting 403rd line #define HWWD_DISABLE 1 // <<< Define HW Watach dog enable here 1: Validates watchdog setting 0: Invalidates watchdog setting - CR trimming valid/invalid setting 413th line #define CR_TRIM_SETUP 1 // <<< Define CR trimming at startup enable here 1: Validates CR trimming setting 0: Invalidates CR trimming setting 3. Change prohibition item in system_mb9bf50x.h The following section defines the device-dependent system clock setting range. Do not change these values. If the user changed these values, the program may not operate properly. - High speed CR clock (CLKHC) setting 432nd line #define CLKHC ( UL) /* Internal 4MHz CR Oscillator */ Set the high speed CR clock to 4 MHz. - Low speed CR clock (CLKLC) setting 439th line #define CLKLC ( UL) /* Internal 100KHz CR Oscillator */ November 29, 2013, FM3_AN v0-E 19

21 Set the low speed CR clock to 100 KHz. - Main clock minimum value setting 446th line #define CLKMOMIN ( UL) Set the main clock minimum value to 4 MHz. - Main clock maximum value setting 453rd line #define CLKMOMAX ( UL) Set the main clock maximum value to 48 MHz. - Sub clock minimum value setting 460th line #define CLKSOMIN ( 32000UL) Set the sub clock minimum value to 32 KHz. - Sub clock maximum value setting 467th line #define CLKSOMAX ( UL) Set the sub clock maximum value to 100 KHz. - PLL internal frequency minimum value setting 474th line #define PLLCLKINMIN ( UL) Set the PLL internal frequency minimum value to 4 MHz. - PLL internal frequency maximum value setting 481st line #define PLLCLKINMAX ( UL) 20 FM3_AN v0-E, November 29, 2013

22 Set the PLL internal frequency maximum value to 30 MHz. - PLL oscillation frequency minimum value setting 488th line #define PLLCLKMIN ( UL) Set the PLL oscillating frequency minimum value to 60 MHz. - PLL oscillation frequency maximum value setting 495th line #define PLLCLKMAX ( UL) Set the PLL oscillating frequency maximum value to 120 MHz. - Base clock (HCLK) maximum value setting 502nd line #define HCLKMAX ( UL) Set the maximum value of base clock to 80 MHz. * The minimum value is 0. November 29, 2013, FM3_AN v0-E 21

23 Spansion Application Note AN v0-E FM3 Family 32-BIT MICROCONTROLLER TEMPLATE PROJECT USAGE Published: Spansion Inc. Edited: Marketing Communications Dept. November 2013 Rev FM3_AN v0-E, November 29, 2013

24 Colophon The products described in this document are designed, developed and manufactured as contemplated for general use, including without limitation, ordinary industrial use, general office use, personal use, and household use, but are not designed, developed and manufactured as contemplated (1) for any use that includes fatal risks or dangers that, unless extremely high safety is secured, could have a serious effect to the public, and could lead directly to death, personal injury, severe physical damage or other loss (i.e., nuclear reaction control in nuclear facility, aircraft flight control, air traffic control, mass transport control, medical life support system, missile launch control in weapon system), or (2) for any use where chance of failure is intolerable (i.e., submersible repeater and artificial satellite). Please note that Spansion will not be liable to you and/or any third party for any claims or damages arising in connection with above-mentioned uses of the products. Any semiconductor devices have an inherent chance of failure. You must protect against injury, damage or loss from such failures by incorporating safety design measures into your facility and equipment such as redundancy, fire protection, and prevention of over-current levels and other abnormal operating conditions. If any products described in this document represent goods or technologies subject to certain restrictions on export under the Foreign Exchange and Foreign Trade Law of Japan, the US Export Administration Regulations or the applicable laws of any other country, the prior authorization by the respective government entity will be required for export of those products. Trademarks and Notice The contents of this document are subject to change without notice. This document may contain information on a Spansion product under development by Spansion. Spansion reserves the right to change or discontinue work on any product without notice. The information in this document is provided as is without warranty or guarantee of any kind as to its accuracy, completeness, operability, fitness for particular purpose, merchantability, non-infringement of third-party rights, or any other warranty, express, implied, or statutory. Spansion assumes no liability for any damages of any kind arising out of the use of the information in this document. Copyright 2013 Spansion Inc. All rights reserved. Spansion, the Spansion logo, MirrorBit, MirrorBit Eclipse TM, ORNAND TM and combinations thereof, are trademarks and registered trademarks of Spansion LLC in the United States and other countries. Other names used are for informational purposes only and may be trademarks of their respective owners. November 29, 2013, FM3_AN v0-E 23