rit.h File Reference

#include "allocator.h"
#include "rit_types.h"
#include "types.h"
#include <stdbool.h>

Go to the source code of this file.

Functions
RIT_Error	RIT_Init (MEM_Allocator *const alloc, u32 ival_ms, u16 int_priority)
	Initialize the RIT.
void	RIT_Deinit (void)
	De-initializes the RIT, by removing every job and disconnecting power.
void	RIT_Enable (void)
	Enables the RIT counting.
void	RIT_Disable (void)
	Disables the RIT entirely (stops counting).
bool	RIT_IsEnabled (void)
	Returns whether the RIT is counting or not.
u32	RIT_GetIntervalMs (void)
	Returns the interval in millis that RIT uses for its interrupts.
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 multiplier_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.

Function Documentation

RIT_AddJob()

RIT_Error RIT_AddJob	(	RIT_Job	job,
		u8	multiplier_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_Deinit()

void RIT_Deinit

(

void

)

De-initializes the RIT, by removing every job and disconnecting power.

Definition at line 43 of file rit.c.

{
    free_jobs_list();
    NVIC_DisableIRQ(RIT_IRQn);
    POWER_TurnOffPeripheral(POW_PCRIT);
}

RIT_Disable()

void RIT_Disable

(

void

)

Disables the RIT entirely (stops counting).

Definition at line 55 of file rit.c.

{
    CLR_BIT(LPC_RIT->RICTRL, 3);
}

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_Enable()

void RIT_Enable

(

void

)

Enables the RIT counting.

Definition at line 50 of file rit.c.

{
    SET_BIT(LPC_RIT->RICTRL, 3);
}

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_GetIntervalMs()

u32 RIT_GetIntervalMs

(

void

)

Returns the interval in millis that RIT uses for its interrupts.

Definition at line 65 of file rit.c.

{
    return base_ival;
}

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_Init()

RIT_Error RIT_Init	(	MEM_Allocator *const	alloc,
		u32	ival_ms,
		u16	int_priority
	)

Initialize the RIT.

Parameters

alloc	The memory allocator to use for the RIT job list.
ival_ms	Interval in millis between each RIT interrupt.
int_priority	Debouncer interrupt priority (0 (highest), 15 (lowest)). If set to INT_PRIO_DEF, the default priority will be used.

Note

The RIT has a fixed number of jobs that can be added to the job queue, defined by RIT_JOBS_COUNT (20 by default) in the peripherals.h file.

Returns

RIT_Error The error.

Definition at line 15 of file rit.c.

{
    // Powering up the RIT
    POWER_TurnOnPeripheral(POW_PCRIT);
 
    CLR_BITS(LPC_SC->PCLKSEL1, 3, 26); // Clear
    SET_BIT(LPC_SC->PCLKSEL1, 26);     // Set PCLK_RIT to CCLK
    SET_BIT(LPC_SC->PCONP, 16);        // Enable power to RIT
 
    LPC_RIT->RICOMPVAL = (rit_clk_mhz * ival_ms * 1000);
    LPC_RIT->RICTRL = 6; // Clear on match + Timer enable for debug
    LPC_RIT->RICOUNTER = 0;
 
    base_ival = ival_ms;
    counter_reset_value = ival_ms;
 
    allocate_jobs_list(alloc);
 
    // Enabling interrupts coming from RIT
    NVIC_EnableIRQ(RIT_IRQn);
 
    if (!IS_DEF_PRIORITY(int_priority) && IS_BETWEEN_EQ(int_priority, 0, 15))
        return RIT_ERR_INT_PRIO_INVALID;
 
    NVIC_SetPriority(RIT_IRQn, int_priority);
    return RIT_ERR_OK;
}

RIT_IsEnabled()

bool RIT_IsEnabled

(

void

)

Returns whether the RIT is counting or not.

Definition at line 60 of file rit.c.

{
    return LPC_RIT->RICTRL & (1 << 3);
}

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;
}