Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Ethernet driver for Corstone-300 FVP (MPS3_AN552) #1009

Merged
merged 3 commits into from
Oct 9, 2023

Conversation

urutva
Copy link
Contributor

@urutva urutva commented Aug 23, 2023

Add Ethernet driver for Corstone-300 FVP (MPS3_AN552)

Description

The Corstone-300 FVP models SMSC 91C111 Ethernet controller. Add a network interface based on CMSIS ethernet driver for SMSC 91C111.

Test Steps

Tested locally with Arm Featured Reference Integration https://github.com/FreeRTOS/iot-reference-arm-corstone3xx. Once this PR is merged, FreeRTOS TCP/IP stack support for https://github.com/FreeRTOS/iot-reference-arm-corstone3xx will be created.

Checklist:

  • I have tested my changes. No regression in existing tests.
  • I have modified and/or added unit-tests to cover the code changes in this Pull Request.

Related Issue

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@urutva urutva requested a review from a team as a code owner August 23, 2023 11:45
@urutva urutva force-pushed the add-mps3-an552-ethernet-driver branch from 9ff6bae to 12a9265 Compare August 23, 2023 14:30
Copy link
Contributor

@htibosch htibosch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @urutva, thank you for this new network interface.

I have a few remarks, please have a look at them.

Maybe it is good to have a look at this NetworkInterface.c, and it use of enum xEMAC_STATE.

Also it may be worth having a look at phyHandling.c. That is a generic PHY driver used in most network interfaces in FreeRTOS+TCP. It recognises all major 100/10 Mbps PHYs. That'll save a lot of refactoring when users start asking for different models of PHY's.

phyHandling.c will recognise the ID of many PHY's, and it will initialise them automatically.

eEthernetLinkState = xEthernetInterface0.pxEthernetPHYDriver->GetLinkState();
eEthernetLinkStateTimeOutCount++;

if( eEthernetLinkStateTimeOutCount >= 5 )
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here you are creating a loop that will last at most 5 x 1000 ms.
It is enough to test the link status once, because this function will be called repeatedly until pdPASS is returned.
Mind you: it is possible that more network drivers are starting up at the same time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The initialisation method has been refactored based on the recommended use of enum xEMAC_STATE.

xEthernetInterface0.pxEthernetMACDriver->PHY_Write );
xEthernetInterface0.pxEthernetPHYDriver->PowerControl( ARM_POWER_FULL );
xEthernetInterface0.pxEthernetPHYDriver->SetInterface( xEthernetMACCapabilities.media_interface );
xEthernetInterface0.pxEthernetPHYDriver->SetMode( ARM_ETH_PHY_AUTO_NEGOTIATE );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here above, before calling xTaskCreate(), you test if xRxTaskHandle has been set. That is good.
Likewise, it should be tested if the Ethernet and the PHY drivers have been initialised already.

The function NetworkInterfaceInitialise() will be called repeatedly until it returns a non-zero value.

In other drivers you will see an enum that describes different phases in the initialisation. Once example for this is the Xilinx Ultrascale driver:

typedef enum xEMAC_STATE
{
    xEMAC_Init,
    xEMAC_SetupPHY,
    xEMAC_WaitPHY,
    xEMAC_Ready,
    xEMAC_Fatal,
} EMACState_t;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The initialisation method has been refactored based on the recommended use of enum xEMAC_STATE.

