From 39ff13375dd2a79fe6af76d82636e8503513a099 Mon Sep 17 00:00:00 2001 From: Georg-Johann Lay Date: Tue, 20 Feb 2024 13:46:30 +0100 Subject: [PATCH] AVR: extend.texi - Use @defbuiltin to document built-ins. gcc/ * doc/extend.texi (AVR Built-in Functions): Use @defbuiltin instead of @table. --- gcc/doc/extend.texi | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi index e048404dffe..b2383b55666 100644 --- a/gcc/doc/extend.texi +++ b/gcc/doc/extend.texi @@ -16782,37 +16782,41 @@ or if not a specific built-in is implemented or not. For example, if @code{__builtin_avr_nop} is available the macro @code{__BUILTIN_AVR_NOP} is defined to @code{1} and undefined otherwise. -@table @code +@defbuiltin{void __builtin_avr_nop (void)} +@defbuiltinx{void __builtin_avr_nop (void)} +@defbuiltinx{void __builtin_avr_sei (void)} +@defbuiltinx{void __builtin_avr_cli (void)} +@defbuiltinx{void __builtin_avr_sleep (void)} +@defbuiltinx{void __builtin_avr_wdr (void)} +@defbuiltinx{{unsigned char} __builtin_avr_swap (unsigned char)} +@defbuiltinx{{unsigned int} __builtin_avr_fmul (unsigned char, unsigned char)} +@defbuiltinx{int __builtin_avr_fmuls (char, char)} +@defbuiltinx{int __builtin_avr_fmulsu (char, unsigned char)} -@item void __builtin_avr_nop (void) -@itemx void __builtin_avr_sei (void) -@itemx void __builtin_avr_cli (void) -@itemx void __builtin_avr_sleep (void) -@itemx void __builtin_avr_wdr (void) -@itemx unsigned char __builtin_avr_swap (unsigned char) -@itemx unsigned int __builtin_avr_fmul (unsigned char, unsigned char) -@itemx int __builtin_avr_fmuls (char, char) -@itemx int __builtin_avr_fmulsu (char, unsigned char) These built-in functions map to the respective machine instruction, i.e.@: @code{nop}, @code{sei}, @code{cli}, @code{sleep}, @code{wdr}, @code{swap}, @code{fmul}, @code{fmuls} resp. @code{fmulsu}. The three @code{fmul*} built-ins are implemented as library call if no hardware multiplier is available. -@item void __builtin_avr_delay_cycles (unsigned long ticks) +@enddefbuiltin + +@defbuiltin{void __builtin_avr_delay_cycles (unsigned long @var{ticks})} Delay execution for @var{ticks} cycles. Note that this built-in does not take into account the effect of interrupts that might increase delay time. @var{ticks} must be a compile-time integer constant; delays with a variable number of cycles are not supported. +@enddefbuiltin -@item char __builtin_avr_flash_segment (const __memx void*) +@defbuiltin{char __builtin_avr_flash_segment (const __memx void*)} This built-in takes a byte address to the 24-bit @ref{AVR Named Address Spaces,address space} @code{__memx} and returns the number of the flash segment (the 64 KiB chunk) where the address points to. Counting starts at @code{0}. If the address does not point to flash memory, return @code{-1}. +@enddefbuiltin -@item uint8_t __builtin_avr_insert_bits (uint32_t map, uint8_t bits, uint8_t val) +@defbuiltin{uint8_t __builtin_avr_insert_bits (uint32_t @var{map}, uint8_t @var{bits}, uint8_t @var{val})} Insert bits from @var{bits} into @var{val} and return the resulting value. The nibbles of @var{map} determine how the insertion is performed: Let @var{X} be the @var{n}-th nibble of @var{map} @@ -16856,12 +16860,12 @@ __builtin_avr_insert_bits (0xffff3210, bits, val); // reverse the bit order of bits __builtin_avr_insert_bits (0x01234567, bits, 0); @end smallexample +@enddefbuiltin -@item void __builtin_avr_nops (unsigned count) +@defbuiltin{void __builtin_avr_nops (unsigned @var{count})} Insert @var{count} @code{NOP} instructions. The number of instructions must be a compile-time integer constant. - -@end table +@enddefbuiltin @noindent There are many more AVR-specific built-in functions that are used to