drivers: add ATWINC15x0 WiFi netdev driver #13754

gschorcht · 2020-03-30T13:25:41Z

Contribution description

This PR adds a netdev driver for the Microchip ATWINC15x0 WiFi module.

Background

The ATWINC15x0 WiFi module is used on several boards and extension boarsd, for example:

Adafruit Feather M0 WiFi
ATWIN1500-XPRO for the extension of Atmel Xplained PRO boards
Adafruit ATWINC1500 WiFi breakout
Watterott ATWINC1500-Breakout

Furthermore, the ATWINC15x0 WiFi module is the only module supported by the standard Arduino WiFi101 library. Therefore, there are a number of Arduino shields with the ATWINC15x0 WiFi module, e.g. Adafruit WINC1500 WiFi Shield for Arduino.

Using this netdev driver together with an ATWINC15x0 WiFi module enables the connection via WiFi in RIOT. Thus, ATWINC15x0 WiFi module can be used as netdev for GNRC as well as lwIP netifs.

Current Status

The driver works out of the box for the following boards that have the ATWINC15x0 on-board:

It was also tested with an Adafruit WINC1500 WiFi Shield for Arduino for ESP32 and STM32 Nucleo-F411RE.

Arduino AVR boards unfortunately have too less RAM.

The driver supports following WiFi security modes:

WPA2 Personal mode (PSK)
Open System.

WPA2 enterprise mode with IEEE 802.1X/EAP authentication is not supported for the following reasons:

At least ATWINC15x0 firmware version 19.6.1 is required, but most available modules still have a firmware version lower than 19.5.0. Older firmware versions support EAP-TTLSv0/MSCHAPv2 but use an invalid SSL/TLS version.
At least version 19.6.1 of the ATWINC15x0 vendor driver is required. The driver version used by this netdev driver, which is available as open source, is version 19.5.2.

Future Work

At the moment, only station mode is implemented. It might be interesting to support AP mode so that it could be used in a border router.

Testing procedure

It should work with examples/gnrc_networking

USEMODULE='atwinc15x0' \
CFLAGS='-DWIFI_SSID=\"ssid\" -DWIFI_PASS=\"pass\" \
        -DATWINC15X0_PARAM_SSN_PIN=GPIO_PIN\(1,6\) \
        -DATWINC15X0_PARAM_RESET_PIN=GPIO_PIN\(1,4\) \
        -DATWINC15X0_PARAM_IRQ_PIN=GPIO_PIN\(0,8\)' \
make BOARD=... -C examples/gnrc_networking flash term

Issues/PRs references

aabadie · 2020-03-30T13:28:43Z

Is it a take-over from #7433 ?

Otherwise thanks for providing this. I'm be able to test this PR on arduino-mkr1000.

gschorcht · 2020-03-30T13:37:58Z

Is it a take-over from #7433 ?

No, I didn't know that. Even though I searched for all combinations winc, atwinc, atwinc1500, winc1500, atwinc15x0, winc15x0, ... in issues and PRs to avoid duplicates, I didn't find it. Probably because I didn't search in closed issues and PRs.

I'm be able to test this PR on arduino-mkr1000.

Sounds good.

aabadie · 2020-03-30T13:41:57Z

Even though I searched for all combinations winc, atwinc, atwinc1500, winc1500, atwinc15x0, winc15x0, ... in issues and PRs to avoid duplicates, I didn't find it. Probably because I didn't search in closed issues and PRs.

You can blame the stale bot ;)

gschorcht · 2020-03-30T13:43:44Z

I'm be able to test this PR on arduino-mkr1000.

@aabadie Thanks for pointing out this board. I found such a board, which I bought 3 years ago, unused in a box. I will try the driver with this board to refine the default parameters of the driver a little bit.

gschorcht · 2020-03-30T13:45:35Z

You can blame the stale bot ;)

But at that time there was also no reaction from the author for over a year. So closing the PR was correct.

aabadie · 2020-03-30T13:49:44Z

But at that time there was also no reaction from the author for over a year. So closing the PR was correct.

I know, it was a joke :)

gschorcht · 2020-03-30T14:05:38Z

@aabadie My first test with mkr1000 did not work, I have to check whether I used the right GPIOs.

gschorcht · 2020-03-30T14:34:43Z

@aabadie Good news. Worked for me for mkr1000 with following configuration. I had to use SPI_DEV(1) instead of SPI_DEV(0).

