Expanding "shield" functionality (example uses WNC-M14A2A and SARA modem) #14057

mike-scott · 2019-03-05T01:38:23Z

I took some time today to see if I could setup a "shield" to represent the AT&T LTE-M WNC-M14A2A-based Arduino-R3 compatible shield.

This is very rough work and generates a few warnings when compiling, but this RFC patch series handles the following "special cases" which I encountered:

I felt like a shield-based .conf file simplified everything. So I added handling for that (as opposed to adding overlay-conf files into each sample or creating special samples for the shield).
AT&T LTE-M shield uses non-standard UART pins on the headers and Nordic UART needs tx, rx, cts and rts pins configured for nRF52840_pca10056, so I added handling for [shield]X[board].overlay files which could be board specific.
No current shields use GPIOs, and in order to configure the A0-A5 & D0-D13 Arduino pins, I created a new dts binding for arduino-header-r3.
Then I configured those pins in the frdm_k64f and nrf52840_pca10056 DTS files and assign them arduino_d1/d2 handle names.
I adjusted the WNC-M14A2A modem driver and DTS bindings slightly to allow for the use of aliases for the pins instead of the dts-binding gpios. This way driver can be used for the shield-based WNC-M14A2A or if a piece of HW had the modem directly connected, it could still be configured completely in the board's DTS.
Finally I add the actual wnc_m14a2a shield complete with it's own overlay file, conf file, and board-based overlays. (Missing docs for the moment).

The following now works to build the LwM2M client for each of the 2 configured boards:

$ cd samples/net/lwm2m_client/
$ mkdir build && cd build
$ cmake -DBOARD=frdm_k64f -DSHIELD=wnc_m14a2a ..
or
$ cmake -DBOARD=nrf52840_pca10056 -DSHIELD=wnc_m14a2a ..

These warnings are generated since I named the alias "gpios":

nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-boot-mode-sel-gpios: cell 0 is not a phandle reference
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-boot-mode-sel-gpios: Could not get phandle node for (cell 0)
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-power-gpios: cell 0 is not a phandle reference
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-power-gpios: Could not get phandle node for (cell 0)
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-keep-awake-gpios: cell 0 is not a phandle reference
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-keep-awake-gpios: Could not get phandle node for (cell 0)
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-reset-gpios: cell 0 is not a phandle reference
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-reset-gpios: Could not get phandle node for (cell 0)
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-shld-trans-ena-gpios: cell 0 is not a phandle reference
nrf52840_pca10056.dts_compiled: Warning (gpios_property): /aliases:dt-wnc-m14a2a-0-mdm-shld-trans-ena-gpios: Could not get phandle node for (cell 0)

However, it looks like the generated include file has the right defines/values in it.

I am also working on the U-blox SARA R41xx modem driver, which is present in the Particle.io Boron board as well as a SparkFun LTE-M Arduino shield. It uses the standard UART exposed by Arduino so it won't need per board .overlay files, but this series solves a lot of the issues I am hitting with that driver as well (reset and power GPIOs, etc).

Please discuss.

zephyrbot · 2019-03-05T01:42:44Z

All checks are passing now.

Review history of this comment for details about previous failed status.
Note that some checks might have not completed yet.

SebastianBoe

The approach looks sane.

I'd prefer it if we could express this pattern in DT source code, instead of in the toolchain, but AFAICT this is impossible.

This pattern needs documentation.

boards/shields/wnc_m14a2a/wnc_m14a2a.conf

cmake/app/boilerplate.cmake

cmake/kconfig.cmake

mike-scott · 2019-03-05T17:44:35Z

@SebastianBoe Thank you for the great feedback! I'll put up a v2 with your comments accounted for.

boards/shields/wnc_m14a2a/wnc_m14a2a_X_frdm_k64f.overlay

drivers/modem/Kconfig.wncm14a2a

mike-scott · 2019-03-07T19:05:20Z

Fixed gitlint issue

mike-scott · 2019-03-07T19:07:07Z

@erwango Are you planning to be main CODEOWNER for boards/shields/?

mike-scott · 2019-03-07T19:10:48Z

boards/shields/wnc_m14a2a/wnc_m14a2a.overlay

This needs to be discussed as I think a change in our DTS processing is needed for:

To remove the warning generated by these aliases using labels with a "gpios" portion in their name
OR

Perhaps we can make a change which would allow the actual GPIO setting in the modem DTS to be assigned a label:
mdm-boot-mode-sel-gpios = &arduino_d1;
This would make these hacky aliases go away.

