379 lines
12 KiB
C
379 lines
12 KiB
C
/*
|
|
* Copyright (c) 2019 - 2021, Nordic Semiconductor ASA
|
|
* All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*
|
|
* 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 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.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* @brief Module that defines the 802.15.4 driver peripheral usage for nRF52 family.
|
|
*
|
|
*/
|
|
|
|
#ifndef NRF_802154_PERIPHERALS_NRF52_H__
|
|
#define NRF_802154_PERIPHERALS_NRF52_H__
|
|
|
|
#include <nrf.h>
|
|
#include <nrfx.h>
|
|
#include "nrf_802154_config.h"
|
|
#include "nrf_802154_debug.h"
|
|
#include "hal/nrf_ppi.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_EGU_INSTANCE_NO
|
|
*
|
|
* Number of the EGU instance used by the driver to synchronize PPIs and for requests and
|
|
* notifications if SWI is in use.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_EGU_INSTANCE_NO
|
|
|
|
#if defined(NRF52811_XXAA)
|
|
#define NRF_802154_EGU_INSTANCE_NO 0
|
|
#else
|
|
#define NRF_802154_EGU_INSTANCE_NO 3
|
|
#endif
|
|
|
|
#endif // NRF_802154_EGU_INSTANCE_NO
|
|
|
|
/**
|
|
* @def NRF_802154_EGU_INSTANCE
|
|
*
|
|
* The EGU instance used by the driver to synchronize PPIs and for requests and notifications if
|
|
* SWI is in use.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
*
|
|
*/
|
|
#define NRF_802154_EGU_INSTANCE NRFX_CONCAT_2(NRF_EGU, NRF_802154_EGU_INSTANCE_NO)
|
|
|
|
/**
|
|
* @def NRF_802154_EGU_IRQ_HANDLER
|
|
*
|
|
* The SWI EGU IRQ handler used by the driver for requests and notifications if SWI is in use.
|
|
*
|
|
* @note This option is used when the driver uses SWI to process requests and notifications.
|
|
*
|
|
*/
|
|
#define NRF_802154_EGU_IRQ_HANDLER \
|
|
NRFX_CONCAT_3(NRFX_CONCAT_3(SWI, NRF_802154_EGU_INSTANCE_NO, _EGU), \
|
|
NRF_802154_EGU_INSTANCE_NO, \
|
|
_IRQHandler)
|
|
|
|
/**
|
|
* @def NRF_802154_EGU_IRQN
|
|
*
|
|
* The SWI EGU IRQ number used by the driver for requests and notifications if SWI is in use.
|
|
*
|
|
* @note This option is used when the driver uses SWI to process requests and notifications.
|
|
*
|
|
*/
|
|
#define NRF_802154_EGU_IRQN \
|
|
NRFX_CONCAT_3(NRFX_CONCAT_3(SWI, NRF_802154_EGU_INSTANCE_NO, _EGU), \
|
|
NRF_802154_EGU_INSTANCE_NO, \
|
|
_IRQn)
|
|
|
|
/**
|
|
* @def NRF_802154_RTC_INSTANCE_NO
|
|
*
|
|
* Number of the RTC instance used in the standalone timer driver implementation.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_RTC_INSTANCE_NO
|
|
|
|
#if defined(NRF52811_XXAA) || defined(NRF52820_XXAA)
|
|
#define NRF_802154_RTC_INSTANCE_NO 0
|
|
#else
|
|
#define NRF_802154_RTC_INSTANCE_NO 2
|
|
#endif
|
|
|
|
#endif // NRF_802154_RTC_INSTANCE_NO
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RADIO_DISABLED_TO_EGU
|
|
*
|
|
* The PPI channel that connects RADIO_DISABLED event to EGU task.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RADIO_DISABLED_TO_EGU
|
|
#define NRF_802154_PPI_RADIO_DISABLED_TO_EGU NRF_PPI_CHANNEL6
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_EGU_TO_RADIO_RAMP_UP
|
|
*
|
|
* The PPI channel that connects EGU event to RADIO_TXEN or RADIO_RXEN task.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_EGU_TO_RADIO_RAMP_UP
|
|
#define NRF_802154_PPI_EGU_TO_RADIO_RAMP_UP NRF_PPI_CHANNEL7
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_EGU_TO_TIMER_START
|
|
*
|
|
* The PPI channel that connects EGU event to TIMER_START task.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_EGU_TO_TIMER_START
|
|
#define NRF_802154_PPI_EGU_TO_TIMER_START NRF_PPI_CHANNEL8
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RADIO_CRCERROR_TO_TIMER_CLEAR
|
|
*
|
|
* The PPI channel that connects RADIO_CRCERROR event to TIMER_CLEAR task.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
* The peripheral is shared with @ref NRF_802154_PPI_RADIO_CCAIDLE_TO_FEM_GPIOTE
|
|
* and @ref NRF_802154_PPI_TIMER_COMPARE_TO_RADIO_TXEN.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RADIO_CRCERROR_TO_TIMER_CLEAR
|
|
#define NRF_802154_PPI_RADIO_CRCERROR_TO_TIMER_CLEAR NRF_PPI_CHANNEL9
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RADIO_CCAIDLE_TO_FEM_GPIOTE
|
|
*
|
|
* The PPI channel that connects RADIO_CCAIDLE event to the GPIOTE tasks used by the Frontend.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
* The peripheral is shared with @ref NRF_802154_PPI_RADIO_CRCERROR_TO_TIMER_CLEAR
|
|
* and @ref NRF_802154_PPI_TIMER_COMPARE_TO_RADIO_TXEN.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RADIO_CCAIDLE_TO_FEM_GPIOTE
|
|
#define NRF_802154_PPI_RADIO_CCAIDLE_TO_FEM_GPIOTE NRF_PPI_CHANNEL9
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_TIMER_COMPARE_TO_RADIO_TXEN
|
|
*
|
|
* The PPI channel that connects TIMER_COMPARE event to RADIO_TXEN task.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
* The peripheral is shared with @ref NRF_802154_PPI_RADIO_CRCERROR_TO_TIMER_CLEAR
|
|
* and @ref NRF_802154_PPI_RADIO_CCAIDLE_TO_FEM_GPIOTE.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_TIMER_COMPARE_TO_RADIO_TXEN
|
|
#define NRF_802154_PPI_TIMER_COMPARE_TO_RADIO_TXEN NRF_PPI_CHANNEL9
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RADIO_CRCOK_TO_PPI_GRP_DISABLE
|
|
*
|
|
* The PPI channel that connects RADIO_CRCOK event with the task that disables the whole PPI group.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RADIO_CRCOK_TO_PPI_GRP_DISABLE
|
|
#define NRF_802154_PPI_RADIO_CRCOK_TO_PPI_GRP_DISABLE NRF_PPI_CHANNEL10
|
|
#endif
|
|
|
|
#if NRF_802154_DISABLE_BCC_MATCHING
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RADIO_ADDR_TO_COUNTER_COUNT
|
|
*
|
|
* The PPI channel that connects RADIO_ADDRESS event to TIMER_COUNT task.
|
|
*
|
|
* @note This configuration is used only when the NRF_RADIO_EVENT_BCMATCH event handling is disabled
|
|
* (see @ref NRF_802154_DISABLE_BCC_MATCHING).
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RADIO_ADDR_TO_COUNTER_COUNT
|
|
#define NRF_802154_PPI_RADIO_ADDR_TO_COUNTER_COUNT NRF_PPI_CHANNEL11
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RADIO_CRCERROR_TO_COUNTER_CLEAR
|
|
*
|
|
* The PPI channel that connects RADIO_CRCERROR event to TIMER_CLEAR task.
|
|
*
|
|
* @note This option is used only when the NRF_RADIO_EVENT_BCMATCH event handling is disabled
|
|
* (see @ref NRF_802154_DISABLE_BCC_MATCHING).
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RADIO_CRCERROR_COUNTER_CLEAR
|
|
#define NRF_802154_PPI_RADIO_CRCERROR_COUNTER_CLEAR NRF_PPI_CHANNEL12
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_DISABLE_BCC_MATCHING_PPI_CHANNELS_USED_MASK
|
|
*
|
|
* Helper bit mask of PPI channels used additionally by the 802.15.4 driver when the BCC matching
|
|
* is disabled.
|
|
*/
|
|
#define NRF_802154_DISABLE_BCC_MATCHING_PPI_CHANNELS_USED_MASK \
|
|
((1 << NRF_802154_PPI_RADIO_ADDR_TO_COUNTER_COUNT) | \
|
|
(1 << NRF_802154_PPI_RADIO_CRCERROR_COUNTER_CLEAR))
|
|
|
|
#else // NRF_802154_DISABLE_BCC_MATCHING
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RADIO_SYNC_TO_EGU_SYNC
|
|
*
|
|
* The PPI channel that connects RADIO_SYNC event to EGU_SYNC task.
|
|
* EGU_SYNC task belongs to one of EGU channels
|
|
*
|
|
* @note This configuration is used only when the NRF_RADIO_EVENT_BCMATCH event handling is enabled
|
|
* (see @ref NRF_802154_DISABLE_BCC_MATCHING).
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RADIO_SYNC_TO_EGU_SYNC
|
|
#define NRF_802154_PPI_RADIO_SYNC_TO_EGU_SYNC NRF_PPI_CHANNEL11
|
|
#endif
|
|
|
|
#define NRF_802154_DISABLE_BCC_MATCHING_PPI_CHANNELS_USED_MASK \
|
|
(1 << NRF_802154_PPI_RADIO_SYNC_TO_EGU_SYNC)
|
|
|
|
#endif // NRF_802154_DISABLE_BCC_MATCHING
|
|
|
|
#ifdef NRF_802154_FRAME_TIMESTAMP_ENABLED
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_RTC_COMPARE_TO_TIMER_CAPTURE
|
|
*
|
|
* The PPI channel that connects LP timer's COMPARE event to HP timer's TIMER_CAPTURE task.
|
|
*
|
|
* @note This option is used only when the timestamping feature is enabled
|
|
* (see @ref NRF_802154_FRAME_TIMESTAMP_ENABLED).
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_RTC_COMPARE_TO_TIMER_CAPTURE
|
|
#define NRF_802154_PPI_RTC_COMPARE_TO_TIMER_CAPTURE NRF_PPI_CHANNEL13
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_TIMESTAMP_EVENT_TO_TIMER_CAPTURE
|
|
*
|
|
* The PPI channel that connects provided event to HP timer's TIMER_CAPTURE task.
|
|
*
|
|
* @note This option is used only when the timestamping feature is enabled
|
|
* (see @ref NRF_802154_FRAME_TIMESTAMP_ENABLED).
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_TIMESTAMP_EVENT_TO_TIMER_CAPTURE
|
|
#define NRF_802154_PPI_TIMESTAMP_EVENT_TO_TIMER_CAPTURE NRF_PPI_CHANNEL14
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_TIMESTAMP_PPI_CHANNELS_USED_MASK
|
|
*
|
|
* Helper bit mask of PPI channels used by the 802.15.4 driver for timestamping.
|
|
*/
|
|
#define NRF_802154_TIMESTAMP_PPI_CHANNELS_USED_MASK \
|
|
((1 << NRF_802154_PPI_RTC_COMPARE_TO_TIMER_CAPTURE) | \
|
|
(1 << NRF_802154_PPI_TIMESTAMP_EVENT_TO_TIMER_CAPTURE))
|
|
|
|
#else // NRF_802154_FRAME_TIMESTAMP_ENABLED
|
|
|
|
#define NRF_802154_TIMESTAMP_PPI_CHANNELS_USED_MASK 0
|
|
|
|
#endif // NRF_802154_FRAME_TIMESTAMP_ENABLED
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_CORE_GROUP
|
|
*
|
|
* The PPI channel group used to disable self-disabling PPIs used by the core module.
|
|
*
|
|
* @note This option is used by the core module regardless of the driver configuration.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_CORE_GROUP
|
|
#define NRF_802154_PPI_CORE_GROUP NRF_PPI_CHANNEL_GROUP0
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_ABORT_GROUP
|
|
*
|
|
* The PPI channel group used to break PPI connections related with FEM, when the abort condition occurs.
|
|
*
|
|
*/
|
|
#ifndef NRF_802154_PPI_ABORT_GROUP
|
|
#define NRF_802154_PPI_ABORT_GROUP NRF_PPI_CHANNEL_GROUP1
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_802154_EGU_USED_MASK
|
|
*
|
|
* Bit mask of instances of SWI/EGU peripherals used by the 802.15.4 driver.
|
|
*/
|
|
#ifndef NRF_802154_EGU_USED_MASK
|
|
#define NRF_802154_EGU_USED_MASK (1 << NRF_802154_EGU_INSTANCE_NO)
|
|
#endif
|
|
|
|
/**
|
|
* @def NRF_80254_PPI_CHANNELS_USED_MASK
|
|
*
|
|
* Bit mask of PPI channels used by the 802.15.4 driver.
|
|
*/
|
|
#ifndef NRF_802154_PPI_CHANNELS_USED_MASK
|
|
#define NRF_802154_PPI_CHANNELS_USED_MASK ((1 << NRF_802154_PPI_RADIO_DISABLED_TO_EGU) | \
|
|
(1 << NRF_802154_PPI_EGU_TO_RADIO_RAMP_UP) | \
|
|
(1 << NRF_802154_PPI_EGU_TO_TIMER_START) | \
|
|
(1 << NRF_802154_PPI_RADIO_CRCERROR_TO_TIMER_CLEAR) | \
|
|
(1 << NRF_802154_PPI_RADIO_CCAIDLE_TO_FEM_GPIOTE) | \
|
|
(1 << NRF_802154_PPI_TIMER_COMPARE_TO_RADIO_TXEN) | \
|
|
(1 << NRF_802154_PPI_RADIO_CRCOK_TO_PPI_GRP_DISABLE) | \
|
|
NRF_802154_DISABLE_BCC_MATCHING_PPI_CHANNELS_USED_MASK | \
|
|
NRF_802154_TIMESTAMP_PPI_CHANNELS_USED_MASK | \
|
|
NRF_802154_DEBUG_PPI_CHANNELS_USED_MASK)
|
|
#endif // NRF_802154_PPI_CHANNELS_USED_MASK
|
|
|
|
/**
|
|
* @def NRF_802154_PPI_GROUPS_USED_MASK
|
|
*
|
|
* Bit mask of PPI groups identifiers used by the 802.15.4 driver.
|
|
*/
|
|
#ifndef NRF_802154_PPI_GROUPS_USED_MASK
|
|
#define NRF_802154_PPI_GROUPS_USED_MASK ((1 << NRF_802154_PPI_CORE_GROUP) | \
|
|
(1 << NRF_802154_PPI_ABORT_GROUP) )
|
|
#endif // NRF_802154_PPI_GROUPS_USED_MASK
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // NRF_802154_PERIPHERALS_NRF52_H__
|