USEMODULE='atwinc15x0' \
CFLAGS='-DGNRC_IPV6_NIB_CONF_SLAAC=1 -DDEBUG_ASSERT_VERBOSE \
        -DWIFI_SSID=\"<ssid>\" -DWIFI_PASS=\"<pass>\" \
        -DATWINC15X0_PARAM_SPI=SPI_DEV\(1\) \
        -DATWINC15X0_PARAM_SSN_PIN=GPIO_PIN\(0,14\) \
        -DATWINC15X0_PARAM_RESET_PIN=GPIO_PIN\(0,27\) 
        -DATWINC15X0_PARAM_IRQ_PIN=GPIO_PIN\(1,9\) \
        -DATWINC15X0_PARAM_CHIP_EN_PIN=GPIO_PIN\(0,28\) \
        -DATWINC15X0_PARAM_WAKE_PIN=GPIO_PIN\(1,8\)' \
make BOARD=arduino-mkr1000 -C examples/gnrc_networking flash

> ifconfig
Iface  7  HWaddr: F8:F0:05:F5:E1:50  Link: up 
L2-PDU:1500 MTU:1440  HL:255  RTR  
RTR_ADV  
Source address length: 6
Link type: wireless
inet6 addr: fe80::faf0:5ff:fef5:e150  scope: link  VAL
inet6 addr: 2003:c1:e703:555:faf0:5ff:fef5:e150  scope: global  VAL
inet6 group: ff02::2
inet6 group: ff02::1
inet6 group: ff02::1:fff5:e150

          Statistics for Layer 2
          Statistics for IPv6

I don't know why the output of `ifconfig' is not correctly indented. On ESP32 the indentations are correct.

Anyway, the driver works with mkr1000 and we could enable WiFi in board definition once the driver has been finished and is merged.

aabadie · 2020-03-30T14:40:22Z

Well done @gschorcht!

I don't know why the output of `ifconfig' is not correctly indented

I think this problem comes from the stdio over USB layer. For some reasons, the \t character is dropped.

benpicco · 2020-03-30T14:43:57Z

@aabadie Good news. Worked for me for mkr1000 with following configuration

#define ATWINC15X0_PARAM_SPI         SPI_DEV(1)
#define ATWINC15X0_PARAM_SSN_PIN     GPIO_PIN(0,14) 
#define ATWINC15X0_PARAM_RESET_PIN   GPIO_PIN(0,27) 
#define ATWINC15X0_PARAM_IRQ_PIN     GPIO_PIN(1,9)
#define ATWINC15X0_PARAM_CHIP_EN_PIN GPIO_PIN(0,28)
#define ATWINC15X0_PARAM_WAKE_PIN    GPIO_PIN(1,8)

better add that to the board's board.h then

gschorcht · 2020-03-30T14:45:19Z

I think this problem comes from the stdio over USB layer. For some reasons, the \t character is dropped.

It seem that it donsn't like spaces directly after the newline. The following function is responsible for the line break and the indentation:

RIOT/sys/shell/commands/sc_gnrc_netif.c

Lines 364 to 371 in e738508

    
           static unsigned _newline(unsigned threshold, unsigned line_thresh) 
        
           { 
        
               if (line_thresh > threshold) { 
        
                   printf("\n          "); 
        
                   line_thresh = 0U; 
        
               } 
        
               return line_thresh; 
        
           }

gschorcht · 2020-03-30T14:49:15Z

#define ATWINC15X0_PARAM_SPI         SPI_DEV(1)
#define ATWINC15X0_PARAM_SSN_PIN     GPIO_PIN(0,14) 
#define ATWINC15X0_PARAM_RESET_PIN   GPIO_PIN(0,27) 
#define ATWINC15X0_PARAM_IRQ_PIN     GPIO_PIN(1,9)
#define ATWINC15X0_PARAM_CHIP_EN_PIN GPIO_PIN(0,28)
#define ATWINC15X0_PARAM_WAKE_PIN    GPIO_PIN(1,8)

better add that to the board's board.h then

That was my intention, of course. I just wanted to try out the settings on the command line first. I also suppose the ATWINC15x0 netdev should be defined netdev_default device.

gschorcht · 2020-03-30T14:52:59Z

#define ATWINC15X0_PARAM_SPI         SPI_DEV(1)
#define ATWINC15X0_PARAM_SSN_PIN     GPIO_PIN(0,14) 
#define ATWINC15X0_PARAM_RESET_PIN   GPIO_PIN(0,27) 
#define ATWINC15X0_PARAM_IRQ_PIN     GPIO_PIN(1,9)
#define ATWINC15X0_PARAM_CHIP_EN_PIN GPIO_PIN(0,28)
#define ATWINC15X0_PARAM_WAKE_PIN    GPIO_PIN(1,8)

better add that to the board's board.h then

And I will do the same for the Adafruit feather M0 WiFi once I have tested.

@benpicco BTW, now it's time to introduce WIFI_SSID and WIFI_PATH as common configurations 😉

gschorcht · 2020-06-25T12:17:28Z

And for drivers and pkgs, this happens way after:

RIOT/Makefile.include