I'll try to discuss this at connect with dts guys.

erwango · 2019-03-08T13:36:08Z

@mike-scott

Are you planning to be main CODEOWNER for boards/shields/?

I thought I was already, but indeed, it appears this is not the case. So, if you volunteer, please go ahead. Otherwise, answer is yes.

MaureenHelm

Thanks @mike-scott for tackling this problem! It's been blocking me from converting the MCR20A to a shield for quite some time.

MaureenHelm · 2019-03-08T20:33:43Z

boards/shields/wnc_m14a2a/boards/frdm_k64f.conf

What if instead we add a CONFIG_ARDUINO_SERIAL to drivers/serial/Kconfig, and then the boards can intelligently enable the right instance like they do with the console uart? Something like this in boards/arm/frdm_k64f/Kconfig.defconfig

if UART_MCUX config UART_MCUX_0 default y if UART_CONSOLE config UART_MCUX_2 default y if ARDUINO_SERIAL config UART_MCUX_3 default y if BT_UART endif # UART_MCUX

@MaureenHelm I like this idea. I was struggling with the abstraction between a shield's UART (arduino_serial) and a HW specific UART (Like if the driver needed to be used directly).

A great example of this is the Particle.io Boron board which has a U-blox SARA-R41xx modem connected to the nRF52840 directly via UART1 vs. a SparkFun LTE Cat M1 shield which has the U-blox SARA-R41xx connected to Arduino R3-compatible headers.

The shield configuration should only reference the arduino_serial and stay away from anything too specific to the device.

However, this approach won't work for the WNC-M14A2A modem. The UART pins are on non-standard Arduino pins. The traditional Arduino UART is actually C16/C17 pins (UART_3) for K64F.

Technically, ARDUINO_SERIAL should enable UART_3 (where BT_UART is identified). And, the BT_UART setting could go away if we migrate that to a shield setup.

mike-scott · 2019-03-09T01:26:52Z

@mike-scott

Are you planning to be main CODEOWNER for boards/shields/?

I thought I was already, but indeed, it appears this is not the case. So, if you volunteer, please go ahead. Otherwise, answer is yes.

@erwango Feel free to take ownership of the boards/shields dir. My Zephyr plate is fairly full considering I'm working at a starving startup. :)

Following new shield introduction in zephyrproject-rtos#14057, it has been highlighted there was no codeowner for boards/shields/. Assign erwango as codeowner. Signed-off-by: Erwan Gouriou <[email protected]>

Following new shield introduction in #14057, it has been highlighted there was no codeowner for boards/shields/. Assign erwango as codeowner. Signed-off-by: Erwan Gouriou <[email protected]>

mike-scott · 2019-03-12T06:14:52Z

recheck

mike-scott · 2019-05-20T16:12:58Z

@WilliamGFish There are a couple more changes coming, but which modem were you testing?

I have been working with a modified sara-r4 driver on u201 on a particle boron.
Up until I pulled the last ~13 commits it had been working just fine, odd errors but there network related.

The error occurs when attempting :
/* Set iface up */
net_if_up(ictx.iface);

Can you try testing w/ these 2 changes to the prj.conf:
CONFIG_NET_IPV6=n
CONFIG_NET_CONFIG_NEED_IPV6=n

Caller will handle freeing packet if error is encountered. Fixes issue reported by Github User @weinholtendian: <err> net_pkt: *** ERROR *** pkt 0x20027e78 is freed already by offload_sendto():1717 (context_sendto():1473). Signed-off-by: Michael Scott <[email protected]>

Assert is checking the array size of pinconfig. Not the actual size of the structure. Fixes issue reported by Github User @weinholtendian Signed-off-by: Michael Scott <[email protected]>

The label binding was missed during initial development of the WNC-M14A2A modem. Let's add the binding so that during the migration to a shield, we can update the DTS correctly. Signed-off-by: Michael Scott <[email protected]>

This allows HW with compatible headers to define the related GPIOs Signed-off-by: Michael Scott <[email protected]>

Let's expose the Arduino R3-compatible pin definition as DTS for the frdm_k64f board. Signed-off-by: Michael Scott <[email protected]>

Let's expose the Arduino R3-compatible pin definition as DTS for the nrf542840_pca10056 board. Signed-off-by: Michael Scott <[email protected]>

Let's expose the Arduino R3-compatible pin definition as DTS for the disco_l475_iot1 board. Signed-off-by: Michael Scott <[email protected]>

Let's remove the sample-specific overlay files dealing with the WNC-M14A2A modem. Signed-off-by: Michael Scott <[email protected]>

