rit_job.c File Reference

#include "cl_list.h"
#include "rit.h"
#include <LPC17xx.h>
#include <stdlib.h>
#include <string.h>

Go to the source code of this file.

Classes
struct	JobWrapper

Functions
void	allocate_jobs_list (MEM_Allocator *const alloc)
void	free_jobs_list (void)
_PRIVATE void	recalculate_reset_value (void)
RIT_Error	RIT_EnableJob (RIT_Job job)
	Include this job in the RIT handler queue.
RIT_Error	RIT_DisableJob (RIT_Job job)
	Exclude this job from the RIT handler queue.
RIT_Error	RIT_AddJob (RIT_Job job, u8 divider_factor)
RIT_Error	RIT_RemoveJob (RIT_Job job)
	Removes a job from the RIT interrupt handler job queue.
u32	RIT_GetJobsCount (void)
	Returns the number of jobs in the job queue.
u8	RIT_GetJobMultiplierFactor (RIT_Job job)
	Returns the multiplier factor for the given job.
RIT_Error	RIT_SetJobMultiplierFactor (RIT_Job job, u8 multiplier_factor)
	Sets the multiplier factor for the given job.
void	RIT_ClearJobs (void)
	Clears the job queue.
void	RIT_IRQHandler (void)

Variables
_DECL_EXTERNALLY u32	base_ival
	External variable that stores the base interval between each RIT interrupt.
_PRIVATE CL_List *	jobs
	Array of jobs to execute in the RIT interrupt handler.
_PRIVATE u32	counter = 0
	Stores the current RIT counter value, and it's incremented by each RIT interrupt. It's used with the counter_reset_value, that's the maximum value the counter can reach before being reset, which corresponds to the interval of the less frequent job.
_USED_EXTERNALLY u32	counter_reset_value

Function Documentation

allocate_jobs_list()

void allocate_jobs_list

(

MEM_Allocator *const

alloc

)

Definition at line 37 of file rit_job.c.

{
    jobs = CL_ListAlloc(alloc, sizeof(JobWrapper));
    if (!jobs)
        return;
}

free_jobs_list()

void free_jobs_list

(

void

)

Definition at line 45 of file rit_job.c.

{
    if (jobs)
        CL_ListFree(jobs);
}

recalculate_reset_value()

_PRIVATE void recalculate_reset_value

(

void

)

Definition at line 51 of file rit_job.c.

{
    counter_reset_value = base_ival;
    CL_LIST_FOREACH_PTR(JobWrapper, job, jobs, {
        if (!job->enabled || !job->job)
            continue;
 
        if (job->interval > counter_reset_value)
            counter_reset_value = job->interval;
    });
}

RIT_AddJob()

RIT_Error RIT_AddJob	(	RIT_Job	job,
		u8	divider_factor
	)

Definition at line 104 of file rit_job.c.

{
    const u32 ival = base_ival * divider_factor;
    if (CL_ListPushBack(jobs, &(JobWrapper){.job = job, .interval = ival, .enabled = false}) != CL_ERR_OK)
        return RIT_ERR_DURING_PUSHBACK;
 
    // Compute the maximum value counter can reach before being reset
    if (ival > counter_reset_value)
        counter_reset_value = ival;
 
    return RIT_ERR_OK;
}

RIT_ClearJobs()

void RIT_ClearJobs

(

void

)

Clears the job queue.

Definition at line 175 of file rit_job.c.

{
    CL_ListClear(jobs);
    counter_reset_value = base_ival;
}

RIT_DisableJob()

RIT_Error RIT_DisableJob

(

RIT_Job

job

)

Exclude this job from the RIT handler queue.

Definition at line 85 of file rit_job.c.

{
    CL_LIST_FOREACH_PTR(JobWrapper, list_job, jobs, {
        if (list_job->job == job)
        {
            list_job->enabled = false;
 
            // Need to recompute the counter_reset_value, if this job was
            // the slowest one.
            if (list_job->interval == counter_reset_value)
                recalculate_reset_value();
 
            return RIT_ERR_OK;
        }
    });
 
    return RIT_ERR_JOB_NOT_FOUND;
}

RIT_EnableJob()

RIT_Error RIT_EnableJob

(

RIT_Job

job

)

Include this job in the RIT handler queue.

Definition at line 65 of file rit_job.c.