Lines 452 to 455 in c0d171a

include $(RIOTBASE)/drivers/Makefile.include

# include Makefile.includes for packages in $(USEPKG)

-include $(USEPKG:%=$(RIOTPKG)/%/Makefile.include)

Changing that order would affect too many things and I don't think that doable.

That's clear.

But I have found another trick by adding the include path to CFLAGS in pkg/atwin15x0/Makefile.

CFLAGS += -I$(PKG_BUILDDIR)/src

With this trick the driver's package include path is the first one and the compilation of the driver package works.

I know, it is tricky and breaks the usual handling of include paths, but it helps. What do you think?

aabadie · 2020-06-25T12:35:55Z

What do you think?

Since this is only done for the package itself it shouldn't have too much impact. So I think that's ok.

gschorcht · 2020-06-26T06:28:36Z

@aabadie I had to change the dependencies and the include order of the driver header files a bit to make LLVM happy. The reason was a forward type declaration that requires C11.

I'm a bit surprised that the compilation worked with -std=c99 for all platforms but not for LLVM.
I'm wondering why we still use -std=c99 by default even though all our platform toolchains support C11? Wasn't there a PR which switches to C11 by default (@maribu)?

aabadie · 2020-06-26T06:30:11Z

all our platform toolchains support C11?

I don't think that's the case for AVR.

gschorcht · 2020-06-26T07:48:11Z

@aabadie Compilation succeed now. May I squash?

aabadie · 2020-06-26T07:53:26Z

May I squash?

Yes please !

gschorcht · 2020-06-26T09:56:56Z

@aabadie Should I add proactively a driver/atwinc15x0/Makefile.include regarding PR #14369? It shouldn't have any effect before PR #14369 is merged but it will avoid conflicts if this PR is merged befor PR #14369.

aabadie · 2020-06-26T09:58:35Z

Should I add proactively a driver/atwinc15x0/Makefile.include regarding PR #14369?

Don't worry about #14369, I can rebase it later :)

aabadie · 2020-06-26T10:01:48Z

pkg/driver_atwinc15x0/Makefile

+	"$(MAKE)" MODULE=driver_atwinc15x0 -C $(PKG_BUILDDIR)/src/driver/source -f $(RIOTBASE)/Makefile.base
+	"$(MAKE)" MODULE=driver_atwinc15x0_common -C $(PKG_BUILDDIR)/src/common/source -f $(RIOTBASE)/Makefile.base
+	"$(MAKE)" MODULE=driver_atwinc15x0_spi_flash -C $(PKG_BUILDDIR)/src/spi_flash/source -f $(RIOTBASE)/Makefile.base


#14289 was merged so this Makefile must be adapted once again:

Suggested change

"$(MAKE)" MODULE=driver_atwinc15x0 -C $(PKG_BUILDDIR)/src/driver/source -f $(RIOTBASE)/Makefile.base

"$(MAKE)" MODULE=driver_atwinc15x0_common -C $(PKG_BUILDDIR)/src/common/source -f $(RIOTBASE)/Makefile.base

"$(MAKE)" MODULE=driver_atwinc15x0_spi_flash -C $(PKG_BUILDDIR)/src/spi_flash/source -f $(RIOTBASE)/Makefile.base

"$(MAKE)" -C $(PKG_SOURCE_DIR)/src/driver/source -f $(RIOTBASE)/Makefile.base MODULE=driver_atwinc15x0

"$(MAKE)" -C $(PKG_SOURCE_DIR)/src/common/source -f $(RIOTBASE)/Makefile.base MODULE=driver_atwinc15x0_common

"$(MAKE)" -C $(PKG_SOURCE_DIR)/src/spi_flash/source -f $(RIOTBASE)/Makefile.base MODULE=driver_atwinc15x0_spi_flash

