RCL_Lite.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2023, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 OWNER 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 ti_drivers_RCL_Lite_h__include
#define ti_drivers_RCL_Lite_h__include

#include <stdint.h>
#include <stddef.h>

#include <ti/drivers/rcl/RCL_Event.h>
#include <ti/drivers/rcl/RCL_Command.h>
#include <ti/drivers/rcl/RCL_Buffer.h>
#include <ti/drivers/rcl/RCL_Scheduler.h>
#include <ti/drivers/rcl/LRF.h>
#include <ti/drivers/rcl/hal/hal.h>

void RCL_Lite_CommandHwi(void);

static inline LRF_SetupResult RCL_Lite_configSetPhyFeatures(const LRF_Config *lrfConfig, uint16_t phyFeatures)
{
    /* Temporary solution: Enable all needed clocks here and leave them enabled */
    LRF_rclEnableRadioClocks();
    return LRF_setupRadio(lrfConfig, phyFeatures, RadioState_Down);
}

static inline LRF_SetupResult RCL_Lite_config(const LRF_Config *lrfConfig)
{
    return RCL_Lite_configSetPhyFeatures(lrfConfig, LRF_PhyFeatures_Default);
}

static inline LRF_SetupResult RCL_Lite_setPhyFeatures(const LRF_Config *lrfConfig, uint16_t phyFeatures)
{
    return LRF_setupRadio(lrfConfig, phyFeatures, RadioState_Configured);
}


void RCL_Lite_Command_start(RCL_Command_Handle c);

bool RCL_Lite_Command_isFinished(void);

RCL_Command_Handle *RCL_Lite_Command_stop(RCL_StopType stopType);

static inline RCL_Command_Handle *RCL_Lite_Command_abort(void)
{
    return RCL_Lite_Command_stop(RCL_StopType_Hard);
}

static inline int8_t RCL_Lite_readRssi(void)
{
    return LRF_readRssi();
}

#endif