/** * Copyright 2013-2021 Software Radio Systems Limited * * This file is part of srsRAN. * * srsRAN is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of * the License, or (at your option) any later version. * * srsRAN is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * A copy of the GNU Affero General Public License can be found in * the LICENSE file in the top-level directory of this distribution * and at http://www.gnu.org/licenses/. * */ #ifndef SRSRAN_RRC_CELL_H #define SRSRAN_RRC_CELL_H #include "srsran/asn1/rrc.h" #include "srsran/asn1/rrc_nr.h" #include "srsran/asn1/rrc_nr_utils.h" #include "srsran/asn1/rrc_utils.h" #include "srsran/common/task_scheduler.h" #include "srsran/interfaces/ue_rrc_interfaces.h" #include "srsran/srslog/srslog.h" #include namespace srsue { inline std::string to_string(const phy_cell_t& c) { char buffer[64]; snprintf(buffer, 64, "{earfcn=%d, pci=%d}\n", c.earfcn, c.pci); return {buffer}; } class meas_cell { public: const static int neighbour_timeout_ms = 5000; explicit meas_cell(srsran::unique_timer timer); meas_cell(const phy_cell_t& phy_cell_, srsran::unique_timer timer); // comparison based on pci and earfcn bool is_valid() const { return phy_cell.earfcn != 0 && srsran_cellid_isvalid(phy_cell.pci); } bool equals(const meas_cell& x) { return equals(x.phy_cell.earfcn, x.phy_cell.pci); } bool equals(uint32_t earfcn, uint32_t pci) { return earfcn == phy_cell.earfcn && pci == phy_cell.pci; } // NaN means an RSRP value has not yet been obtained. Keep then in the list and clean them if never updated bool greater(const meas_cell* x) const { return rsrp > x->rsrp || std::isnan(rsrp); } bool greater(const meas_cell& x) const { return rsrp > x.rsrp || std::isnan(rsrp); } void set_rsrp(float rsrp_) { if (!std::isnan(rsrp_)) { rsrp = rsrp_; } timer.run(); } void set_rsrq(float rsrq_) { if (!std::isnan(rsrq_)) { rsrq = rsrq_; } } void set_cfo(float cfo_Hz_) { if (not std::isnan(cfo_Hz_) && not std::isinf(cfo_Hz_)) { phy_cell.cfo_hz = cfo_Hz_; } } bool has_sib1() const { return has_valid_sib1; } bool has_sib2() const { return has_valid_sib2; } bool has_sib3() const { return has_valid_sib3; } bool has_sib13() const { return has_valid_sib13; } bool has_sib(uint32_t index) const; bool has_sibs(srsran::span indexes) const; bool is_sib_scheduled(uint32_t sib_index) const; void reset_sibs() { has_valid_sib1 = false; has_valid_sib2 = false; has_valid_sib3 = false; has_valid_sib13 = false; } uint32_t get_earfcn() const { return phy_cell.earfcn; } uint32_t get_pci() const { return phy_cell.pci; } float get_rsrp() const { return rsrp; } float get_rsrq() const { return rsrq; } float get_cfo_hz() const { return phy_cell.cfo_hz; } phy_cell_t phy_cell = {0, 0, 0}; srsran::unique_timer timer; protected: float rsrp = NAN; float rsrq = NAN; bool has_valid_sib1 = false; bool has_valid_sib2 = false; bool has_valid_sib3 = false; bool has_valid_sib13 = false; std::map sib_info_map; ///< map of sib_index to index of schedInfoList in SIB1 }; class meas_cell_nr : public meas_cell { public: explicit meas_cell_nr(srsran::unique_timer timer) : meas_cell(std::move(timer)){}; meas_cell_nr(const phy_cell_t& phy_cell_, srsran::unique_timer timer) : meas_cell(phy_cell_, std::move(timer)){}; bool has_plmn_id(asn1::rrc_nr::plmn_id_s plmn_id) const; uint32_t nof_plmns() const { return has_sib1() ? sib1.cell_access_related_info.plmn_id_list.size() : 0; } srsran::plmn_id_t get_plmn(uint32_t idx) const; void set_sib1(const asn1::rrc_nr::sib1_s& sib1_); void set_sib2(const asn1::rrc_nr::sib2_s& sib2_); void set_sib3(const asn1::rrc_nr::sib3_s& sib3_); const asn1::rrc_nr::sib1_s* sib1ptr() const { return has_sib1() ? &sib1 : nullptr; } const asn1::rrc_nr::sib2_s* sib2ptr() const { return has_sib2() ? &sib2 : nullptr; } const asn1::rrc_nr::sib3_s* sib3ptr() const { return has_sib3() ? &sib3 : nullptr; } uint32_t get_cell_id() const { return (uint32_t)0xFFFF; } // TODO find the correct sib uint16_t get_mcc() const; uint16_t get_mnc() const; std::string to_string() const; bool has_mcch = false; asn1::rrc_nr::sib1_s sib1 = {}; asn1::rrc_nr::sib2_s sib2 = {}; asn1::rrc_nr::sib3_s sib3 = {}; asn1::rrc::mcch_msg_s mcch = {}; }; class meas_cell_eutra : public meas_cell { public: explicit meas_cell_eutra(srsran::unique_timer timer) : meas_cell(std::move(timer)){}; meas_cell_eutra(const phy_cell_t& phy_cell_, srsran::unique_timer timer) : meas_cell(phy_cell_, std::move(timer)){}; bool has_plmn_id(asn1::rrc::plmn_id_s plmn_id) const; uint32_t nof_plmns() const { return has_sib1() ? sib1.cell_access_related_info.plmn_id_list.size() : 0; } srsran::plmn_id_t get_plmn(uint32_t idx) const; uint16_t get_tac() const { return has_sib1() ? (uint16_t)sib1.cell_access_related_info.tac.to_number() : 0; } void set_sib1(const asn1::rrc::sib_type1_s& sib1_); void set_sib2(const asn1::rrc::sib_type2_s& sib2_); void set_sib3(const asn1::rrc::sib_type3_s& sib3_); void set_sib13(const asn1::rrc::sib_type13_r9_s& sib13_); const asn1::rrc::sib_type1_s* sib1ptr() const { return has_sib1() ? &sib1 : nullptr; } const asn1::rrc::sib_type2_s* sib2ptr() const { return has_sib2() ? &sib2 : nullptr; } const asn1::rrc::sib_type3_s* sib3ptr() const { return has_sib3() ? &sib3 : nullptr; } const asn1::rrc::sib_type13_r9_s* sib13ptr() const { return has_sib13() ? &sib13 : nullptr; } uint32_t get_cell_id() const { return (uint32_t)sib1.cell_access_related_info.cell_id.to_number(); } bool has_sib13() const { return has_valid_sib13; } uint16_t get_mcc() const; uint16_t get_mnc() const; std::string to_string() const; bool has_mcch = false; asn1::rrc::sib_type1_s sib1 = {}; asn1::rrc::sib_type2_s sib2 = {}; asn1::rrc::sib_type3_s sib3 = {}; asn1::rrc::sib_type13_r9_s sib13 = {}; asn1::rrc::mcch_msg_s mcch = {}; private: bool has_valid_sib13 = false; }; //! Universal methods to extract pci/earfcn and compare the two values template uint32_t get_pci(const T& t) { return t.pci; } template <> inline uint32_t get_pci(const meas_cell_eutra& t) { return t.get_pci(); } template <> inline uint32_t get_pci(const meas_cell_nr& t) { return t.get_pci(); } template uint32_t get_earfcn(const T& t) { return t.earfcn; } template <> inline uint32_t get_earfcn(const meas_cell_eutra& t) { return t.get_earfcn(); } template <> inline uint32_t get_earfcn(const meas_cell_nr& t) { return t.get_earfcn(); } template bool is_same_cell(const T& lhs, const U& rhs) { return get_pci(lhs) == get_pci(rhs) and get_earfcn(lhs) == get_earfcn(rhs); } template class meas_cell_list { public: const static int NEIGHBOUR_TIMEOUT = 5; const static int MAX_NEIGHBOUR_CELLS = 8; typedef std::unique_ptr unique_meas_cell; explicit meas_cell_list(srsran::task_sched_handle task_sched_); bool add_meas_cell(const phy_meas_t& meas); bool add_meas_cell(unique_meas_cell cell); void rem_last_neighbour(); unique_meas_cell remove_neighbour_cell(uint32_t earfcn, uint32_t pci); void clean_neighbours(); void sort_neighbour_cells(); bool process_new_cell_meas(const std::vector& meas, const std::function& filter_meas); T* get_neighbour_cell_handle(uint32_t earfcn, uint32_t pci); const T* get_neighbour_cell_handle(uint32_t earfcn, uint32_t pci) const; void log_neighbour_cells() const; std::string print_neighbour_cells() const; std::set get_neighbour_pcis(uint32_t earfcn) const; bool has_neighbour_cell(uint32_t earfcn, uint32_t pci) const; size_t nof_neighbours() const { return neighbour_cells.size(); } T& operator[](size_t idx) { return *neighbour_cells[idx]; } const T& operator[](size_t idx) const { return *neighbour_cells[idx]; } T& at(size_t idx) { return *neighbour_cells.at(idx); } T* find_cell(uint32_t earfcn, uint32_t pci); // serving cell handling int set_serving_cell(phy_cell_t phy_cell, bool discard_serving); T& serving_cell() { return *serv_cell; } const T& serving_cell() const { return *serv_cell; } using iterator = typename std::vector::iterator; iterator begin() { return neighbour_cells.begin(); } iterator end() { return neighbour_cells.end(); } private: bool add_neighbour_cell_unsorted(unique_meas_cell cell); // args srslog::basic_logger& logger = srslog::fetch_basic_logger("RRC"); srsran::task_sched_handle task_sched; unique_meas_cell serv_cell; std::vector neighbour_cells; }; } // namespace srsue #endif // SRSRAN_RRC_CELL_H