Apply formatting rules [nfc]

vendor/jnk0le-AVR-UART-lib/usart_config.h

@@ -8,51 +8,93 @@
 #ifndef USART_CONFIG_H_
 #define USART_CONFIG_H_
 
-// DO NOT DEFINE F_CPU, BUFFERS SIZES OR ANY OTHER SHARED MACROS IN 'main.c' CODE
+// DO NOT DEFINE F_CPU, BUFFERS SIZES OR ANY OTHER SHARED MACROS IN 'main.c'
-// instead of this, define it in makefile (-D flag) or "Project Properties -> AVR C Compiler -> Symbols"
+// CODE instead of this, define it in makefile (-D flag) or "Project Properties
+// -> AVR C Compiler -> Symbols"
 
 // #define NO_USART_RX // disable all receiver code and dependencies
 // #define NO_USART_TX // disable all transmitter code and dependencies
 
-//#define USART_MPCM_MODE // globally enable MPCM operation mode // 9 bit data frame only // always set frame format to 8 data bits
+// #define USART_MPCM_MODE // globally enable MPCM operation mode // 9 bit data
+// frame only // always set frame format to 8 data bits
 
-//#define USE_DOUBLE_SPEED // enables double speed for all available USART interfaces
+// #define USE_DOUBLE_SPEED // enables double speed for all available USART
+// interfaces
 
-#define RX_STDIO_GETCHAR_ECHO // echoes back received characters in getchar() function (for reading in scanf())
+#define RX_STDIO_GETCHAR_ECHO // echoes back received characters in getchar()
+                              // function (for reading in scanf())
 // #define RX_GETC_ECHO // echoes back received characters in getc() function
 
-//#define PUTC_CONVERT_LF_TO_CRLF // allow for unix style (\n only) newline terminator in stored strings // not included into putc_noblock
+// #define PUTC_CONVERT_LF_TO_CRLF // allow for unix style (\n only) newline
+// terminator in stored strings // not included into putc_noblock
 #define RX_NEWLINE_MODE 2 // 0 - \r,  1 - \n,  2 - \r\n
-// lot of terminals sends only \r character as a newline terminator, instead of \r\n or even unix style \n
+// lot of terminals sends only \r character as a newline terminator, instead of
-// (BTW PuTTY doesn't allow to change this) but in return requires \r\n terminator to show not broken text
+// \r\n or even unix style \n (BTW PuTTY doesn't allow to change this) but in
+// return requires \r\n terminator to show not broken text
 
-//#define USART_NO_ABI_BREAKING_PREMATURES // do not use prematures that might break compilers ABI (non-gcc calling conventions), compilers that are not forcing constant number of call-used registers might generate even better code
+// #define USART_NO_ABI_BREAKING_PREMATURES // do not use prematures that might
-//#define USART_PUTHEX_IN_UPPERCASE // use uppercase letters in uart_puthex() function
+// break compilers ABI (non-gcc calling conventions), compilers that are not
-//#define USART_EXTEND_RX_BUFFER // extend RX buffer by hardware 2/3 byte FIFO // required for hardware and software RTS
+// forcing constant number of call-used registers might generate even better
-//#define USART_PUTC_FAST_INSERTIONS // skip FIFO procedure and write directly data to the UDR register when possible // probably required for full bus utilization at highest speed (f_cpu/8)
+// code
-//#define USART_NO_LOCAL_BUFFERS // do not allocate temporary buffers on stack for integer/float <-> asci conversions and use globally visible u_tmp_buff[] instead // it have to be declared in application part and have to be at least of 6-17 bytes wide (depending on what is being converted)
-//#define USART_UNSAFE_TX_INTERRUPT // max 19 cycles of interrupt latency // 3+PC bytes on stack // will not interrupt itself
-//#define USART_UNSAFE_RX_INTERRUPT // max 23 cycles of interrupt latency // 4+PC bytes on stack // will not interrupt itself
-//#define USART_REMAP_LAST_INTERFACE // remap hardware registers of USART1/2/3 to USART0 if only one interface is used
-//#define USART_SKIP_UBRRH_IF_ZERO // do not generate code for writing to ubrrh if calculated value is zero // prematures out 2 bytes if ubrr is compile time constant
 
