Macro usage cleanup (FreeRTOS#1080)

* Remove duplicate definitions of macros, and move static assertion definition to FreeRTOSIPConfigDefaults.h
---------
Authored-by: Holden <[email protected]>

Author: HTRamsey

source/FreeRTOS_DNS_Parser.c

@@ -1108,7 +1108,7 @@
                 xEndPoint.bits.bIPv6 = pdFALSE_UNSIGNED;
                 xEndPoint.usDNSType = dnsTYPE_A_HOST;
 
-                #if defined( ipconfigIPv4_BACKWARD_COMPATIBLE ) && ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 )
+                #if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 )
                     xDNSHookReturn = xApplicationDNSQueryHook( ( const char * ) ucNBNSName );
                 #else
                     xDNSHookReturn = xApplicationDNSQueryHook_Multi( &( xEndPoint ), ( const char * ) ucNBNSName );

source/FreeRTOS_IP_Utils.c

@@ -839,7 +839,7 @@ void prvProcessNetworkDownEvent( struct xNetworkInterface * pxInterface )
         {
             if( pxEndPoint->bits.bCallDownHook != pdFALSE_UNSIGNED )
             {
-                #if defined( ipconfigIPv4_BACKWARD_COMPATIBLE ) && ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 )
+                #if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 )
                 {
                     vApplicationIPNetworkEventHook( eNetworkDown );
                 }

source/include/FreeRTOSIPConfigDefaults.h

@@ -60,6 +60,33 @@
  * MACROS details :
  * https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html
  */
+
+/*---------------------------------------------------------------------------*/
+
+/*
+ * Compile time assertion with zero runtime effects.
+ * It will assert on 'e' not being zero, as it tries to divide by it.
+ */
+
+#ifdef static_assert
+    #define STATIC_ASSERT( e )    static_assert( e, "FreeRTOS-Plus-TCP Error" )
+#elif defined( _Static_assert )
+    #define STATIC_ASSERT( e )    _Static_assert( e, "FreeRTOS-Plus-TCP Error" )
+#else
+/* MISRA Ref 20.10.1 [Lack of sizeof operator and compile time error checking] */
+/* More details at: https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/MISRA.md#rule-2010 */
+/* coverity[misra_c_2012_rule_20_10_violation] */
+    #define ASSERT_CONCAT_( a, b )    a ## b
+    #define ASSERT_CONCAT( a, b )     ASSERT_CONCAT_( a, b )
+    #ifdef __COUNTER__
+        #define STATIC_ASSERT( e ) \
+    ; enum { ASSERT_CONCAT( static_assert_, __COUNTER__ ) = 1 / ( int ) ( !!( e ) ) }
+    #else
+        #define STATIC_ASSERT( e ) \
+    ; enum { ASSERT_CONCAT( assert_line_, __LINE__ ) = 1 / ( int ) ( !!( e ) ) }
+    #endif
+#endif /* ifdef static_assert */
+
 /*---------------------------------------------------------------------------*/
 
 /*
@@ -990,6 +1017,8 @@
  * Unit: count of ports
  * Minimum: 0
  * Maximum: 32
+ *
+ * There can be at most 32 PHY ports, but in most cases there are 4 or less.
  */
 
 #ifndef ipconfigPHY_MAX_PORTS

source/include/FreeRTOS_DNS_Globals.h

@@ -57,13 +57,6 @@
  * name field is an offset to the string, rather than the string itself. */
     #define dnsNAME_IS_OFFSET    ( ( uint8_t ) 0xc0 )
 
-/** @brief The maximum number of times a DNS request should be sent out if a response
- * is not received, before giving up. */
-    #ifndef ipconfigDNS_REQUEST_ATTEMPTS
-        #define ipconfigDNS_REQUEST_ATTEMPTS    5
-    #endif
-
-
 /* NBNS flags. */
     #if ( ipconfigUSE_NBNS == 1 )
         #define dnsNBNS_FLAGS_RESPONSE        0x8000U /**< NBNS response flag. */

source/include/FreeRTOS_IP.h

@@ -117,7 +117,7 @@ extern uint32_t ulApplicationGetNextSequenceNumber( uint32_t ulSourceAddress,
  */
 
 /* Use setting from FreeRTOS if defined and non-zero */
-#if defined( ipconfigBUFFER_PADDING ) && ( ipconfigBUFFER_PADDING != 0 )
+#if ( ipconfigBUFFER_PADDING != 0 )
     #define ipBUFFER_PADDING    ipconfigBUFFER_PADDING
 #elif ( UINTPTR_MAX > 0xFFFFFFFF )
     #define ipBUFFER_PADDING    ( 12U + ipconfigPACKET_FILLER_SIZE )
@@ -142,12 +142,6 @@ extern uint32_t ulApplicationGetNextSequenceNumber( uint32_t ulSourceAddress,
  * handled.  The value is chosen simply to be easy to spot when debugging. */
 #define ipUNHANDLED_PROTOCOL    0x4321U
 
-/** @brief The maximum time the IP task is allowed to remain in the Blocked state if no
- * events are posted to the network event queue. */
-#ifndef ipconfigMAX_IP_TASK_SLEEP_TIME
-    #define ipconfigMAX_IP_TASK_SLEEP_TIME    ( pdMS_TO_TICKS( 10000UL ) )
-#endif
-
 /* Trace macros to aid in debugging, disabled if ipconfigHAS_PRINTF != 1 */
 #if ( ipconfigHAS_PRINTF == 1 )
     #define DEBUG_DECLARE_TRACE_VARIABLE( type, var, init )    type var = ( init ) /**< Trace macro to set "type var = init". */

source/portable/BufferManagement/BufferAllocation_2.c

@@ -67,20 +67,8 @@
 #define baALIGNMENT_MASK             ( baALIGNMENT_BYTES - 1U )
 #define baADD_WILL_OVERFLOW( a, b )    ( ( a ) > ( SIZE_MAX - ( b ) ) )
 
-/* Compile time assertion with zero runtime effects
- * it will assert on 'e' not being zero, as it tries to divide by it,
- * will also print the line where the error occurred in case of failure */
-#if defined( ipconfigETHERNET_MINIMUM_PACKET_BYTES )
-    /* MISRA Ref 20.10.1 [Lack of sizeof operator and compile time error checking] */
-    /* More details at: https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/blob/main/MISRA.md#rule-2010 */
-    /* coverity[misra_c_2012_rule_20_10_violation] */
-    #define ASSERT_CONCAT_( a, b )    a ## b
-    #define ASSERT_CONCAT( a, b )     ASSERT_CONCAT_( a, b )
-    #define STATIC_ASSERT( e ) \
-    enum { ASSERT_CONCAT( assert_line_, __LINE__ ) = ( 1 / ( !!( e ) ) ) }
-
-    STATIC_ASSERT( ipconfigETHERNET_MINIMUM_PACKET_BYTES <= baMINIMAL_BUFFER_SIZE );
-#endif
+STATIC_ASSERT( ipconfigETHERNET_MINIMUM_PACKET_BYTES <= baMINIMAL_BUFFER_SIZE );
+
 /* A list of free (available) NetworkBufferDescriptor_t structures. */
 static List_t xFreeBuffersList;
 

source/portable/NetworkInterface/ATSAM4E/NetworkInterface.c

@@ -53,22 +53,6 @@
     #define BMSR_LINK_STATUS    0x0004          /*!< Link status */
 #endif
 
-#if defined( PHY_LS_HIGH_CHECK_TIME_MS ) || defined( PHY_LS_LOW_CHECK_TIME_MS )
-    #error please use the new defines with 'ipconfig' prefix
-#endif
-
-#ifndef ipconfigPHY_LS_HIGH_CHECK_TIME_MS
-
-/* Check if the LinkStatus in the PHY is still high after 15 seconds of not
- * receiving packets. */
-    #define ipconfigPHY_LS_HIGH_CHECK_TIME_MS    15000U
-#endif
-
-#ifndef ipconfigPHY_LS_LOW_CHECK_TIME_MS
-    /* Check if the LinkStatus in the PHY is still low every second. */
-    #define ipconfigPHY_LS_LOW_CHECK_TIME_MS    1000U
-#endif
-
 /* Interrupt events to process.  Currently only the Rx event is processed
  * although code for other events is included to allow for possible future
  * expansion. */

source/portable/NetworkInterface/ATSAME5x/NetworkInterface.c

@@ -86,7 +86,7 @@
 #endif
 
 /* Setup LLMNR specific multicast address. */
-#if ( defined( ipconfigUSE_LLMNR ) && ( ipconfigUSE_LLMNR == 1 ) )
+#if ( ipconfigUSE_LLMNR == 1 )
 static uint8_t ucLLMNR_MAC_address[] = { 0x01, 0x00, 0x5E, 0x00, 0x00, 0xFC };
 #endif
 
@@ -122,13 +122,13 @@ static uint8_t ucLLMNR_MAC_address[] = { 0x01, 0x00, 0x5E, 0x00, 0x00, 0xFC };
  * static allocation with a non zero-copy driver.
  */
 #define ipUSE_STATIC_ALLOCATION    0
-#if ( defined( ipUSE_STATIC_ALLOCATION ) && ( ipUSE_STATIC_ALLOCATION == 1 ) )
+#if ( ipUSE_STATIC_ALLOCATION == 1 )
 
 /* 1536 bytes is more than needed, 1524 would be enough.
  * But 1536 is a multiple of 32, which gives a great alignment for cached memories. */
     #define NETWORK_BUFFER_SIZE    1536
     static uint8_t ucBuffers[ ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS ][ NETWORK_BUFFER_SIZE ];
-#endif /* ( defined( ipUSE_STATIC_ALLOCATION ) && ( ipUSE_STATIC_ALLOCATION == 1 )) */
+#endif /* if ( ipUSE_STATIC_ALLOCATION == 1 ) */
 
 
 /* Holds the handle of the task used as a deferred interrupt processor.  The
@@ -137,7 +137,7 @@ static uint8_t ucLLMNR_MAC_address[] = { 0x01, 0x00, 0x5E, 0x00, 0x00, 0xFC };
 TaskHandle_t xEMACTaskHandle = NULL;
 
 /* The PING response queue */
-#if ( defined( ipconfigSUPPORT_OUTGOING_PINGS ) && ( ipconfigSUPPORT_OUTGOING_PINGS == 1 ) )
+#if ( ipconfigSUPPORT_OUTGOING_PINGS == 1 )
     QueueHandle_t xPingReplyQueue = NULL;
 #endif
 
@@ -254,7 +254,7 @@ BaseType_t xATSAM5x_NetworkInterfaceInitialise( NetworkInterface_t * pxInterface
         prvPHYLinkReset();
 
         /* Initialize PING capability */
-        #if ( defined( ipconfigSUPPORT_OUTGOING_PINGS ) && ( ipconfigSUPPORT_OUTGOING_PINGS == 1 ) )
+        #if ( ipconfigSUPPORT_OUTGOING_PINGS == 1 )
             xPingReplyQueue = xQueueCreate( ipconfigPING_QUEUE_SIZE, sizeof( uint16_t ) );
         #endif
 
@@ -471,7 +471,7 @@ void xRxCallback( void )
     vTaskNotifyGiveFromISR( xEMACTaskHandle, 0 );
 }
 
-#if ( defined( ipUSE_STATIC_ALLOCATION ) && ( ipUSE_STATIC_ALLOCATION == 1 ) )
+#if ( ipUSE_STATIC_ALLOCATION == 1 )
 
 /* Next provide the vNetworkInterfaceAllocateRAMToBuffers() function, which
  * simply fills in the pucEthernetBuffer member of each descriptor. */
@@ -490,7 +490,7 @@ void xRxCallback( void )
             *( ( uint32_t * ) &ucBuffers[ x ][ 0 ] ) = ( uint32_t ) &( pxNetworkBuffers[ x ] );
         }
     }
-#endif /* ( defined( ipUSE_STATIC_ALLOCATION ) && ( ipUSE_STATIC_ALLOCATION == 1 )) */
+#endif /* if ( ipUSE_STATIC_ALLOCATION == 1 ) */
 
 
 /*********************************************************************/
@@ -518,7 +518,7 @@ static void prvGMACInit()
     prvGMACEnableMulticastHashTable( true );
 
     /* Enable traffic for LLMNR, if defined. */
-    #if ( defined( ipconfigUSE_LLMNR ) && ( ipconfigUSE_LLMNR == 1 ) )
+    #if ( ipconfigUSE_LLMNR == 1 )
     {
         mac_async_set_filter_ex( &ETH_MAC, ucLLMNR_MAC_address );
     }

source/portable/NetworkInterface/Common/phyHandling.c

@@ -55,22 +55,6 @@
 #define phyMIN_PHY_ADDRESS    0
 #define phyMAX_PHY_ADDRESS    31
 
-#if defined( PHY_LS_HIGH_CHECK_TIME_MS ) || defined( PHY_LS_LOW_CHECK_TIME_MS )
-    #error please use the new defines with 'ipconfig' prefix
-#endif
-
-#ifndef ipconfigPHY_LS_HIGH_CHECK_TIME_MS
-
-/* Check if the LinkStatus in the PHY is still high after 15 seconds of not
- * receiving packets. */
-    #define ipconfigPHY_LS_HIGH_CHECK_TIME_MS    15000U
-#endif
-
-#ifndef ipconfigPHY_LS_LOW_CHECK_TIME_MS
-    /* Check if the LinkStatus in the PHY is still low every second. */
-    #define ipconfigPHY_LS_LOW_CHECK_TIME_MS    1000U
-#endif
-
 /* As the following 3 macro's are OK in most situations, and so they're not
  * included in 'FreeRTOSIPConfigDefaults.h'.
  * Users can change their values in the project's 'FreeRTOSIPConfig.h'. */

source/portable/NetworkInterface/LPC18xx/NetworkInterface.c

@@ -50,25 +50,8 @@
 /* The size of the stack allocated to the task that handles Rx packets. */
 #define nwRX_TASK_STACK_SIZE    140
 
-#if defined( PHY_LS_HIGH_CHECK_TIME_MS ) || defined( PHY_LS_LOW_CHECK_TIME_MS )
-    #error please use the new defines with 'ipconfig' prefix
-#endif
-
-#ifndef ipconfigPHY_LS_HIGH_CHECK_TIME_MS
-
-/* Check if the LinkStatus in the PHY is still high after 15 seconds of not
- * receiving packets. */
-    #define ipconfigPHY_LS_HIGH_CHECK_TIME_MS    15000U
-#endif
-
-#ifndef ipconfigPHY_LS_LOW_CHECK_TIME_MS
-    /* Check if the LinkStatus in the PHY is still low every second. */
-    #define ipconfigPHY_LS_LOW_CHECK_TIME_MS    1000U
-#endif
-
-
 #ifndef configUSE_RMII
-    #define configUSE_RMII    1
+    #define configUSE_RMII      1
 #endif
 
 #ifndef configNUM_RX_DESCRIPTORS