rit.c File Reference

#include "rit.h"
#include "power.h"
#include "types.h"
#include <LPC17xx.h>

Go to the source code of this file.

Functions
_DECL_EXTERNALLY void	allocate_jobs_list (MEM_Allocator *const)
_DECL_EXTERNALLY void	free_jobs_list (void)
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.

Variables
_PRIVATE const u32	rit_clk_mhz = 100
	RIT_CLK frequency in MHz. Can be checked in the RIT GUI in Keil.
_USED_EXTERNALLY u32	base_ival
_DECL_EXTERNALLY u32	counter_reset_value

Function Documentation

allocate_jobs_list()

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

_DECL_EXTERNALLY void free_jobs_list

(

void

)

Definition at line 45 of file rit_job.c.

{
    if (jobs)
        CL_ListFree(jobs);
}

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

void RIT_Enable

(

void

)

Enables the RIT counting.

Definition at line 50 of file rit.c.

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

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

Variable Documentation

base_ival

_USED_EXTERNALLY u32 base_ival

Definition at line 12 of file rit.c.

counter_reset_value

_DECL_EXTERNALLY u32 counter_reset_value

Definition at line 13 of file rit.c.

rit_clk_mhz

_PRIVATE const u32 rit_clk_mhz = 100

RIT_CLK frequency in MHz. Can be checked in the RIT GUI in Keil.

Definition at line 7 of file rit.c.