-//#define USART_USE_GLOBALLY_RESERVED_ISR_SREG_SAVE // prematures out 4 cycles from every isr run // requires one globally reserved lower register
+// #define USART_PUTHEX_IN_UPPERCASE // use uppercase letters in uart_puthex()
-//#define USART_USE_GLOBALLY_RESERVED_ISR_Z_SAVE    // prematures out 6 cycles from every isr run // requires pair of globally reserved lower registers
+// function
-// usage of globally reserved register for temporary storage in interrupts, should be combined with other interrupts for best results. 
-// special care have to be taken when doing so, since those registers can still be used by other compilation units (fixable in gcc by -ffixed-n flag, where n is a suppressed register),
-// precompiled libraries (vprintf, vscanf, qsort, strtod, strtol, strtoul), or even assembly hardcoded libraries (fft, aes).
-// registers r2-r7 should be used instead of the higher ones, since those are never used by gcc for eg. argument passing.
 
-	#define USART_SREG_SAVE_REG_NAME G_sreg_save // ??? // have to be redeclared under the same name if the same registers are reused in other instances (libs)
+// #define USART_EXTEND_RX_BUFFER // extend RX buffer by hardware 2/3 byte FIFO
+// // required for hardware and software RTS
+
+// #define USART_PUTC_FAST_INSERTIONS // skip FIFO procedure and write directly
+// data to the UDR register when possible // probably required for full bus
+// utilization at highest speed (f_cpu/8)
+
+// #define USART_NO_LOCAL_BUFFERS // do not allocate temporary buffers on stack
+// for integer/float <-> asci conversions and use globally visible u_tmp_buff[]
+// instead // it have to be declared in application part and have to be at least
+// of 6-17 bytes wide (depending on what is being converted)
+
+// #define USART_UNSAFE_TX_INTERRUPT // max 19 cycles of interrupt latency //
+// 3+PC bytes on stack // will not interrupt itself
+
+// #define USART_UNSAFE_RX_INTERRUPT // max 23 cycles of interrupt latency //
+// 4+PC bytes on stack // will not interrupt itself
+
+// #define USART_REMAP_LAST_INTERFACE // remap hardware registers of USART1/2/3
+// to USART0 if only one interface is used
+
+// #define USART_SKIP_UBRRH_IF_ZERO // do not generate code for writing to ubrrh
+// if calculated value is zero // prematures out 2 bytes if ubrr is compile time
+// constant
+
+// #define USART_USE_GLOBALLY_RESERVED_ISR_SREG_SAVE // prematures out 4 cycles
+// from every isr run // requires one globally reserved lower register
+
+// #define USART_USE_GLOBALLY_RESERVED_ISR_Z_SAVE    // prematures out 6 cycles
+// from every isr run // requires pair of globally reserved lower registers
+//  usage of globally reserved register for temporary storage in interrupts,
+//  should be combined with other interrupts for best results. special care have
+//  to be taken when doing so, since those registers can still be used by other
+//  compilation units (fixable in gcc by -ffixed-n flag, where n is a suppressed
+//  register), precompiled libraries (vprintf, vscanf, qsort, strtod, strtol,
+//  strtoul), or even assembly hardcoded libraries (fft, aes). registers r2-r7
+//  should be used instead of the higher ones, since those are never used by gcc
+//  for eg. argument passing.
+
+#define USART_SREG_SAVE_REG_NAME                                               \
+  G_sreg_save // ??? // have to be redeclared under the same name if the same
+              // registers are reused in other instances (libs)
 #define USART_SREG_SAVE_REG_NUM "r4"
 
-	#define USART_Z_SAVE_REG_NAME G_z_save // ??? // have to be redeclared under the same name if the same registers are reused in other instances (libs)
+#define USART_Z_SAVE_REG_NAME                                                  \
-	#define USART_Z_SAVE_REG_NUM "r2" // register pair rn and rn+1 (rn+1:rn gives "invalid register name")
+  G_z_save // ??? // have to be redeclared under the same name if the same
+           // registers are reused in other instances (libs)
+#define USART_Z_SAVE_REG_NUM                                                   \
+  "r2" // register pair rn and rn+1 (rn+1:rn gives "invalid register name")
 
-//#define RX_BUFFER_SIZE 128 // Size of the ring buffers, must be power of 2 // default 32
+// #define RX_BUFFER_SIZE 128 // Size of the ring buffers, must be power of 2 //
-//#define TX_BUFFER_SIZE 64 // Size of the ring buffers, must be power of 2 // default 32
+// default 32 #define TX_BUFFER_SIZE 64 // Size of the ring buffers, must be
+// power of 2 // default 32
 
-/*****************************config for multiple USART mcu's***********************************/
+/*******************config for multiple USART * mcu's*************************/
 
 // #define NO_USART0 // disable usage of uart0
 // #define NO_USART1 // disable usage of uart1
