cherry_ccc.h

Go to the documentation of this file.

 
#pragma once
 
#include <cherry/cherry.h>
#include <cherry/cherry_common.h>
#include <cherry/cherry_session.h>
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CHERRY_CCC_HOP_MODE_KEY_SIZE 4
 
struct cherry_ccc_session;
 
struct cherry_ccc_capabilities {
        uint8_t slot_bitmask;
        uint32_t sync_code_index_bitmask;
        uint8_t hopping_config_bitmask;
        uint8_t channel_bitmask;
        struct {
                size_t len;
                uint16_t *items;
        } protocol_versions;
        struct {
                size_t len;
                uint16_t *items;
        } uwb_configs;
        struct {
                size_t len;
                uint8_t *items;
        } pulse_shape_combos;
        uint8_t minimum_ran_multiplier;
        bool qorvo_vendor_feature_1_supported;
};
 
enum cherry_ccc_event_type {
        CHERRY_CCC_EVENT_TYPE_SESSION_STATUS,
        CHERRY_CCC_EVENT_TYPE_SESSION_ERROR,
        CHERRY_CCC_EVENT_TYPE_SESSION_CONTROLLER_REPORT,
        CHERRY_CCC_EVENT_TYPE_SESSION_CONTROLEE_REPORT,
        CHERRY_CCC_EVENT_TYPE_SESSION_DIAGNOSTIC_REPORT,
};
 
enum cherry_ccc_session_state {
        CHERRY_CCC_SESSION_STATE_INIT,
        CHERRY_CCC_SESSION_STATE_DEINIT,
        CHERRY_CCC_SESSION_STATE_ACTIVE,
        CHERRY_CCC_SESSION_STATE_IDLE,
};
 
enum cherry_ccc_state_change_reason {
        CHERRY_CCC_STATE_CHANGE_REASON_MGMT_CMD,
        CHERRY_CCC_STATE_CHANGE_REASON_UNKNOWN,
        CHERRY_CCC_STATE_CHANGE_REASON_FORCE_STOPPED,
};
 
struct cherry_ccc_session_event_session_status {
        enum cherry_ccc_session_state session_state;
        enum cherry_ccc_state_change_reason reason_code;
};
 
struct cherry_ccc_session_event_error {
        enum cherry_err status_err;
};
 
struct cherry_ccc_controller_session_report;
struct cherry_ccc_controlee_session_report;
 
struct cherry_ccc_event {
        enum cherry_ccc_event_type type;
        struct cherry_ccc_session *session;
        union {
                struct cherry_ccc_session_event_session_status *status;
                struct cherry_ccc_session_event_error *error;
                struct cherry_ccc_controller_session_report *controller_report;
                struct cherry_ccc_controlee_session_report *controlee_report;
                struct cherry_common_diag_report *diagnostics;
        } data;
};
 
typedef void (*cherry_ccc_cb_t)(struct cherry_ccc_event *event, void *user_data);
 
enum cherry_ccc_hopping_mode {
        CHERRY_CCC_HOPPING_MODE_DISABLE = 0,
        CHERRY_CCC_HOPPING_MODE_ENABLED = 1,
        CHERRY_CCC_HOPPING_MODE_CONTINUOUS_AES = 0xA0,
        CHERRY_CCC_HOPPING_MODE_CONTINUOUS_DEFAULT = 0xA1,
        CHERRY_CCC_HOPPING_MODE_ADAPTATIVE_AES = 0xA2,
        CHERRY_CCC_HOPPING_MODE_ADAPTATIVE_DEFAULT = 0xA3,
};
 
struct cherry_ccc_aliro_session_config {
        uint32_t session_id;
        uint16_t uwb_config_id;
        uint8_t pulse_shape_combo;
        uint8_t channel;
        uint8_t sync_code_index;
        uint32_t ranging_duration_ms;
        uint8_t slot_per_rr;
        uint16_t slot_duration;
        enum cherry_ccc_hopping_mode hopping_mode;
        uint8_t hopping_config_bitmask;
        uint8_t hop_mode_key[CHERRY_CCC_HOP_MODE_KEY_SIZE];
        uint32_t sts_index;
        uint8_t mac_mode;
        uint64_t uwb_time_us;
};
 
struct cherry_ccc_session *
cherry_ccc_session_create_aliro_responder(struct cherry *ctx, cherry_ccc_cb_t callback,
                                          void *user_data,
                                          struct cherry_ccc_aliro_session_config *config);
 
struct cherry_session *cherry_ccc_session_to_base(struct cherry_ccc_session *session);
 
static inline void *cherry_ccc_session_get_user_data(struct cherry_ccc_session *session)
{
        return cherry_session_get_user_data(cherry_ccc_session_to_base(session));
}
 
void cherry_ccc_event_free(struct cherry_ccc_event *event);
 
static inline void cherry_ccc_session_destroy(struct cherry_ccc_session *session)
{
        cherry_session_destroy(cherry_ccc_session_to_base(session));
}
 
static inline enum cherry_err cherry_ccc_session_start(struct cherry_ccc_session *session)
{
        return cherry_session_start(cherry_ccc_session_to_base(session));
}
 
static inline enum cherry_err cherry_ccc_session_stop(struct cherry_ccc_session *session)
{
        return cherry_session_stop(cherry_ccc_session_to_base(session));
}
 
static inline enum cherry_err cherry_ccc_session_set_antennas(struct cherry_ccc_session *session,
                                                              uint8_t tx_antenna_set,
                                                              uint8_t rx_antenna_set)
{
        return cherry_session_set_antennas(cherry_ccc_session_to_base(session), tx_antenna_set,
                                           rx_antenna_set);
}
 
enum cherry_err cherry_ccc_session_set_ursk(struct cherry_ccc_session *session,
                                            const uint8_t *ursk);
 
enum cherry_err cherry_ccc_session_set_protocol_version(struct cherry_ccc_session *session,
                                                        uint16_t selected_protocol_version);
 
enum cherry_err cherry_ccc_session_set_round2_antennas(struct cherry_ccc_session *session,
                                                       uint8_t tx_antenna_set,
                                                       uint8_t rx_antenna_set);
 
enum cherry_err cherry_ccc_session_set_sts_index(struct cherry_ccc_session *session,
                                                 uint32_t sts_index);
 
enum cherry_err cherry_ccc_session_set_initiation_time(struct cherry_ccc_session *session,
                                                       uint64_t initiation_time_us);
 
static inline enum cherry_err
cherry_ccc_session_set_diagnostics(struct cherry_ccc_session *session,
                                   struct cherry_common_diag_cfg config)
{
        return cherry_session_set_diagnostics(cherry_ccc_session_to_base(session), config, false);
}
 
#ifdef __cplusplus
}
#endif