Shields can often be very complex to setup in a generic way for several boards to support. Let's allow shields to have their own .conf files as well as specialized overlays per board (when needed). Signed-off-by: Michael Scott <[email protected]>

This shield uses a non-standard UART exposed via Arduino-R3 compatible header pins. It has configurations for FRDM_K64F and nRF52840_PCA10056. Signed-off-by: Michael Scott <[email protected]>

The WNC-M14A2A shield configuration has HW specific settings in place. We can remove those settings here. Signed-off-by: Michael Scott <[email protected]>

Let's change the specific WNC-M14A2A check into a more generic MODEM check for enabling ethernet. Many of these pins are used on the Arduino headers. Signed-off-by: Michael Scott <[email protected]>

Instead of using the now removed overlay files, use the SHIELD= command-line option for testing the WNC-M14A2A modem. Signed-off-by: Michael Scott <[email protected]>

The SARA-R4 series modules from U-Blox are size-optimized LTE-M / NB-IoT and EGPRS modules designed for low power consumption and longer battery life. The binding identifies the UART device, power GPIO and reset GPIO lines. Signed-off-by: Michael Scott <[email protected]>

The u-blox SARA-R4 modem modules are Ultra-compact LTE Cat M1 / NB1 ready: - Configurable with a single hardware version - Flexible mode selection as LTE Cat M1, LTE Cat NB1, EGPRS - only/preferred - Low power consumption and longer battery life - Extended range in buildings, basements, and with NB1, underground This driver introduces support for basic AT commands to query modem information as well as socket connection for TCP/UDP communication. Signed-off-by: Michael Scott <[email protected]>

Setup the SARA-R4 POWER and RESET pins as gpios. Signed-off-by: Michael Scott <[email protected]>

SparkFun offers an Arduino-R3 compatible shield using the SARA-R410M-02B LTE Cat M1/NB-IoT modem. Now, that the basic SARA-R4 modem driver is implemented, let's enable the shield for several MCUs supporting Arduino-R3 compatible headers. Product Link: https://www.sparkfun.com/products/14997 Signed-off-by: Michael Scott <[email protected]>

The Particle.io Boron is an nRF52840-based board with a connected u-blox SARA-R4 modem. The main board was previously upstreamed without modem support. Now that we have a driver to support the SARA-R4 modem, let's enable it for the Boron board. Signed-off-by: Michael Scott <[email protected]>

mike-scott · 2019-05-20T16:27:19Z

Rebased and addressed gitlint and license issues.

mike-scott added area: Drivers RFC Request For Comments: want input from the community area: Shields Shields (add-on boards) labels Mar 5, 2019

mike-scott requested review from erwango, galak, nashif and ulfalizer March 5, 2019 01:38

mike-scott requested review from MaureenHelm, SebastianBoe and carlescufi as code owners March 5, 2019 01:38

mike-scott mentioned this pull request Mar 5, 2019

wncm14a2a modem should be moved to a shield configuration #10965

Closed

SebastianBoe requested changes Mar 5, 2019

View reviewed changes

erwango reviewed Mar 7, 2019

View reviewed changes

boards/shields/wnc_m14a2a/wnc_m14a2a_X_frdm_k64f.overlay Outdated Show resolved Hide resolved

drivers/modem/Kconfig.wncm14a2a Outdated Show resolved Hide resolved

mike-scott force-pushed the master-wncm14a2a-shield branch 2 times, most recently from 005c048 to 8581444 Compare March 7, 2019 19:05

mike-scott commented Mar 7, 2019

View reviewed changes

SebastianBoe approved these changes Mar 8, 2019

View reviewed changes

MaureenHelm reviewed Mar 8, 2019

View reviewed changes

mike-scott force-pushed the master-wncm14a2a-shield branch from 8581444 to fda5413 Compare March 10, 2019 05:27

erwango mentioned this pull request Mar 11, 2019

CODEOWNERS: Add codeowner to boards/shields #14249

Merged

mike-scott added 18 commits May 20, 2019 09:23

drivers: modem: wncm14a2a: correct pinconfig assert check

28d7f4e

Assert is checking the array size of pinconfig. Not the actual size of the structure. Fixes issue reported by Github User @weinholtendian Signed-off-by: Michael Scott <[email protected]>

dts-binding: modem: wnc-14a2a: add label binding

e53f58b

The label binding was missed during initial development of the WNC-M14A2A modem. Let's add the binding so that during the migration to a shield, we can update the DTS correctly. Signed-off-by: Michael Scott <[email protected]>