@@ -71,15 +113,19 @@
 // #define RX3_BUFFER_SIZE 128
 // #define TX3_BUFFER_SIZE 64
 
-//#define NO_RX0_INTERRUPT // removes whole receive code (including ISR) and frees RX0 pin // combining with NO_USART_RX is not necessary
+// #define NO_RX0_INTERRUPT // removes whole receive code (including ISR) and
-//#define NO_RX1_INTERRUPT // removes whole receive code (including ISR) and frees RX1 pin
+// frees RX0 pin // combining with NO_USART_RX is not necessary #define
-//#define NO_RX2_INTERRUPT // removes whole receive code (including ISR) and frees RX2 pin
+// NO_RX1_INTERRUPT // removes whole receive code (including ISR) and frees RX1
-//#define NO_RX3_INTERRUPT // removes whole receive code (including ISR) and frees RX3 pin
+// pin #define NO_RX2_INTERRUPT // removes whole receive code (including ISR)
+// and frees RX2 pin #define NO_RX3_INTERRUPT // removes whole receive code
+// (including ISR) and frees RX3 pin
 
-//#define NO_TX0_INTERRUPT // removes whole transmit code (including ISR) and frees TX0 pin // combining with NO_USART_TX is not necessary
+// #define NO_TX0_INTERRUPT // removes whole transmit code (including ISR) and
-//#define NO_TX1_INTERRUPT // removes whole transmit code (including ISR) and frees TX1 pin
+// frees TX0 pin // combining with NO_USART_TX is not necessary #define
-//#define NO_TX2_INTERRUPT // removes whole transmit code (including ISR) and frees TX2 pin
+// NO_TX1_INTERRUPT // removes whole transmit code (including ISR) and frees TX1
-//#define NO_TX3_INTERRUPT // removes whole transmit code (including ISR) and frees TX3 pin
+// pin #define NO_TX2_INTERRUPT // removes whole transmit code (including ISR)
+// and frees TX2 pin #define NO_TX3_INTERRUPT // removes whole transmit code
+// (including ISR) and frees TX3 pin
 
 // #define USART0_U2X_SPEED // enables double speed for USART0
 // #define USART1_U2X_SPEED // enables double speed for USART1
@@ -111,9 +157,10 @@
 // #define USART2_MPCM_MODE
 // #define USART3_MPCM_MODE
 
-/*****************************soft flow control config***********************************/
+/***********************soft flow control * config*****************************/
 // define IO instance to enable software CTS
-// CTS handlers also have to be placed into INT/PCINT interrupt in the application code, see example(flow control).c
+// CTS handlers also have to be placed into INT/PCINT interrupt in the
+// application code, see example(flow control).c
 
 // #define CTS0_DDR // DDRB
 // #define CTS0_PORT // PORTB
@@ -158,7 +205,8 @@
 // #define RTS3_IONUM
 
 /*****************************RS 485 config***********************************/
-// define IO instance to enable half duplex rs485 operation mode // used pin should be initially kept in low state before boot
+// define IO instance to enable half duplex rs485 operation mode // used pin
+// should be initially kept in low state before boot
 
 // #define RS485_CONTROL0_DDR // DDRB
 // #define RS485_CONTROL0_PORT // PORTB
@@ -197,9 +245,10 @@
 // #define MPCM2_MASTER_ONLY // do not include slave code into RX ISR
 // #define MPCM3_MASTER_ONLY // do not include slave code into RX ISR
 
-// Optional macros for placing user-defined code that will be executed inside of USART interrupt handlers.
+// Optional macros for placing user-defined code that will be executed inside of
-// Only inline asm and its input operand lists are allowed to be put here.
+// USART interrupt handlers. Only inline asm and its input operand lists are
-// Too large code may generate weird cryptic linker errors, what is caused by exceeded range of branch instructions.
+// allowed to be put here. Too large code may generate weird cryptic linker
+// errors, what is caused by exceeded range of branch instructions.
 // http://www.nongnu.org/avr-libc/user-manual/inline_asm.html
 
 // example:
@@ -209,31 +258,40 @@
 // #define OPERAND_LIST [A_MASK] "M" (0x55),\                 //
 //                     [TIMADDR]  "M" (_SFR_IO_ADDR(TCCR0A)),
 
-// code executed on every ISR call, before feeding UDR (for this racing implementation only), can be placed here // r30 and r31 are free to use
+// code executed on every ISR call, before feeding UDR (for this racing
+// implementation only), can be placed here // r30 and r31 are free to use
 #define TX0_EVERYCAL_EVENT "\n\t"
 
