driver: eth: Support for lan8651 T1S ETH (with OA TC6 library) #63614

lmajewski · 2023-10-06T10:49:25Z

This patch set provides support for T1S ethernet device - LAN8651.

For communication the approach described in Open Alliance TC6 specification is used. This code (from oa_tc6.[ch]) can be reused with other ICs following this standard.

Test HW:

nucleo_g491re development board from STM
Microe LAN8651 module
LAN8670-USB dongle with debian12 as host

Build:

west build -p always -b nucleo_g431rb samples/net/sockets/echo_server/ \
	-- -DCONF_FILE=boards/nucleo_g431rb.conf

Test on host PC (one needs to first build echo-client program from net-tools):

while :; do ./echo-client -r -i enx001ec0d1cc4d  192.168.3.3; sleep 1; \
	ping -c3 192.168.3.3; done

Code required for testing and debugging:
https://github.com/lmajewski/zephyr/commits/t1s-lan8651-nucleo_g431rb-test

lmajewski · 2023-10-06T10:55:35Z

List of interested developers: @GeorgeCGV @uwearzt @lunn

lmajewski · 2023-10-06T11:01:46Z

Setup LAN8670-USB dongle (to be connected to T1S host) - debian12 (kernel 6.1):
###################################################################

cd lan867x-linux-driver-1v0/linux-v6.1.21-support
make
sudo --preserve-env=KBUILD_SIGN_PIN /usr/src/linux-kbuild-6.1/scripts/sign-file sha256 /var/lib/shim-signed/mok/MOK.priv /var/lib/shim-signed/mok/MOK.der microchip_t1s.ko
sudo insmod microchip_t1s.ko enable=1 node_id=0 node_count=8 max_bc=0 burst_timer=128 to_timer=32

Note:
The smsc95xx module shall be loaded first (before the usb dongle is inserted) - otherwise it will
use default PHY driver (not the one for microchip).

To fix it use:
$ echo <usb_device_name> | sudo tee /sys/bus/usb/drivers/smsc95xx/unbind > /dev/null
$ sudo insmod microchip_t1s.ko
$ echo <usb_device_name> | sudo tee /sys/bus/usb/drivers/smsc95xx/bind > /dev/null

Design decisions:
#################

The OA_TC6 routines are using the struct tc6 and struct net_pkt as input.
It was on purpose to tie it with net_pkt as this is what we do receive to send
and what is read to upper layers.
The driver supports half-duplex in terms of the data transmission to/from LAN8651
via SPI (i.e. when TX is performed, no valid data is read).

It can be added, but would increase the design of driver and memory footprint.

I need to assess if this is worth the effort - for now the driver is as simple
as possible.
The driver design differs from Linux one [1], as I had to take into account the
constrained RAM evironment in Cortex-M4 based CPUs (STM32G491 from nucleo_g491re
has only 32KiB of RAM to fit network stack and LAN865x driver).
The PHY part of LAN8651 is very limited - for example the link status is always 1,
hence there was no good reason to add separate PHY driver (as it was done for
adin2111).

Test scenarios:
###############

ARP and ICMP from HOST (ping)
ping 192.168.3.3
echo_client (on my Linux HOST PC) -> UDP only
while :; do ./echo-client -r -i enx001ec0d1cc4d 192.168.3.3; sleep 1; ping -c3 192.168.3.3; done
echo_server run on nucleo_g491:

west build -p always -b nucleo_g431rb samples/net/sockets/echo_server/ -- -DSHIELD="mikroe_twowire_eth_click_arduino" -DEXTRA_CONF_FILE=boards/nucleo_g431rb_microe_twowire_eth_click.conf
zperf (CONFIG_NET_ZPERF) cannot be used as it turns out that RAM size is exceeded
(nucleo_g431re has STM32G491 with only 32 KiB or RAM)

What is missing:
################

