instaburst_tx.h

/* Copyright (c) 2010 - 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 INSTABURST_TX_H__
#define INSTABURST_TX_H__

#include "instaburst.h"
#include "broadcast.h"
#include "adv_ext_tx.h"
#include "bearer_event.h"
#include "packet_buffer.h"
#include "bearer_handler.h"

#define INSTABURST_TX_BUFFER_MIN_SIZE \
 (sizeof(packet_buffer_packet_t) + sizeof(adv_ext_tx_event_t) + \
 (sizeof(adv_ext_tx_packet_t) + ADV_EXT_PACKET_LEN_MAX) * ADV_EXT_TX_CHAIN_MAX_COUNT)


typedef struct instaburst_tx instaburst_tx_t;

typedef void (*instaburst_tx_complete_t)(struct instaburst_tx * p_tx, nrf_mesh_tx_token_t tx_token, timestamp_t timestamp);

typedef struct
{
 uint8_t set_id;
 const uint8_t * p_channels;
 uint8_t channel_count;
 radio_mode_t radio_mode;
 radio_tx_power_t tx_power;
 instaburst_tx_complete_t callback;
 uint32_t interval_ms;
} instaburst_tx_config_t;

#ifdef INSTABURST_TX_DEBUG

typedef struct
{
 uint32_t failed_allocs;
 uint32_t tx_regular_packet;
 uint32_t tx_adv_ext;
 uint32_t tx_skipped;
} instaburst_tx_debug_t;
#endif

struct instaburst_tx
{
 instaburst_tx_config_t config;

 uint8_t channel_index;

 packet_buffer_t packet_buffer;

 uint8_t * p_next_alloc; 
 adv_ext_tx_packet_t * p_alloc_packet; 
 packet_buffer_packet_t * p_alloc_buf; 
 packet_buffer_packet_t * p_tx_buf; 
 broadcast_t broadcast;
 adv_ext_tx_t adv_ext_tx;

 bearer_event_sequential_t tx_complete_event;
 timestamp_t prev_tx_timestamp;

 timer_event_t timer_event;

#ifdef INSTABURST_TX_DEBUG
 instaburst_tx_debug_t debug;
#endif
};

void instaburst_tx_init(uint32_t lfclk_ppm);

void instaburst_tx_instance_init(instaburst_tx_t * p_instaburst,
 const instaburst_tx_config_t * p_config,
 uint8_t * p_packet_buffer,
 uint32_t packet_buffer_size);

void instaburst_tx_enable(instaburst_tx_t * p_instaburst);

void instaburst_tx_disable(instaburst_tx_t * p_instaburst);

bool instaburst_tx_is_enabled(const instaburst_tx_t * p_instaburst);

uint8_t * instaburst_tx_buffer_alloc(instaburst_tx_t * p_instaburst, uint32_t data_len, nrf_mesh_tx_token_t tx_token);

void instaburst_tx_buffer_commit(instaburst_tx_t * p_instaburst, const uint8_t * p_buffer);

void instaburst_tx_buffer_discard(instaburst_tx_t * p_instaburst, const uint8_t * p_buffer);

bool instaburst_tx_finalize(instaburst_tx_t * p_instaburst);

void instaburst_tx_buffer_lock(bool lock);

void instaburst_tx_interval_set(instaburst_tx_t * p_instaburst, uint32_t interval_ms);

static inline uint32_t instaburst_tx_interval_get(const instaburst_tx_t * p_instaburst)
{
 return p_instaburst->config.interval_ms;
}

void instaburst_tx_tx_power_set(instaburst_tx_t * p_instaburst, radio_tx_power_t tx_power);

static inline radio_tx_power_t instaburst_tx_tx_power_get(const instaburst_tx_t * p_instaburst)
{
 return p_instaburst->config.tx_power;
}

#endif /* INSTABURST_TX_H__ */