dts/bindings: introduce Arduino-header-R3 GPIO binding

9f2c8db

This allows HW with compatible headers to define the related GPIOs Signed-off-by: Michael Scott <[email protected]>

boards: arm: frdm_k64f: add Arduino header definition to DTS

d685032

Let's expose the Arduino R3-compatible pin definition as DTS for the frdm_k64f board. Signed-off-by: Michael Scott <[email protected]>

boards: nrf52840_pca10056: add Arduino header definition to DTS

f1576d5

Let's expose the Arduino R3-compatible pin definition as DTS for the nrf542840_pca10056 board. Signed-off-by: Michael Scott <[email protected]>

board: disco_l475_iot1: add Arduino header definition to DTS

93ed6b0

Let's expose the Arduino R3-compatible pin definition as DTS for the disco_l475_iot1 board. Signed-off-by: Michael Scott <[email protected]>

samples: lwm2m_client: cleanup shield overlay files

0560624

Let's remove the sample-specific overlay files dealing with the WNC-M14A2A modem. Signed-off-by: Michael Scott <[email protected]>

shields: introduce shield-based WNC-M14A2A modem setup

d12922b

This shield uses a non-standard UART exposed via Arduino-R3 compatible header pins. It has configurations for FRDM_K64F and nRF52840_PCA10056. Signed-off-by: Michael Scott <[email protected]>

drivers: modem: wncm14a2a: remove HW specific Kconfig settings

dfaa250

The WNC-M14A2A shield configuration has HW specific settings in place. We can remove those settings here. Signed-off-by: Michael Scott <[email protected]>

boards: arm: frdm_k64f: don't use ETH if MODEM is enabled

c5cbebf

Let's change the specific WNC-M14A2A check into a more generic MODEM check for enabling ethernet. Many of these pins are used on the Arduino headers. Signed-off-by: Michael Scott <[email protected]>

samples: lwm2m_client: re-add sanity check for WNC-M14A2A build

74ddf2f

Instead of using the now removed overlay files, use the SHIELD= command-line option for testing the WNC-M14A2A modem. Signed-off-by: Michael Scott <[email protected]>

boards: arm: frdm_k64f: add pinmux for SARA-R4 modem

ffbeaee

Setup the SARA-R4 POWER and RESET pins as gpios. Signed-off-by: Michael Scott <[email protected]>

mike-scott force-pushed the master-wncm14a2a-shield branch from 8870e9c to a56e073 Compare May 20, 2019 16:26

erwango approved these changes May 21, 2019

View reviewed changes

zephyrproject-rtos deleted a comment from codecov-io May 21, 2019

nashif approved these changes May 21, 2019

View reviewed changes

nashif merged commit e2b45e6 into zephyrproject-rtos:master May 21, 2019

WilliamGFish mentioned this pull request May 21, 2019

Driver: modem ublox-sara-r4 not compiling #16289

Closed

avisconti mentioned this pull request Jun 28, 2019

Add x_nucleo_cca02m1 microphone shield #17140

Closed

MaureenHelm mentioned this pull request Jul 5, 2019

Add shield iks01a3 #15425

Merged

mike-scott deleted the master-wncm14a2a-shield branch August 12, 2019 05:36

Expanding "shield" functionality (example uses WNC-M14A2A and SARA modem) #14057

Expanding "shield" functionality (example uses WNC-M14A2A and SARA modem) #14057

Uh oh!

Conversation

mike-scott commented Mar 5, 2019

Uh oh!

zephyrbot commented Mar 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SebastianBoe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mike-scott commented Mar 5, 2019

Uh oh!

Uh oh!

Uh oh!

mike-scott commented Mar 7, 2019

Uh oh!

mike-scott commented Mar 7, 2019

Uh oh!

mike-scott Mar 7, 2019

Choose a reason for hiding this comment

Uh oh!

erwango Mar 26, 2019

Choose a reason for hiding this comment

Uh oh!

erwango commented Mar 8, 2019

Uh oh!

MaureenHelm left a comment

Choose a reason for hiding this comment

Uh oh!

MaureenHelm Mar 8, 2019

Choose a reason for hiding this comment

Uh oh!

mike-scott Mar 9, 2019

Choose a reason for hiding this comment

Uh oh!

mike-scott commented Mar 9, 2019

Uh oh!

mike-scott commented Mar 12, 2019

Uh oh!

mike-scott commented May 20, 2019

Uh oh!

mike-scott commented May 20, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

zephyrbot commented Mar 5, 2019 •

edited

Loading