radio.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 RADIO_H_
#define RADIO_H_

#include <stdint.h>

#include <openthread/types.h>

#ifdef __cplusplus
extern "C" {
#endif

enum
{
    OT_RADIO_FRAME_MAX_SIZE      = 127,                             
    OT_RADIO_CHANNEL_MIN         = 11,                              
    OT_RADIO_CHANNEL_MAX         = 26,                              
    OT_RADIO_SUPPORTED_CHANNELS  = 0xffff << OT_RADIO_CHANNEL_MIN,  
    OT_RADIO_SYMBOLS_PER_OCTET   = 2,                               
    OT_RADIO_BIT_RATE            = 250000,                          

    OT_RADIO_BITS_PER_OCTET  = 8,      
    OT_RADIO_SYMBOL_TIME     = ((OT_RADIO_BITS_PER_OCTET / OT_RADIO_SYMBOLS_PER_OCTET) * 1000000) / OT_RADIO_BIT_RATE,

    OT_RADIO_LQI_NONE        = 0,      
    OT_RADIO_RSSI_INVALID    = 127,    
};

typedef enum otRadioCaps
{
    OT_RADIO_CAPS_NONE              = 0,  
    OT_RADIO_CAPS_ACK_TIMEOUT       = 1,  
    OT_RADIO_CAPS_ENERGY_SCAN       = 2,  
    OT_RADIO_CAPS_TRANSMIT_RETRIES  = 4,  
    OT_RADIO_CAPS_CSMA_BACKOFF      = 8,  
} otRadioCaps;

typedef struct otRadioFrame
{
    uint8_t  *mPsdu;            
    uint8_t  mLength;           
    uint8_t  mChannel;          
    int8_t   mPower;            
    uint8_t  mLqi;              
    uint8_t  mMaxTxAttempts;    
    bool     mSecurityValid: 1; 
    bool     mDidTX: 1;         
    bool     mIsARetx: 1;       

    uint32_t mMsec;

    uint16_t mUsec;
} otRadioFrame;

typedef enum otRadioState
{
    OT_RADIO_STATE_DISABLED = 0,
    OT_RADIO_STATE_SLEEP    = 1,
    OT_RADIO_STATE_RECEIVE  = 2,
    OT_RADIO_STATE_TRANSMIT = 3,
} otRadioState;

void otPlatRadioGetIeeeEui64(otInstance *aInstance, uint8_t *aIeeeEui64);

void otPlatRadioSetPanId(otInstance *aInstance, uint16_t aPanId);

void otPlatRadioSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress);

void otPlatRadioSetShortAddress(otInstance *aInstance, uint16_t aShortAddress);

otRadioState otPlatRadioGetState(otInstance *aInstance);

otError otPlatRadioEnable(otInstance *aInstance);

otError otPlatRadioDisable(otInstance *aInstance);

bool otPlatRadioIsEnabled(otInstance *aInstance);

otError otPlatRadioSleep(otInstance *aInstance);

otError otPlatRadioReceive(otInstance *aInstance, uint8_t aChannel);

void otPlatRadioEnableSrcMatch(otInstance *aInstance, bool aEnable);

otError otPlatRadioAddSrcMatchShortEntry(otInstance *aInstance, const uint16_t aShortAddress);

otError otPlatRadioAddSrcMatchExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress);

otError otPlatRadioClearSrcMatchShortEntry(otInstance *aInstance, const uint16_t aShortAddress);

otError otPlatRadioClearSrcMatchExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress);

void otPlatRadioClearSrcMatchShortEntries(otInstance *aInstance);

void otPlatRadioClearSrcMatchExtEntries(otInstance *aInstance);

extern void otPlatRadioReceiveDone(otInstance *aInstance, otRadioFrame *aFrame, otError aError);

otRadioFrame *otPlatRadioGetTransmitBuffer(otInstance *aInstance);

otError otPlatRadioTransmit(otInstance *aInstance, otRadioFrame *aFrame);

extern void otPlatRadioTxStarted(otInstance *aInstance, otRadioFrame *aFrame);

extern void otPlatRadioTxDone(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame,
                              otError aError);

int8_t otPlatRadioGetRssi(otInstance *aInstance);

otRadioCaps otPlatRadioGetCaps(otInstance *aInstance);

void otPlatRadioSetDefaultTxPower(otInstance *aInstance, int8_t aPower);

bool otPlatRadioGetPromiscuous(otInstance *aInstance);

void otPlatRadioSetPromiscuous(otInstance *aInstance, bool aEnable);

extern void otPlatDiagRadioTransmitDone(otInstance *aInstance, otRadioFrame *aFrame, otError aError);

extern void otPlatDiagRadioReceiveDone(otInstance *aInstance, otRadioFrame *aFrame, otError aError);

otError otPlatRadioEnergyScan(otInstance *aInstance, uint8_t aScanChannel, uint16_t aScanDuration);

extern void otPlatRadioEnergyScanDone(otInstance *aInstance, int8_t aEnergyScanMaxRssi);

int8_t otPlatRadioGetReceiveSensitivity(otInstance *aInstance);

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

#endif  // RADIO_H_