Lora Basics Modem port for ZephyrInitial commit

Author: lbm-team

CHANGELOG

@@ -0,0 +1,35 @@
+v0.6
+====
+
+LoRa Basics Modem:
+* Fix gpio interrupt behaviour that was not left pending when disabled (Fixes WiFi/GNSS Scanning)
+* Properly configure the "Scanning" LED for GNSS/WiFi scanning
+
+v0.5
+====
+
+Radio drivers:
+* BUSY wait timeout was bumped to 10 minutes to support wifi/GNSS scanning.
+* Update the current shields and add new specific shields for TCXO/Crystal
+
+v0.4
+====
+
+Radio drivers:
+* Add complete support for SX126x
+* Rework drivers Kconfig settings (now only CONFIG_LORA_BASICS_MODEM_DRIVERS is required)
+* Rework device tree LR11xx configuration, add TX power calibration settings
+* Partially support MCU-controlled TCXO (properly configure the transceiver)
+* Support configuration of XTAL trim capacitors
+
+LoRa Basics Modem:
+* Support Class B, Class C, and Multicast
+* Fix FUOTA
+* Fix geolocation build
+* Add a new optional "LBM Main Thread" that offloads LBM outside of the main thread 
+* Coding style fixes
+* Rename samples
+* samples/hw_modem: Fix FUOTA, misc fixes
+* Fix some buggy logging messages
+* Implement crashlog storage
+* samples: Add LCTT certification sample

CMakeLists.txt

@@ -0,0 +1,9 @@
+# Copyright (c) 2024 Semtech Corporation - Félix Piédallu
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.12.4)
+
+add_subdirectory(drivers)
+add_subdirectory(subsys)
+
+zephyr_include_directories(include)

Kconfig

@@ -0,0 +1,13 @@
+# General configuration options
+
+# Copyright (c) 2014-2015 Wind River Systems, Inc.
+# Copyright (c) 2016 Intel Corporation
+# Copyright (c) 2023 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+# This Kconfig file is picked by the Zephyr build system because it is defined
+# as the module Kconfig entry point (see zephyr/module.yml). You can browse
+# module options by going to Zephyr -> Modules in Kconfig.
+
+rsource "drivers/Kconfig"
+rsource "subsys/Kconfig"

README.md

