diff options
author | gjl <gjl@138bc75d-0d04-0410-961f-82ee72b054a4> | 2011-10-24 14:55:45 +0000 |
---|---|---|
committer | gjl <gjl@138bc75d-0d04-0410-961f-82ee72b054a4> | 2011-10-24 14:55:45 +0000 |
commit | b44eaceb1855c7f61ce071104233cd88e70c7f04 (patch) | |
tree | eae9e83ef5822ba97e749fab6609431437d77f9b /gcc/doc | |
parent | 6b9de3d44811008ad9804cb670e4171cf470277e (diff) | |
download | gcc-b44eaceb1855c7f61ce071104233cd88e70c7f04.tar.gz |
PR target/49824
Backport from mainline r180385
* doc/extend.texi (Declaring Attributes of Functions):
Document OS_main and OS_task attributes.
(Specifying Attributes of Variables): Move up
subsection "AVR Variable Attributes" as of alphabetical order.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/branches/gcc-4_6-branch@180390 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'gcc/doc')
-rw-r--r-- | gcc/doc/extend.texi | 50 |
1 files changed, 40 insertions, 10 deletions
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi index c7714361fbb..be1c32cc1d5 100644 --- a/gcc/doc/extend.texi +++ b/gcc/doc/extend.texi @@ -3029,6 +3029,33 @@ compiled with more aggressive optimization options that produce faster and larger code, while other functions can be called with less aggressive options. +@item OS_main/OS_task +@cindex @code{OS_main} AVR function attribute +@cindex @code{OS_task} AVR function attribute +On AVR, functions with the @code{OS_main} or @code{OS_task} attribute +do not save/restore any call-saved register in their prologue/epilogue. + +The @code{OS_main} attribute can be used when there @emph{is +guarantee} that interrupts are disabled at the time when the function +is entered. This will save resources when the stack pointer has to be +changed to set up a frame for local variables. + +The @code{OS_task} attribute can be used when there is @emph{no +guarantee} that interrupts are disabled at that time when the function +is entered like for, e@.g@. task functions in a multi-threading operating +system. In that case, changing the stack pointer register will be +guarded by save/clear/restore of the global interrupt enable flag. + +The differences to the @code{naked} function attrubute are: +@itemize @bullet +@item @code{naked} functions do not have a return instruction whereas +@code{OS_main} and @code{OS_task} functions will have a @code{RET} or +@code{RETI} return instruction. +@item @code{naked} functions do not set up a frame for local variables +or a frame pointer whereas @code{OS_main} and @code{OS_task} do this +as needed. +@end itemize + @item pcs @cindex @code{pcs} function attribute @@ -4517,6 +4544,19 @@ The @code{dllexport} attribute is described in @ref{Function Attributes}. @end table +@subsection AVR Variable Attributes + +@table @code +@item progmem +@cindex @code{progmem} AVR variable attribute +The @code{progmem} attribute is used on the AVR to place data in the program +memory address space (flash). This is accomplished by putting +respective variables into a section whose name starts with @code{.progmem}. + +AVR is a Harvard architecture processor and data and reas only data +normally resides in the data memory address space (RAM). +@end table + @subsection Blackfin Variable Attributes Three attributes are currently defined for the Blackfin. @@ -4786,16 +4826,6 @@ placed in either the @code{.bss_below100} section or the @end table -@subsection AVR Variable Attributes - -@table @code -@item progmem -@cindex @code{progmem} variable attribute -The @code{progmem} attribute is used on the AVR to place data in the Program -Memory address space. The AVR is a Harvard Architecture processor and data -normally resides in the Data Memory address space. -@end table - @node Type Attributes @section Specifying Attributes of Types @cindex attribute of types |