src/core/mac/mac_whitelist_impl.hpp

/*
 *  Copyright (c) 2016, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. 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.
 *  3. Neither the name of the copyright holder 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 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.
 */

/**
 * @file
 *   This file includes definitions for IEEE 802.15.4 frame filtering based on MAC address.
 */

#ifndef MAC_WHITELIST_HPP_
#define MAC_WHITELIST_HPP_

#include "utils/wrap_stdint.h"

#include <openthread/types.h>

#include "mac/mac_frame.hpp"

namespace ot {
namespace Mac {

/**
 * @addtogroup core-mac
 *
 * @{
 *
 */

/**
 * This class implements whitelist filtering on IEEE 802.15.4 frames.
 *
 */
class Whitelist
{
public:
    typedef otMacWhitelistEntry Entry;

    enum
    {
        kMaxEntries = OPENTHREAD_CONFIG_MAC_WHITELIST_SIZE,
    };

    /**
     * This constructor initializes the whitelist filter.
     *
     */
    Whitelist(void);

    /**
     * This method indicates whether or not the whitelist filter is enabled.
     *
     * @retval TRUE   If the whitelist filter is enabled.
     * @retval FALSE  If the whitelist filter is disabled.
     *
     */
    bool IsEnabled(void) const { return mEnabled; }

    /**
     * This method enables the whitelist filter.
     *
     * @param[in]  aEnabled  TRUE to enable the whitelist filter, FALSE otherwise.
     *
     */
    void SetEnabled(bool aEnabled) { mEnabled = aEnabled; }

    /**
     * This method returns the maximum number of whitelist entries.
     *
     * @returns The maximum number of whitelist entries.
     *
     */
    int GetMaxEntries(void) const { return kMaxEntries; }

    /**
     * This method gets a whitelist entry.
     *
     * @param[in]   aIndex  An index into the MAC whitelist table.
     * @param[out]  aEntry  A reference to where the information is placed.
     *
     * @retval OT_ERROR_NONE          Successfully retrieved the MAC whitelist entry.
     * @retval OT_ERROR_INVALID_ARGS  @p aIndex is out of bounds or @p aEntry is NULL.
     *
     */
    otError GetEntry(uint8_t aIndex, Entry &aEntry) const;

    /**
     * This method adds an Extended Address to the whitelist filter.
     *
     * @param[in]  aAddress  A reference to the Extended Address.
     *
     * @returns A pointer to the whitelist entry or NULL if there are no available entries.
     *
     */
    Entry *Add(const ExtAddress &aAddress);

    /**
     * This method removes an Extended Address to the whitelist filter.
     *
     * @param[in]  aAddress  A reference to the Extended Address.
     *
     */
    void Remove(const ExtAddress &aAddress);

    /**
     * This method removes all entries from the whitelist filter.
     *
     */
    void Clear(void);

    /**
     * This method finds a whitelist entry.
     *
     * @param[in]  aAddress  A reference to the Extended Address.
     *
     * @returns A pointer to the whitelist entry or NULL if the entry could not be found.
     *
     */
    Entry *Find(const ExtAddress &aAddress);

    /**
     * This method clears the fixed RSSI value and uses the measured value provided by the radio instead.
     *
     * @param[in]  aEntry  A reference to the whitelist entry.
     *
     */
    void ClearFixedRssi(Entry &aEntry);

    /**
     * This method indicates whether or not the fixed RSSI is set.
     *
     * @param[in]   aEntry  A reference to the whitelist entry.
     * @param[out]  aRssi   A reference to the RSSI variable.
     *
     * @retval OT_ERROR_NONE          A fixed RSSI is set and written to @p aRssi.
     * @retval OT_ERROR_INVALID_ARGS  A fixed RSSI was not set.
     *
     */
    otError GetFixedRssi(Entry &aEntry, int8_t &aRssi) const;

    /**
     * This method sets a fixed RSSI value for all received messages matching @p aEntry.
     *
     * @param[in]  aEntry  A reference to the whitelist entry.
     * @param[in]  aRssi   An RSSI value in dBm.
     *
     */
    void SetFixedRssi(Entry &aEntry, int8_t aRssi);

private:
    Entry mWhitelist[kMaxEntries];

    bool mEnabled;
};

/**
 * @}
 *
 */

}  // namespace Mac
}  // namespace ot

#endif  // MAC_WHITELIST_HPP_