third_party/NordicSemiconductor/drivers/radio/rsch/raal/softdevice/nrf_raal_softdevice.h

/* Copyright (c) 2017 - 2018, 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 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 Radio Arbiter Abstraction Layer interface
 * using Timeslot API provided by SoftDevice.
 *
 */

#ifndef NRF_RAAL_SOFTDEVICE_H_
#define NRF_RAAL_SOFTDEVICE_H_

#include <stdbool.h>
#include <stdint.h>

#include <nrf_802154_utils.h>

#ifdef __cplusplus
extern "C" {
#endif

/** @brief RAAL SoftDevice default parameters. */
#define NRF_RAAL_TIMESLOT_DEFAULT_LENGTH                    6400
#define NRF_RAAL_TIMESLOT_DEFAULT_ALLOC_ITERS               5
#define NRF_RAAL_TIMESLOT_DEFAULT_SAFE_MARGIN               nrf_raal_softdevice_safe_margin_calc( \
        NRF_RAAL_DEFAULT_LF_CLK_ACCURACY_PPM)
#define NRF_RAAL_TIMESLOT_DEFAULT_TIMEOUT                   4500
#define NRF_RAAL_TIMESLOT_DEFAULT_MAX_LENGTH                120000000
#define NRF_RAAL_DEFAULT_LF_CLK_ACCURACY_PPM                500

#define NRF_RAAL_TIMESLOT_DEFAULT_SAFE_MARGIN_LFRC_TICKS    4
#define NRF_RAAL_TIMESLOT_DEFAULT_SAFE_MARGIN_CRYSTAL_TICKS 3
#define NRF_RAAL_TIMESLOT_DEFAULT_SAFE_MARGIN_US            3

#define NRF_RAAL_PPM_THRESHOLD                              500

#define NRF_RAAL_TIMESLOT_SAFE_MARGIN_TICKS(ppm)            ((ppm >= NRF_RAAL_PPM_THRESHOLD) ?                \
                                                             NRF_RAAL_TIMESLOT_DEFAULT_SAFE_MARGIN_LFRC_TICKS \
                                                             :                                                \
                                                             NRF_RAAL_TIMESLOT_DEFAULT_SAFE_MARGIN_CRYSTAL_TICKS)

/**
 * @brief Function-like macro used to calculate a safe margin from the LF clock accuracy
 *        in ppm unit.
 *
 * @param[in]  ppm  LF clock accuracy in ppm units.
 */
#define nrf_raal_softdevice_safe_margin_calc(ppm)           (NRF_802154_RTC_TICKS_TO_US(              \
                                                                 NRF_RAAL_TIMESLOT_SAFE_MARGIN_TICKS( \
                                                                     ppm))                            \
                                                             +                                        \
                                                             NRF_RAAL_TIMESLOT_DEFAULT_SAFE_MARGIN_US)

/** @brief RAAL Softdevice configuration parameters. */
typedef struct
{
    /**
     * @brief Timeslot length requested by the module, in microseconds.
     */
    uint32_t timeslot_length;

    /**
     * @brief The longest acceptable delay until the start of the requested timeslot,
     *        in microseconds.
     */
    uint32_t timeslot_timeout;

    /**
     * @brief The maximum single timeslot length created by the extension processing,
     *        in microseconds.
     */
    uint32_t timeslot_max_length;

    /**
     * @brief The maximum number of iteration of dividing timeslot_length by factor of 2 performed
     *        by the arbiter.
     */
    uint16_t timeslot_alloc_iters;

    /**
     * @brief The safe margin before the timeslot is finished and nrf_raal_timeslot_ended
     * is to be called, in microseconds. @ref nrf_raal_softdevice_safe_margin_calc can be used
     * to calculate the proper value based on the clock accuracy. This value can also be selected
     * experimentally.
     */
    uint16_t timeslot_safe_margin;

    /**
     * @brief The clock accuracy in ppm unit.
     */
    uint16_t lf_clk_accuracy_ppm;
} nrf_raal_softdevice_cfg_t;

/**
 * @brief Informs the RAAL client about the SoftDevice SoC events.
 *
 */
void nrf_raal_softdevice_soc_evt_handler(uint32_t evt_id);

/**
 * @brief Sets non-default parameters of RAAL.
 *
 */
void nrf_raal_softdevice_config(const nrf_raal_softdevice_cfg_t * p_cfg);

/**
 *@}
 **/

#ifdef __cplusplus
}
#endif

#endif /* NRF_RAAL_SOFTDEVICE_H_ */