mpsl_fem_protocol_api.h

Go to the documentation of this file.

/*
 * Copyright (c) Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef MPSL_FEM_PROTOCOL_API_H__
#define MPSL_FEM_PROTOCOL_API_H__
 
#include <stdint.h>
#include <stdbool.h>
 
#include <nrf.h>
#include <nrf_peripherals.h>
#include "nrf_errno.h"
#include "mpsl_tx_power.h"
#include "mpsl_fem_types.h"
 
typedef enum
{
    MPSL_FEM_PA  = 1 << 0,                     
    MPSL_FEM_LNA = 1 << 1,                     
    MPSL_FEM_ALL = MPSL_FEM_PA | MPSL_FEM_LNA  
} mpsl_fem_functionality_t;
 
typedef enum
{
    MPSL_FEM_EVENT_TYPE_TIMER,                 
    MPSL_FEM_EVENT_TYPE_GENERIC                
} mpsl_fem_event_type_t;
 
#ifdef PPI_PRESENT
typedef uint32_t mpsl_subscribable_hw_event_t;
#else
typedef uint8_t mpsl_subscribable_hw_event_t;
#endif
 
typedef struct
{
    mpsl_fem_event_type_t      type;
    union
    {
        struct
        {
            NRF_TIMER_Type *   p_timer_instance;
 
            struct
            {
                uint32_t       start;
                uint32_t       end;
            } counter_period;
 
            uint8_t            compare_channel_mask;
        } timer;
 
        struct
        {
            mpsl_subscribable_hw_event_t event;
        } generic;
    } event;
 
#if defined(NRF52_SERIES)
    bool                       override_ppi;
    uint8_t                    ppi_ch_id;
#endif
} mpsl_fem_event_t;
 
typedef struct
{
    mpsl_tx_power_t radio_tx_power;
 
    mpsl_fem_pa_power_control_t fem_pa_power_control;
} mpsl_tx_power_split_t;
 
#define MPSL_FEM_CAPS_FLAG_PA_SETUP_REQUIRED  (1U << 0)
 
#define MPSL_FEM_CAPS_FLAG_LNA_SETUP_REQUIRED (1U << 1)
 
typedef struct
{
    uint32_t flags;
} mpsl_fem_caps_t;
 
void mpsl_fem_caps_get(mpsl_fem_caps_t * p_caps);
 
void mpsl_fem_enable(void);
 
int32_t mpsl_fem_disable(void);
 
int32_t mpsl_fem_pa_configuration_set(const mpsl_fem_event_t * const p_activate_event,
                                      const mpsl_fem_event_t * const p_deactivate_event);
 
int32_t mpsl_fem_pa_configuration_clear(void);
 
int32_t mpsl_fem_lna_configuration_set(const mpsl_fem_event_t * const p_activate_event,
                                       const mpsl_fem_event_t * const p_deactivate_event);
 
int32_t mpsl_fem_lna_configuration_clear(void);
 
void mpsl_fem_deactivate_now(mpsl_fem_functionality_t type);
 
int32_t mpsl_fem_abort_set(mpsl_subscribable_hw_event_t event, uint32_t group);
 
int32_t mpsl_fem_abort_extend(uint32_t channel_to_add, uint32_t group);
 
int32_t mpsl_fem_abort_reduce(uint32_t channel_to_remove, uint32_t group);
 
int32_t mpsl_fem_abort_clear(void);
 
void mpsl_fem_cleanup(void);
 
int8_t mpsl_fem_tx_power_split(const mpsl_tx_power_t         power,
                               mpsl_tx_power_split_t * const p_tx_power_split,
                               uint16_t                      freq_mhz,
                               bool                          tx_power_ceiling);
 
int32_t mpsl_fem_pa_power_control_set(mpsl_fem_pa_power_control_t pa_power_control);
 
void mpsl_fem_lna_is_configured(int8_t * const p_gain);
 
bool mpsl_fem_prepare_powerdown(NRF_TIMER_Type * p_instance,
                                uint32_t         compare_channel,
                                uint32_t         ppi_id,
                                uint32_t         event_addr);
 
void mpsl_fem_utils_available_cc_channels_cache(uint8_t mask);
 
#endif // MPSL_FEM_PROTOCOL_API_H__