/*
 * Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
 * its subsidiaries and affiliates (collectly called MKSEMI).
 *
 * 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 an MKSEMI
 *    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 MKSEMI 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
 *    MKSEMI 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 MKSEMI "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 MKSEMI 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 RANGING_CCC_H_
#define RANGING_CCC_H_
#include "mk_mac.h"
#include "uwb_api.h"
#include "ranging_ccc_task.h"
#include "wsf_timer.h"

/* Main control block of the ranging task */
struct RANGING_CB_T
{
    wsfQueue_t msg_queue;
    wsfHandlerId_t handle_id;
    wsfTimer_t daemon_timer;
};

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Initialize ranging task.
 *
 * @param [in] handle_id       Task handle ID
 */
int ranging_init(uint8_t handle_id);

/**
 * @brief De-initialize ranging task.
 */
int ranging_deinit(void);

/**
 * @brief Configure ranging environment variable, generate ranging keys and configure UWB subsystem.
 */
void ranging_configure(void);

/**
 * @brief Request update ranging keys.
 * @param[in] sts_idx               STS index
 * @param[in] key_type              key type
 */
void ranging_req_update_keys(uint32_t sts_idx, uint8_t key_type);

/**
 * @brief Start ranging monitor timer.
 *
 * @param [in] time_ms          Time to check link loss, unit: ms
 */
void ranging_monitor_start(uint32_t time_ms);

/**
 * @brief Stop ranging monitor timer.
 */
void ranging_monitor_stop(void);

/**
 * @brief Indicate UWB packet TX done.
 * @param[in] tx                Pointer of MAC HW report for TX
 * @param[in] stage             Stage of ranging FSM @enum RANGING_STAGE_T
 */
void uwb_pkt_tx_done_ind(const struct MAC_HW_REPORT_T *tx, enum RANGING_STAGE_T stage);

/**
 * @brief Indicate UWB packet RX done.
 * @param[in] rx                Pointer of MAC HW report for RX
 * @param[in] stage             Stage of ranging FSM @enum RANGING_STAGE_T
 * @param[in] slot_idx          Slot index
 */
void uwb_pkt_rx_done_ind(const struct MAC_HW_REPORT_T *rx, enum RANGING_STAGE_T stage, uint8_t slot_idx);

/**
 * @brief Send ranging report.
 * @param[in] report            Pointer of ranging report
 * @param[in] block_idx         Index of current ranging block
 * @param[in] round_idx         Index of current ranging round
 * @param[in] sts_idx           STS index of Final-Data
 */
void ranging_report(struct RANGING_REPORT_IND_T *report, uint16_t block_idx, uint16_t round_idx, uint32_t sts_idx);

#ifdef __cplusplus
}
#endif

#endif /* RANGING_CCC_H_ */