link.h

Go to the documentation of this file.

/*
 *  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.
 */

#ifndef OPENTHREAD_LINK_H_
#define OPENTHREAD_LINK_H_

#include <openthread/types.h>
#include <openthread/platform/radio.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef void (OTCALL *otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext);

OTAPI otError OTCALL otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration,
                                      otHandleActiveScanResult aCallback, void *aCallbackContext);

OTAPI bool OTCALL otLinkIsActiveScanInProgress(otInstance *aInstance);

typedef void (OTCALL *otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext);

OTAPI otError OTCALL otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration,
                                      otHandleEnergyScanResult aCallback, void *aCallbackContext);

OTAPI bool OTCALL otLinkIsEnergyScanInProgress(otInstance *aInstance);

OTAPI otError OTCALL otLinkSendDataRequest(otInstance *aInstance);

OTAPI bool OTCALL otLinkIsInTransmitState(otInstance *aInstance);

OTAPI uint8_t OTCALL otLinkGetChannel(otInstance *aInstance);

OTAPI otError OTCALL otLinkSetChannel(otInstance *aInstance, uint8_t aChannel);

OTAPI const otExtAddress *OTCALL otLinkGetExtendedAddress(otInstance *aInstance);

OTAPI otError OTCALL otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress);

OTAPI void OTCALL otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64);

OTAPI int8_t OTCALL otLinkGetMaxTransmitPower(otInstance *aInstance);

OTAPI void OTCALL otLinkSetMaxTransmitPower(otInstance *aInstance, int8_t aPower);

OTAPI otPanId OTCALL otLinkGetPanId(otInstance *aInstance);

OTAPI otError OTCALL otLinkSetPanId(otInstance *aInstance, otPanId aPanId);

OTAPI uint32_t OTCALL otLinkGetPollPeriod(otInstance *aInstance);

OTAPI void OTCALL otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod);

OTAPI otShortAddress OTCALL otLinkGetShortAddress(otInstance *aInstance);

OTAPI otMacFilterAddressMode OTCALL otLinkFilterGetAddressMode(otInstance *aInstance);

OTAPI otError OTCALL otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode);

OTAPI otError OTCALL otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress);

OTAPI otError OTCALL otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress);

OTAPI void OTCALL otLinkFilterClearAddresses(otInstance *aInstance);

OTAPI otError OTCALL otLinkFilterGetNextAddress(otInstance *aInstance,
                                                otMacFilterIterator *aIterator, otMacFilterEntry *aEntry);

OTAPI otError OTCALL otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss);

OTAPI otError OTCALL otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress);

OTAPI void OTCALL otLinkFilterClearRssIn(otInstance *aInstance);

OTAPI otError OTCALL otLinkFilterGetNextRssIn(otInstance *aInstance,
                                              otMacFilterIterator *aIterator, otMacFilterEntry *aEntry);

uint8_t otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss);

int8_t otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality);

OTAPI const otMacCounters *OTCALL otLinkGetCounters(otInstance *aInstance);

typedef void (*otLinkPcapCallback)(const otRadioFrame *aFrame, void *aContext);

void otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext);

bool otLinkIsPromiscuous(otInstance *aInstance);

otError otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous);

#ifdef __cplusplus
}  // extern "C"
#endif

#endif  // OPENTHREAD_LINK_H_