Setup of PLCA parameters from user programs (only DTS is used now)
(if there would be need a to add the special network management callback
Callback to adjust MAC address
SW based reset - at least on LAN8651 rev B0 simple OA_RESET bit 0
set has some issues. GPIO based reset works correctly.
For performance improvement: Modify the code to use k_fifo for RX/TX and perform full-duplex SPI transmission in a separate thread based on in the FIFO data available. This is ongoing work and can be added after the "base" OA TC6 code is added.

Dependencies:
#############
#63239
lmajewski@912115f

Open Questions:
#############

where to place the oa_tc.[ch] agnostic files?

jukkar

Looks quite resonable. Please fix the compliance issues, there are several whitespace issues in the code.
Please change the driver commit subject to
driver: eth: Support for lan8651 T1S ETH

drivers/ethernet/Kconfig.lan865x

drivers/ethernet/eth_lan865x.c

drivers/ethernet/oa_tc6.c

jukkar · 2023-10-06T14:16:15Z

samples/net/sockets/echo_server/boards/nucleo_g431rb.conf

@@ -0,0 +1,52 @@
+# Generic networking options


This sample board config should be in a separate commit.

Please only place here board specific stuff so that the main prj.conf in that sample will be the master information and here we just tweak things needed for this board. Do not place config options specific to your local setup here (like IP addresses etc).

The prj.conf file needs changes as shown in nucleo_g431rb.conf, otherwise the sample will not build (excess of on-board RAM).

IMHO, it would be better to have a complete setup there for this particular development board, so other users can reproduce this setup easily.

Sorry, but this is not a way here. The prj.conf will be the master of the config and the config in board/ directory can then add or adjust the configuration parameters. This way if any new config options are added in prj.conf, the compilation for this board will automatically use them and we do not need to adjust two files.

samples/net/sockets/echo_server/boards/nucleo_g431rb.conf

samples/net/sockets/echo_server/boards/nucleo_g431rb.overlay

jukkar · 2023-10-06T14:24:24Z

where to place the oa_tc.[ch] agnostic files?

I suppose we could start with drivers/ethernet directory, or a sub-directory there

jukkar

Please check the compliance issues

samples/net/sockets/echo_server/boards/nucleo_g431rb.conf

jukkar · 2023-10-09T10:32:38Z

samples/net/sockets/echo_server/boards/nucleo_g431rb.conf

@@ -0,0 +1,52 @@
+# Generic networking options


Sorry, but this is not a way here. The prj.conf will be the master of the config and the config in board/ directory can then add or adjust the configuration parameters. This way if any new config options are added in prj.conf, the compilation for this board will automatically use them and we do not need to adjust two files.

boards/shields/mikroe_twowire_eth_click/mikroe_twowire_eth_click_arduino.overlay

lmajewski · 2023-11-03T10:34:23Z

Sorry, but I shouldn't be the assignee on such PR no shield, noSTM32). Assigning @rlubos as PR has already been reviewed by @jukkar.

The aforementioned "shield" has been removed with this PR, as it has been pointed out that Zephyr will not accept non compatible combination of base board (nucleo) and MicroBus shield.

Moreover, I would appreciate if we could finish with review of this PR.

jukkar · 2023-11-03T11:47:54Z

@erwango if you are not reviewing this any more, please remove your -1

Not involved in area

lmajewski · 2023-11-03T15:26:06Z

@jukkar - I had to rebase those patches on top of newest origin/main branch. The only change was with Kconfig.

lmajewski · 2023-11-06T10:46:54Z

@jukkar - Please find list of enhancements for this driver (as I had to rebase it on top of newest 'main' branch):

Add support for setting MAC address
Reduce IRQ stack size
Check if received frame shall be dropped (based on footer information)
Optimize 'sbo' and 'ebo' usage when receiving packets
Handle special case when frame ends and starts in the same chunk

drivers/ethernet/eth_lan865x.c

Those files provide generic functions to handle transmission between chip conforming OA TC6 standard and Zephyr's network stack represented by struct net_pkt. The communication is performed via SPI and is focused on reduced memory footprint (works with SOC equipped with 32 KiB of RAM) and robustness of operation. Signed-off-by: Lukasz Majewski <lukma@denx.de>

jfischer-no

Nice 👍

drivers/ethernet/eth_lan865x.c

This patch set provides support for T1S ethernet device - LAN8651. For SPI communication the implementation of Open Alliance TC6 specification is used. The driver implementation focuses mostly on reducing memory footprint, as the used SoC (STM32G491) for development has only 32 KiB RAM in total. Signed-off-by: Lukasz Majewski <lukma@denx.de>

lmajewski requested review from rlubos, tbursztyka, jukkar and galak as code owners October 6, 2023 10:49

zephyrbot added area: Networking area: Sockets Networking sockets area: Devicetree Binding PR modifies or adds a Device Tree binding area: Ethernet platform: Microchip MEC Microchip MEC Platform labels Oct 6, 2023

zephyrbot requested review from albertofloyd, jvasanth1, ssharks and VenkatKotakonda October 6, 2023 10:50

lmajewski mentioned this pull request Oct 6, 2023

Microchip's TC6 OA library for T1S #62440

Closed

jukkar reviewed Oct 6, 2023

View reviewed changes

lmajewski changed the title ~~RFC: net: eth: Support for lan8651 T1S ETH (with OA TC6 library)~~ driver: eth: Support for lan8651 T1S ETH (with OA TC6 library) Oct 6, 2023

lmajewski force-pushed the t1s-lan8651-nucleo_g431rb branch from 27e2ccc to c043401 Compare October 6, 2023 15:25

jukkar requested changes Oct 9, 2023

View reviewed changes

lmajewski force-pushed the t1s-lan8651-nucleo_g431rb branch from c043401 to 2054156 Compare October 10, 2023 10:24

lmajewski requested review from nashif and erwango as code owners October 10, 2023 10:24

zephyrbot added the area: Shields Shields (add-on boards) label Oct 10, 2023

zephyrbot requested review from avisconti, jfischer-no and kartben October 10, 2023 10:25

zephyrbot assigned erwango Oct 10, 2023

erwango previously requested changes Oct 10, 2023

View reviewed changes

boards/shields/mikroe_twowire_eth_click/mikroe_twowire_eth_click_arduino.overlay Outdated Show resolved Hide resolved

erwango assigned rlubos and unassigned erwango Nov 2, 2023

erwango removed the area: Shields Shields (add-on boards) label Nov 2, 2023

lmajewski dismissed jukkar’s stale review via 33475c1 November 3, 2023 15:23

lmajewski force-pushed the t1s-lan8651-nucleo_g431rb branch from f99c1b8 to 33475c1 Compare November 3, 2023 15:23

lmajewski force-pushed the t1s-lan8651-nucleo_g431rb branch from 33475c1 to 7200f6f Compare November 6, 2023 10:44

lmajewski mentioned this pull request Nov 6, 2023

Setting T1S ETH (e.g. PLCA) parameters from user program #64844

Open

jukkar reviewed Nov 6, 2023

View reviewed changes

drivers/ethernet/eth_lan865x.c Outdated Show resolved Hide resolved

lmajewski force-pushed the t1s-lan8651-nucleo_g431rb branch from 7200f6f to 457c2f0 Compare November 7, 2023 09:39

lmajewski requested a review from jukkar November 7, 2023 10:41

jukkar previously approved these changes Nov 7, 2023

View reviewed changes

jfischer-no reviewed Nov 8, 2023

View reviewed changes

drivers/ethernet/eth_lan865x.c Outdated Show resolved Hide resolved

lmajewski dismissed jukkar’s stale review via f55f690 November 8, 2023 11:15

lmajewski force-pushed the t1s-lan8651-nucleo_g431rb branch from 457c2f0 to f55f690 Compare November 8, 2023 11:15

lmajewski requested review from jfischer-no and jukkar November 8, 2023 11:16

jfischer-no approved these changes Nov 8, 2023

View reviewed changes

jukkar approved these changes Nov 9, 2023

View reviewed changes

rlubos approved these changes Nov 9, 2023

View reviewed changes

carlescufi merged commit 12665a0 into zephyrproject-rtos:main Nov 9, 2023
19 checks passed

lmajewski deleted the t1s-lan8651-nucleo_g431rb branch November 9, 2023 15:36

lmajewski mentioned this pull request Nov 21, 2023

drivers: net: lan8651: Provide fixes for OA TC6 LAN865x driver #65507

Merged

lmajewski mentioned this pull request Apr 17, 2024

Contributor Nomination - Łukasz Majewski (OA TC6 driver) #71616

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

driver: eth: Support for lan8651 T1S ETH (with OA TC6 library) #63614

driver: eth: Support for lan8651 T1S ETH (with OA TC6 library) #63614

lmajewski commented Oct 6, 2023 •

edited

lmajewski commented Oct 6, 2023

lmajewski commented Oct 6, 2023 •

edited

jukkar left a comment

jukkar Oct 6, 2023

lmajewski Oct 6, 2023

jukkar Oct 9, 2023

jukkar commented Oct 6, 2023

jukkar left a comment

jukkar Oct 9, 2023

lmajewski commented Nov 3, 2023

jukkar commented Nov 3, 2023

lmajewski commented Nov 3, 2023

lmajewski commented Nov 6, 2023

jfischer-no left a comment

driver: eth: Support for lan8651 T1S ETH (with OA TC6 library) #63614

driver: eth: Support for lan8651 T1S ETH (with OA TC6 library) #63614

Conversation

lmajewski commented Oct 6, 2023 • edited

lmajewski commented Oct 6, 2023

lmajewski commented Oct 6, 2023 • edited

jukkar left a comment

Choose a reason for hiding this comment

jukkar Oct 6, 2023

Choose a reason for hiding this comment

lmajewski Oct 6, 2023

Choose a reason for hiding this comment

jukkar Oct 9, 2023

Choose a reason for hiding this comment

jukkar commented Oct 6, 2023

jukkar left a comment

Choose a reason for hiding this comment

jukkar Oct 9, 2023

Choose a reason for hiding this comment

lmajewski commented Nov 3, 2023

jukkar commented Nov 3, 2023

lmajewski commented Nov 3, 2023

lmajewski commented Nov 6, 2023

jfischer-no left a comment

Choose a reason for hiding this comment

lmajewski commented Oct 6, 2023 •

edited

lmajewski commented Oct 6, 2023 •

edited