{
    CL_LIST_FOREACH_PTR(JobWrapper, list_job, jobs, {
        if (list_job->job == job)
        {
            list_job->enabled = true;
 
            // Need to recompute the counter_reset_value, if the interval
            // of the enabled job is higher than the current least frequent enabled job.
            if (list_job->interval > counter_reset_value)
                counter_reset_value = list_job->interval;
 
            return RIT_ERR_OK;
        }
    });
 
    // If here, job was not found
    return RIT_ERR_JOB_NOT_FOUND;
}

RIT_GetJobMultiplierFactor()

u8 RIT_GetJobMultiplierFactor

(

RIT_Job

job

)

Returns the multiplier factor for the given job.

Parameters

job	The job to get the multiplier factor from

Returns

u8 The multiplier factor

Definition at line 143 of file rit_job.c.

{
    CL_LIST_FOREACH_PTR(JobWrapper, list_job, jobs, {
        if (list_job->job == job)
            return list_job->interval / base_ival;
    })
 
    return 0;
}

RIT_GetJobsCount()

u32 RIT_GetJobsCount

(

void

)

Returns the number of jobs in the job queue.

Definition at line 138 of file rit_job.c.

{
    return CL_ListSize(jobs);
}

RIT_IRQHandler()

void RIT_IRQHandler ( void  )

extern

Definition at line 183 of file rit_job.c.

{
#ifdef SIMULATOR
    RIT_Disable();
#endif
 
    LPC_RIT->RICOUNTER = 0;      // Reset counter
    SET_BIT(LPC_RIT->RICTRL, 0); // Clear interrupt flag
 
    if (CL_ListSize(jobs) <= 0)
        return;
 
    counter += base_ival;
    CL_LIST_FOREACH_PTR(JobWrapper, job, jobs, {
        if (!job->enabled)
            continue;
 
        if (counter % job->interval == 0 && job->job)
            job->job();
    });
 
    // Reset the counter if the maximum value is reached
    if (counter >= counter_reset_value)
        counter = 0;
 
#ifdef SIMULATOR
    RIT_Enable();
#endif
}

RIT_RemoveJob()

RIT_Error RIT_RemoveJob

(

RIT_Job

job

)

Removes a job from the RIT interrupt handler job queue.

Parameters

job	The job to remove

Definition at line 117 of file rit_job.c.

{
    for (u32 i = 0; i < CL_ListSize(jobs); i++)
    {
        JobWrapper *const list_job;
        CL_ListGetPtr(jobs, i, (void **)&(list_job));
        {
            if (list_job->job == job)
            {
                if (CL_ListRemoveAt(jobs, i, ((void *)0)) != CL_ERR_OK)
                    return RIT_ERR_DURING_REMOVEAT;
 
                recalculate_reset_value();
                break;
            }
        }
    }
 
    return RIT_ERR_OK;
}

RIT_SetJobMultiplierFactor()

RIT_Error RIT_SetJobMultiplierFactor	(	RIT_Job	job,
		u8	multiplier_factor
	)

Sets the multiplier factor for the given job.

Parameters

job	The job to set the multiplier factor for
multiplier_factor	The new multiplier factor

Returns

RIT_Error The error.

Definition at line 153 of file rit_job.c.

{
    if (multiplier_factor == 0)
        return RIT_ERR_INVALID_MULTIPLIER;
 
    CL_LIST_FOREACH_PTR(JobWrapper, list_job, jobs, {
        if (list_job->job == job)
        {
            list_job->interval = base_ival * multiplier_factor;
 
            // Need to recompute the counter_reset_value, if this job was
            // the slowest one.
            if (list_job->interval == counter_reset_value)
                recalculate_reset_value();
 
            return RIT_ERR_OK;
        }
    });
 
    return RIT_ERR_JOB_NOT_FOUND;
}

Variable Documentation

base_ival

_DECL_EXTERNALLY u32 base_ival

External variable that stores the base interval between each RIT interrupt.

Note

This variable is used to calculate the RIT counter value for each job.

Definition at line 23 of file rit_job.c.

counter

_PRIVATE u32 counter = 0

Stores the current RIT counter value, and it's incremented by each RIT interrupt. It's used with the counter_reset_value, that's the maximum value the counter can reach before being reset, which corresponds to the interval of the less frequent job.

Definition at line 31 of file rit_job.c.

counter_reset_value

_USED_EXTERNALLY u32 counter_reset_value

Definition at line 32 of file rit_job.c.

jobs

_PRIVATE CL_List* jobs

Array of jobs to execute in the RIT interrupt handler.

Definition at line 26 of file rit_job.c.