/*
|
* 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_FIRA_H_
|
#define RANGING_FIRA_H_
|
#include "lib_fira.h"
|
#include "wsf_timer.h"
|
#include "ranging_fira_task.h"
|
|
#ifndef PDOA_3D_EN
|
#define PDOA_3D_EN (0)
|
#endif
|
|
/* Main control block of the ranging task */
|
struct RANGING_CB_T
|
{
|
wsfQueue_t msg_queue;
|
wsfHandlerId_t handle_id;
|
wsfTimer_t daemon_timer;
|
};
|
|
#if MCTT_TEST_EN
|
/** Ranging round print payload indication */
|
struct RANGING_ROUND_PRINT_IND_T
|
{
|
wsfMsgHdr_t hdr;
|
};
|
#endif
|
|
#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 Start ranging procedure.
|
*/
|
void ranging_start(void);
|
|
/**
|
* @brief Stop ranging procedure.
|
*/
|
void ranging_stop(void);
|
|
/**
|
* @brief Restart ranging procedure.
|
* @note This function can be called once detected link loss from peer device
|
*/
|
void ranging_restart(void);
|
|
/**
|
* @brief Get ranging UWB TX power.
|
* @return ranging UWB TX power in dBm
|
*/
|
int8_t ranging_tx_power_get(void);
|
|
/**
|
* @brief Clear ranging measurements.
|
*/
|
void ranging_measurements_clear(void);
|
|
/**
|
* @brief Start ranging monitor timer.
|
* This API will be called by ranging start
|
*
|
* @param [in] time_ms Time to check link loss, unit: ms
|
*/
|
void ranging_monitor_start(uint32_t time_ms);
|
|
/**
|
* @brief Stop ranging monitor timer.
|
* This API will be called by ranging stop
|
*/
|
void ranging_monitor_stop(void);
|
|
/**
|
* @brief Filter distance result.
|
*
|
* @param [in] mac_addr Pointer of device MAC address
|
* @param [inout] distance Pointer of ranging distance result
|
*/
|
void distance_result_filter(uint8_t *mac_addr, uint16_t *distance);
|
|
/**
|
* @brief Filter angle result.
|
*
|
* @param [in] mac_addr Pointer of device MAC address
|
* @param [inout] angle Pointer of angle result
|
* @param [in] type azimuth or elevation
|
*/
|
void angle_result_filter(uint8_t *mac_addr, int16_t *angle, uint8_t type);
|
|
/**
|
* @brief Filter ranging result.
|
*
|
* @param [in] mac_addr Pointer of device MAC address
|
* @param [inout] distance Pointer of ranging distance result
|
* @param [inout] azimuth Pointer of azimuth result
|
* @param [inout] elevation Pointer of elevation result
|
*/
|
void ranging_result_filter(uint8_t *mac_addr, uint16_t *distance, int16_t *azimuth, int16_t *elevation);
|
|
/**
|
* @brief Ranging procedure complete handler, to calculate distance.
|
*
|
* @param [in] ind Pointer of ranging rx done indication packet
|
*/
|
int measure_report_handler(const struct UWB_PKT_RX_DONE_IND_T *ind);
|
|
/**
|
* @brief Ranging result process handler.
|
*
|
* @param [in] ind Pointer of ranging rx done indication packet
|
*/
|
int ranging_result_report_handler(const struct UWB_PKT_RX_DONE_IND_T *ind);
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif /* RANGING_FIRA_H_ */
|
