SignalStrength.hpp

/*
 *  Copyright (c) 2017-2020 The Linux Foundation. All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form 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.
 *    * Neither the name of The Linux Foundation nor the names of its
 *      contributors may be used to endorse or promote products derived
 *      from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER 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.
 */

/*
 *  Changes from Qualcomm Innovation Center are provided under the following license:
 *
 *  Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the
 * disclaimer below) provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *     * Redistributions in binary form 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.
 *
 *     * Neither the name of Qualcomm Innovation Center, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
 * GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER 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 SIGNALSTRENGTH_HPP
#define SIGNALSTRENGTH_HPP

#include <memory>

#define INVALID_SIGNAL_STRENGTH_VALUE 0x7FFFFFFF

namespace telux {

namespace tel {

// forward declarations
class LteSignalStrengthInfo;
class GsmSignalStrengthInfo;
class CdmaSignalStrengthInfo;
class WcdmaSignalStrengthInfo;
class TdscdmaSignalStrengthInfo;
class Nr5gSignalStrengthInfo;

enum class SignalStrengthLevel {
   LEVEL_1,
   LEVEL_2,
   LEVEL_3,
   LEVEL_4,
   LEVEL_5,
   LEVEL_UNKNOWN = -1,
};

class SignalStrength {
public:
   SignalStrength(std::shared_ptr<LteSignalStrengthInfo> lteSignalStrengthInfo,
                  std::shared_ptr<GsmSignalStrengthInfo> gsmSignalStrengthInfo,
                  std::shared_ptr<CdmaSignalStrengthInfo> cdmaSignalStrengthInfo,
                  std::shared_ptr<WcdmaSignalStrengthInfo> wcdmaSignalStrengthInfo,
                  std::shared_ptr<TdscdmaSignalStrengthInfo> tdscdmaSignalStrengthInfo,
                  std::shared_ptr<Nr5gSignalStrengthInfo> nr5gSignalStrengthInfo);
   std::shared_ptr<LteSignalStrengthInfo> getLteSignalStrength();

   std::shared_ptr<GsmSignalStrengthInfo> getGsmSignalStrength();

   std::shared_ptr<CdmaSignalStrengthInfo> getCdmaSignalStrength();

   std::shared_ptr<WcdmaSignalStrengthInfo> getWcdmaSignalStrength();

   std::shared_ptr<TdscdmaSignalStrengthInfo> getTdscdmaSignalStrength();

   std::shared_ptr<Nr5gSignalStrengthInfo> getNr5gSignalStrength();

private:
   std::shared_ptr<LteSignalStrengthInfo> lteSS_;
   std::shared_ptr<GsmSignalStrengthInfo> gsmSS_;
   std::shared_ptr<CdmaSignalStrengthInfo> cdmaSS_;
   std::shared_ptr<WcdmaSignalStrengthInfo> wcdmaSS_;
   std::shared_ptr<TdscdmaSignalStrengthInfo> tdscdmaSS_;
   std::shared_ptr<Nr5gSignalStrengthInfo> nr5gSS_;
};

class LteSignalStrengthInfo {
public:
   LteSignalStrengthInfo(int lteSignalStrength, int lteRsrp, int lteRsrq, int lteRssnr, int lteCqi,
                         int timingAdvance);
   const SignalStrengthLevel getLevel() const;

   const int getDbm() const;

   const int getLteSignalStrength() const;

   const int getLteReferenceSignalReceiveQuality() const;

   const int getLteReferenceSignalSnr() const;

   const int getLteChannelQualityIndicator() const;

   const int getTimingAdvance() const;

private:
   int lteSignalStrength_;
   int lteRsrp_;
   int lteRsrq_;
   int lteRssnr_;
   int lteCqi_;
   int timingAdvance_;
};

class GsmSignalStrengthInfo {
public:
   GsmSignalStrengthInfo(int gsmSignalStrength, int gsmBitErrorRate, int timingAdvance);
   const SignalStrengthLevel getLevel() const;

   const int getDbm() const;

   const int getGsmSignalStrength() const;

   const int getGsmBitErrorRate() const;

   const int getTimingAdvance();

private:
   int gsmSignalStrength_;
   int gsmBitErrorRate_;
   int timingAdvance_;
};

class CdmaSignalStrengthInfo {
public:
   CdmaSignalStrengthInfo(int cdmaDbm, int cdmaEcio, int evdoDbm, int evdoEcio,
                          int evdoSignalNoiseRatio);
   const SignalStrengthLevel getLevel() const;

   const int getDbm() const;

   const int getCdmaEcio() const;

   const int getEvdoEcio() const;

   const int getEvdoSignalNoiseRatio() const;

private:
   // Helper functions used to calculate EVDO dBm and EVDO Level
   const int getEvdoDbm() const;
   const SignalStrengthLevel getEvdoLevel() const;
   // Helper functions used  to calculate CDMA dBm and CDMA Level
   const int getCdmaDbm() const;
   const SignalStrengthLevel getCdmaLevel() const;
   int cdmaDbm_;
   int cdmaEcio_;
   int evdoDbm_;
   int evdoEcio_;
   int evdoSignalNoiseRatio_;
};

class WcdmaSignalStrengthInfo {
public:
   WcdmaSignalStrengthInfo(int signalStrength, int bitErrorRate);
   const SignalStrengthLevel getLevel() const;

   const int getDbm() const;

   const int getSignalStrength() const;

   const int getBitErrorRate() const;

private:
   int signalStrength_;
   int bitErrorRate_;
};

class TdscdmaSignalStrengthInfo {
public:
   TdscdmaSignalStrengthInfo(int rscp);

   const int getRscp() const;

private:
   int rscp_;
};

class Nr5gSignalStrengthInfo {
public:
   Nr5gSignalStrengthInfo(int rsrp, int rsrq, int rssnr);
   const SignalStrengthLevel getLevel() const;

   const int getDbm() const;

   const int getReferenceSignalReceiveQuality() const;

   const int getReferenceSignalSnr() const;

private:
   int rsrp_;
   int rsrq_;
   int rssnr_;
};
 /* end_addtogroup telematics_phone */

}  // End of namespace tel

}  // End of namespace telux

#endif