third_party/openthread/repo/src/posix/platform/max_power_table.hpp

   1 /*
   2  *  Copyright (c) 2020, The OpenThread Authors.
   3  *  All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions are met:
   7  *  1. Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  *  2. Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *  3. Neither the name of the copyright holder nor the
  13  *     names of its contributors may be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  *  POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef OT_POSIX_PLATFORM_MAX_POWER_TABLE_HPP_
  30 #define OT_POSIX_PLATFORM_MAX_POWER_TABLE_HPP_
  31
  32 #include "core/radio/radio.hpp"
  33
  34 namespace ot {
  35 namespace Posix {
  36
  37 class MaxPowerTable
  38 {
  39 public:
  40     static const int8_t kPowerDefault = 30; ///< Default power 1 watt (30 dBm).
  41
  42     MaxPowerTable(void) { memset(mPowerTable, kPowerForbidden, sizeof(mPowerTable)); }
  43
  44     /**
  45      * This method gets the max allowed transmit power of channel @p aChannel.
  46      *
  47      * @params[in]  aChannel    The radio channel number.
  48      *
  49      * @returns The max allowed transmit power in dBm.
  50      *
  51      */
  52     int8_t GetTransmitPower(uint8_t aChannel) const { return mPowerTable[aChannel - Radio::kChannelMin]; }
  53
  54     /**
  55      * This method sets the max allowed transmit power of channel @p aChannel.
  56      *
  57      * @params[in]  aChannel    The radio channel number.
  58      * @params[in]  aPower      The max allowed transmit power in dBm.
  59      *
  60      */
  61     void SetTransmitPower(uint8_t aChannel, int8_t aPower) { mPowerTable[aChannel - Radio::kChannelMin] = aPower; }
  62
  63     /**
  64      * This method gets the allowed channel masks.
  65      *
  66      * All channels of max power value of 0x7f is considered forbidden.
  67      *
  68      */
  69     uint32_t GetAllowedChannelMask(void) const
  70     {
  71         uint32_t channelMask = 0;
  72
  73         for (uint8_t i = Radio::kChannelMin; i <= Radio::kChannelMax; ++i)
  74         {
  75             if (mPowerTable[i - Radio::kChannelMin] != kPowerForbidden)
  76             {
  77                 channelMask |= (1 << i);
  78             }
  79         }
  80
  81         return channelMask;
  82     }
  83
  84 private:
  85     static const int8_t kPowerForbidden = 0x7f;
  86
  87     int8_t mPowerTable[Radio::kChannelMax - Radio::kChannelMin + 1];
  88 };
  89
  90 } // namespace Posix
  91 } // namespace ot
  92
  93 #endif // OT_POSIX_PLATFORM_MAX_POWER_TABLE_HPP_