nrf_modem_rs_capture.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_MODEM_RS_CAPTURE_H__
#define NRF_MODEM_RS_CAPTURE_H__
 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NRF_MODEM_RS_CAPTURE_MAX_DATA_SAMPLES 1536
 
#define NRF_MODEM_RS_CAPTURE_STATUS_SUCCESS              0x00
#define NRF_MODEM_RS_CAPTURE_STATUS_CELL_AVAILABLE       0x00
#define NRF_MODEM_RS_CAPTURE_STATUS_NO_MEM               0x01
#define NRF_MODEM_RS_CAPTURE_STATUS_NO_CELL              0x03
#define NRF_MODEM_RS_CAPTURE_STATUS_NOT_ACTIVE           0x04
#define NRF_MODEM_RS_CAPTURE_STATUS_BUSY                 0x05
#define NRF_MODEM_RS_CAPTURE_STATUS_NOT_SUPPORTED        0x06
#define NRF_MODEM_RS_CAPTURE_STATUS_TIMEOUT              0x07
#define NRF_MODEM_RS_CAPTURE_STATUS_STOPPED              0x08
enum nrf_modem_rs_capture_event_id {
        NRF_MODEM_RS_CAPTURE_EVT_PRS_SAMPLE = 1,
        NRF_MODEM_RS_CAPTURE_EVT_CELL_STATUS,
        NRF_MODEM_RS_CAPTURE_EVT_ABORT,
};
 
struct nrf_modem_rs_capture_session_start_req {
        uint32_t timeout;
};
 
struct nrf_modem_rs_capture_session_start_resp {
        uint8_t plmn[3];
        uint32_t cell_id;
        uint16_t mcc;
        uint16_t mnc;
};
 
struct nrf_modem_rs_capture_prs_config {
        int8_t gain_offset[16];
        uint8_t nb_pattern[16];
        uint16_t i_prs;
        int16_t timing_offset;
        uint8_t index;
};
 
struct nrf_modem_rs_capture_prs_sample {
        uint8_t plmn[3];
        uint32_t cell_id;
        uint16_t mcc;
        uint16_t mnc;
        uint8_t index;
        uint8_t nb;
        uint16_t sfn;
        uint16_t num_samples;
        int16_t timing_offset;
        int8_t rssi;
        int8_t gain_offset;
 
        int16_t *data;
};
 
struct nrf_modem_rs_capture_cell_status {
        uint8_t plmn[3];
        uint32_t cell_id;
        uint16_t mcc;
        uint16_t mnc;
};
 
struct nrf_modem_rs_capture_event_data {
        enum nrf_modem_rs_capture_event_id event_id;
 
        int32_t status;
 
        union {
                struct nrf_modem_rs_capture_prs_sample prs_sample;
                struct nrf_modem_rs_capture_cell_status cell_status;
        };
};
 
typedef void (*nrf_modem_rs_capture_event_handler_type_t)(
        const struct nrf_modem_rs_capture_event_data *event_data);
 
int32_t nrf_modem_rs_capture_version(uint8_t version);
 
int32_t nrf_modem_rs_capture_session_start(
        const struct nrf_modem_rs_capture_session_start_req *req,
        struct nrf_modem_rs_capture_session_start_resp *resp,
        nrf_modem_rs_capture_event_handler_type_t callback);
 
int32_t nrf_modem_rs_capture_session_stop(void);
 
int32_t nrf_modem_rs_capture_prs_configure(const struct nrf_modem_rs_capture_prs_config *req);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_MODEM_RS_CAPTURE_H__ */