platform.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2019, Cascoda Ltd.
 *  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 CA821X_OPENTHREAD_PLATFORM_PLATFORM_H_
#define CA821X_OPENTHREAD_PLATFORM_PLATFORM_H_
 
#include <stdint.h>
#include "openthread/instance.h"
#include "openthread/platform/radio.h"
#include "ca821x_api.h"
 
#include "cascoda-util/cascoda_settings.h"
 
extern otInstance *OT_INSTANCE;
 
#define SuccessOrExit(aCondition) \
    do                            \
    {                             \
        if ((aCondition) != 0)    \
        {                         \
            goto exit;            \
        }                         \
    } while (0)
 
enum openthread_message_codes
{
    OT_SERIAL_DOWNLINK = 0xB2,
    OT_SERIAL_UPLINK   = 0xB3,
};
 
static const uint16_t joiner_credential_key = 0xCA50;
static const uint16_t autostart_key = 0xCA51;
static const uint16_t sensordemo_key = 0xCA5C;
static const uint16_t actuatordemo_key = 0xCA5D;
static const uint16_t stack_profiler_key = 0xCA5E;
static const uint16_t OC_SETTINGS_KEY = 0xe107;
static const uint16_t OC_ENCRYPTION_KEY_KEY = 0xe108;
 
struct ca821x_dev *PlatformGetDeviceRef(void);
 
int PlatformRadioInit(void);
 
int PlatformRadioInitWithDev(struct ca821x_dev *pDeviceRef);
 
int PlatformRadioInitWithDevEui64(struct ca821x_dev *apDeviceRef, uint8_t *pEui64);
 
int PlatformIsExpectingIndication(void);
 
void PlatformRadioStop(void);
 
void PlatformAlarmInit(void);
 
otError PlatformSleep(uint32_t aSleepTime);
 
bool PlatformCanSleep(otInstance *aInstance);
 
otError PlatformUartReceive(const uint8_t *aBuf, uint16_t aBufLength);
 
otError PlatformTryJoin(struct ca821x_dev *pDeviceRef, otInstance *aInstance);
 
otError PlatformTryJoinWithCustomPoll(struct ca821x_dev *pDeviceRef, otInstance *aInstance, void (*poll_func)(void));
 
otError PlatformTryJoinWithPskd(struct ca821x_dev *pDeviceRef, otInstance *aInstance, const char *aPskd);
 
otError PlatformTryJoinWithPskdWithCustomPoll(struct ca821x_dev *pDeviceRef,
                                              otInstance        *aInstance,
                                              const char        *aPskd,
                                              void (*poll_func)(void));
 
otError PlatformPrintJoinerCredentials(struct ca821x_dev *pDeviceRef, otInstance *aInstance, uint32_t aMaxWaitMs);
 
otError PlatformPrintJoinerCredentialsWithPskd(struct ca821x_dev *pDeviceRef,
                                               otInstance        *aInstance,
                                               uint32_t           aMaxWaitMs,
                                               const char        *aPskd);
 
otError PlatformEraseJoinerCredentials(otInstance *aInstance);
 
const char *PlatformGetJoinerCredential(otInstance *aInstance);
 
otError otPlatSettingsGetAddress(uint16_t aKey, int aIndex, void **aValue, uint16_t *aValueLength);
 
otError otPlatSettingsAddVector(otInstance *aInstance, uint16_t aKey, struct settingBuffer *aVector, size_t aCount);
 
otError PlatformGetQRString(char *aBufOut, size_t bufferSize, otInstance *aInstance);
 
#endif /* CA821X_OPENTHREAD_PLATFORM_PLATFORM_H_ */