{
/* Task that reads incoming Ethernet frames and sends it FreeRTOS
* TCP/IP stack. */
xReturn = xTaskCreate( prvRxTask,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating the task should be the last step in the initialisation, because prvRxTask takes over the ownership of the EMAC. It can be disturbing (fatal) when the IP-task calls NetworkInterfaceInitialise(), working on the EMAC, and prvRxTask accessing DMA and the PHY.
So let xTaskCreate() happen in the last state of the initialisation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chime in with this opinion. To avoid accessing non-init hardware/variables, we should move this to the last.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Seems like an issue in existing network interface https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/tree/main/source/portable/NetworkInterface/MPS2_AN385 which I used as a reference for this.

if( pxNetworkBuffer->xDataLength > 1518 )
{
FreeRTOS_debug_printf( ( "Error: Too big Ethernet frame, Size:", pxNetworkBuffer->xDataLength ) );
return xReturn;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some developers do not like to see a return statement in the middle of a function. Please restructure it to get a single point of return.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reference, this also violates MISRA Rule 15.5 is "A function should have a single point of exit at the end".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.


if( xReleaseAfterSend == pdTRUE )
{
vReleaseNetworkBufferAndDescriptor( pxNetworkBuffer );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about zero-copy? Does SendFrame() wait until the entire frame has been queued / sent?
If not the space will be released and may get corrupted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The driver doesn't support zero-copy. I've added a compile time error to catch this.


/* Hard force an assert as this driver cannot be used with BufferAllocation_1.c
* without implementing this function. */
configASSERT( 0 );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeh good.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my earlier comments, I referred to Xilinx Ultrascale, which does not use phyHandling.c, because it needs a 1GB PHY.

Here is an example of how to use phyHandling.c, used by the STM32Hx driver.

Another thing that I didn't mention yet is that the link status should be monitored from time to time. The STM32Hx driver also shows how that can be accomplished.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've created a new function prvLAN91C111_CheckEthertnetLinkStatus which is invoked as part of prvRxTask. The prvLAN91C111_CheckEthertnetLinkStatus check the ethernet link status and notifies the IP stack if the link is down. It also sets the eEMACState to xEMAC_Init, so that the both MAC and PHY drivers are reinitialised when IP stack calls xLAN91C111_NetworkInterfaceInitialise on receiving network down event.

{
/* Task that reads incoming Ethernet frames and sends it FreeRTOS
* TCP/IP stack. */
xReturn = xTaskCreate( prvRxTask,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chime in with this opinion. To avoid accessing non-init hardware/variables, we should move this to the last.

if( pxNetworkBuffer->xDataLength > 1518 )
{
FreeRTOS_debug_printf( ( "Error: Too big Ethernet frame, Size:", pxNetworkBuffer->xDataLength ) );
return xReturn;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reference, this also violates MISRA Rule 15.5 is "A function should have a single point of exit at the end".

@ActoryOu
Copy link
Member

BTW, could you share your project to run it with FreeRTOS-Plus-TCP?

@urutva urutva force-pushed the add-mps3-an552-ethernet-driver branch from 12a9265 to 6bb586d Compare September 18, 2023 08:28
@urutva
Copy link
Contributor Author

urutva commented Sep 18, 2023

Hello @urutva, thank you for this new network interface.

I have a few remarks, please have a look at them.

Maybe it is good to have a look at this NetworkInterface.c, and it use of enum xEMAC_STATE.

Also it may be worth having a look at phyHandling.c. That is a generic PHY driver used in most network interfaces in FreeRTOS+TCP. It recognises all major 100/10 Mbps PHYs. That'll save a lot of refactoring when users start asking for different models of PHY's.

phyHandling.c will recognise the ID of many PHY's, and it will initialise them automatically.

@htibosch @ActoryOu Thanks for your valuable inputs.

Initially when I started working on the networkinterface for MPS3_AN552, the closest match I could find was https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/tree/main/source/portable/NetworkInterface/MPS2_AN385. The MPS2_AN385 uses CMSIS native drivers and MPS3_AN552 uses CMSIS drivers. Please note that the ethernet MAC and PHY drivers from CMSIS drivers are reused here.

Copy link
Member

@ActoryOu ActoryOu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your update!!

There is still one small change needed in handling NULL endpoint case.
Please help to take a look.

Copy link
Contributor

@htibosch htibosch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @urutva, thank you for your patience with us, and thank you for your contribution.

Your NetworkInterface.c looks pretty good to me, and I approve it.

You decided not to incorporate the generic PHY driver phyHandling.c. Does that mean that only LAN91C111 can be used? It looks like the PHY is pretty interwoven with the MPS3 platform?

phyHandling.c is probably not the best PHY driver on earth, but the advantage is that it is a uniform approach among all (10/100 Mbps) +TCP drivers, and avoids the need to debug third-party PHY drivers.

Unfortunately I do not have hardware yet to do tests. Please keep us informed about how it is going, here on on the FreeRTOS forum.

Thanks again.

@urutva urutva force-pushed the add-mps3-an552-ethernet-driver branch 3 times, most recently from a4bee2e to b45d9b0 Compare September 30, 2023 13:01
@urutva
Copy link
Contributor Author

urutva commented Oct 5, 2023

@htibosch @ActoryOu Thanks for your support. I've created a PR for Arm Featured Reference Integration (FRI) with FreeRTOS TCP/IP stack support FreeRTOS/iot-reference-arm-corstone3xx#9. The Arm FRI uses the network interface created with this PR.

Arm FRI validates end to end connectivity to AWS IoT Core and successful OTA with FreeRTOS TCP/IP stack.

@urutva urutva force-pushed the add-mps3-an552-ethernet-driver branch from 300f53b to e4a9472 Compare October 5, 2023 09:24
@urutva urutva force-pushed the add-mps3-an552-ethernet-driver branch 2 times, most recently from 6ac7f6f to 0e39fa4 Compare October 6, 2023 10:22
The Corstone-300 FVP models SMSC 91C111 Ethernet controller. Add a
network interface based on CMSIS ethernet driver for SMSC 91C111.

Signed-off-by: Devaraj Ranganna <devaraj.ranganna@arm.com>
Signed-off-by: Devaraj Ranganna <devaraj.ranganna@arm.com>
Signed-off-by: Devaraj Ranganna <devaraj.ranganna@arm.com>
@urutva urutva force-pushed the add-mps3-an552-ethernet-driver branch from 0e39fa4 to 6b65e92 Compare October 6, 2023 12:26
@amazonKamath amazonKamath merged commit 3d5ee0e into FreeRTOS:main Oct 9, 2023
10 checks passed
@HTRamsey HTRamsey mentioned this pull request Oct 9, 2023
2 tasks
HTRamsey pushed a commit to HTRamsey/FreeRTOS-Plus-TCP that referenced this pull request Dec 3, 2023
commit 9abe2d1
Author: Emil Popov <evpopov@gmail.com>
Date:   Sun Nov 5 22:52:32 2023 -0500

    Changes the ND cache full behavior when the Neighbor Discovery cache fills up. (FreeRTOS#1040)

    * Changes the ND cache full behavior: If the Neighbor Discovery cache ever gets full, trying to store a new entry will overwrite the oldest existing entry.

    * Adds casting to avoid warnings

    ---------

    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
    Co-authored-by: Tony Josi <tonyjosi@amazon.com>

commit c8d9b70
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Fri Nov 3 14:47:16 2023 +0530

    Update release script to add cleanup step (FreeRTOS#1038)

    * Add cleanup step in release script

    * update comment

    ---------

    Co-authored-by: Monika Singh <moninom@amazon.com>

commit 7c129b6
Author: Emil Popov <evpopov@gmail.com>
Date:   Fri Nov 3 04:14:32 2023 -0400

    Fixes the allocation size when sending a neighbor solicitation packet to avoid having to always reallocate the buffer. (FreeRTOS#1039)

    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>

commit be2555b
Author: Holden <68555040+holden-zenith@users.noreply.github.com>
Date:   Wed Nov 1 03:03:52 2023 -0400

    Improve Default Macros (FreeRTOS#782)

    * Delete duplicate default defines

    * Remove errno definitions that exist in projdefs.h

    * Clean & Organize FreeRTOSIPConfigDefaults.h

    * Move deprecated definitions to their own file

    * Definitions Documentation Improvements

    * Tracing default definitions improvements

    * Organize and add to deprecated definitions

    * Remove FreeRTOS_errno_TCP.h

    * Fixes for definitions updates

    * Address review comments

    * Start enforcing macro value limits and make some doc more succinct

    * enforce ipconfig macro bounds

    * repair config default and reduce unnecessary changes

    * Add more descriptions of ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM (FreeRTOS#947)

    * Fixes mDNS over IPv6. (FreeRTOS#949)

    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>

    * remove enabled checks

    * Remove enable checks from trace macros

    * Update cmake sources

    * add missing defines

    * revert unnecessary changes

    * formatting

    * fix lexicon

    * fix build issue and remove deprecated macro usage from tests

    * fix build issues and formatting

    * disable pdFREERTOS_ERRNO_EAFNOSUPPORT check

    * update kernel submodule for tests

    * macro definition fixes

    * fix some test build issues

    * Temporary passing state

    * Fix unittest

    * Fix CBMC

    * Update CBMC proof

    * Update Macro comments

    * revert changes

    * Fix MISRA 4.4

    * Fix MISRA 20.7 violation

    * Fix spell checker

    * Update Hein's comment

    ---------

    Co-authored-by: Holden <holden-zenithaerotech.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>
    Co-authored-by: Emil Popov <evpopov@gmail.com>
    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>
    Co-authored-by: ActoryOu <ousc@amazon.com>

commit 1474378
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Wed Oct 25 12:02:25 2023 +0800

    Give header files a uniform indentation (FreeRTOS#1034)

    * Give header files a uniform indentation

    * Uncrustify: triggered by comment.

    * A few more removals of /* ifndef ...*/

    * After applying formattingChanges.patch

    * Undo indent to avoid huge white space changes

    * Undo more indent to avoid huge white space changes

    * Undo two more indent to avoid huge white space changes

    * Undo 15 more indent to avoid huge white space changes

    * Undo 3 more indent to avoid huge white space changes

    * Undo 4 more indent to avoid huge white space changes

    * Undo 3 more indent to avoid huge white space changes

    * It seems that core_cm55.h was not yet formatted

    * More files in MPS3_AN552 were not yet formatted.

    * And the last one

    * Uncrustify: triggered by comment.

    * Just a push to restart CI-checks

    * Placed some extern "c" comments again

    * Formatting fixes

    ---------

    Co-authored-by: GitHub Action <action@github.com>
    Co-authored-by: Soren Ptak <ptaksoren@gmail.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>

commit 8761f51
Author: Emil Popov <evpopov@gmail.com>
Date:   Tue Oct 24 23:04:54 2023 -0400

    SAME70 driver xTXDescriptorSemaphore issue (FreeRTOS#1033)

    * Fixes and issue with the SAME70 port where and error in gmac_dev_write() causes the counting  xTXDescriptorSemaphore to not be returned and eventually exhausting it.

    * fix formatting

    * Allows release of the network buffer if gmac_dev_write() fails and the ero-copy driver is being used.
    Thanks @htibosch

    * Fix typo

    ---------

    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
    Co-authored-by: tony-josi-aws <tonyjosi@amazon.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>

commit 2131f01
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Wed Oct 25 10:22:22 2023 +0800

    STM32H7xx driver check result of HAL_ETH_Init v3 (FreeRTOS#1035)

    * STM32H7xx driver check result of HAL_ETH_Init v3

    * One more change to networkInterface.c

    * Updating FreeRTOS kernel submodule

    * Once again commit kernel

    ---------

    Co-authored-by: ActoryOu <jay2002824@gmail.com>

commit eac0d0c
Author: ActoryOu <jay2002824@gmail.com>
Date:   Wed Oct 25 10:03:27 2023 +0800

    Fix build combination test caused by kernel change (FreeRTOS#1036)

    * Fix build combination test caused by kernel change

commit 56b3374
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Thu Oct 12 14:15:43 2023 +0530

    Update STM32Hxx port to use HW MAC hashtable filter (FreeRTOS#970)

    * fix

    * MAC filter updated for DAD and IPv6 all nodes multicast

    * add more comments

    * fix formatting

    * fix comments

    * fix review comments

    * fix formatting

    * update review comments

    * enable multicast packets in MAC

    * use multi cast MAC filter

    * fix formatting

    * update naming and comments

    * update comments and formatting

    * rename function

    * fix formatting

    * fix spell check

    * Uncrustify: triggered by comment

    ---------

    Co-authored-by: GitHub Action <action@github.com>

commit c0f5ba0
Author: Błażej Sowa <bsowa123@gmail.com>
Date:   Tue Oct 10 12:52:22 2023 +0200

    Fix network down up process (FreeRTOS#1030)

    * Disable DHCP timer when network goes down

    * Don't stop checking the Network Timer

    * Fix network down when using RA

    * Revert "Don't stop checking the Network Timer"

    This reverts commit f5d8d98.

    * Add vSetNotAllNetworksUp function

    * Fix unit tests

    * Update comments

    * Store DHCPv4 socket locally for all endpoints

    * Add vDHCPStop and vDHCPv6Stop functions

    * Fix IP Utils tests

    * Fix most of DHCP unit tests

    * Fix formatting

    * Change vSetNotAllNetworksUp into a more generic vSetAllNetworksUp

    * Fix almost all of DHCP unit tests

    * Fix formatting

    * Add tests for vDHCPStop and vDHCPv6Stop functions

    * Fix formatting

    * Remove redundant MISRA comment

    * Set all fields of xAddress when binding DHCP socket

    * Fix unit test coverage of prvCreateDHCPSocket

    * Fix DHCP CBMC memory proof

    ---------

    Co-authored-by: Soren Ptak <ptaksoren@gmail.com>
    Co-authored-by: Tony Josi <tonyjosi@amazon.com>

commit 3d5ee0e
Author: Devaraj Ranganna <devaraj.ranganna@arm.com>
Date:   Mon Oct 9 05:46:25 2023 +0100

    Add Ethernet driver for Corstone-300 FVP (MPS3_AN552) (FreeRTOS#1009)

    * networkinterface: Add Ethernet driver for Corstone-300 FVP (MPS3_AN552)

    The Corstone-300 FVP models SMSC 91C111 Ethernet controller. Add a
    network interface based on CMSIS ethernet driver for SMSC 91C111.

    Signed-off-by: Devaraj Ranganna <devaraj.ranganna@arm.com>

    * ci: Update spell-check dictionary

    Signed-off-by: Devaraj Ranganna <devaraj.ranganna@arm.com>

    * networkinterface: Fix formatting issues

    Signed-off-by: Devaraj Ranganna <devaraj.ranganna@arm.com>

    ---------

    Signed-off-by: Devaraj Ranganna <devaraj.ranganna@arm.com>

commit 160fa29
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Fri Oct 6 19:06:10 2023 +0800

    Check minimum size of ICMPv6 packets (FreeRTOS#994)

    * Not all ICMPv6 packets have the same minimum length

    * More precise length checking

    * Repaired unit tests / coverage

    * Running uncrustify

    ---------

    Co-authored-by: Tony Josi <tonyjosi@amazon.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>
    Co-authored-by: kar-rahul-aws <118818625+kar-rahul-aws@users.noreply.github.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>

commit 16a74c3
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Fri Oct 6 18:57:45 2023 +0800

    Preparing library to use loopback device (FreeRTOS#1020)

    * Preparing library to use loopback device

    * Repaired FreeRTOS_AddEndPoint() as well

    * Minor changes for Doxygen

    * Uncrustify: triggered by comment.

    * Added IPv6.h and removed call to xIsIPv6Loopback

    * Conditional compilation of xIPv6_GetIPType()

    * Do not call xBadIPv4Loopback() when IPv4 is not enabled

    * Repaired unit tests

    * In FreeRTOS_AddEndPoint(), set next to NULL

    * One more change in FreeRTOS_AddNetworkInterface()

    * FreeRTOS_FillEndPoint: save pxNext before clearing entire endpoint struct

    * Uncrustify: triggered by comment.

    * Changes after review by Shub

    * Changes after review by Shub, part 2

    * Uncrustify: triggered by comment.

    * Replace pxUDPPacket with pxIPacket in function prvAllowIPPacketIPv4()

    * utest: replace xIPv6UnspecifiedAddress with FreeRTOS_in6addr_any

    * Checked unit-tests and coverage

    * ut: Repaired GetIPType loopback test

    * Update test/unit-test/FreeRTOS_IPv6_ConfigDriverCheckChecksum/FreeRTOS_IPv6_ConfigDriverCheckChecksum_stubs.c

    Co-authored-by: ActoryOu <jay2002824@gmail.com>

    * Update test/unit-test/FreeRTOS_IPv6/ut.cmake

    Co-authored-by: ActoryOu <jay2002824@gmail.com>

    * Remove test for 'ipIPv4_FRAME_TYPE'

    * Repairing tu again

    ---------

    Co-authored-by: GitHub Action <action@github.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>
    Co-authored-by: Tony Josi <tonyjosi@amazon.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>

commit 3cc5d1c
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Fri Oct 6 15:40:42 2023 +0530

    Update sockets header to include ntop/pton IPv4/v6 API declarations (FreeRTOS#1031)

    * update sockets header to include ntop / pton IPv4/v6 API declarations

    * Uncrustify: triggered by comment

    ---------

    Co-authored-by: GitHub Action <action@github.com>

commit 243de78
Author: Soren Ptak <ptaksoren@gmail.com>
Date:   Thu Oct 5 09:39:43 2023 -0700

    Apply formatting bot fix (FreeRTOS#1029)

    Co-authored-by: Tony Josi <tonyjosi@amazon.com>

commit 382ddb0
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Thu Oct 5 13:56:32 2023 +0800

    Make use of FreeRTOS_inet_addr_quick() when applicable (FreeRTOS#1032)

commit d3ce35f
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Wed Oct 4 14:49:57 2023 +0800

    New helper function: FreeRTOS_get_tx_base (FreeRTOS#544)

    * IPv4/single: new function: FreeRTOS_get_tx_base

    * Changed some code comments and repaired a typo.

    * Attempt to repair utest

    * Changes after CI checks

    * utest: Added tests for get_tx_base

    * Do not use const socket type in FreeRTOS_get_tx_base()

    * Removed comments from cmake  file ut

    * Repaired UT

    * Removed a nested if/endif couple

    ---------

    Co-authored-by: Hein Tibosch <hein@htibosch.net>

commit ce11071
Author: Archit Gupta <71798289+archigup@users.noreply.github.com>
Date:   Mon Sep 25 22:45:16 2023 -0700

    Fix uninitialized variable in TM4C NetworkInterface.c (FreeRTOS#1028)

    * Fix uninitialized variable in TM4C NetworkInterface.c

    * Uncrustify: triggered by comment.

    * Update macro

    ---------

    Co-authored-by: GitHub Action <action@github.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>

commit c9e63fc
Author: Emil Popov <evpopov@gmail.com>
Date:   Wed Sep 20 06:11:02 2023 -0400

    Fixes the TCP zero-copy functionality... (FreeRTOS#1018)

    * Fixes the TCP zero-copy functionality... looks like this somehow just got overlooked.

    * Update unit tests

    ---------

    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
    Co-authored-by: tony-josi-aws <tonyjosi@amazon.com>

commit 222a36d
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Tue Sep 19 15:02:59 2023 +0800

    The new loopback network interface (FreeRTOS#1022)

    Co-authored-by: Tony Josi <tonyjosi@amazon.com>

commit ce7b689
Author: Jonathan Reichelt Gjertsen <jonath.re@gmail.com>
Date:   Mon Sep 18 21:46:47 2023 +0200

    Use GCC-compatible alignment specifier in TM4C NetworkInterface.c (FreeRTOS#1027)

    * Use GCC-compatible alignment specifier in TM4C NetworkInterface.c

    Replace the CCS-only pragma with GCC attribute. Fixing this along with #1206 will make this file build without warnings on the ARM GNU toolchain.

    The CCS compiler does support this attribute, see section 5.17.2 in: https://www.ti.com/lit/ug/spnu151w/spnu151w.pdf?ts=1695011722091

    * Uncrustify: triggered by comment.

    ---------

    Co-authored-by: GitHub Action <action@github.com>

commit 5e55153
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Wed Sep 13 15:07:17 2023 +0530

    Update FreeRTOS_get_tx_head to create TX stream if not created already (FreeRTOS#1023)

    * TCP zero copy update FreeRTOS_get_tx_head()

    * fix unit tests

    * Uncrustify: triggered by comment

    * updating with review feedback

    ---------

    Co-authored-by: GitHub Action <action@github.com>

commit b3289a7
Merge: a91c311 0ebf0c2
Author: rawalexe <113639451+rawalexe@users.noreply.github.com>
Date:   Fri Sep 8 18:12:49 2023 -0700

    Remove obsolete config structs

    This PR removes the xNetworkAddressing and xDefaultAddressing structs as they appear to be obsolete.

commit 0ebf0c2
Merge: 9f33e6e a91c311
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Thu Sep 7 11:08:01 2023 +0530

    Merge branch 'main' into NetParamsCleanup_PR

commit a91c311
Author: Peter R Herrmann <114958111+Peter-Herrmann@users.noreply.github.com>
Date:   Wed Sep 6 21:08:37 2023 -0700

    DriverSAM/NetworkInterface.c warning cleanup - purely refactoring (FreeRTOS#1016)

    * warning cleanup - purely refactoring

    * Incorporated PR feedback
    - Made vCheckBuffersAndQueue() static
    - Added uxLowestSemCount back into prvEMACHandlerTask, now modifying global instead of shadowing

    * Uncrustify: triggered by comment.

    * Fix formatting

    * Uncrustify: triggered by comment.

    * Un-doing uncrustify commit that breaks formatting rules

    * formatting fix

    * formatting fix

    ---------

    Co-authored-by: Soren Ptak <ptaksoren@gmail.com>
    Co-authored-by: GitHub Action <action@github.com>
    Co-authored-by: Rahul Kar <karahulx@amazon.com>

commit 9f33e6e
Author: Emil Popov <epopov@cardinalkinetic.com>
Date:   Wed Sep 6 13:59:07 2023 -0400

    removes the xNetworkAddressing and  xDefaultAddressing structs as they appear to be obsolete.

commit f590724
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Wed Sep 6 16:52:00 2023 +0530

    Add integer overflow checks to buffer allocation APIs (FreeRTOS#1017)

    * Add checks to verify integer overflows doesnt occur during buffer allocations

    * Uncrustify: triggered by comment

    * updating review feedback

    ---------

    Co-authored-by: Soren Ptak <ptaksoren@gmail.com>
    Co-authored-by: GitHub Action <action@github.com>

commit eed294c
Author: Soren Ptak <ptaksoren@gmail.com>
Date:   Tue Sep 5 17:31:24 2023 -0400

    CI-CD Updates (FreeRTOS#1014)

    * Use new version of CI-CD Actions,  checkout@v3 instead of checkout@v2 on all jobs
    * Use cSpell spell check, and use ubuntu-20.04 for formatting check
    * Add in bot formatting action

commit a3413d2
Author: kar-rahul-aws <118818625+kar-rahul-aws@users.noreply.github.com>
Date:   Sat Sep 2 02:57:20 2023 +0530

    Fix FreeRTOS+TCP unit tests for latest Kernel V10.6.1 (FreeRTOS#1015)

    * Fix unit tests for latest FreeRTOS-Kernel V10.6.1
    * Update the FreeRTOS-Kernel submodule to V10.6.1
    * Update the Coverage-Cop action to use new parameter name

    ---------

    Co-authored-by: Monika Singh <moninom@amazon.com>
    Co-authored-by: Soren Ptak <ptaksoren@gmail.com>

commit 34148c3
Author: Błażej Sowa <bsowa123@gmail.com>
Date:   Wed Aug 23 18:10:42 2023 +0200

    Add LIBSLIRP to Network Interface selection in CMakeLists

commit 0c59e71
Author: microcris <31326314+microcris@users.noreply.github.com>
Date:   Tue Aug 22 10:54:01 2023 +0100

    Fix assertion failure when disconnecting the Ethernet cable (NXP1060 -  NetworkInterface.c) (FreeRTOS#1002)

    * Update NetworkInterface.c

    The changes that I'm proposing are to make the driver to work in case of cable disconnection.

    In prvEMACHandlerTask, when xSendEventStructToIPTask, we have to pass network interface or it will fail the assertion in xSendEventStructToIPTask "configASSERT( pxInterface != NULL )".

    In pxNXP1064_NetworkInterfaceInitialise, if xWaitPHY fails (for instance, the cable is not connected), the switch case will break without doing nothing and the prvEMACHandlerTask will be blocked waiting for the notification. We have to unblock it to try again in case of failure in xEMAC_WaitPHY.

    * Update NetworkInterface.c

    uncrustify code

    * Update NetworkInterface.c

    Correct indentation

    * Update NetworkInterface.c

    Correct indentation

    * Update NetworkInterface.c

    fix indentation... again

    * Update source/portable/NetworkInterface/NXP1060/NetworkInterface.c

    Co-authored-by: ActoryOu <jay2002824@gmail.com>

    * Update source/portable/NetworkInterface/NXP1060/NetworkInterface.c

    Co-authored-by: ActoryOu <jay2002824@gmail.com>

    ---------

    Co-authored-by: ActoryOu <jay2002824@gmail.com>

commit 20d30d9
Author: Hein Tibosch <hein_tibosch@yahoo.es>
Date:   Tue Aug 22 09:46:31 2023 +0800

    DriverSAM: let gmac_dev_read() return the proper length (version 2) (FreeRTOS#1000)

    * Atmel SAM driver: let gmac_dev_read() return the proper length (version 2)

    * Running uncrustify

    * A minor format change

    * Added a comment about a min() test

commit 169ae78
Author: Monika Singh <moninom@amazon.com>
Date:   Fri Aug 11 15:11:45 2023 +0530

    Update minor fixes in Readme (FreeRTOS#1005)

    * Update Readme

    * Update line

    * Remove dead link

    * Update README.md

    * Update README.md

commit 44765e4
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Thu Aug 10 18:06:21 2023 +0530

    Fix coverity issues in ARP (FreeRTOS#1003)

    Co-authored-by: ActoryOu <jay2002824@gmail.com>

commit f5ecc5f
Author: ActoryOu <jay2002824@gmail.com>
Date:   Thu Aug 10 20:09:17 2023 +0800

    Fix MISRA violations Rule 1.1 for forward declaration (FreeRTOS#1004)

    * Fix MISRA things for forward declaration

    * Formatting

    * Fix return structure of prvAllowIPPacketIPv4 and comments.

commit 4c6c8ab
Author: shubnil <103672514+shubnil@users.noreply.github.com>
Date:   Wed Aug 9 23:03:12 2023 +0530

    Update the History.txt section for V4.0.0 Release (FreeRTOS#997)

    * Update History.txt

    Update the history section for V4.0.0 release.
    This captures the various changes  and documentation updates and felicitations to the various contributors.

    * Update History.txt

    * Update History.txt

    * Update History.txt

    * Pentest Update in History.txt

    Pentest Update in History.txt

    * Update History.txt

    * Update History.txt

    * Update History.txt for CBMC link

    * Update History.txt

    * Update History.txt

    * Update History.txt

    * Update History.txt

    ---------

    Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>

commit 7805363
Author: Monika Singh <moninom@amazon.com>
Date:   Wed Aug 9 22:26:06 2023 +0530

    Update readme (FreeRTOS#996)

    Co-authored-by: shubnil <103672514+shubnil@users.noreply.github.com>

commit 7681bb1
Author: Monika Singh <moninom@amazon.com>
Date:   Wed Aug 9 21:41:58 2023 +0530

    Update Getting Started Guide Doc (FreeRTOS#995)

    * Update getting started

    * Rename getting started

    * Remove rc reference

    ---------

    Co-authored-by: shubnil <103672514+shubnil@users.noreply.github.com>

commit f1aa0a0
Author: Monika Singh <moninom@amazon.com>
Date:   Wed Aug 9 21:12:01 2023 +0530

    Update Version number in doxygen and manifest for GA (FreeRTOS#993)

    * Update release version

    * Update kernel version

    ---------

    Co-authored-by: Tony Josi <tonyjosi@amazon.com>

commit 5757e07
Author: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
Date:   Wed Aug 9 20:31:01 2023 +0530

    Fix use of uninitialized variable warning (FreeRTOS#998)

    Signed-off-by: Gaurav Aggarwal <aggarg@amazon.com>

commit bb65463
Author: Monika Singh <moninom@amazon.com>
Date:   Wed Aug 9 11:38:30 2023 +0530

    Add README for ports (FreeRTOS#992)

    * Add readme for ports which are not ested

    * Update name

    * Add readme for pic32mzef

commit 8b90477
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Tue Aug 8 17:08:26 2023 +0530

    IAR warning fixes  (FreeRTOS#991)

    * remove forward declarations

    * Revert "remove forward declarations"

    This reverts commit a20213d.

    * supress IAR warnings

commit 40c16fe
Author: ActoryOu <jay2002824@gmail.com>
Date:   Tue Aug 8 09:23:39 2023 +0800

    Update function names in libslirp interface. (FreeRTOS#990)

commit 67b9e1c
Author: Monika Singh <moninom@amazon.com>
Date:   Mon Aug 7 14:32:28 2023 +0530

    Update File names (FreeRTOS#989)

    * Update File names

commit 941cad7
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Fri Aug 4 16:43:35 2023 +0530

    Gratuituous ARP fixes  (FreeRTOS#988)

    * adding more checks for GARP

    * adding more checks for GARP

    * adding more checks for GARP

    * more debug logs

    * more debug logs

    * more testing

    * verify subnet

    * fix formatting, cleaning up

    * fix formatting, cleaning up

    * adding unit tests

    * updating review comments

commit ae3cd02
Author: ActoryOu <jay2002824@gmail.com>
Date:   Fri Aug 4 17:14:53 2023 +0800

    Create IPv6 socket for DHCPv6 flow (FreeRTOS#987)

commit 62f5d3a
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Fri Aug 4 11:24:49 2023 +0530

    DNS callback to use new xDNSDoCallback API (FreeRTOS#985)

    * fix issue with DNS callback

    * update test cli code

    * fix formatting

    * fix build warnings

    * fix formatting

    * clang build fix

commit df5aed9
Author: ActoryOu <jay2002824@gmail.com>
Date:   Mon Jul 31 12:10:29 2023 +0800

    Check user related headers can be included independently. (FreeRTOS#982)

    * Header fix part 1

    * IP_Private

    * TEST_HEADER_INC_ONLY_IPv4

    * NetworkBufferManagement and NetworkInterface

    * Add CI flow to check user related headers can be included independently

    * Revert some redundant change

    * Add CI flow and fix formatting

    * Use -include compile option to test header self contain.

    ---------

    Co-authored-by: Monika Singh <moninom@amazon.com>

commit 9b903bd
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Fri Jul 28 11:21:14 2023 +0530

    Update Renesas RX network interface port (FreeRTOS#983)

    * wip basic compilation fix

    * add BSP_MCU_RX72N to checks

    * wip

    * build fix

    * testing with buffer allocation 1 of +TCP

    * clean up code

    * use macro instead of magic numbers

    * fix formatting

    * update review comments

commit 1c7623d
Author: Emil Popov <evpopov@gmail.com>
Date:   Fri Jul 28 01:25:34 2023 -0400

    Improves the calculation of the offset at which we store the IP version value (FreeRTOS#979)

    * Defines ipUDP_PAYLOAD_IP_TYPE_OFFSET as an offset dependent on the IPv6 and UDP headers.
    Calculates ipIP_TYPE_OFFSET automatically based on the sizes it depends on instead of using a hardcoded number.
    Removes the definitions of ipIP_TYPE_OFFSET and ipUDP_PAYLOAD_IP_TYPE_OFFSET from FreeRTOS_IPv6_Private.h because they are already defined in FreeRTOS_IPv4_Private.h
    Makes ipIP_TYPE_OFFSET define signed so asserts can properly check for negative values.
    Adds an assert to ensure that storing of the IP-Type for IPv4 frames does not result in overwriting the ethernet header which would be the case if ipIP_TYPE_OFFSET somehow became negative or zero.
    Adds a comment to the code storing of the IP-Type byte for IPv6 frames emphasizing that it is not required and only used for debugging.

    * Uncrustify: triggered by comment.

    * Correct the comment of ipUDP_PAYLOAD_IP_TYPE_OFFSET.

    ---------

    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
    Co-authored-by: GitHub Action <action@github.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>
    Co-authored-by: Tony Josi <tonyjosi@amazon.com>

commit 574b646
Author: Monika Singh <moninom@amazon.com>
Date:   Fri Jul 28 10:25:24 2023 +0530

    Fix Clang warnings (FreeRTOS#984)

    * CMAKe update

    * Fix Wdocumentation errors

    * Fix Wconditional-uninitialized

    * Fix [-Wformat-pedantic

    * Fix Wcompound-token-split-by-space and Wgnu-statement-expression

    * Add suppression

    * Uncrustify: triggered by comment.

    * Fix coverity

    ---------

    Co-authored-by: GitHub Action <action@github.com>

commit b23fa86
Author: Monika Singh <moninom@amazon.com>
Date:   Thu Jul 27 15:56:36 2023 +0530

    Add and fix -Wconversion errors (FreeRTOS#980)

    * Fix Wconverstion

    * Enable Wconversion warning

    * Add fix

    * Fix MISRA

    * Fix coverity

    * Add comments

commit 14b3e24
Author: Monika Singh <moninom@amazon.com>
Date:   Wed Jul 26 13:59:06 2023 +0530

    Fix use of extern C block (FreeRTOS#981)

    * Fix use of extern C block

    * Uncrustify: triggered by comment.

    ---------

    Co-authored-by: GitHub Action <action@github.com>

commit 5e1c991
Author: ActoryOu <jay2002824@gmail.com>
Date:   Tue Jul 25 18:39:58 2023 +0800

    Remove duplicate configurations (FreeRTOS#978)

    * Remove duplicate configurations

    * Move LLMNR/NBNS back before USE_DNS

commit b863f68
Author: Tony Josi <tonyjosi@amazon.com>
Date:   Mon Jul 24 15:10:25 2023 +0530

    [PR#482] - Update ARP cache from gratuitous ARP packets v2 (FreeRTOS#974)

    * Let the TCP timer becomes expired in stead of active

    * Renamed parameter of function vIPSetTCPTimerExpiredState

    * Adapt unit tests to use the new name and field

    * Change bActive to bExpired

    * Empty commit

    * Fix spell check

    * When a gratuitous ARP is received, use it to update the ARP cache entry

    * wip

    * adding comments on matching endpoint for Gratuitous ARP

    * adding unit tests for Gratuitous ARP processing, fix formatting

    * fix build

    * fix formatting

    * fix formatting

    * fic CBMC

    * adding review changes

    ---------

    Co-authored-by: Hein Tibosch <hein@htibosch.net>
    Co-authored-by: Hein Tibosch <hein_tibosch@yahoo.es>
    Co-authored-by: Aniruddha Kanhere <60444055+AniruddhaKanhere@users.noreply.github.com>

commit 6a0ce66
Author: Monika Singh <moninom@amazon.com>
Date:   Mon Jul 24 00:02:54 2023 +0530

    Fixes mDNS over IPv6  (FreeRTOS#977)

    * Add more descriptions of ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM (FreeRTOS#947)

    * Fixes mDNS over IPv6. (FreeRTOS#949)

    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
    Co-authored-by: ActoryOu <jay2002824@gmail.com>
    Co-authored-by: Monika Singh <moninom@amazon.com>

    ---------

    Co-authored-by: ActoryOu <jay2002824@gmail.com>
    Co-authored-by: Emil Popov <evpopov@gmail.com>
    Co-authored-by: Emil Popov <epopov@cardinalkinetic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants