Home

TR0131 ARM Embedded Tools Reference

1. 0x0000001f APPLICATION MODE_ system sw linear 0x00000134 main 0x00000f34 Exit 0x00000f38 _START 4o JE ISI ICICI ICSI IOC IIIA kkk Processor and Memory abr ak k i k A k A k A R e A R k e A e A E e A E A R I TI IKI FE IIIS Ae AE E e e e e k e R Ae e E e e A A E A E IOI A k L oca te Ru T es AAAA e e k A k e E R e k e a A e A A R e k Ae k Ae E R R R A A I E A E R K K K system sw linear absolute 0x00000020 _vector_0 338 system sw linear contiguous stack_fiq 315 stack_irq 316 stack_svc 317 stack_abt 318 stack_und 319 system sw linear clustered data libc 65 system sw linear clustered data libc 322 system sw linear unrestricted text cstart 296 system sw linear unrestricted rodata 5 system sw linear unrestricted table 321 system sw linear unrestricted stack 314 Hoenn nnn nnn nnn ne ne nn ne nnn ne nnn nnn nnn nn nn nn nn nn nn ee The meaning of the different parts is Tool and Invocation This part of the map file contains information about the linker its version header information binary location and which options are used to call it Used Resources This part of the map file shows the memory usage at memory level and space level The largest free block of memory Largest gap is also shown This part also contains an es
2. File From archive Symbol causing the extraction cstart obj carm lib _START hello obj printf obj carm lib printf fon ion 8 2 8 8 5 ARM Embedded Tools Reference JE ICI ICI ICI EEE EEEE EEEE IOI ICIS EFCC Tink ReSU toad dada nE EEEE EEE EEEE EEEE EEE CI ICICI CI I ICICI CR RII IA RR IIA hello obj text 2 0x00000018 0x00000000 text 2 0x00000018 SSSR SS SS cstart obj text cstart 296 0x000000d0 0x00000000 text cstart 296 0x000000d0 BSS SS SS SS ESS SSS SS SS SS SS printf obj text libc 57 0x0000004c 0x00000000 text 1ibc 57 0x0000004c tonne nn 5 5 5 5 nn nn nn nnn nnn 55 55 55 FEI ICI IOI III IIT TOR IIR IIIT TISAI ISAT IS III K IISA IKI IK IIIA Module Local Symbols Scope hello c Name Space addr Space hello c 0x0 rodata 0x0000111c system sw linear rodata 0x00001118 text 0x00000134 text 0x00000108 KAKARAKA KKA KAKA III AKARAK IOI IDC DIG COCCHI Cross References Frnt Definition file Definition section Symbol Referenced in cstart obj text cstart 296 _START printf obj text libe 57 printf hello obj a Undefined symbols HAIR IK RI
3. Type Oper Name Description ator parenthesis Expressions enclosed by parenthesis are evaluated first Unary plus Returns the value of its operand minus Returns the negative of its operand complement Returns complement integer only logical negate Returns 1 if the operands value is 0 otherwise 0 For example if buf is 0 then buf is 1 Arithmetic multiplication Yields the product of two operands division Yields the quotient of the division of the first operand by the second With integers the divide operation produces a truncated integer modulo Integer only yields the remainder from a division of the first operand by the second addition Yields the sum of its operands subtraction Yields the difference of its operands Shift lt lt shift left Integer only shifts the left operand to the left zero filled by the number of bits specified by the right operand gt gt shift right Integer only shifts the left operand to the right sign bit extended by the number of bits specified by the right operand Relational lt less than lt less or equal Returns gt greater than an integer 1 if the indicated condition is TRUE gt greater or equal an integer 0 if the indicated condition is FALSE equal l not equal Bitwise amp AND Integer only yields bitwise AND OR Integer only yields bitwise OR i exclusive OR Integer only yields bitwise exlusive OR Logical amp amp logical AND Returns an int
4. reserved myreserved size 2k attributes rw fill Oxaa If you do not specify any attributes the linker will reserve the given number of maus no matter what type of memory lies beneath If you do not specify a fill pattern no section is generated The linker creates two labels to mark the begin and end of the section _1c_ub_name for the start and_1c_ue_name for the end of the reserved section Output sections The keyword section tells the linker to accumulate sections obtained from object files input sections into an output section of a fixed size in the locate phase You can select the input sections with select statements You can use groups inside output sections but you can only set the align attributes and load_addr attributes The fi11 field contains a bit pattern that the linker writes to all unused space in the output section When all input sections have an image code data you must specify a fill pattern If you do not specify a fill pattern all input sections must be scratch sections The fill pattern is aligned at the start of the output section As with a reserved section you can use the attributes field to set the access type of the output section group section myoutput size 4k attributes rw fill 0Oxaa select myinputl1 select myinput2 The available room for input sections is determined by the size blocksize and overflow fields With the ke
5. 0 0 cece eects 3 2 3 4 Symbol NAMES miria sna Pe ee ele wees cbhe adds a ono eked ea a 3 2 3 4 1 Predefined Preprocessor Symbols 0 00 cece eect eee eens 3 3 3 5 FREQISIONS oeer cierna Riek Gon ered wie atau Dap ee Gaited eee eha ge er eee en 4 3 3 3 6 Assembly Expressions serce i200 nadace aet shbadeded nh ndewsnndal mein deeded e aa 3 3 3 6 1 Numeric Constants 4 2306034 weece ea ae eis pn Cae Kd Senedd ms eee Oe RE Sas 3 4 3 6 2 SWINGS haste aoe ced eee ee ie eee a yee Ril cae a RU we cede a eek 3 4 3 6 3 Expression Operators sass goad eta ntadooad date Seeded aed Mendig acts wee ha eens 3 4 3 7 Built in Assembly Functions 0 0 cece eee eee ett eens 3 5 3 7 1 Overview of Built in Assembly Functions 0 0 eeunenn renea 3 5 3 7 2 Detailed Description of Built in Assembly Functions 0 cece eee eee eee es 3 6 3 8 Assembler Directives iisa2 o0is vert poi daw we aha tan sin Oe aoe Ea 3 9 3 8 1 Overview of Assembler Directives 0 teens 3 9 3 8 2 Detailed Description of Assembler Directives 00 0 cece eee ees 3 11 3 9 Macro Operations 20 cece tener nent eens 3 46 3 9 1 Detining a Macro 2 6cqche ug dete cate dain Aaa ad tli tannin de oy dob eae tect 3 46 3 9 2 Calling a Macro s siori nesi enie abies nt dene tended E E Ragu ai wens E E E A EEE 3 46 3 9 3 Using Operators for Macro Arguments 00 cece eeraa 3 47 3 9 4 Using the FOR and REPEAT Di
6. code for other architectures ENDIF Gb C compiler option cpu Select architecture in section 5 1 C Compiler Options of Chapter Too Options DEFINED symbol symbol Returns 1 if symbol has been defined O otherwise If symbol is quoted it is looked up as a DEFINE symbol if it is not quoted it is looked up as an ordinary symbol macro or label Example IF DEFINED ANGLE is symbol ANGLE defined IF DEFINED ANGLE does label ANGLE exist LSB expression Returns the east significant byte of the result of the expression The result of the expression is calculated as 16 bits LSH expression Returns the east significant half word bits 0 15 of the result of the absolute expression The result of the expression is calculated as a word 32 bits LSW expression Returns the east significant word bits 0 31 of the result of the expression The result of the expression is calculated as a double word 64 bits MSB expression Returns the most significant byte of the result of the expression The result of the expression is calculated as16 bits MSH expression Returns the most significant half word bits 16 31 of the result of the absolute expression The result of the expression is calculated as a word 32 bits MSH expression is equivalent to expression gt gt 16 amp Oxffff 3 7 ARM Embedded Tools Reference MSW expression Returns the most significant word
7. Command line syntax library directory dir Loir ignore default library path L Description With this option you can specify the path s where your system libraries specified with the library option are located If you want to specify multiple paths use the option library directory for each separate path The default path is PRODDIR carm 1lib If you specify only L without a pathname or the long option ignore default library path the linker will not search the default path and also not in the paths specified in the environment variable LIBARM So the linker ignores steps 2 and 3 as listed below The priority order in which the linker searches for system libraries specified with the library option is 1 The path that is specified with the library directory option 2 The path that is specified in the environment variable LIBARM 3 The default directory PRODDIR carm 1lib or a processor specific sub directory Example Suppose you call the linker as follows lkarm test obj library directory c mylibs library carm First the linker looks in the directory c mylibs for library carm lib this option If it does not find the requested libraries it looks in the directory that is set with the environment variable LIBARM Then the linker looks in the default directory PRODDIR carm 1ib for libraries Related information d gt Linker option library Link system library Section 5 4 1 How t
8. Related information i 5 170 Tool Options Make Utility Make Utility a Command line syntax a Description Normally the make utility rebuilds only those files that are out of date With this option you tell the make utility to rebuild all files without checking whether they are out of date Example tmk a Rebuilds all your files regardless of whether they are out of date or not Related information J 5 171 ARM Embedded Tools Reference Make Utility c Command line syntax c Description Altium Designer uses this option for the graphical version of the make utility when you create sub projects In this case the make utility calls another instance of the make utility for the sub project With the option c the make utility runs as a child process of the current make The option c overrules the option err Example tmk c The make utility runs its commands as a child processes Related information J 5 172 Tool Options Make Utility Make Utility D DD Command line syntax D DD Description With the option D the make utility prints every line of the makefile to standard output as it is read by tmk With the option DD not only the lines of the makefile are printed but also the lines of the tmk mk file implicit rules Example tmk D Each line of the makefile that is read by the make utility is printed to standard output usually your screen Related inform
9. int outvar void increment int invar _ asm add 0 1 1 r outvar O invar Generated assembly increment type func add r0 r0 1 ldr r1 L2 str r0 xr1 0 bx lr size add32 add32 align 4 L2 dw outvar ARM Embedded Tools Reference 1 5 Pragmas to Control the Compiler Pragmas are keywords in the C source that control the behavior of the compiler Pragmas overrule compiler options For example you can set a compiler option to specify which optimizations the compiler should perform With the pragma optimize flags you can set an optimization level for a specific part of the C source This overrules the general optimization level that is set in the C compiler Optimization page in the Project Options dialog command line option optimize O The general syntax for pragmas is pragma pragma spec ON OFF DEFAULT RESTORE or _Pragma pragma spec ON OFF DEFAULT RESTORE Pragmas marked with accept the following special arguments default set the pragma to the initial value restore restore the previous value of the pragma Pragmas marked with are boolean flags and accept the following arguments on switch the flag on same as without argument off switch the flag off The compiler recognizes the following pragmas other pragmas are ignored alias symbol defined_symbol Define symbol as an alias for definined_symbol It corresponds to an equate directive equ a
10. sdata Initialized data in read write small data area data bss Uninitialized data cleared data sbss Uninitialized data in read write small data area cleared data rodata ROM data constants data debug Debug sections debug Table 3 4 Predefined section names Sections of a specified type are located by the linker in a memory space The space names are defined in a so called linker script file files with the extension 1s1 delivered with the product in the directory Program Files Altium Designer System Tasking include 1sl You can specify the following section attributes Example SECTION data Declare a data section SECTION data abs at 0x0 Declare a data abs section at an absolute address 3 38 Assembly Language SET Syntax symbol SET expression SET symbol expression Description With the SET directive you assign the value of expression to symbol temporarily If a symbol was defined with the SET directive you can redefine that symbol in another part of the assembly source using the SET directive again Symbols that you define with the SET directive are always local you cannot define the symbol global with the GLOBAL directive The SET directive is useful in establishing temporary or reusable counters within macros expression must be absolute and cannot include a symbol that is not yet defined no forward references are allowed Example COUNT SET 0 I
11. source line 3 END The assembler generates a list file with the following lines SECTION text x source line 1 LIST d source line 3 END Related information db Assembler option list file Generate list file in Section 5 2 Assembler Options of Chapter Tool Options 3 30 Assembly Language LTORG Syntax LTORG Description With this directive you force the assembler to generate a literal pool data pocket at the current location All literals from the LDR pseudo instructions except those which could be translated to MOV or MVN instructions between the previous literal pool and the current location will be assembled in a new literal pool using DW directives By default the assembler generates a literal pool at the end of a code section i e the ENDSEC directive at the end of a code section causes an implicit LTORG directive However the default literal pool may be out of reach of one or more LDR pseudo instructions in the section In that case the assembler issues an error message and you should insert LTORG directives at proper locations in the section Example section text 7 LDR r1 0x12345678 code ltorg literal pool contains the literal amp 0x12345678 endsec default literal pool is empty Related information d LDR ARM generic LDR Thumb generic 3 31 ARM Embedded Tools Reference MACRO ENDM Syntax macro_name MACRO argumeni argumenit meee de
12. 3 13 ARM Embedded Tools Reference CALLS Syntax CALLS caller callee or CALLS caller stackO_usage stack1_usage Description The first syntax creates a call graph reference between caller and callee The linker needs this information to build a call graph If applicable the call graph is used to create a static stack overlay caller and callee are names of functions The second syntax specifies stack information When callee is an empty name this means we define the stack usage of the function itself The values specified are the stack usage in bytes at the time of the call including the return address This information is used by the linker to compute the used stack within the application The information is found in the generated linker map file within the Memory Usage Normally CALLS directives are automatically generated by the compiler Use the CALLS directive in hand coded assembly when the assembly code calls a C function If you manually add CALLS directives make sure they connect to the compiler generated CALLS directives the name of the caller must also be named as a callee in another directive Example CALLS main nfunc Indicates that the function main calls the function nfunc CALLS main 8 The function main uses 8 bytes on the stack 3 14 Assembly Language CODE16 CODE32 THUMB ARM Syntax CODE16 THUMB CODE32 ARM Description Wi
13. ARM Embedded Tools Reference 19 9 R 19 10 R 19 11 R 19 12 R 19 13 A 19 14 R 19 15 R 19 16 R 19 17 R Standard libraries 20 1 R 20 2 R x 20 3 R 20 4 R 20 5 R 20 6 R 20 7 R 20 8 R 20 9 R 20 10 R 20 11 R 20 12 R Run time failures x 21 1 R Arguments to a function like macro shall not contain tokens that look like preprocessing directives A violation is reported when the first token of an actual macro argument is In the definition of a function like macro each instance of a parameter shall be enclosed in parentheses unless it is used as the operand of or All macro identifiers in preprocessor directives shall be defined before use except in ifdef and ifndef preprocessor directives and the defined operator There shall be at most one occurrence of the or preprocessor operators in a single macro definition The and preprocessor operators should not be used The defined preprocessor operator shall only be used in one of the two standard forms Precautions shall be taken in order to prevent the contents of a header file being included twice Preprocessing directives shall be syntactically meaningful even when excluded by the preprocessor All else elif and endif preprocessor directives shall reside in the same file as the if or ifdef directive to which they are related Reserved identifiers macros and functions in the standard library shall
14. END Indicates the end of an assembly module INCLUDE Include file MESSAGE Programmer generated message Overview of symbol definition directives Directive Description EQU Set permanent value to a symbol EXTERN Import global section symbol GLOBAL Declare global section symbol SECTION ENDSEC Start a new section SET Set temporary value to a symbol SIZE Set size of symbol in the ELF symbol table SOURCE Specify name of original C source file TYPE Set symbol type in the ELF symbol table WEAK Mark a symbol as weak 3 9 ARM Embedded Tools Reference Overview of data definition storage allocation directives DS DSB DSH DSW DSD FLOAT DOUBLE OFFSET Directive Description ALIGN Align location counter BS BSB BSH Define block storage initialized BSW BSD DB Define byte DH Define half word DW Define word DD Define double word Define storage Define a 32 bit 64 bit floating point constant Move location counter forwards Overview of macro and conditional assembly directives REPEAT ENDREP FOR ENDFOR IF ELIF ELSE ENDIF MACRO ENDM UNDEF Directive Description DEFINE Define substitution string BREAK Break out of current macro expansion Repeat sequence of source lines Repeat sequence of source lines n times Conditional assembly directive End of conditional assembly directive
15. In the last pass you call the linker without this option with the final linker output file out The linker will now locate the file Example In this example the files test1 obj test2 obj and test3 obj are incrementally linked 1 lkarm incremental testl obj test2 obj otest out test1 obj and test2 obj are linked 2 lkarm incremental test3 obj test out test3 obj and test out are linked task1 out is created 3 lkarm taskl out task1 out is located Related information dE Section 5 5 Incremental Linking in chapter Using the Linker of the user s manual 5 102 Tool Options Linker Linker keep output files k Menu entry Altium Designer always removes the output files when errors occurred Command line syntax keep output files k Description If an error occurs during linking the resulting output file may be incomplete or incorrect With this option you keep the generated output files when an error occurs By default the linker removes the generated output file when an error occurs This is useful when you use the make utility If the erroneous files are not removed the make utility may process corrupt files on a subsequent invocation Use this option when you still want to use the generated file For example when you know that a particular error does not result in a corrupt object file or when you want to inspect the output file or send it to Altium support Related information J 5 103 ARM
16. clock difftime t1 t0 mktime tm tp time timer Time conversion asctime tm tp ctime timer gmtime timer localtime timer Formatted time seconds after the minute 0 59 minutes after the hour 0 59 hours since midnight 0 23 day of the month 1 31 months since January 0 11 year since 1900 days since Sunday 0 6 days since January 1 0 365 Daylight Saving Time flag Returns the application s best approximation to the processor time used by the program since it was started This low level routine is not implemented because it strongly depends on the hardware To determine the time in seconds the result of clock should be divided by the value defined as CLOCKS_PER_SEC 12000000 Returns the difference t1 t0 in seconds Converts the broken down time in the structure pointed to by tp to a value of type time_t The return value has the same encoding as the return value of the time function Returns the current calendar time This value is also assigned to timer g Converts the broken down time in the structure pointed to by tp into a string in the form Mon Jan 21 16 15 14 2004 n 0 Returns a pointer to this string Converts the calender time pointed to by timer to local time in the form of a string This is equivalent to asctime localtime timer Converts the calender time pointed to by timer to the broken down time expressed a
17. cpu ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M xS C ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M XxS Description With this option you specify the ARM architecture for which you create your application The architecture determines which instructions are valid and which are not If the architecture is ARMV4 the linker replaces BX instructions by MOV PC instructions The default architecture is ARMv4T and the complete list of supported architectures is ARMv4 ARMv4T ARMV5T ARMV5TE ARMv6 M ARMv7 M or XScale Assembly code can check the value of the option by means of the built in function CPU Architecture ARMv4 does not support the Thumb instruction set Architecture profile ARMv7 M only supports the Thumb 2 instruction set i e it has no ARM execution state Related information C compiler option cpu Select architecture Assembler option cpu Select architecture 5 129 ARM Embedded Tools Reference Control Program create cl cm co cs Command line syntax create siage c stage You can specify the following stages if you omit the stage the default is create object relocatable I Stop after the files are linked to a linker object file out mil m Stop after C files are compiled to MIL mil object 0 Stop after the files are assembled to objects obj assembly s Stop after C files are compiled to assembly src Description Normally the control program generates an absolute obje
18. 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Debug Information 3 Select which debug information to include Automatic HLL or assembly level debug information Custom debug information or No debug information If you select Custom debug information 4 Select which Custom debug information to include Assembler source line information Pass HLL debug information or None 5 Enable or disable the option Assembler local symbols information Command line syntax debug info flag g flag you can set the following flags asm a A Assembly source line information hll h H Pass high level language debug information HLL local VL Assembler local symbols debug information smart s S Smart debug information Description With this option you tell the assembler which kind of debug information to emit in the object file If you do not use this option the default is debug info hll If you specify debug info without any flags the default is debug info smart You cannot specify debug info asm hll Either the assembler generates assembly source line information or it passes HLL debug information When you specify debug info smart the assembler selects which flags to use If high level language information is available in the source file the assembler passes this information same as debug info asm thll local
19. Append or move new modules after existing module name a name Append or move new modules before existing module name b name Create library without notification if library does not exist c Preserve last modified date from the library 0 Print symbols in library modules s 0 1 Replace only newer modules u Verbose vV Miscellaneous Display options Display version header V Read options from file f file Suppress warnings above level n wn Table 5 1 Overview of librarian options and suboptions 5 194 Tool Options Librarian Librarian Command line syntax Description Displays an overview of all command line options Example The following invocations display a list of the available command line options tlb tlb Related information i 5 195 ARM Embedded Tools Reference Librarian d Command line syntax d v Description Delete the specified object modules from a library With the suboption v the librarian shows which files are removed V Verbose the librarian shows which files are removed Example tlb d mylib lib objl obj obj2 obj The librarian deletes obj1 obj and obj2 obj from the library mylib lib tlb d v mylib lib objl obj obj2 obj The librarian deletes obj1 obj and obj2 obj from the library mylib 1ib and displays which files are removed Related information J 5 196 Tool Options Librarian Librarian f Command line syntax f file Descrip
20. Define macro Undefine DEFINE symbol or macro Overview of listing control assembly directives Directive Description LIST NOLIST PAGE TITLE Print do not print source lines to list file Set top of page size of page Set program title in header of assembly list file Overview of HLL directives Directive Description CALLS Pass call tree information ARM specific directives Directive Description CODE16 CODE32 THUMB ARM LTORG Treat instructions as Thumb or ARM instructions using pre UAL syntax Treat instructions as Thumb or ARM instructions using UAL syntax Assemble current literal pool immediately Assembly Language 3 8 2 Detailed Description of Assembler Directives ALIGN Syntax ALIGN expression Description With the ALIGN directive you tell the assembler to align the location counter When the assembler encounters the ALIGN directive it moves the location counter forwards to an address that is aligned as specified by expression and places the next instruction or directive on that address The alignment is in minimal addressable units MAUs The assembler fills the gap with NOP instructions If the location counter is already aligned on the specified alignment it remains unchanged The location of absolute sections will not be changed The expression must be a power of two 2 4 8 16 If you
21. Initialize or copy the vector table The startup code calls the function init _vector_table This function has a default implementation in the run time library which copies the vector table from ROM to RAM if necessary You should only change it in very specific situations For example in case position dependent vectors are used B instructions instead of LDR PC and the vector table must be generated in RAM or copied from ROM to RAM with patched offsets in the B instructions 6 Switch to the user defined application mode as defined through the symbol APPLICATION _MODE_ in the LSL file This symbol is used to set the value of the CPSR status register before calling the function main 7 Load register r10 with the end of the user system stack This is needed in case stack overflow checking is enabled 8 Switch to Thumb code if you specified compiler option thumb 9 Initialize profiling if profiling is enabled For an extensive description of profiling refer to Chapter 3 Profiling in the user s manual 10 Initialize the argc and argv arguments to zero 11 Call the entry point of your application with a call to function main ARM Embedded Tools Reference Exit code When the C application returns which is not likely to happen in an embedded environment the program ends with an endless loop at the assembly label exit When you use a debugger it can be useful to set a breakpoint on this label to indicate that the pr
22. Test if current CPU matches string DEFINED symbol symbol Test whether symbol exists LSB expr Least significant byte of the expression LSH expr Least significant half word of the absolute expression LSW expr Least significant word of the expression MSB expr Most significant byte of the expression MSH expr Most significant half word of the absolute expression MSW expr Most significant word of the expression PRE_UAL Test if the assembler runs in pre UAL syntax mode or in UAL syntax mode by default option old syntax STRCAT str1 str2 Concatenate str and str2 STRCMP strl1 str2 Compare str1 with str2 STRLEN Str Return length of string STRPOS Sstrl str2 start Return position of sir7 in str2 THUMB tet a runs in Thumb mode or in ARM mode by default option thum 3 7 2 Detailed Description of Built in Assembly Functions ALUPCREL expression group check This function is used internally by the assembler with the generic instructions ADR ADRL and ADRLL This function returns the PC relative address of the expression for use in these generic instructions group is 0 for ADR 1 for ADRL or 2 for ADRLL With check you can specify to check for overflow 1 means true 0 means false If check is omitted the default is 1 Example The instruction ADRAL R1 label expands to ADRAL R1 PC ALUPCREL label 0 1 ARG symbol expression Returns integer 1 if the macro argument repr
23. and you can specify their values in Altium Designer or on the command line with linker option define If the default run time startup code does not match your configuration you need to modify the startup code accordingly The entry point of the startup code reset handler is label START This global label should not be removed since the linker uses it in the linker script file It is also used as the default start address of the application Initialization code The following initialization actions are executed before the application starts 1 Load the real program address This assures that the reset handler is immune for any ROM RAM re mapping 2 Initialize the stack pointers for each processor mode The stack pointers are loaded in memory by the stack address located at a linker generate symbol for example _lc_ub stack These symbols are defined in the linker script file See section 4 3 Stack and Heap for detailed information on the stack 3 Call a user function which initializes hardware The startup code calls the function init _hardware This function has an empty implementation in the run time library which you should change if certain hardware initializations such as ROM RAM re mapping or MMU configuration are required before calling the main application 4 Copy initialized sections from ROM to RAM using a linker generated table also known as the copy table and clear uninitialized data sections in RAM 5
24. group page 3 8 29 ARM Embedded Tools Reference e With the priority keyword you can change the order in which sections are located This is useful when some sections are considered important for good performance of the application and a small amount of fast memory is available The value is a number for which the default is 1 so higher priorities start at 2 Sections with a higher priority are located before sections with a lower priority unless their relative locate priority is already determined by other restrictions like run_addr and page group priority 2 select importantcodel select importantcode2 8 9 3 Creating or Modifying Special Sections Instead of selecting sections you can also create a reserved section or an output section or modify special sections like a stack or a heap Because you cannot define these sections in the input files you must use the linker to create them Stack e The keyword stack tells the linker to reserve memory for the stack The name for the stack section refers to the stack as defined in the architecture definition If no name was specified in the architecture definition the default name is stack With the keyword size you can specify the size for the stack If the size is not specified the linker uses the size given by the min_size argument as defined for the stack in the architecture definition Normally the linker automatically tries to maximize the size unless y
25. library directory for each separate path By default path this is PRODDIR carm 1ib directory If you specify only L without a pathname or the long option ignore default library path the linker will not search the default path and also not in the paths specified in the environment variable LIBARM So the linker ignores steps 2 and 3 as listed below The priority order in which the linker searches for system libraries specified with the library option is 1 The path that is specified with the library directory option 2 The path that is specified in the environment variable LIBARM 3 The default directory PRODDIR carm 1lib or a processor specific sub directory Example Suppose you call the control program as follows ccarm test c library directory c mylibs library carm First the linker looks in the directory c mylibs for library carm lib this option If it does not find the requested libraries it looks in the directory that is set with the environment variable LIBARM Then the linker looks in the default directory PRODDIR carm 1ib for libraries Related information d Linker option library Link system library 5 145 ARM Embedded Tools Reference Control Program list files Command line syntax list files name Description With this option you tell the assembler via the control programma to generate a list file for each specified input file A list file shows the generated object
26. n Related information d gt Make utility option s Do not print commands before execution 5 183 ARM Embedded Tools Reference Make Utility p Command line syntax P Description Normally if a command in a target rule in a makefile returns an error or when the target construction is interrupted the make utility removes that target file With this option you tell the make utility to make all target files precious This means that dependency files are never removed Example tmk p The make utility never removes target dependency files Related information de 5 184 Tool Options Make Utility Make Utility q Command line syntax q Description With this option the make utility does not perform any tasks but only returns an exit code A zero status indicates that all target files are up to date a non zero status indicates that some or all target files are out of date Example tmk q The make utility only returns an exit code that indicates whether all target files are up to date or not It does not rebuild any files Related information J 5 185 ARM Embedded Tools Reference Make Utility r Command line syntax r Description When you call the make utility it first reads the implicit rules from the file tmk mk then it reads the makefile with the rules to build your files The file tmk mk is located in the etc directory of the toolset With this option you tell the mak
27. overview 3 9 conditional assembly overview 3 10 data definition overview 3 10 detailed description 3 11 HLL overview 3 10 listing control overview 3 10 macros overview 3 10 overview 3 9 storage allocation overview 3 10 symbol definitions overview 3 9 weak 3 45 Assembler options 5 54 5 65 case insensitive 5 55 check 5 56 cpu 5 57 debug info 5 58 define 5 59 diag 5 60 emit locals 5 61 endianness 5 62 error file 5 63 error limit 5 64 help 5 65 include directory 5 66 include file 5 67 inversions 5 68 list file 5 70 list format 5 71 no warnings 5 72 old syntax 5 73 optimize 5 74 option file 5 75 output 5 76 page length 5 77 page width 5 78 preprocess 5 79 preprocessor type 5 80 relaxed 5 81 section info 5 82 symbol scope 5 83 thumb 5 84 verbose 5 86 version 5 85 warnings as errors 5 87 B big endian 5 62 C 5 57 c 5 55 D 5 59 E 5 79 f 5 75 g 5 58 H 5 67 I 5 66 i 5 83 Index 2 k 5 69 k keep output files 5 69 L 5 71 I 5 70 m 5 80 O 5 74 0 5 76 T 5 84 t 5 82 V 5 85 V 5 86 w 5 72 debug information 5 58 5 61 diagnostics 5 64 5 72 5 87 inverse instructions 5 68 list file 5 70 5 71 5 82 optimization 5 74 preprocessing 5 59 5 67 5 79 5 80 relaxed 2 operand syntax 5 81 Thumb instructions 5 84 Assembler significant chara
28. that optimal speed is achieved The default speed is 1 The map field specifies how this memory maps onto an internal bus Mappings are described in section 8 5 4 Mappings memory mem_name type rom mau 8 size 64k speed 2 map map_description With the bus keyword you define a bus in a derivative definition Buses are described in section 8 5 2 Defining Internal Buses 8 21 ARM Embedded Tools Reference 8 7 Semantics of the Board Specification Keywords in the board specification processor derivative bus mau width map memory type reserved rom ram nvram mau size speed map map dest bus space dest_dbits dest_offset size src_dbits sre offset 8 7 1 Defining a Processor If you have a target board with multiple processors that have the same derivative you need to instantiate each individual processor in a processor definition This information tells the linker which processor has which derivative and enables the linker to distinguish between the present processors LAN If you use processors that all have a unique derivative you may omit the processor definitions In this case the linker assumes that for each derivative definition in the LSL file there is one processor The linker uses the derivative name also for the processor With the keyword processor you define a processor You can freely choose the processor name The name is used to refer to it at other places in the LSL fil
29. 1 19 __noinline 1 15 __novector 1 19 _ packed __ 1 2 __ REVISION __ 1 12 3 3 __SINGLE_FP_ 1 12 __TASKING_ 1 12 3 3 __THUMB_ 1 12 __unaligned 1 2 __ VERSION _ 1 12 3 3 _close 2 6 _Complex 2 2 _Exit 2 18 _Imaginary 2 2 _IOFBF 2 13 _IOLBF 2 13 _IONBF 2 13 _lseek 2 6 _open 2 6 _read 2 6 _START 4 1 4 2 _tolower 2 3 _unlink 2 6 _write 2 6 A abort 2 18 abs 2 19 Absolute Address 1 3 access 2 22 acos functions 2 7 acosh functions 2 7 Address spaces 8 15 alias 1 8 align 3 11 Alignment 1 2 composite types 5 3 Alignment gaps 8 28 alupcrel 3 6 Architecture definition 8 1 8 14 arg 3 6 Argument 2 3 arm 3 15 asctime 2 21 asin functions 2 7 asinh functions 2 7 Assembler directives align 3 11 arm 3 15 break 3 12 bs 3 13 bsb 3 13 bsd 3 13 bsh 3 13 bsw 3 13 calls 3 14 code16 3 15 code32 3 15 db 3 16 dd 3 17 define 3 18 dh 3 19 double 3 25 ds 3 20 dsb 3 20 dsd 3 20 dsh 3 20 dsw 3 20 dw 3 21 end 3 22 equ 3 23 extern 3 24 float 3 25 for endfor 3 26 global 3 27 iff elif else endif 3 28 include 3 29 list nolist 3 30 ltorg 3 31 macro endm 3 32 message 3 34 offset 3 35 page 3 36 repeat endrep 3 37 section 3 38 set 3 39 size 3 40 source 3 41 thumb 3 15 title 3 42 Index 1 ARM Embedded Tools Reference type 3 43 undef 3 44 ARM specific overview 3 10 assembly control
30. 5 123 w 5 123 w 5 117 diagnostics 5 117 5 125 libraries 5 104 5 115 Map File 5 111 miscellaneous 5 89 5 92 5 97 5 100 5 109 5 110 optimization 5 118 output format 5 90 Linker script file 5 108 5 109 architecture definition 8 1 board specification 8 2 bus definition 8 2 derivative definition 8 1 memory definition 8 2 preprocessing 8 3 processor definition 8 2 section layout definition 8 2 specifying 5 110 5 147 structure 8 1 List file 5 70 5 71 list nolist 3 30 llabs 2 19 IIdiv 2 19 Ilrint functions 2 8 Index 7 ARM Embedded Tools Reference llround functions 2 8 Local label override operator 3 49 localeconv 2 7 localtime 2 21 log functions 2 8 log10 functions 2 8 log1p functions 2 8 log2 functions 2 8 logb functions 2 8 Long branch veneers 5 107 longjmp 2 10 lrint functions 2 8 lround functions 2 8 Isb 3 7 Iseek 2 22 Ish 3 7 LSL expression evaluation 8 13 LSL functions absolute 8 5 addressof 8 5 exists 8 5 max 8 5 min 8 6 sizeof 8 6 LSL keywords align 8 16 8 27 alloc_allowed 8 31 allow_cross_references 8 28 architecture 8 15 8 20 attributes 8 26 8 27 blocksize 8 32 bus 8 15 8 18 8 23 clustered 8 28 contiguous 8 28 copy 8 17 8 27 copy_unit 8 16 copytable 8 16 8 32 core 8 20 derivative 8 20 8 22 dest 8 16 8 18 dest_dbits 8 18 dest_offset 8 18 direction 8 26 8 28 else 8 33 extends 8 15 8 20 fill 8 1
31. 7 2 Motorola S Record Format 0 0 ccc eect eee eens 7 2 7 3 Intel Hex Record FofmMat eri ei dane sie receu dane ee dane eiia DERE eee ee eee es 7 5 Linker Script Language 8 1 8 1 IntFOCUCTION esd ib acca tech nha ea Beetle eae ish tanta oF bie ee Rh gee eee 8 1 8 2 Structure of a Linker Script File 0 0 0 cece eee e ete aee 8 1 8 3 Syntax of the Linker Script Language 00 cece cece 8 3 8 3 1 Preprocessing iiic2 dna rich naii Wied Bae aa Ae Rad aa eee eRe oe Ae ORE OSes 8 3 8 3 2 Lexical SyMtax otic aeranta aa an doped ah aaa rna oh ethene s 8 3 Table of Contents 8 3 3 8 3 4 8 3 5 8 3 6 8 3 7 8 3 8 8 3 9 8 3 10 8 3 11 8 4 8 5 8 5 1 8 5 2 8 5 3 8 5 4 8 6 8 6 1 8 6 2 8 6 3 8 7 8 7 1 8 7 2 8 7 3 8 8 8 8 1 8 9 8 9 1 8 9 2 8 9 3 8 9 4 8 9 5 MISRA C Rules 9 1 9 2 Index identifiers s orrea ioen a cae tae Peeks Coheed aw de eae g eee PA eh E ey eee eee 8 4 Expressions facut cde tae ede Cee eae MAA REED Caen Oe p EEA 8 4 Built in FURCHOnS isese ie vireen eioan eh e EE a baa da ge EASE tage ee ee saan eae 8 5 LSL Definitions in the Linker Script File 0 0 cece cece eee 8 6 Memory and Bus Definitions 0 ccc tte tenes 8 6 Architecture DetinitiOn ycacccv end eka odd eee a eRe beeen eae dad ol E E a 8 7 Derivative Definition i eere mer ack paced eke ESEE ed auld GATE EO eee ele ed poe Le 8 9 Processor Definition and Board Specification 0 eee
32. A popup menu appears 3 Select More Info A Message Info box appears with additional information Command line syntax diag format all nr Description With this option you can ask for an extended description of error messages in the format you choose The output is directed to stdout normally your screen and in the format you specify You can specify the following formats html rtf or text default To create a file with the descriptions you must redirect the output With the suboption all the descriptions of all error messages are given If you want the description of one or more selected error messages you can specify the error message numbers separated by commas With this option the compiler does not compile any files Example To display an explanation of message number 282 enter carm diag 282 This results in the following message and explanation E282 unterminated comment Make sure that every comment starting with has a matching Nested comments are not possible To write an explanation of all errors and warnings in HTML format to file cerrors html1 use redirection and enter carm diag html all gt cerrors html Related information J 5 11 ARM Embedded Tools Reference C Compiler endianness Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Processor entry and select Processor Definition 3 Enable the
33. Currently defined as getchar getwchar because FILE I O is not supported Returns the read character or EOF WEOF on error Reads one character from the stdin stream Returns the character read or EOF WEOF on error Implemented as macro FSS implementation Reads at most the next n 1 characters from the stream into array s until a newline is found Returns s or NULL or EOF WEOF on error FSS implementation Reads at most the next n 1 characters from the stdin stream into array s A newline is ignored Returns s or NULL or EOF WEOF on error FSS implementation Pushes character c back onto the input stream Returns EOF WEOF on error Put character c onto the given stream Returns EOF WEOF on error FSS implementation Same as fpuc fputwe except that is implemented as a macro FSS implementation Put character c onto the stdout stream Returns EOF WEOF on error Implemented as macro FSS implementation Writes string s to the given stream Returns EOF WEOF on error Writes string s to the stdout stream Returns EOF WEOF on error FSS implementation fread ptr size nobj stream fwrite ptr size nobj stream Random access stdio h Reads nobj members of size bytes from the given stream into the array pointed to by ptr Returns the number of elements succesfully read FSS implementation Writes nobj members of size bytes from to the array pointed to by pir to the given stream Returns the number
34. Example Suppose the file myoptions contains the following lines Mmymap generate a map file test obj input file Lc mylibs additional search path for system libraries Specify the option file to the linker lkarm option file myoptions This is equivalent to the following command line lkarm Mmymap test obj Lc mylibs Related information do 5 119 ARM Embedded Tools Reference Linker output o Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Output Format 3 Enable one or more output formats Command line syntax output filename format addr_size offilename format adar_size You can specify the following formats ELF ELF DWARF IHEX Intel Hex SREC Motorola S records Description By default the linker generates an output file in ELF DWARF format named after the first input file with extension abs With this option you can specify an alternative filename and an alternative output format The default output format is the format of the first input file You can use the output option multiple times This is useful to generate multiple output formats With the first occurrence of the output option you specify the basename the filename without extension which is used for subsequent output options with no filename specified If you do not specify a filename or you do not specify
35. FILE __ the TASKING C compiler supports the predefined macros as defined in the table below The macros are useful to create conditional C code Macro Description __ ARM Expands to 1 for the ARM toolset otherwise unrecognized as macro BIG ENDIAN Expands to 1 if big endian mode is selected endianness big otherwise unrecognized as macro _ BUILD __ Identifies the build number of the compiler composed of decimal digits for the build number three digits for the major branch number and three digits for the minor branch number For example if you use build 1 22 1 of the compiler _ BUILD _ expands to 1022001 If there is no branch number the branch digits expand to zero For example build 127 results in 127000000 __CARM__ Expands to 1 for the ARM toolset otherwise unrecognized as macro CPU Expands to the ARM architecture name option cpu arch _ CPU arch __ A symbol is defined depending on the option cpu arch The arch is converted to uppercase For example if cpu ARMv4T is specified the symbol _ CPU_ARMV4T__ is defined When no cpu is supplied symbol ___CPU_ARMV4T__is the default __DOUBLE_FP__ Expands to 1 if you did not use option no double Treat double as float otherwise unrecognized as macro __LITTLE ENDIAN _ Expands to 1 if little endian mode is selected endianness little otherwise unrecognized as macro This is the default __ REV
36. If not the assembler generates assembly source line information Same as debug info asm hll local With debug info AHLS the assembler does not generate any debug information Related information J 5 58 Tool Options Assembler Assembler define D Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Preprocessing 3 Click on User macro click on the down arrow in the right pane to expand macro input 4 Click on an empty Macro field and enter a macro name Then click outside the cell to confirm 5 Optionally click in the Value field and enter a definition Then click outside the cell to confirm Command line syntax define macro_name macro_definition Dmacro_name macro_definition Description With this option you can define a macro and specify it to the assembler preprocessor If you only specify a macro name no macro definition the macro expands as 1 You can specify as many macros as you like On the command line you can use the option define D multiple times If the command line exceeds the limit of the operating system you can define the macros in an option file which you then must specify to the assembler with the option option file file f Defining macros with this option instead of in the assembly source is for example useful in combination with conditional assembly as shown in
37. Linker first library first Menu entry Command line syntax first library first Description When the linker processes a library it searches for symbols that are referenced by the objects and libraries processed so far If the library contains a definition for an unresolved reference the linker extracts the object that contains the definition from the library By default the linker processes object files and libraries in the order in which they appear on the command line If you specify the option first library first the linker always tries to take the symbol definition from the library that appears first on the command line before scanning subsequent libraries This is for example useful when you are working with a newer version of a library that partially overlaps the older version Because they do not contain exactly the same functions you have to link them both However when a function is present in both libraries you may want the linker to extract the most recent function Example Consider the following example lkarm first library first a lib test obj b lib If the file test obj calls a function which is both present in a lib and b 1ib normally the function in b 1ib would be extracted With this option the linker first tries to extract the symbol from the first library a Lib Note that routines in b 1ib that call other routines that are present in both a lib and b 1ib are now also resolved from a lib Related inform
38. Select More Info A Message Info box appears with additional information Command line syntax diag format all nr Description With this option you can ask for an extended description of error messages in the format you choose The output is directed to stdout normally your screen and in the format you specify You can specify the following formats html rtf or text default To create a file with the descriptions you must redirect the output With the suboption all the descriptions of all error messages are given If you want the description of one or more selected error messages you can specify the error message numbers separated by commas With this option the linker does not link locate any files Example To display an explanation of message number 106 enter lkarm diag 106 This results in the following message and explanation E106 unresolved external lt message gt The linker could not resolve all external symbols This is an error when the incremental linking option is disabled The lt message gt indicates the symbol that is unresolved To write an explanation of all errors and warnings in HTML format to file Lerrors htm1 enter lkarm diag html all gt lerrors html Related information J 5 93 ARM Embedded Tools Reference Linker endianness Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Processor entry an
39. Suppose the file myoptions contains the following lines DDEMO 1 test c Specify the option file to the control program ccarm option file myoptions This is equivalent to the following command line ccarm DDEMO 1 test c Related information i 5 154 Tool Options Control Program Control Program output o Command line syntax output file 0 file Description Default the control program generates a file with the same basename as the first specified input file With this option you specify another name for the resulting absolute object file Example ccarm test c prog c The control program generates an ELF DWARF object file default with the name test abs To generate the file result abs ccarm output result abs test c prog c Related information i 5 155 ARM Embedded Tools Reference Control Program pass W Command line syntax pass assembler option Waoption Pass option directly to the assembler pass c option Wcoption Pass option directly to the C compiler pass linker option Wloption Pass option directly to the linker Description With this option you tell the control program to call a tool with the specified option The control program does not use or interpret the option itself but specifies it directly to the tool which it calls Related information J 5 156 Tool Options Control Program Control Program preprocess E Command lin
40. With the REPEAT ENDREP directive you can repeat a sequence of assembly source lines With expression you specify the number of times the loop is repeated If you specify label it gets the value of the location counter at the start of the directive processing Example In this example the loop is repeated 3 times Effectively the preprocessor repeats the source lines DB 10 three times then the assembler assembles the result REPEAT 3 DB 10 assembly source lines ENDREP Related information Gs FOR ENDFOR Repeat sequence of source lines n times 3 37 ARM Embedded Tools Reference SECTION Syntax SECTION name at address ENDSEC Description With the SECTION directive you define a new section Each time you use the SECTION directive a new section is created It is possible to create multiple sections with exactly the same name If you define a section you must always specify the section name The names have a special meaning to the locating process and have to start with a predefined name optionally extended by a dot and a user defined name The predefined section name also determines the type of the section code data or debug Optionally you can specify the at attribute to locate a section at a specific address You can use the following predefined section names Section Name Description Section Type text Code sections code data Initialized data data
41. about the core for the locating phase of the linker A linker script file is coded in LSL and contains the following types of information e the architecture definition describes the core s hardware architecture e the memory definition describes the physical memory available in the system e the section layout definition describes how to locate sections in memory With this option you specify a linker script file to the linker If you do not specify this option the linker uses a default script file You can specify the existing file arm 1s1 or the name of a manually written linker script file You can use this option multiple times The linker processes the LSL files in the order in which they appear on the command line Related information db Linker option Isl check Check LSL file s and exit Section 5 9 Controlling the Linker with a Script in chapter Using the Linker of the user s manual 5 110 Tool Options Linker Linker map file M Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Map File 3 Enable the option Generate a memory map file map 4 Inthe Map file format section enable or disable the information you want to be included in the map file Command line syntax map file file Mifile Description With this option you tell the linker to generate a linker map file If you do not specify a filename an
42. access Description With this option you tell the compiler to generate more efficient instructions to access unaligned 16 bit or larger data Halfword or word load and store instructions are used instead of byte instructions This option is only useful for cores that have support for unaligned access Related information J 5 50 Tool Options C Compiler C Compiler undefine U Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option undefine to the Additional C compiler options field Command line syntax undefine macro_name Umacro_name Description With this option you can undefine an earlier defined macro as with undef This option is for example useful to undefine predefined macros However the following predefined ISO C standard macros cannot be undefined _ FILE _ current source filename LINE current source line number int type TIME___ hh mm ss _ DATE___ mmmddyyyy __STDC___level of ANSI standard Example To undefine the predefined macro _ TASKING __ carm undefine _ TASKING test c Related information d C compiler option define Define preprocessor macro 5 51 ARM Embedded Tools Reference C Compiler version V Menu entry Command line only Command line syntax version V Description Displays version information of the compiler The
43. bin lkarm exe arguments o hello abs fmk2052c tmp task task1 4o JE ISIC III ICIS IIIS OIG IDI kk kkk Used ReSOUT CES JOS kk k andi ainda a inc ISIC k I Ae E A E ICCC I ICICI RR IIIA Memory usage in bytes system xram 0x0 0x00180 0x08028 0x77e58 0x80000 system xrom 0x01050 0x0010a 0x0 Ox0eea6 0x10000 Total 0x01050 0x0028a 0x08028 Ox86cfe 0x90000 fon o 2 9 2 Space Native used Rom Native used Ram Foreign used Reserved Free Rom Free Ram Total system sw linear 0x0115a 0x00180 0x0 0x08028 Ox0eea6 0x77e58 0x90000 ee Total Ox0115a 0x00180 Largest gap OxOeea4 0x77e58 pace ncn nnn nnn nnn ne tne nnn nn ne nnn nnn nnn nn nn nnn nnn nnn nn nn nn nnn nnn nn en anne nn nn nnn nen nnn Note When spaces share memory with each other some space can be consumed by sections located in other spaces In the table above we call this foreign used space as opposed to native used space Estimated stack usage stack 0 0x000000fc recursive no EE E AE E AE E E e A Ae IIIS ICIS E E A A A R A E A A E R E k kkk Proces sed Fi es 4 ARAkA k k k A k k k ange a a SIS k I Ae E R R ICCC III RII IIE
44. bits 32 63 of the result of the expression The result of the expression is calculated as a double word 64 bits PRE_UAL Returns1 if the assembler runs in pre UAL syntax mode by default or 0 if the assembler runs in UAL syntax mode default This function reflects the setting of the option old syntax Example IF PRE_UAL true if you specified option old syntax 7 Old code ELSE 7 new code UAL syntax ENDIF STRCAT string1 string2 Concatenates string1 and string2 and returns them as a single string You must enclose string1 and string2 either with single quotes or with double quotes Example DEFINE ID STRCAT TAS KING ID TASKING STRCMP string1 string2 Compares string with string2 by comparing the characters in the string The function returns the difference between the characters at the first position where they disagree or zero when the strings are equal lt 0 if string lt string2 0 if string string2 gt 0 if string gt string2 Example IF STRCMP STR MAIN does STR equal MAIN STRLEWN string Returns the length of string as an integer Example SLEN SET STRLEN string SLEN 6 STRPOS string1 string2 start Returns the position of string2 in string1 as an integer If string2 does not occur in string7 the last string postition 1 is returned With start you can specify the starting position of the search
45. box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option define to the Additional linker options field Command line syntax define macro_name macro_definition Dmacro_name macro_definition Description With this option you can define a macro and specify it to the linker LSL file preprocessor If you only specify a macro name no macro definition the macro expands as 1 You can specify as many macros as you like just use the option define multiple times If the command line exceeds the limit of the operating system you can define the macros in an option file which you then must specify to the linker with the option option file file f The definition can be tested by the preprocessor with if ifdef and ifndef for conditional locating Example To define the stack size and start address which are used in the linker script file arm 1s1 enter lkarm test obj otest abs darm 1sl D__STACK 32k D__START 0x00000000 or using the long option names lkarm otest abs lsl file arm 1sl define _ STACK 32k define _ START 0x00000000 Related information db Linker option option file Read options from file 5 92 Tool Options Linker Linker diag Menu entry 1 From the View menu select Workspace Panels System Messages The Messages panel appears 2 In the Messages panel right click on the message you want more information on A popup menu appears 3
46. cae Ra Ke pee Oe Bee ee ee eee oe 2 7 2 2 16 SCUMP heiii wt Gio ee Dee Cea A bee Adda he pel doesn LE hea dane eee 2 10 2 2 17 signali ewir a nE eed ao diegu Ae Wa alike on N ak eee ned of Gee he Rie RES 2 11 2 2 18 SUC ANG HN 5 cee ace eee acer i hd aay Steeda arm re ap Mam a edt pa at wesc 2 11 2 2 19 StODOOIN reio hs bah dnt Rat oy als BG a E O eee at eda haan Rom any 2 11 2 2 20 siddeti 3 85 Siac ssek ach ete ces or ea wettest pent dten Soe eta aed 2 11 2 2 21 SICING hece iatri e ohaett eine thee E E a ge a Bak ounces tele eyes 2 12 2 2 22 Stdio Mand WCMAR o eta tos edie weld carn E eee ana Marta etd ap aid wwe OE Go ws wa ea 2 12 2 2 23 Stdlib h and Wha o edted weed anak otk nal tages ela chance bday aoe tay deo ae 2 17 2 2 24 string hand weharh 2iscees pcke eee ae bowie caai iakin dae PERE ai pioa ed ne e we oS 2 19 2 2 25 time N and Wha occa cde eae fend MAO eae MA Eee A eae Oe hee ge Aes 2 20 2 2 26 UNISTQIA orrs secant he pee ed ata dea Pag oa a eee G aieane eee Red as eee oe Pees 2 22 2 2 27 Wehar i 6 cov idawcerena debates tee teaaeates tbadibe til nhtadetendt he bea ded peta ose ons 2 23 2 2 28 WCtype hi 4 aciseetaiseted aoa eee need an Rid i aa T EEE aE DEDE Ge Re Peas 2 24 ARM Embedded Tools Reference Assembly Language 3 1 3 1 Assembly Syntax acicccace ic ieivere dette ene eg Ree dee alae tate ee 3 1 3 2 Assembler Significant Characters 000 cece eet eee eens 3 2 3 3 Operands of an Assembly Instruction
47. call the control program as follows ccarm include directory myinclude test c First the compiler looks for the file stdio h in the directory myinc lude relative to the current directory If it was not found the compiler searches in the environment variable and then in the default include directory The compiler now looks for the file myinc h in the directory where test c is located If the file is not there the compiler searches in the directory myinclude If it was still not found the compiler searches in the environment variable and then in the default include directory Related information C compiler option include directory Add directory to include file search path C compiler option include file Include file at the start of a compilation Section 2 4 How the Compiler Searches Include Files in chapter Using the Compiler of the user s manual 5 140 Tool Options Control Program Control Program iso Command line syntax iso 90 99 Description With this option you specify to the control program against which ISO standard it should check your C source C90 is also referred to as the ANSI C standard C99 refers to the newer ISO IEC 9899 1999 E standard and is the default AN Independant of the chosen ISO standard the control program always links libraries with C99 support Example To compile the file test c conform the ISO C90 standard ccarm iso 90 test c Related information Gb C compile
48. can temporarily disable the default behavior that the C compiler automatically inlines small functions when you turn on the C compiler option optimize inline 1 8 4 Intrinsic Functions Some specific assembly instructions have no equivalence in C Intrinsic functions give the possibility to use these instructions Intrinsic functions are predefined functions that are recognized by the compiler The compiler generates the most efficient assembly code for these functions The compiler always inlines the corresponding assembly instructions in the assembly source rather than calling it as a function This avoids parameter passing and register saving instructions which are normally necessary during function calls Intrinsic functions produce very efficient assembly code Though it is possible to inline assembly code by hand intrinsic functions use registers even more efficiently At the same time your C source remains very readable You can use intrinsic functions in C as if they were ordinary C library functions All intrinsics begin with a double underscore character The TASKING ARM C compiler recognizes the following intrinsic functions __alloc void volatile _alloc _ size_t size Allocate memory Same as library function malloc Returns a pointer to space in external memory of size bytes length NULL if there is not enough space left __free void volatile _ free void p Deallocates the memory pointed to by p p must poi
49. cnt Reads a sequence of characters from a file FSS implementation _unlink name Used by the function remove FSS implementation _write fd buffer cnt Writes a sequence of characters to a file FSS implementation 2 2 11 iso646 h The header file iso646 h adds tokens that can be used instead of regular operator tokens define and amp amp define and_eq amp define bitand amp define bitor define compl define not define not_eq define or define or_eq define xor define xor_eq 2 2 12 limits h Contains the sizes of integral types defined as macros 2 2 13 locale h To keep C code reasonable portable accross different languages and cultures a number of facilities are provided in the header file local h char setlocale int category const char locale The function above changes locale specific features of the run time library as specified by the category to change and the name of the locale 2 6 Libraries The following categories are defined and can be used as input for this function LC_ALL 0 LC_NUMERIC 3 LC_COLLATE 1 LC_TIME 4 LC_CTYPE 2 LC_MONETARY 5 struct lconv localeconv void Returns a pointer to type stuct lconv with values appropriate for the formatting of numeric quantities according to the rules of the current locale The struct lconv in this header file is conforming the ISO standard 2 2 14 malloc h The header file malloc h contains protot
50. code and the relative addresses Note that the assembler generates a relocatable object file with relative addresses With name you can specify a name for the list file This is only possible if you specify only one input file to the control program If you do not specify name or you specify more than one input files the control program names the generated list file s after the specified input file s with extension 1st Example This example generates the list files 1 1st and 2 1st for 1 c and 2 c If in this example also a name had been specified it would be ignored because two input files are specified ccarm l c 2 c list files Related information Gb Assembler option list file Generate list file Assembler option list format List file formatting options 5 146 Tool Options Control Program Control Program IsI file d Command line syntax Isl file file dfile Description A linker script file contains vital information about the core for the locating phase of the linker A linker script file is coded in LSL and contains the following types of information e the architecture and derivative definition describe the core s hardware architecture and its internal memory e the board specification describes the physical memory available in the system e the section layout definition describes how to locate sections in memory With this option you specify a linker script file via the control program to
51. comments are not preserved similar to ECMP With preprocess make the compiler will generate dependency lines that can be used in a Makefile The preprocessor output is discarded The default target name is the basename of the input file with the extension obj With the option make target you can specify a target name which overrules the default target name Related information Gls C compiler option make target Specify target name for Em output 5 37 ARM Embedded Tools Reference C Compiler profile p Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Debug Information 3 Enable the option Generate profiling information 4 Enable one or more of the following suboptions to select which profiles should be obtained e Block counters not in combination with with Call graph or Function timers e Call graph e Function counters e Function timers LN Note that the more detailled information you request the larger the overhead in terms of execution time code size and heap space needed The option Generate Debug information debug or g does not affect profiling execution time or code size Command line syntax profile flags plflags Use the following option for a predefined set of flags profile g pg profiling with call graph and function timers Alias for pBcFt You can set the following flags when yo
52. conditional code to compile a demo program and a real program void main void if DEMO demo_func compile for the demo program else real_func compile for the real program endif You can now use a macro definition to set the DEMO flag With the control program this looks as follows ccarm define DEMO test c ccarm define DEMO 1 test c Note that both invocations have the same effect The next example shows how to define a macro with arguments Note that the macro name and definition are placed between double quotes because otherwise the spaces would indicate a new option ccarm D MAX A B A gt B A B test c Related information Control Program option undefine Undefine preprocessor macro Control Program option option file Read options from file 5 132 Tool Options Control Program Control Program diag Command line syntax diag format all nr Description With this option you can ask for an extended description of error messages in the format you choose The output is directed to stdout normally your screen and in the format you specify You can specify the following formats html rtf or text default To create a file with the descriptions you must redirect the output With the suboption all the descriptions of all error messages are given If you want the description of one or more selected error messages you can specify the error messag
53. constant string pointer With this option the following example produces no warning char p void main void p hello With option language gcc Ag command line only you tell the compiler to enable the following gcc languages extensions e The identifier FUNCTION __ expands to the current function name e Alternative syntax for variadic macros e Alternative syntax for designated initializers e Allow zero sized arrays e Allow empty struct union e Allow empty initializer list e Allow initialization of static objects by compound literals e The middle operand of a operator may be omitted e Allow a compound statement inside braces as expression e Allow arithmetic on void pointers and function pointers e Allow a range of values after a single case label e Additional preprocessor directive warning e Allow comma operator conditional operator and cast as lvalue e An inline function without static or extern will be global e An extern inline function will not be compiled on its own e An attribute directly following a struct union definition relates to that tag instead of to the objects in the declaration For an exact description of these gcc extensions please refer to the gcc info pages info gcc 5 23 ARM Embedded Tools Reference Example carm AGPx c90 test c carm language ggc comments strings iso 90 test c db C compiler option iso ISO C standard 5 24 Tool Opt
54. copy vector id 1IL loop reserved 8 8 1 Setting up a Section With the keyword section_setup you can define stacks heaps vector tables and or reserved address ranges outside their address space definition section_setup my_space vector table statements reserved address range stack definition heap definition See the subsections Stacks and heaps Vector table and Reserved address ranges in section 8 5 3 Defining Address Spaces for details on the keywords stack heap vector_table and reserved 8 24 Linker Script Language 8 9 Semantics of the Section Layout Definition Keywords in the section layout definition section_layout direction low_to_high high _to_low group align attributes rwxbis copy nocopy gali ordered contiguous clustered overlay allow cross_references load_addr mem run addr mem page page_size priority select stack size heap size reserved size attributes rwx fill alloc allowed absolute copytable section size blocksize attributes rwx Eill overflow Lt else 8 9 1 Defining a Section Layout With the keyword section_layout you define a section layout for exactly one address space In the section layout you can specify how input sections are placed in the address space relative to each other and what the absolute run and load addresses of each section will be You can define one or more section definitions Each section definition arranges the sections in one addres
55. detected Identifiers shall be given for all of the parameters in a function prototype declaration The identifiers used in the declaration and definition of a function shall be identical Functions with no parameters shall be declared with parameter type void The number of arguments passed to a function shall match the number of parameters A pointer parameter in a function prototype should be declared as pointer to const if the pointer is not used to modify the addressed object All exit paths from a function with non void return type shall have an explicit return statement with an expression A function identifier shall only be used with either a preceding amp or with a parenthesized parameter list which may be empty If a function returns error information then that error information shall be tested A violation is reported when the return value of a function is ignored Pointers and arrays x 17 1 x 17 2 17 3 17 4 17 5 17 6 BBs SB Pointer arithmetic shall only be applied to pointers that address an array or array element Pointer subtraction shall only be applied to pointers that address elements of the same array gt gt lt lt shall not be applied to pointer types except where they point to the same array In general checking whether two pointers point to the same object is impossible The compiler will only report a violation for a relational operation with incompatible pointer types Array inde
56. exits No linking or locating is performed Use the option Isl file file to specify the name of the Linker Script File you want to test Related information Gb Linker option Isl file Linker script file Linker option Isl dump Dump LSL info Section 5 9 Controlling the Linker with a Script in chapter Using the Linker of the user s manual 5 108 Tool Options Linker Linker Isl dump Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Enable the option Dump processor and memory info from LSL file Command line syntax Isl dump file Description With this option you tell the linker to dump the LSL part of the map file in a separate file independent of the option map file generate map file If you do not specify a filename the file Lktarget 1df is used Related information db Linker option map file format Map file formatting 5 109 ARM Embedded Tools Reference Linker IsI file d Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Enable the option Use project specific LSL file 4 Inthe LSL file field type a name or click and select an LSL file Command line syntax lIsl file file diile Description A linker script file contains vital information
57. file Command line syntax output file 0 file Description With this option you can specify another filename for the output file of the compiler Without this option the basename of the C source file is used with extension src Example To create the file output src instead of test src enter carm output output sre test c Related information i 5 36 Tool Options C Compiler C Compiler preprocess E Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Preprocessing 3 Enable the option Store the C Compiler preprocess output lt file gt pre Command line syntax preprocess flags Effiags You can set the following flags when you specify E without flags the default is ECMP comments c C Keep comments from the C source in the preprocessed output make m M Generate dependency lines that can be used for the makefile noline p P Strip line source position info lines starting with line The compiler sends the preprocessed file to stdout To capture the information in a file specify an output file with the option output Description When compiling each file is preprocessed first With this option you can store the result of preprocessed C files Altium Designer stores the preprocessed file in a file called name pre where name is the name of the C source file being compiled C
58. from functions outside the current module On the command line this option only makes sense when you specify all modules of an application on the command line Example carm static modulel c module2 c module3 c Related information J 5 45 ARM Embedded Tools Reference C Compiler stdout n Menu entry Command line only Command line syntax stdout n Description With this option you tell the compiler to send the output to stdout usually your screen No files are created This option is for example useful to quickly inspect the output or to redirect the output to other tools Related information i 5 46 Tool Options C Compiler C Compiler thumb Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Code Generation 3 Enable the option Generate Thumb code Command line syntax thumb Description With this option you tell the compiler to generate 16 bit thumb instructions Related information db C compiler option interwork Generate interworking code 5 47 ARM Embedded Tools Reference C Compiler tradeoff t Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Optimization 3 Inthe Size speed trade off field select a level between fully optimize for size or fully op
59. from high_to_low addresses stack grows downwards The min_size is required By default the linker tries to maximize the size of the stacks and heaps After locating all sections the largest remaining gap in the space is used completely for the stacks and heaps If you specify the keyword fixed you can disable this so called balloon behavior The size is also fixed if you used a stack or heap in the software layout definition in a restricted way For example when you override a stack with another size or select a stack in an ordered group with other sections The id keyword matches stack information generated by the compiler with a stack name specified in LSL This value assigned to this keyword is strongly related to the compiler s output so users are not supposed to change this configuration Optionally you can specify an alignment for the stack with the argument align This alignment must be equal or larger than the alignment that you specify for the address space itself The heap keyword defines a heap in the address space and assigns a name to it The definition of a heap is similar to the definition of a stack See also the heap keyword in section 8 9 3 Creating or Modifying Special Sections db See section 8 9 Semantics of the Section Layout Definition for information on creating and placing stack sections Copy tables The copytable keyword defines a copy table in the address space The content of the copy table is created by t
60. group at the given absolute offset in memory group run_addr mem A 0x1000 A range can be an absolute space address range written as expr expr acomplete memory device written as mem mem_name Or a memory address range mem mem name expr expr group run_addr mem my dram You can use the to specify an address range of more than one physical memory device group run_addr mem A mem B The load_addr keyword changes the meaning of the section selection in the group the linker selects the load time ROM copy of the named section s instead of the regular sections Just like run_addr you can specify an absolute address or an address range The load_addr keyword itself without an assignment specifies that the group s position in the LSL file defines its load time address group load_addr select mydata select ROM copy of mydata mydata The load time and run time addresses of a group cannot be set at the same time If the load time property is set for a group the group only restricts the positioning at load time of the group s sections It is not possible to set the address of a group that has a not unrestricted parent group The properties of the load time and run time start address are At run time before using an element in an overlay group the application copies the sections from their load location to their run time location but only if these two addresses are different For non over
61. groups you can only specify group_alignment and attributes e The overlay keyword also sets the contiguous property e The clustered property cannot be set together with contiguous or ordered on a single group load_or_run_addr addr_absolute addr_range lt addr_range gt addr_absolute 2 expr memory_reference expr e An absolute address can only be set on ordered groups addr_range expr expr memory_reference memory_reference expr expr e The parent of a group with an addr_range or page restriction cannot be ordered contiguous or clustered memory_reference mem lt proc_name gt 0 1 lt core_name gt 0 1 mem_name e Aproc_name refers to a defined processor e Acore_name refers to a defined core e Amem_name refers to a defined memory if_ statement if expr section_statement lt else section_statement gt 1 section_creation_statement section section_name section_specs lt section_statement2 gt gt 0 section_specs section_spec lt section_spec gt gt 0 section_spec attributes fill_spec size expr blocksize expr overflow section_name section_statement2 select_section_statement group_descr2 lt section_statement2 gt gt 8 12 Linker Script Language group _descr2 group lt group_name gt 1 group_specs2 section_statement2 group_specs2 group_spec2 lt group _spec2 gt 0 group_spec2 grou
62. gt s2 Performs a local specific comparison between string s7 and string s2 according to the LC_COLLATE category of the current locale Returns lt 0 if s1 lt s2 0 if s1 s2 or gt 0 if s1 gt s2 See section 2 2 13 locale h Transforms a local string s2 so that a comparison between transformed strings with strcmp gives the same result as a comparison between non transformed strings with strcol11 Returns the transformed string s7 Description memchr s c n strchr s c strrchr s c strspn s set strespn s set strpbrk s set strstr s sub strtok s delim wmemchr s c n weschr s Cc wesrchr s c wesspn s set wescspn s set wespbrk s set wesstr s sub westok s delim Miscellaneous functions stdio h wchar h Checks the first n characters of s on the occurence of character c Returns a pointer to the found character Returns a pointer to the first occurence of character c in string s or the null pointer if not found Returns a pointer to the last occurence of character c in string s or the null pointer if not found Searches s for a sequence of characters specified in set Returns the length of the first sequence found Searches s for a sequence of characters not specified in set Returns the length of the first sequence found Same as strspn wcsspn but returns a pointer to the first character in s that also is specified i
63. h and adds portable formatting and conversion functions Below the conversion functions from inttypes h are listed intmax_t imaxabs intmax_t j Returns the absolute value of j imaxdiv_t imaxdiv intmax_t numer Computes numer denom and numer denom The result is stored in the quot intmax_t denom and rem components of the imaxdiv_t structure type 2 5 ARM Embedded Tools Reference intmax_t strtoimax const char Convert string to maximum sized integer Compare strtol restrict nptr char restrict endptr int base uintmax_t strtoumax const char Convert string to maximum sized unsigned integer Compare strtoul restrict nptr char restrict endptr int base intmax_t westoimax const wchar_t Convert wide string to maximum sized integer Compare wctol restrict nptr wchar_t re strict endptr int base uintmax_t westoumax const wchar_t Convert wide string to maximem sized unsigned integer Compare wctoul restrict nptr wchar_t re strict endptr int base 2 2 10 io h The header file io h contains definitions and prototypes for low level I O functions This header file is not defined in ISO IEC9899 _close fd Used by the functions close and fclose FSS implementation _lseek fd offset whence Used by all file positioning functions fgetpos fseek fsetpos ftell rewind FSS imple mentation _open fd flags Used by the functions fopen and freopen FSS implementation _read fd buff
64. id_symbol_ prefix symbol_name run_addr addr_absolute template section_name template_symbol symbol name vector prefix section_name fill vector value no_inline copy vector def vector vector_spec lt vector_spec gt vector spec id vector_id_spec fill vector_value vector_id_spec number range lt range gt 9 vector value symbol_name number lt number gt loop lt expr gt l reserved_range reserved expr expr endianness_ def endianness lt endianness_type gt 1 endianness_ type big little 8 3 9 Derivative Definition derivative_definition derivative derivative_name lt parameter list gt 9 1 lt extends derivative_name lt argument_list gt 1 gt 0 1 lt derivative_spec gt e Aderivative_definition defines a derivative with the given derivative_name as a unique name derivative_spec core def bus_def mem_def section_definition no processor name section_setup core _def core core name lt core_ descr gt gt 0 e Acore_def defines a core with the given core_name as a unique name e Atleast one core_def must be present in a derivative_definition 8 9 ARM Embedded Tools Reference core_descr architecture arch_name lt argument_list gt 0l1 endianness endianness_type lt endianness_type gt gt 0 e Anarch_name refers to a defined core architecture
65. information Q This illustration indicates actions you can perform with the mouse Such as Altium Designer menu entries and dialogs E Command line type your input on the command line d gt Reference follow this reference to find related topics ARM Embedded Tools Reference Related Publications C Standards e ISO IEC 9899 1999 E Programming languages C ISO IEC More information on the standards can be found at http www ansi org e DSP C An Extension to ISO IEC 9899 1999 E Programming languages C TASKING TK0071 14 MISRA C e Guidelines for the Use of the C Language in Vehicle Based Software MIRA limited 1998 See also http www misra org uk e MISRA C 2004 Guidelines for the use of the C Language in critical systems MIRA limited 2004 See also http www misra c com TASKING Tools e Using the ARM Embedded Tools Altium GU0116 ARM e ARM Architecture Reference Manual ARM DDI 01001 2005 ARM Limited e ARM v7 M Architecture Application Level Reference Manual ARM DDI 0405A 01 2006 ARM Limited Altium 1 C Language Summary This chapter describes the target specific features of the C language including language extensions that are not standard in ISO C For example pragmas are a way to control the compiler from within the C source 1 1 Introduction The TASKING C compiler fully supports the ISO C standard but adds possibilities to program the special functions of the ARM In addition
66. integer Decimal digits 0 9 1245 Table 3 2 Numeric constants 3 6 2 Strings ASCII characters enclosed in single or double quotes constitue an ASCII string Strings between double quotes allow symbol substitution by a DEFINE directive whereas strings between single quotes are always literal strings Both types of strings can contain escape characters Strings constants in expressions are evaluated to a number each character is replaced by its ASCII value Strings in expressions can have a size of up to 8 characters or less depending on the operand of an instruction or directive any subsequent characters in the string are ignored In this case the assembler issues a warning An exception to this rule is when a string is used in a DB assembler directive in that case all characters result in a constant value of the specified size Null strings have a value of 0 Examples ABCD 0x41424344 rreo to enclose a quote double it A BC or to enclose a quote escape it AB 1 0x4143 string used in expression i null string 3 6 3 Expression Operators The next table shows the assembler operators They are ordered according to their precedence Operators of the same precedence are evaluated left to right Parenthetical expressions have the highest priority innermost first Valid operands include numeric constants literal ASCII strings and symbols 3 4 Assembly Language
67. is reported when the value of the constant is outside the range indicated by the suffixes if any 19 R Octal constants other than zero shall not be used 20 R All object and function identifiers shall be declared before use 21 R Identifiers shall not hide identifiers in an outer scope 22 A Declarations should be at function scope where possible 9 1 ARM Embedded Tools Reference x 23 A _ All declarations at file scope should be static where possible 24 R Identifiers shall not have both internal and external linkage x 25 R Identifiers with external linkage shall have exactly one definition 26 R Multiple declarations for objects or functions shall be compatible x 27 A External objects should not be declared in more than one file 28 A The register storage class specifier should not be used 29 R The use ofa tag shall agree with its declaration 30 R All automatics shall be initialized before being used This rule is checked using worst case assumptions This means that violations are reported not only for variables that are guaranteed to be uninitialized but also for variables that are uninitialized on some execution paths 31 R Braces shall be used in the initialization of arrays and structures 32 R Only the first or all enumeration constants may be initialized 33 R The right hand operand of amp amp or shall not contain side effects 34 R The operands of a logical amp amp or shall be
68. label Note that you can use standard C escape sequences __asm nop n t m nop m ARM Embedded Tools Reference Generated code nop nop Example 2 using output parameters Assign the result of inline assembly to a variable A register is chosen for the parameter because of the constraint r the compiler decides which register is best to use The 0 in the instruction template is replaced with the name of this register Finally the compiler generates code to assign the result to the output variable char out void main void __asm mov 0 0xff r out Generated assembly code mov r0 0xff ldr rl L2 strb ro r1 0 bx lr size main main align 4 L2 dw out Example 3 using input and output parameters Add two C variables and assign the result to a third C variable Registers are used for the input parameters constraint r 1 for a and 2 for b in the instruction template and for the output parameter constraint r 0 for result in the instruction template The compiler generates code to move the input expressions into the input registers and to assign the result to the output variable char a b int result void main void a 3 b 4 __asm ADD 0 1 2 r result r a r b Generated assembly code main type func ldr rl L2 mov r0 3 strb r0 r1 0 mov r2 4 strb r2 r1 1 ADD r0 r0 r2 str r0 r1 4 bx lr size main
69. line syntax keep output files k Description If an error occurs during assembling the resulting object file obj may be incomplete or incorrect With this option you keep the generated object file when an error occurs By default the assembler removes the generated object file when an error occurs This is useful when you use the make utility If the erroneous files are not removed the make utility may process corrupt files on a subsequent invocation Use this option when you still want to use the generated object For example when you know that a particular error does not result in a corrupt object file Related information J 5 69 ARM Embedded Tools Reference Assembler list file l Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select List File 3 Enable Generate list file 4 Inthe List file format section enable or disable the types of information to be included Command line syntax list file file I file Description With this option you tell the assembler to generate a list file A list file snows the generated object code and the relative addresses Note that the assembler generates a relocatable object file with relative addresses With the optional file you can specify an alternative name for the list file By default the name of the list file is the basename of the source file with the exten
70. m Command line syntax m a posname b posname Description Move the specified object modules to another position in the library The ordering of members in a library can make a difference in how programs are linked if a symbol is defined in more than one member Default the specified members are moved to the end of the archive Use the suboptions a or b to move them to a specified place instead a posname Move the specified object module s after the existing module posname b posname Move the specified object module s before the existing module posname Example Suppose the library mylib lib contains the following objects see option t obj1 obj obj2 obj obj3 0bj To move obj1 obj to the end of mylib lib tlb m mylib 1lib objl obj To move obj3 obj just before obj2 obj tlb m b obj3 o0bj mylib lib obj2 obj The library mylib lib after these two invocations now looks like obj3 0bj obj2 obj obj1 obj Related information db Librarian option t Print library contents 5 198 Tool Options Librarian Librarian p Command line syntax p Description Print the specified object module s in the library to standard output This option is only useful when you redirect or pipe the output to other files or tools that serve your own purposes Normally you do not need this option Example tlb p mylib lib objl obj gt file obj The librarian prints the file obj1 obj to standard output where it i
71. main align 4 L2 dw a C Language Example 4 reserve registers Sometimes an instruction knocks out certain specific registers The most common example of this is a function call where the called function is allowed to do whatever it likes with some registers If this is the case you can list specific registers that get clobbered by an operation after the inputs Same as Example 3 but now register RO is a reserved register You can do this by adding a reserved register list RO As you can see in the generated assembly code register RO is not used the first register used is R1 char a b int result void main void a 3 b 4 __asm ADD 30 1 2 r result r a r b RO Generated assembly code main type func ldr r2 L2 mov r1 3 strb r1 r2 0 mov r3 4 strb 1r3 r2 1 ADD r1 r1 xr3 str r1 r2 4 bx lr size main main align 4 L2 dw a Example 5 input and output are the same If the input and output must be the same you must use a number constraint The following example increments the value of the input variable invar and returns this value to outvar Since the assembly instruction has to use only one register the return value has to go in the same place as the input value Parameter 0 corresponds to outvar To indicate that invar uses the same register as outvar the input constraint 0 is used which indicates that invar also corresponds to 0
72. module 5 200 create library 5 200 delete module 5 196 extract module 5 205 move module 5 198 print list of objects 5 202 print list of symbols 5 202 print module 5 199 replace module 5 200 warning level 5 204 Libraries linking 5 98 5 115 Library specifying 5 104 5 105 5 144 5 145 5 146 linear_switch 1 10 Linker macro 5 92 Linker options 5 88 5 99 case insensitive 5 89 chip output 5 90 cpu 5 91 define 5 92 diag 5 93 endianness 5 94 error file 5 95 error limit 5 96 extern 5 97 extra verbose 5 123 first library first 5 98 help 5 99 ignore default library path 5 105 import object 5 100 include directory 5 101 incremental 5 102 keep output files 5 103 library 5 104 library directory 5 105 link only 5 106 long branch veneers 5 107 Isl check 5 108 Isl dump 5 109 lsl file 5 110 map file 5 111 map file format 5 112 misra c report 5 113 no rescan 5 115 no rom copy 5 116 no warnings 5 117 non romable 5 114 optimize 5 118 option file 5 119 output 5 120 strip debug 5 121 user provided initialization code 5 122 verbose 5 123 version 5 124 warnings as errors 5 125 B big endian 5 94 C 5 91 c 5 90 D 5 92 d 5 110 e 5 97 f 5 119 I 5 101 i 5 122 k 5 103 L 5 105 l 5 104 M 5 111 m 5 112 N 5 116 O 5 118 0 5 120 r 5 102 S 5 121 V 5 124 v
73. most one direction statement e If you do not specify the direction statement the locate direction of the section layout is low to high section_statement simple _section_statement aggregate_section_statement simple_section_statement 2 assignment select_section_statement special_section_statement assignment symbol name assign_op expr assign _op 2 Linker Script Language select_section_statement select lt ref_tree gt 9 1 lt section_name gt 1 lt section_selections gt 9 1 e Either a section_name or at least one section_selection must be defined section_selections section_selection lt section_selection gt section_selection attributes lt lt gt attribute gt e attribute means select all sections that have this attribute e attribute means select all sections that do not have this attribute special _section_statement heap stack _name lt size_spec gt 1 stack stack name lt size_spec gt 1 copytable reserved section name lt reserved_specs gt 1 e Special sections cannot be selected in load time groups size_spec 2 size expr reserved_specs reserved_spec lt reserved_spec gt reserved_spec 3 attributes fi11_ spec size expr alloc_allowed absolute e Ifa reserved section has attributes r rw x rx or rwx and no fill pattern is defined the section is filled with zeros If no attributes a
74. no effect when an object is added to the library Examples Suppose the library mylib 1ib contains the following objects see option t obj1 obj To add obj2 obj to the end of mylib 1lib tlb r mylib lib obj2 obj To insert obj3 obj just before obj2 obj tlb r b obj2 obj mylib lib obj3 o0bj The library mylib 1ib after these two invocations now looks like obj1 obj obj3 0bj obj2 obj Creating a new library To create a new library file add an object file and specify a library that does not yet exist tlb r objl obj newlib lib The librarian creates the library newlib 1ib and adds the object obj1 obj to it To create a new library file and overwrite an existing library add an object file and specify an existing library with the supoption C tlb r c objl obj mylib lib 5 200 Tool Options Librarian The librarian overwrites the library mylib 1ib and adds the object obj1 obj to it The new library mylib 1ib only contains obj1 0bj Related information d gt Librarian option t Print library contents 5 201 ARM Embedded Tools Reference Librarian t Command line syntax t s0 s1 Description Print a table of contents of the library to standard out With the suboption s the librarian displays all symbols per object file s0 Displays per object the library in which it resides the name of the object itself and all symbols in the object s1 Displays only the symbols of all object files in the library Exa
75. only a single core for an unused architecture ARM Embedded Tools Reference db See section 8 6 Semantics of the Derivative Definition for a detailed description of LSL in the derivative definition The processor definition The processor definition describes an instance of a derivative Typically the processor definition instantiates one derivative only single core processor A processor that contains multiple cores having the same homogeneous or different heterogeneous architecture can also be described by instantiating multiple derivatives of the same or different types in separate processor definitions If for a derivative A no processor is defined in the LSL file the linker automatically creates a processor named A of derivative A This is why for single processor applications it is enough to specify the derivative in the LSL file db See section 8 7 Semantics of the Board Specification for a detailed description of LSL in the processor definition The memory and bus definitions optional Memory and bus definition are used within the context of a derivative definition to specify internal memory and on chip buses In the context of a board specification the memory and bus definitions are used to define external off chip memory and buses Given the above definitions the linker can convert a logical address into an offset into an on chip or off chip memory device See section 8 7 3 Defining External Memory and B
76. option ofilename SREC option the linker produces output in Motorola S record format with three types of S records SO S3 and S7 With the options ofilename SREC 2 or ofilename SREC 3 option you can force other types of S records They have the following layout SO record S 0 lt length_byte gt lt 2 bytes 0 gt lt comment gt lt checksum_byte gt A linker generated S record file starts with a SO record with the following contents length_byte 08 comment Ikarm checksum E0 lkarm S00800006C6B61726DE0 The SO record is a comment record and does not contain relevant information for program execution The length_byte represents the number of bytes in the record not including the record type and length byte The checksum is calculated by first adding the binary representation of the bytes following the record type starting with the length_byte to just before the checksum Then the one s complement is calculated of this sum The least significant byte of the result is the checksum The sum of all bytes following the record type is OFFH S1 record With the linker option ofilename SREC 2 the actual program code and data is supplied with S1 records with the following layout S 1 lt length_byte gt lt address gt lt code bytes gt lt checksum_byte gt This record is used for 2 byte addresses Example 1130250F03EF04DFOACE8A408A2A013EDFCDBO0E6 _ checksum _ code _ address _ le
77. option Big endian mode Command line syntax endianness endianness B big endian You can specify the following endianness big b Big endian little I Little endian default Description By default the compiler generates code for a little endian target least significant byte of a word at lowest byte address With endianness big the compiler generates code for a big endian target most significant byte of a word at lowest byte address B is an alias for option endianness big Related information J 5 12 Tool Options C Compiler C Compiler error file Menu entry Command line only Command line syntax error file file Description With this option the compiler redirects error messages to a file If you do not specify a filename the error file will be named after the input file with extension err Example To write errors to errors err instead of stderr enter carm error file errors err test c Related information ie 5 13 ARM Embedded Tools Reference C Compiler fpu Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Floating Point 3 Select an option from the Floating point unit FPU support field Command line syntax fpu fpu You can specify the following arguments VFPv2 Compile for VFPv2 architecture VFPv3 Compile for VFPv3 architecture none Compile for software FPU
78. possible alias may cause the result of an expression to be evaluation order dependent The sizeof operator shall not be used on expressions that contain side effects The right hand operand of a logical amp amp or operator shall not contain side effects The operands of a logical amp amp or shall be primary expressions The operands of logical operators amp amp and should be effectively Boolean Expressions that are effectively Boolean should not be used as operands to operators other than amp amp and Bitwise operators shall not be applied to operands whose underlying type is signed 9 7 ARM Embedded Tools Reference 12 8 12 9 12 10 12 11 12 12 12 13 R The right hand operand of a shift operator shall lie between zero and one less than the width in bits of the underlying type of the left hand operand This violation will only be checked when the shift count evaluates to a constant value at compile time The unary minus operator shall not be applied to an expression whose underlying type is unsigned The comma operator shall not be used Evaluation of constant unsigned integer expressions should not lead to wrap around The underlying bit representations of floating point values shall not be used A violation is reported when a pointer to a floating point type is converted to a pointer to an integer type The increment and decrement operators should not be mixed with oth
79. produces slightly larger code Related information d gt C compiler option thumb use Thumb instruction set 5 20 Tool Options C Compiler C Compiler iso c Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Language 3 Select the ISO C standard C90 or C99 Command line syntax iso 90 99 c 90 99 Description With this option you select the ISO C standard The compiler checks the C source against this standard and may generate warnings or errors if you use C language that is not defined in the standard C90 is also referred to as the ANSI C standard C99 refers to the newer ISO IEC 9899 1999 E standard C99 is the default carm iso 90 test c Related information db C compiler option language Language extensions 5 21 ARM Embedded Tools Reference C Compiler keep output files k Menu entry Altium Designer always removes the src file when errors occur during compilation Command line syntax keep output files k Description If an error occurs during compilation the resulting src file may be incomplete or incorrect With this option you keep the generated output file src when an error occurs By default the compiler removes the generated output file src when an error occurs This is useful when you use the make utility If the erroneous files are not remove
80. reports any warnings and or errors Related information d gt C compiler option check Check syntax 5 56 Tool Options Assembler Assembler cpu C Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Processor entry and select Processor Definition 3 Select a processor from the Select processor box Command line syntax cpu ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M xS C ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M XS Description With this option you specify the ARM architecture for which you create your application The architecture determines which instructions are valid and which are not If the architecture is ARMV4 the linker replaces BX instructions by MOV PC instructions The default architecture is ARMv4T and the complete list of supported architectures is ARMv4 ARMv4T ARMv5T ARMvV5TE ARMv6 M ARMv7 M or XScale Assembly code can check the value of the option by means of the built in function cPu Architecture ARMv4 does not support the Thumb instruction set Architecture profile ARMv7 M only supports the Thumb 2 instruction set i e it has no ARM execution state When you call the assembler from the command line make sure you specify the same core type to the compiler to avoid conflicts Related information d gt Assembly function CPU 5 57 ARM Embedded Tools Reference Assembler debug info g Menu entry
81. set by RTOS EILSEQ 30 ENODEV 31 2 4 Invalid or incomplete multibyte or wide character Operation canceled No such device Libraries 2 2 6 fcntl h The file ont1 h contains the function open which calls the low level function open and definitions of flags used by the low level function open This header file is not defined in ISO C99 open Opens a file for reading or writing Calls open FSS implementation 2 2 7 fenv h Contains mechanisms to control the floating point environment The functions in this header file are not implemented fegetenv Stores the current floating point environment Not implemented feholdexept Saves the current floating point environment and installs an environment that ignores all floating point exceptions Not implemented fesetenv Restores a previously saved fegetenv or feholdexcept floating point environment Not implemented feupdateenv Saves the currently raised floating point exceptions restores a previousely saved floating point environ ment and finally raises the saved exceptions Not implemented feclearexcept Clears the current exception status flags corresponding to the flags specified in the argument Not im plemented fegetexceptflag Stores the current setting of the floating point status flags Not implemented feraiseexcept Raises the exceptions represented in the argument As a result other exceptions may be raised as well Not implemented fesetexc
82. suboptions to select which run time checks should be performed e Bounds checking e Report unhandled case in a switch e Malloc consistency checks e Stack overflow check e Division by zero check Command line syntax runtime flags r flags You can set the following flags when you specify r without flags the default is rbcm bounds b B bounds checking case c C report unhandled case in a switch malloc m M malloc consistency checks stack s S check for stack overflow zero z Z check for divide by zero Description This option controls a number of run time checks to detect errors during program execution Some of these checks require additional code to be inserted in the original application code and may therefore slow down the program execution The following checks are available Bounds checking Every pointer update and dereference will be checked to detect out of bounds accesses null pointers and uninitialized automatic pointer variables This check will increase the code size and slow down the program considerably In addition some heap memory is allocated to store the bounds information You may enable bounds checking for individual modules or even parts of modules only see pragma runtime Report unhandled case in a switch Report an unhandled case value in a switch without a default part This check will add one function call to every switch without a default part but it will have little impa
83. the IRQ FIQ interrupts mode __PIC_VECTORS Defined if position independent vectors are used __FIQ_HANDLER_INLINE Defined if you do not generate reserve the FIQ vector VECTOR_TABLE_ROM_ADDR ROM address of the vector table VECTOR_TABLE RAM SPACE Defined if space must be reserved for a copy of the vector table in RAM VECTOR_TABLE_RAM ADDR RAM address of the copy of the vector table VECTOR_TABLE_RAM_ COPY o if the linker should copy the vector table to Table 4 4 Defines used in arm lsl 4 4 Run time Environment 4 3 Stack and Heap The stack is used for local automatic variables and function parameters The following diagram shows the structure of a stack frame high memory incoming parameters stack lt Sp grows down saved on entry registers local variables outgoing parameters low memory lt SP during execution Figure 4 1 Stack diagram The ARM hardware has separate stack pointers for each processor mode These stack pointers should be initialized at run time This is taken care of by the startup code in the run time library by means of linker generated symbols defined in the LSL file See section 4 1 Startup Code for a list of these symbols You can define the values of these symbols in Altium Designer as follows 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Stack Heap 3 Make your chang
84. the Properties column address range The section must be located in the union of the address ranges shown in the Properties column end addresses are not included in the range address range size The sections must be located in some address range with size not larger than shown in the Properties column the second number in that field is the alignment requirement for the address range ballooned After locating all sections the largest remaining gap in the space is used completely for the stack and or heap Properties The contents depends on the Type column 6 7 ARM Embedded Tools Reference Sections The sections to which the rule applies restrictions between sections are shown in this column lt ordered contiguous clustered For contiguous sections the linker uses the section order as shown here Clustered sections can be located in any relative order Related information Section 5 11 Generating a Map File in Chapter Using the Linker of the user s manual Linker option map file Generate map file 6 8 Altium 7 Object File Formats Summ ary This chapter describes the formats of several object files 7 1 ELF DWARF Object Format The TASKING ARM toolset by default produces objects in the ELF DWARF 2 format For a complete description of the ELF and DWARF formats please refer to the Tool Interface Standard TIS ARM Embedded Tools Reference 7 2 Motorola S Record Format With the linker
85. the architecture space large id 1 mau 4 map src_offset 0 dest_offset 0 dest bus bus_name size 16M From bus to bus The next example maps an external bus called e_bus to an internal bus called i_bus This internal bus resides on a core called mycore The source bus has 16 data lines whereas the destination bus has only 8 data lines Therefore the keywords src_dbits and dest_dbits specify which source data lines are mapped on which destination data lines architecture mycore bus i_bus mau 4 space i_space map dest bus i bus size 256 bus e_bus mau 16 width 16 map dest bus mycore i_ bus srce_dbits 0 7 dest_dbits 0 7 It is not possible to map an internal bus to an external bus 8 19 ARM Embedded Tools Reference 8 6 Semantics of the Derivative Definition Keywords in the derivative definition derivative extends core architecture bus mau width map memory type reserved rom ram nvram mau size speed map section_layout section_setup map dest bus space dest_dbits dest_offset size src_dbits sre offset 8 6 1 Defining a Derivative With the keyword derivative you define a derivative and assign a unique name to it The name is used to refer to it at other places in the LSL file derivative name definitions If you are defining multiple derivatives that show great resemblance you can define the common features in a pare
86. the example below aN This option has the same effect as defining symbols via the DEFINE SET and EQU directives similar to define in the C language With the MACRO directive you can define more complex macros Example Consider the following assembly program with conditional code to assemble a demo program and a real program IF DEMO ate instructions for demo application ELSE ssi instructions for the real application ENDIF You can now use a macro definition to set the DEMO flag Macro Value DEMO 1 or empty asarm define DEMO test src asarm define DEMO 1 test src Note that both invocations have the same effect Related information Gls Assembler option option file Read options from file 5 59 ARM Embedded Tools Reference Assembler diag Menu entry 1 From the View menu select Workspace Panels System Messages The Messages panel appears 2 In the Messages panel right click on the message you want more information on A popup menu appears 3 Select More Info A Message Info box appears with additional information Command line syntax diag format all nr Description With this option you can ask for an extended description of error messages in the format you choose The output is directed to stdout normally your screen and in the format you specify You can specify the following formats html rtf or text default To create a file with the descripti
87. the linker If you do not specify this option the linker does not use a script file You can specify the existing file arm 1s1 or the name of a manually written linker script file You can use this option multiple times The linker processes the LSL files in the order in which they appear on the command line Related information db Section 5 9 Controlling the Linker with a Script in chapter Using the Linker of the user s manual 5 147 ARM Embedded Tools Reference Control Program mil link mil split Command line syntax mil link mil split Description With option mil link the C compiler links the optimized intermediate representation MIL of all input files and MIL libraries specified on the command line in the compiler The result is one single module that is optimized another time Option mil split does the same as option mil link but in addition the resulting MIL representation is written to a file with the suffix mil and the C compiler also splits the MIL representation and writes it to separate files with suffix ms One file is written for each input file or MIL library specified on the command line The ms files are only updated on a change With option mil split you can perform application wide optimizations during the frontend phase by specifying all modules at once and still invoke the backend phase one module at a time to reduce the total compilation time Related information d gt C compile
88. the linker option to allocate memory on demand is set then the linker will assume that all virtual addresses are mapped on physical memory You can override this behavior by specifying one or more memory definitions memory mem_name type rom mau 8 size 64k speed 2 map map_description d gt For a description of the keywords see section 8 6 3 Defining Internal Memory and Buses With the keyword bus you define a bus the combination of data and corresponding address bus The bus name is used to identify a bus and does not conflict with other identifiers Bus descriptions at the global scope outside any definition define external buses These are buses that are present on the target board bus bus_name mau 8 width 8 map map _ description d For a description of the keywords see section 8 5 2 Defining Internal Buses You can connect off chip memory to any derivative you need to map the off chip memory to a bus and map that bus on the internal bus of the derivative you want to connect it to 8 23 ARM Embedded Tools Reference 8 8 Semantics of the Section Setup Definition Keywords in the section setup definition section_setup stack min_size grows low_to_high high _to_low align fixed id heap min_size grows low_to_high high _to_low align fixed id vector _table vector size size id_symbol_ prefix run_addr template template_symbol vector prefix fill no_inline
89. the prefix that is defined in the default LSL file s if this attribute is changed the vectors declared in C source files are not included in the vector table When a vector supplied in an object file has exactly one relocation the linker will assume it is a branch to a handler function and can be removed when the handler is inlined in the vector table Otherwise no inlining is done This argument is required With the optional no_inline argument the vectors handlers are not inlined in the vector table With the optional copy argument a ROM copy of the vector table is made and the vector table is copied to RAM at startup With the optional id_symbol_prefix argument you can set an internal string representing a symbol name prefix that may be found on symbols in vector handler code When the linker detects such a symbol in a handler the symbol is assigned the vector number If the symbol was already assigned a vector number a warning is issued The i11 argument sets the default contents of vectors If nothing is specified for a vector this setting is used See below When no default is provided empty vectors may be used to locate large vector handlers and other sections Only one fill argument is allowed The vector field defines the content of vector with the number specified by id If a range is specified for id p q s t all vectors in the ranges inclusive are defined the same way With i111 symbo1_name the vector must jump to thi
90. the previous value of signalfunction for the specific signal or SIG_ERR if an error occurs 2 2 18 stdarg h The facilities in this header file gives you a portable way to access variable arguments lists such as needed for as fprintf and vfprintf va_copy is new in ISO C99 This header file contains the following macros va_arg ap type Returns the value of the next argument in the variable argument list It s return type has the type of the given argument type A next call to this macro will return the value of the next argument va_copy va_list dest This macro duplicates the current state of src in dest creating a second pointer into the va_list src argument list After this call va_arg may be used on src and dest independently va_end va_list ap This macro must be called after the arguments have been processed It should be called before the function using the macro va_start is terminated ANSI specification va_start va_list ap This macro initializes ap After this call each call to va_arg will return the value of the next lastarg argument In our implementation va_list cannot contain any bit type variables Also the given argument lastarg must be the last non bit type argument in the list 2 2 19 stdbool h This header file contains the following macro definitions These names for boolean type and values are consistent with C You are allowed to undefine or redefine the macros below define bool _Bool defi
91. the recursive call the macro acts as an environment variable This means that it is overruled by definitions in the recursive call Use the option e to prevent this You can specify as many macros as you like If the command line exceeds the limit of the operating system you can define the macros in an option file which you then must specify to the make utility with the option m file Defining macros on the command line is for example useful in combination with conditional processing as shown in the example below Example Consider the following makefile with conditional rules to build a demo program and a real program ifdef DEMO the value of DEMO is of no importance real abs real obj main obj lkarm demo obj main obj darm 1lsl lcarm lfparm else real abs real obj main obj lkarm real obj main obj darm 1sl lcarm lfparm endif You can now use a macro definition to set the DEMO flag tmk real abs DEMO 1 In both cases the absolute object file real abs is created but depending on the DEMO flag it is linked with demo obj or with real obj Related information Make utility option e Environment variables override macro definitions Make utility option m Name of invocation file 5 169 ARM Embedded Tools Reference Make Utility Command line syntax Description Displays an overview of all command line options Example The following invocation displays a list of the available command line options tmk
92. the same are claimed v8 0 31 3 08 Table of Contents Table of Contents C Language 1 1 1 1 IMOOUCHON siine ctv enced Seinen aut Saar a ate ome naan cue had Bora Rasen Taa 1 1 1 2 Data TYPES 2h ceed cen bedaced enn Mies ibd a a i i dion edward eee einen ood 1 2 1 2 1 Changing the Alignment unaligned _ packed__ and ___align 1 2 1 3 Placing an Object at an Absolute Address at 0 eee eee ees 1 3 1 4 Using Assembly in the C Source _ASM 0 ee tte eens 1 4 1 5 Pragmas to Control the Compiler 0 cece eee 1 8 1 6 Predefined Preprocessor Macros 0 cece cece t ee ten nn eees 1 12 1 7 Switch Statement ss c sec0 wate We Pave ee vag ee Oh Pde a ea eee ie etl 1 13 1 8 FUNCIONS yae iaaa Sie ier rn teen peed ae eel Pane Oia Hee eed 1 14 1 8 1 Parameter Passing a adiecrsa cman nlonnad emanate haw OA Ate Aiud 4 had TEE Week a ea eer 1 14 1 8 2 Function Return Types sii ncat8 iii thither dead ibaddotdd E A boy bbe hada bid 1 14 1 8 3 Inlining Functions inline __noinline 0 0000 1 15 1 8 4 IntrinSic FUNCUONS messere tai eE hao Been alent a arlene bys 1 16 1 8 5 Interrupt Functions Exception Handlers 0 eens 1 18 1 8 5 1 Defining an Exception Handler __interrupt keywords 00 cece eee eee eee 1 18 1 8 5 2 Interrupt Frame frame ss cee ceca eeceas cae dan eee eae ni peed Cee ee eR ee eas 1 19 1 9 LIDFANGS sede Bee ee Peak ade pea a Geb ag aes a pe
93. the symbol _lc_bs occurs as an undefined reference in an object file the linker allocates space for the stack 8 32 Linker Script Language 8 9 5 Conditional Group Statements Within a group you can conditionally select sections or create special sections e With the if keyword you can specify a condition The succeeding section statement is executed if the condition evaluates to TRUE 1 e The optional else keyword is followed by a section statement which is executed in case the if condition evaluates to FALSE 0 group if exists mysection select mysection else reserved myreserved size 2k 8 33 ARM Embedded Tools Reference 8 34 9 MISRA C Rules Summ ary chapter contains an overview of the supported and unsupported MISRA C rules 9 1 MISRA C 1998 This section lists all supported and unsupported MISRA C 1998 rules db See also section 2 7 C Code Checking MISRA C in Chapter Using the Compiler of the User s Manual AN A number of MISRA C rules leave room for interpretation Other rules can only be checked in a limited way In such cases the implementation decisions and possible restrictions for these rules are listed x means that the rule is not supported by the TASKING C compiler R is a required rule A is an advisory rule R The code shall conform to standard C without language extensions x A Other languages should only be used with an interfa
94. to format the generated list file width Number of characters on a line 1 255 Default is 132 length Number of lines per page 10 255 Default is 66 blanktop Number of blank lines at the top of the page Default 0 Specify a value so that blanktop blankbtm lt length 10 blankbtm Number of blank lines at the bottom of the page Default 0 Specify a value so that blanktop blankbtm lt length 10 blankleft Number of blank columns at the left of the page Default 0 Specify a value smaller than width If you use the PAGE directive without arguments it causes a formfeed the next source line is printed on the next page in the list file You can omit an argument by using two adjacent commas If the remaining arguments after an argument are all empty you can omit them A label is not allowed with this directive Example PAGE PAGE 96 PAGE 5 formfeed the next source line is printed on the next page in the list file set pagewidth to 96 Note that you can omit the last four arguments insert five blank lines at the top Note that you can omit the last two arguments Related information dE TITLE Set program title in header of assembler list file Assembler option list file Generate list file in Section 5 2 Assembler Options of Chapter Tool Options 3 36 Assembly Language REPEAT ENDREP Syntax label REPEAT expression ENDREP Description
95. with ISO C This chapter describes the specific target features of the C language including language extensions that are not standard in ISO C For example pragmas are a way to control the compiler from within the C source The following language extensions are described e Data types e Keywords e Function qualifiers e Intrinsic functions e Pragmas e Predefined macros Chapter 2 Libraries Contains overviews of all library functions you can use in your C source First libraries are listed per header file that contains the prototypes These tables also show the level of implementation per function Second all library functions are listed and discussed into detail Chapter 3 Assembly Language Describes the specific features of the assembly language as well as directives which are pseudo instructions that are interpreted by the assembler Chapter 4 Run time Environment Describes the startup code used by the C compiler the vector table the stack layout and the heap Chapter 5 Tool Options Contains a description of all tool options e C compiler options e Assembler options e Linker options e Control program options e Make utility options e Librarian options Chapter 6 List File Formats Contains a description of the following list file formats e Assembler List File Format e Linker Map File Format Chapter 7 Object File Formats Contains a description of the following object file formats e ELF DWAR
96. z isprint iswprint Returns a non zero value when c is printable including spaces ispunct iswpunct Returns a non zero value when c is a punctuation character such as isspace iswspace Returns a non zero value when c is a space type character space tab vertical tab formfeed linefeed carriage return isupper iswupper Returns a non zero value when c is an uppercase character A Z isxdigit iswxdigit Returns a non zero value when c is a hexadecimal digit O 9 A F a f tolower towlower Returns c converted to a lowercase character if it is an uppercase character otherwise c is returned toupper towupper Returns c converted to an uppercase character if it is a lowercase character otherwise c is returned _tolower Converts c to a lowercase character does not check if c really is an uppercase character Implemented as macro This macro function is not defined in ISO C99 _toupper Converts c to an uppercase character does not check if c really is a lowercase character Implemented as macro This macro function is not defined in ISO C99 isascii Returns a non zero value when c is in the range of 0 and 127 This function is not defined in ISO C99 toascii Converts c to an ASCII value strip highest bit This function is not defined in ISO C99 2 3 ARM Embedded Tools Reference 2 2 4 dbg h The header file dbg h contains the debugger call interface for file system simulation It contains l
97. 1 s2 n Copies n characters from s2 into s1 and returns s1 If s1 and s2 overlap the result is undefined wmemmove sl1 s2 n Same as memcpy but overlapping strings are handled correctly Returns s1 wcscpy s1 s2 Copies s2 into s1 and returns s1 If s1 and s2 overlap the result is undefined wesncpy s1 s2 n Copies not more than n characters from s2 into s7 and returns s7 If s1 and s2 overlap the result is undefined wescat s1 s2 Appends a copy of s2 to s7 and returns s7 If s7 and s2 overlap the result is undefined wesncat sl1 s2 n Appends not more than n characters from s2 to s7 and returns s7 If s1 and s2 overlap the result is undefined 2 19 ARM Embedded Tools Reference Comparison functions stdio h wchar h Description memcmp sl s2 n stremp sl1 s2 strncemp sl s2 n strcoll sl1 s2 strxfrm sl1 s2 n Search functions stdio h wmemcmp sl1 s2 n wescmp sl1 s2 wesncemp sl1 s2 n wescoll sl s2 wesxfrm sl s2 n wcehar h Compares the first n characters of s7 to the first n characters of s2 Returns lt 0 if s1 lt s2 0 if s1 s2 or gt Oif s7 gt s2 Compares string s7 to string s2 Returns lt 0 if s7 lt s2 0 if s s2 or gt O if s7 gt s2 Compares the first n characters of s7 to the first n characters of s2 Returns lt 0 if s1 lt s2 0 if s1 s2 or gt Oif s7
98. 1 15 inline noinline smartinline 1 8 Inlining 5 18 Input specification 3 1 Instructions 3 1 generic 3 1 3 51 Intel hex record type 7 5 Intel Hex record format 7 5 Index 6 Interrupt frame 1 19 Interrupt functions 1 18 __frame 1 19 __interrupt 1 18 __interrupt_dabt 1 18 __interrupt_fiq 1 18 __interrupt_iabt 1 18 __interrupt_irq 1 18 __interrupt_svc 1 18 __interrupt_und 1 18 Interrupt service routine 1 18 Intrinsic functions 1 16 isalnum 2 3 isalpha 2 3 isblank 2 3 iscntrl 2 3 isdigit 2 3 isfinite 2 10 isgraph 2 3 isgreater 2 10 isgreaterequal 2 10 isinf 2 10 isless 2 10 islessequal 2 10 islessgreater 2 10 islower 2 3 isnan 2 10 isnormal 2 10 ISO C standard selecting 5 21 5 141 isprint 2 3 ispunct 2 3 isspace 2 3 isunordered 2 10 isupper 2 3 iswalnum 2 3 2 24 iswalpha 2 3 2 24 iswblank 2 3 iswentrl 2 3 2 24 iswctype 2 24 iswdigit 2 3 2 24 iswgraph 2 3 2 24 iswlower 2 3 2 24 iswprint 2 3 2 24 iswpunct 2 3 2 24 iswspace 2 3 2 24 iswupper 2 3 2 24 iswxdigit 2 3 iswxditig 2 24 isxdigit 2 3 J Jump chain 1 13 Jump table 1 13 jump_switch 1 10 L L_tmpnam 2 12 Label 3 2 Index Labels 3 1 labs 2 19 Idexp functions 2 8 Idiv 2 19 Igamma functions 2 10 Librarian options 5 195 d 5 196 f 5 197 m 5 198 p 5 199 r 5 200 t 5 202 V 5 203 w 5 204 x 5 205 add
99. 2 14 2 15 conversion characters 2 15 scanf versions 1 20 Section 3 38 section endsection 1 10 Section attributes 3 38 Section information 5 82 Index 10 Section layout definition 8 2 8 25 Section renaming 5 40 Section setup definition 8 24 section_code_init 1 10 section_const_init 1 10 section_no_code_init 1 10 section_no_const_init 1 10 Sections 3 38 grouping 8 26 SEEK_CUR 2 12 2 16 SEEK_END 2 12 2 16 SEEK_SET 2 12 2 16 set 3 39 setbuf 2 13 setjmp 2 10 setlocale 2 6 setvbuf 2 13 SIGABRT 2 11 SIGFPE 2 11 SIGILL 2 11 SIGINT 2 11 signal 2 11 signbit 2 10 SIGSEGV 2 11 SIGTERM 2 11 sin functions 2 7 sinh functions 2 7 size 3 40 size_t 2 11 smart_switch 1 10 smartinline 1 9 snprintf 2 15 source 3 41 source nosource 1 10 sprintf 2 15 sqrt functions 2 9 srand 2 18 sscanf 2 15 Stack 8 16 Start address 8 18 Startup code 4 1 stat 2 22 Statement 3 1 stderr 2 12 stdin 2 12 stdinc 1 10 stdout 2 12 strcat 2 19 3 8 strchr 2 20 strcmp 2 20 3 8 strcoll 2 20 strcpy 2 19 strespn 2 20 strerror 2 20 strftime 2 21 strlen 3 8 strncat 2 19 strncmp 2 20 Index strncpy 2 19 strpbrk 2 20 strpos 3 8 strrehr 2 20 strspn 2 20 strstr 2 20 strtod 2 18 strtof 2 18 strtoimax 2 6 strtok 2 20 strtol 2 18 strtold 2 18 strtoll 2 18 strtoul 2 18 strtoull 2 18 strtoum
100. 2 32 bit Generic Instructions LDR ARM and Thumb 2 generic Load an address or a 32 bit constant value into a register If the constant or its bitwise negation can be encoded then the assembler will generate a MOV or a MVN instruction Otherwise the assembler places the constant or the address in a literal pool and generates a PC relative LDR instruction that loads the value from the literal pool Instruction Replacement Description LDRcond Rd expr MOVcond Rd expr If expr can be encoded MVNcond Rd LSW expr If expr can be encoded LDRcond Rd ltpool If expr is external or PC relative or cannot be code encoded ltpool DW expr The PC relative offset from the LDR instruction to the value in the literal pool must be positive and less than 4 kB By default the assembler will place a literal pool at the end of each code section If the default literal pool is out of range you will have to ensure that there is another literal pool within range by means of the LTORG directive VLDR ARM and Thumb 2 generic Load a 32 bit or 64 bit floating point constant value into a register The assembler places the constant in a literal pool and generates a PC relative VLDR instruction that loads the value from the literal pool 3 51 ARM Embedded Tools Reference Instruction Replacement VLDRcond Sd expr VLDRcond Sd lItpool code Itpool FLOAT expr VLDRcond Dd expr VLDRcond Dd ltpoo
101. 4 5 118 code compaction 5 18 inlining 5 19 optimize for speed size 5 48 optimize endoptimize 1 9 Option file 5 35 5 119 5 154 5 182 Options saving restoring 5 35 5 119 P page 3 36 Parameter passing 1 14 Passing options 5 156 perror 2 17 Phase angle 2 3 pow functions 2 9 Pragmas 1 8 Predefined preprocessor macros 1 12 3 3 Predefined preprocessor symbols 3 3 Preprocessing 5 59 5 79 5 152 5 157 8 3 storing output 5 37 Index 9 ARM Embedded Tools Reference printf 2 13 2 15 conversion characters 2 14 printf versions 1 20 Processor definition 8 2 8 22 Processor options processor definition 5 6 5 57 5 91 Processor type assembling for 5 57 compiling for 5 6 5 129 selecting 5 6 5 57 5 129 profile 1 9 Profiling 5 38 5 158 profiling 1 9 protect 1 10 ptrdiff_t 2 11 putc 2 16 putchar 2 16 puts 2 16 putwc 2 16 putwchar 2 16 Q qsort 2 19 R raise 2 11 rand 2 18 RAND_MAX 2 17 read 2 22 realloc 2 7 2 18 Register usage 1 14 remainder functions 2 9 remove 2 17 remquo functions 2 9 rename 2 17 Renaming sections 5 40 repeat endrep 3 37 Reserved address ranges 8 18 Reset handler 4 1 4 2 Reset vector 8 18 Return decimal value operator 3 48 Return hex value operator 3 48 rewind 2 17 Riemann sphere 2 3 rint functions 2 8 round functions 2 8 Run time checks 5 41 runtime 1 10 S scalbln functions 2 8 scalbn functions 2 8 scanf
102. 5 116 Tool Options Linker Linker no warnings w Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Diagnostics 3 Set Error reporting to one of the following values e Report all warnings e Suppress all warnings e Suppress specific warnings If you select Suppress specific warnings 4 Enter the numbers separated by commas of the warnings you want to suppress Command line syntax no warnings number w number Description With this option you can suppresses all warning messages or specific warning messages e If you do not specify this option all warnings are reported e If you specify this option but without numbers all warnings are suppressed e If you specify this option with a number only the specified warning is suppressed You can specify the option no warnings number multiple times Example To suppress warnings 135 and 136 enter 135 136 in the Specific warnings to suppress field or enter the following on the command line lkarm no warnings 135 136 test obj Related information d gt Linker option warnings as errors Treat warnings as errors 5 117 ARM Embedded Tools Reference Linker optimize O Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Optimization 3 Select an op
103. 5 131 Debug information 5 61 define 3 18 defined 3 7 Defining a macro 3 46 Derivative definition 8 1 8 20 dh 3 19 Index difftime 2 21 Directives 3 1 div 2 19 double 3 25 Double as float 5 150 ds 3 20 dsb 3 20 dsd 3 20 dsh 3 20 dsw 3 20 dw 3 21 E ELF DWARF object format 7 1 end 3 22 Endianness 5 12 5 62 5 94 5 135 endprofile 1 9 endprotect 1 10 EOF 2 12 equ 3 23 erf functions 2 10 erfc functions 2 10 errno 2 4 Exception handler 1 18 defining 1 18 exit 2 18 EXIT_FAILURE 2 17 EXIT_SUCCES 2 17 exp functions 2 8 exp2 functions 2 8 expm1 functions 2 8 Expressions 3 3 absolute 3 3 relative 3 3 relocatable 3 3 extension isuffix 1 8 extern 1 8 3 24 F fabs functions 2 9 fclose 2 13 fdim functions 2 9 FE_ALL_EXCEPT 2 5 FE_DIVBYZERO 2 5 FE_INEXACT 2 5 FE_INVALID 2 5 FE_OVERFLOW 2 5 FE_UNDERFLOW 2 5 feclearexcept 2 5 fegetenv 2 5 fegetexceptflag 2 5 feholdexept 2 5 feof 2 17 feraiseexcept 2 5 ferror 2 17 fesetenv 2 5 fesetexceptflag 2 5 fetestexcept 2 5 feupdateenv 2 5 fflush 2 13 fgetc 2 16 fgetpos 2 17 fgets 2 16 fgetwc 2 16 fgetws 2 16 FILENAME_MAX 2 12 float 3 25 Floating point unit 5 14 floor functions 2 8 fma functions 2 9 fmax functions 2 9 fmin functions 2 9 fmod functions 2 9 fopen 2 13 FOPEN_MAX 2 12 for endfor 3 26 fpclassify 2 10 fprintf 2 15 fputc 2 16 fputs 2 16 fp
104. 6 Creating or Modifying Special Sections 0 c cece ete ete 8 30 Creating SYMbOIS 5 4 h ec oria ciis iae ei ea ar ana e A ee baed a 8 32 Conditional Group Statements e ssassn eune ea aeaaee aaee 8 33 1 MISRA C 1998 2434 0c ohaped epenn a epbl ae E iE e E bee 9 1 MISRA C 2004 seerne etak aaae a wane TERA i EEEE eee an Ra EPE 9 5 ARM Embedded Tools Reference vi Manual Purpose and Structure Manual Purpose and Structure Windows Users The documentation explains and describes how to use the TASKING ARM toolset to program a ARM processor You can use the tools either with the graphical Altium Designer or from the command line in a command prompt window Structure The toolset documentation consists of a user s manual Using the ARM Embedded Tools which includes a Getting Started section and a separate reference manual this manual Start by reading the Getting Started in Chapter 1 of the user s manual The other chapters in the user s manual explain how to use the compiler assembler linker and the various utilities Once you are familiar with these tools you can use this reference manual to lookup specific options and details to make full use of the TASKING toolset The reference manual describes the C language implementation and the assembly language vii ARM Embedded Tools Reference Short Table of Contents Chapter 1 C Language The TASKING C compilers are fully compatible
105. 7 8 28 8 31 fixed 8 16 8 30 group 8 26 8 27 grows 8 16 heap 8 16 8 30 high_to_low 8 16 8 26 id 8 15 8 16 id_symbol_prefix 8 17 if 8 33 load_adadr 8 29 low_to_high 8 16 8 26 map 8 15 8 16 8 18 8 21 mau 8 15 8 16 8 21 8 23 Index 8 mem 8 29 memory 8 21 8 23 min_size 8 16 8 30 no_inline 8 17 nocopy 8 28 nvram 8 21 ordered 8 28 overflow 8 31 overlay 8 28 page 8 16 8 29 page_size 8 16 8 29 priority 8 30 processor 8 22 ram 8 21 ref_tree 8 27 reserved 8 18 8 21 8 30 rom 8 21 run_adadr 8 17 8 18 8 29 section 8 31 section_layout 8 25 section_setup 8 24 select 8 26 size 8 17 8 18 8 21 8 23 8 30 8 31 space 8 15 8 18 speed 8 21 8 23 src_dbits 8 18 src_offset 8 18 stack 8 16 8 30 start_address 8 18 symbol 8 18 template 8 17 template_symbol 8 17 type 8 21 8 23 vector 8 17 vector_prefix 8 17 vector_size 8 17 vector_table 8 17 width 8 15 LSL syntax 8 3 architecture definition 8 7 board specification 8 10 bus definition 8 6 derivative definition 8 9 memory definition 8 6 processor definition 8 10 section layout definition 8 10 Istat 2 23 Isw 3 7 ltorg 3 31 macro nomacro 1 9 Macro argument string 3 48 Macro call 3 1 Macro definition 5 8 5 59 5 132 Macro operations 3 46 macro endm 3 32 Index Macros 3 46 for directive 3 49 repeat directive 3 49 argument concatenation 3 47 argument operator 3 47 argume
106. 7 Memory and Bus Definitions mem_def memory mem_name lt mem descr gt 7 e Amem def defines a memory with the mem_name as a unique name mem_descr 7 type lt reserved gt 1 mem type mau expr size expr speed number mapping e Amem def contains exactly one type statement e Amem def contains exactly one mau statement non zero size e Amem def contains exactly one size statement e Amem def contains zero or one speed statement default value is 1 e Amem def contains at least one mapping mem_type rom attrs rx ram attrs rw nvram attrs rwx bus_def bus bus_name lt bus_descr gt 7 e Abus_def statement defines a bus with the given bus_name as a unique name within a core architecture bus_descr mau expr width expr bus width nr l of data bits mapping legal destination bus only e The mau and width statements appear exactly once ina bus_descr The default value for width is the mau size e The bus width must be an integer times the bus MAU size 8 6 Linker Script Language e The MAU size must be non zero e Abus can only have a mapping ona destination bus through dest bus mapping map map_descr lt map _descr gt map descr dest destination dest_dbits range dest_offset expr size expr sre_dbits range src_offset expr e A mapping requires at least the size and dest stat
107. ARM Embedded Tools Reference TRO131 May 05 2008 Software hardware documentation and related materials Copyright 2008 Altium Limited All Rights Reserved The material provided with this notice is subject to various forms of national and international intellectual property protection including but not limited to copyright protection You have been granted a non exclusive license to use such material for the purposes stated in the end user license agreement governing its use In no event shall you reverse engineer decompile duplicate distribute create derivative works from or in any way exploit the material licensed to you except as expressly permitted by the governing agreement Failure to abide by such restrictions may result in severe civil and criminal penalties including but not limited to fines and imprisonment Provided however that you are permitted to make one archival copy of said materials for back up purposes only which archival copy may be accessed and used only in the event that the original copy of the materials is inoperable Altium Altium Designer Board Insight DXP Innovation Station LiveDesign NanoBoard NanoTalk OpenBus P CAD SimCode Situs TASKING and Topological Autorouting and their respective logos are trademarks or registered trademarks of Altium Limited or its subsidiaries All other registered or unregistered trademarks referenced herein are the property of their respective owners and no trademark rights to
108. ARM Generic Instructions The ARM assembler recognizes the following generic instructions in ARM mode ADR ADRL ADRLL ARM generics Load a PC relative address into a register The address is specified as a target label The assembler generates one ADR two ADRL or three ADRLL generic DPR instruction called ADR and one two or three PC relative relocation types for the target label The linker evaluates the relocation types calculate the PC relative offset and generates one two or three add or sub instructions each with an 8 bit immediate operand plus a 4 bit rotation If the offset cannot be encoded the linker generates an error message Instruction Replacement ADRcond Rad label ADRcond Rd PC ALUPCREL abel 0 1 ADRLcond Rad label ADRcond Rd PC ALUPCREL abel 0 0 ADRcond Rd Rd ALUPCREL label 1 1 ADRLLcond Rd label ADRcond Rd PC ALUPCREL abel 0 0 ADRcond Rd Rd ALUPCREL label 1 0 ADRcond Rd Rd ALUPCREL label 2 1 BX for ARMv4 The ARMV4 architecture does not support the BX instruction in hardware If the option cpu ARMv4 or cpu ARMV4T was specified the assembler will emit a relocation type at the location of the BX instruction The linker will replace the BX instruction by a MOV instruction if the option cpu ARMV4 was specified Instruction Replacement by linker Description BXcond Rm MOVcond PC Rm Only if architecture is ARMv4 3 10 2 ARM and Thumb
109. E 308 _Imaginary float 32 32 3 402E 38i 1 175E 38 1 175E 38i 3 402E 38i _Imaginary double 64 64 1 798E 308i 2 225E 308i _Imaginary long double 2 225E 308i 1 798E 308 _Complex float 64 32 real part imaginary part Complex double p 128 64 real part imaginary part _Complex long double Table 1 1 Data Types for the ARM 1 2 1 Changing the Alignment __unaligned _packed__ and __align Normally data pointers and structure members are aligned according to the table in the previous section Suppress alignment With the type qualifier unaligned you can specify to suppress the alignment of objects or structure members This can be useful to create compact data structures In this case the alignment will be one bit for bit fields or one byte for other objects or structure members At the left side of a pointer declaration you can use the type qualifier unaligned to mark the pointer value as potentially unaligned This can be useful to access externally defined data However the compiler can generate less efficient instructions to dereference such a pointer to avoid unaligned memory access C Language Example struct char c _ unaligned int i aligned at offset 1 S _ unaligned int up amp s i Packed structures To prevent alignment gaps in structures you can use the attribute packed__ When you use the attribute packed__ directly after the keyword struct all structure
110. Embedded Tools Reference Linker library l Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Libraries 3 Enable the option Link default C libraries Command line syntax library name Iname Description With this option you tell the linker to use system library name Lib where name is a string The linker first searches for system libraries in any directories specified with library directory then in the directories specified with the environment variable LIBARM unless you used the option ignore default library path Example To search in the system library carm lib C library lkarm test obj mylib lib library carm The linker links the file test obj and first looks in mylib 1ib in the current directory only then in the system library carm 1ib to resolve unresolved symbols Related information d Linker option library directory Additional search path for system libraries Section 5 4 Linking with Libraries in chapter Using the Linker of the user s manual 5 104 Tool Options Linker Linker library directory L ignore default library path Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Open the Build Options page 3 Add a pathname in the Library files path field If you enter multiple paths separate them with a semicolon
111. F 2 Object Format e Motorola S Record Format e Intel Hex Record Format Chapter 8 Linker Script Language Contains a description of the linker script language LSL Chapter 9 MISRA C Rules Contains a description the supported and unsupported MISRA C code checking rules viii Manual Purpose and Structure Conventions Used in this Manual Notation for syntax The following notation is used to describe the syntax of command line input bold Type this part of the syntax literally italics Substitute the italic word by an instance For example filename Type the name of a file in place of the word filename Encloses a list from which you must choose an item Encloses items that are optional For example carm Both carm and carm are valid commands Separates items in a list Read it as OR You can repeat the preceding item zero or more times Example carm option filename You can read this line as follows enter the command carm with or without an option follow this by zero or more options and specify a filename The following input lines are all valid carm test c carm g test c carm g s test c Not valid is carm g According to the syntax description you have to specify a filename Icons The following illustrations are used in this manual AN Note notes give you extra information A Warning read the information carefully It prevents you from making serious mistakes or from loosing
112. ING preprocessor When the assembly source file does not contain any preprocessor symbols you can specify to the assembler not to use a preprocessor Related information ie 5 80 Tool Options Assembler Assembler relaxed Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Enable the option Allow 2 operand form for 3 operand instructions Command line syntax relaxed Description With this option you tell the assembler that a relaxed 2 operand syntax is allowed on 3 operand instructions If the first two register operands are equal you can replace the two registers by one Example Instead of add rl1 r1 4 you can write add r1 4 and instead of add r1 r1 r2 you can write add r1 r2 Related information ie 5 81 ARM Embedded Tools Reference Assembler section info t Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select List File 3 Enable Generate list file 4 Enable the option Display section information Command line syntax section info flags t flags You can set the following flags console c C Display section information on stdout list I L Write section information to the list file Description With this option you tell the assembler to display s
113. ISION __ Identifies the revision number of the compiler For example if you use version 1 0r2 of the compiler _ REVISION _ expands to 2 __ SINGLE _FP__ Expands to 1 if you used option no double Treat double as float otherwise unrecognized as macro _ TASKING _ Identifies the compiler as a TASKING compiler Expands to 1 if a TASKING compiler is used _ THUMB _ Expands to 1 if you used option thumb otherwise unrecognized as macro __VERSION _ Identifies the version number of the compiler For example if you use version 1 0r2 of the compiler _VERSION__ expands to 1000 dot and revision number are omitted minor version number in 3 digits Table 1 3 Predefined preprocessor macros Example ifdef _ CARM __ this part is only compiled for the ARM endif C Language 1 7 Switch Statement The TASKING C compiler supports three ways of code generation for a switch statement a jump chain linear switch a jump table or a binary search table A jump chain is comparable with an if else if else if else construction A jump table is a table filled with jump instructions for each possible switch value The switch argument is used as an index to jump within this table A binary search table is a table filled with a value to compare the switch argument with and a target address to jump to pragma smart_switch is the default of the compiler The compiler tries to use the switch method which uses the least s
114. If you do not specify start the search is started from the beginning of string1 Example ID set STRPOS TASKING ASK ID ID set STRPOS TASKING BUG ID 7 THUMB Q Returns1 if the assembler runs in Thumb mode by default or 0 if the assembler runs in ARM mode default This function reflects the setting of the option thumb T So it does not depend on the CODE16 CODE32 ARM or THUMB directive If you are in a CODE32 part and you specified T THUMB still returns 1 Assembly Language 3 8 Assembler Directives An assembler directive is simply a message to the assembler Assembler directives are not translated into machine instructions but can produce data There are three types of assembler directives Assembler directives that tell the assembler how to go about translating instructions into machine code This is the most typical form of assembly directives Typically they tell the assembler where to put a program in memory what space to allocate for variables and allow you to initialize memory with data When the assembly source is assembled a location counter in the assembler keeps track of where the code and data is to go in memory The following directives fall under this group Assembly control directives Symbol definition directives Data definition Storage allocation directives HLL directives Directives that are interpreted by the macro preprocessor These directives t
115. Inthe Startup code Vector table page enable the option Reserve space for copy in RAM and fill in the RAM address Optionally enable the option Copy vector table to RAM Refer to the run time library implementation of the init _vector_table routine in Lib src initvectortable asmor initvectortable_thumb asm for more information Vecior table versions all architectures except M profile You can select between two versions of the vector table position dependent or position independent The position dependent table contains branch instructions to the handlers The handlers must be located in range of the branch instructions The size of the table is 32 bytes The position independent table contains PC relative load instructions of the PC The handler addresses are in a literal pool data pocket following the vector table There are no range restrictions The size of the table and pool together is 64 bytes A position independent table is recommended if the table is copied from ROM to RAM at run time or if the ROM table is re mapped to address 0x00000000 after startup e Inthe Startup code Vector table page select the Vector type position dependent or position independent If you selected a position dependent vector table it is possible to locate the FIQ handler directly at the FIQ vector since the FIQ vector is the last vector in the table Doing so saves a branch instruction when servicing a fast interrupt The generated vector table o
116. KKI KK IKK IKK K KIKI KK IKKE KIBAKI KIKI A KKK K RRR KI KEK KIKI KK KK IKK KIKI KKK IKK IK IKI IKKE RII KIRA IK FEI III IOI ISSO IOSD I ISIS I IOS TIS KKK KAKARAKA KAKAK Ca Graph A AE E A A K e e A A A K i Sa EIEIO R e E K A A I IIE I III I IIE main printloop printf s printf printf _doprint _doprint_int c _emitchar _doprint_int c _putnumber _doprint_int c _emitchar _doprint_int c _putstring strlen _doprint_int c _ltoa _doprint_int c _putstring _doflt List File Formats FEI ICICI ICICI ICI IOI ICIS OCI E Locate Res uT t AA A e k A e aida a IEE III ICICI I Ae E A e I IIIA RI IIR RI IIA Task entry address symbol _START Sections system xrom _vector_0 338 0x00000004 0x00000020 0x00000020 system xrom data libc 322 0x000000c8 0x00000040 0x00000040 system xrom text 2 0x00000018 0x00000134 0x00000134 system xrom rodata 5 0x0000000e 0x0000111c 0x0000111c system xrom table 321 0x00000030 0x0000112c 0x0000112c system xram stack_fig 315 0x00000008 0x01000000 0x0 system xram stack 314 0x00008000 0x010001a8 0x000001a8 Symbols sorted on name Josns ioe _APPLICATION MODE_ 0x0000001f system sw linear Exit 0x00000F34 _START 0x00000f38 main 0x00000134 4
117. M Embedded Tools Reference Assembler verbose v Menu entry Command line only Command line syntax verbose y Description With this option you put the assembler in verbose mode The assembler prints the filenames and the assembly passes while it processes the files so you can monitor the current status of the assembler Related information i 5 86 Tool Options Assembler Assembler warnings as errors Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Diagnostics 3 Enable the option Treat warnings as errors Command line syntax warnings as errors number Description If the assembler encounters an error it stops assembling When you use this option without arguments you tell the assembler to treat all warnings as errors This means that the exit status of the assembler will be non zero after one or more compiler warnings As a consequence the assembler now also stops after encountering a warning You can also limit this option to specific warnings by specifying a comma separated list of warning numbers Related information d gt Assembler option no warnings Suppress some or all warnings 5 87 ARM Embedded Tools Reference 5 3 Linker Options Altium Designer uses a makefile to build your entire project This means that you cannot run the linker separately However you can
118. MBOL MYSYMBOL EQU 0x4000 You cannot redefine the used symbols Related information d gt SET Set temporary value to a symbol 3 23 ARM Embedded Tools Reference EXTERN Syntax EXTERN symbol symbol Description With the EXTERN directive you define an external symbol It means that the symbol is referenced in the current module while it is defined outside the current module You must define the symbols either outside any module or declare it as globally accessible within another module with the GLOBAL directive If you do not use the EXTERN directive and the symbol is not defined within the current module the assembler issues a warning and inserts the EXTERN directive Example EXTERN AA CC DD defined elsewhere Related information db GLOBAL Declare global section symbol 3 24 Assembly Language FLOAT DOUBLE Syntax label FLOAT expression expression label DOUBLE expression expression Description With the FLOAT or DOUBLE directive the assembler allocates and initializes a floating point number 32 bits or a double 64 bits in memory for each argument An expression can be e a floating point expression e NULL indicated by two adjacent commas You can represent a constant as a signed whole number with fraction or with the e format as used in the C language 12 457 and 0 27E 13 are legal floating point constants If you specify label i
119. OS Passes the string s to the environment for execution NOTE this function is not implemented because there is no OS Libraries Searching and sorting bsearch key base n size cmp qsort base n size cmp Integer arithmetic int abs j long labs j long long llabs j div_t div x y ldiv_t ldiv x y lldiv_t lldiv x y This function searches in an array of n members for the object pointed to by key The initial base of the array is given by base The size of each member is specified by size The given array must be sorted in ascending order according to the results of the function pointed to by cmp Returns a pointer to the matching member in the array or NULL when not found This function sorts an array of n members using the quick sort algorithm The initial base of the array is given by base The size of each member is specified by size The array is sorted in as cending order according to the results of the function pointed to by cmp Compute the absolute value of an int long int and long long intj resepectively Compute x y and x y in a single operation X and y have respectively type int long int and long long int The result is stored in the members quot and remof struct div_t ldiv_t and 11div_t which have the same types Multibyte wide character and string conversions mblen s n mbtowc pwc s n wctomb s wc mbstowcs pwcs s n westombs s pwcs n Determines the number of byt
120. Rn imm32 ADCcondS Rd Rn imm32 ANDcond Rd Rn imm32 BICcond Rd Rn LSW imm32 ANDcondS Rd Rn imm32 BlCcondS Rd Rn LSW imm32 BlCcond Rd Rn imm32 ANDcond Rad Rn LSW imm32 BICcondS Rd Rn imm32 ANDcondS Rd Rn LSW imm32 CMNcond Rn imm32 CMPcond An imm32 CMPcond Rn imm32 CMNcond Rn imm32 MOVcond Rd imm32 MVNcond Rd LSW imm32 MOVcondS Rd imm32 MVNcondS Rd LSW imm32 MVNeond Rd imm32 MOVcond Rd LSW imm32 MVNcondS Rd imm32 MOVcondS Rd LSW imm32 Note that the built in function LSW must be used on the bitwise negated immediate value because all values are interpreted by the assembler as 64 bit signed values The LSW function returns the lowest 32 bits 3 52 Assembly Language 3 10 3 Thumb 16 bit Generic Instructions The ARM assembler recognizes the following generic instructions in Thumb mode ADR Thumb 16 bit generic Load a PC relative address into a low register The address is specified as a target label The PC relative offset must be less than 1 kB The target label must be defined locally must be word aligned and must be in the same code section as the instruction The assembler will not emit a relocation type for the target label If the offset is out of range or the target label is external or in another section then the assembler generates an error message LDR T
121. S p same as H M second 00 59 replaced by horizontal tab character ISO 8601 time format H M S ISO 8601 weekday number 1 7 Monday as first day of the week week number of the year Sunday as first day of the week 00 53 ISO 8601 week number 01 53 in the week based year weekday 0 6 Sunday is 0 week number of the year 00 53 week 1 has the first Monday local date representation local time representation year without century 00 99 year with century ISO 8601 offset of time zone from UTC or nothing time zone name if any unistd h The file unistd h contains standard UNIX I O functions These functions are all implemented using the debugger s file system simulation Except for lstat and fstat which are not implemented This header file is not defined in ISO C99 access name mode Use the file system simulation of the debugger to check the permissions of a file on the host mode specifies the type of access and is a bit pattern constructed by a logical OR of the following values R_OK Checks read permission W_OK Checks write permission X_OK Checks execute search permission F_OK Checks to see if the file exists FSS implementation chdir path Use the file system simulation feature of the debugger to change the current directory on the host to the directory indicated by path FSS implementation close fd File close function The given file descriptor should be properly closed
122. This function calls _close FSS implementation getcwd buf size Use the file system simulation feature of the debugger to retrieve the current directory on the host Returns the directory name FSS implementation lseek fd offset Moves read write file offset Calls _1seek whence FSS implementation read fd buff cnt Reads a sequence of characters from a file This function calls read FSS implementation stat name buff Use the file system simulation feature of the debugger to stat a file on the host platform 2 22 FSS implementation Libraries lstat name buff This function is identical to stat except in the case of a symbolic link where the link itself is stat ed not the file that it refers to Not implemented fstat fd buff This function is identical to stat except that it uses a file descriptor instead of a name Not implemented unlink name Removes the named file so that a subsequent attempt to open it fails Calls unlink FSS implementation write fd buff cnt Write a sequence of characters to a file Calls write FSS implementation 2 2 27 Wwchar h Many in wchar h represent the wide character variant of other so these are discussed together See sections 2 2 22 sidio h and wehar h 2 2 23 stdlib h and wchar h 2 2 24 string h and wehar h and 2 2 25 time h and wchar h The remaining are described below They perform conversions between multi byte
123. W Define Word DD Define Double Word Assembly Language DD Syntax label DD argument argument Description With the DD directive Define Double Word you allocate and initialize one double word of memory for each argument One double word is 64 bits An argument is e asingle or multiple character string constant e an expression e NULL indicated by two adjacent commas If you specify label it gets the value of the location counter at the start of the directive processing Multiple arguments are stored in sets of eight bytes If an argument is NULL its corresponding address locations are flled with zeros Double word arguments are stored as is Floating point values are not allowed If the evaluated argument is too large to be represented in a double word the assembler issues a warning and truncates the value In case of character strings each ASCII value of the character is stored in successive locations starting at the most significant byte of a double word DD AB D gt 0x4241000000000000 0x0000000000000000 second argument is empty 0x4400000000000000 Example TABLE DD 14 253 0x62 ABCD CHARS DD A B C D Related information d gt BS Block Storage DS Define Storage DB_ Define Byte DH Define Half Word DW Define Word 3 17 ARM Embedded Tools Reference DEFINE Syntax DEFINE symbol string Description With the DEFINE direct
124. abel is followed by a colon and can be prefixed by whitespace LAB1 This label has to start at the beginning of a line 1 b 1p This is an endless loop using numeric labels instruction An instruction consists of a mnemonic and zero one or more operands It must not start in the first column All instructions of the ARM Unified Assembler Language UAL are supported With assembler option old syntax you can specify to use the pre UAL syntax VFP instructions are only supported in the UAL syntax Operands are described in section 3 3 Operands of an Assembly Instruction The instructions are described in the target s Core Reference Manual The instruction can also be a so called generic instruction Generic instructions are pseudo instructions no instructions from the instruction set Depending on the situation in which a generic instruction is used the assembler replaces the generic instruction with appropriate real assembly instruction s For a complete list see section 3 10 Generic Instructions directive With directives you can control the assembler from within the assembly source Except for preprocessing directives these must not start in the first column Directives are described in section 3 8 Assembler Directives macro_call A call to a previously defined macro It must not start in the first column See section 3 9 Macro Operations 3 1 ARM Embedded Tools Reference comment Comment preceded by a
125. absolute value of z also known as norm modulus or magnitude Returns the complex value of z raised to the power w z where both z and w are complex numbers Returns the complex square root of zZ Returns the argument of z also known as phase angle Returns the imaginary part of z as a real respectively as a double float long double Returns the complex conjugate value the sign of its imaginary part is reversed Returns the value of the projection of z onto the Riemann sphere Returns the real part of z respectively as a double float long double 2 2 3 ctype h and wctype h The header file ctype h declares the following functions which take a character c as an integer type argument The header file wetype h declares parallel wide character functions which take a character c of the wchar_t type as argument ctype h wctype h Description isalnum iswalnum Returns a non zero value when c is an alphabetic character or a number A Z a z 0 9 isalpha iswalpha Returns a non zero value when c is an alphabetic character A Z a z isblank iswblank Returns a non zero value when c is a blank character tab space isentrl iswentrl Returns a non zero value when c is a control character isdigit iswditit Returns a non zero value when c is a numeric character 0 9 isgraph iswgraph Returns a non zero value when c is printable but not a space islower iswlower Returns a non zero value when c is a lowercase character a
126. acters shall not occur in include directives include shall be followed by either lt filename gt or filename Plain macros shall only be used for constants qualifiers specifiers Macros shall not be define d and undef d within a block undef should not be used A function should be used in preference to a function like macro A function like macro shall not be used without all arguments Macro arguments shall not contain pre preprocessing directives A violation is reported when the first token of an actual macro argument is Macro definitions parameters should be enclosed in parentheses Don t use undefined identifiers in pre processing directives A macro definition shall contain at most one or operator All uses of the pragma directive shall be documented This rule is really a documentation issue The compiler will flag all pragma directives as violations defined shall only be used in one of the two standard forms Pointer arithmetic should not be used ARM Embedded Tools Reference 102 103 104 105 106 107 108 109 110 111 112 113 114 115 x 116 x 117 118 119 120 121 122 123 124 125 126 127 A pu po Rees Ee e 33 R R R III IDDI IDIIDDII R R R No more than 2 levels of pointer indirection should be used A violation is reported when a poi
127. ample with one long long double arguments and one other argument func2 long long d chare e q first parameter is passed in register rO and r1 e e second parameter is passed in register r2 Example with two long long double arguments and one other argument func3 double f long long g char h e f first parameter is passed in register rO and r1 e g second parameter is passed in register r2 and r3 e h third parameter cannot be passed through registers anymore and is passed via the stack 1 8 2 Function Return Types The C compiler uses registers to store C function return values depending on the function return types Return Type Register _Bool rO char rO short rO int long rO C Language Return Type Register float rO 32 bit pointer rO 32 bit struct rO long long rOr1 double rOr1 64 bit struct rOr1 Table 1 5 Register usage for function return types Objects larger than 64 bits are returned via the stack 1 8 3 Inlining Functions inline __noinline With the C compiler option optimize inline the C compiler automatically inlines small functions in order to reduce execution time smart inlining The compiler inserts the function body at the place the function is called The C compiler decides which functions will be inlined You can overrule this behavior with the two keywords inline ISO C and__ noinline With the inline keyword you force th
128. and line you can create an option file which contains all options and flags you want to specify With this option you specify the option file to the compiler Use an option file when the command line would exceed the limits of the operating system or just to store options and save typing You can specify the option option file multiple times Format of an option file e Multiple arguments on one line in the option file are allowed e To include whitespace in an argument surround the argument with single or double quotes e If you want to use single quotes as part of the argument surround the argument by double quotes and vise versa This has a single quote embedded This has a double quote embedded This has a double quote and a single quote embedded e When a text line reaches its length limit use a to continue the line Whitespace between quotes is preserved This is a continuation line gt This is a continuation line e Itis possible to nest command line files up to 25 levels Example Suppose the file myoptions contains the following lines 9g DDEMO 1 test c Specify the option file to the C compiler carm option file myoptions This is equivalent to the following command line carm g DDEMO 1 test c Related information d gt 5 35 ARM Embedded Tools Reference C Compiler output o Menu entry Altium Designer names the output file always after the C source
129. architecture mycorearchl 1 2 8 6 3 Defining Internal Memory and Buses With the memory keyword you define physical memory that is present on the target board The memory name is used to identify the memory and does not conflict with other identifiers It is common to define internal memory on chip in the derivative definition External memory off chip memory is usually defined in the board specification See section 8 7 3 Defining External Memory and Buses The type field specifies a memory type rom read only memory it can only be written at load time ram random access volatile writable memory writing at run time is possible while writing at load time has no use since the data is not retained after a power down nvram non volatile ram writing is possible both at load time and run time The optional reserved qualifier before the memory type tells the linker not to locate any section in the memory by default You can locate sections in such memories using an absolute address or range restriction see subsection Locating a group in section 8 9 2 Creating and Locating Groups of Sections The mau field specifies the MAU size Minimum Addressable Unit of the memory This field is required The size field specifies the size in MAU of the memory This field is required The speed field specifies a symbolic speed for the memory 1 4 1 is the fastest 4 the slowest The linker uses the relative speed of the memories in such a way
130. arguments are symbolic names that the macro preprocessor replaces with the literal arguments when the macro is expanded called Each argument must follow the same rules as global symbol names Argument names cannot start with a percent sign Example Consider the following macro definition RESERV MACRO val reserve space DS val ENDM After the following macro call section text RESERV 8 The macro expands to DS 8 3 9 2 Calling a Macro To invoke a macro construct a source statement with the following format label macro_name arg arg 7 comment where label An optional label that corresponds to the value of the location counter at the start of the macro expansion 3 46 Assembly Language macro_name The name of the macro This may not start in the first column arg One or more optional substitutable arguments Multiple arguments must be separated by commas comment An optional comment The following applies to macro arguments e Each argument must correspond one to one with the formal arguments of the macro definition If the macro call does not contain the same number of arguments as the macro definition the assembler issues a warning e fan argument has an embedded comma or space you must surround the argument by single quotes e You can declare a macro call argument as null in three ways enter delimiting commas in succession with no intervening spaces macroname ARG1 ARG3 th
131. ath that is specified in the environment variable AStargetINC when the product was installed 4 The default directory ctarget include Example Suppose that your assembly source file test src contains the following line INCLUDE c myincludes myinc inc The assembler issues an error if it cannot find the file at the specified location INCLUDE myinc inc The assembler searches the file myinc inc according to the rules described above Related information d Assembler option include directory Add directory to include file search path in Section 5 2 Assembler Options of Chapter Tool Options 3 29 ARM Embedded Tools Reference LIST NOLIST Syntax NOLIST assembly source lines LIST Description If you generate a list file see assembler option list file you can use the LIST and NOLIST directives to specify which source lines the assembler must write to the list file The assembler prints all source lines to the list file untill it encounters a NOLIST directive The assembler does not print the NOLIST directive and subsequent source lines When the assembler encounters the LIST directive it resumes printing to the list file starting with the LIST directive itself It is possible to nest the LIST NOLIST directives Example Suppose you assemble the following assembly code with the assembler option list file SECTION text source line 1 NOLIST source line 2 LIST
132. ation d gt Linker option no rescan Rescan libraries to solve unresolved externals 5 98 Tool Options Linker Linker help Menu entry Command line syntax help options Description Displays an overview of all command line options When you specify the argument options you can list detailed option descriptions Example The following invocations all display a list of the available command line options lkarm lkarm help lkarm To see a detailed description of the available options enter lkarm help options 5 99 ARM Embedded Tools Reference Linker import object Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option import object to the Additional linker options field Command line syntax import object file Description With this option the linker imports a binary file containing raw data and places it in a section The section name is derived from the filename in which dots are replaced by an underscore So when importing a file called my jpg a section with the name my_ jpg is created In your application you can refer to the created section by using linker labels Related information Gls Section 5 7 Importing Binary Files 5 100 Tool Options Linker Linker include directory l Menu entry Command line syntax incl
133. ation i 5 173 ARM Embedded Tools Reference Make Utility d dd Command line syntax d dd Description With the option d the make utility shows which files are out of date and thus need to be rebuild The option dd gives more detail than the option d Example tmk d Shows which files are out of date and rebuilds them Related information J 5 174 Tool Options Make Utility Make Utility e Command line syntax e Description If you use macro definitions they may overrule the settings of the environment variables With the option e the settings of the environment variables are used even if macros define otherwise Example tmk e The make utility uses the settings of the environment variables regardless of macro definitions Related information i 5 175 ARM Embedded Tools Reference Make Utility err Command line syntax err file Description With this option the make utility redirects error messages and verbose messages to a specified file With the option s the make utility only displays error messages Example tmk err error txt The make utility writes messages to the file error txt Related information d gt Make utility option s Do not print commands before execution 5 176 Tool Options Make Utility Make Utility f Command line syntax f my_makefile Description Default the make utility uses the file makefile to build your files W
134. ation FSS This system can be used by the debugger to simulate an I O environment which enables you to debug your application A number of wide character functions are available as C source code but have not been compiled with the C library To use complete wide character functionality you must recompile the libraries with the macro WCHAR_SUPPORT_ENABLED and keep this macro also defined when compiling your own sources See C compiler option define D in section 5 1 C Compiler Options in Chapter 5 Tool options 2 2 1 assert h assert expr Prints a diagnostic message if NDEBUG is not defined Implemented as macro 2 2 2 complex h The complex number z is also written as x yi where x the real part and y the imaginary part are real numbers of types float double or long double The real and imaginary part can be stored in structs or in arrays This implementation uses arrays because structs may have different alignments The header file complex h also defines the following macros for backward compatibility complex _Complex C99 keyword imaginary _ Imaginary C99 keyword Parallel sets of functions are defined for double float and long double They are respectively named function function function1 All Long type functions though declared in complex h are implemented as the double type variant which nearly always meets the requirement in embedded applications This implementation uses the obvious implementat
135. ation and you are using the interrupt _type function qualifier of the compiler you will need to specify the novector attribute in order to prevent the compiler from generating the vector _nr symbol multiple times as this would lead to a link error Execution mode all architectures except M profile In Altium Designer you can define the execution mode in which the processor should run when your application s main program is called together with the interrupt status FIQ interrupts enabled disabled IRQ interrupts enabled disabled Based on these settings the linker will generate a symbol _APPLICATION_MODE_ which value is used in the startup code in the run time library to set the value of the CPSR status register before calling your main function e Inthe Startup code Vector table page select the Main application execution mode Optionally enable or disable the options Enable IRQ interrupts and Enable FIQ interrupts Preprocessor macros in arm lsl The options you select in Altium Designer result in preprocessor macros that are used in the LSL file Instead of using Altium Designer you can also define the macros by using the linker option define Define Description __ START Reset handler ROM address __PROCESSOR_MODE Main application execution mode __IRQ BIT Is 0 if IRQ interrupts enabled __FIQ BIT Is 0 if FIQ interrupts enabled __APPLICATION_MODE Contains the processor mode and
136. atus register APSR AN This intrinsic is only available for the ARMv6 M and ARMv7 M M profile architectures __setapsr unsigned int volatile _setapsr int set int clear Set or clear bits in the APSR status register Returns the new value of the APSR status register amp This intrinsic is only available for the ARMv6 M and ARMv7 M M profile architectures __getipsr unsigned int volatile _ getipsr void Get the value of the IPSR status register Returns the value of the status register IPSR This intrinsic is only available for the ARMv6 M and ARMv7 M M profile architectures 1 17 ARM Embedded Tools Reference __sve void volatile __svc int number Generates a supervisor call software interrupt Number must be a constant value Returns nothing 1 8 5 Interrupt Functions Exception Handlers The TASKING C compiler supports a number of function qualifiers and keywords to program exception handlers An exception handler or interrupt function is called when an exception occurs The ARM supports seven types of exceptions The next table lists the types of exceptions and the processor mode that is used to process that exception When an exception occurs execution is forced from a fixed memory address corresponding to the type of exception These fixed addresses are called the exception vectors Exception type Mode Normal address High vector address Function type qualifier Re
137. aware that the options in the option file are added to the linker options you have set in the other dialogs Only in extraordinary cases you may want to use them in combination Altium Designer automatically saves the options with your project Command line syntax option file file f file Description This option is primarily intended for command line use Instead of typing all options on the command line you can create an option file which contains all options and flags you want to specify With this option you specify the option file to the linker Use an option file when the length of the command line would exceed the limits of the operating system or just to store options and save typing You can specify the option option file multiple times Format of an option file e Multiple arguments on one line in the option file are allowed e To include whitespace in an argument surround the argument with single or double quotes e If you want to use single quotes as part of the argument surround the argument by double quotes and vise versa This has a single quote embedded This has a double quote embedded This has a double quote and a single quote embedded e When a text line reaches its length limit use a to continue the line Whitespace between quotes is preserved This is a continuation line gt This is a continuation line e tis possible to nest command line files up to 25 levels
138. ax 2 6 strxfrm 2 20 Switch method 1 10 switch statement 1 13 swprintf 2 15 swscanf 2 15 Symbol names 3 2 Syntax error checking 5 5 5 56 5 128 Syntax of an expression 3 4 system 2 18 T tan functions 2 7 tanh functions 2 7 tbb_switch 1 10 tbh_switch 1 10 tgamma functions 2 10 thumb 3 8 3 15 5 20 Thumb instructions 5 84 time 2 21 time_t 2 20 title 3 42 tm struct 2 21 TMP_MAX 2 12 tmpfile 2 17 tmpnam 2 17 tolower 2 3 toupper 2 3 towctrans 2 24 towlower 2 3 2 24 towupper 2 3 2 24 tradeoff 1 11 Transferring parameters between functions 1 14 trunc functions 2 8 type 3 43 Type qualifier _ unaligned 1 2 U UAL syntax 3 8 undef 3 44 ungetc 2 16 ungetwc 2 16 unlink 2 23 Using assembly in C source 1 4 V va_arg 2 11 va_copy 2 11 va_end 2 11 va_start 2 11 Vector table 4 3 8 17 Version information 5 191 5 203 vfprintf 2 15 vfscanf 2 15 vfwprintf 2 15 vfwscanf 2 15 vprintf 2 15 vscanf 2 15 vsprintf 2 15 vsscanf 2 15 vswprintf 2 15 vswscanf 2 15 vwprintf 2 15 vwscanf 2 15 W warning 1 11 Warnings suppressing 5 32 5 72 5 117 5 153 treat as errors 5 87 wchar_t 2 11 wcrtomb 2 23 wcscat 2 19 weschr 2 20 wescmp 2 20 wcscoll 2 20 wescpy 2 19 wescspn 2 20 wesncat 2 19 wesncmp 2 20 wesncpy 2 19 wespbrk 2 20 wesrchr 2 20 wcsrtombs 2 23 wcesspn 2 20 wesstr 2 20 wcstod 2 18 wcstof 2 18 wcstoimax 2 6 wce
139. bel in the application code that should be located at the specified start address The symbol argument is required The linker will resolve the start symbol and use its value after locating for the start address field in IEEE 695 files and Intel Hex files If you also specified the run_addr argument the start symbol label must point to a section The linker locates this section such that the start symbol ends up on the start address space space_name id 1 mau 8 align 8 page_size 1 stack name min_size 1k grows low_to_high reserved start _address end_address start_address run_addr 0x0000 symbol start_label map map_description 8 5 4 Mappings You can use a mapping when you define a space bus or memory With the map field you specify how addresses from the source Space bus or memory are translated to addresses of a destination Space bus The following mappings are possible e space gt space e space gt bus e bus gt bus e memory gt bus With a mapping you specify a range of source addresses you want to map specified by a source offset and a size the destination to which you want to map them a bus or another address space and the offset address in the destination e The dest argument specifies the destination This can be a bus or another address space only for a space to space mapping This argument is required e The src_offset argument specifies the offset of t
140. ber of arguments shall not be used Functions shall not call themselves either directly or indirectly A violation will be reported for direct or indirect recursive function calls in the source file being checked Recursion via functions in other source files or recursion via function pointers is not detected Function prototypes shall be visible at the definition and call The function prototype of the declaration shall match the definition Identifiers shall be given for all prototype parameters or for none Parameter identifiers shall be identical for declaration definition Every function shall have an explicit return type Functions with no parameters shall have a void parameter list An actual parameter type shall be compatible with the prototype The number of actual parameters shall match the prototype The values returned by void functions shall not be used Void expressions shall not be passed as function parameters const should be used for reference parameters not modified A function should have a single point of exit Every exit point shall have a return of the declared return type For void functions return shall not have an expression Function calls with no parameters should have empty parentheses If a function returns error information it should be tested A violation is reported when the return value of a function is ignored include shall only be preceded by other directives or comments Non standard char
141. bitwise complement negative value binary_op penn exclusive OR multiplication division modulus addition subtraction gt gt right shift lt lt left shift equal to not equal to gt greater than lt less than gt greater than or equal to lt less than or equal to amp bitwise AND bitwise OR amp amp logical AND logical OR 8 4 Linker Script Language 8 3 5 Built in Functions function_call absolute expr addressof addr_id exists section_name max expr expr min expr expr sizeof size_id addr_id sect section_name group group_name size_id 3 sect section_name group group_name mem mem_name e Every space bus memory section or group your refer to must be defined in the LSL file e The addressof and sizeof functions with the group or sect argument can only be used in the right hand side of an assignment The sizeof function with the mem argument can be used anywhere in section layouts You can use the following built in functions in expressions All functions return a numerical value This value is a 64 bit signed integer absolute int absolute expr Converts the value of expr to a positive integer absolute labelA labelB addressof int addressof addr_id Returns the address of addr_id which is a named section or group To get the offset of th
142. box 4 If you select Custom Optimization enable or disable the optimizations you want 5 In addition in the Size speed trade off field select a level between fully optimize for size or fully optimize for speed Command line syntax optimize flags Offlags Use the following options for predefined sets of flags optimize 0 O0 No optimization Alias for OABCEFGIKLOPSUWY optimize 1 O1 Few optimizations Alias for OabcefgIKLOPSUWy optimize 2 O2 Medium optimization default Alias for OabcefglklopsUwy optimize 3 O3 Full optimization Alias for Oabcefgiklopsuwy You can enable the following individual optimizations coalesce a A Coalescer remove unnecessary moves ipro b B Interprocedural Register Optimization cse c C Common subexpression elimination CSE expression e E Expression simplification flow f F Control flow simplification optimization and code reordering glo g G Generic assembly code optimizations inline i I Function inlining schedule k K Instruction scheduler loop I L Loop transformations forward 0 0 Forward store propagate p P Constant propagation subscript s S Subscript strength reduction unroll u U Unroll small loops pipeline w W Software pipelining peephole y Y Peephole optimizations For an extensive description of these optimizations please refer to section 2 6 Compiler Optimizations in chapt
143. c Related information 5 75 ARM Embedded Tools Reference Assembler output o Menu entry Altium Designer names the output file always after the source file Command line syntax output file 0 file Description With this option you can specify another filename for the output file of the assembler Without this option the basename of the assembly source file is used with extension obj Example To create the file relobj obj instead of asm obj enter asarm output relobj obj asm src Related information J 5 76 Tool Options Assembler Assembler page length Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Add the option page length to the Additional assembler options field Command line syntax page length number Default 72 Description If you generate a list file with the assembler option list file I this option sets the number of lines in a page in the list file The default is 72 the minimum is 10 As a special case a page length of 0 turns off page breaks Related information d gt Assembler option list file Generate list file 5 77 ARM Embedded Tools Reference Assembler page width Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellan
144. c_ub_name for the start and_1c_ue_name for the end of the output section Copy table The keyword copytable tells the linker to select a section that is used as copy table The content of the copy table is created by the linker It contains the start address and length of all sections that should be initialized by the startup code The linker creates two labels to mark the begin and end of the section _lc_ub_table for the start and_1c_ue_table for the end of the copy table The linker generates a copy table when a reference to either of the section labels exists in one of the input object files 8 9 4 Creating Symbols You can tell the linker to create symbols before locating by putting assignments in the section layout definition Symbol names are represented by double quoted strings Any string is allowed but object files may not support all characters for symbol names You can use two different assignment operators With the simple assignment operator the symbol is created unconditionally With the operator the symbol is only created if it already exists as an undefined reference in an object file The expression that represents the value to assign to the symbol may contain references to other symbols If such a referred symbol is a special section symbol creation of the symbol in the left hand side of the assignment will cause creation of the special section section_layout 1le_bs _le_ub stack when
145. can deduce where a given section may be located in memory form the board specification the linker can deduce which physical memory is still available while locating the section See section 8 9 Semantics of the Section Layout Definition for more information on how to locate a section at a specific place in memory Skeleton of a Linker Script File The skeleton of a linker script file now looks as follows architecture architecture_name architecture definition derivative derivative_name derivative definition 8 2 Linker Script Language processor processor name processor definition memory definitions and or bus definitions section_layout space_name section placement statements 8 3 Syntax of the Linker Script Language 8 3 1 Preprocessing When the linker loads an LSL file the linker processes it with a C style prepocessor As such it strips C and C comments You can use the standard ISO C preprocessor directives such as include define if else endif For example include arch 1s1 Preprocess and include the file arch 1s1 at this point in the LSL file 8 3 2 Lexical Syntax The following lexicon is used to describe the syntax of the Linker Script Language A B A is defined as B A BC A is defined as B and C B is followed by C A B C A is defined as B or C lt B gt 0 1 zero or one occurrence of B lt B gt gt 0 zero of more occurrences of B l
146. case a module must be loaded at a fixed address or a data section needs a special place in memory you can use this option to generate different section names You can then use this unique section name in the linker script file for locating Because sections have reserved names the compiler will not actually change the section name but will add a suffix to the name With the section name you select which sections are renamed With suffix you specify the suffix part which will be attached to the existing name The following name values have special meaning With the suboption f the compiler uses the function name only for code With the suboption m the compiler uses the name of the current module With the suboption fm or mf the compiler uses the name of the current module for data sections and the function name for code sections If you do not specify a section name all sections will receive the specified suffix carm rename sections data NEW test c To add the name of the current module name as suffix to all data sections resulting in data test carm rename sections data m test c Gls Assembler directive SECTION 5 40 Tool Options C Compiler C Compiler runtime r Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Debug Information 3 Enable the option Run time checks 4 Enable one or more of the following
147. ce standard A Inline assembly is only allowed in dedicated C functions x A Provision should be made for appropriate run time checking R Only use characters and escape sequences defined by ISO C R Character values shall be restricted to a subset of ISO 106460 1 R Trigraphs shall not be used R Multibyte characters and wide string literals shall not be used R Comments shall not be nested ba oO ON ODO 0 e OY A Sections of code should not be commented out In general it is not possible to decide whether a piece of comment is C code that is commented out or just some pseudo code Instead the following heuristics are used to detect possible C code inside a comment a line ends with or a line starts with possibly preceded by white space 11 R Identifiers shall not rely on significance of more than 31 characters 12 A The same identifier shall not be used in multiple name spaces 13 A Specific length typedefs should be used instead of the basic types 14 R Use unsigned char or signed char instead of plain char x 15 A Floating point implementations should comply with a standard 16 R The bit representation of floating point numbers shall not be used A violation is reported when a pointer to a floating point type is converted to a pointer to an integer type 17 R typedef names shall not be reused 18 A Numeric constants should be suffixed to indicate type A violation
148. characters and wide characters In these ps points to struct mbstate_t which holds the conversion state information necessary to convert between sequences of multibyte characters and wide characters typedef struct wchar_t we_value wide character value solved so far unsigned short n_bytes number of bytes of solved multibyte unsigned short encoding encoding rule for wide character lt gt mbstate_t multibyte conversion When multibyte characters larger than 1 byte are used this struct will be used to store the conversion information when not all the bytes of a particular multibyte character have been read from the source In this implementation multi byte characters are 1 byte long MB_CUR_MAX and MB_LEN_MAX are defined as 1 and this will never occur mbsinit ps mbsrtowcs pwces src n ps wesrtombs s srce n ps mbrtowc pwc s n ps wertomb s wc ps btowc c wctob c mbrlen s n ps Determines whether the object pointed to by ps is an initial conversion state Returns a non zero value if so Restartable version of mbstowcs See section 2 2 23 stdlib h and wchar h The initial conversion state is specified by ps The input sequence of multibyte charactersis specified indirectly by src Restartable version of westombs See section 2 2 23 stdlib h and wchar h The initial conversion state is specified by ps The input wide string is specified indirectly by src Conv
149. ches for include files is 1 The pathname in the C source file and the directory of the C source only for include files that are enclosed in 2 The path that is specified with this option 3 The path that is specified in the environment variable CARMINCwhen the product was installed 4 The default include directory relative to the installation directory unless you specified option no stdinc Example Suppose that the C source file test c contains the following lines include lt stdio h gt include myinc h You can specify the include directory myinclude to the C compiler carm include directory myinclude test c First the compiler looks for the file stdio h in the directory myinc lude relative to the current directory If it was not found the compiler searches in the environment variable and then in the default include directory The compiler now looks for the file myinc h in the directory where test c is located If the file is not there the compiler searches in the directory myinclude If it was still not found the compiler searches in the environment variable and then in the default include directory Related information C compiler option include file Include file at the start of a compilation C compiler option no stdine Skip standard include files directory Tool Options C Compiler C Compiler include file H Menu entry 1 From the Project menu select Project Options The Proje
150. cifying signed char With this option char is the same as unsigned char Related information i 5 163 ARM Embedded Tools Reference Control Program undefine U Command line syntax undefine macro_name Umacro_name Description With this option you can undefine an earlier defined macro as with undef This option is for example useful to undefine predefined macros However you cannot undefine predefined ISO C standard macros The control program passes the option undefine U to the compiler Example To undefine the predefined macro _ TASKING_ ccarm undefine _ TASKING test c Related information d gt Control Pogram option define Define preprocessor macro 5 164 Tool Options Control Program Control Program verbose v Command line syntax verbose V Description With this option you put the control program in verbose mode With the option v the control program performs it tasks while it prints the steps it performs to stdout Related information db Control Program option n dry run Verbose output and suppress execution 5 165 ARM Embedded Tools Reference Control Program version V Command line syntax version V Description Display version information The control program ignores all other options or input files Related information J 5 166 Tool Options Control Program Control Program warnings as errors Command line s
151. clude one extra file at the beginning of the assembly source file The specified include file is included before all other includes This is the same as specifying INCLUDE file atthe beginning of your assembly source Example asarm include file myinc inc testl srce The file myinc inc is included at the beginning of test 1 src before it is assembled Related information Gb Assembler option include directory Include files path Section 4 4 How the Assembler Searches Include Files in chapter Using the Assembler of the user s manual 5 67 ARM Embedded Tools Reference Assembler inversions Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Enable the option Allow instruction inversions Command line syntax inversions Description With this option you tell the assembler to try to invert some data processing instructions with an immediate operand Inversions are available for MOV MVN CMP CMN AND BIC ADC SBC and ADD SUB Example You can write add r1 r2 4 and the assembler will generate sub r1 r2 4 and instead of mov r1 0xFFFFFFFF the assembler will generate mvn rl1 0 Related information ie 5 68 Tool Options Assembler Assembler keep output files k Menu entry Altium Designer always removes the object file when errors occur during assembling Command
152. compiler ignores all other options or input files Related information J 5 52 Tool Options C Compiler C Compiler warnings as errors Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Diagnostics 3 Enable the option Treat warnings as errors Command line syntax warnings as errors number Description If the compiler encounters an error it stops compiling When you use this option without arguments you tell the compiler to treat all warnings as errors This means that the exit status of the compiler will be non zero after one or more compiler warnings As a consequence the compiler now also stops after encountering a warning You can also limit this option to specific warnings by specifying a comma separated list of warning numbers Related information Gb C compiler option no warnings Suppress some or all warnings 5 53 ARM Embedded Tools Reference 5 2 Assembler Options Altium Designer uses a makefile to build your entire project This means that in Altium Designer you cannot run the assembler separately If you want assembly results you must compile a single C source file from within Altium Designer the file is then also assembled However you can set options specific for the assembler Options in Altium Designer versus options on the command line Most command line options have an equivalen
153. contains the line number This is a decimal number indicating each input line starting from 1 and incrementing with each source line SOURCE LINE This column contains the source text This is a copy of the source line from the assembly source file For the SET and EQU directives the ADDR and CODE columns do not apply The symbol value is listed instead Related information See section 4 6 Generating a List File in Chapter Using the Assembler of the user s manual for more information on how to generate a list file and specify the amount of list file information 6 2 List File Formats 6 2 Linker Map File Format The linker map file is an additional output file of the linker that shows how the linker has mapped the sections and symbols from the various object files obj to output sections The locate part shows the absolute position of each section External symbols are listed per space with their absolute address both sorted on symbol and sorted on address With the linker option map file format map file formatting you can specify which parts of the map file you want to see Example part of linker map file JE II ICI ISIC ICI I GIG ICIS BICC kkk Too and Invocation ee badd aa dinci anid a anni i a II ICC ICICI CI I ICICI CR RI IIR RIA 4o tool TASKING ARM object linker vx yrz Build 062 path lt installation dir gt System Tasking carm
154. ct Options dialog box appears 2 Expand the C Compiler entry and select Preprocessing 3 Enter the name of the file in the Include this file before source field or click and select a file Command line syntax include file file Hfile Description With this option set at project level you include one extra file at the beginning of each C source file in your project On a document level Project Document Options you can overrule this option with another file or no file at all The specified include file is included before all other includes This is the same as specifying include file at the very beginning of each of your C source files Example carm include file stdio h testl c test2 c The file stdio h is included at the beginning of both test1 c and test2 c Related information db C compiler option include directory Add directory to include file search path Section 2 4 How the Compiler Searches Include Files in chapter Using the Compiler of the user s manual 5 17 ARM Embedded Tools Reference C Compiler inline Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option inline to the Additional C compiler options field Command line syntax inline Description With this option you instruct the compiler to inline calls to functions without the noinline
155. ct file of the specified output format from the file you supplied as input With this option you tell the control program to stop after a certain number of phases Related information d Linker option link only Link only no locating 5 130 Tool Options Control Program Control Program debug info g Command line syntax debug info g Description With this option you tell the control program to include debug information in the generated object file Related information J 5 131 ARM Embedded Tools Reference Control Program define D Command line syntax define macro_name macro_definition Dmacro_name macro_definition Description With this option you can define a macro and specify it to the preprocessor If you only specify a macro name no macro definition the macro expands as 1 You can specify as many macros as you like On the command line use the option define multiple times If the command line exceeds the length limit of the operating system you can define the macros in an option file which you then must specify to the control program with the option option file file f Defining macros with this option instead of in the C source is for example useful to compile or assemble conditional source as shown in the example below The control program passes the option define D to the compiler and the assembler Example Consider the following C program with
156. ct on the excution speed Malloc consistency checks This option enables the use of wrappers around the functions malloc realloc free that will check for common dynamic memory allocation errors like e buffer overflow e write to freed memory e multiple calls to free e passing invalid pointer to free Enabling this check will extract some additional code from the library but it will not enlarge your application code The dynamic memory usage will increase by a couple of bytes per allocation Stack overflow check The compiler generates extra code within the function prolog that will check the available stack size before allocating This is only useful when the processor runs in USR or SYS mode 5 41 ARM Embedded Tools Reference Division by zero check The compiler generates a call to specific run time functions for additional division by zero checks If this situation occurs an abort signal is issued Without this check a division by zero could lead to unpredictable results Related information i 5 42 Tool Options C Compiler C Compiler signed bitfields Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Language 3 Enable the option Treat int bit fields as signed Command line syntax signed bitfields Description For bit fields it depends on the implementation whether a plain int is treated as signe
157. cter set specified by the current locale category LC_CTYPE see section 2 2 13 ocale h 2 17 ARM Embedded Tools Reference Numeric conversions The following functions convert the intial portion of a string s to a double int long int andlong long int value respectively double atof s int atoi s long atol s long long atoll s The following functions convert the initial portion of the string s to a float double and long double value respectively endp will point to the first character not used by the conversion stdlib h wehar h float strtof s endp float westof s endp double strtod s endp double westod s endp long double strtold s endp long double wcestold s endp The following functions convert the initial portion of the string s to a long long long unsigned long and unsigned long long respectively Base specifies the radix endp will point to the first character not used by the conversion stdlib h wchar h long strtol s endp base long westol s endp base long long strtoll s endp base long long westoll s endp base unsigned long strtoul s endp base unsigned long long strtoull s endp base unsigned long wcestoul s endp base unsigned long long westoull s endp base Random number generation rand srand seed Memory management malloc size calloc nobj size free ptr realloc ptr size Returns a pseudo random integer in th
158. cters 3 2 Assembly Programming in C 1 4 Assembly expressions 3 3 Assembly functions 3 5 alupcrel 3 6 arg 3 6 bigendian 3 6 ent 3 7 cpu 3 7 defined 3 7 lsb 3 7 lsh 3 7 lsw 3 7 msb 3 7 msh 3 7 msw 3 8 pre_ual 3 8 strcat 3 8 sircmp 3 8 strlen 3 8 strpos 3 8 thumb 3 8 detailed description 3 6 overview 3 5 Assembly syntax 3 1 atan functions 2 7 atan2 functions 2 7 atanh functions 2 7 atexit 2 18 atof 2 18 atoi 2 18 atol 2 18 atoll 2 18 B bigendian 3 6 Binary search table 1 13 binary_switch 1 10 Index Board specification 8 2 8 22 break 3 12 bs 3 13 bsb 3 13 bsd 3 13 bsearch 2 19 bsh 3 13 bsw 3 13 btowc 2 23 BUFSIZ 2 12 Build options 5 105 include files path 5 16 5 31 5 66 5 101 Bus definition 8 2 Buses 8 15 Cc C compiler options 5 1 5 15 align composites 5 3 big endian 5 12 call 5 4 check 5 5 cpu 5 6 debug info 5 7 define 5 8 dep file 5 10 diag 5 11 endianness 5 12 error file 5 13 help 5 15 include directory 5 16 include file 5 17 inline 5 18 inline max incr 5 19 inline max size 5 19 interwork 5 20 iso 5 21 keep output files 5 22 language 5 23 make target 5 25 mil 5 26 mil split 5 26 misrac 5 27 misrac advisory warnings 5 28 misrac required warnings 5 28 no double 5 30 no stdinc 5 31 no warnings 5 32 optimize 5 33 o
159. d the make utility may process corrupt files on a subsequent invocation Use this option when you still want to inspect the generated assembly source Even if it is incomplete or incorrect Related information f 5 22 Tool Options C Compiler C Compiler language A Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Language 3 Enable or disable the following options e Allow C style comments in C source code only available when ISO C 90 is selected e Relax const check for string literals Command line syntax language flags Afflags You can set the following flags gcc g G Enable a number of gcc extensions comments p P Allow C style comments in C source code strings x X Relaxed const check for string literals The option language A is the equivalent of AGPX which disables all language extensions The default is Agpx Description With this option you control the language extensions the compiler accepts Default the C compiler allows all language extensions With Allow C style comments in C source code Ap you tell the compiler to allow C style comments in ISO C90 mode option c90 In ISO C99 mode this style of comments is always accepted With Relax const check for string literals Ax you tell the compiler not to check for assignments of a constant string to a non
160. d arguments The same applies to all scanf type functions which call the function doscan and also for the wprint and wscanf type functions which call _dowprint and _dowscan respectively The C library contains three versions of these routines int long and long long versions If you use floating point the formatter function for floating point _dof1t or dowf1t is called Depending on the formatting arguments you use the correct routine is used from the library Of course the larger the version of the routine the larger your produced code will be Note that when you call any of the printf scanf routines indirect the arguments are not known and always the long long version with floating point support is used from the library Example include lt stdio h gt long L void main void printf This is a long ld n L The linker extracts the Long version without floating point support from the library db See also the description of pragma weak in section 1 5 Pragmas to Control the Compiler in the user s manual 1 20 Altum 2 Libraries Summary This chapter lists all library functions that you can call in your C source 2 1 Introduction This chapter contains an overview of all library functions that you can call in your C source This includes all functions of the standard C library ISO C99 and some functions of the floating point library A number of standard operations within C are too complex
161. d files information invocation i I Invocation and tool information link k K Link result information locate I L Locate result information memory m M Memory usage information nonalloc n N Non alloc information overlay 0 0 Overlay information statics q Q Module local symbols crossref r R Cross references information Isl s S Processor and memory information rules u U Locate rules Description With this option you specify which information you want to include in the map file Use this option in combination with the option map file M If you do not specify this option the linker uses the default map file format 2 Related information d Linker option map file Generate map file 5 112 Tool Options Linker Linker misra c report Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select MISRA C 3 Select a MISRA C configuration 4 Enable the option Produce a MISRA C report Command line syntax misra c report i e Description With this option you tell the linker to create a MISRA C Quality Assurance report This report lists the various modules in the project with the respective MISRA C settings at the time of compilation If you do not specify a filename the file name mcr is used Related information d gt Compiler option misrac 5 113 ARM Embedded Too
162. d int orunsigned int By default an int bit field is treated as unsigned int This offers the best performance With this option you tell the compiler to treat int bit fields as signed int In this case you can still add the keyword unsigned to treat a particular int bit field as unsigned Related information i 5 43 ARM Embedded Tools Reference C Compiler source s Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Enable the option Merge C source code with assembly in output file src Command line syntax source S Description With this option you tell the compiler to merge C source code with generated assembly code in the output file The C source lines are included as comments Related information i 5 44 Tool Options C Compiler C Compiler static Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option static to the Additional C compiler options field Command line syntax static Description With this option the compiler treats external definitions at file scope except for main as if they were declared static Asa result unused functions will be eliminated and the alias checking algorithm assumes that objects with static storage cannot be referenced
163. d select Processor Definition 3 Enable the option Big endian mode Command line syntax endianness endianness B big endian You can specify the following endianness big b Big endian little I Little endian default Description By default the linker links objects in little endian mode With endianness big you tell the linker to link the input files in big endian mode The endianess used must be valid for the architecture you are linking for Depending on the endianess used the linker links different libraries B is an alias for option endianness big Related information J 5 94 Tool Options Linker Linker error file Menu entry Command line syntax error file file Description With this option the linker redirects error messages to a file If you do not specify a filename the error file is Lkarm elk Example To write errors to errors elk instead of stderr enter lkarm error file errors elk test obj Related information ie 5 95 ARM Embedded Tools Reference Linker error limit Menu entry Command line syntax error limit number Description With this option you tell the linker to only emit the specified maximum number of errors When 0 null is specified the linker emits all errors Without this option the maximum number of errors is 42 Related information J 5 96 Tool Options Linker Linker extern e Menu entry 1 Fro
164. d you specfied the o option the linker uses the same basename as the output file with the extension map If you did not specify the o option the linker uses the file task1 map Altium Designer names the map file after the project A linker map file is a text file that shows how the linker has mapped the sections and symbols from the various object files obj to the linked object file A locate part shows the absolute position of each section External symbols are listed per space with their absolute address both sorted on symbol and sorted on address Related information Gls With the option map file format map file formatting you can specify which parts you want to place in the map file Section 6 2 Linker Map File Format in Chapter List File Formats 5 111 ARM Embedded Tools Reference Linker map file format m Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Map File 3 Enable the option Generate a map file map 4 Inthe Map file format section enable or disable the information you want to be included in the map file Command line syntax map file format flags mflags You can specify the following formats 0 Same as mefikLMNoQrSU link information 1 Same as mCfiKIMNoQRSU locate information 2 Same as mefiklmNoQrSu most information callgraph c C Call graph information files f F Processe
165. e processor proc_name processor definition 8 7 2 Instantiating Derivatives With the keyword derivative you tell the linker that the given processor has a certain derivative The derivative name refers to an existing derivative definition in the same LSL file For examples if you have two processors on your target board called myproc_1 and myproc_2 that have the same derivative called myderiv you must instantiate both processors as follows processor myproc_1 derivative myderiv processor myproc_ 2 derivative myderiv 8 22 Linker Script Language If the derivative definition has parameters you must specify the arguments that correspond with the parameters For example myderiv1 expects two parameters which are used in the derivative definition processor myproc derivative myderivl 2 4 8 7 3 Defining External Memory and Buses It is common to define external memory off chip and external buses at the global scope outside any enclosing definition Internal memory on chip memory is usually defined in the scope of a derivative definition With the keyword memory you define physical memory that is present on the target board The memory name is used to identify the memory and does not conflict with other identifiers If you define memory parts in the LSL file only the memory defined in these parts is used for placing sections If no external memory is defined in the LSL file and if
166. e format adar_size c basename format adar_size You can specify the following formats IHEX Intel Hex SREC Motorola S records The addr_size specifies the size of the addresses in bytes record length For Intel Hex you can use the values 1 2 or 4 bytes default For Motorola S you can specify 2 S1 records 3 S2 records or 4 bytes S3 records default In Altium Designer you cannot specify the address size because Altium Designer always uses the default values Description With this option you specify the Intel Hex or Motorola S record output format for loading into a PROM programmer The linker generates a file for each ROM memory defined in the LSL file where sections are located memory memname type rom The name of the file is the name of the Altium Designer project or on the command line the name of the memory device that was emitted with extension hex or sre Optionally you can specify a basename which prepends the generated file name AN The linker always outputs a debugging file in ELF DWARF format and optionally an absolute object file in Intel Hex format and or Motorola S record format Example To generate Intel Hex output files for each defined memory enter the following on the command line lkarm chip output myfile IHEX testl obj In this case this generates the file myfile_memname hex Related information d gt Linker option output Output file Section 7 2 Motorola S Record For
167. e Exactly one architecture statement must be present in a core_def 8 3 10 Processor Definition and Board Specification board _spec proc_def bus_def mem _ def proc_def processor proc_name proc_descr proc_descr derivative derivative_name lt argument_list gt l1 e Aproc_def defines a processor with the proc_name as a unique name e If you do not explicitly define a processor for a derivative in an LSL file the linker defines a processor with the same name as that derivative e Aderivative_name refers to a defined derivative e Aproc_def contains exactly one derivative statement 8 3 11 Section Layout Definition and Section Setup section definition section_layout lt space ref gt 1 lt locate direction gt 9 1 lt section_statement gt gt e A section definition inside a space definition does not have a space_ref e All global section definitions have a space_ref space_ref lt proc_name gt 1 lt core_name gt 9 1 space name e If more than one processor is present the proc_name must be given for a global section layout e Ifthe section layout refers to a processor that has more than one core the core_name must be given in the space_ref e Aproc_name refers to a defined processor e Acore_name refers to a defined core e A space_name refers to a defined address space locate_direction direction direction direction low_to_high high_to_low e A section layout contains at
168. e OEE Yond dod Na dae ware 1 20 1 9 1 Printf and Scant ROUNE S ee sau eee ceres raana ea daa eee pe eae he E A eae 1 20 Libraries 2 1 2 1 IMtODUCTION s copieer koe edge eda Don os Mare See ES taeda OF hd Ge a a A ee 2 1 2 2 Library FUNCIONS i jeescees ee beacon pe EE ERE EE EE UNET EE AE EAE EE eae eae 2 2 2 2 1 ASSCMM 34 5 cities eee ea e Ao ai a i aine a a E peed EE E 2 2 2 2 2 COMPIOXA 50s eet aenedae cob araea t due eua kaa aE E E E E DETENER 2 2 2 2 3 ctype k and wetype llc cacoee eee oka ea eee Raed E aa eae et Nias 2 3 2 2 4 ABON oarriero cide iwe fava aed eee die real e eames elawd dae odes 2 4 2 2 5 STO a oe Sieg esas wesw tae iva eater Spey EEE E EAE r koe ab tel E ayes eae eae 2 4 2 2 6 TORN angaa alte app ied Sih don Paonia ARGON eRe haute needa EE ERAS 2 5 2 2 7 TST cg cette cette tags ete ates ence een eae eyes mau a ate E are 2 5 2 2 8 TOA sk teardown heen seal Sa iden bain b dele 2 5 2 2 9 inttypes hand stdin 2 cca seed sriain kka eh die keene aad ete ee bee Ra eae 2 5 2 2 10 IO 5 ots peti E E bimawnd doe Midgce dune oy ddinte E E dined waa gelog 2 6 2 2 11 ISOG46 2 2 23 cotaiescn gun fae oie a Oke ea aR EEE Oe EE Ree doe Rees een hes 2 6 2 2 12 WMS HY ese oie Read ede poe eRe Re Mea ahi ed Vea Selb A 2 6 2 2 13 locale orme a een Peed ead ation Sane ee dame Ree aa ene Ohler he deneee 2 6 2 2 14 MAlOGH fe edidel dower ects dee eoddaddeok ntdwdeis edad ee Gderend retain clot 2 7 2 2 15 math hand tgmath h orice ceed ee ee ee
169. e as the last modified date that was recorded in the library Without this suboption it receives the last modified date of the moment it is extracted V Verbose the librarian shows which files are extracted Examples To extract the file obj1 obj from the library mylib lib tlb x mylib lib objl obj If you do not specify an object module all object modules are extracted tlb x mylib lib Related information J 5 205 ARM Embedded Tools Reference 5 206 6 List File Formats Summary This chapter describes the format of the assembler list file and the linker map file 6 1 Assembler List File Format The assembler list file is an additional output file of the assembler that contains information about the generated code The list file consists of a page header and a source listing Page header The page header is repeated on every page TASKING target Assembler vx yrz Build nnn SN 00000000 Title Page 1 ADDR CODE CYCLES LINE SOURCE LINE The first line contains version information The second line can contain a title which you can specify with the assembler directive TITLE and always contains a page number With the assembler directives LIST NOLIST and PAGE and with the assembler option Lflag list format you can format the list file See Section 3 8 2 Assembler Directives in Chapter Assembly Language and Section 5 2 Assembler Options in Chapter Tools Options The fourth line contains the headings
170. e assembler encouters a new TITLE directive Example TITLE The best program In the header of each page in the assembler list file the title of the progam is printed In this case The best program Related information db PAGE Format the assembler list file Assembler option list file Generate list file in Section 5 2 Assembler Options of Chapter Tool Options 3 42 Assembly Language TYPE Syntax symbol TYPE typeid Description With the TYPE directive you set a symbol s type to the specified value in the ELF symbol table Valid symbol types are FUNC The symbol is associated with a function or other executable code OBJECT The symbol is associated with an object such as a variable an array or a structure FILE The symbol name represents the filename of the compilation unit Labels in code sections have the default type FUNC Labels in data sections have the default type OBJECT Example Afunc TYPE FUNC Related information db SIZE Set Symbol Size 3 43 ARM Embedded Tools Reference UNDEF Syntax UNDEF symbol Description With the UNDEF directive you can undefine a substitution string that was previously defined with the DEFINE directive The substitution string associated with symbol is released and symbol will no longer represent a valid DEFINE substitution The assembler issues a warning if you redefine an existing symbol Example UNDEF LEN Undefines the LEN substit
171. e compiler to inline the specified function regardless of the optimization strategy of the compiler itself inline unsigned int abs int val unsigned int abs_val val if val lt 0 abs_val val return abs_val If a function with the keyword inline is not called at all the compiler does not generate code for it You must define inline functions in the same source module as in which you call the function because the compiler only inlines a function in the module that contains the function definition When you need to call the inline function from several source modules you must include the definition of the inline function in each module for example using a header file With the _ noinline keyword you prevent a function from being inlined __noinline unsigned int abs int val unsigned int abs_val val if val lt 0 abs_val val return abs_val Using pragmas inline noinline smartinline Instead of the inline qualifier you can also use pragma inline and pragma noinline to inline a function body pragma inline unsigned int abs int val unsigned int abs_val val if val lt 0 abs_val val return abs val pragma noinline void main void int i i abs 1 If a function has an inline __noinline function qualifier then this qualifier will overrule the current pragma setting 1 15 ARM Embedded Tools Reference With the pragma noinline pragma smartinline you
172. e numbers separated by commas With this option the control program does not process any files Example To display an explanation of message number 103 enter ccarm diag 103 This results in message 103 with explanation To write an explanation of all errors and warnings in HTML format to file ccerrors html1 enter ccarm diag html all gt ccerrors html Related information ie 5 133 ARM Embedded Tools Reference Control Program dry run n Command line syntax dry run n Description With this option you put the control program verbose mode The control program prints the invocations of the tools it would use to process the files without actually performing the steps Related information db Control Program option verbose v Verbose output 5 134 Tool Options Control Program Control Program endianness Command line syntax endianness endianness B big endian You can specify the following endianness big b Big endian little I Little endian default Description By default the compiler generates code for a little endian target least significant byte of a word at lowest byte address With endianness big the compiler generates code for a big endian target most significant byte of a word at lowest byte address B is an alias for option endianness big Related information i 5 135 ARM Embedded Tools Reference Control Program error file Comma
173. e range 0 to RAND_MAX Same as rand but uses seed for a new sequence of pseudo random numbers Allocates space for an object with size size The allocated space is not initialized Returns a pointer to the allocated space Allocates space for n objects with size size The allocated space is initialized with zeros Returns a pointer to the allocated space Deallocates the memory space pointed to by pir which should be a pointer earlier returned by the malloc or calloc function Deallocates the old object pointed to by ptr and returns a pointer to a niew object with size size The new object cannot have a size larger than the previous object Environment communication abort atexit func exit status _Exit status getenv s system s 2 18 Causes abnormal program termination If the signal SIGABRTis caught the signal handler may take over control See section 2 2 17 signal h Func points to a function that is called without arguments when the program normally terminates Causes normal program termination Acts as if main returns with status as the return value Status can also be specified with the predefined macros EXIT SUCCES or EXIT_FAILURE Same as exit but no registered by the atexit function or signal handlers registerd by the signal function are called Searches an environment list for a string s Returns a pointer to the contents of s NOTE this function is not implemented because there is no
174. e second argument is a null argument terminate the argument list with a comma the arguments that normally would follow are now considered null macroname ARG1 the second and all following arguments are null declare the argument as a null string e No character is substituted in the generated statements that reference a null argument 3 9 3 Using Operators for Macro Arguments The assembler recognizes certain text operators within macro definitions which allow text substitution of arguments during macro expansion You can use these operators for text concatenation numeric conversion and string handling Operator Name Description Macro argument Concatenates a macro argument with adjacent alphanumeric characters concatenation Return decimal Substitutes the symbo sequence with a character string that represents the decimal value value of symbol of the symbol Return hex Substitutes the symbo sequence with a character string that represents the hexadecimal value of symbol value of the symbol Macro string Allows the use of macro arguments as literal strings delimiter Macro local label Prevents name mangling on labels in macros override Example Argument Concatenation Operator Consider the following macro definition MAC_A MACRO reg val sub r reg r reg val ENDM The macro is called as follows MAC_A 2 1 The macro expands as follows sub r2 r2 1 The macro preprocessor substitu
175. e section with the name asect addressof sect asect AN This function only works in assignments exists int exists section_name The function returns 1 if the section section_name exists in one or more object file O otherwise If the section is not present in input object files but generated from LSL the result of this function is undefined To check whether the section mysection exists in one of the object files that is specified to the linker exists mysection max int max expr expr Returns the value of the expression that has the largest value To get the highest value of two symbols max Syml sym2 8 5 ARM Embedded Tools Reference ming int min expr expr Returns the value of the expression hat has the smallest value To get the lowest value of two symbols min sym1l sym2 sizeof int sizeof size_id Returns the size of the object group section or memory the identifier refers to To get the size of the section asection sizeof sect asection LN The group and sect arguments only works in assignments The mem argument can be used anywhere in section layouts 8 3 6 LSL Definitions in the Linker Script File description lt definition gt 1 definition architecture_definition derivative _definition board_spec section definition section_setup e Atleast one architecture_definition must be present in the LSL file 8 3
176. e switch statement Nested switch statements use the same switch method unless the nested switch is implemented in a separate function which is preceded by a different switch pragma Example place pragma before function body pragma jump switch void test unsigned char val function containing the switch switch val use jump table 1 13 ARM Embedded Tools Reference 1 8 Functions 1 8 1 Parameter Passing A lot of execution time of an application is spent transferring parameters between functions The fastest parameter transport is via registers Therefore function parameters are first passed via registers If no more registers are available for a parameter the compiler pushes parameters on the stack See the table below Parameter Type Parameter Number 1 2 3 4 _Bool rO r1 r2 r3 char rO r1 r2 r3 short ro r1 r2 r3 int long rO ri r2 r3 float ro r1 r2 r3 32 bit pointer rO r1 r2 r3 32 bit struct rO r1 r2 r3 long long rOr1 rir2 r2r3 r3 double rOr1 rir2 r2r3 64 bit struct rOr1 rir2 r2r3 Table 1 4 Register usage for parameter passing AN If a register corresponding to a parameter number is already in use the next register is used Example with three arguments funcl int a int b int c e a first parameter is passed in register rO e b second parameter is passed in register r1 e c third parameter is passed in register r2 Ex
177. e syntax preprocess flags Efflags You can set the following flags when you specify E without flags the default is ECMP comments c C Keep comments from the C source in the preprocessed output make m M Generate dependency lines that can be used for the makefile noline p P Strip line source position info lines starting with line Description With this option you tell the control program to preprocess the C source The C compiler sends the preprocessed output to the file name pre where name is the name of the C source file being compiled Altium Designer also compiles the C source On the command line the control program stops after preprocessing If you also want to compile the C source you can specify the option no preprocessing only In this case the control program calls the compiler twice once with option preprocess and once for a regular compilation Example ccarm preprocess comments make noline no preprocessing only test c The compiler preprocesses the file test c and sends the output to the file test pre Comments are included but no dependencies are generated and the line source position information is not stripped from the output file Next the control program calls the compiler assembler and linker to create the final object file test abs Related information d gt Control program option no preprocessing only 5 157 ARM Embedded Tools Reference Control Program p
178. e the exception vector Function type qualifier Vector symbol Vector symbol M profile __interrupt_und _vector_1 __interrupt_svcec _vector_2 _vector_11 __interrupt_iabt _vector_3 __interrupt_dabt _vector_4 __interrupt_irg _vector_6 __interrupt_fiq _vector_7 __interrupt n _vector_n _vector_n Note that the reset handler is designated by the symbol START instead of vector_0 _vector_1 for M profile architectures You can prevent the compiler from generating the _vector_n symbol by specifying the function qualifier novector This can be necessary if you have more than one interrupt handler for the same exception for example for different IRQ s or for different run time phases of your application Without the novector function qualifier the compiler generates the _vector_n symbol multiple times which results in a link error void _ interrupt_irq __novector another_handler void used __novector to prevent multiple _vector_6 symbols Enable interrupts in exception handlers not for M profile architectures Normally interrupts are disabled when an exception handler is entered With the function qualifier nesting enabled you can force that the link register LR is saved and that interrupts are enabled For example void _interrupt_svc _ nesting enabled svc int n if n 2 svc 3 1 8 5 2 Interrupt Frame __frame With the function type q
179. e utility not to read tmk mk and to rely fully on the make rules in the makefile Example tmk r The make utility does not read the implicit make rules in tmk mk Related information J 5 186 Tool Options Make Utility Make Utility S Command line syntax S Description With this option you cancel the effect of the option k This is only necessary in a recursive make where the option k might be inherited from the top level make via MAKEFLAGS or if you set the option k in the environment variable MAKEFLAGS Example tmk S The effect of the option k is cancelled so the make utility stops with the make process after it encounters an error The option k in this example may have been set with the environment variable MAKEFLAGS or in a recursive call to tmk in the makefile Related information db Make utility option k On error abandon the work for the current target only 5 187 ARM Embedded Tools Reference Make Utility s Command line syntax s Description With this option you tell the make utility to perform its tasks without printing the commands it executes Error messages are normally printed Example tmk s The make utility rebuilds your files but does not print the commands it executes during the make process Related information d Make utility option n Perform a dry run 5 188 Tool Options Make Utility Make Utility t Command line syntax t Description Wit
180. ecify the number of minimum addressable units MAUs you want to reserve and how much the location counter will advance The expression must be an integer greater than zero and cannot contain any forward references to address labels labels that have not yet been defined With expression2 you can specify a value to initialize the block with Only the least significant MAU of expression2 is used If you omit expression2 the default is zero If you specify label it gets the value of the location counter at the start of the directive processing LN You cannot initialize of a block of memory in sections with prefix sbss or bss In those sections the assembler issues a warning and only reserves space just as with DS The BSB BSH BSW and BSD directives are variants of the BS directive BSB The expression argument specifies the number of bytes to reserve BSH The expression argument specifies the number of half words to reserve one half word is16 bits BSW The expression argument specifies the number of words to reserve one word is 32 bits BSD The expression argument specifies the number of double words to reserve one double word is 64 bits Example The BSB directive is for example useful to define and initialize an array that is only partially filled section sdata DB 84 101 115 116 initialize 4 bytes BSB 96 0xFF reserve another 96 bytes initialized with OxFF Related information Gb DS Define Storage
181. ection information For each section its memory space size total cycle counts and name is listed on stdout and or in the list file The cycle count consists of two parts the total accumulated count for the section and the total accumulated count for all repeated instructions In the case of nested loops it is possible that the total supersedes the section total Without arguments this option is the same as section info cl With section info l the assembler writes the section information to the list file You must specify this option in combination with the option list file generate list file Example asarm list file section info console list test sre The assembler generates a list file and writes the section information to this file The section information is also displayed on stdout Related information d gt Assembler option list file generate list file 5 82 Tool Options Assembler Assembler symbol scope i Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Select the default label mode Local or Global Command line syntax symbol scope global local i g l Default il Description With this option you tell the assembler how to treat symbols that you have not specified explicitly as global or local By default the assembler treats all symbols as local symbols unle
182. ed as signed int or unsigned int By default an int bit field is treated as unsigned int This offers the best performance With this option you tell the compiler to treat int bit fields as signed int In this case you can still add the keyword unsigned to treat a particular int bit field as unsigned Related information J 5 160 Tool Options Control Program Control Program static Command line syntax static Description This option is directly passed to the compiler With this option the compiler treats external definitions at file scope except for main as if they were declared static Asa result unused functions will be eliminated and the alias checking algorithm assumes that objects with static storage cannot be referenced from functions outside the current module This option only makes sense when you specify all modules of an application on the command line Example ccarm static modulel c module2 c module3 c Related information i 5 161 ARM Embedded Tools Reference Control Program thumb Command line syntax thumb Description Generate code in Thumb mode The Thumb instruction set is a subset of the ARM instruction set which is encoded using 16 bit instructions instead of 32 bit instructions Related information J 5 162 Tool Options Control Program Control Program uchar u Command line syntax u uchar Description By default char is the same as spe
183. ees 8 10 Section Layout Definition and Section Setup 00 eet eee 8 10 Expression EValUatiOn ois dick Geka Rae ate wn meade a hn nk ele aos 8 13 Semantics of the Architecture Definition 0 cece eee teens 8 14 Defining an Architecture neisa criaden ee ee ee ene eee ee 8 15 Defining Intemal BUSES ir nc4 cee ees Da kaki ban ea a E E hoa bw ded Bi 8 15 Defining Address Spaces 000 cece ect et eee e eee DEE a DaD Eaa 8 15 Map pIngS 2 400 eee ea ieee edd ie Re a a EE AE a ee Yaka dod eed Peewee 8 18 Semantics of the Derivative Definition 0 cece eeaeee 8 20 Defining a Derivative 20 00caced ead oabdens antadedaebiaddawede MM awhe ede need nade dee 8 20 Instantiating Core Architectures 0 0 ccc ete eee eens 8 20 Defining Internal Memory and Buses 0 cece eect eens 8 21 Semantics of the Board Specification 0 cette ttt eens 8 22 DetiningG a PrOCESSOF sdrrieta isi hence wane pe mole wanes mle ae E EEEa OSE see aoe une 8 22 Instantiating Derivatives wiicdiocvd on taconite en di e i a a Oa Ea bes 8 22 Defining External Memory and BUSES 0 0 ett 8 23 Semantics of the Section Setup Definition 0 8 24 Setting up a Section ttt teeta 8 24 Semantics of the Section Layout Definition 00sec tee eeeeeee 8 25 Defining a Section Layout 0 ene teens 8 25 Creating and Locating Groups of Sections 0 cece tetas 8 2
184. efinition the macro expands as 1 You can specify as many macros as you like On the command line you can use the option define D multiple times If the command line exceeds the length limit of the operating system you can define the macros in an option file which you then must specify to the compiler with the option option file file f Defining macros with this option instead of in the C source is for example useful to compile conditional C source as shown in the example below Example Consider the following C program with conditional code to compile a demo program and a real program void main void if DEMO demo_func compile for the demo program else real func compile for the real program endif You can now use a macro definition to set the DEMO flag Macro Value DEMO 1 or empty On the command line use the option as follows carm define DEMO test c carm define DEMO 1 test c Note that both invocations have the same effect The next example shows how to specify a macro with arguments Macro definitions follow exactly the same rules as the define statement in the C language Macro Value MAX A B A gt B A B On the command line use the option D as follows carm D MAX A B A gt B A B test c 5 8 Tool Options C Compiler Note that the macro name and definition are placed between double quotes because otherwise the spaces
185. eger 1 if both operands are non zero otherwise it returns an integer 0 II logical OR kimo integer 1 if either of the operands is non zero otherwise it returns an integer Table 3 3 Assembly expression operators 3 7 Built in Assembly Functions The TASKING assemblers have several built in functions to support data conversion string comparison and math computations You can use functions as terms in any expression Syntax of an assembly function function_name argument argumenti Functions start with character and have zero or more arguments and are always followed by opening and closing parentheses White space a blank or tab is not allowed between the function name and the opening parenthesis and between the comma separated arguments 3 7 1 Overview of Built in Assembly Functions The following table provides an overview of all built in assembly functions Next all functions are described into more detail expr can be any assembly expression resulting in an integer value Expressions are explained in section 3 6 Assembly Expressions 3 5 ARM Embedded Tools Reference Overview of assembly functions Function Description ALUPCREL expr group check PC relative ADD SUB with operand split ARG symbol expr Test whether macro argument is present BIGENDIAN Test if assembler generates code for big endian mode CNT Return number of macro arguments cPU string
186. ell the macro preprocessor how to manipulate your assembly code before it is actually being assembled You can use these directives to write macros and to write conditional source code Parts of the code that do not match the condition will not be assembled at all Unlike other directives preprocesssor directives can start in the first column Some directives act as assembler options and most of them indeed do have an equivalent assembler command line option The advantage of using a directive is that with such a directive you can overrule the assembler option for a particular part of the code A typical example is to tell the assembler with an option to generate a list file while with the directives NOLIST and LIST you overrule this option for a part of the code that you do not want to appear in the list file Directives of this kind sometimes are called controls Each assembler directive has its own syntax Some assembler directives can be preceded with a label If you do not precede an assembler directive with a label you must use white space instead spaces or tabs You can use assembler directives in the assembly code as pseudo instructions 3 8 1 Overview of Assembler Directives The following tables provide an overview of all assembler directives For a detailed description of these directives refer to section 3 8 2 Detailed Description of Assembler Directives Overview of assembly control directives Directive Description
187. ements e Each map_descr can occur only once e You can define multiple mappings from a single source e Overlap between source ranges or destination ranges is not allowed e Ifthe src_dbits or dest_dbits statement is not present its value defaults to the width value if the source destination is a bus and to the mau size otherwise destination space space name bus lt proc_name core name gt ll bus_name e Aspace_name refers to a defined address space e Aproc_name refers to a defined processor e Acore_name refers to a defined core e Abus_name refers to a defined bus e The following mappings are allowed source to destination space gt space space gt bus bus gt bus memory gt bus range expr ee expr 8 3 8 Architecture Definition architecture _definition architecture arch_name lt parameter list gt 9 1 lt extends arch_name lt argument_list gt 0 1 gt 0 1 arch_spec e Anarchitecture_definition defines a core architecture with the given arch_name as a unique name e Atleast one space_def and at least one bus_def have to be present in an architecture_definition e Anarchitecture_definition that uses the extends construct defines an architecture that inherits all elements of the architecture defined by the second arch_name The parent architecture must be defined in the LSL file as well parameter list parameter lt parameter gt 9 parameter IDENTIFIER lt e
188. end of file indication The header file also defines type fpos_t as an unsigned long Macros stdio h wchar h Description NULL BUFSIZ EOF WEOF FOPEN_MAX FILENAME MAX _IOFBF _IOLBF _IONBF L_tmpnam TMP_MAX SEEK _CUR SEEK_END SEEK_SET stderr stdin stdout 2 12 expands to the null pointer constant Size of the buffer used by the setbuf setvbuf function 512 End of file indicator Expands to 1 End of file indicator Expands to UINT_Max defined in Limits h NOTE WEOF need not to be a negative number as long as its value does not correspond to a member of the wide character set Defined in wchar h Number of files that can be opened simultaneously 10 Maximum length of a filename 100 Expand to an integer expression suitable for use as argument to the setvbuf function Size of the string used to hold temporary file names 8 tmpxxxxx Maximum number of unique temporary filenames that can be generated 0x8000 Expand to an integer expression suitable for use as the third argument to the fseek function Expressions of type pointer to FILE that point to the FILE objects associated with standard error input and output streams Libraries File access stdio h Description fopen name mode Opens a file for a given mode Available modes are EP r read open text file for reading yy w write create text file for writing if the file already exists its contents is discarded a a
189. ent directory The order in which the assembler searches for include files is 1 The pathname in the assembly file and the directory of the assembly source 2 The path that is specified with this option 3 The path that is specified in the environment variable ASARMINC when the product was installed 4 The default include directory relative to the installation directory Example Suppose that your assembly source file test src contains the following line INCLUDE myinc inc You can call the assembler as follows asarm include directory c proj include test srce First the assembler looks in the directory where test src is located for the file myinc inc If it does not find the file it looks in the directory c proj include for the file myinc inc this option If the file is still not found the assembler searches in the environment variable and then in the default include directory Related information db Assembler option include file H Include file before source 5 66 Tool Options Assembler Assembler include file H Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Preprocessing 3 Enter the name of the file in the Include this file before source field or click and select a file Command line syntax include file file Hfile Description With this option set at project level you in
190. ents outside the core or processor Such buses on a processor have physical pins reserved for the number of bits specified with the width statements e The mau field specifies the MAU size Minimum Addressable Unit of the data bus This field is required e The width field specifies the width number of address lines of the data bus The default value is the MAU size e The map keyword specifies how this bus maps onto another bus if so Mappings are described in section 8 5 4 Mappings bus bus_name mau 8 width 8 map map_description 8 5 3 Defining Address Spaces With the space keyword you define a logical address space The space name is used to identify the address space and does not conflict with other identifiers 8 15 ARM Embedded Tools Reference The id field defines how the addressing space is identified in object files In general each address space has a unique ID The linker locates sections with a certain ID in the address space with the same ID This field is required In IEEE this ID is specified explicitly for sections and symbols ELF sections map by default to the address space with ID 1 Sections with one of the special names defined in the ABI Application Binary Interface may map to different address spaces The mau field specifies the MAU size Minimum Addressable Unit of the space This field is required The align value must be a power of two The linker uses this value to compute the star
191. eous 3 Add the option page width to the Additional assembler options field Command line syntax page width number Default 132 Description If you generate a list file with the assembler option list file I this option sets the number of columns per line on a page in the list file The default is 132 the minimum is 40 Related information d gt Assembler option list file Generate list file 5 78 Tool Options Assembler Assembler preprocess E Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Add the option preprocess to the Additional assembler options field Command line syntax preprocess E Description With this option the assembler will only preprocess the assembly source file The assembler sends the preprocessed file to stdout Related information i 5 79 ARM Embedded Tools Reference Assembler preprocessor type m Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Add the option preprocessor type to the Additional assembler options field Command line syntax preprocessor type none tasking m n t Default mt Description With this option you select the preprocessor that the assembler will use By default the assembler uses the TASK
192. eptflag Sets the current floating point status flags Not implemented fetestexcept Returns the bitwise OR of the exception macros corresponding to the exception flags which are current ly set and are specified in the argument Not implemented For each supported exception a macro is defined The following exceptions are defined FE_DIVBYZERO FE_INEXACT FE_INVALID FE_OVERFLOW FE_UNDERFLOW FE_ALL_EXCEPT fegetround Returns the current rounding direction represented as one of the values of the rounding direction mac ros Not implemented fesetround Sets the current rounding directions Not implemented Currently no rounding mode macros are implemented 2 2 8 float h The header file float h defines the characteristics of the real floating point types float double and long double AN Float h used to contain prototypes for the functions copysign f isinf f isfinite f isnan f and scalb f These functions have accordingly to the ISO C99 standard been moved to the header file math h See also section 2 2 15 math h and tgmath h 2 2 9 inttypes h and stdint h The header files stdint h and inttypes h provide additional declarations for integer types and have various characteristics The stdint h header file contains basic definitions of integer types of certain sizes and corresponding sets of macros This header file clearly refers to the corresponding sections in the ISO C99 standard The inttypes h header file includes stdint
193. er Using the Compiler of the user s manual Description The TASKING C compilers offer four optimization levels and a custom level at each level a specific set of optimizations is enabled e No optimization O0 No optimizations are performed The compiler tries to achieve a 1 to 1 resemblance between source code and produced code Expressions are evaluated in the order written in the source code associative and commutative properties are not used e Few optimizations O1 Enables optimizations that do not affect the debug ability of the source code Use this level when you encounter problems during debugging your source code with optimization level 2 5 33 ARM Embedded Tools Reference e Medium optimization O2 Enables more optimizations to reduce code size and or execution time This is the default optimization level e Full optimization O3 This is the highest optimization level Use this level to decrease execution time to meet your real time requirements e Custom optimization Ox X you can enable disable specific optimizations With these options you can control the level of optimization The default optimization level is Medium optimization option 02 or O or OabcefglklopsUwy You can overrule these settings in your C source file with the pragma pair pragma optimize flag and pragma endoptimize amp In addition to the command line option optimize O you can specify the option tradeoff t Wit
194. er operators in an expression Control statement expressions Control flow 13 1 13 2 13 3 13 4 13 5 13 6 13 7 14 1 14 2 14 3 14 4 14 5 14 6 14 7 14 8 14 9 14 10 2z 3 3332393 2 233333 2 R R Assignment operators shall not be used in expressions that yield a Boolean value Tests of a value against zero should be made explicit unless the operand is effectively Boolean Floating point expressions shall not be tested for equality or inequality The controlling expression of a for statement shall not contain any objects of floating type The three expressions of a for statement shall be concerned only with loop control A violation is reported when the loop initialization or loop update expression modifies an object that is not referenced in the loop test Numeric variables being used within a for loop for iteration counting shall not be modified in the body of the loop Boolean operations whose results are invariant shall not be permitted There shall be no unreachable code All non null statements shall either a have at least one side effect however executed or b cause control flow to change Before preprocessing a null statement shall only occur on a line by itself it may be followed by a comment provided that the first character following the null statement is a white space character The goto statement shall not be used The continue statement shall not be used For a
195. erts a multibyte character s to a wide character pwc according to conversion state ps See also mbtowc in section 2 2 23 stdlib h and wchar h Converts a wide character wc to a multi byte character according to conversion state ps and stores the multi byte character in s Returns the wide character corresponding to character c Returns WEOF on error Returns the multi byte character corresponding to the wide character c The returned multi byte character is represented as one byte Returns EOF on error Inspects up to n bytes from the string s to see if those characters represent valid multibyte characters relative to the conversion state held in ps 2 23 ARM Embedded Tools Reference 2 2 28 wctype h Most in wctype h represent the wide character variant of declared in ctype h and are discussed in section 2 2 3 ctype h and wetype h In addition this header file provides extensible locale specific wide character classification wctype property iswctype wc desc Constructs a value of type wctype_t that describes a class of wide characters identified by the string property If property identifies a valid class of wide characters according to the LC_TYPE category see section 2 2 13 ocale h of the current locale a non zero value is returned that can be used as an argument in the iswctype function Tests whether the wide character wc is a member of the class represented by wctype_t desc Returns a non zero value if te
196. es For the user stack used in USR mode and in SYS mode you can specify the size and the location and you can tell the linker to add unused memory to the stack You can do the same for the heap For the other stacks you can only specify their sizes The linker will determine their locations and their sizes are fixed If you want another stack to be the primary stack for example the supervisor stack you need to change the LSL file The stack size is defined in the linker script file arm 1s1 in directory include 1s1 with macros Define Description __ STACK Size of user stack used in USR mode and in SYS mode __STACK_FIQ FIQ mode stack size __STACK_IRQ IRQ mode stack size __STACK_SVC Supervisor mode stack size __STACK_ABT Abort mode stack size __STACK_UND Undefined mode stack size __ STACK FIXED Defined if you do not expand the user stack if space is left __STACKADDR User stack start address Table 4 5 Stack macros used in arm lsl Heap allocation The heap is only needed when you use one or more of the dynamic memory management library functions malloc calloc free and realloc The heap is a reserved area in memory Only if you use one of the memory allocation functions listed above the linker automatically allocates a heap as specified in the linker script file with the keyword heap 4 5 ARM Embedded Tools Reference A special section called heap is used for the allocatio
197. es in the multi byte character pointed to by s At most n characters will be examined See also mbr1len in section 2 2 27 wchar h Converts the multi byte character in s to a wide character code and stores it in pwc At most n characters will be examined Converts the wide character wc into a multi byte representation and stores it in the string pointed to by s At most MB_CUR_MAX characters are stored Converts a sequence of multi byte characters in the string pointed to by s into a sequence of wide characters and stores at most n wide characters into the array pointed to by pwcs See also mbsrtowcs in section 2 2 27 wchar h Converts a sequence of wide characters in the array pointed to by pwcs into multi byte charac ters and stores at most n multi byte characters into the string pointed to by s See also wcsrtowmb in section 2 2 27 wchar h 2 2 24 string h and wehar h This header file provides numerous functions for manipulating strings By convention strings in C are arrays of characters with a terminating null character Most functions therefore take arguments of type char However many functions have also parallel wide character functions which take arguments of type wchar_t These functions are declared in wchar h Copying and concatenation functions stdio h wehar h Description memcpy sl s2 n memmove sl1 s2 n strcpy sl1 s2 strncpy sl s2 n strcat sl1 s2 strncat sl s2 n wmemcpy s
198. esented by symbol or expression is present 0 otherwise You can specify the argument with a symbo name the name of a macro argument enclosed in single quotes or with expression the ordinal number of the argument in the macro formal argument list If you use this function when macro expansion is not active the assembler issues a warning Example IF ARG TWIDDLE is argument twiddle present IF ARG 1 is first argument present BIGENDIAN Returns 1 if the assembler generates code for big endian mode returns 0 if the assembler generates code for little endian mode this is the default Assembly Language CNT Returns the number of macro arguments of the current macro expansion as an integer If you use this function when macro expansion is not active the assembler issues a warning Example ARGCOUNT SET CNT reserve argument count CPU processor_type With the cPu function you can check whether the source code is being assembled for a certain processor type The function evaluates to TRUE when the specified processor_type matches the processor type that was specified with the option Cpu cpu This function is useful to create conditional code for several targets as shown in the example Example IF CPU ARMv4 true if you specified option cpu ARMv4 code for the ARMv4 ELIF CPU ARMvV6M true if you specified option cpu ARMv6M code for the ARMv6 M ELSE
199. essor macros in dialog Project Project Options Assembler Preprocessing assembler option define Related information Gb Assembler option define Define preprocessor macro in Section 5 2 Assembler Options of Chapter Tool Options 3 28 Assembly Language INCLUDE Syntax INCLUDE filename lt filename gt Description With the INCLUDE directive you include another file at the exact location where the INCLUDE occurs This happens before the resulting file is assembled The INCLUDE directive works similarly to the include statement in C The source from the include file is assembled as if it followed the point of the INCLUDE directive When the end of the included file is reached assembly of the original file continues The string specifies the filename of the file to be included The filename must be compatible with the operating system forward backward slashes and can contain a directory specification If you omit a filename extension the assembler assumes the extension asm If an absolute pathname is specified the assembler searches for that file If a relative path is specified or just a filename the order in which the assembler searches for include files is 1 The current directory if you use the filename construction The current directory is not searched if you use the lt filename gt syntax 2 The path that is specified with the assembler option include directory l 3 The p
200. ew of the architecture you are using and a description of the assembly instruction set refer to the target s Core Reference Manual 3 1 Assembly Syntax An assembly program consists of zero or more statements A statement may optionally be followed by a comment Any source statement can be extended to more lines by including the line continuation character as the last character on the line The length of a source statement first line and continuation lines is only limited by the amount of available memory Mnemonics and directives are case insensitive Labels symbols directive arguments and literal strings are case sensitive The syntax of an assembly statement is label instruction directive macro_call comment label A label is a special symbol which is assigned the value and type of the current program location counter A label can consist of letters digits and underscore characters _ The first character cannot be a digit The label can also be a number A label which is prefixed by whitespace spaces or tabs has to be followed by a colon The size of an identifier is only limited by the amount of available memory number is a number ranging from 1 to 255 This type of label is called a numeric label or local label To refer to a numeric label you must put an n next or p previous immediately after the label This is required because the same label number may be used repeatedly Examples LAB1 This l
201. f a memory chip Locate Result Symbols This part of the map file lists all external symbols per address space name both sorted on address and sorted on symbol name Name The name of the symbol Space addr The absolute address of the section in the address space Space The names of the address spaces as defined in the linker script file 1s1 The names are constructed of the derivative name followed by a colon the core name another colon and the space name Processor and Memory This part of the map file shows the processor and memory information of the linker script file By default this part is not shown in the map file You have to turn this part on manually with linker option map file format lsl processor and memory info You can print this information to a separate file with linker option Isl dump Locate Rules This part of the map file shows the rules the linker uses to locate sections Address space The names of the address spaces as defined in the linker script file 1s1 The names are constructed of the derivative name followed by a colon the core name another colon and the space name Type The rule type ordered contiguous clustered unrestricted Specifies how sections are grouped By default a group is unrestricted which means that the linker has total freedom to place the sections of the group in the address space absolute The section must be located at the address shown in
202. fied the value is then taken from the next argument which is assumed to be of type int A length modifier h hh P P L F z or t h indicates that the argument is to be treated as a short or unsigned short hh indicates that the argument is to be treated as a char or unsigned char l should be used if the argument is a long integer Il fora long long L indicates that the argument is a long double indicates a pointer to intmax_t or uintmax_t 2 indicates a pointer to size_t and t indicates a pointer to ptrdiff_t 2 13 ARM Embedded Tools Reference Flags length specifier period precision and length modifier are optional the conversion character is not The conversion character must be one of the following if a character following is not in the list the behavior is undefined Character Printed as d i int signed decimal o int unsigned octal x X int unsigned hexadecimal in lowercase or uppercase respectively u int unsigned decimal c int single character converted to unsigned char S char the characters from the string are printed until a NULL character is found When the given precision is met before printing will also stop f double e E double g G double a A double n int the number of characters written so far is written into the argument This should be a pointer to an inte ger in default memory No value is printed p pointer hexadecimal 24 bit value No ar
203. finition_statements ENDM Description With the MACRO directive you define a macro Macros provide a shorthand method for handling a repeated pattern of code or group of instructions You can define the pattern as a macro and then call the macro at the points in the program where the pattern would repeat The definition of a macro consists of three parts e Header which assigns a name to the macro and defines the arguments e Body which contains the code or instructions to be inserted when the macro is called e Terminator which indicates the end of the macro definition ENDM directive The arguments are symbolic names that the macro processor replaces with the literal arguments when the macro is expanded called Each formal argument must follow the same rules as symbol names the name can consist of letters digits and underscore characters _ The first character cannot be a digit Argument names cannot start with a percent sign Macro definitions can be nested but the nested macro will not be defined until the primary macro is expanded You can use the following operators in macro definition statements Operator Name Description Macro argument Concatenates a macro argument with adjacent alphanumeric characters concatenation Return decimal Substitutes the symbol sequence with a character string that represents the decimal value value of symbol of the symbol Return hex Substitutes the symbo sequence wit
204. flag endprofile Control the profile settings The pragma works the same as compiler option profile p Note that this pragma will only be checked at the start of a function endprofile switches back to the previous profiling settings db See C compiler option profile p in section 5 1 C Compiler Options in Chapter Tool Options profiling If profiling is enabled on the command line C compiler option profile p you can disable part of your source code for profiling with the pragmas profiling off and profiling ARM Embedded Tools Reference protect endprotect With these pragmas you can protect sections against linker optimizations This excludes a section from unreferenced section removal and duplicate section removal by the linker endprotext restores the default section protection runtime flag Check for run time errors The pragma works the same as compiler option runtime r Gls See C compiler option runtime r in section 5 1 C Compiler Options in Chapter Tool Options section name suffix f m fm endsection Rename sections by adding a suffix to all section names specified with name or restore default section naming If you specify only a suffix without a name the suffix is added to all section names See C compiler option rename sections in section 5 1 C Compiler Options in Chapter Tool Options See assembler directive SECTION Start or continue secti
205. function qualifier whenever possible This option has the same effect as a pragma inline at the start of the source file Related information d gt Tool Options C Compiler C Compiler inline max incr inline max size Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Optimization 3 Set the option Maximum code size increasse caused by to a value default 25 4 Set the option Maximum size for functions to always inline to a value default 25 Command line syntax inline max incr percentage Default 25 inline max size threshold Default 25 Description With these options you can control the function inlining optimization process of the compiler These options have only effect when you have enabled the inlining optimization option Oi Regardless of the optimization process the compiler always inlines all functions that have the function qualifier inline With the option inline max size you can specify the maximum size of functions that the compiler inlines as part of the optimization process The compiler always inlines all functions that are smaller than the specified threshold The threshold is measured in compiler internal units and the compiler uses this measure to decide which functions are small enough to inline The default threshold is 25 After the compiler has inlined all functions that have the function
206. g Multiple arguments are stored in successive half word address locations If an argument is NULL its corresponding address location is filled with zeros Half word arguments are stored as is Floating point values are not allowed If the evaluated argument is too large to be represented in a half word the assembler issues a warning and truncates the value In case of single and multiple character strings each ASCII value of the character is stored in successive locations starting at the most significant byte of a half word The standard C escape sequences are allowed DH AB D gt 0x4241 0x0000 second argument is empty 0x4400 Example TABLE DH 14 253 0x62 ABCD CHARS DH A B C D Related information db BS Block Storage DS Define Storage DB_ Define Byte DW Define Word DD_ Define Double Word 3 19 ARM Embedded Tools Reference DS DSB DSH DSW DSD Syntax label DS expression label DSB expression label DSH expression label DSW expression label DSD expression Description With the Ds directive Define Storage the assembler reserves a block of memory The reserved block of memory is not initialized to any value With the expression you specify the number of minimum addressable units MAUs that you want to reserve The expression must evaluate to an integer larger than zero and cannot contain references to symbols that are not yet defined in
207. greater than x as a double rint rintl rintf rint Returns the rounded integer value as an int according to the current rounding direction See fenv h Not implemented lrint lrintf Ilrintl lrint Returns the rounded integer value as a long int according to the current rounding direction See fenv h Not implemented llrint lrintf lrintl llrint Returns the rounded integer value as along long int according to the current rounding direction See fenv h Not implemented nearbyint nearbyintf nearbyint Returns the rounded integer value as a floating point according to the current nearbyintl rounding direction See fenv h Not implemented round roundl roundf round Returns the nearest integer value of x as int Not implemented lround lroundl lroundf lround Returns the nearest integer value of x as long int Not implemented llround1llroundlllroundf 1lround Returns the nearest integer value of x as long long int Not implemented trunc truncl truncf trunc Returns the truncated integer value x Not implemented 2 8 Libraries Remainder after devision Description remainderl remainderf remquo remquol remquof Power and absolute value functions Returns the remainder r of x ny n is chosen as trunc Xx y r has the same sign as x Returns the remainder r of x ny n is chosen as trunc X y r may not have the same sign as x Not implemented Same as remainder In addition the argument quo is given a specific value see ISO N
208. gument is converted a is printed Table 2 2 Printf conversion characters All arguments to the scanf related functions should be pointers to variables in default memory of the type which is specified in the format string The format string can contain Blanks or tabs which are skipped Normal characters not which should be matched exactly in the input stream Conversion specifications starting with a character Conversion specifications should be built as follows in order A meaning that no assignment is done for this field Anumber specifying the maximum field width The conversion characters d i n o u and x may be preceded by h if the argument is a pointer to short rather than int or by hh if the argument is a pointer to char or by l letter ell if the argument is a pointer to Long or by I for a pointer to long long J fora pointer to intmax_t or uintmax_t Z for a pointer to size_t or t for a pointer to ptrdiff_t The conversion characters e f and g may be preceded by I if the argument is a pointer to double rather than float and by L for a pointer toa long double A conversion specifier maximum field width and length modifier are optional the conversion character is not The conversion character must be one of the following if a character following is not in the list the behavior is undefined Length specifier and length modifier a
209. h a character string that represents the hexadecimal value of symbol value of the symbol Macro string Allows the use of macro arguments as literal strings delimiter Macro local label Prevents name mangling on labels in macros override Example The macro definition macro_a MACRO argl arg2 header db argl body dw argl arg2 ENDM terminator The macro call section data macro_a 2 3 The macro expands as follows db 2 dw 2 3 3 32 Assembly Language Related information d DEFINE Define a substitution string Section 3 9 Macro Operations 3 33 ARM Embedded Tools Reference MESSAGE Syntax MESSAGE type str exp symbo strlexp symbo Description With the MESSAGE directive you tell the assembler to print a message to stdout during the assembling process With type you can specify the following types of messages I Information message Error and warning counts are not affected and the assembler continues the assembling process W Warning message Increments the warning count and the assembler continues the assembling process E Error message Increments the error count and the assembler continues the assembling process F Fatal error message The assembler immediately aborts the assembling process and generates no object file or list file The MESSAGE directive is for example useful in combination with conditional assembly to indicate which part is asse
210. h this option you specify whether the used optimizations should optimize for more speed regardless of code size or for smaller code size regardless of speed Example The following invocations are equivalent and result all in the default optimization set carm test c carm 02 test c carm optimize 2 test c carm 0 test c carm optimize test c carm OabcefgIklopsUwy test c carm optimize coalesce ipro cse expression tflow glo inline schedule loop forward propagate subscript unroll pipeline peephole test c Related information db Section 2 6 Compiler Optimizations in chapter Using the Compiler of the user s manual C compiler option tradeoff t Trade off between speed t0 and size t4 5 34 Tool Options C Compiler C Compiler option file f Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option option file to the Additional C compiler options field Be aware that the options in the option file are added to the C compiler options you have set in the other dialogs Only in extraordinary cases you may want to use them in combination Altium Designer automatically saves the options with your project Command line syntax option file file f file Description This option is primarily intended for command line use Instead of typing all options on the comm
211. h this option you tell the make utility to touch the target files bringing them up to date rather than performing the rules to rebuild them Example tmk t The make utility updates out of date files by giving them a new date and time stamp The files are not actually rebuild Related information J 5 189 ARM Embedded Tools Reference Make Utility time Command line syntax time Description With this option you tell the make utility to display the current date and time on standard output Example tmk time The make utility displays the current date and time and updates out of date files Related information i 5 190 Tool Options Make Utility Make Utility V Command line syntax V Description Display version information The make utility ignores all other options or input files Example tmk V The make utility displays the version information but does not perform any tasks Related information i 5 191 ARM Embedded Tools Reference Make Utility W Command line syntax W target Description With this option the make utility considers the specified target file always as up to date and will not rebuild it Example tmk W test abs The make utility rebuilds out of date targets in the makefile except the file test abs which is considered now as up to date Related information i 5 192 Tool Options Make Utility Make Utility x Command line syntax X Desc
212. h_switch Force use of the tbh instruction Uses a table of 16 bit jump offsets no_tbh_ switch Same as smart_switch but do not use the tbh instruction d gt See Section 1 7 Switch Statement tradeoff level Specify tradeoff between speed 0 and size 4 db See also C compiler option tradeoff t warning number With this pragma you can disable warning messages If you do not specify a warning number all warnings will be suppressed Gls See also C compiler option no warnings w weak symbol Mark a symbol as weak weak assembler directive The symbol must have external linkage which means a global or external object or function A static symbol cannot be declared weak A weak external reference is resolved by the linker when a global or weak definition is found in one of the object files However a weak reference will not cause the extraction of a module from a library to resolve the reference When a weak external reference cannot be resolved the null pointer is substituted A weak definition can be overruled by a normal global definition The linker will not complain about the duplicate definition and ignore the weak definition d gt See assembler directive WEAK in Section 3 8 2 Assembler Directives in Chapter Assembly Language ARM Embedded Tools Reference 1 6 Predefined Preprocessor Macros In addition to the predefined macros required by the ISO C standard suchas ___ DATE _and___
213. hardware initialization routine __init_vector_table Start label of vector table initialization Table 4 2 Labels used in cstart asm 4 2 Reset Handler and Vector Table Reset handler As explained in the previous section the entry point of the startup code reset handler is label START The reset handler can have a fixed ROM address run address If the reset handler is called from the vector table you do not need the specify a fixed address In this case the linker determines the address and patches the vector table There are however situations were you have to specify a fixed ROM address e If START is the entry point upon reset Typically you would set the ROM address to the address which is mapped at address 0x00000000 Your initialization code re maps this address during startup Note that the reset handler in the run time library is immune to this re mapping because the first instruction in the startup code sets the program counter to the actual ROM address 4 2 Run time Environment e When the reset handler is called from the vector table with a branch instruction B _ START and the linker has located the reset handler at an address that is out of range of the branch instruction When you specify a fixed ROM address you can make sure that the reset handler can be called from the vector table Note however that you can prevent out of range branches by using a position independent vector table which loads the handler addresse
214. he argument VAL Example Argument String Operator To generate a literal string enclosed by single quotes you must use the argument string operator in the macro definition Consider the following macro definition STR_MAC MACRO STRING DB STRING ENDM The macro is called as follows STR_MAC ABCD The macro expands as follows DB ABCD Within double quotes DEFINE directive definitions can be expanded Take care when using constructions with quotes and double quotes to avoid inappropriate expansions Since DEFINE expansion occurs before macro substitution any DEFINE symbols are replaced first within a macro argument string DEFINE LONG short STR_MAC MACRO STRING MESSAGE I This is a LONG STRING MESSAGE I This is a LONG STRING ENDM If the macro is called as follows STR_MAC sentence 3 48 Assembly Language it expands as MESSAGE I This is a LONG STRING MESSAGE I This is a short sentence Macro Local Label Override Operator If you use labels in macros the assembler normally generates another unique name for the labels such as LOCAL M L000001 The macro operator prevents name mangling on macro local labels Consider the following macro definition INIT MACRO addr LOCAL ldr r0 addr ENDM The macro is called as follows LOCAL INIT LOCAL The macro expands as LOCAL M L000001 ldr r0 LOCAL If you would not have u
215. he linker and contains the start address and size of all sections that should be initialized by the startup code You must define exactly one copy table in one of the address spaces for a core Optionally you can specify an alignment for the copy table with the argument align This alignment must be equal or larger than the alignment that you specify for the address space itself If smaller the alignment for the address space is used The copy_unit argument specifies the size in MAUs of information chunks that are copied If you do not specify the copy unit the MAU size of the address space itself is used The dest argument specifies the destination address space that the code uses for the copy table The linker uses this information to generate the correct addresses in the copy table The memory into where the sections must be copied at run time must be accessible from this destination space Sections generated for the copy table may get a page restriction with the address space s page size by adding the page argument Linker Script Language Vector table The vector_table keyword defines a vector table with n vectors of size m This is an internal LSL object similar to an LSL group The run_addr argument specifies the location of the first vector id 0 This can be a simple address or an offset in memory see the description of the run time address in subsection Locating a group in section 8 9 2 Creating and Locating Groups of Sect
216. he linker searches libraries in chapter Using the Linker of the user s manual 5 105 ARM Embedded Tools Reference Linker link only Menu entry Command line syntax link only Description With this option you suppress the locating phase The linker stops after linking and informs you about unresolved references Related information dE Control program option cl Stop after linking 5 106 Tool Options Linker Linker long branch veneers Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Enable the option Generate long branch veneers Command line syntax long branch veneers Description With this option you enable the linker to generate a long branch veneer if the target of a B ARM only not for Thumb BL or BLX instruction is out of range The locating process of the linker may become less efficient if this option is switched on even if no long branch veneers are required after all Therefore it is better to first see if out of range branches are in the code unlikely before switching on this option You cannot use this option with the ARMv6 M architecture profile Related information J 5 107 ARM Embedded Tools Reference Linker Isl check Menu entry Command line syntax Isl check Description With this option the linker just checks the syntax of the LSL file s and
217. he object modules that contain a reference to the symbol are shown Also symbols that remain undefined are shown Call Graph This part of the map file contains a schematic overview that shows how library functions call each other 6 6 List File Formats Locate Result Sections This part of the map file shows the absolute position of each section in the absolute object file It is organized per address space memory chip and group and sorted on space address Space The names of the address spaces as defined in the linker script file 1s1 The names are constructed of the derivative name followed by a colon the core name another colon and the space name Chip The names of the memory chips as defined in the linker script file 1s1 in the memory definitions Group Sections can be ordered in groups These are the names of the groups as defined in the linker script file 1s1 with the keyword group in the section_layout definition The name that is displayed is the name of the deepest nested group Section The name and id of the section The number between uniquely identifies the section Names within square brackets will be copied during initialization from ROM to the corresponding section name in RAM Size MAU The size of the section in minimum addressable units Space addr The absolute address of the section in the address space Chip addr The absolute offset of the section from the start o
218. he source addresses In combination with size this specifies the range of address that are mapped By default the source offset is Ox0000 e The size argument specifies the number of addresses that are mapped This argument is required e The dest_offset argument specifies the position in the destination to which the specified range of addresses is mapped By default the destination offset is Ox0000 If you are mapping a bus to another bus the number of data lines of each bus may differ In this case you have to specify a range of source data lines you want to map sre_dbits begin end and the range of destination data lines you want to map them to dest_dbits first last e The srce_dbits argument specifies a range of data lines of the source bus By default all data lines are mapped e The dest_dbits argument specifies a range of data lines of the destination bus By default all data lines from the source bus are mapped on the data lines of the destination bus starting with line 0 Linker Script Language From space to space If you map an address space to another address space nesting you can do this by mapping the subspace to the containing larger space In this example a small space of 64k is mapped on a large space of 16M space small id 2 mau 4 map src_offset 0 dest_offset 0 dest space large size 64k From space to bus All spaces that are not mapped to another space must map to a bus in
219. here the pattern would repeat Some patterns contain variable entries which change for each repetition of the pattern Others are subject to conditional assembly When a macro is called the assembler executes the macro and replaces the call by the resulting in line source statements In line means that all replacements act as if they are on the same line as the macro call The generated statements may contain substitutable arguments The statements produced by a macro can be any processor instruction almost any assembler directive or any previously defined macro Source statements resulting from a macro call are subject to the same conditions and restrictions as any other statements Macros can be nested The assembler processes nested macros when the outer macro is expanded 3 9 1 Defining a Macro The first step in using a macro is to define it The definition of a macro consists of three parts e Header which assigns a name to the macro and defines the arguments e Body which contains the code or instructions to be inserted when the macro is called e Terminator which indicates the end of the macro definition ENDM directive A macro definition takes the following form macro_name MACRO arg arg comment source statements ENDM If the macro name is the same as an existing assembler directive or mnemonic opcode the assembler replaces the directive or mnemonic opcode with the macro and issues a warning The
220. humb 16 bit generic Load an address or a 32 bit constant value into a low register If the constant is in the range 0 255 the assembler will generate a MOV instruction Otherwise the assembler places the constant or the address in a literal pool and generates a PC relative LDR instruction that loads the value from the literal pool Instruction Replacement Description LDR Ad expr MOV Rad expr If expr is in range LDR Rad ltpool code ltpool DW expr If expr is external or PC relative or not in range The PC relative offset from the LDR instruction to the value in the literal pool must be positive and less than 1 kB By default the assembler will place a literal pool at the end of each code section If the default literal pool is out of range you will have to ensure that there is another literal pool within range by means of the LTORG directive Bcond inversion Thumb 16 bit generic The PC relative conditional branch instruction has a range of 256 255 bytes The unconditional version has a range of 2048 2047 bytes If the conditional branch target is out of range the assembler will rewrite the conditional branch instruction with an inversed conditional branch and an unconditional branch Instruction Replacement Description Bcond label Binv_cond 1 B label 1 If target label out of range ADD SUB inversions Thumb 16 bit generic For the following six in
221. implementation Performs a formatted write to the stream stdout Returns EOF WEOF on error FSS implementation Performs a formatted write to string s Returns EOF WEOF on error Same as sprintf but n specifies the maximum number of characters including the terminating null character to be written Same as fprintf fwprintf but extra arguments are given as variable argument list arg See section 2 2 18 stdarg h FSS implementation Same as printf wprintf but extra arguments are given as variable argument list arg See section 2 2 18 stdarg h FSS implementation Same as sprintf swprintf but extra arguments are given as variable argument list arg See section 2 2 18 stdarg h FSS implementation 2 15 ARM Embedded Tools Reference Character input output stdio h wchar h Description fgetc stream getc stream getchar stdin fgets s n stream gets s n stdin ungetc c stream fputc c stream putc c stream putchar c stdout fputs s stream puts s Direct input output stdio h fgetwc stream getwc stream getwchar stdin fgetws s n stream ungetwc c stream fputwe c stream putwe c stream putwchar c stdout fputws s stream Description Reads one character from stream Returns the read character or EOF WEOF on error FSS implementation Same as fgetc fgetwe except that is implemented as a macro FSS implementation NOTE
222. implicitly by initialization MISRA C Rules Initialization 9 1 R All automatic variables shall have been assigned a value before being used This rule is checked using worst case assumptions This means that violations are reported not only for variables that are guaranteed to be uninitialized but also for variables that are uninitialized on some execution paths Braces shall be used to indicate and match the structure in the non zero initialization of arrays and structures In an enumerator list the construct shall not be used to explicitly initialize members other than the first unless all items are explicitly initialized Arithmetic type conversions 10 1 10 2 10 3 10 4 10 5 10 6 R The value of an expression of integer type shall not be implicitly converted to a different underlying type if a it is not a conversion to a wider integer type of the same signedness or b the expression is complex or c the expression is not constant and is a function argument or d the expression is not constant and is a return expression The value of an expression of floating type shall not be implicitly converted to a different type if a it is not a conversion to a wider floating type or b the expression is complex or c the expression is a function argument or d the expression is a return expression The value of a complex expression of integer type may only be cast to a type that is narr
223. in order Flags in any order specifies left adjustment of the converted argument a number is always preceded with a sign character has higher precedence than space space a negative number is preceded with a sign positive numbers with a space 0 specifies padding to the field width with zeros only for numbers specifies an alternate output form For o the first digit will be zero For x or X 0x and 0X will be prefixed to the number For e E f g G the output always contains a decimal point trailing zeros are not removed A number specifying a minimum field width The converted argument is printed in a field with at least the length specified here If the converted argument has fewer characters than specified it will be padded at the left side or at the right when the flag was specified with spaces Padding to numeric fields will be done with zeros when the flag 0 is also specified only when padding left Instead of a numeric value also may be specified the value is then taken from the next argument which is assumed to be of type int A period This separates the minimum field width from the precision A number specifying the maximum length of a string to be printed Or the number of digits printed after the decimal point only for floating point conversions Or the minimum number of digits to be printed for an integer conversion Instead of a numeric value also may be speci
224. ine int add int a int b int i 4 return a b pragma noinline void main void add 1 2 z add x y Wl If a function has an inline or _noinline function qualifier then this qualifier will overrule the current pragma setting d See section 1 8 3 Inlining Functions inline __noinline By default small fuctions that are not too often called from different locations are inlined This reduces execution speed at the cost of code size C compiler option Oi With the pragma noinline pragma smartinline you can temporarily disable this optimization With the C compiler options inline max incr and inline max size you have more control over the automatic function inlining process of the compiler See for more information the C compiler options inline max iner and inline max size in section 5 1 C Compiler Options in Chapter Tool Options macro nomacro Turns macro expansion on or off By default macro expansion is enabled message message Print the message string s on standard output optimize flags endoptimize You can overrule the compiler option O for the code between the pragmas optimize and endoptimize The pragma works the same as compiler option O See section 2 6 Compiler Optimizations in Chapter Using the Compiler in the user s manual See C compiler option optimize O in section 5 1 C Compiler Options in Chapter Tool Options profile
225. ion misrac required warnings Linker option misrac report 5 27 ARM Embedded Tools Reference C Compiler misrac advisory warnings misrac required warnings Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select MISRA C 3 Enable one or both options Turn advisory rule violation into warning and Turn required rule violation into warning Command line syntax misrac advisory warnings misrac required warnings Description Normally if an advisory rule or required rule is violated the compiler generates an error AS a consequence no output file is generated With this option the compiler generates a warning instead of an error Related information d gt C compiler option misrac Linker option misrac report 5 28 Tool Options C Compiler C Compiler misrac version Menu entry 1 From the Project menu select Project Options The Project Options dialog appears 2 Expand the C Compiler entry and select MISRA C 3 Select the MISRA C standard MISRA C 1998 or MISRA C 2004 Command line syntax misrac version 1998 2004 Description MISRA C rules exist in two versions MISRA C 1998 and MISRA C 2004 By default the C source is checked against the MISRA C 2004 rules With this option you can specify to check against the MISRA C 1998 rules Related information d See Chapter 9 MISRA C Rules for a list
226. ion for complex multiplication and a more sophisticated implementation for divison and absolute value calculations which handles underflow overflow and infinities with more care The ISO C99 pragma CX_LIMITED_RANGE therefore has no effect Trigonometric functions csin csinf csinl Returns the complex sine of z ccos ccosf ccosl Returns the complex cosine of z ctan ctanf ctanl Returns the complex tangent of z casin casinf casinl Returns the complex arc sine sin 1 z cacos cacosf cacosl Returns the complex arc cosine cos 1 z catan catanf catanl Returns the complex arc tangent tan 1 z csinh csinhf csinhl Returns the complex hyperbolic sine of z ccosh ccoshf ccoshl Returns the complex hyperbolic cosine of z ctanh ctanhf ctanhl Returns the complex hyperbolic tangent of z casinh casinh cfasinhl Returns the complex arc hyperbolic sinus of z cacosh cacosh cfacoshl Returns the complex arc hyperbolic cosinus of z catanh catanhfcatanhl Returns the complex arc hyperbolic tangent of z Exponential and logarithmic functions cexp cexpf cexpl Returns the result of the complex exponential function e7 clog clogf clogl Returns the complex natural logarithm 2 2 Libraries Power and absolute value functions cabs cabsf cpow cpowf cabs1l cpowl esqrt csqrtf csqrtl Manipulation functions carg cargf cargl cimag cimagf cimagl conj conjf conjl cproj cprojf cprojl creal crealf creall Returns the complex
227. ion size Default optimize gJs Description Allow generic instructions If you use generic instructions in your assembly source the assembler can optimize them by replacing it with the fastest or shortest possible variant of that instruction By default this option is enabled If you turn off this optimization the assembler generates an error on generic instructions Be aware that the compiler also generates generic instructions Jump chains With this optimization the assembler replaces chained jumps by a single jump instruction For example a jump from a to b immediately followed by a jump from b to c is replaced by a jump from a to c Optimize instruction size With this optimization the assembler tries to find the shortest possible operand encoding for instructions Related information d gt Section 4 5 Assembler Optimizations in chapter Using the Assembler of the user s manual 5 74 Tool Options Assembler Assembler option file f Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Add the option option file to the Additional assembler options field Be aware that the options in the option file are added to the assembler options you have set in the other dialogs Only in extraordinary cases you may want to use them in combination Command line syntax option file file f file Desc
228. ions The Project Options dialog box appears 2 Expand the Processor entry and select Processor Definition 3 Enable the option Big endian mode Command line syntax endianness endianness B big endian You can specify the following endianness big b Big endian little I Little endian default Description By default the assembler generates object files with instructions and data in little endian format least significant byte of a word at lowest byte address With endianness big the assembler generates object files in big endian format most significant byte of a word at lowest byte address B is an alias for option endianness big The endianness is reflected in the list file Assembly code can check the setting of this option by means of the built in assembly function BIGENDIAN Related information db Assembly function BIGENDIAN 5 62 Tool Options Assembler Assembler error file Menu entry Command line only Command line syntax error file file Description With this option the assembler redirects error messages to a file If you do not specify a filename the error file will be named after the input file with extension ers Example To write errors to errors err instead of stderr enter asarm error file errors err test src Related information ie 5 63 ARM Embedded Tools Reference Assembler error limit Menu entry 1 From the Project menu select Projec
229. ions A vector table defines symbols _1c_ub_ fooand_1c_ue_foo pointing to start and end of the table vector table vtable vector _size m size n run_addr x See the following example of a vector table definition vector table vtable vector_size 4 size 256 run_addr 0 template text vector template template _symbol _lc vector_target vector prefix _vector_ id_symbol_prefix foo no_inline default empty or fill foo or fill 1 2 3 4 or i1l1 loop vector id 0 fill _ START vector id 12 fill 0Oxab 0x21 0x32 0x43 vector id 1 11 fill 0 vector id 18 23 fill loop The template argument defines the name of the section that holds the code to jump to a handler function from the vector table This template section does not get located and is removed when the locate phase is completed This argument is required The template_symbol argument is the symbol reference in the template section that must be replaced by the address of the handler function This symbol name should start with the linker prefix for the symbol to be ignored in the link phase This argument is required The vector_prefix argument defines the names of vector sections the section for a vector with id vector_id is vector_prefix vector_id Vectors defined in C or assembly source files that should be included in the vector table must have the correct symbol name The compiler uses
230. ions C Compiler C Compiler make target Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option make target to the Additional C compiler options field Command line syntax make target name Description With this option you can overrule the default target name in the make dependencies generated by the options preprocess make Em and dep file The default target name is the basename of the input file with extension obj Related information C compiler option preprocess make Generate dependencies for make C compiler option dep file Generate dependencies in a file 5 25 ARM Embedded Tools Reference C Compiler mil mil split Menu entry Command line only Command line syntax mil mil split file Description With option mil the C compiler skips the code generator phase and writes the optimized intermediate representation MIL to a file with the suffix mil The C compiler accepts mil files as input files on the command line Option mil split does the same as option mil but in addition the C compiler splits the MIL representation and writes it to separate files with suffix ms One file is written for each input file or MIL library specified on the command line The ms files are only updated on a change The C compiler accepts ms files as inpu
231. iple times Format of an option file Multiple arguments on one line in the option file are allowed To include whitespace in an argument surround the argument with single or double quotes If you want to use single quotes as part of the argument surround the argument by double quotes and vise versa This has a single quote embedded This has a double quote embedded This has a double quote and a single quote embedded When a text line reaches its length limit use a to continue the line Whitespace between quotes is preserved This is a continuation line gt This is a continuation line It is possible to nest command line files up to 25 levels Example Suppose the file myoptions contains the following lines k err errors txt test abs Specify the option file to the make utility tmk m myoptions This is equivalent to the following command line tmk k err errors txt test abs Related information de 5 182 Tool Options Make Utility Make Utility n Command line syntax n Description With this option you tell the make utility to perform a dry run The make utility shows what it would do but does not actually perform these tasks This option is for example useful to quickly inspect what would happen if you call the make utility Example tmk n The make utility does not perform any tasks but displays what it would do if called without the option
232. ith this option you tell the make utility to use the specified file instead of the file makefile Multiple f options act as if all the makefiles were concatenated in a left to right order Example tmk f mymake The make utility uses the file mymake to build your files Related information J 5 177 ARM Embedded Tools Reference Make Utility G Command line syntax G path Description Normally you must call the make utility tmk from the directory where your makefile and other files are stored With the option G you can call the make utility from within another directory The path is the path to the directory where your makefile and other files are stored and can be absolute or relative to your current directory Example Suppose your makefile and other files are stored in the directory myfiles You can call the make utility for example as follows tmk G myfiles Related information J 5 178 Tool Options Make Utility Make Utility i Command line syntax i Description When an error occurs during the make process the make utility exits with a certain exit code With the option i the make utility exits without an error code even when errors occurred Example tmk i The make utility exits without an error code even when an error occurs Related information J 5 179 ARM Embedded Tools Reference Make Utility K Command line syntax K Description With this optio
233. ive you define a substitution string that you can use on all following source lines The assembler searches all succeeding lines for an occurrence of symbol and replaces it with string If the symbol occurs in a double quoted string it is also replaced Strings between single quotes are not expanded This directive is useful for providing better documentation in the source program A symbol can consist of letters digits and underscore characters _ and the first character cannot be a digit The assembler issues a warning if you redefine an existing symbol Example Suppose you defined the symbol LEN with the substitution string 32 DEFINE LEN 32 Then you can use the symbol LEN for example as follows DS LEN MESSAGE I The length is LEN The assembler preprocessor replaces LEN with 32 and assembles the following lines DS 32 MESSAGE I The length is 32 Related information UNDEF Undefine a DEFINE symbol or macro MACRO ENDM Define a macro Assembly Language DH Syntax label DH argument argument Description With the DH directive Define Half Word you allocate and initialize a half word of memory for each argument A half word is 16 bits An argument is e asingle or multiple character string constant e an expression e NULL indicated by two adjacent commas If you specify label it gets the value of the location counter at the start of the directive processin
234. ject Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Enter one or more command line options in the Additional C compiler options field Invocation syntax on the command line Windows Command Prompt To call the compiler from the command line use the following syntax carm option file The input file must be a C source file c or ic 5 1 ARM Embedded Tools Reference Short and long option names Options can have both short and long names Short option names always begin with a single minus character long option names always begin with double minus characters You can abbreviate long option names as long as the name is unique You can mix short and long option names on the command line Options can have flags or sub options To switch a flag on use a lowercase letter or a ongflag To switch a flag off use an uppercase letter or a ongflag Separate longflags with commas The following two invocations are equivalent carm Oac test c carm optimize coalesce cse test c When you do not specify an option a default value may become active 5 2 Tool Options C Compiler C Compiler align composites Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Code Generation 3 Select the Alignment of composite types Natural alignmen
235. ject file There are six different types of records e Data Record 8 16 or 32 bit formats e End of File Record 8 16 or 32 bit formats e Extended Segment Address Record 16 or 32 bit formats e Start Segment Address Record 16 or 32 bit formats e Extended Linear Address Record 32 bit format only e Start Linear Address Record 32 bit format only By default the linker generates records in the 32 bit format 4 byte addresses General Record Format In the output file the record format is length offset type content Ea Where is the record header length is the record length which specifies the number of bytes of the content field This value occupies one byte two hexadecimal digits The linker outputs records of 255 bytes 32 hexadecimal digits or less that is ength is never greater than FFH offset is the starting load offset specifying an absolute address in memory where the data is to be located when loaded by a tool This field is two bytes long This field is only used for Data Records In other records this field is coded as four ASCII zero characters 0000 type is the record type This value occupies one byte two hexadecimal digits The record types are Byte Type Record type 00 Data 01 End of File 02 Extended segment address not used 03 Start segment address not used 04 Extended linear address 32 bit 05 Start linear address 32 bit content is the information co
236. l code Itpool DOUBLE expr MOV32 ARM and Thumb 2 generic Load an address or a 32 bit constant value into a register Instruction Replacement Description MOV32cond Rd expr MOVWcond Rd LSH expr MOVTcond Rd MSH expr If expr is internal and absolute MOVWcond Rd expr MOVTcond Rad expr If expr is external or relocatable ARM and Thumb 2 generic DPR inversions for immediate operands For data processing instructions DPR which operate on an immediate operand the operand value must be encoded as an 8 bit value plus a 4 bit even rotation value If a value does not fit in such an encoding it could be possible that the negated value value or the bitwise negated value va ue does fit in such an encoding In that case the assembler will replcace the DPR instruction by its inverse DPR instruction operating on the negated value Instruction Replacement if imm or imm can be encoded ADDcond Rd Rn imm32 SUBcond Rd ARn imm32 ADDcondS Rd Rn imm32 SUBcondS Rd Rn imm32 ADDWcond Rd Rn imm12 SUBWcond RAd Rn imm12 SUBcond Rd Rn imm32 ADDcond Rd Rn imm32 SUBcondS Rd Rn imm32 ADDcondS Rd Rn imm32 SUBWcond Rd Rn imm12 ADDWcond Rd Rn imm12 ADCcond Rd Rn imm32 SBCcond Rd Rn imm32 ADCcondS Rd ARn imm32 SBCcondS Rd Rn imm32 SBCcond Rd Rn imm32 ADCcond Rd Rn imm32 SBCcondS Rd
237. l application compile your C files without debug information When you specify a high optimization level debug comfort may decrease Therefore the compiler issues a warning if the chosen optimizations expect to affect ease of debugging call frame information With this suboption only call frame information is generated This enables you to inspect parameters of nested functions all debug information With this information extra debug information is generated In extra ordinary cases you may use this debug information for instance if you use your own debugger which makes use of this information With this suboption the resulting assembler object file increases significantly Related information J 5 7 ARM Embedded Tools Reference C Compiler define D Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Preprocessing 3 Select User macro and click on the down arrow in the right pane to expand macro input 4 Click on an empty Macro field and enter a macro name Then click an empty cell to confirm 5 Optionally click in the Value field and enter a definition Then click an empty cell to confirm Command line syntax define macro_name macro_definition Dmacro_name macro_definition Description With this option you can define a macro and specify it to the preprocessor If you only specify a macro name no macro d
238. l the linker will generate an error It is recommended to use the near addressing mode unless your application needs calls to addresses that fall outside a 256 MB region 5 4 Tool Options C Compiler C Compiler check Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option check to the Additional C compiler options field Command line syntax check Description With this option you can check the source code for syntax errors without generating code This saves time in developing your application because the code will not actually be compiled The compiler reports any warnings and or errors Related information d gt Assembler option check Check syntax 5 5 ARM Embedded Tools Reference C Compiler cpu C Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Processor entry and select Processor Definition 3 Select a processor from the Select processor box Command line syntax cpu ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M xS C ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M XS Description With this option you specify the ARM architecture for which you create your application The ARM target supports more than one architecture and therefore you need to specify for which architecture the compiler sho
239. lay sections this happens at program start up The start addresses cannot be set to absolute values for unrestricted groups For non overlay groups that do not have an overlay parent the load time start address equals the run time start address For any group if the run time start address is not set the linker selects an appropriate address If an ordered group or sequential group has an absolute address and contains sections that have separate page restrictions not defined in LSL all those sections are located in a single page In other cases for example when an unrestricted group has an address range assigned to it the paged sections may be located in different pages For overlays the linker reserves memory at the run time start address as large as the largest element in the overlay group The page keyword tells the linker to place the group in one page Instead of specifying a run time address you can specify a page and optional a page number Page numbers start from zero If you omit the page number the linker chooses a page The page keyword refers to pages in the address space as defined in the architecture definition With the page_size keyword you can override the page alignment and size set on the address space When you set the page size to zero the linker removes simple auto generated page restrictions from the selected sections See also the page_size keyword in section 8 5 3 Defining Address Spaces group page
240. le architecture name definitions If you are defining multiple core architectures that show great resemblance you can define the common features in a parent core architecture and extend this with a child core architecture that contains specific features The child inherits all features of the parent With the keyword extends you create a child core architecture architecture name_child_arch extends name_parent_arch definitions A core architecture can have any number of parameters These are identifiers which get values assigned on instantiation or extension of the architecture You can use them in any expression within the core architecture Parameters can have default values which are used when the core architecture is instantiated with less arguments than there are parameters defined for it When you extend a core architecture you can pass arguments to the parent architecture Arguments are expressions that set the value of the parameters of the sub architecture architecture name_child_arch parml1 parm2 1 extends name_parent_arch arguments definitions 8 5 2 Defining Internal Buses With the bus keyword you define a bus the combination of data and corresponding address bus The bus name is used to identify a bus and does not conflict with other identifiers Bus descriptions in an architecture definition or derivative definition define internal buses Some internal buses are used to communicate with the compon
241. library Description With this option you define the kind of FPU support with which you create your application Related information J 5 14 Tool Options C Compiler C Compiler help Menu entry Command line only Command line syntax help item You can specify the following arguments intrinsics i Show the list of intrinsic functions options 0 Show extended option descriptions pragmas p Show the list of supported pragmas typedefs t Show the list of predefined typedefs Description Displays an overview of all command line options With an argument you can specify which extended information is shown Example The following invocations all display a list of the available command line options carm carm help carm The following invocation displays a list of the available pragmas carm help pragmas 5 15 ARM Embedded Tools Reference C Compiler include directory l Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Select Build Options 3 Add a pathname in the Include files path field If you enter multiple paths separate them with a semicolon Command line syntax include directory path lpath Description With this option you can specify the path where your include files are located A relative path will be relative to the current directory The order in which the compiler sear
242. ls Reference Linker non romable Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option non romable to the Additional linker options field Command line syntax non romable Description With this option the linker will locate all ROM sections in RAM A copy table is generated and is located in RAM When the application is started that data and BSS sections are re initialized Related information de 5 114 Tool Options Linker Linker no rescan Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Libraries 3 Disable the option Rescan libraries to solve unresolved externals Command line syntax no rescan Description When the linker processes a library it searches for symbol definitions that are referenced by the objects and libraries processed so far If the library contains a definition for an unresolved reference the linker extracts the object that contains the definition from the library The linker processes object files and libraries in the order in which they appear on the command line When all objects and libraries are processed the linker checks if there are unresolved symbols left If so the default behavior of the linker is to rescan all libraries in the order given at the command li
243. m the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option extern to the Additional linker options field Command line syntax extern symbol e symbol Description With this option you force the linker to consider the given symbol as an undefined reference The linker tries to resolve this symbol either the symbol is defined in an object file or the linker extracts the corresponding symbol definition from a library This option is for example useful if the startup code is part of a library Because your own application does not refer to the startup code you can force the startup code to be extracted by specifying the symbol START as an unresolved external Example Consider the following invocation lkarm mylib 1lib Nothing is linked and no output file will be produced because there are no unresolved symbols when the linker searches through mylib lib lkarm extern _START mylib lib In this case the linker searches for the symbol _START in the library and if found extracts the object that contains _START the startup code If this module contains new unresolved symbols the linker looks again in mylib lib This process repeats until no new unresolved symbols are found Related information Gb Section 5 4 Linking with Libraries in chapter Using the Linker of the user s manual 5 97 ARM Embedded Tools Reference
244. m_list amp constraint_char C_expression input_param_list constraint_char C_expression amp Says that an output operand is written to before the inputs are read so this output must not be the same register as any input constraint _char Constraint character the type of register to be used for the C_expression C_expression Any C expression For output parameters it must be an value that is something that is legal to have on the left side of an assignment register_save_list register_name register_name q Name of the register you want to reserve char a b int result void main void a 3 b 4 __asm ADD 0 1 2 r result r a r b 0 corresponds with the first C variable 1 with the second and so on C Language Generated assembly code main type func ldr rl1 L2 mov r0 3 strb r0 rl 0 mov r2 4 strb r2 r1 1 ADD r0 r0 r2 str ro r1 4 bx lr size main main align 4 L2 dw a Specifying registers for C variables With a constraint character you specify the register type for a parameter In the example above the r is used to force the use of registers Rn for the parameters a and b You can reserve the registers that are already used in the assembly instructions either in the parameter lists or in the reserved register list register_save_list also called clobber list The compiler takes account of these list
245. mat Section 7 3 Intel Hex Record Format in Chapter Object File Formats 5 90 Tool Options Linker Linker cpu C Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Processor entry and select Processor Definition 3 Select a processor from the Select processor box Command line syntax cpu ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M xS C ARMv4 ARMv4T ARMv5T ARMv5TE ARMv6M ARMv7M XS Description With this option you specify the ARM architecture for which you create your application The linker uses the architecture to determine which libraries must be linked and what kind of veneers to generate If the architecture is ARMv4 the linker will replace BX instructions in ARMv4T code by MOV PC instructions If the architecture is ARMv5T ARMv5TE or XScale the linker will replace unconditional BL instructions by BLX instructions if the branch target requires a state change between ARM and Thumb ot vice versa The default architecture is ARMv4T and the complete list of supported architectures is ARMv4 ARMV4T ARMv5T ARMv5TE ARMV6 M ARMv7 M XScale Architecture ARMv4 does not support the Thumb instruction set Architecture ARMv7 M only supports the Thumb 2 instruction set Related information J 5 91 ARM Embedded Tools Reference Linker define D Menu entry 1 From the Project menu select Project Options The Project Options dialog
246. may be possible that one of the sections in the overlay group already has been defined in another group where it received a load time address In this case the linker does not overrule this load time address and excludes the section from the overlay group Linker Script Language 3 Restrict the possible addresses for the sections in a group The load time address specifies where the group s elements are loaded in memory at download time The run time address specifies where sections are located at run time that is when the program is executing If you do not explicitly restrict the address in the LSL file the linker assigns addresses to the sections based on the restrictions relative to other sections in the LSL file and section alignments The program is responsible for copying overlay sections at appropriate moment from its load time location to its run time location this is typically done by the startup code The run_addr keyword defines the run time address If the run time location of a group is set explicitly the given order between groups specify whether the run time address propagates to the parent group or not The location of the sections a group can be restricted either to a single absolute address or to a number of address ranges With an expression you can specify that the group should be located at the absolute address specified by the expression group run_addr 0xa00f0000 You can use the offset variant to locate the
247. mbled Example MESSAGE I Generating tables ID EQU 4 MESSAGE E The value of ID is ID DEFINE LONG SHORT MESSAGE I This is a LONG string MESSAGE I This is a LONG string Within single quotes the defined symbol LONG is not expanded Within double quotes the symbol LONG is expanded so the actual message is printed as This is a LONG string This is a SHORT string 3 34 Assembly Language OFFSET Syntax OFFSET expression Description With the OFFSET directive you tell the assembler to give the location counter a new offset relative to the start of the section When the assembler encounters the OFFSET directive it moves the location counter forwards to the specified address relative to the start of the section and places the next instruction on that address If you specify an address equal to or lower than the current position of the location counter the assembler issues an error Example SECTION text nop nop nop OFFSET 0x20 nop SECTION text nop nop nop OFFSET 0x02 nop the assembler places this instruction at address 0x20 relative to the start of the section WRONG the current position of the location counter is 0x0C 3 35 ARM Embedded Tools Reference PAGE Syntax PAGE width length blanktop blankbim blankleft Description If you generate a list file see assembler option list file you can use the PAGE directive
248. mbler Assembler case insensitive c Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Disable the option Assemble case sensitive Command line syntax case insensitive C Description With this option you tell the assembler not to distinguish between upper and lower case characters By default the assembler considers upper and lower case characters as different characters AN Disabling the option Assemble case sensitive in Altium Designer is the same as specifying the option case insensitive on the command line Assembly source files that are generated by the compiler must always be assembled case sensitive When you are writing your own assembly code you may want to specify the case insensitive mode Example When assembling case insensitive the label Labe1Name is the same label as labelname Related information de 5 55 ARM Embedded Tools Reference Assembler check Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Add the option check to the Additional assembler options field Command line syntax check Description With this option you can check the source code for syntax errors without generating code This saves time in developing your application The assembler
249. members are marked __ unaligned For example the following two declarations are the same struct _ packed __ char c int i sl struct _ unaligned char c _ unaligned int i 52 The attribute __packed__ has the same effect as adding the type qualifier unaligned to the declaration to suppress the standard alignment You can also use _ packed ___ina pointer declaration In that case it affects the alignment of the pointer itself not the value of the pointer The following two declarations are the same int _ unaligned p int p _ packed_ Change alignment With the attribute __align n you can overrule the default alignment of objects or structure members to n bytes 1 3 Placing an Object at an Absolute Address _at With the attribute __at you can specify an absolute address Examples unsigned char Display 80 24 _at 0x2000 The array Display is placed at address 0x2000 In the generated assembly an absolute section is created On this position space is reserved for the variable Display int i _ at 0x1000 1 The variable i is placed at address 0x1000 and is initialized at 1 void f void _at Oxf0ff 1 The function f is placed at address Oxf100 Restrictions Take note of the following restrictions if you place a variable at an absolute address e The argument ofthe at attribute must be a constant address expression ARM Embedded Tools Reference e You can place only gl
250. mented lgamma lgammal lgammaf lgamma Computes the loge I x Not implemented tgamma tgammal tgammaf tgamma Computes T x Not implemented Comparison macros The next are implemented as macros For any ordered pair of numeric values exactly one of the relationships less greater and equal is true These macros are type generic and therefor do not have a parallel function in tgmath h All arguments must be expressions of real floating type math h tgmath h Description isgreater Returns the value of x gt y isgreaterequal Returns the value of x gt y isless Returns the value of x lt y islessequal Returns the value of x lt y islessgreater Returns the value of x lt y x gt y isunordered Returns 1 if its arguments are unordered O otherwise Classification macros The next are implemented as macros These macros are type generic and therefor do not have a parallel function in tgmath h All arguments must be expressions of real floating type math h tgmath h Description fpclassify Returns the class of its argument FP_INFINITE FP_NAN FP_NORMAL FP_SUBNORMAL or FP_ZERO isfinite Returns a nonzero value if and only if its argument has a finite value isinf Returns a nonzero value if and only if its argument has an infinit value isnan Returns a nonzero value if and only if its argument has NaN value isnormal Returns a nonzero value if an only if its argument has a no
251. mple tlb t mylib lib The librarian prints a list of all object modules in the libary mylib lib tlb t s0 mylib lib The librarian prints per object all symbols in the library This looks like prolog obj symbols mylib lib prolog obj Qabi_callee_save mylib lib prolog obj Qabi_callee restore divl16 obj symbols mylib lib divl6 obj udivl6 mylib lib divl6 obj divl6 mylib lib divl6 obj _urem16 mylib lib divl6 obj rem16 Related information J 5 202 Tool Options Librarian Librarian V Command line syntax V Description Display version information The librarian ignores all other options or input files Example tlb V The librarian displays version information but does not perform any tasks Related information i 5 203 ARM Embedded Tools Reference Librarian w Command line syntax wievel Description With this suboption you tell the librarian to suppress all warnings above the specified level The level is a number between 0 9 The level of a message is printed between parentheses after the warning number If you do not use the w option the default warning level is 8 Example To suppresses warnings above level 5 tlb x w5 mylib lib objl obj Related information i 5 204 Tool Options Librarian Librarian x Command line syntax x 0 v Description Extract an existing module from the library 0 Give the extracted object module the same dat
252. n set Searches for a substring sub in s Returns a pointer to the first occurence of sub in s A sequence of calls to this function breaks the string s into a sequence of tokens delimited by a character specified in delim The token found in s is terminated with a null character The function returns a pointer to the first position in s of the token Description memset s c n strerror errno strlen s wmemset s cC N weslen s 2 2 25 time h and wehar h The header file time h provides facilities to retrieve and use the calendar date and time and the process time Time can be represented as an integer value or can be broken down in components Two arithmetic data types are defined which are capable of holding the integer representation of times clock_t time _t 2 20 unsigned long long unsigned long Fills the first n bytes of s with character c and returns s Typically the values for errno come from int errno This function re turns a pointer to the associated error message See also section 2 2 5 errno h Returns the length of string s Libraries The type struct tm below is defined according to ISO IEC9899 with one exception this implementation does not support leap seconds The struct tm type is defines as follows struct tm int tm_sec int tm_min int tm_hour int tm_mday int tm_mon int tm_year int tm_wday int tm_yday int tm_isdst he Time manipulation
253. n z Z Define expansions Default LdEGiIMnPqrsVwXyZ Description With this option you specify which information you want to include in the list file On the command line you must use this option in combination with the option list file I Related information d gt Assembler option list file Generate list file Assembler option section info list Display section information in list file 5 71 ARM Embedded Tools Reference Assembler no warnings w Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Diagnostics 3 Enable one of the options e Report all warnings e Suppress all warnings e Suppress specific warnings If you select Suppress specific warnings 4 Enter the numbers separated by commas of the warnings you want to suppress Command line syntax no warnings number w number Description With this option you can suppresses all warning messages or specific warning messages e If you do not specify this option all warnings are reported e If you specify this option but without numbers all warnings are suppressed e If you specify this option with a number only the specified warning is suppressed You can specify the option no warnings number multiple times Example To suppress warnings 135 and 136 enter 135 136 in the Specific warnings to suppress field or enter the f
254. n of the heap area The size of the heap is defined in the linker script file arm 1s1 in directory include 1s1 with the macro __ HEAP which results in a section called heap The linker defined labels _1lc_ub_heap and_1c_ue_heap begin and end of heap are used by the library function sbrk which is called by malloc when memory is needed from the heap Define Description __HEAP Size of heap __HEAP FIXED Defined if you do not expand the heap if space is left __HEAPADDR Heap start address Table 4 6 Heap macros used in arm lsl 4 6 Altium 5 Tool Options Summary This chapter provides a detailed description of the options for the compiler assembler linker control program make program and the librarian 5 1 C Compiler Options Altium Designer uses a makefile to build your entire project This means that in Altium Designer you cannot run the compiler separately If you compile a single C source file from within Altium Designer the file is also assembled However you can set options specific for the compiler Options in Altium Designer versus options on the command line Most command line options have an equivalent option in Altium Designer but some options are only available on the command line for example in a Windows Command Prompt If there is no equivalent option in Altium Designer you can specify a command line option in Altium Designer as follows 1 From the Project menu select Pro
255. n the make utility keeps temporary files it creates during the make process The make utility stores temporary files in the directory that you have specified with the environment variable TMPDIR or in the default temp directory of your system when the TMPDIR environment variable is not specified Example tmk K The make utility preserves all temporary files Related information J 5 180 Tool Options Make Utility Make Utility k Command line syntax k Description When during the make process the make utility encounters an error it stops rebuilding your files With the option k the make utility only stops building the target that produced the error All other targets defined in the makefile are built Example tmk k If the make utility encounters an error it stops building the current target but proceeds with the other targets that are defined in the makefile Related information db Make utility option S Undo the effect of k 5 181 ARM Embedded Tools Reference Make Utility m Command line syntax m file Description Instead of typing all options on the command line you can create an option file which contains all options and flags you want to specify With this option you specify the option file to the make utility Use an option file when the command line would exceed the limits of the operating system or just to store options and save typing You can specify the option m mult
256. nclude symbolic debug information in the resulting output file Related information d 5 121 ARM Embedded Tools Reference Linker user provided initialization code i Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option user provided initialization code to the Additional linker options field Command line syntax user provided initialization code i Description It is possible to use your own initialization code for example to save ROM space With this option you tell the linker not to generate a copy table for initialize clear sections Use linker labels in your source code to access the positions of the sections when located If the linker detects references to the TASKING initialization code an error is emitted it is either the TASKING initialization routine or your own not both Note that the options no rom copy and non romable may vary independently The copytable compression optimization optimize t is automatically disabled when you enable this option Related information i 5 122 Tool Options Linker Linker verbose v extra verbose vv Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option verbose or extra verbo
257. nd line syntax error file Description With this option the control program tells the compiler assembler and linker to redirect error messages to a file The error file will be named after the input file with extension err for compiler or ers for assembler For the linker the error file is Lkarm elk Example To write errors to error files instead of stderr enter ccarm error file t test c Related information d Control Program option warnings as errors Treat warnings as errors 5 136 Tool Options Control Program Control Program format Command line syntax format format You can specify the following formats IEEE IEEE 695 ELF ELF DWARF IHEX Intel Hex SREC Motorola S records Description With this option you specify the output format for the resulting absolute object file The default output format is ELF DWARF which can directly be used by the debugger If you choose IHEX or SREC you can additionally specify the address size of the chosen format option address size Example To generate an Motorola S record output file ccarm format SREC testl c test2 c output test sre Related information db Control program option address size Set address size for linker IHEX SREC files Linker option output Specify an output object file Linker option chip output Generate hex file for each chip 5 137 ARM Embedded Tools Reference Control Program fp trap C
258. nditional assembly Macro Description __ASARM __ Expands to 1 for the ARM toolset otherwise unrecognized as macro _ BUILD __ Identifies the build number of the assembler composed of decimal digits for the build number three digits for the major branch number and three digits for the minor branch number For example if you use build 1 22 1 of the compiler _BUILD__ expands to 1022001 If there is no branch number the branch digits expand to zero For example build 127 results in 127000000 __ REVISION __ Identifies the revision number of the assembler For example if you use version 1 0r2 of the compiler _ REVISION _ expands to 2 __ TASKING _ Identifies the assembler as a TASKING assembler Expands to 1 if a TASKING compiler is used __VERSION__ Identifies the version number of the assembler For example if you use version 1 0r2 of the assembler _VERSION__ expands to 1000 dot and revision number are omitted minor version number in 3 digits Table 3 1 Assembler predefined preprocessor symbols 3 5 Registers The following register names either upper or lower case should not be used for user defined symbol names in an assembly language source file ARM registers RO R15 IP alias for R12 SP alias for R13 LR alias for R14 PC alias for R15 3 6 Assembly Expressions An expression is a combination of symbols constants operators and parentheses which represent a value that is used a
259. ne The linker stops rescanning the libraries when all symbols are resolved or when the linker could not resolve any symbol s during the rescan of all libraries Notice that resolving one symbol may introduce new unresolved symbols With this option you tell the linker to scan the object files and libraries only once When the linker has not resolved all symbols after the first scan it reports which symbols are still unresolved This option is useful if you are building your own libraries The libraries are most efficiently organized if the linker needs only one pass to resolve all symbols Related information d gt Linker option first library first Scan libraries in given order 5 115 ARM Embedded Tools Reference Linker no rom copy N Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option no rom copy to the Additional linker options field Command line syntax no rom copy N Description With this option the linker will not generate a ROM copy for data sections A copy table is generated and contains entries to clear BSS section However no entries to copy data sections from ROM to RAM are placed in the copy table The data sections are initialized when the application is downloaded The data sections are not re initialized when the application is restarted Related information i
260. ne true 1 define false 0 define bool true false are defined 1 2 2 20 stddef h This header file defines the types for common use ptrdiff_t signed integer type of the result of subtracting two pointers size_t unsigned integral type of the result of the sizeof operator wchar_t integer type to represent character codes in large character sets Besides these types the following macros are defined 2 11 ARM Embedded Tools Reference NULL expands to the null pointer constant offsetof _type _member expands to an integer constant expression with type size_t that is the offset in bytes of 2 2 21 stdint h _member within structure type type db See section 2 2 9 inttypes h and stdint h 2 2 22 stdio h and wchar h Types The header file stdio h contains functions for performing input and output A number of functions also have a parallel wide character function or macro defined in wchar h The header file wchar h also includes stdio h In the C language many O facilities are based on the concept of streams The stdio h header file defines the data type FILE which holds the information about a stream An FILE object is created with the function fopen The pointer to this object is used as an argument in many of the in this header file The FILE object can contain the following information e the current position within the stream e pointers to any associated buffers e indications of for read write errors e
261. nged by you unless you also modify the core s hardware architecture If the LSL file describes a multi core system an architecture definition must be available for each different type of core d gt See section 8 5 Semantics of the Architecture Definition for detailed descriptions of LSL in the architecture definition The derivative definition The derivative definition describes the configuration of the internal on chip bus and memory system Basically it tells the linker how to convert offsets on the buses specified in the architecture definition into offsets in internal memory A derivative definition must be present in an LSL file Microcontrollers and DSPs often have internal memory and I O sub systems apart from one or more cores The design of such a chip is called a derivative When you design an FPGA together with a PCB the components on the FPGA become part of the board design and there is no need to distinguish between internal and external memory For this reason you probably do not need to work with derivative definitions at all There are however two situations where derivative definitions are useful 1 When you re use an FPGA design for several board designs it may be practical to write a derivative definition for the FPGA design and include it in the project LSL file 2 When you want to use multiple cores of the same type you must instantiate the cores in a derivative definition since the linker automatically instantiates
262. ngs are suppressed e If you specify this option with a number only the specified C compiler warning is suppressed You can specify the option no warnings number multiple times Related information ie 5 153 ARM Embedded Tools Reference Control Program option file f Command line syntax option file file f file Description Instead of typing all options on the command line you can create an option file which contains all options and flags you want to specify With this option you specify the option file to the control program Use an option file when the command line would exceed the limits of the operating system or just to store options and save typing You can specify the option option file multiple times Format of an option file Multiple arguments on one line in the option file are allowed To include whitespace in an argument surround the argument with single or double quotes If you want to use single quotes as part of the argument surround the argument by double quotes and vise versa This has a single quote embedded This has a double quote embedded This has a double quote and a single quote embedded When a text line reaches its length limit use a to continue the line Whitespace between quotes is preserved This is a continuation line gt This is a continuation line It is possible to nest command line files up to 25 levels Example
263. ngth The linker has an option that controls the length of the output buffer for generating S1 records The default buffer length is 32 code bytes The checksum calculation of S1 records is identical to SO S2 record With the linker option ofilename SREC 3 the actual program code and data is supplied with S2 records with the following layout S 2 lt length_byte gt lt address gt lt code bytes gt lt checksum_byte gt This record is used for 3 byte addresses Example S 213FF002000232222754E00754F04AF4FAE4E22BF _ checksum _ code _ address _ length The linker has an option that controls the length of the output buffer for generating S2 records The default buffer length is 32 code bytes 7 2 Object File Formats The checksum calculation of S2 records is identical to SO S3 record With the linker option ofilename SREC 4 which is the default the actual program code and data is supplied with S3 records with the following layout S 3 lt length_byte gt lt address gt lt code bytes gt lt checksum_byte gt The linker generates 4 byte addresses by default Example S3070000FFFE6E6825 _ checksum _ code _ address _ length The linker has an option that controls the length of the output buffer for generating S3 records The checksum calculation of S3 records is identical to SO S7 record With the linker option ofilename SREC 4 which is the defaul
264. nitialize count Later on you can assign other values to the symbol Related information d gt EQU Set a permanent value to a symbol 3 39 ARM Embedded Tools Reference SIZE Syntax SIZE symbol expression Description With the SIZE directive you set the size of the specified symbol to the value represented by expression The SIZE directive may occur anywhere in the source file unless the specified symbol is a function In this case the SIZE directive must occur after the function has been defined Example section text global main code32 align 4 Function main main type func 7 SIZE main main endsec Related information db TYPE Set Symbol Type 3 40 Assembly Language SOURCE Syntax SOURCE siring Description With the SOURCE directive you specify the name of the original C source module This directive is generated by the C compiler You do not need this directive in hand written assembly Example SOURCE test c Related information J 3 41 ARM Embedded Tools Reference TITLE Syntax TITLE title Description If you generate a list file see assembler option list file you can use the TITLE directive to specify the program title which is printed at the top of each page in the assembler list file If you use the TITLE directive without the argument the title becomes empty This is also the default The specified title is valid until th
265. not be defined redefined or undefined The names of standard library macros objects and functions shall not be reused The validity of values passed to library functions shall be checked Dynamic heap memory allocation shall not be used The error indicator errno shall not be used The macro offsetof in library lt stddef h gt shall not be used The setjmp macro and the long jmp function shall not be used The signal handling facilities of lt signal h gt shall not be used The input output library lt stdio h gt shall not be used in production code The library functions atof atoi and atol from library lt stdlib h gt shall not be used The library functions abort exit getenv and system from library lt stdlib h gt shall not be used The time handling functions of library lt time h gt shall not be used Minimization of run time failures shall be ensured by the use of at least one of a static analysis tools techniques b dynamic analysis tools techniques c explicit coding of checks to handle run time faults Index Index Symbols __align 1 2 __ARM_ 1 12 __ASARM_ 3 3 __asm syntax 1 4 __at 1 3 __BIG_ENDIAN __ 1 12 _ BUILD 1 12 3 3 __CARM_ 1 12 CPU 1 12 __CPU_arch_ 1 12 __DOUBLE_FP_ 1 12 __interrupt 1 18 __interrupt_dabt 1 18 __interrupt_fig 1 18 __interrupt_iabt 1 18 __interrupt_irg 1 18 __interrupt_svc 1 18 __interrupt_und 1 18 __LITTLE_ENDIAN__ 1 12 __nesting_enabled
266. not part of the group in these gaps To prevent this you can use the 111 keyword If the group is located in RAM the gaps are treated as reserved scratch space If the group is located in ROM the alignment gaps are filled with zeros by default You can however change the fill pattern by specifying a bit pattern The result of the expression or list of expressions is used as values to write to memory each in MAU The overlay keyword tells the linker to overlay the sections in the group The linker places all sections in the address space using a contiguous range of addresses Thus an overlay group is automatically also a contiguous group To overlay the sections all sections in the overlay group share the same run time address For each input section within the overlay the linker automatically defines two symbols The symbol _le_cb_section_name is defined as the load time start address of the section The symbol _1le_ce_section_name is defined as the load time end address of the section C or assembly code may be used to copy the overlaid sections If sections in the overlay group contain references between groups the linker reports an error The keyword allow_cross_references tells the linker to accept cross references Normally it does not make sense to have references between sections that are overlaid group ovl overlay group a select my_ovl_p1 select my_ovl_p2 group b select my_ovl_ql1 It
267. nsigned int or signed int bit fields of type signed int shall be at least 2 bits long Octal constants other than zero and octal escape sequences shall not be used Declarations and definitions 8 1 8 2 8 3 8 4 8 5 8 6 8 7 x 8 8 x 8 9 x 8 10 8 11 8 12 9 6 Functions shall have prototype declarations and the prototype shall be visible at both the function definition and call Whenever an object or function is declared or defined its type shall be explicitly stated For each function parameter the type given in the declaration and definition shall be identical and the return types shall also be identical If objects or functions are declared more than once their types shall be compatible There shall be no definitions of objects or functions in a header file Functions shall be declared at file scope Objects shall be defined at block scope if they are only accessed from within a single function An external object or function shall be declared in one and only one file An identifier with external linkage shall have exactly one external definition All declarations and definitions of objects or functions at file scope shall have internal linkage unless external linkage is required The static storage class specifier shall be used in definitions and declarations of objects and functions that have internal linkage When an array is declared with external linkage its size shall be stated explicitly or defined
268. nt derivative and extend this with a child derivative that contains specific features The child inherits all features of the parent cores and memories With the keyword extends you create a child derivative derivative name_child_deriv extends name_parent_deriv definitions As with a core architecture a derivative can have any number of parameters These are identifiers which get values assigned on instantiation or extension of the derivative You can use them in any expression within the derivative definition derivative name_child_deriv parml1 parm2 1 extends name_parent_derivh arguments definitions 8 6 2 Instantiating Core Architectures With the keyword core you instantiate a core architecture in a derivative 8 20 Linker Script Language With the keyword architecture you tell the linker that the given core has a certain architecture The architecture name refers to an existing architecture definition in the same LSL file For example if you have two cores called mycore_1 and mycore_2 that have the same architecture called mycorearch you must instantiate both cores as follows core mycore_1 architecture mycorearch core mycore 2 architecture mycorearch If the architecture definition has parameters you must specify the arguments that correspond with the parameters For example mycorearch1 expects two parameters which are used in the architecture definition core mycore
269. nt string 3 48 calling 3 46 conditional assembly 3 49 defining 3 46 local label override 3 49 make utility 5 169 return decimal value operator 3 48 return hex value operator 3 48 Macros preprocessor 1 12 3 3 Magnitude 2 3 Make utility options 5 170 a 5 171 c 5 172 D 5 173 d 5 174 DD 5 173 dd 5 174 5 175 err 5 176 f 5 177 G 5 178 i 5 179 K 5 180 k 5 181 m 5 182 5 187 n 5 183 p 5 184 q 5 185 r 5 186 s 5 188 t 5 189 time 5 190 V 5 191 W 5 192 x 5 193 defining a macro 5 169 malloc 2 7 2 18 Map file generation 5 111 Mappings 8 18 MB_CUR_MAX 2 17 2 23 MB_LEN_MAX 2 23 mblen 2 19 mbrlen 2 23 mbrtowc 2 23 mbsinit 2 23 mbsrtowcs 2 23 mbstate_t 2 23 mbstowcs 2 19 mbtowc 2 19 memchr 2 20 memcmp 2 20 memcpy 2 19 memmove 2 19 Memory definition 8 2 memset 2 20 Merging source code 5 44 message 1 9 3 34 MISRA C 5 27 5 28 MISRA C report 5 113 supported rules 1998 9 1 supported rules 2004 9 5 version 5 29 mktime 2 21 modf functions 2 8 Modulus 2 3 Motorola S record format 7 2 msb 3 7 msh 3 7 msw 3 8 N nan functions 2 9 nearbyint functions 2 8 nextafter functions 2 9 nexttoward functions 2 9 no_tbh_switch 1 10 Functions 1 14 intrinsic 1 16 parameter passing 1 14 return types 1 14 Norm 2 3 NULL 2 12 O offset 3 35 offsetof 2 12 open 2 5 Operands 3 2 Optimization 5 33 5 7
270. nt to memory earlier allocated by acallto__ alloc Same as library function free Returns nothing __nop void _nop void Generate NOP instructions Returns nothing Example __nop generate NOP instruction __get_return_address __codeptr volatile _ get_return_address void Used by the compiler for profiling wnen you compile with the profile p option Returns return address of a function __getspsr unsigned int volatile _ getspsr void Get the value of the SPSR status register Returns the value of the status register SPSR __setspsr unsigned int volatile _setspsr int set int clear Set or clear bits in the SPSR status register Returns the new value of the SPSR status register 1 16 C Language Example define SR_F 0x00000040 define SR_I 0x00000080 i _setspsr 0 SRF SRI if i amp SRF SR_I exit 6 Interrupt flags not correct if __getspsr amp SRF SR_I exit 7 Interrupt flags not correct __getcpsr unsigned int volatile _ getcpsr void Get the value of the CPSR status register Returns the value of the status register CPSR __setcpsr unsigned int volatile _setcpsr int set int clear Set or clear bits in the CPSR status register Returns the new value of the CPSR status register __getapsr unsigned int volatile _ getapsr void Get the value of the APSR status register Returns the value of the st
271. ntained in the record This depends on the record type checksum is the record checksum The linker computes the checksum by first adding the binary representation of the previous bytes from ength to content The linker then computes the result of sum modulo 256 and subtracts the remainder from 256 two s complement Therefore the sum of all bytes following the header is zero Extended Linear Address Record The Extended Linear Address Record specifies the two most significant bytes bits 16 31 of the absolute address of the first data byte in a subsequent Data Record 02 0000 upper_address checksum 7 5 ARM Embedded Tools Reference The 32 bit absolute address of a byte in a Data Record is calculated as address offset index modulo 4G where address is the base address where the two most significant bytes are the upper_address and the two least significant bytes are zero offset is the 16 bit offset from the Data Record index is the index of the data byte within the Data Record 0 for the first byte Example 0200000400FFFB _ checksum _ upper address _ type _ offset _ length Data Record The Data Record specifies the actual program code and data length offset 00 data checksum The length byte specifies the number of data bytes The linker has an option that controls the length of the output buffer for generating Data records The default buffer length is 32 bytes The off
272. nter with three or more levels of indirection is declared No relational operators between pointers to different objects In general checking whether two pointers point to the same object is impossible The compiler will only report a violation for a relational operation with incompatible pointer types Non constant pointers to functions shall not be used Functions assigned to the same pointer shall be of identical type Automatic address may not be assigned to a longer lived object The null pointer shall not be de referenced A violation is reported for every pointer dereference that is not guarded by a NULL pointer test All struct union members shall be fully specified Overlapping variable storage shall not be used A violation is reported for every union declaration Unions shall not be used to access the sub parts of larger types A violation is reported for a union containing a struct member bit fields shall have type unsigned int or signed int bit fields of type signed int shall be at least 2 bits long All struct union members shall be named Reserved and standard library names shall not be redefined Standard library function names shall not be reused Production libraries shall comply with the MISRA C restrictions The validity of library function parameters shall be checked Dynamic heap memory allocation shall not be used The error indicator errno shall not be used The macro offsetof shall n
273. ny iteration statement there shall be at most one break statement used for loop termination A function shall have a single point of exit at the end of the function The statement forming the body of a switch while do while or for statement be a compound statement An if expression construct shall be followed by a compound statement The else keyword shall be followed by either a compound statement or another if statement Allif else if constructs shall be terminated with an else clause Switch statements 15 1 15 2 15 3 15 4 15 5 3333 2 A switch label shall only be used when the most closely enclosing compound statement is the body of a switch statement An unconditional break statement shall terminate every non empty switch clause The final clause of a switch statement shall be the default clause A switch expression shall not represent a value that is effectively Boolean Every switch statement shall have at least one case clause MISRA C Rules Functions 16 1 16 2 16 3 16 4 16 5 16 6 16 7 16 8 16 9 16 10 3 aoaaa a D D 2 gt 2 R R Functions shall not be defined with variable numbers of arguments Functions shall not call themselves either directly or indirectly A violation will be reported for direct or indirect recursive function calls in the source file being checked Recursion via functions in other source files or recursion via function pointers is not
274. o a reserved section With the keyword size you can specify a size for a given reserved area or section group reserved myreserved size 2k 8 30 Linker Script Language The optional 111 field contains a bit pattern that the linker writes to all memory addresses that remain unoccupied during the locate process The result of the expression or list of expressions is used as values to write to memory each in MAU The first MAU of the fill pattern is always the first MAU in the section By default no sections can overlap with a reserved section With alloc_allowed absolute sections that are located at an absolute address due to an absolute group restriction can overlap a reserved section With the attributes field you can set the access type of the reserved section The linker locates the reserved section in its space with the restrictions that follow from the used attributes r w or x or a valid combination of them The allowed attributes are shown in the following table A value between lt and gt in the table means this value is set automatically by the linker Properties set in LSL Resulting section properties attributes filled access memory content x yes lt rom gt executable r yes r lt rom gt data r no r lt rom gt scratch rx yes r lt rom gt executable rw yes rw lt ram gt data rw no rw lt ram gt scratch rwx yes rw lt ram gt executable group
275. o invocations are equivalent lkarm mfk test obj lkarm map file format files link test obj When you do not specify an option a default value may become active 5 88 Tool Options Linker Linker case insensitive Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Disable the option Link case sensitive Command line syntax case insensitive Description With this option you tell the linker not to distinguish between upper and lower case characters in symbols By default the linker considers upper and lower case characters as different characters Disabling the option Link case sensitive in Altium Designer is the same as specifying the option case insensitive on the command line Assembly source files that are generated by the compiler must always be assembled and thus linked case sensitive When you have written your own assembly code and specified to assemble it case insensitive you must also link the obj file case insensitive Related information ie 5 89 ARM Embedded Tools Reference Linker chip output c Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Output Format 3 Enable the options Intel HEX records and or Motorola S records Command line syntax chip output basenam
276. obal variables at absolute addresses Parameters of functions or automatic variables within functions cannot be placed at absolute addresses e A variable that is declared extern is not allocated by the compiler in the current module Hence it is not possible to use the keyword __at on an external variable Use __at at the definition of the variable e You cannot place structure members at an absolute address e Absolute variables cannot overlap each other If you declare two absolute variables at the same address the assembler and or linker issues an error The compiler does not check this 1 4 Using Assembly in the C Source _ asm With the __asm keyword you can use assembly instructions in the C source Be aware that C modules that contain assembly are not portable and harder to compile in other environments Furthermore assembly blocks are not interpreted by the compiler they are regarded as a black box So it is your responsibility to make sure that the assembly block is syntactically correct General syntax of the _ asm keyword __asm instruction_template output_param_list input_param_list register_save_list instruction_template Assembly instructions that may contain parameters from the input list or output list in the form parm_nr parm_nr regnum Parameter number in the rar ge 0 9 With the optional regnum you can g access an individual register from a register pair output_para
277. of all supported MISRA C rules C compiler option misrac 5 29 ARM Embedded Tools Reference C Compiler no double F Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Floating Point 3 Enable the option Use single precision floating point only Command line syntax no double F Description With this option you tell the compiler to treat variables of the type double as float Because the float type takes less space execution speed increases and code size decreases both at the cost of less precision Related information i 5 30 Tool Options C Compiler C Compiler no stdinc Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option no stdinc to the Additional C compiler options field Command line syntax no stdinc Description With this option you tell the compiler not to look in the default include directory relative to the installation directory when searching for include files This way the compiler only searches in the include file search paths you specified Related information d gt C compiler option include directory Add directory to include file search path 5 31 ARM Embedded Tools Reference C Compiler no warnings w Menu entry 1 From the Project menu
278. of elements succesfully written FSS implementation Description fseek stream offset origin Sets the position indicator for stream FSS implementation When repositioning a binary file the new position origin is given by the following macros SEEK_SET 0 SEEK_CUR 1 SEEK_END 2 offset characters from the beginning of the file offset characters from the current position in the file offset characters from the end of the file Libraries ftell stream rewind stream fgetpos stream pos fsetpos stream pos Operations on files stdio h Returns the current file position for stream or 1L on error FSS implementation Sets the file position indicator for the stream to the beginning of the file This function is equivalent to void fseek stream OL SEEK _SET clearerr stream FSS implementation Stores the current value of the file position indicator for stream in the object pointed to by pos FSS implementation Positions stream at the position recorded by getpos in pos FSS implementation Description remove file rename old new tmpfile tmpnam buffer Error handling stdio h Removes the named file so that a subsequent attempt to open it fails Returns a non zero value if not succesful Changes the name of the file from old name to new name Returns a non zero value if not succesful Creates a temporary file of the mode wb that will be automatically
279. of the columns for the source listing Source listing The following is a sample part of a listing An explanation of the different columns follows below ADDR CODE CYCLES LINE SOURCE LINE 1 Module start 16 ldr r0 L2 0000 O8009FE5 1 1 0004 001090E5 1 2 17 ldr r1 r0 0 0008 04009FE5 1 3 18 ldr r0 L2 4 000C rrrrrrEA 3 6 19 b printf 0000 38 ds 2 RESERVED 0001 The meaning of the different columns is ADDR This column contains the memory address The address is a hexadecimal number that represents the offset from the beginning of a relocatable section or the absolute address for an absolute section The address only appears on lines that generate object code 6 1 ARM Embedded Tools Reference CODE This is the object code generated by the assembler for this source line displayed in hexadecimal format The displayed code need not be the same as the generated code that is entered in the object module The code can also be relocatable code In this case the letter r is printed for the relocatable code part in the listing For lines that allocate space the code field contains the text RESERVED For lines that initialize a buffer the code field lists one value followed by the word REPEATS CYCLES The first number in this column is the number of instruction cycles needed to execute the instruction s as generated in the CODE field The second number is the accumulated cycle count of this section LINE This column
280. ogram has reached the end or that the library function exit has been called Macro Preprocessor Symbols A number of macro preprocessor symbols are used in the startup code These are enabled when you use a particular option or you can enable or disable them using the linker command line option define with the following syntax define symbol value In the startup file cstart asm the following macro preprocessor symbols are used Define Description PROF_ENABLE If defined initialize profiling __ POSIX __ If defined call posix_main instead of main Table 4 1 Defines used in cstart asm The following table shows the linker labels and other labels used in the startup code Define Description _ START Start label mentioned in LSL file arm Isl _Next Real program address main Start label user C program exit Start label of exit function _exit exit function returns to this place _lc_ub_stack User system mode stack pointer _lc_ue_stack End of stack symbol required by debugger _lc_ub_stack_und Undefined mode stack pointer _lc_ub_stack_svc Supervisor mode stack pointer _lc_ub_stack_abt Abort mode stack pointer _lc_ub_stack_irq IRQ mode stack pointer _lc_ub_stack_fiq FIQ mode stack pointer _lc_ub_table ROM to RAM copy table _APPLICATION MODE_ Contains the processor mode and the IRQ FIQ interrupts mode __init_hardware Start label of
281. olations The implementation defined behavior and packing of bit fields shall be documented if being relied upon All libraries used in production code shall be written to comply with the provisions of this document and shall have been subject to appropriate validation Only those escape sequences that are defined in the ISO C standard shall be used Trigraphs shall not be used 9 5 ARM Embedded Tools Reference Identifiers 5 1 5 2 5 3 5 4 x 5 5 5 6 x 5 7 Types 6 1 x 6 2 6 3 6 4 6 5 Constants 7 1 R R ZS R Identifiers internal and external shall not rely on the significance of more than 31 characters Identifiers in an inner scope shall not use the same name as an identifier in an outer scope and therefore hide that identifier A typedef name shall be a unique identifier A tag name shall be a unique identifier No object or function identifier with static storage duration should be reused No identifier in one name space should have the same spelling as an identifier in another name space with the exception of structure and union member names No identifier name should be reused The plain char type shall be used only for storage and use of character values signed and unsigned char type shall be used only for the storage and use of numeric values typedefs that indicate size and signedness should be used in place of the basic types bit fields shall only be defined to be of type u
282. ollowing on the command line asarm test srce no warnings 135 136 Related information db Assembler option warnings as errors Treat warnings as errors 5 72 Tool Options Assembler Assembler old syntax Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Disable the option UAL syntax mode Command line syntax old syntax Description In UAL syntax mode the assembler will not accept instructions which use the pre UAL syntax and will select encodings based on the UAL syntax in case both syntaxes are the same With this option you can change this default behavior The assembler will run in pre UAL mode The built in function PRE_UVAL will return true so you can use IF PRE UAL lt old code gt ELSE lt new code gt ENDIF Related information i 5 73 ARM Embedded Tools Reference Assembler optimize O Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Optimization 3 Enable or disable the optimization options e Generic instructions e Jump chains e Instruction size Command line syntax Oflags optimize flags You can set the following flags generics g G Allow generic instructions jumpchains j J Jump chains instr size s S Optimize instruct
283. ommand line syntax fp trap Description By default the control program uses one of the non trapping floating point libraries parm lib or fpthumb 1ib With this option you tell the control program to use the trapping floating point library fparmt lib or fpthumbt 1ib If you use the trapping floating point library exceptional floating point cases are intercepted and can be handled separately by an application defined exception handler Using this library decreases the execution speed of your application Related information db 5 138 Tool Options Control Program Control Program help Command line syntax help options Description Displays an overview of all command line options When you specify the argument options you can list detailed option descriptions Example The following invocations all display a list of the available command line options ccarm ccarm help ccarm To see a detailed description of the available options enter ccarm help options 5 139 ARM Embedded Tools Reference Control Program include directory l Command line syntax include directory path Ipath Description With this option you can specify the path where your include files are located A relative path will be relative to the current directory Example Suppose that the C source file test c contains the following lines include lt stdio h gt include myinc h You can
284. on in section 3 8 2 Assembler Directives in Chapter Assembly Language section_code_init section_no_code_init Copy or do not copy code sections from ROM to RAM at application startup section_const_init section_no_const_init Copy or do not copy read only data sections from ROM to RAM at application startup source nosource With these pragmas you can choose which C source lines must be listed as comments in assembly output d gt See also C compiler option source s stdinc This pragma changes the behavior of the include directive When set the C compiler options include directory and no stdince are ignored linear_switch jump_switch binary_switch smart_switch tbb_switch tbh_switch no_tbh_switch With these pragmas you can overrule the compiler chosen switch method linear_switch Force jump chain code A jump chain is comparable with an if else if else if else construction jump switch Force jump table code A jump table is a table filled with jump instructions for each possible switch value The switch argument is used as an index to jump within this table binary switch Force binary lookup table code A binary search table is a table filled with a value to compare the switch argument with and a target address to jump to smart_switch Let the compiler decide the switch method used C Language tbb_switch Force use of the tbb instruction Uses a table of 8 bit jump offsets tb
285. on By default the control program tells the linker to generate a linker map file A linker map file is a text file that shows how the linker has mapped the sections and symbols from the various object files obj to the linked object file A locate part shows the absolute position of each section External symbols are listed per space with their absolute address both sorted on symbol and sorted on address With this option you prevent the generation of a map file Related information i 5 151 ARM Embedded Tools Reference Control Program no preprocessing only Command line syntax no preprocessing only Description On the command line the control program stops after preprocessing If you also want to compile the C source you can specify the option no preprocessing only In this case the control program calls the compiler twice once with option preprocess and once for a regular compilation Example ccarm preprocess t comments make noline no preprocessing only test c Related information db Control program option preprocess E 5 152 Tool Options Control Program Control Program no warnings w Command line syntax no warnings number w number Description With this option you can suppress all warning messages or specific C compiler warning messages e If you do not specify this option all warnings are reported e If you specify this option but without numbers all warni
286. onding address locations are flled with zeros Word arguments are stored as is Floating point values are not allowed If the evaluated argument is too large to be represented in a word the assembler issues a warning and truncates the value In case of single and multiple character strings each ASCII value of the character is stored in successive locations starting at the most significant byte of a word The standard C escape sequences are allowed DW AB D gt 0x42410000 0x00000000 second argument is empty 0x44000000 Example TABLE DW 14 253 0x62 ABCD CHARS DW A B C D Related information d gt BS Block Storage DS Define Storage DB Define Byte DH Define Half Word DD_ Define Double Word 3 21 ARM Embedded Tools Reference END Syntax END Description With the END directive you tell the assembler that the end of the module is reached If the assembler finds assembly source lines beyond the END directive it ignores those lines and issues a warning Example section text source lines END End of assembly module 3 22 Assembly Language EQU Syntax symbol EQU expression Description With the EQU directive you assign the value of expression to symbol permanently Once defined you cannot redefine the symbol With the GLOBAL directive you can define the symbol global Example To assign the value 0x4000 permanently to the symbol MYSY
287. ons you must redirect the output With the suboption all the descriptions of all error messages are given If you want the description of one or more selected error messages you can specify the error message numbers separated by commas With this option the assembler does not assemble any files Example To display an explanation of message number 241 enter asarm diag 241 This results in the following message and explanation W241 additional input files will be ignored The assembler supports only a single input file All other input files are ignored To write an explanation of all errors and warnings in HTML format to file aserrors html use redirection and enter asarm diag html all gt aserrors html Related information J 5 60 Tool Options Assembler Assembler emit locals Menu entry Command line only Command line syntax emit locals flag you can set the following flags when you specify no flags the default is Es equs e E emit local EQU symbols symbols s S emit local non EQU symbols Description With the option emit locals equs the assembler also emits local EQU symbols to the object file Normally only global symbols and non EQU local symbols are emitted Having local symbols in the object file can be useful for debugging Related information i 5 61 ARM Embedded Tools Reference Assembler endianness Menu entry 1 From the Project menu select Project Opt
288. ontain one or more sets of input sections as well as other groups Per group you can assign a mutual order to the sets of sections and locate them into a specific memory part group group_specifications section_statements With the section_statements you generally select sets of sections to form the group This is described in subsection Selecting sections for a group Instead of selecting sections you can also modify special sections like stack and heap or create a reserved section This is described in section 8 9 3 Creating or Modifying Special Sections With the group_specifications you actually locate the sections in the group This is described in subsection Locating a group Selecting sections for a group With the select keyword you can select one or more sections for the group You can select a section by name or by attributes If you select a section by name you can use a wildcard pattern ane matches with all section names 2 matches with a single character in the section name N takes the next character literally abc matches with a single a b or c character a z matches with any single character in the range a to 2 group select mysection select The first select statement selects the section with the name mysection The second select statement selects all sections that were not selected yet A section is selected by the first
289. ot be used lt locale h gt and the setlocale function shall not be used The setjmp and longjmp functions shall not be used The signal handling facilities of lt signal h gt shall not be used The lt stdio h gt library shall not be used in production code The functions atof atoi atol shall not be used The functions abort exit getenv system shall not be used The time handling functions of library lt time h gt shall not be used Gls See also section 2 7 C Code Checking MISRA C in Chapter Using the Compiler of the User s manual 9 4 MISRA C Rules 9 2 MISRA C 2004 This section lists all supported and unsupported MISRA C 2004 rules d gt See also section 2 7 C Code Checking MISRA C in Chapter Using the Compiler of the User s Manual AN A number of MISRA C rules leave room for interpretation Other rules can only be checked in a limited way In such cases the implementation decisions and possible restrictions for these rules are listed x means that the rule is not supported by the TASKING C compiler R is a required rule A is an advisory rule Environment 1 1 R 1 2 R x13 R x14 R x15 A All code shall conform to ISO 9899 1990 Programming languages C amended and corrected by ISO IEC 9899 COR1 1995 ISO IEC 9899 AMD1 1995 and ISO IEC 9899 COR2 1996 No reliance shall be placed on undefined or unspecified behavior Multiple compilers and or languages shall only be used if
290. ot implemented Description Returns the real cube root of x x1 3 Not implemented Returns the absolute value of x x abs labs llabs div ldiv lldiv are defined in stdlib h Floating point multiply add Returns x y z Not implemented Returns the square root of x2 y2 Returns x raised to the power y xy Returns the non negative square root of x x 0 Manipulation functions copysign nan nextafter nexttoward Description nextafterl nextafterf nexttowardl nexttoward nexttowardf nexttoward Positive difference maximum minimum Returns the value of x with the sign of y Returns a quiet NaN if available with content indcated through tagp Not implemented Returns the next representable value in the specified format after x in the direction of y Returns y is x y Not implemented Same as nextafter except that the second argument in all three variants is of type long double Returns y if x y Not implemented Description Returns the positive difference between x y Not implemented Returns the maximum value of their arguments Not implemented Returns the minimum value of their arguments Not implemented 2 9 ARM Embedded Tools Reference Error and gamma Not implemented math h tgmath h Description erf erfl erff erf Computes the error function of x Not implemented erfc erfcl erfcf erc Computes the complementary error function of x Not imple
291. ot wrap around 52 R There shall be no unreachable code 53 R All non null statements shall have a side effect 54 R Anull statement shall only occur on a line by itself 55 A Labels should not be used 56 R The goto statement shall not be used 57 R The continue statement shall not be used 58 R The break statement shall not be used except in a switch 59 R An if or loop body shall always be enclosed in braces 60 A All if else if constructs should contain a final else 61 R Every non empty case clause shall be terminated with a break 62 R All switch statements should contain a final default case MISRA C Rules 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 ae ese 3 A A switch expression should not represent a Boolean case Every switch shall have at least one case Floating point variables shall not be used as loop counters A for should only contain expressions concerning loop control A violation is reported when the loop initialization or loop update expression modifies an object that is not referenced in the loop test Iterator variables should not be modified in a for loop Functions shall always be declared at file scope Functions with variable num
292. ou specified the keyword fixed group stack mystack size 2k The linker creates two labels to mark the begin and end of the stack lc_ub_stack_name for the begin of the stack and _1ce_ue_stack_name for the end of the stack The linker allocates space for the stack when there is a reference to either of the labels See also the stack keyword in section 8 5 3 Defining Address Spaces Heap e The keyword heap tells the linker to reserve a dynamic memory range for the malloc function Optionally you can assign a name to the heap section With the keyword size you can change the size for the heap If the size is not specified the linker uses the size given by the min_size argument as defined for the heap in the architecture definition Normally the linker automatically tries to maximize the size unless you specified the keyword fixed group heap myheap size 2k The linker creates two labels to mark the begin and end of the heap _lc_ub_heap_name for the begin of the heap and _1lc_ue_heap_name for the end of the heap The linker allocates space for the heap when a reference to either of the section labels exists in one of the input object files Reserved section e The keyword reserved tells the linker to create an area or section of a given size The linker will not locate any other sections in the memory occupied by a reserved section with some exceptions Optionally you can assign a name t
293. ow level functions This header file is not defined in ISO C99 _dbg_trap Returns a non zero value when c is in the range of 0 and 127 This function is not defined in ISO C99 _argev const char buf Converts c to an ASCII value strip highest bit size t size This function is not defined in ISO C99 2 2 5 errno h int errno External variable that holds implementation defined error codes The following error codes are defined as macros in errno h EPERM 1 Not owner ENOENT 2 No such file or directory EINTR 3 Interrupted system call EIO 4 I O error EBADF 5 Bad file number EAGAIN 6 No more processes ENOMEM 7 Not enough core EACCES 8 Permission denied EFAULT 9 Bad address EEXIST 10 File exists ENOTDIR 11 Not a directory EISDIR 12 Is a directory EINVAL 13 Invalid argument ENFILE 14 File table overflow EMFILE 15 Too many open files ETXTBSY 16 Text file busy ENOSPC 17 No space left on device ESPIPE 18 Illegal seek EROFS 19 Read only file system EPIPE 20 Broken pipe ELOOP 21 Too many levels of symbolic links ENAMETOOLONG 22 File name too long Floating point errors EDOM 23 Argument too large ERANGE 24 Result too large Errors returned by prinff scanf ERR_FORMAT 25 Illegal format string for printf scanf ERR_NOFLOAT 26 Floating point not supported ERR_NOLONG 27 Long not supported ERR_NOPOINT 28 Pointers not supported Encoding error stored in errno by functions like fgetwc getwc mbrtowc etc EILSEQ 29 Errors
294. ower and of the same signedness as the underlying type of the expression The value of a complex expression of floating type may only be cast to a narrower floating type If the bitwise operators and lt lt are applied to an operand of underlying type unsigned char or unsigned short the result shall be immediately cast to the underlying type of the operand A U suffix shall be applied to all constants of unsigned type Pointer type conversions 11 1 11 2 11 3 11 4 11 5 Expressions 12 1 12 2 12 3 12 4 12 5 12 6 12 7 R R DES A R 333 2 Conversions shall not be performed between a pointer to a function and any type other than an integral type Conversions shall not be performed between a pointer to object and any type other than an integral type another pointer to object type or a pointer to void A cast should not be performed between a pointer type and an integral type A cast should not be performed between a pointer to object type and a different pointer to object type A cast shall not be performed that removes any const or volatile qualification from the type addressed by a pointer Limited dependence should be placed on C s operator precedence rules in expressions The value of an expression shall be the same under any order of evaluation that the standard permits This rule is checked using worst case assumptions This means that a violation will be reported when a
295. p temporary files it generates during the creation of the absolute object file Related information J 5 143 ARM Embedded Tools Reference Control Program library l Command line syntax library name Iname Description With this option you tell the linker via the control program to use system library name Lib where name is a string The linker first searches for system libraries in any directories specified with library directory then in the directories specified with the environment variable LIBARM unless you used the option ignore default library path Example To search in the system library carm 1ib C library ccarm test obj mylib lib library carm The linker links the file test obj and first looks in mylib 1ib in the current directory only then in the system library carm 1ib to resolve unresolved symbols Related information d gt Linker option library directory Additional search path for system libraries Section 5 4 Linking with Libraries in chapter Using the Linker of the user s manual 5 144 Tool Options Control Program Control Program library directory L ignore default library path Command line syntax library directory dir Loir ignore default library path L Description With this option you can specify the path s where your system libraries specified with the library option are located If you want to specify multiple paths use the option
296. p_alignment attributes load_addr section_setup section_setup space_ref lt section_setup_item gt gt section_setup_item vector _table_ statement reserved_range stack_def heap_def 8 4 Expression Evaluation Only constant expressions are allowed including sizes but not addresses of sections in object files All expressions are evaluated with 64 bit precision integer arithmetic The result of an expression can be absolute or relocatable A symbol you assign is created as an absolute symbol 8 13 ARM Embedded Tools Reference 8 5 Semantics of the Architecture Definition Keywords in the architecture definition architecture extends endianness big little bus mau width map space id mau align page_size page direction low_to_high high _to_low stack min_size grows low_to_high high _to_low align fixed id heap min_size grows low_to_high high _to_low align fixed id copytable align copy_unit dest page vector table vector _size size id_symbol_ prefix run_addr template template_symbol vector_prefix ill no_inline copy vector id 211 loop reserved start_address run_addr symbol map 8 14 Linker Script Language map dest bus space dest_dbits dest_offset size sre_dbits sre_offset 8 5 1 Defining an Architecture With the keyword architecture you define an architecture and assign a unique name to it The name is used to refer to it at other places in the LSL fi
297. pace in ROM table size in ROMDATA plus code to do the indexing For a switch with a long type argument only binary search table code is used For an int type argument a jump table switch is only possible when all case values are in the same 256 value range the high byte value of all programmed cases are the same Especially for large switch statements the jump table approach executes faster than the binary search table approach Also the jump table has a predictable behavior in execution speed independent of the switch argument every case is reached in the same execution time With a small number of cases the jump chain method can be faster in execution and shorter in size For ARMv7M a switch using the tbh instruction gets priority over a normal switch table implementation You can overrule the compiler chosen switch method by using a pragma pragma linear _switch force jump chain code pragma jump switch force jump table code pragma binary switch force binary search table code pragma smart_switch let the compiler decide the switch method used pragma tbb switch force use of tbb instruction uses a table of 8 bit jump offsets pragma tbh switch force use of tbh instruction uses a table of 16 bit jump offsets pragma no tbh switch same as smart_switch but do not use tbh instruction Using a pragma cannot overrule the restrictions as described earlier The switch pragmas must be placed before the function body containing th
298. ple the loop is repeated 4 times there are four arguments With the DB directive you allocate and initialize a byte of memory for each repetition of the loop a word for the Dw directive Effectively the preprocessor duplicates the DB and DW directives four times in the assembly source FOR VAR1 IN 1 2 3 4 12 DB VARI DW VAR1 VAR1 ENDFOR In the following example the loop is repeated 16 times With the DW directive you allocate and initialize four bytes of memory for each repetition of the loop Effectively the preprocessor duplicates the DW directive16 times in the assembled file and substitutes VAR2 with the subsequent numbers FOR VAR2 IN 1 to 0x10 DW VAR1 VAR1 ENDFOR Related information d REPEAT ENDREP Repeat sequence of source lines 3 26 Assembly Language GLOBAL Syntax GLOBAL symbol symbol Description All symbols or labels defined in the current section or module are local to the module by default You can change this default behavior with assembler option ig With the GLOBAL directive you declare one of more symbols as global It means that the specified symbols are defined within the current section or module and that those definitions should be accessible by all modules To access a symbol defined with GLOBAL from another module use the EXTERN directive Only program labels and symbols defined with EQU can be made global Example LOOPA EQU 1 definition of s
299. pmlf expmll expml Returns the result of the exponential function e 1 Not implemented log logf logl log Returns the natural logarithm 1n x x gt 0 log10 1logl0f 1og101 10g10 Returns the base 10 logarithm of x x gt 0 loglp loglpf loglpl loglp Returns the base e logarithm of 1 x x lt gt 1 Not implemented log2 log2f 1log21 log2 Returns the base 2 logarithm of x x gt 0 Not implemented ilogb ilogbf ilogbl ilogb Returns the signed exponent of x as an integer x gt 0 Not implemented logb logbf logbl logb Returns the exponent of x as a signed integer in value in floating point notation x gt 0 Not implemented frexp Idexp modf scalbn scalbin math h tgmath h Description frexp frexpl frexpf frexp Splits a float x into fraction f and exponent n so that f 0 0 or 0 5 lt f lt 1 0 and 2 x Returns f stores n ldexp ldexpl ldexpf ldexp Inverse of frexp Returns the result of x 22 x and n are both arguments modf modf1 modff Splits a float x into fraction f and integer n so that f lt 1 0 and f n x Returns f stores n scalbn scalbnl scalbnf scalbn Computes the result of x FLT_RADIX efficiently not normally by computing FLT RADIX explicitly scalblnscalblnlscalblnf scalblin Same as scalbn but with argument n as long int Rounding functions math h tgmath h Description ceil ceilf ceill ceil Returns the smallest integer not less than x as a double floor floorf floorl floor Returns the largest integer not
300. ppend open existing text file or create new text file for writing at end of file r open text file for update reading and writing create text file for update previous contents if any is discarded W a append open or create text file for update writes at end of file fclose name Flushes the data stream and closes the specified file that was previously opened with fopen fflush name If stream is an output stream any buffered but unwritten date is written Else the effect is undefined freopen name mode stream Similar to fopen but rather then generating a new value of type FILE the existing value is associated with a new stream setbuf stream buffer If buffer is NULL buffering is turned off for the stream Otherwise setbuf is equivalent to void setvbuf stream buf IOFBF BUFSIZ setvbuf stream buffer Controls buffering for the stream this function must be called before reading or writing mode size Mode can have the following values _IOFBF causes full buffering _IOLBF causes line buffering of text files _IONBF causes no buffering If buffer is not NULL it will be used as a buffer otherwise a buffer will be allocated size determines the buffer size Character input output The format string of printf related functions can contain plain text mixed with conversion specifiers Each conversion specifier should be preceded by a character The conversion specifier should be build
301. primary expressions 35 R Assignment operators shall not be used in Boolean expressions 36 A Logical operators should not be confused with bitwise operators 37 R Bitwise operations shall not be performed on signed integers 38 R A shift count shall be between 0 and the operand width minus 1 This violation will only be checked when the shift count evaluates to a constant value at compile time 39 R The unary minus shall not be applied to an unsigned expression 40 A sizeof should not be used on expressions with side effects x 41 A The implementation of integer division should be documented 42 R The comma operator shall only be used in a for condition 43 R Don t use implicit conversions which may result in information loss 44 A Redundant explicit casts should not be used 45 R Type casting from any type to or from pointers shall not be used 46 R The value of an expression shall be evaluation order independent This rule is checked using worst case assumptions This means that a violation will be reported when a possible alias may cause the result of an expression to be evaluation order dependent 47 A No dependence should be placed on operator precedence rules 48 A Mixed arithmetic should use explicit casting 49 A Tests of a non Boolean value against 0 should be made explicit 50 R F P variables shall not be tested for exact equality or inequality 51 A Constant unsigned integer expressions should n
302. ption file 5 35 output 5 36 preprocess 5 37 profile 5 38 rename sections 5 40 runtime 5 41 signed bitfields 5 43 source 5 44 static 5 45 stdout 5 46 thumb 5 47 tradeoff 5 48 uchar 5 49 unaligned access 5 50 undefine 5 51 version 5 52 warnings as errors 5 53 A 5 23 B 5 12 C 5 6 c 5 21 D 5 8 E 5 37 F 5 30 f 5 35 f option file 5 14 g 5 7 H 5 17 I 5 16 k 5 22 m 5 4 n 5 46 O 5 33 0 5 36 p 5 38 R 5 40 r 5 41 S 5 44 t 5 48 U 5 51 u 5 49 V 5 52 w 5 32 debug information 5 7 diagnostics 5 32 5 53 language 5 21 5 23 5 43 5 49 MISRA C 5 27 optimization 5 33 5 48 preprocessing 5 8 5 17 5 37 5 51 C style comments 5 23 cabs 2 3 cacos 2 2 cacosh 2 2 call 1 8 Call graph 3 14 calloc 2 7 2 18 calls 3 14 carg 2 3 casin 2 2 casinh 2 2 catan 2 2 catanh 2 2 cbrt functions 2 9 ccos 2 2 ccosh 2 2 ceil functions 2 8 cexp 2 2 Index 3 ARM Embedded Tools Reference chdir 2 22 Check source code 5 5 5 56 5 128 cimag 2 3 clearerr 2 17 clock 2 21 clock_t 2 20 CLOCKS _PER_SEC 2 21 clog 2 2 close 2 22 cnt 3 7 Code compaction 5 18 code16 3 15 code32 3 15 Command file 5 182 Comment 3 2 Comments 8 3 compiler options misrac version 5 29 complex 2 2 Conditional assembly 3 49 Conditional make rules 5 169 conj 2 3 Conjugate value 2 3 Control program pas
303. qualifier inline and all functions that are smaller than the specified threshold the compiler looks whether it can inline more functions without increasing the code size too much With the option inline max iner you can specify how much the code size is allowed to increase Default this is 25 which means that the compiler continues inlining functions until the resulting code size is 25 larger than the original size Example carm inline max incr 40 inline max size 15 test c The compiler first inlines all functions with the function qualifier inline and all functions that are smaller than the specified threshold of 15 If the code size has still not increased with 40 the compiler decides which other functions it can inline Related information d gt C compiler option optimize Specify optimization level Section 1 8 3 nlining Functions in chapter C Language 5 19 ARM Embedded Tools Reference C Compiler interwork Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Code Generation 3 Enable the option Compile for ARM Thumb interworking Command line syntax interwork Description With this option the compiler generates code which supports calls between functions with the ARM and Thumb instruction set Use this option if your program consists of both ARM and Thumb functions By default this option is disabled since it
304. r Options of Chapter Tool Options 3 15 ARM Embedded Tools Reference DB Syntax label DB argument argument Description With the DB directive Define Byte the assembler allocates and initializes one byte of memory for each argument An argument can be e asingle or multiple character string constant e an integer expression e NULL indicated by two adjacent commas If you specify label it gets the value of the location counter at the start of the directive processing Multiple arguments are stored in successive address locations If an argument is NULL its corresponding address location is flled with zeros Integer arguments are stored as is but must be byte values within the range 0 255 floating point numbers are not allowed If the evaluated expression is out of the range 256 255 the assembler issues an error For negative values within that range the assembler adds 256 to the specified value for example 254 is stored as 2 In case of single and multiple character strings each character is stored in consecutive bytes whose lower seven bits represent the ASCII value of the character The standard C escape sequences are allowed DB R 0x52 DB AB D 0x41420043 second argument is empty Example TABLE DB 14 253 0x62 ABCD CHARS DB A B C D Related information d gt BS Block Storage DS Define Storage DH Define Half Word D
305. r option iso ISO C standard 5 141 ARM Embedded Tools Reference Control Program keep output files k Command line syntax keep output files k Description If an error occurs during the compilation assembling or linking process the resulting output file may be incomplete or incorrect With this option you keep the generated output files when an error occurs By default the control program removes generated output files when an error occurs This is useful when you use the make utility If the erroneous files are not removed the make utility may process corrupt files on a subsequent invocation Use this option when you still want to use the generated files For example when you know that a particular error does not result in a corrupt file or when you want to inspect the output file or send it to Altium support Related information J 5 142 Tool Options Control Program Control Program keep temporary files t Menu Entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Select Build Options 3 Enable the option Keep temporary files that are generated during a compile Command line syntax keep temporary files t Description By default the control program removes intermediate files like the src file result of the compiler phase and the obj file result of the assembler phase With this option you tell the control program to kee
306. r option mil mil split 5 148 Tool Options Control Program Control Program no default libraries Command line syntax no default libraries Description By default the control program specifies the standard C libraries C99 and run time library to the linker With this option you tell the control program not to specify the standard C libraries and run time library to the linker In this case you must specify the libraries you want to link to the linker with the option I ibrary_name The control program recognizes the option I as an option for the linker and passes it as such Example ccarm no default libraries test c The control program does not specify any libraries to the linker In normal cases this would result in unresoved externals To specify your own libraries libmy a and avoid unresolved externals ccarm no default libraries lmy test c Related information d gt Linker option library I Add library 5 149 ARM Embedded Tools Reference Control Program no double F Command line syntax no double F Description With this option you tell the compiler to treat variables of the type double as float Because the float type takes less space execution speed increases and code size decreases both at the cost of less precision Related information i 5 150 Tool Options Control Program Control Program no map file Command line syntax no map file Descripti
307. r the space reserved for the table will be 28 bytes instead of 32 This option is not available for a position independent vector table Note that you need to use the __at attribute to specify the actual position of the FIQ handler e Inthe Startup code Vector table page enable or disable the option Do not use FIQ vector ARM Embedded Tools Reference The linker will look for specific symbols designating the start of a handler function These symbols are generated by the compiler when one of the following function qualifiers is used Function type qualifier Vector symbol __interrupt_und _vector_1 __interrupt_svcec _vector_2 __interrupt_iabt _vector_3 __interrupt_dabt _vector_4 __interrupt_irgqg _vector_6 __interrupt_fiq _vector_7 Table 4 3 Function qualifiers and vector symbols Note that the reset handler is designated by the symbol START instead of _vector_0 The fifth vector with symbol _vector_5 is reserved You should use the same vector symbols in hand coded assembly handlers You may first want to generate an idle handler in C with the compiler and than use the result as a starting point for your assembly implementation If the linker does not find the symbol for a handler it will generate a loop for the corresponding vector i e a jump to itself Note that if you have more than one handler for the same exception for example for different IRQ s or for different run time phases of your applic
308. re optional the conversion character is not The conversion character must be one of the following if a character following is not in the list the behavior is undefined Character Scanned as d int signed decimal i int the integer may be given octal i e a leading 0 is entered or hexadecimal leading 0x or 0X or just decimal int unsigned octal int unsigned decimal int unsigned hexadecimal in lowercase or uppercase single character converted to unsigned char n Oo xX O char a string of non white space characters The argument should point to an array of characters large enough to hold the string and a terminating NULL character 2 14 Libraries Character Scanned as f float e E float g G float a A float n int the number of characters written so far is written into the argument No scanning is done p pointer hexadecimal 24 bit value which must be entered without Ox prefix Matches a string of input characters from the set between the brackets A NULL character is added to termi nate the string Specifying includes the character in the set of scanning characters m Matches a string of input characters not in the set between the brackets A NULL character is added to termi nate the string Specifying includes the character in the set Literal no assignment is done Table 2 3 Scanf conversion characters stdio h wchar h De
309. re set the section is created as a scratch section attributes ws no image fill_spec fill fill_values fill_values 3 expr expr lt expr gt 9 aggregate _section_statement lt section_statement gt 9 group_descr if_statement section_creation_statement group_descr group lt group_name gt lt group specs gt 9 1 section statement e No two groups for an address space can have the same group_name group_specs group_spec lt group_spec gt 0 group_alignment attributes copy nocopy group_load_address fill lt fill_values gt 1 group_page group_run_address group_type allow_cross_references group_spec priority number e The allow cross references property is only allowed for overlay groups e Sub groups inherit all properties from a parent group 8 11 ARM Embedded Tools Reference group_alignment align expr attributes lt attribute gt 1 attributes Ge attribute readable sections writable sections executable code sections initialized sections scratch sections blanked cleared sections oN ry x EK group_load_address load_addr lt load_or_run_addr gt page lt expr gt 0 1 page_size expr lt range lt range gt gt 0 gt 0 1 group_page group_run_address run_addr lt load_or_run_addr gt 1 contiguous group _type clustered ordered overlay e For non contiguous
310. read write attributes These properties are assigned to all sections in the group and subgroups and override the attributes of the input sections e The align field tells the linker to align all sections in the group and the group as a whole according to the align value By default the linker uses the largest alignment constraint of either the input sections or the alignment of the address space e The attributes field tells the linker to assign one or more attributes to all sections in the group This overrules the default attributes By default the linker uses the attributes of the input sections You can set the r wor rw attributes and you can switch between the b and s attributes e The copy field tells the linker to locate a read only section in RAM and generate a ROM copy and a copy action in the copy table This property makes the sections in the group writable which causes the linker to generate ROM copies for the sections 8 27 ARM Embedded Tools Reference The effect of the nocopy field is the opposite of the copy field It prevents the linker from generating ROM copies of the selected sections 2 Define the mutual order of the sections in the group By default a group is unrestricted which means that the linker has total freedom to place the sections of the group in the address space B 8 28 The ordered keyword tells the linker to locate the sections in the same order in the address space as they appear in the group b
311. rectives as Macros 0 00 cece eee eens 3 49 3 9 5 Conditional Assembly r bie E E EE E eeaae 3 49 3 10 Generic INStrUCtiONS kece ee OE E a eE ee Sele EE daa E E nd EE EA E aE 3 51 3 10 1 ARM Generic Instructions s a sus euesan ua eeunenn 3 51 3 10 2 ARM and Thumb 2 32 bit Generic Instructions 00 cece ces 3 51 3 10 3 Thumb 16 bit Generic Instructions 0 eee eens 3 53 Run time Environment 4 1 4 1 StartUp Code i240 crorcren riano i eeg eona AEA EE E E Dead die bee ELONE E 4 1 4 2 Reset Handler and Vector Table cece eect tenets 4 2 4 3 Stack and Heap 62s si40d eva tebe idiei ata EE E aida E E EA rade 4 5 Tool Options 5 1 5 1 C Compiler Options 0 tne 5 1 5 2 Assembler Options 2 lt i0c c0taue vise ciebiee ci pE a E E vane eee e ieee Ns 5 54 5 3 Linker OPtiONnS rss sina cine oe ea ed neki Behe de ee Pe ee ed Go ee alee 5 88 5 4 Control Program OptionS 0 eee eee eee eee 5 126 5 5 Make Utility OPtiONS nnrir e con Rind Dene eae eee dae eee cane E a E E ee PONG oes 5 168 5 6 Librarian Options seesi neen a Send onde ce eee tend Lede twee Mite tee 5 194 List File Formats 6 1 6 1 Assembler List File Format c 022 0223s ascc8u dioa cape Cys eee eas ea ee ed ded ee eee eke 6 1 6 2 Linker Map File Format 2 2 c4ccc e cad tacbntiee wade tae d diame oe ieee eee oiak 6 3 Object File Formats 7 1 7 1 ELF DWARF Object Format erorerinicr teanen pier eera ea AEE EEE Da eas 7 1
312. removed when closed or when the program terminates normally Returns a file pointer Creates new file names that do not conflict with other file names currently in use The new file name is stored in a buffer which must have room for L_tmpnam characters Returns a pointer to the temporary name The file names are created in the current directory and all start with tmp At most TMP_MAX unique file names can be generated Description clearerr stream ferror stream feof stream perror s Clears the end of file and error indicators for stream Returns a non zero value if the error indicator for stream is set Returns a non zero value if the end of file indicator for stream is set Prints s and the error message belonging to the integer errno See section 2 2 5 errno h 2 2 23 Stdlib h and wchar h The header file stdlib h contains general utility functions which fall into the following categories Some have parallel wide character declared in wchar h e Numeric conversions e Random number generation e Memory management e Envirnoment communication e Searching and sorting e Integer arithmetic e Multibyte wide character and string conversions Macros EXIT_SUCCES 0 EXIT_FAILURE 1 RAND_MAX 32767 MB_CUR_MAX 1 Predefined exit codes that can be used in the exit function Highest number that can be returned by the rand srand function Maximum number of bytes in a multibyte character for the extended chara
313. responds to the index in the CALLS directive as generated by the compiler If the id is omitted the id is O zero direction low_to_high high_to_low e If you do not specify the grows statement the stack and grow low to high copy_table def copytable lt copy table descr lt copy_table_descr gt gt 0 gt 0 1 e Aspace_def contains at most one copytable statement e If the architecture definition contains more than one address space exactly one copy table must be defined in one of the spaces If the architecture definition contains only one address space a copy table definition is optional it will be generated in the space copy_table_ descr align expr copy_unit expr dest lt space_name gt 1 space_name page e The copy_unit is defined by the size in MAUs in which the startup code moves data e The dest statement is only required when the startup code initializes memory used by another processor that has no access to ROM e Aspace_name refers to a defined address space 8 8 Linker Script Language start_addr start_address start_addr_descr lt start_addr_descr gt gt start_addr_descr run_addr expr symbol symbol_name e Asymbol_name refers to the section that contains the startup code vector table statement vector_table section_name vecttab_spec lt vecttab_spec gt lt vector_def gt vecttab_spec vector size expr size expr
314. ription This option is primarily intended for command line use Instead of typing all options on the command line you can create an option file which contains all options and flags you want to specify With this option you specify the option file to the assembler Use an option file when the command line would exceed the limits of the operating system or just to store options and save typing Option files can also be generated on the fly for example by the make utility You can specify the option option file multiple times Format of an option file e Multiple arguments on one line in the option file are allowed e To include whitespace in an argument surround the argument with single or double quotes e If you want to use single quotes as part of the argument surround the argument by double quotes and vise versa This has a single quote embedded This has a double quote embedded This has a double quote and a single quote embedded e When a text line reaches its length limit use a to continue the line Whitespace between quotes is preserved This is a continuation line gt This is a continuation line e tis possible to nest command line files up to 25 levels Example Suppose the file myoptions contains the following lines gaL test src Specify the option file to the assembler asarm option file myoptions This is equivalent to the following command line asarm gaL test sr
315. ription With this option the make utility shows extended error messages Extended error messages give more detailed information about the exit status of the make utility after errors Altium Designer uses this option for the graphical version of make Example tmk x If errors occur the make utility gives extended information Related information i 5 193 ARM Embedded Tools Reference 5 6 Librarian Options The librarian tlb is a tool to build library files and it offers the possibility to replace extract and remove modules from an existing library You can only call the librarian from the command line The invocation syntax is tlb key_option sub_option library object_file This section describes all options for the make utility Suboptions can only be used in combination with certain key options Keyoptions and their suboptions are therefor described together The miscellaneous options can always be used and are also described separately The librarian is a command line tool so there are no equivalent options in Altium Designer Description Option Suboption Main functions key options Replace or add an object module r a b c u v Extract an object module from the library X 0 V Delete object module from library d V Move object module to another position m a b v Print a table of contents of the library t s0 s1 Print object module to standard output p Suboptions
316. rmal value signbit Returns a nonzero value if and only if its argument value is negative 2 2 16 setjmp h The setjmp and longjmp in this header file implement a primitive form of nonlocal jumps which may be used to handle exceptional situations This facility is traditionally considered more portable than signal h int setjmp jmp buf env Records its caller s environment in env and returns 0 void longjmp jmp_buf env Restores the environment previously saved with a call to set jmp int status Libraries 2 2 17 signal h Signals are possible asynchronous events that may require special processing Each signal is named by a number The following signals are defined SIGINT 1 Receipt of an interactive attention signal SIGILL 2 Detection of an invalid function message SIGFPE 3 Anerrouneous arithmetic operation for example zero devide overflow SIGSEGV 4 An invalid access to storage SIGTERM 5 A termination request sent to the program SIGABRT 6 Abnormal terminiation such as is initiated by the abort function The next function sends the signal sig to the program int raise int sig The next function determines how subsequent signals will be handled signalfunction signal int signalfunction The first argument specifies the signal the second argument points to the signal handler function or has one of the following values SIG DFL Default behaviour is used SIG_IGN The signal is ignored The function returns
317. rofile p Command line syntax profile flags plflags Use the following option for a predefined set of flags profile g pg profiling with call graph and function timers Alias for pBcFt You can set the following flags when you specify p without flags the default is pBCfST block b B block counters callgraph c C call graph function f F function counters static s S static profile generation time t T function timers Description Profiling is the process of collecting statistical data about a running application With these data you can analyze which functions are called how often they are called and what their execution time is Several methods of profiling exist One method is code instrumentation which adds code to your application that takes care of the profiling process when the application is executed db For an extensive description of profiling refer to Chapter 3 Profiling in the user s manual With this option the compiler adds the extra code to your application that takes care of the profiling process You can obtain the following profiling data see flags above Block counters not in combination with Call graph or Time This will instrument the code to perform basic block counting As the program runs it counts the number of executions of each branch in an if statement each iteration of a for loop and so on Note that though you can combine Block counters with Function co
318. s so no unnecessary register saving and restoring instructions are placed around the inline assembly instructions Constraint Type Operand Remark character R general purpose rO r11 Thumb mode rO r7 register 64 bits Based on the specified register a register pair is formed 64 bit For example r0r1 r general purpose r r11 Ir Thumb mode rO r7 register i immediate value value l label label m memory label variable stack or memory operand a fixed address number other operand same as number Input constraint only The number must refer to an output parameter Indicates that number and number are the same register Use number 0 and number 1 to indicate the first and second half of a register pair when used in combination with R Table 1 2 Available input output operand constraints for the ARM Loops and conditional jumps The compiler does not detect loops that are coded with multiple __asm statements or conditional jumps across __ asm statements and will generate incorrect code for the registers involved If you want to create a loop with __ asm the whole loop must be contained ina single __asm statement The same counts for conditional jumps As a rule of thumb all references to a labelinan__ asm statement must be contained in the same statement Example 1 no input or output A simple example without input or output parameters You can use any instruction or
319. s UTC Returns a pointer to the broken down time Converts the calendar time pointed to by timer to the broken down time expressed as local time Returns a pointer to the broken down time The next function has a parallel function defined in wchar h stdio h wcehar h strftime s smax fmt tm tp wstrftime s smax fmt tm tp Formats date and time information from struct tm tp into s according to the specified format fmt No more than smax characters are placed into s The formatting of strf time is locale specific using the LC_TIME category see section 2 2 13 locale h You can use the next conversion specifiers a abbreviated weekday name A full weekday name b abbreviated month name B full month name c local date and time representation Same as a b e T Y C last two of the year d day of the month 01 31 2 21 ARM Embedded Tools Reference D e F g G h H l j m M n p r R S t T u U V W W X X y Y Z Z 2 2 26 same as m d y day of the month 1 31 with single digits preceded by a space ISO 8601 date format Y m d last two digits of the week based year 00 99 week based year 0000 9999 same as b hour 24 hour clock 00 23 hour 12 hour clock 01 12 day of the year 001 366 month 01 12 minute 00 59 replaced by the newline character local equivalent of AM or PM locale s 12 hour clock time same as I M
320. s an operand of an assembler instruction or directive Expressions may contain user defined labels and their associated integer values and any combination of integers or ASCII literal strings Expressions follow the conventional rules of algebra and boolean arithmetic Expressions that can be evaluated at assembly time are called absolute expressions Expressions where the result is unknown until all sections have been combined and located are called relocatable or relative expressions 3 3 ARM Embedded Tools Reference When any operand of an expression is relocatable the entire expression is relocatable Relocatable expressions are emitted in the object file and evaluated by the linker The assembler evaluates expressions with 64 bit precision in two s complement The syntax of an expression can be any of the following numeric contant string symbol expression binary_operator expression unary_operator expression expression function call All types of expressions are explained in separate sections 3 6 1 Numeric Constants Numeric constants can be used in expressions If there is no prefix by default the assembler assumes the number is a decimal number Base Description Example Binary A 0b prefix followed by binary digits 0 1 Or use a b suffix oe 0x12FF Hexadecimal A 0x prefix followed by a hexadecimal digits 0 9 A F a f Or use a h suffix 0x45 OfalOh Decimal as 12
321. s are within the section layout s address space 2 The sections match the specified attributes 3 The sections have no absolute restriction as is the case for all wildcard selections For example to select the code sections referenced from fool group refgrp ordered contiguous run_addr mem ext_c select ref_tree fool attributes x If section foo1 references foo2 and foo2 references foo3 then all these sections are selected by the selection shown above Locating a group group group _name group_specifications section_statements With the group_specifications you actually define how the linker must locate the group You can roughly define three things 1 assign properties to the group like alignment and read write attributes 2 define the mutual order in the address space for sections in the group and 3 restrict the possible addresses for the sections in a group The linker creates labels that allow you to refer to the begin and end address of a group from within the application software Labels _le_gb_group_name and _1le_ge_group_name mark the begin and end of the group respectively where the begin is the lowest address used within this group and the end is the highest address used Notice that a group not necessarily occupies all memory between begin and end address The given label refers to where the section is located at run time versus load time 1 Assign properties to the group like alignment and
322. s into the program counter by means of a PC relative load from a literal pool To set a fixed ROM address in Altium Designer 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Processor entry and select Startup code Vector table 3 Enter an address in the Force reset handler at ROM address field Vector table The ROM address of the vector table is usually address 0x00000000 You have to specify an address if the vector table will be copied from ROM to RAM address 0x00000000 is mapped to RAM or if the hardware uses high vectors at address OxFFFFOOOO If you forced the reset handler on address 0x00000000 then you also have to specify a vector table ROM address to prevent overlapping address ranges e Inthe dialog as described above enter an address in the Vector table ROM address field For M profile architectures also specify the Number of vectors The linker can generate a vector table for you e Inthe Startup code Vector table page enable the option Generate vector table in ROM You can ask the linker to reserve space in RAM memory for a copy of the vector table at run time at a certain address in memory Typically this would be the address which will be the mapping of address 0x00000000 after ROM RAM re mapping If you reserve space for a copy you can also let the startup code copy the table automatically from ROM to RAM but only if position independent vectors are used e
323. s parallel type generic math macros whose expansion depends on the used type tgmath h includes math h and the effect of expansion is that the correct math h functions are called The type generic macro if available is listed in the second column of the tables below Trigonometric and hyperbolic functions math h tgmath h Description sin sinf sinl sin Returns the sine of x cos cosf cosl cos Returns the cosine of x tan tanf tanl tan Returns the tangent of x asin asinf asinl asin Returns the arc sine sin x of x acos acosf acosl acos Returns the arc cosine cos 1 x of x atan atanf atanl atan Returns the arc tangent tan x of x atan2 atan2f atan2l atan2 Returns the result of tan y x sinh sinhf sinhl sinh Returns the hyperbolic sine of x cosh coshf coshl cosh Returns the hyperbolic cosine of x tanh tanhf tanhl tanh Returns the hyperbolic tangent of x asinh asinhf asinhl asinh Returns the arc hyperbolic sinus of x acosh acoshf acoshl acosh Returns the non negative arc hyperbolic cosinus of x atanh atanhf atanhl atanh Returns the arc hyperbolic tangent of x 2 7 ARM Embedded Tools Reference Exponential and logarithmic functions All of these functions are new in ISO C99 except for exp log and 1og10 math h tgmath h Description exp expf expl exp Returns the result of the exponential function e exp2 exp2f exp2l1 exp2 Returns the result of the exponential function 2 Not implemented expml ex
324. s redirected to the file ile obj The effect of this example is very similar to extracting a file from the library but in this case the extracted file gets another name Related information i 5 199 ARM Embedded Tools Reference Librarian r Command line syntax r a posname b posname c u v Description You can use the option r for several purposes e Adding new objects to the library e Replacing objects in the library with the same object of a newer date e Creating a new library The option r normally adds a new module to the library However if the library already contains a module with the specified name the existing module is replaced If you specify a library that does not exist the librarian creates a new library with the specified name If you add a module to the library without specifying the suboption a or b the specified module is added at the end of the archive Use the suboptions a or b to insert them to a specified place instead aposname Add the specified object module s after the existing module posname b posname Add the specified object module s before the existing module posname C Create a new library without checking whether it already exists If the library already exists it is overwritten u Insert the specified object module only if it is newer than the module in the library V Verbose the librarian shows which files are removed AN The suboptions a or b have
325. s space You can precede the address space name with a processor name and or core name separated by colons You can omit the processor name and or the core name if only one processor is defined and or only one core is present in the processor A reference to a space in the only core of the only processor in the system would look like my_space A reference to a space of the only core on a specific processor in the system could be my_chip my_space The next example shows a section definition for sections in the my_space address space of the processor called my_chip 8 25 ARM Embedded Tools Reference section_layout my chip my_space locate direction section statements With the optional keyword direction you specify whether the linker starts locating sections from low_to_high default or from high_to_low In the second case the linker starts locating sections at the highest addresses in the address space but preserves the order of sections when necessary one processor and core in this example section_layout my_ space direction high_to_low section statements AN If you do not explicitly tell the linker how to locate a section the linker decides on the basis of the section attributes in the object file and the information in the architecture definition and memory parts where to locate the section 8 9 2 Creating and Locating Groups of Sections Sections are located per group A group can c
326. s symbol If the section in which the symbol is defined fits in the vector table size may be gt m locate the section at the location of the vector Otherwise insert code to jump to the symbol s value A template handler section name symbol name for the target code must be supplied in the LSL file i11 value s fills the vector with the specified MAU values With i111 1loop the vector jumps to itself With the optional offset you can specify an offset from the vector table entry 8 17 ARM Embedded Tools Reference Reserved address ranges e The reserved keyword specifies to reserve a part of an address space even if not all of the range is covered by memory See also the reserved keyword in section 8 9 3 Creating or Modifying Special Sections Start address e The start_address keyword specifies the start address for the position where the C startup code is located When a processor is reset it initializes its program counter to a certain start address sometimes called the reset vector In the architecture definition you must specify this start address in the correct address space in combination with the name of the label in the application code which must be located here The run_addr argument specifies the start address reset vector If the core starts executing using an entry from a vector table and directly jumps to the start label you should omit this argument The symbol argument specifies the name of the la
327. scription fscanf stream fwscanf stream Performs a formatted read from the given stream Returns the number of format format items converted succesfully FSS implementation scanf format wscanf format Performs a formatted read from the stdin stream Returns the number sscanf s format vfscanf stream format arg vscanf format arg vsscanf s format arg fprintf stream format printf format sprintf s format snprintf s n format vfprintf stream format arg vprintf format arg vsprintf s format arg swscanf s format vfwscanf stream format arg vwscanf format arg vswscanf s format arg fwprintf stream format wprintf format swprintf s n format vfwprintf stream format arg vwprintf format arg vswprintf s format arg of items converted succesfully FSS implementation Performs a formatted read from the string s Returns the number of items converted succesfully Same as fscanf fwscanf but extra arguments are given as variable argument list arg See section 2 2 18 sidarg h Same as scanf wscanf but extra arguments are given as variable ar gument list arg See section 2 2 18 sidarg h Same as scanf wscanf but extra arguments are given as variable ar gument list arg See section 2 2 18 stdarg h Performs a formatted write to the given stream Returns EOF WEOF on error FSS
328. se to the Additional linker options field Command line syntax verbose extra verbose v vv Description With this option you put the linker in verbose mode The linker prints the link phases while it processes the files In the extra verbose mode the linker also prints the filenames and it shows which objects are extracted from libraries With this option you can monitor the current status of the linker Related information J 5 123 ARM Embedded Tools Reference Linker version V Menu entry Command line syntax version V Description Display version information The linker ignores all other options or input files Related information J 5 124 Tool Options Linker Linker warnings as errors Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Diagnostics 3 Enable the option Treat warnings as errors Command line syntax warnings as errors number Description When the linker detects an error or warning it tries to continue the link process and reports other errors and warnings When you use this option without arguments you tell the linker to treat all warnings as errors This means that the exit status of the linker will be non zero after the detection of one or more linker warnings As a consequence the linker will not produce any output files You can also limit this option to
329. sed the operator the macro preprocessor would choose another name for LOCAL because the label already exists The macro would expand like LOCAL M L000001 ldr r0 LOCAL_M L000001 3 9 4 Using the FOR and REPEAT Directives as Macros The FOR and REPEAT directives are specialized macro forms to repeat a block of source statements You can think of them as a simultaneous definition and call of an unnamed macro The source statements between the FOR and ENDFOR directives and REPEAT and ENDREP directives follow the same rules as macro definitions d gt For a detailed description of these directives see section 3 8 Assembler Directives 3 9 5 Conditional Assembly With the conditional assembly directives you can instruct the macro preprocessor to use a part of the code that matches a certain condition You can specify assembly conditions with arguments in the case of macros or through definition of symbols via the DEFINE SET and EQU directives The built in functions of the assembler provide a versatile means of testing many conditions of the assembly environment You can use conditional directives also within a macro definition to check at expansion time if arguments fall within a range of allowable values In this way macros become self checking and can generate error messages to any desired level of detail The conditional assembly directive IF ENDIF has the following form IF expression ELIF expression
330. select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Diagnostics 3 In the Warnings field select one of the following options e Report all warnings e Suppress all warnings e Suppress specific warningsn If you select Suppress specific warnings 4 Enter the numbers separated by commas of the warnings you want to suppress Command line syntax no warnings number w number Description With this option you can suppress all warning messages or specific warning messages On the command line this option works as follows e If you do not specify this option all warnings are reported e If you specify this option but without numbers all warnings are suppressed e If you specify this option with a number only the specified warning is suppressed You can specify the option no warnings number multiple times Example To suppress warnings 135 and 136 enter 135 136 in the Specific warnings to suppress field or enter the following on the command line carm test c no warnings 135 136 Related information d gt C compiler option warnings as errors Treat warnings as errors 5 32 Tool Options C Compiler C Compiler optimize O Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Optimization 3 Select an optimization level in the Optimization level
331. select statement that matches in the union of all section layouts for the address space Global section layouts are processed in the order in which they appear in the LSL file Internal core architecture section layouts always take precedence over global section layouts e The attributes field selects all sections that carry or do not carry the given attribute With attribute you select sections that have the specified attribute set With attribute you select sections that do not have the specified attribute set You can specify one or more of the following attributes r readable sections w writable sections 8 26 Linker Script Language executable sections initialized sections sections that should be cleared at program startup no rf mw scratch sections not cleared and not initialized To select all read only sections group select attributes r w Keep in mind that all section selections are restricted to the address space of the section layout in which this group definition occurs e With the ref_tree field you can select a group of related sections The relation between sections is often expressed by means of references By selecting just the root of tree the complete tree is selected This is for example useful to locate a group of related sections in special memory e g fast memory The referenced sections must meet the following conditions in order to be selected 1 The section
332. sembly Expressions address A combination of expression register and symbol 3 4 Symbol Names User defined symbols A user defined symbol can consist of letters digits and underscore characters _ The first character cannot be a digit The size of an identifier is only limited by the amount of available memory The case of these characters is significant You can define a symbol by means of a label declaration or an equate or set directive Predefined preprocessor symbols These symbols start and end with two underscore characters _ symbo __ and you can use them in your assembly source to create conditional assembly See section 3 4 1 Predefined Preprocessor Symbols Labels Symbols used for memory locations are referred to as labels It is allowed to use reserved symbols as labels as long as the label is followed by a colon or starts at the first column Assembly Language Reserved symbols Symbol names and other identifiers beginning with a period are reserved for the system for example for directives or section names Instructions are also reserved The case of these built in symbols is insignificant Examples Valid symbol names loop _1 ENTRY a Be _aBC Invalid symbol names 1_loop starts with a number DEFINE reserved directive name 3 4 1 Predefined Preprocessor Symbols The TASKING assembler knows the predefined symbols as defined in the table below The symbols are useful to create co
333. semicolon You can use empty lines or lines with only comments 3 2 Assembler Significant Characters You can use all ASCII characters in the assembly source both in strings and in comments Also the extended characters from the ISO 8859 1 Latin 1 set are allowed Some characters have a special meaning to the assembler Special characters associated with expression evaluation are described in section 3 6 3 Expression Operators Other special assembler characters are Character Description Start of a comment Line continuation character or Macro operator argument concatenation Macro operator return decimal value of a symbol v Macro operator return hex value of a symbol Macro operator override local label Macro string delimiter or Quoted string DEFINE expansion character String constants delimiter Start of a built in assembly function Location counter substitution Note that macro operators have a higher precedence than expression operators 3 3 Operands of an Assembly Instruction In an instruction the mnemonic is followed by zero one or more operands An operand has one of the following types Operand Description symbol A symbolic name as described in section 3 4 Symbol Names Symbols can also occur in expressions register Any valid register as listed in section 3 5 Registers expression Any valid expression as described in section 3 6 As
334. set Supervisor 0x00000000 OxFFFFOOOO Undefined instructions Undefined 0x00000004 OxFFFF0004 __interrupt_und Supervisor call software Supervisor 0x00000008 OxFFFFO008 __interrupt_sve interrupt Prefetch abort Abort 0x0000000C OxFFFFOOOC __interrupt_iabt Data abort Abort 0x00000010 OxFFFF0010 __interrupt_dabt IRQ interrupt IRQ 0x00000018 OxFFFF0018 __interrupt_irg FIQ fast interrupt FIQ 0x0000001C OxFFFF001C __interrupt_figq Table 1 6 Exception processing modes AN ARMv6 M and ARMv7 M M profile architectures have a different exception model Read the ARM Architecture Reference Manual for details 1 8 5 1 Defining an Exception Handler __ interrupt keywords You can define six types of exception handlers with the function type qualifiers interrupt_und _interrupt_sve __interrupt_iabt interrupt_dabt interrupt_irqand_interrupt_fig You can also use the general __interrupt function qualifier Interrupt functions and other exception handlers cannot return anything and must have a void argument type list void _ interrupt_xxx isr void void _interrupt n isr2 void Example void _ interrupt_irq serial_receive void C Language Vector symbols When you use one or more of these interrupt_xxx function qualifiers the compiler generates a corresponding vector symbol to designate the start of an execption handler function The linker uses this symbol to automatically generat
335. set is the 16 bit starting load offset Together with the address specified in the Extended Address Record it specifies an absolute address in memory where the data is to be located when loaded by a tool Example _ checksum _ data _ type _ offset 0F00200000232222754E00754F04AF4FAE4E22C3 _ length Start Linear Address Record The Start Linear Address Record contains the 32 bit program execution start address Layout 04 0000 05 address checksum Example 0400000500FF0003F5 _ checksum _ address _ type _ offset length Object File Formats End of File Record The hexadecimal file always ends with the following end of file record 00000001FF _ checksum _ type _ offset _ length ARM Embedded Tools Reference 7 8 8 Linker Script Language Summary This chapter describes the syntax of the linker script language LSL 8 1 Introduction To make full use of the linker you can write a script with information about the architecture of the target processor and locating information The language for the script is called the Linker Script Language LSL This chapter first describes the structure of an LSL file The next section contains a summary of the LSL syntax Finally in the remaining sections the semantics of the Linker Script Language is explained The TASKING linker is a target independent linker locator that can simul
336. set options specific for the linker Options in Altium Designer versus options on the command line Most command line options have an equivalent option in Altium Designer but some options are only available on the command line for example in a Windows Command Prompt If there is no equivalent option in Altium Designer you can specify a command line option in Altium Designer as follows 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Enter one or more command line options in the Additional Linker options field Invocation syntax on the command line Windows Command Prompt The invocation syntax on the command line is lkarm option file When you are linking multiple files either relocatable object files obj or libraries 1ib it is important to specify the files in the right order Short and long option names Options can have both short and long names Short option names always begin with a single minus character long option names always begin with double minus characters You can abbreviate long option names as long as the name is unique You can mix short and long option names on the command line Options can have flags or sub options To switch a flag on use a lowercase letter or a ongflag To switch a flag off use an uppercase letter or a ongflag Separate longflags with commas The following tw
337. sing options 5 156 Control program options 5 126 5 139 adress size 5 127 check 5 128 cpu 5 129 create 5 130 debug info 5 131 define 5 132 diag 5 133 dry run 5 134 endianness 5 135 error file 5 136 format 5 137 fp trap 5 138 help 5 139 ignore default library path 5 145 include directory 5 140 iso 5 141 keep output files 5 142 keep temporary files 5 143 library 5 144 library directory 5 145 Is file 5 147 mil link 5 148 mil split 5 148 no default libraries 5 149 no double 5 150 no map file 5 151 no preprocessing only 5 152 no warnings 5 153 option file 5 154 output 5 155 pass 5 156 preprocess 5 157 profile 5 158 Index 4 signed bitfields 5 160 Static 5 161 thumb 5 162 undefine 5 164 verbose 5 165 version 5 166 warnings as errors 5 167 B big endian 5 135 C 5 129 c 5 130 D 5 132 d 5 147 E 5 157 F 5 150 f 5 154 g 5 131 I 5 140 k 5 142 L 5 145 l 5 144 I library 5 146 n 5 134 0 5 155 p 5 158 t 5 143 U 5 164 u uchar 5 163 V 5 166 v 5 165 W 5 156 w 5 153 preprocessing 5 132 Copy table 8 16 8 32 copysign functions 2 9 cos functions 2 7 cosh functions 2 7 cpow 2 3 cproj 2 3 cpu 3 7 creal 2 3 csin 2 2 csinh 2 2 csqrt 2 3 ctan 2 2 ctanh 2 2 ctime 2 21 D Data types 1 2 db 3 16 dd 3 17 Debug info
338. sion 1st Related information On the command line you can use the option list format L to specify which types of information should be included in the list file 5 70 Tool Options Assembler Assembler list format L Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select List File 3 Enable Generate list file 4 Inthe List file format section enable or disable the types of information to be included Command line syntax list format flags Lilags You can set the following flags 0 Same as LDEGILMNPQRSVWXYZ all options disabled 1 Same as Ldegilmnpqrsvwxyz all options enabled section d D Section directives SECTION symbol e E Symbol definition directives generic expansion g G Generic instruction expansion generic i I Generic instructions line I L C preprocessor line directives macro m M Macro dup definitions e g MACRO empty line n N Empty source lines newline conditional p P Conditional assembly IF ELSE ENDIF equate q Q Assembler EQU and SET directives relocations r R Relocation characters r hll s S HLL symbolic debug information SYMB equate values v V Assembler EQU and SET values wrap lines w W Wrapped source lines macro expansion x X Macro expansions cycle count y Y Cycle counts macro expansio
339. specific warnings by specifying a comma separated list of warning numbers Related information db Linker option no warnings Suppress some or all warnings 5 125 ARM Embedded Tools Reference 5 4 Control Program Options The control program is a tool to facilitate use of the toolset from the command line Therefore you can only call the control program from the command line The invocation syntax is ccarm option file Options The control program processes command line options either by itself or when the option is unknown to the control program it looks whether it can pass the option to one of the other tools However for directly passing an option to the C compiler assembler or linker it is recommended to use the control program options pass c pass assembler pass linker Short and long option names Options can have both short and long names Short option names always begin with a single minus character long option names always begin with double minus characters You can abbreviate long option names as long as the name is unique You can mix short and long option names on the command line Options can have flags or sub options To switch a flag on use a lowercase letter or a ongflag To switch a flag off use an uppercase letter or a ongflag Separate longflags with commas The following two invocations are equivalent ccarm Wc Oac test c ccarm pass c optimize coalescer cse te
340. specify another value the assembler changes the alignment to the next higher power of two and issues a warning Examples SECTION text ALIGN 16 the assembler aligns instruction this instruction at 16 MAUs and fills the gap with NOP instructions SECTION text ALIGN 12 WRONG not a power of two the instruction assembler aligns this instruction at 16 MAUs and issues a warning 3 11 ARM Embedded Tools Reference BREAK Syntax BREAK Description The BREAK directive causes immediate termination of a macro expansion a FOR loop exansion or a REPEAT loop expansion In case of nested loops or macros the BREAK directive returns to the previous level of expansion The BREAK directive is for example useful in combination with the IF directive to terminate expansion when error conditions are detected Example FOR MYVAR IN 10 TO 20 i TE assembly source lines a A IF MYVAR gt 15 BREAK ENDIF ENDREP 3 12 Assembly Language BS BSB BSH BSW BSD Syntax label BS expression1 expression2 label BSB expression1 expression2 label BSH expression1 expression2 label BSW expression1 expression2 label BSD expression1 expression2 Description With the Bs directive Block Storage the assembler reserves a block of memory The reserved block of memory is initialized to the value of expression2 or zero if omitted With expression you sp
341. ss you have defined them explicitly as global Related information i 5 83 ARM Embedded Tools Reference Assembler thumb T Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Add the option thumb to the Additional assembler options field Command line syntax thumb T Description With this option you tell the assembler that the input file contains Thumb code By default the assembler assumes that the input file contains ARM code The assembler will complain if thumb is used in combination with cpu ARMv4 Specifying thumb with cpu ARMVv7M is not required Note that the input may still contain mixed Thumb and ARM code because the ARM THUMB CODE16 and CODE32 directives overrule the thumb option Assembly code can check the setting of the thumb option by means of the built in assembly function THUMB So if you use THUMB in a ARM part and you specified thumb THUMB still returns 1 Related information db Assembly function THUMB Assembler directives CODE16 CODE32 THUMB ARM 5 84 Tool Options Assembler Assembler version V Menu entry Command line only Command line syntax version V Description Displays version information of the assembler The assembler ignores all other options or input files Related information J 5 85 AR
342. st c When you do not specify an option a default value may become active 5 126 Tool Options Control Program Control Program address size Command line syntax address size adar_size Description If you specify IHEX or SREC with the control option format you can additionally specify the record length to be emitted in the output files With this option you can specify the size of addresses in bytes record length For Intel Hex you can use the values 1 2 and 4 default For Motorola S records you can specify 2 S1 records 3 S2 records or 4 bytes S3 records default If you do not specify addr_size the default address size is generated Example To create the SREC file test sre with S1 records type ccarm format SREC address size 2 test c Related information d gt Control program option format Set linker output format Linker option output Specify an output object file 5 127 ARM Embedded Tools Reference Control Program check Command line syntax check Description With this option you can check the source code for syntax errors without generating code This saves time in developing your application The compiler assembler reports any warnings and or errors Related information db C compiler option check Check syntax Assembler option check Check syntax 5 128 Tool Options Control Program Control Program cpu C Command line syntax
343. sted true Function Equivalent to locale specific test iswalnum wc iswctype wc wctype alnum iswalpha wc iswctype wc wctype alpha iswentrl wc iswctype wc wctype cntr1 iswdigit wc iswctype wc wctype digit iswgraph wc iswctype wc wctype graph iswlower wc iswctype wc wctype lower iswprint wc iswctype wc wctype print iswpunct wc iswctype wc wctype punct iswspace wc iswctype wc wctype space iswupper wc iswctype wc wctype upper iswxditig wc iswctype wc wctype xdigit wctrans property towctrans wc desc Constructs a value of type wctype_t that describes a mapping between wide characters identi fied by the string property If property identifies a valid mapping of wide characters according to the LC_TYPE category see section 2 2 13 ocale h of the current locale a non zero value is returned that can be used as an argument in the towctrans function Transforms wide character wc into another wide character described by desc Function Equivalent to locale specific transformation towlower wc towctrans wc wctrans tolower towupper wc towctrans wc wctrans toupper 2 24 3 Assembly Language Summ ary This chapter describes the most important aspects of the TASKING assembly language and contains a detailed description of all built in assembly functions and assembler directives For a complete overvi
344. stok 2 20 wcstol 2 18 wcstold 2 18 westoll 2 18 wcstombs 2 19 wcstoul 2 18 wcstoull 2 18 wcstoumax 2 6 wesxfrm 2 20 wctob 2 23 wctomb 2 19 wctrans 2 24 Index 11 ARM Embedded Tools Reference wctype 2 24 weak 1 11 3 45 WEOF 2 12 wmemchr 2 20 wmememp 2 20 wmemcpy 2 19 Index 12 wmemmove 2 19 wmemset 2 20 wprintf 2 15 write 2 23 wscanf 2 15 wsirftime 2 21
345. structions the assembler accepts negative values for the immediate operand If a negative value is specified the assembler inverts the instruction from ADD to SUB or vice versa For example ADD R1 4 will be rewritten as SUB R1 4 Instruction Replacement ADD Rd Rn imm SUB Rd Rn imm ADD Rad imm SUB Rd imm ADD SP 4imm SUB _ SP imm SUB Rad Rn imm ADD Rad Rn imm SUB Rd imm ADD Rad imm SUB SP 4imm ADD SP imm 3 53 ARM Embedded Tools Reference 3 54 4 Run time Environment Summary This chapter describes the startup code used by the TASKING ARM C Compiler the vector table the stack layout and the heap 4 1 Startup Code You need the run time startup code to build an executable application The default startup code consists of the following components e nitialization code This code is executed when the program is initiated and before the function main is called e Exit code This controls the closedown of the application after the program s main function terminates The startup code is part of the C library and the source is present in the file cstart asm for ARM cstart_thumb asm for Thumb or cstart_thumb2 asm for Thumb2 in the directory 1ib src This code is generic code It uses linker generated symbols which you can give target specific or application specific values These symbols are defined in the linker script file include 1sl1 arm 1s1
346. t at the end of an S record file the linker generates an S7 record which contains the program start address S7 is the corresponding termination record for S3 records Layout S 7 lt length_byte gt lt address gt lt checksum_byte gt Example S70500000000FA checksum _ address _ length The checksum calculation of S7 records is identical to SO S8 record With the linker option ofilename SREC 3 at the end of an S record file the linker generates an S8 record which contains the program start address Layout S 8 lt length_byte gt lt address gt lt checksum_byte gt Example S804FF0003F9 _ checksum _ address _ length The checksum calculation of S8 records is identical to SO S9 record With the linker option ofilename SREC 2 at the end of an S record file the linker generates an S9 record which contains the program start address S9 is the corresponding termination record for S1 records Layout S 9 lt length_byte gt lt address gt lt checksum_byte gt ARM Embedded Tools Reference Example 9030210EA _ checksum _ address _ length The checksum calculation of S9 records is identical to SO Object File Formats 7 3 Intel Hex Record Format Intel Hex records describe the hexadecimal object file format for 8 bit 16 bit and 32 bit microprocessors The hexadecimal object file is an ASCII representation of an absolute binary ob
347. t B gt gt 1 one of more occurrences of B IDENTIFIER a character sequence starting with a z A Z or _ Following characters may also be digits and dots STRING sequence of characters not starting with n r or t DOSTRING STRING double quoted string OCT_NUM octal number starting with a zero 06 045 DEC_NUM decimal number not starting with a zero 14 1024 HEX NUM hexadecimal number starting with Ox 0x0023 OxFFOO OCT_NUM DEC_NUM and HEX_NUM can be followed by a k kilo M mega or G giga Characters in bold are characters that occur literally Words in italics are higher order terms that are defined in the same or in one of the other sections To write comments in LSL file you can use the C style or C style ARM Embedded Tools Reference 8 3 3 Identifiers arch_name IDENTIFIER bus_name IDENTIFIER core_name IDENTIFIER derivative_name IDENTIFIER file name DQSTRING group_name IDENTIFIER mem_name IDENTIFIER proc_name IDENTIFIER section_name DQSTRING space_name IDENTIFIER stack_name section_name symbol_name DOSTRING 8 3 4 Expressions The expressions and operators in this section work the same as in ISO C number OCT_NUM DEC_NUM HEX NUM expr number symbol name unary_op expr expr binary_op expr expr expr expr expr function_call unary_op r logical NOT a
348. t Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Add the option error limit to the Additional assembler options field Command line syntax error limit number Description With this option you tell the assembler to only emit the specified maximum number of errors Without this option Same as 0 the assembler emits all errors Related information Gs 5 64 Tool Options Assembler Assembler help Menu entry Command line only Command line syntax help options Description Displays an overview of all command line options When you specify the argument options you can list detailed option descriptions Example The following invocations all display a list of the available command line options asarm asarm help asarm To see a detailed description of the available options enter asarm help options 5 65 ARM Embedded Tools Reference Assembler include directory l Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Select Build Options 3 Add a pathname in the Include Files Path field If you enter multiple paths separate them with a semicolon Command line syntax include directory path lpath Description With this option you can specify the path where your include files are located A relative path will be relative to the curr
349. t addresses when sections are concatenated An align value of n means that objects in the address space have to be aligned on n MAUs The page_size field sets the page alignment and page size in MAUs for the address space It must be a power of 2 The default value is 1 If one or more page ranges are supplied the supplied value only sets the page alignment The ranges specify the available space in each page as offsets to the page start which is aligned at the page alignment See also the page keyword in subsection Locating a group in section 8 9 2 Creating and Locating Groups of Sections With the optional direction field you can specify how all sections in this space should be located This can be either from low_to_high addresses this is the default or from high_to_low addresses The map keyword specifies how this address space maps onto an internal bus or onto another address space Mappings are described in section 8 5 4 Mappings Stacks and heaps The stack keyword defines a stack in the address space and assigns a name to it The architecture definition must contain at least one stack definition Each stack of a core architecture must have a unique name See also the stack keyword in section 8 9 3 Creating or Modifying Special Sections The stack is described in terms of a minimum size min_size and the direction in which the stack grows grows This can be either from low_to_high addresses stack grows upwards this is the default or
350. t assembly level The symbol should not be defined elsewhere and defined_symbo should be defined with static storage duration not extern or automatic Gls See assembler directive EQU in section 3 8 2 Assembler Directives in Chapter Assembly Language call near far By default functions are called with 26 bit PC relative calls This near call is directly coded into the instruction resulting in higher execution speed and smaller code size The destination address of a near call must be located within 32 MB from the program counter The other call mode is a 32 bit indirect call With far calls you can address the full range of memory The address is first loaded into a register after which the call is executed d See C compiler option call m in section 5 1 C Compiler Options in Chapter Tool Options extension isuffix Enables a language extension to specify imaginary floating point constants With this extension you can use an i suffix on a floating point constant to make the type Imaginary extern symbol Force an external reference extern assembler directive even when the symbol is not used in the module Gb See assember directive EXTERN in section 3 8 2 Assembler Directives in Chapter Assembly Language inline noinline smartinline Instead of the qualifier inline you can also use pragma inline and pragma noinline to inline a function body int w X Y Z C Language pragma inl
351. t files on the command line With option mil split you can perform application wide optimizations during the frontend phase by specifying all modules at once and still invoke the backend phase one module at a time to reduce the total compilation time Optionally you can specify another filename for the ms file the C compiler generates Without an argument the basename of the C source file is used to create the ms filename Note that if you specify a filename you have to specify one filename for every input file Related information db Control program option mil link mil split 5 26 Tool Options C Compiler C Compiler misrac Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select MISRA C 3 Select a MISRA C Standard If you select Custom MISRA C configuration 4 Inthe left pane expand the MISRA C entry and select MISRA C Rules 5 Enable or disable the individual rules Command line syntax misrac all number number Description With this option you specify to the compiler which MISRA C rules must be checked With the option misrac all the compiler checks for all supported MISRA C rules Example carm misrac 9 13 test c The compiler generates an error for each MISRA C rule 9 10 11 12 or 13 violation in file test c Related information C compiler option misrac advisory warnings C compiler opt
352. t gets the value of the location counter at the start of the directive processing If the evaluated argument is too large to be represented in a single word double word the assembler issues an error and truncates the value Example FLT FLOAT 12 457 0 27E 13 DBL DOUBLE 12 457 0 27E 13 Related information d gt DS Define Storage 3 25 ARM Embedded Tools Reference FOR ENDFOR Syntax label FOR var IN expression expression ENDFOR or label FOR var IN start TO end STEP step ENDFOR Description With the FOR ENDFOR directive you can repeat a sequence of assembly source lines with an iterator As shown by the syntax you can use the FOR ENDFOR in two ways 1 Inthe first mehod the loop is repeated as many times as the number of arguments following IN If you use the symbol var in the assembly lines between FOR and ENDFOR for each repetition the symbol var is substituted by a subsequent expression from the argument list If the argument is a null then the loop is repeated with each occurrence of the symbol var removed 2 Inthe second method the loop is repeated using the symbol var as a counter The counter passes all integer values from start to end with a step If you do not specify step the counter is increased by one for every repetition If you specify label it gets the value of the location counter at the start of the directive processing Example In the following exam
353. t option in Altium Designer but some options are only available on the command line for example in a Windows Command Prompt If there is no equivalent option in Altium Designer you can specify a command line option in Altium Designer as follows 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Assembler entry and select Miscellaneous 3 Enter one or more command line options in the Additional assembler options field Invocation syntax on the command line Windows Command Prompt To call the assembler from the command line use the following syntax asarm option file The input file must be an assembly source file asm or src Short and long option names Options can have both short and long names Short option names always begin with a single minus character long option names always begin with double minus characters You can abbreviate long option names as long as the name is unique You can mix short and long option names on the command line Options can have flags or sub options To switch a flag on use a lowercase letter or a ongflag To switch a flag off use an uppercase letter or a ongflag Separate longflags with commas The following two invocations are equivalent asarm Ogs test src asarm optimize tgenerics instr size test src When you do not specify an option a default value may become active 5 54 Tool Options Asse
354. t or Optimal alignment Command line syntax align composites alignment You can specify the following alignments n Natural alignment default o Optimal alignment Description With this option you can set the alignment for composite types structs unions and arrays Natural alignment n uses the natural alignment of the most aligned member of the composite type Optimal alignment 0 sets the alignment to 8 16 or 32 bits depending on the size of the composite type Related information J 5 3 ARM Embedded Tools Reference C Compiler call m Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Code Generation 3 Set the option Select call mode to Use 26 bit PC relative calls default or to Use 32 bit indirect calls Command line syntax call far near m f n Description To address the memory of the ARM you can use two different call modes far 32 bit indirect calls Though you can address the full range of memory the address is first loaded into a register after which the call is executed near 26 bit PC relative call The PC relative call is directly coded into the B instruction This way of calling results in higher execution speed However not the full range of memory can be addressed with near calls aN If you compile your C source with near calls but the called address cannot be reached with a near cal
355. taneously link and locate all programs for all cores available on a target board The target board may be of arbitrary complexity A simple target board may contain one standard processor with some external memory that executes one task A complex target board may contain multiple standard processors and DSPs combined with configurable IP cores loaded in an FPGA Each core may execute a different program and external memory may be shared by multiple cores LSL serves two purposes First it enables you to specify the characteristics that are of interest to the linker of your specific target board and of the cores installed on the board Second it enables you to specify how sections should be located in memory 8 2 Structure of a Linker Script File A script file consists of several definitions The definitions can appear in any order The architecture definition required In essence an architecture definition describes how the linker should convert logical addresses into physical addresses for a given type of core If the core supports multiple address spaces then for each space the linker must know how to perform this conversion In this context a physical address is an offset on a given internal or external bus Additionally the architecture definition contains information about items such as the hardware stack and the vector table This specification is normally written by Altium The architecture definition of the LSL file should not be cha
356. te therefore this is an estimation only The calculated stack size is supposed to be smaller than the actual allocated stack size If that is not the case then a warning is given Processed Files This part of the map file shows all processed files This also includes object files that are extracted from a library with the symbol that led to the extraction Link Result This part of the map file shows per object file how the link phase has mapped the sections from the various object files obj to output sections in File The name of an input object file in Section A section name and id from the input object file The number between uniquely identifies the section in Size The size of the input section out Offset The offset relative to the start of the output section out Section The resulting output section name and id out Size The size of the output section Module Local Symbols This part of the map file shows a table for each local scope within an object file Each table has three columns 1 the symbol name 2 the address of the symbol and 3 the space where the symbol resides in The table is sorted on symbol name within each space By default this part is not shown in the map file You have to turn this part on manually with linker option map file format statics module local symbols Cross References This part of the map file lists all symbols defined in the object modules and for each symbol t
357. tes the character 2 for the argument reg and the character 1 for the argument val The concatenation operator indicates to the macro preprocessor that the substitution characters for the arguments are to be concatenated with the characters r Without the operator the macro would expand as sub rreg rreg 1l which results in an assembler error invalid operand 3 47 ARM Embedded Tools Reference Example Decimal Value Operator Instead of substituting the formal arguments with the actual macro call arguments you can also use the value of the macro call arguments Consider the following source code that calls the macro MAC_A after the argument AVAL has been set to 1 AVAL SET 1 MAC A 2 AVAL If you want to replace the argument val with the value of AVAL rather than with the literal string AVAL you can use the operator and modify the macro as follows MAC_A MACRO reg val sub r reg r reg val ENDM Example Hex Value Operator The percent sign is similar to the standard decimal value operator except that it returns the hexadecimal value of a symbol Consider the following macro definition GEN_LAB MACRO LAB VAL STMT LAB SVAL STMT ENDM The macro is called after NUM has been set to 10 NUM SET 10 GEN_LAB HEX NUM NOP The macro expands as follows HEXA NOP The VAL argument is replaced by the character A which represents the hexadecimal value 10 of t
358. th the CODE16 directive you instruct the assembler to interpret subsequent instructions as 16 bit Thumb instructions using the pre UAL syntax until it encounters another mode directive or till it reaches the end of the active section This directive causes an implicit alignment of two bytes The assembler issues an error message if CODE16 is used in combination with option cpu ARMv4 The THUMB directive is the same as the CODE16 directive except that the UAL syntax is expected With the CODE32 directive you instruct the assembler to interpret subsequent instructions as 32 bit ARM instructions using the pre UAL syntax until it encounters another mode directive or till it reaches the end of the active section This directive causes an implicit alignment of four bytes The assembler issues an error message if CODE32 is used in combination with option cpu ARMv7M The ARM directive is the same as the CODE32 directive except that the UAL syntax is expected These directives are useful when you have files that contain both ARM and Thumb instructions The directive must appear before the instruction change and between a SECTION ENDSEC The default instruction set at the start of a section depends on the use of assembler option thumb Example section text code32 following instructions are ARM instructions r endsec Related information d Assembler option thumb Treat input as Thumb instructions in Section 5 2 Assemble
359. the output option at all the linker uses the default basename taskn IHEX and SREC formats If you specify the Intel Hex format or the Motorola S records format you can use the argument addr_size to specify the size of addresses in bytes record length For Intel Hex you can use the values 1 2 and 4 default For Motorola S records you can specify 2 S1 records 3 S2 records or 4 bytes S3 records default The name of the output file will be filename with the extension hex or sre and contains the code and data allocated in the default address space If they exist any other address spaces are also emitted whereas their output files are named filename_spacename hex sre Use option chip output c to create Intel Hex or Motorola S record output files for each chip defined in the LSL file suitable for loading into a PROM programmer Example To create the output file my file hex of the default address space lkarm test obj output myfile hex IHEX Related information db Linker option chip output Generate an output file for each chip 5 120 Tool Options Linker Linker strip debug S Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Disable the option Include symbolic debug information Command line syntax strip debug S Description With this option you specify not to i
360. the ELIF directive is optional ELSE the ELSE directive is optional ENDIF 3 49 ARM Embedded Tools Reference A section of a program that is to be conditionally assembled must be bounded by an IF ENDIF directive pair If the optional ELSE and or ELIF directives are not present then the source statements following the IF directive and up to the next ENDIF directive will be included as part of the source file being assembled only if the expression had a non zero result If the expression has a value of zero the source file will be assembled as if those statements between the IF and the ENDIF directives were never encountered If the ELSE directive is present and expression has a nonzero result then the statements between the IF and ELSE directives will be assembled and the statement between the ELSE and ENDIF directives will be skipped Alternatively if expression has a value of zero then the statements between the IF and ELSE directives will be skipped and the statements between the ELSE and ENDIF directives will be assembled 3 50 Assembly Language 3 10 Generic Instructions The assembler supports so called generic instructions Generic instructions are pseudo instructions no instructions from the instruction set Depending on the situation in which a generic instruction is used the assembler replaces the generic instruction with appropriate real assembly instruction s 3 10 1
361. the assembly source If you specify label it gets the value of the location counter at the start of the directive processing amp You cannot use the DS directive in sections with attribute init If you need to reserve initialized space in an init section use the BS directive instead The DSB DSH DSW and DSD directives are variants of the DS directive DSB The expression argument specifies the number of bytes to reserve DSH The expression argument specifies the number of half words to reserve one half word is16 bits DSW The expression argument specifies the number of words to reserve one word is 32 bits DSD The expression argument specifies the number of double words to reserve one double word is 64 bits Example RES DS 5 3 allocate 8 bytes Related information d BS Block Storage DB_ Define Byte DH Define Half Word DW Define Word DD Define Double Word 3 20 Assembly Language DW Syntax label DW argument argumeni Description With the Dw directive Define Word you allocate and initialize one word of memory for each argument One word is 32 bits An argument is e asingle or multiple character string constant e an expression e NULL indicated by two adjacent commas If you specify label it gets the value of the location counter at the start of the directive processing Multiple arguments are stored in sets of four bytes If an argument is NULL its corresp
362. the caller with the gathered profiling data 5 38 Tool Options C Compiler Function counters This will instrument the code to perform function call counting This is a subset of the basic Block counters Time not in combination with Block counters This will instrument the code to measure the time spent in a function This includes the time spent in all sub functions callees Static profiling With this option you do not need to run the application to get profiling results The compiler generates profiling information at compile time LN If you use the profiling option you must link the corresponding libraries too Refer to Section 5 4 Linking with Libraries in Chapter Using the Linker of the user s manual for an overview of the profiling libraries When you use Altium Designer automatically the correct libraries are linked Example carm profile block test c In this case you must link the library pbarm lib Related information d gt Chapter 3 Profiling in the user s manual 5 39 ARM Embedded Tools Reference C Compiler rename sections R Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option rename sections to the Additional C compiler options field Command line syntax rename sections name suffix f m fm R name suffix f m fm Description In
363. there is a common defined interface standard for object code to which the languages compilers assemblers conform The compiler linker shall be checked to ensure that 31 character significance and case sensitivity are supported for external identifiers Floating point implementations should comply with a defined floating point standard Language extensions 2 1 R 22 R 2 3 R 2 4 A Documentation x 3 1 R x 3 2 R x 3 3 A 3 4 R 3 5 R x 3 6 R Character sets 4 1 R 4 2 R Assembly language shall be encapsulated and isolated Source code shall only use style comments The character sequence shall not be used within a comment Sections of code should not be commented out In general it is not possible to decide whether a piece of comment is C code that is commented out or just some pseudo code Instead the following heuristics are used to detect possible C code inside a comment a line ends with or a line starts with possibly preceded by white space All usage of implementation defined behavior shall be documented The character set and the corresponding encoding shall be documented The implementation of integer division in the chosen compiler should be determined documented and taken into account All uses of the pragma directive shall be documented and explained This rule is really a documentation issue The compiler will flag all pragma directives as vi
364. timation of the stack usage Memory The names of the memory as defined in the linker script file 1s1 ARM Embedded Tools Reference Code The size of all executable sections Data The size of all non executable sections not including stacks heaps debug sections in non alloc space Reserved The total size of reserved memories reserved ranges reserved special sections stacks heaps alignment protections sections located in non alloc space debug sections In fact this size is the same as the size in the Total column minus the size of all other columns Free The free memory area addressable by this core This area is accessible for unrestricted items Total The total memory area addressable by this core Space The names of the address spaces as defined in the linker script file IsI The names are constructed of the derivative name followed by a colon the core name another colon and the space name Native used The size of sections located in this space Foreign used The size of all sections destined for located in other spaces but because of overlap in spaces consume memory in this space Stack Name The name s of the stack s as defined in the linker script file 1s1 Used An estimation of the stack usage The linker calculates the required stack size by using information CALLS directives generated by the compiler If for example recursion is detected the calculated stack size is inaccura
365. timization level in the Optimization level box If you select Custom Optimization 4 Enable the optimizations you want Command line syntax optimize flags Offlags Use the following options for predefined sets of flags optimize 0 O0 No optimization Alias for OCLTXY optimize 1 O1 Default optimization Alias for OcLtXY optimize 2 O2 All optimizations Alias for Ocltxy You can set the following flags delete unreferenced sections c C Delete unreferenced sections from the output file first fit decreasing VL Use a first fit decreasing algorithm to locate unrestricted sections in memory copytable compression t T Emit smart restrictions to reduce copy table size delete duplicate code x X Delete duplicate code sections from the output file delete duplicate data y Y Delete duplicate constant data from the output file Description With this option you can control the level of optimization the linker performs If you do not use this option optimize 1 is the default Related information d gt Section 5 8 Linker Optimizations in chapter Using the Linker of the user s manual 5 118 Tool Options Linker Linker option file f Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the Linker entry and select Miscellaneous 3 Add the option option file to the Additional linker options field Be
366. timize for speed Command line syntax tradeoff 0 1 2 3 4 t 0 1 2 3 4 Description If the compiler uses certain optimizations option optimize you can use this option to specify whether the used optimizations should optimize for more speed regardless of code size or for smaller code size regardless of speed By default the compiler optimizes for more speed tradeoff 0 AN If you have not used the option optimize the compiler uses the default optimization In this case it is still useful to specify a trade off level Related information d C compiler option optimize Specify optimization level 5 48 Tool Options C Compiler C Compiler uchar u Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Language 3 Enable the option Treat char variables as unsigned Command line syntax uchar u Description By default char is the same as specifying signed char With this option char is the same as unsigned char Related information d 5 49 ARM Embedded Tools Reference C Compiler unaligned access Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option unaligned access to the Additional C compiler options field Command line syntax unaligned
367. tion Instead of typing all options on the command line you can create an option file which contains all options and flags you want to specify With this option you specify the option file to the librarian tlb Use an option file when the command line would exceed the limits of the operating system or just to store options and save typing Option files can also be generated on the fly for example by the make utility You can specify the option f multiple times Format of an option file e Multiple arguments on one line in the option file are allowed e To include whitespace in an argument surround the argument with single or double quotes e If you want to use single quotes as part of the argument surround the argument by double quotes and vise versa This has a single quote embedded This has a double quote embedded This has a double quote and a single quote embedded When a text line reaches its length limit use a to continue the line Whitespace between quotes is preserved This is a continuation line gt This is a continuation line e Itis possible to nest command line files up to 25 levels Example Suppose the file myoptions contains the following lines x mylib lib objl obj w5 Specify the option file to the librarian tlb f myoptions This is equivalent to the following command line tlb x mylib lib objl obj w5 5 197 ARM Embedded Tools Reference Librarian
368. to generate inline code for too much code These operations are implemented as run time library functions to save code Section 2 2 Library Functions gives an overview of all library functions you can use grouped per header file A number of functions declared in wchar h are parallel to functions in other header files These are discussed together Libraries Description carm lib C library for ARM and Thumb instructions repectively cthumb lib some functions also need the floating point library carms lib Single precision C library cthumbs lib some functions also need the floating point library fparm t lib Floating point library fpthumbft lib t trapping version rtarm lib Run time library rtthumb lib pbarm lib Profiling libraries pb block function counter pbthumb lib pc call graph pcarm lib pct call graph and timing pcthumb lib pd dummy pctarm lib pt function timing pctthumb lib pdarm lib pdthumb ib ptarm lib ptthumb lib Table 2 1 Overview of libraries 2 1 ARM Embedded Tools Reference 2 2 Library Functions The following sections list all library functions grouped per header file in which they are declared Some functions are not completely implemented because their implementation depends on the context where your application will run These functions are for example all I O related functions Where possible these functions are implemented using file system simul
369. to the standard C language the compiler supports the following e intrinsic built in functions that result in target specific assembly instructions e pragmas to control the compiler from within the C source e predefined macros e the possibility to use assembly instructions in the C source e attribute to specify absolute addresses e keywords for inlining functions and programming interrupt routines e libraries All non standard keywords have two leading underscores _ In this chapter the target specific characteristics of the C language are described including the above mentioned extensions 1 1 ARM Embedded Tools Reference 1 2 Data Types The TASKING C compiler for the ARM architecture carm supports the following data types Size Align ram Type C Type bit bit Limits Boolean _Bool 8 8 Oori Character uone 8 8 27 27 4 signed char unsigned char 8 8 0 28 1 Integral aE 16 16 215 _215_4 signed short unsigned short 16 16 o 216 1 enum 32 32 231 231_4 int oo 32 32 231 231 1 long signed long ee ee 32 32 0 232 1 unsigned long aes long 64 64 263 963_4 signed long long unsigned long long 64 64 0 264 1 Pointer pointer to function or data 32 32 0 282 4 Floating Point 3 402E 38 1 175E 38 float 23 bit mantissa 32 32 1 175E 38 3 402E 38 double 64 64 1 798E 308 2 225E 308 long double 52 bit mantissa 2 225E 308 1 798
370. u specify p without flags the default is pBCfST block b B block counters callgraph c C call graph function f F function counters static s S static profile generation time t T function timers Description Profiling is the process of collecting statistical data about a running application With these data you can analyze which functions are called how often they are called and what their execution time is Several methods of profiling exist One method is code instrumentation which adds code to your application that takes care of the profiling process when the application is executed d For an extensive description of profiling refer to Chapter 3 Profiling in the user s manual With this option the compiler adds the extra code to your application that takes care of the profiling process You can obtain the following profiling data see flags above Block counters not in combination with Call graph or Time This will instrument the code to perform basic block counting As the program runs it counts the number of executions of each branch in an if statement each iteration of a for loop and so on Note that though you can combine Block counters with Function counters this has no effect because Function counters is only a subset of Block counters Call graph not in combination with Block counters This will instrument the code to reconstruct the run time call graph As the program runs it associates
371. ualifier frame can specify which registers and SFRs must be saved for a particular interrupt function Only the specified registers will be pushed and popped from the stack If you do not specify the function qualifier __frame the C compiler determines which registers must be pushed and popped The syntax is void _ interrupt_xxx __frame reg reg isr void where reg can be any register defined as an SFR The compiler generates a warning if some registers are missing which are normally required to be pushed and popped in an interrupt function prolog and epilog to avoid run time problems 1 19 ARM Embedded Tools Reference Example __interrupt_irq _ frame R4 R5 R6 void alarm void 1 9 Libraries The TASKING compilers come with standard C libraries ISO IEC 9899 1999 and header files with the appropriate prototypes for the library functions All standard C libraries are available in object format and in C or assembly source code A number of standard operations within C are too complex to generate inline code for too much code These operations are implemented as run time library functions to save code db See section 2 2 Library Functions in Chapter Libraries for an extensive description of all standard C library functions 1 9 1 Printf and Scanf Routines The C library functions printf fprintf viprintf vsprintf call one single function doprint that deals with the format string an
372. ude directory path Ipath Description With this option you can specify the path where your LSL include files are located A relative path will be relative to the current directory The order in which the linker searches for LSL include files is 1 The pathname in the LSL file and the directory where the LSL file is located only for include files that are enclosed in 2 The path that is specified with this option 3 The default directory PRODDIR include 1sl Example Suppose that your linker script file my1s1 1s1 contains the following line include myinc inc You can call the linker as follows lkarm include directory c proj include lsl file mylsl 1sl test obj First the linker looks in the directory where my1s1 1s1 is located for the file myinc inc If it does not find the file it looks in the directory c proj include for the file myinc inc this option Finally it looks in the directory PRODDIR include 1sl Related information ie 5 101 ARM Embedded Tools Reference Linker incremental r Menu entry Command line syntax incremental r Description Normally the linker links and locates the specified object files With this option you tell the linker only to link the specified files The linker creates a linker output file out You then can link this file again with other object files until you have reached the final linker output file that is ready for locating
373. uld compile The architecture determines which instructions are valid and which are not The effect of this option is that the compiler uses the appropriate instruction set You choose one of the following architectures ARMv4 ARMv4T ARMv5T ARMV5TE ARMv6 M ARMv7 M or XScale Example To compile the file test c for the ARMv4 processor type enter the following on the command line carm cpu ARMv4 test c The compiler compiles for the chosen processor type When you call the compiler from the command line make sure you specify the same core type to the assembler to avoid conflicts Related information ie 5 6 Tool Options C Compiler C Compiler debug info g Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Debug Information 3 Enable the option Generate symbolic debug information 4 Enable or disable the suboptions Command line syntax debug info suboption You can set the following suboptions when you specify g without suboption the default is ga call frame c Generate call frame information only all a Generate all debug information Description With this option you tell the compiler to add directives to the output file for including symbolic information This facilitates high level debugging but increases the size of the resulting assembler file and thus the size of the object file For the fina
374. unters this has no effect because Function counters is only a subset of Block counters Call graph not in combination with Block counters This will instrument the code to reconstruct the run time call graph As the program runs it associates the caller with the gathered profiling data Function counters This will instrument the code to perform function call counting This is a subset of the basic Block counters Time not in combination with Block counters This will instrument the code to measure the time spent in a function This includes the time spent in all sub functions callees N Note that the more detailled information you request the larger the overhead in terms of execution time code size and heap space needed The option Generate Debug information g or debug does not affect profiling execution time or code size aN The control program automatically specifies the corresponding profiling libraries to the linker Example To generate block count information for the module test c during execution compile as follows ccarm profile block test c In this case the library pbarm lib is linked 5 158 Tool Options Control Program Related information db Chapter 3 Profiling in the user s manual 5 159 ARM Embedded Tools Reference Control Program signed bitfields Command line syntax signed bitfields Description For bit fields it depends on the implementation whether a plain int is treat
375. uses for more information on how to specify the external physical memory layout Internal memory for a processor should be defined in the derivative definition for that processor The board specification The processor definition and memory and bus definitions together form a board specification LSL provides language constructs to easily describe single core and heterogeneous or homogeneous multi core systems The board specification describes all characteristics of your target board s system buses memory devices I O sub systems and cores that are of interest to the linker Based on the information provided in the board specification the linker can for each core e convert a logical address to an offset within a memory device e locate sections in physical memory e maintain an overall view of the used and free physical memory within the whole system while locating The section layout definition optional The optional section layout definition enables you to exactly control where input sections are located Features are provided such as the ability to place sections at a given load address or run time address to place sections in a given order and to overlay code and or data sections Which object files Sections constitute the task that will run on a given core is specified on the command line when you invoke the linker The linker will link and locate all sections of all tasks simultaneously From the section layout definition the linker
376. ut not necessarily adjacent Suppose you have an ordered group that contains the sections A B and C By default the linker places the sections in the address space like A B C where section A gets the lowest possible address With direction high_to_lowin the section_layout space properties the linker places the sections in the address space like C B A where section A gets the highest possible address The contiguous keyword tells the linker to locate the sections in the group in a single address range Within a contiguous group the input sections are located in arbitrary order however the group occupies one contigous range of memory Due to alignment of sections there can be alignment gaps between the sections When you define a group that is both ordered and contiguous this is called a sequential group In a sequential group the linker places sections in the same order in the address space as they appear in the group and it occupies a contiguous range of memory The clustered keyword tells the linker to locate the sections in the group in a number of contiguous blocks It tries to keep the number of these blocks to a minimum If enough memory is available the group will be located as if it was specified as contiguous Otherwise it gets split into two or more blocks If a contiguous or clustered group contains alignment gaps the linker can locate sections that are
377. ution string that was previously defined with the DEFINE directive Related information Gb DEFINE Define substitution string 3 44 Assembly Language WEAK Syntax WEAK symbol symbol Description With the WEAK directive you mark one or more symbols as weak The symbol can be defined in the same module with the GLOBAL directive or the EXTERN directive If the symbol does not already exist it will be created A weak external reference is resolved by the linker when a global or weak definition is found in one of the object files However a weak reference will not cause the extraction of a module from a library to resolve the reference You can overrule a weak definition with a GLOBAL definition in another module The linker will not complain about the duplicate definition and ignore the weak definition Only program labels and symbols defined with EQU can be made weak Example LOOPA EQU 1 definition of symbol LOOPA GLOBAL LOOPA LOOPA will be globally accessible by other modules WEAK LOOPA mark symbol LOOPA as weak se Related information d gt EXTERN Import global section symbol GLOBAL Declare global section symbol 3 45 ARM Embedded Tools Reference 3 9 Macro Operations Macros provide a shorthand method for inserting a repeated pattern of code or group of instructions You can define the pattern as a macro and then call the macro at the points in the program w
378. utwc 2 16 fputws 2 16 fread 2 16 free 2 7 2 18 freopen 2 13 frexp functions 2 8 fscanf 2 15 fseek 2 16 fsetpos 2 17 fstat 2 23 ftell 2 17 Function syntax 3 5 Function inlining 1 15 Function qualifiers __frame 1 19 __interrupt 1 18 __interrupt_dabt 1 18 __interrupt_fiq 1 18 __interrupt_iabt 1 18 __interrupt_irg 1 18 __interrupt_svc 1 18 __interrupt_und 1 18 __nesting_enabled 1 19 __novector 1 19 fwprintf 2 15 fwrite 2 16 fwscanf 2 15 G Generic instructions 3 1 3 51 getc 2 16 getchar 2 16 getcwd 2 22 getenv 2 18 gets 2 16 getwc 2 16 Index 5 ARM Embedded Tools Reference getwchar 2 16 global 3 27 gmtime 2 21 H Header files 2 2 alert h 2 2 complex h 2 2 ctype h 2 3 dbg h 2 4 errno h 2 4 fentl h 2 5 fenv h 2 5 float h 2 5 inttypes h 2 5 io h 2 6 iso646 h 2 6 limits h 2 6 locale h 2 6 malloc h 2 7 math h 2 7 setjimp h 2 10 signal h 2 11 stdarg h 2 11 stdbool h 2 11 stddef h 2 11 stdint h 2 5 stdio h 2 12 stdlib h 2 17 string h 2 19 tgmath h 2 7 time h 2 20 unistd h 2 22 wehar h 2 12 2 19 2 20 2 23 wetype h 2 3 2 24 Heap 8 16 begin of 4 6 end of 4 6 hypot functions 2 9 l if elif else endif 3 28 ilogb functions 2 8 imaginary 2 2 imaxabs 2 5 imaxdiv 2 5 include 3 29 Include directory 5 16 5 31 5 66 5 101 5 140 Include file 5 17 5 67 Inline assembly __asm 1 4 Inline functions
379. would indicate a new option Related information C compiler option undefine Undefine preprocessor macro C compiler option option file Read options from file 5 9 ARM Embedded Tools Reference C Compiler dep file Menu entry 1 From the Project menu select Project Options The Project Options dialog box appears 2 Expand the C Compiler entry and select Miscellaneous 3 Add the option dep file to the Additional C compiler options field Command line syntax dep file file Description With this option you tell the compiler to generate dependency lines that can be used in a Makefile In contrast to the option preprocess make Em the dependency information will be generated in addition to the normal output file By default the information is written to a file with extension d one for every input file When you specify a filename all dependencies will be combined in the specified file Example carm dep file test dep test c The compiler compiles the file test c which results in the output file test src and generates dependency lines in the file test dep Related information db C compiler option preprocess make Generate dependencies for make Tool Options C Compiler C Compiler diag Menu entry 1 From the View menu select Workspace Panels System Messages The Message pannel appears 2 In the Message panel right click on the message you want more information on
380. xing shall be the only allowed form of pointer arithmetic The declaration of objects should contain no more than 2 levels of pointer indirection A violation is reported when a pointer with three or more levels of indirection is declared The address of an object with automatic storage shall not be assigned to another object that may persist after the first object has ceased to exist Structures and unions 18 1 18 2 x 18 3 18 4 R R R R All structure or union types shall be complete at the end of a translation unit An object shall not be assigned to an overlapping object An area of memory shall not be reused for unrelated purposes Unions shall not be used Preprocessing directives 19 1 19 2 x 19 3 19 4 19 5 19 6 19 7 19 8 jae e ee 2 include statements in a file should only be preceded by other preprocessor directives or comments Non standard characters should not occur in header file names in include directives The include directive shall be followed by either a lt filename gt or filename sequence C macros shall only expand to a braced initializer a constant a parenthesized expression a type qualifier a storage class specifier or a do while zero construct Macros shall not be define d or undef d within a block undef shall not be used A function should be used in preference to a function like macro A function like macro shall not be invoked without all of its arguments
381. xpr gt l 1 argument_list expr lt expr gt 0 arch_spec bus_def space def endianness_ def space _def space space_name lt space_descr gt e Aspace_def defines an address space with the given space_name as a unique name within an architecture 8 7 ARM Embedded Tools Reference space_descr space property section_definition no space ref vector table statement reserved_range space property id number as used in object mau expr align expr page_size expr lt range lt range gt 0 gt 0 1 page direction direction stack_def heap_def copy_table def start_address mapping e Aspace_def contains exactly one id and one mau statement e Aspace_def contains at most one align statement e Aspace_def contains at most one page_size statement e Aspace_def contains at least one mapping stack_def stack stack_name stack_heap_descr lt stack_heap descr gt gt e Astack_def defines a stack with the stack_name as a unique name heap_def heap heap name stack_heap_descr lt stack_heap_descr gt gt 0 e A heap def defines a heap with the heap_name as a unique name stack_heap_descr min_size expr grows direction align expr fixed id expr e The min_size statement must be present e You can specify at most one align statement and one grows statement e Each stack definition has its own unique id the number specified cor
382. ymbol LOOPA GLOBAL LOOPA LOOPA will be globally accessible by other modules Related information dE EXTERN Import global section symbol 3 27 ARM Embedded Tools Reference IF ELIF ELSE ENDIF Syntax IF expression ELIF expression the ELIF directive is optional ELSE the ELSE directive is optional ENDIF Description With the IF ENDIF directives you can create a part of conditional assembly code The assembler assembles only the code that matches a specified condition The expression must evaluate to an integer and cannot contain forward references If expression evaluates to zero the IF condition is considered FALSE any non zero result of expression is considered as TRUE You can nest IF directives to any level The ELSE and ELIF directive always refer to the nearest previous IF directive Example Suppose you have an assemble source file with specific code for a test version for a demo version and for the final version Within the assembly source you define this code conditionally as follows IF TEST code for the test version ELIF DEMO code for the demo version ELSE code for the final version ENDIF Before assembling the file you can set the values of the symbols TEST and DEMO in the assembly source before the IF directive is reached For example to assemble the demo version TEST SET 0 DEMO SET 1 You can also define the symbols in Altium Designer as preproc
383. yntax warnings as errors number Description If one of the tools encounters an error it stops processing the file s With this option you tell the tools to treat warnings as errors or treat specific C compiler warning messages as errors e If you specify this option but without numbers all warnings are treated as errors e If you specify this option with a number only the specified C compiler warning is treated as an error You can specify the option warnings as errors number multiple times Related information d gt Control Program option no warnings Suppress all warnings 5 167 ARM Embedded Tools Reference 5 5 Make Utility Options When you build a project in Altium Designer Altium Designer generates a makefile and uses the make utility tmk to build all your files However you can also use the make utility directly from the command line to build your project The invocation syntax is tmk option target macro def This section describes all options for the make utility The make utility is a command line tool so there are no equivalent options in Altium Designer 5 168 Tool Options Make Utility Defining Macros Command line syntax macro definition Description With this argument you can define a macro and specify it to the make utility A macro definition remains in existence during the execution of the makefile even when the makefile recursively calls the make utility again In
384. ypes for memory allocation functions This include file is not defined in ISO C99 it is included for backwards compatibility with ISO C90 For ISO C99 the memory allocation functions are part of stdlib h See section 2 2 23 sidlib h and wchar h malloc size Allocates space for an object with size size The allocated space is not initialized Returns a point er to the allocated space calloc nobj size Allocates space for n objects with size size The allocated space is initialized with zeros Returns a pointer to the allocated space free ptr Deallocates the memory space pointed to by pir which should be a pointer earlier returned by the malloc or calloc function realloc ptr size Deallocates the old object pointed to by ptr and returns a pointer to a niew object with size size The new object cannot have a size larger than the previous object 2 2 15 math h and tgmath h The header file math h contains the prototypes for many mathematical functions Before ISO C99 all functions were computed using the double type the float was automatically converted to double prior to calculation In this ISO C99 version parallel sets of functions are defined for double float and long double They are respectively named function function function1 All long type functions though declared in math h are implemented as the double type variant which nearly always meets the requirement in embedded applications The header file tgmath h contain
385. yword size you specify the fixed size of the output section Input sections are placed from output section start towards higher addresses offsets When the end of the output section is reached and one or more input sections are not yet placed an error is emitted If however the overflow field is set to another output section remaining sections are located as if they were selected for the overflow output section 8 31 ARM Embedded Tools Reference group section tskl_ data size 4k attributes rw f1i11 0 overflow overflow_data select data tsk1 section tsk2 data size 4k attributes rw f1i11 0 overflow overflow_data select data tsk2 section overflow data size 4k attributes rx i11 0 With the keyword blocksize the size of the output section will adapt to the size of its content For example group flash_area run_addr 0x10000 section flash_code blocksize 4k attributes rx i11 0 select flash If the content of the section is 1 mau the size will be 4k if the content is 11k the section will be 12k etc If you use size in combination with blocksize the size value is used as default minimal size for this section If it is omitted the default size will be of blocksize It is not allowed to omit both size and blocksize from the section definition The linker creates two labels to mark the begin and end of the section _1

TR0131 ARM Embedded Tools Reference

Contents

Download Pdf Manuals

Related Search

Related Contents