buttons.h File Reference

#include "button_types.h"
#include "types.h"

Go to the source code of this file.

Functions
BUTTON_Error	BUTTON_Init (u8 options)
	Initializes the BUTTON peripherals.
void	BUTTON_Deinit (void)
	Deinitializes the buttons, by removing all jobs, disabling the interrupts, and removing the debouncing job from the RIT.
BUTTON_Error	BUTTON_EnableSource (BUTTON_Source source, u8 int_priority)
	Enables the interrupt generation of the given source, provided that there's a function associated to it.
void	BUTTON_DisableSource (BUTTON_Source source)
	Disables the interrupt generation of the given source, but it leaves the function binding.
void	BUTTON_SetFunction (BUTTON_Source source, BUTTON_Function func)
	Binds a given interrupt to a functionality.
void	BUTTON_UnsetFunction (BUTTON_Source source)
	Unbinds the previously set function from the selected interrupt source.

Function Documentation

BUTTON_Deinit()

void BUTTON_Deinit

(

void

)

Deinitializes the buttons, by removing all jobs, disabling the interrupts, and removing the debouncing job from the RIT.

Definition at line 43 of file buttons.c.

{
    // Disabling EINT[0..2] in PINSEL4. In the table, these PINS behave
    // like EINTs when set to 01.
    LPC_PINCON->PINSEL4 &= ~(0b010101 << 20);
    LPC_SC->EXTMODE = 0x0;
    LPC_SC->EXTPOLAR = 0x0;
 
    NVIC_DisableIRQ(EINT0_IRQn);
    NVIC_DisableIRQ(EINT1_IRQn);
    NVIC_DisableIRQ(EINT2_IRQn);
 
    if (debouncer_on)
    {
        debouncer_on = false;
        RIT_RemoveJob(handle_debouncing);
    }
}

BUTTON_DisableSource()

void BUTTON_DisableSource

(

BUTTON_Source

source

)

Disables the interrupt generation of the given source, but it leaves the function binding.

Parameters

source

THe source to disable.

Definition at line 121 of file buttons_irq.c.

{
    if (!handlers[source].handler)
        return; // No handler associated
 
    handlers[source].source_enabled = false;
}

BUTTON_EnableSource()

BUTTON_Error BUTTON_EnableSource	(	BUTTON_Source	source,
		u8	int_priority
	)

Enables the interrupt generation of the given source, provided that there's a function associated to it.

Parameters

source	The source to enable.
int_priority	The priority to assign to the specified source.

Definition at line 84 of file buttons_irq.c.

{
    if (!handlers[source].handler)
        return BTN_ERR_NO_HANDLER_TO_ENABLE; // No handler associated
 
    handlers[source].source_enabled = true;
 
    switch (source)
    {
    case BTN_SRC_EINT0:
        NVIC_EnableIRQ(EINT0_IRQn);
        if (!IS_DEF_PRIORITY(int_priority) && IS_BETWEEN_EQ(int_priority, 0, 15))
            NVIC_SetPriority(EINT0_IRQn, int_priority);
        else
            return BTN_ERR_INT_PRIO_INVALID;
        break;
    case BTN_SRC_EINT1:
        NVIC_EnableIRQ(EINT1_IRQn);
        if (!IS_DEF_PRIORITY(int_priority) && IS_BETWEEN_EQ(int_priority, 0, 15))
            NVIC_SetPriority(EINT1_IRQn, int_priority);
        else
            return BTN_ERR_INT_PRIO_INVALID;
        break;
    case BTN_SRC_EINT2:
        NVIC_EnableIRQ(EINT2_IRQn);
        if (!IS_DEF_PRIORITY(int_priority) && IS_BETWEEN_EQ(int_priority, 0, 15))
            NVIC_SetPriority(EINT2_IRQn, int_priority);
        else
            return BTN_ERR_INT_PRIO_INVALID;
        break;
    default:
        return BTN_ERR_NO_HANDLER_TO_ENABLE;
    }
 
    return BTN_ERR_OK;
}

BUTTON_Init()

BUTTON_Error BUTTON_Init

(

u8

options

)

Initializes the BUTTON peripherals.

Parameters

options

Button options from the BUTTON_Config enum

Returns

BUTTON_Error The error.

Definition at line 15 of file buttons.c.

{
    // Enabling EINT[0..2] in PINSEL4. In the table, these PINS behave
    // like EINTs when set to 01.
    LPC_PINCON->PINSEL4 |= (0b010101 << 20);
 
    // EITs mapped to PINs 2.[10..12]. Need to set them to 0, i.e. input.
    LPC_GPIO2->FIODIR &= ~(0b111 << 10);
 
    // Setting how EINTs are raised using EXTMODE in SC. Setting 1 to the
    // bottom 3 bits to set interrupt edge sensitive. Since we're not modifying
    // EXTPOLAR in SC, ints are raised on FALLING EDGE.
    LPC_SC->EXTMODE = 0x7;
    LPC_SC->EXTPOLAR = 0x0;
    
    if (options & BTN_DEBOUNCE_WITH_RIT)
    {
        if (!RIT_IsEnabled())
            return BTN_ERR_RIT_UNINIT;
 
        debouncer_on = true;
        RIT_AddJob(handle_debouncing, RIT_NO_DIVIDER);
        RIT_EnableJob(handle_debouncing);
    }
 
    return BTN_ERR_OK;
}

BUTTON_SetFunction()

void BUTTON_SetFunction	(	BUTTON_Source	source,
		BUTTON_Function	func
	)

Binds a given interrupt to a functionality.

Parameters

source	Button interrupt source (enum BUTTON_Source)
handler	Function pointer to the interrupt handler.
int_priority	The priority to assign to the interrupts coming from the selected source.
enable	Whether to enable the function binding right away.

Definition at line 129 of file buttons_irq.c.

{
    handlers[source] = (InterruptHandlerWrapper){
        .handler = func,
        .source_enabled = false,
    };
}

BUTTON_UnsetFunction()

void BUTTON_UnsetFunction

(

BUTTON_Source

source

)

Unbinds the previously set function from the selected interrupt source.

Parameters

source

Interrupt source (enum BUTTON_Source)

Definition at line 137 of file buttons_irq.c.

{
    handlers[source] = (InterruptHandlerWrapper){
        .handler = NULL,
        .source_enabled = false,
    };
}