RCL.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-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_h__include
#define ti_drivers_RCL_h__include

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

#include <ti/drivers/rcl/LRF.h>
#include <ti/drivers/rcl/RCL_Types.h>
#include <ti/drivers/rcl/RCL_Client.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/hal/hal.h>

#include <ti/drivers/dpl/SemaphoreP.h>

typedef enum {
    RCL_standbyAllow = 0,
    RCL_standbyDisallow,
} RCL_PowerState;

typedef struct RCL_s {
    uint8_t                   numClients;
    uint8_t                   powerNotifyEnableCount;
    LRF_RadioState            lrfState;
    RCL_PowerState            powerState;
    const LRF_Config         *lrfConfig;
} RCL;

void RCL_init(void);

RCL_Handle RCL_open(RCL_Client *c, const LRF_Config *lrfConfig);

void RCL_close(RCL_Handle h);

void RCL_openPowerNotifications(void);

void RCL_closePowerNotifications(void);

RCL_CommandStatus RCL_Command_submit(RCL_Handle h, RCL_Command_Handle c);

RCL_CommandStatus RCL_Command_pend(RCL_Command_Handle c);

RCL_CommandStatus RCL_Command_stop(RCL_Command_Handle c, RCL_StopType stopType);

int8_t RCL_readRssi(void);

void RCL_triggerScheduler(void);

uint32_t RCL_getPhySwitchingTime(void);

#endif