leds.h

Go to the documentation of this file.

/*
 * Copyright 2015 Sebastian Neuser
 *
 * This file is part of the uMIDI firmware.
 *
 * the uMIDI firmware is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * the uMIDI firmware is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the uMIDI firmware.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _LEDS_H
#define _LEDS_H


//---------------- includes ----------------//
#include <stdbool.h>
#include <avr/io.h>

#include "gpio.h"


//---------------- constants ----------------//

extern struct led* led_red;

extern struct led* led_green;

#define LED_GREEN   led_green

#define LED_RED     led_red


//---------------- data types ----------------//
enum led_mode
{
    LED_STATIC,                     
    LED_FLASH,                      
    LED_BLINK                       
};

struct led_state
{
    bool            active;         
    enum led_mode   mode;           
    uint8_t         prescaler;      
    uint8_t         counter;        
};

struct led
{
    const struct gpio_pin* const pin;   
    struct led_state state;             
};


//---------------- functions and procedures ----------------//
void init_leds_module(void);


void register_led(struct led * const);

void blink_led(struct led* led, uint8_t prescaler);

void flash_led(struct led* led);

void flash_led_multiple(struct led* led, uint8_t count);

void set_led(struct led* led, bool enable);

void toggle_led(struct led* led);

void update_leds(void);


//---------------- EOF ----------------//
#endif // _LEDS_H