Release v1.9.0

Source commits: nrf-802.15.4-driver: 18ddc11 nrf-802.15.4-sl: 759a0a1854bd2e20e89769488edb8dbae292376a
NordicSemiconductor · Dec 11, 2020 · b14c5e4 · b14c5e4
1 parent 0b97285
commit b14c5e4
Show file tree

Hide file tree

Showing 152 changed files with 16,695 additions and 10,961 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,15 @@
 # nRF IEEE 802.15.4 radio driver
 
-[![Build Status][travis-svg]][travis]
-
-[travis]: https://travis-ci.org/NordicSemiconductor/nRF-IEEE-802.15.4-radio-driver
-[travis-svg]: https://travis-ci.org/NordicSemiconductor/nRF-IEEE-802.15.4-radio-driver.svg?branch=master
-
-The nRF IEEE 802.15.4 radio driver implements the IEEE 802.15.4 PHY layer on the Nordic Semiconductor nRF52811 and nRF52840 SoCs.
+The nRF IEEE 802.15.4 radio driver implements the IEEE 802.15.4 PHY layer on the following Nordic Semiconductor SoCs:
+    - nRF52811
+    - nRF52833
+    - nRF52840
+    - nRF5340
 
 The architecture of the nRF IEEE 802.15.4 radio driver is independent of the OS and IEEE 802.15.4 MAC layer.
 It allows to use the driver in any IEEE 802.15.4 based stacks that implement protocols such as Thread, ZigBee, or RF4CE.
 