-// code executed on every byte transmission, can be placed here // r30 and r31 are free to use // r30 contains currently transmitted data byte
+// code executed on every byte transmission, can be placed here // r30 and r31
+// are free to use // r30 contains currently transmitted data byte
 #define TX0_TRANSMIT_EVENT "\n\t"
 
 #define TX0_INPUT_OPERAND_LIST
 
 #if !defined(USART0_EXTEND_RX_BUFFER) // DO NOT CHANGE
-	// code executed before reading UDR register can be placed here // r25 is free to use // executed before enabling interrupts in unsafe mode
+  // code executed before reading UDR register can be placed here // r25 is free
+  // to use // executed before enabling interrupts in unsafe mode
   #define RX0_FRAMING_EVENT "\n\t"
 
   // #define USART0_PUSH_BEFORE_RX // frees r30 an r31 for FRAMING_EVENT
 #else
-	// code executed before reading UDR register can be placed here // r25 and r31 are free to use
+  // code executed before reading UDR register can be placed here // r25 and r31
+  // are free to use
   #define RX0_FRAMING_EVENT "\n\t"
 #endif
 
-// code executed on every ISR call, can be placed here // r30 and r31 are free to use // r25 contains received data byte if 'extended buffer' mode is not used, free to use otherwise
+// code executed on every ISR call, can be placed here // r30 and r31 are free
+// to use // r25 contains received data byte if 'extended buffer' mode is not
+// used, free to use otherwise
 #define RX0_EVERYCALL_EVENT "\n\t"
 
-// code executed only when databyte was received, before buffer store, can be placed here // r31 is free to use // r25 contains received data byte, r30 rxn_last_byte buffer index // MPCM ??
+// code executed only when databyte was received, before buffer store, can be
+// placed here // r31 is free to use // r25 contains received data byte, r30
+// rxn_last_byte buffer index // MPCM ??
 #define RX0_EARLY_RECEIVE_EVENT "\n\t"
 
-// code executed only when databyte was received, can be placed here // r25,r30,r31 are free to use // r25 contains received data byte
+// code executed only when databyte was received, can be placed here //
+// r25,r30,r31 are free to use // r25 contains received data byte
 #define RX0_LATE_RECEIVE_EVENT "\n\t"
 
 #define RX0_INPUT_OPERAND_LIST
@@ -298,8 +356,10 @@
 
 #define RX3_INPUT_OPERAND_LIST
 
-// events executed inside transmit complete interrupts (last byte has been transmitted, UDR buffer is empty)
+// events executed inside transmit complete interrupts (last byte has been
-// if USATRn_NO_NAKED_TXC_INTERRUPT is not defined then inline asm is required here // any modified regs have to be pushed first
+// transmitted, UDR buffer is empty) if USATRn_NO_NAKED_TXC_INTERRUPT is not
+// defined then inline asm is required here // any modified regs have to be
+// pushed first
 // inline void TXCn_interrupt_event(void)
 //{
 //	asm volatile("\n\t"
@@ -314,32 +374,24 @@
 // #define USART0_USE_TXC_INTERRUPT // if rs485 is not used
 
 inline void TXC0_interrupt_event(void) __attribute__((always_inline));
-inline void TXC0_interrupt_event(void)
+inline void TXC0_interrupt_event(void) {}
-{
-}
 
 // #define USATR1_NO_NAKED_TXC_INTERRUPT
 // #define USART1_USE_TXC_INTERRUPT
 
 inline void TXC1_interrupt_event(void) __attribute__((always_inline));
-inline void TXC1_interrupt_event(void)
+inline void TXC1_interrupt_event(void) {}
-{
-}
 
 // #define USATR2_NO_NAKED_TXC_INTERRUPT
 // #define USART2_USE_TXC_INTERRUPT
 
 inline void TXC2_interrupt_event(void) __attribute__((always_inline));
-inline void TXC2_interrupt_event(void)
+inline void TXC2_interrupt_event(void) {}
-{
-}
 
 // #define USATR3_NO_NAKED_TXC_INTERRUPT
 // #define USART3_USE_TXC_INTERRUPT
 
 inline void TXC3_interrupt_event(void) __attribute__((always_inline));
-inline void TXC3_interrupt_event(void)
+inline void TXC3_interrupt_event(void) {}
-{
-}
 
 #endif /* USART_CONFIG_H_ */