/*
|
* 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 AOA_H_
|
#define AOA_H_
|
#include "mk_common.h"
|
#include "mk_mac.h"
|
#include "aoa_task.h"
|
|
/* AoA FSM stage */
|
enum AOA_STAGE_T
|
{
|
AOA_IDLE = 0x00,
|
AOA_POLL = 0x01,
|
AOA_SYNC = 0x02,
|
};
|
|
/* AoA environment variable */
|
struct AOA_ENV_T
|
{
|
uint32_t anchor_point;
|
uint32_t ranging_period;
|
uint32_t sequence_num;
|
enum AOA_STAGE_T stage;
|
uint8_t lost_cnt;
|
};
|
|
/* AOA results report */
|
struct AOA_REPORT_T
|
{
|
// sts_valid is used to indicate whether sts is valid or not
|
// If sts is invalid, the result of azimuth/sts_rssi/pdoa/iq should be ignored
|
// 0x00 invalid
|
// 0x01 valid
|
uint8_t sts_valid;
|
uint8_t fom;
|
// Q9.7
|
int16_t azimuth;
|
int16_t elevation;
|
float pdoa[3];
|
float sts_rssi[4];
|
float iq[8];
|
};
|
|
/* Main control block of the aoa task */
|
struct AOA_CB_T
|
{
|
wsfQueue_t msg_queue;
|
wsfHandlerId_t handle_id;
|
};
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif
|
|
extern struct AOA_ENV_T aoa_env;
|
|
/**
|
* @brief Initialize aoa task.
|
*
|
* @param [in] handle_id Task handle ID
|
*/
|
int aoa_init(uint8_t handle_id);
|
|
/**
|
* @brief De-initialize aoa task.
|
*/
|
int aoa_deinit(void);
|
|
/**
|
* @brief Configure aoa environment variable, configure UWB subsystem.
|
*/
|
void aoa_configure(void);
|
|
/**
|
* @brief Start aoa procedure.
|
*/
|
void aoa_start(void);
|
|
/**
|
* @brief Process MAC report event.
|
*
|
* @param [in] ind Pointer of MAC HW report
|
*/
|
void aoa_process(const struct MAC_HW_REPORT_T *ind);
|
|
/**
|
* @brief Send aoa done indication.
|
*
|
* @param [in] ind Pointer of MAC HW report
|
*/
|
void aoa_done(const struct MAC_HW_REPORT_T *ind);
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif /* AOA_H_ */
|
