RCL_Scheduler.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-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_Scheduler_h__include
#define ti_drivers_RCL_Scheduler_h__include

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

#include <ti/drivers/rcl/RCL_Command.h>
#include <ti/drivers/rcl/hal/hal.h>

#define RCL_SCHEDULER_SYSTIM_US(x) (((uint32_t) (x)) * 4U)

#define RCL_SCHEDULER_SYSTIM_MS(x) (((uint32_t) (x)) * 4U * 1000U)


/* Timing constants */
#define ABS_START_TIME_OFFSET            RCL_SCHEDULER_SYSTIM_US(100U) 
#define IMM_START_TIME_OFFSET            RCL_SCHEDULER_SYSTIM_US(90U)  
#define RCL_SCHEDULER_MARGIN_ARM         RCL_SCHEDULER_SYSTIM_US(40U)  
#define RCL_SCHEDULER_MARGIN_CONFIGURE   RCL_SCHEDULER_SYSTIM_US(76U)  
#define RCL_SCHEDULER_MARGIN_LOAD        RCL_SCHEDULER_SYSTIM_US(460U) 
#define RCL_SCHEDULER_SLEEP_CUTOFF       RCL_SCHEDULER_SYSTIM_MS(10U)  
#define RCL_SCHEDULER_TRIG_NOW_DELAY     RCL_SCHEDULER_SYSTIM_US(50U)  
#if defined(DeviceFamily_CC23X0R5) || defined(DeviceFamily_CC23X0R2) || defined(DeviceFamily_CC23X0R22) || defined(DeviceFamily_CC2340R53)
#define RCL_SCHEDULER_WAKEUP_MARGIN      RCL_SCHEDULER_SYSTIM_US(390U) 
#else
#define RCL_SCHEDULER_WAKEUP_MARGIN      RCL_SCHEDULER_SYSTIM_US(1000U)
#endif

typedef enum {
    RCL_SchedulerStopReason_None = 0,       
    RCL_SchedulerStopReason_Timeout = 1,    
    RCL_SchedulerStopReason_Scheduling = 2, 
    RCL_SchedulerStopReason_Api = 3,        
} RCL_SchedulerStopReason;

typedef enum {
    RCL_SchedulerStopTimeState_Init = 0,       
    RCL_SchedulerStopTimeState_Found = 1,      
    RCL_SchedulerStopTimeState_Programmed = 2, 
} RCL_SchedulerStopTimeState;

typedef struct RCL_SchedulerStopInfo_s {
    uint32_t cmdStopEnabled                     : 1;
    uint32_t schedStopEnabled                   : 1;
    uint32_t apiStopEnabled                     : 1;
    RCL_SchedulerStopReason stopReason          : 2;
    uint32_t cmdStopTime;
    uint32_t schedStopTime;
} RCL_SchedulerStopInfo;

typedef struct RCL_SchedulerState_s {
    RCL_Command  *currCmd;
    uint32_t nextWantsStop                      : 1;
    RCL_SchedulerStopTimeState stopTimeState    : 2;
    RCL_SchedulerStopReason descheduleReason    : 2;
    RCL_Events postedRclEvents; /* Events to be handled by the command handler */
    uint32_t actualStartTime;
    RCL_SchedulerStopInfo hardStopInfo;
    RCL_SchedulerStopInfo gracefulStopInfo;
    uint16_t requestedPhyFeatures;
} RCL_SchedulerState;

extern RCL_SchedulerState rclSchedulerState;

RCL_CommandStatus RCL_Scheduler_findStopStatus(RCL_StopType stopType);

RCL_CommandStatus RCL_Scheduler_setStartStopTime(const RCL_Command *cmd);

RCL_CommandStatus RCL_Scheduler_setStartStopTimeEarliestStart(const RCL_Command *cmd, uint32_t earliestStartTime);

RCL_CommandStatus RCL_Scheduler_setCustomStartStopTime(const RCL_CommandTiming *timing, RCL_ScheduleType scheduling, bool allowDelay);

RCL_CommandStatus RCL_Scheduler_setCustomStartStopTimeEarliestStart(const RCL_CommandTiming *timing, RCL_ScheduleType scheduling, bool allowDelay, uint32_t earliestStartTime);

RCL_CommandStatus RCL_Scheduler_setCmdStopTimeNoStartTrigger(const RCL_Command *cmd);

RCL_CommandStatus RCL_Scheduler_setNewStartNow(void);

RCL_CommandStatus RCL_Scheduler_setNewStartAbsTime(uint32_t startTime, bool allowDelay);

RCL_CommandStatus RCL_Scheduler_setNewStartRelTime(uint32_t relStartTime);

RCL_StopType RCL_Scheduler_setStopTimes(void);

bool               RCL_Scheduler_isLater(uint32_t refTime, uint32_t chkTime);

int32_t            RCL_Scheduler_delta(uint32_t refTime, uint32_t chkTime);

static inline uint32_t RCL_Scheduler_getCurrentTime(void)
{
    return hal_get_current_time();
}

RCL_StopType RCL_Scheduler_setSchedStopTime(RCL_SchedulerStopInfo *stopInfo, uint32_t schedStopTime);

RCL_StopType RCL_Scheduler_setCmdStopTime(RCL_SchedulerStopInfo *stopInfo, uint32_t cmdStopTime);

RCL_StopType RCL_Scheduler_cancelSchedStopTime(RCL_SchedulerStopInfo *stopInfo);

RCL_StopType RCL_Scheduler_cancelCmdStopTime(RCL_SchedulerStopInfo *stopInfo);

bool RCL_Scheduler_postEvent(RCL_Command_Handle c, RCL_Events e);

#endif