(I also propose to move the MODULE=xxx at the end of the line, it's purely a cosmetic change regarding the build output)

May I squash these changes directly to avoid an extra loop in the long, long CI compilation queue?

May I squash these changes directly to avoid an extra loop in the long, long CI compilation queue?

Sure, let's save some CI time.

fixup! pkg: add ATWINC15x0 vendor driver as package fixup! pkg: add ATWINC15x0 vendor driver as package

aabadie

Tested again on arduino-mkr1000 and it still works.

Code changes are now good enough to be merged.

ACK

Thanks for the awesome work @gschorcht !

gschorcht · 2020-06-26T13:55:49Z

@aabadie Thanks for you patience, the reviewing, testing and merging.

Now that we have more than one WiFi network dev, we should pick up the ball again to expose the WiFi configuration via Kconfig, as started in #13135 (@leandrolanzieri).

gschorcht requested review from cgundogan, haukepetersen, miri64 and PeterKietzmann as code owners March 30, 2020 13:25

gschorcht requested review from aabadie and benpicco and removed request for haukepetersen, miri64, cgundogan and PeterKietzmann March 30, 2020 13:26

gschorcht changed the title ~~drivers: add ATWINC15x0 netdev driver~~ drivers: add ATWINC15x0 WiFi netdev driver Mar 30, 2020

gschorcht added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Jun 26, 2020

gschorcht force-pushed the drivers/atwinc15x0 branch from cceb6dc to 009daf7 Compare June 26, 2020 08:48

aabadie reviewed Jun 26, 2020

View reviewed changes

gschorcht force-pushed the drivers/atwinc15x0 branch from 009daf7 to cc2277a Compare June 26, 2020 10:18

gschorcht added 9 commits June 26, 2020 12:33

pkg: add ATWINC15x0 vendor driver as package

649b315

fixup! pkg: add ATWINC15x0 vendor driver as package fixup! pkg: add ATWINC15x0 vendor driver as package

drivers: add netdev driver for ATWINC15x0 WiFi module

660a852

sys/net: add NETOPT_RSSI for wireless channels

c95ebb6

sys/net/gnrc: add netif support for ATWINC15x0 netdef driver

b51ac69

pkg/lwip: support of ATWINC15x0 WiFi netdev

f92d2ac

tests: application for ATWINC15x00 driver test

1ee0b8c

boards/mkr1000: add ATWINC15x0 WiFi driver

35c0524

boards/feather-m0: add ATWINC15x0 WiFi driver

3f8b237

pkg/driver_atwinc15x0: enable vendor spi_flash

4b38d37

gschorcht force-pushed the drivers/atwinc15x0 branch from cc2277a to 4b38d37 Compare June 26, 2020 10:39

aabadie approved these changes Jun 26, 2020

View reviewed changes

aabadie merged commit 81b7709 into RIOT-OS:master Jun 26, 2020

gschorcht deleted the drivers/atwinc15x0 branch June 26, 2020 13:56

gschorcht mentioned this pull request Jun 27, 2020

paho-mqtt: add package and example #12647

Merged

miri64 added this to the Release 2020.07 milestone Jun 29, 2020

gschorcht mentioned this pull request Jan 15, 2021

drivers/bme680: replace pkg with module #15738

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

drivers: add ATWINC15x0 WiFi netdev driver #13754

drivers: add ATWINC15x0 WiFi netdev driver #13754

gschorcht commented Mar 30, 2020 •

edited

Loading

aabadie commented Mar 30, 2020

gschorcht commented Mar 30, 2020

aabadie commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020

aabadie commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020 •

edited

Loading

aabadie commented Mar 30, 2020 •

edited

Loading

benpicco commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Jun 25, 2020

aabadie commented Jun 25, 2020

gschorcht commented Jun 26, 2020

aabadie commented Jun 26, 2020 •

edited

Loading

gschorcht commented Jun 26, 2020

aabadie commented Jun 26, 2020

gschorcht commented Jun 26, 2020

aabadie commented Jun 26, 2020

aabadie Jun 26, 2020

gschorcht Jun 26, 2020

gschorcht Jun 26, 2020

aabadie Jun 26, 2020

aabadie left a comment

gschorcht commented Jun 26, 2020

drivers: add ATWINC15x0 WiFi netdev driver #13754

drivers: add ATWINC15x0 WiFi netdev driver #13754

Conversation

gschorcht commented Mar 30, 2020 • edited Loading

Contribution description

Testing procedure

Issues/PRs references

aabadie commented Mar 30, 2020

gschorcht commented Mar 30, 2020

aabadie commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020

aabadie commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020 • edited Loading

aabadie commented Mar 30, 2020 • edited Loading

benpicco commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Mar 30, 2020

gschorcht commented Jun 25, 2020

aabadie commented Jun 25, 2020

gschorcht commented Jun 26, 2020

aabadie commented Jun 26, 2020 • edited Loading

gschorcht commented Jun 26, 2020

aabadie commented Jun 26, 2020

gschorcht commented Jun 26, 2020

aabadie commented Jun 26, 2020

aabadie Jun 26, 2020

Choose a reason for hiding this comment

gschorcht Jun 26, 2020

Choose a reason for hiding this comment

gschorcht Jun 26, 2020

Choose a reason for hiding this comment

aabadie Jun 26, 2020

Choose a reason for hiding this comment

aabadie left a comment

Choose a reason for hiding this comment

gschorcht commented Jun 26, 2020

gschorcht commented Mar 30, 2020 •

edited

Loading

gschorcht commented Mar 30, 2020 •

edited

Loading

aabadie commented Mar 30, 2020 •

edited

Loading

aabadie commented Jun 26, 2020 •

edited

Loading