@@ -0,0 +1,141 @@
+# LoRa Basics Modem on Zephyr
+
+This repository aims to make LoRa Basics Modem available in Zephyr. It wraps the existing
+SWL2001 repository from Semtech.
+
+At term, this repository might be merged into the upstream Zephyr project.
+
+This is an experimental release of demo projects of LBM on Zephyr, tested on LR11xxMB1LxKS shields
+
+## Zephyr module
+
+You can use this module either as your "west manifest project", or include it in 
+another project. In that case you need to add `import: true` to the caller configuration, as this:
+
+```yaml
+  projects:
+    - name: lora_lbm
+      path: modules/lora_lbm
+      remote: lora-net
+      repo-path: lora_lbm_zephyr
+      revision: zephyr
+      import: true
+```
+
+## Requirements
+
+You need a recent Linux distribution (Python >= 3.10, CMake >= 3.20.5).
+
+### Install west and Zephyr SDK
+
+You need to install the Zephyr SDK (compiler and flashing tools) and west (the build system tool).
+
+Please follow instructions at <https://docs.zephyrproject.org/latest/develop/getting_started/index.html>.
+You will only need to follow this step only once for all your Zephyr projects.
+
+### Activate the Zephyr virtual environment (if not already activated)
+
+If it's not installed in your system, you need to load the Zephyr SDK environment each time you open a new terminal:
+
+```bash
+source ~/zephyrproject/.venv/bin/activate
+```
+
+## Download code
+
+This repository only contains specific LBM port code and the samples. We also need to download Zephyr itself, LBM, and associated HAL modules.
+
+You need to create an empty directory, let's name it `lbm_zephyr_workspace`, and clone the current repository inside it.
+
+```bash
+mkdir lbm_zephyr_workspace
+cd lbm_zephyr_workspace
+git clone git@github.com:lora-net-private/SWL2001_Zephyr.git lora_lbm
+```
+
+The `SWL2001_Manifest` repository will be automatically downloaded, you don't need to clone it yourself.
+
+### Configure the SSH command (only needed if external to lora-net-private)
+
+If you need Git to use a custom SSH key to access the private repositories, you can either
+configure it in your `~/.ssh/config` file or specify it in your terminal's environment:
+
+```bash
+export GIT_SSH_COMMAND="/usr/bin/ssh -i <path>/60093279.SWL2001SSHKEYMFAS.key"
+```
+
+### Download Zephyr and its modules
+
+Then, initialize West (the build tool):
+Multiple repositories will be automatically downloaded inside the workspace directory.
+
+```bash
+west init -l lora_lbm
+west update
+```
+
+It will take 3-10 minutes to run depending on your network connection.
+
+You will need to run this step for every project you download.
+
+If major updates to `lora_lbm` are provided, you might need to run `west update` again.
+
+## The samples
+
+Samples are in the `lora_lbm/samples` directory, split in two classes:
+
+* lora_drivers: Samples only using the low level LoRa drivers 
+  * ping_pong : Flash this sample to two boards to see them talk.
+  * ping_shell : Same as ping_pong, but manually, using the Zephyr shell ! run `lorademo ping` in one board to ping the other flashed board.
+* lora_basics_modem: Samples leveraging the LBM stack to communicate with LoRaWAN networks.
+  * app_demo_periodical_uplink: This sample joins a network and periodically sends packets.
+    You can also send a packet manually by pressing the button (on nRF52840dk it's BUTTON 1).
+    Please configure your device EUIs/App keys in `src/example_options.h`
+  * app_lbm_hw_modem: used for continuous integration tests. It expects serial communication on an UART port.
+    Read `src/hw_modem/cmd_parser.c` for explanations.
+
+
+## Build the code
+
+You need to inform Zephyr which board and shield you want to use. Shields are in the `lora_lbm/boards/shields/*` directories as `.overlay` files.
+They describe which transceiver model you are using. For example, `semtech_lr1110mb1xxs`.
+
+Go into a sample's directory, then run:
+
+```bash
+west build --board nrf52840dk/nrf52840 -- -DSHIELD=semtech_lr1110mb1xxs
+# or 
+west build --board nucleo_l476rg --build-dir build_nucleo -- -DSHIELD=semtech_lr1110mb1xxs
+```
+
+It will build your project in the `build` subdirectory (can be configured by `--build-dir`).
+You can pass `--pristine` to ensure the build directory is clean.
+
+The boards are expected to have a `lora0` node label. The shield `semtech_lr1110mb1xxs` provides it.
+
+You might want to customize the LoRa transceiver configuration by adding a file in the `boards` subdirectory or via `app.overlay`.
+For example, to set a TCXO instead of the default XTAL:
+
+```dts
+&lora_semtech_lr11xxmb1xis {
+    tcxo-wakeup-time = <7>;
+};
+```
+
+## Flash the board
+
+```bash
+west flash
+# or
+west flash --build-dir build_nucleo
+```
+
+For the nRF52840-DK board, you don't need to close open serial ports during flash.
+
+## Open the serial port
+
+You can use minicom, picocom, tio,…
+
+```bash
+tio /dev/serial/by-id/usb-SEGGER_J-Link_*-if00
+```

boards/shields/semtech_lr11xxmb1xxs/Kconfig.shield

@@ -0,0 +1,11 @@
+# Copyright (c) 2024 Semtech Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+config SHIELD_SEMTECH_LR1110MB1xxS
+	def_bool $(shields_list_contains,semtech_lr1110mb1xxs)
+
+config SHIELD_SEMTECH_LR1120MB1xxS
+	def_bool $(shields_list_contains,semtech_lr1120mb1xxs)
+
+config SHIELD_SEMTECH_LR1121MB1xxS
+	def_bool $(shields_list_contains,semtech_lr1121mb1xxs)

boards/shields/semtech_lr11xxmb1xxs/doc/index.rst

@@ -0,0 +1,97 @@
+.. semtech_lr11xxmb1xxs:
+
+Semtech LR11xxMB1xxS LoRa Shields
+#################################
+
+Overview
+********
+
+Semtech provides a series of Arduino compatible shields based on their LoRa
+transceivers LR1110, LR1120, and LR1121.
+Those shields are mostly similar and include a LIS2DE12 3-axis i2c accelerometer
+from STMicroelectronics.
+
+More information about the shield can be found at the `mbed LR1110MB1xxS
+website`_.
+
+Pins Assignment of the Semtech LR1110MB1xxS LoRa Shield
+=======================================================
+
++-------------+---------------------+
+| Shield Pin  | Function            |
++=============+=====================+
+| A0          | LR1110 NRESET       |
++-------------+---------------------+
+| A1          | 32kHz Osc out       |
++-------------+---------------------+
+| A2          | LR111x / LR1110     |
++-------------+---------------------+
+| A3          | LNA Control         |
++-------------+---------------------+
+| A4          | LED TX              |
++-------------+---------------------+
+| A5          | LED RX              |
++-------------+---------------------+
+| D2          | To Display Shield   |
++-------------+---------------------+
+| D3          | LR1110 DIO0 (BUSY)  |
++-------------+---------------------+
+| D4          | LED Sniffing        |
++-------------+---------------------+
+| D5          | LR1110 DIO9         |
++-------------+---------------------+
+| D7          | LR1110 SPI NSS      |
++-------------+---------------------+
+| D8          | MEMS Accel INT1     |
++-------------+---------------------+
+| D9          | Display D/C         |
++-------------+---------------------+
+| D10         | Display CS          |
++-------------+---------------------+
+| D11         | LR1110 SPI MOSI     |
++-------------+---------------------+
+| D12         | LR1110 SPI MISO     |
++-------------+---------------------+
+| D13         | LR1110 SPI SCK      |
++-------------+---------------------+
+| D14         | MEMS+EEPROM i2c SDA |
++-------------+---------------------+
+| D15         | MEMS+EEPROM i2c SCL |
++-------------+---------------------+
+
+LR1110 and LR1120 based shields use a TCXO and LR1121 based shields use a crystal.
+
+Requirements
+************
+
+This shield can only be used with a board which provides a configuration for
+Arduino connectors and defines node aliases for SPI and GPIO interfaces (see
+:ref:`shields` for more details).
+
+Programming
+***********
+
+Set ``-DSHIELD=semtech_lr1110mb1xxs`` when you invoke ``west build``. For
+example:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/subsys/lorawan/class_a
+   :board: nucleo_l073rz
+   :shield: semtech_lr1110mb1xxs
+   :goals: build
+
+References
+**********
+
+.. target-notes::
+
+.. _mbed LR1110MB1xxS website:
+   https://os.mbed.com/components/LR1110MB1xxS/
+
+
+License
+*******
+
+This document Copyright (c) 2024 Semtech Corporation
+
+SPDX-License-Identifier: Apache-2.0

boards/shields/semtech_lr11xxmb1xxs/semtech_lr1110mb1xxs.overlay

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024 Semtech Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "semtech_lr11xxmb1xxs_common.dtsi"
+
+lora_semtech_lr1110mb1xxs: &lora_semtech_lr11xxmb1xxs {
+	compatible = "semtech,lr1110";
+
+	tcxo-wakeup-time = <8>;
+};

boards/shields/semtech_lr11xxmb1xxs/semtech_lr1120mb1xxs.overlay

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024 Semtech Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "semtech_lr11xxmb1xxs_common.dtsi"
+
+lora_semtech_lr1120mb1xxs: &lora_semtech_lr11xxmb1xxs {
+	compatible = "semtech,lr1120";
+
+	tcxo-wakeup-time = <8>;
+};

boards/shields/semtech_lr11xxmb1xxs/semtech_lr1121mb1xxs.overlay

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024 Semtech Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "semtech_lr11xxmb1xxs_common.dtsi"
+
+lora_semtech_lr1121mb1xxs: &lora_semtech_lr11xxmb1xxs {
+	compatible = "semtech,lr1121";
+
+	/* LR1121 shields all have XTAL */
+};