cascoda_evbme.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.
 */
#include "cascoda-bm/cascoda_bm.h"
#include "ca821x_api.h"
 
#ifndef CASCODA_EVBME_H
#define CASCODA_EVBME_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CA_TARGET_NAME
// Should be defined by the build system
#define CA_TARGET_NAME "UNKNOWN-TARGET"
#endif
 
enum powerdown_mode
{
    PDM_ALLON        = 0, 
    PDM_ACTIVE       = 1, 
    PDM_STANDBY      = 2, 
    PDM_POWERDOWN    = 3, 
    PDM_POWEROFF     = 4, 
    PDM_DPD          = 5, 
    PDM_DPD_MCU_ONLY = 6, 
};
 
/******************************************************************************/
/****** Global Parameters that can by set via EVBME_SET_request          ******/
/******************************************************************************/
extern u8_t EVBME_HasReset;
extern u8_t EVBME_UseMAC;
 
extern void (*EVBME_Message)(char *message, size_t len);
extern void (*MAC_Message)(u8_t CommandId, u8_t Count, const u8_t *pBuffer);
 
/******************************************************************************/
/****** EVBME API Functions                                              ******/
/******************************************************************************/
 
/******************************************************************************/
/***************************************************************************/ 
ca_error EVBMEInitialise(const char *aAppName, struct ca821x_dev *dev);
 
/******************************************************************************/
/***************************************************************************/ 
const char *EVBME_GetAppName(void);
 
/******************************************************************************/
/***************************************************************************/ 
ca_error EVBME_NotHandled(const struct MAC_Message *msg, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void cascoda_io_handler(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
extern int (*cascoda_reinitialise)(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void EVBME_PowerDown(enum powerdown_mode mode, u32_t sleeptime_ms, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void EVBME_SwitchClock(struct ca821x_dev *pDeviceRef, u8_t useExternalClock);
 
/******************************************************************************/
/***************************************************************************/ 
void EVBME_CAX_Restart(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
ca_error EVBME_GET_OT_Attrib(enum evbme_attribute aAttrib, uint8_t *aOutBufLen, uint8_t *aOutBuf);
 
#ifdef __cplusplus
}
#endif
 
#endif // CASCODA_EVBME_H