-In addition, it was designed to work with multiprotocol applications. The driver allows to share the RADIO peripheral with other PHY protocol drivers, for example, Bluetooth LE.
-
-For more information and a detailed description of the driver, see the [Wiki](https://github.com/NordicSemiconductor/nRF-IEEE-802.15.4-radio-driver/wiki).
+In addition, it was designed to work with multiprotocol applications.
+The driver allows to share the RADIO peripheral with other PHY protocol drivers, for example, Bluetooth LE.
 
-Note that the *nRF-IEEE-802.15.4-radio-driver.packsc* file is a project building description used for internal testing in Nordic Semiconductor. This file is NOT needed to build the driver with any other tool.
+For more information and a detailed description of the driver, see the [Wiki](https://infocenter.nordicsemi.com/topic/struct_drivers/struct/radio_driver_latest.html).
diff --git a/nrf_802154_sl/include/fem/none/nrf_fem_config.h b/nrf_802154_sl/include/fem/none/nrf_fem_config.h
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2020, Nordic Semiconductor ASA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ *    Semiconductor ASA integrated circuit in a product or a software update for
+ *    such product, must reproduce the above copyright notice, this list of
+ *    conditions and the following disclaimer in the documentation and/or other
+ *    materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ *    Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ *    engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef NRF_FEM_NONE_CONFIG_H_
+#define NRF_FEM_NONE_CONFIG_H_
+
+/** @brief The ID of "none" FEM type (e.g. for run-time selection)  */
+#define NRF_FEM_IF_TYPE_NONE 0
+
+#endif /* NRF_FEM_NONE_CONFIG_H_ */
diff --git a/nrf_802154_sl/include/fem/nrf_fem_abstract_interface.h b/nrf_802154_sl/include/fem/nrf_fem_abstract_interface.h
@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2020, Nordic Semiconductor ASA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ *    Semiconductor ASA integrated circuit in a product or a software update for
+ *    such product, must reproduce the above copyright notice, this list of
+ *    conditions and the following disclaimer in the documentation and/or other
+ *    materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ *    Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ *    engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef NRF_FEM_ABSTRACT_INTERFACE_H_
+#define NRF_FEM_ABSTRACT_INTERFACE_H_
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include "nrf_fem_protocol_api.h"
+
+/**
+ * @brief Set of pointers to functions that enables run-time choice of FEM implementation.
+ */
+typedef struct
+{
+    uint32_t fem_type_id;
+
+    int32_t (* p_pa_configuration_set)(const nrf_802154_fal_event_t * const p_activate_event,
+                                       const nrf_802154_fal_event_t * const p_deactivate_event);
+    int32_t (* p_lna_configuration_set)(const nrf_802154_fal_event_t * const p_activate_event,
+                                        const nrf_802154_fal_event_t * const p_deactivate_event);
+    int32_t (* p_pa_configuration_clear)(void);
+    int32_t (* p_lna_configuration_clear)(void);
+    void (* p_deactivate_now)(nrf_fal_functionality_t type);
+    void (* p_cleanup)(void);
+    bool (* p_prepare_powerdown)(NRF_TIMER_Type  * p_instance,
+                                 uint32_t          compare_channel,
+                                 nrf_ppi_channel_t ppi_id);
+    void (* p_pa_is_configured)(int8_t * const p_gain);
+    int32_t (* p_abort_set)(uint32_t event, nrf_ppi_channel_group_t group);
+    int32_t (* p_abort_extend)(nrf_ppi_channel_t channel_to_add, nrf_ppi_channel_group_t group);
+    int32_t (* p_abort_reduce)(nrf_ppi_channel_t channel_to_remove, nrf_ppi_channel_group_t group);
+    int32_t (* p_abort_clear)(void);
+} nrf_802154_fal_interface_t;
+
+/**
+ * @brief Connects to one of FEM implementation
+ *
+ * @param[in] p_methods   Pointer to structure of pointers. This will be used in case of future calls
+ *                        to specific FEM implementation methods.
+ *
+ * @note This must be used by FEM implementation "constructor" and this is the only case
+ *       in which it can be used.
+ *
+ * @retval   ::NRFX_SUCCESS               The "link" was successfuly created.
+ * @retval   ::NRFX_ERROR_FORBIDDEN       Some error occured (e.q. null pointer was passed)
+ */
+int32_t nrf_802154_fal_interface_set(const nrf_802154_fal_interface_t * p_methods);
+
+#endif // NRF_FEM_ABSTRACT_INTERFACE_
diff --git a/nrf_802154_sl/include/fem/nrf_fem_common_config.h b/nrf_802154_sl/include/fem/nrf_fem_common_config.h
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2020, Nordic Semiconductor ASA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ *    Semiconductor ASA integrated circuit in a product or a software update for
+ *    such product, must reproduce the above copyright notice, this list of
+ *    conditions and the following disclaimer in the documentation and/or other
+ *    materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ *    Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ *    engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef NRF_FEM_COMMON_CONFIG_H_
+#define NRF_FEM_COMMON_CONFIG_H_
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Configuration parameters for pins that enable or disable (or both) either Power Amplifier (PA) or Low Noise Amplifier (LNA).
+ */
+typedef struct
+{
+    bool    enable;       /* Enable toggling for this pin. */
+    bool    active_high;  /* If true, the pin will be active high. Otherwise, the pin will be active low. */
+    uint8_t gpio_pin;     /* GPIO pin number for the pin. */
+    uint8_t gpiote_ch_id; /* GPIOTE channel to be used for toggling pins. */
+} nrf_fem_gpiote_pin_config_t;
+
+/** Mask of GPIO pins used for FEM control. */
+#define NRF_802154_FEM_PINS_USED_MASK            0
+
+/** Mask of PPI channels used for FEM control. */
+#define NRF_802154_FEM_PPI_CHANNELS_USED_MASK    0
+
+/** Mask of GPIOTE channels used for FEM control. */
+#define NRF_802154_FEM_GPIOTE_CHANNELS_USED_MASK 0
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/nrf_802154_sl/include/fem/nrf_fem_control_config.h b/nrf_802154_sl/include/fem/nrf_fem_control_config.h
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2020, Nordic Semiconductor ASA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ *    Semiconductor ASA integrated circuit in a product or a software update for
+ *    such product, must reproduce the above copyright notice, this list of
+ *    conditions and the following disclaimer in the documentation and/or other
+ *    materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ *    Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ *    engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef NRF_FEM_CONTROL_CONFIG_H_
+#define NRF_FEM_CONTROL_CONFIG_H_
+
+#include "none/nrf_fem_config.h"
+#include "simple_gpio/nrf_fem_config.h"
+#include "three_pin_gpio/nrf_fem_config.h"
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @section Configuration
+ */
+
+/**
+ * @brief Retrieves last selected PA, LNA device interface ID code.
+ */
+int32_t nrf_fem_interface_type_get(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* NRF_FEM_CONTROL_CONFIG_H_ */