Skip to content

Commit ea31182

Browse files
committed
Add more descriptions of ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM
1 parent f270918 commit ea31182

File tree

38 files changed

+78
-74
lines changed

38 files changed

+78
-74
lines changed

source/include/FreeRTOSIPConfigDefaults.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -978,7 +978,11 @@
978978

979979
/* When ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM is enabled,
980980
* the network interface is responsible for checking the checksums
981-
* of the incoming packets.
981+
* of the incoming packets. If hardware supports checking TCP checksum only,
982+
* the network interface layer should handle the same for other protocols,
983+
* such as IP/UDP/ICMP/etc, and give the checksum verified packets to the
984+
* FreeRTOS-plus-TCP stack.
985+
*
982986
* This can be either done in hardware, or by calling the checksum
983987
* functions.
984988
*/

test/Coverity/ConfigFiles/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@
5959
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
6060
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
6161

62-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
63-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
62+
/* If the network card/driver includes checksum offloading then set
63+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
6464
* stack repeating the checksum calculations. */
6565
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 0
6666

test/build-combination/AllDisable/FreeRTOSIPConfig.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
5656
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
5757

58-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
58+
/* If the network card/driver includes checksum offloading
5959
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
6060
* stack repeating the checksum calculations. */
6161
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 0

test/build-combination/AllEnable/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@
7878
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
7979
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
8080

81-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
82-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
81+
/* If the network card/driver includes checksum offloading then set
82+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
8383
* stack repeating the checksum calculations. */
8484
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
8585

test/build-combination/Enable_IPv4/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@
8282
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
8383
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
8484

85-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
86-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
85+
/* If the network card/driver includes checksum offloading then set
86+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
8787
* stack repeating the checksum calculations. */
8888
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
8989

test/build-combination/Enable_IPv4_IPv6/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@
8282
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
8383
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
8484

85-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
86-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
85+
/* If the network card/driver includes checksum offloading then set
86+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
8787
* stack repeating the checksum calculations. */
8888
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
8989

test/build-combination/Enable_IPv4_TCP/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@
8282
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
8383
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
8484

85-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
86-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
85+
/* If the network card/driver includes checksum offloading then set
86+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
8787
* stack repeating the checksum calculations. */
8888
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
8989

test/build-combination/Enable_IPv6/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@
8282
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
8383
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
8484

85-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
86-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
85+
/* If the network card/driver includes checksum offloading then set
86+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
8787
* stack repeating the checksum calculations. */
8888
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
8989

test/build-combination/Enable_IPv6_TCP/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@
8282
* on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */
8383
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
8484

85-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
86-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
85+
/* If the network card/driver includes checksum offloading then set
86+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
8787
* stack repeating the checksum calculations. */
8888
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
8989

test/cbmc/patches/FreeRTOSIPConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@
5757
#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN
5858
#endif
5959

60-
/* If the network card/driver includes checksum offloading (IP/TCP/UDP checksums)
61-
* then set ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
60+
/* If the network card/driver includes checksum offloading then set
61+
* ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software
6262
* stack repeating the checksum calculations. */
6363
#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1
6464

0 commit comments

Comments
 (0)