LED functions

Functions
enum sd_led_err	sd_led_init (struct sd_led *led, TIM_HandleTypeDef *tim, uint32_t chan, uint32_t *pattern, uint32_t len, TIM_HandleTypeDef *up_tim)
	LED initialization Initialize an LED configuration on a timer peripheral with a pattern. More...
enum sd_led_err	sd_led_enable (struct sd_led *led, uint8_t en)
	LED Enable.
enum sd_led_err	sd_led_reset (struct sd_led *led)
	LED reset Reset the LED configuration and clear the pattern. More...
enum sd_led_err	sd_led_queuehandler (struct sd_led *led)
	LED queue handler Execute the LED pattern state machine. More...
enum sd_led_err	sd_led_set_pattern (struct sd_led *led, uint32_t *pattern, uint32_t len, uint8_t repeat)
	LED set pattern Set pattern for LED output. More...

Detailed Description

Function Documentation

sd_led_init()

enum sd_led_err sd_led_init	(	struct sd_led *	led,
		TIM_HandleTypeDef *	tim,
		uint32_t	chan,
		uint32_t *	pattern,
		uint32_t	len,
		TIM_HandleTypeDef *	up_tim
	)

#include <Src/sd_led.c>

LED initialization Initialize an LED configuration on a timer peripheral with a pattern.

Parameters

led	LED configuration
tim	Timer handle associated with the LED
chan	Timer channel for the LED
pattern	The pattern to initialize the LED with
len	Length of the pattern
up_tim	Update timer for patter queue

Return values

SD_LED_SUCCESS

on success, error status otherwise

Only reenable the update timer if it was running prior to this function being called

{
    uint8_t reenable_timer;
                  
    /* Check for NULL pointers for the config and timer handle */
    if (led == NULL)
        return SD_LED_NULL_HANDLE_ERROR;

    if (led->tim == NULL)
        return SD_LED_NULL_TIMER_ERROR; 

    /* Check if the update timer has been initialized */
    if ((up_tim->Instance->CR1 & (TIM_CR1_CEN)) && 
        (up_tim->Instance->DIER & (TIM_IT_UPDATE))) {
        reenable_timer = 1;
        HAL_TIM_Base_Stop_IT(up_tim);
    }
       
    /* Set the configuration of the LED */
    led->tim = tim;
    led->chan = chan;
    led->pattern = pattern;
    led->pattern_len = len;
    led->pattern_idx = 0;
    led->up_tim = up_tim;
         
    if (reenable_timer)
        HAL_TIM_Base_Start_IT(up_tim);
  
    return SD_LED_SUCCESS;
}

sd_led_queuehandler()

enum sd_led_err sd_led_queuehandler

(

struct sd_led *

led

)

#include <Src/sd_led.c>

LED queue handler Execute the LED pattern state machine.

Parameters

led	The LED pattern handle

Return values

SD_LED_SUCCESS

on success, error status otherwise

{
  
    /* Check for NULL pointers for the config and timer handle */
    if (led == NULL) 
        return SD_LED_NULL_HANDLE_ERROR;
    if (led->tim == NULL) 
        return SD_LED_NULL_TIMER_ERROR;
  
    /* For uninitialized patterns, do nothing */
    if (led->pattern == NULL)
        return SD_LED_IDLE;
  
    /* Restart the pattern index if necessary */
    if (led->pattern_idx >= led->pattern_len ) {
        led->pattern_idx = 0;
    
        /* Is the pattern repeating? */
        if (!(led->repeat)) {
                led->pattern = NULL;
                led->pattern_len = 0;
                return SD_LED_SUCCESS;  /* Return without configuring the PWM */
        } else if (led->pattern_next != NULL)  {
            /* Is there a new pattern to start? */
            led->pattern = led->pattern_next;
            led->pattern_next = NULL;
        }
    }
  
    /* Set the pattern value in the configuration */
    led->cfg->Pulse = led->pattern[led->pattern_idx++];
  
    /* Set the configuration */
    HAL_TIM_PWM_ConfigChannel(led->tim, led->cfg, led->chan);
  
    /* Set the PWM Output */
    HAL_TIM_PWM_Start(led->tim, led->chan);
  
    return SD_LED_SUCCESS;
}

sd_led_reset()

enum sd_led_err sd_led_reset

(

struct sd_led *

led

)

#include <Src/sd_led.c>

LED reset Reset the LED configuration and clear the pattern.

Parameters

led	LED configuration

Return values

SD_LED_SUCCESS

on success, error status otherwise

{
  
    /* Check for NULL pointers for the config and timer handle */
    if (led == NULL)
        return SD_LED_NULL_HANDLE_ERROR;
    if (led->tim == NULL)
        return SD_LED_NULL_TIMER_ERROR;
  
    /* Disable update timer interrupt */
    HAL_TIM_Base_Stop_IT(led->up_tim);
  
    /* Set the pattern value in the configuration */
    led->cfg->Pulse = 0;
  
    /* Set the configuration */
    HAL_TIM_PWM_ConfigChannel(led->tim, led->cfg, led->chan);
    
    /* Remove the pattern from the LED */
    led->pattern = NULL;
    led->pattern_next = NULL;
    led->pattern_idx = 0;
    led->pattern_len = 0;
    led->repeat = 0;
    
    /* Enable update timer interrupt */
    HAL_TIM_Base_Start_IT(led->up_tim);
  
    return SD_LED_SUCCESS;
}

sd_led_set_pattern()

enum sd_led_err sd_led_set_pattern	(	struct sd_led *	led,
		uint32_t *	pattern,
		uint32_t	len,
		uint8_t	repeat
	)

#include <Src/sd_led.c>

LED set pattern Set pattern for LED output.

Parameters

led	The LED pattern handle
pattern	The pattern to use for the LED
len	The length of the pattern
repeat	Set the pattern to repeat after ending

Return values

SD_LED_SUCCESS

on success, error status otherwise

{
    /* Check for NULL pointers for the config and timer handle */
    if ((led == NULL) || (led->tim == NULL)) 
        return SD_LED_NULL_HANDLE_ERROR;
  
    /* Disable the timer interrupt */
    //HAL_TIM_Base_Stop_IT( LED->Update_HTIMx );
  
    led->pattern = pattern;
    led->pattern_len = len;
    led->pattern_idx = 0;
    led->repeat = repeat;
  
    /* Reenable the timer */
    //HAL_TIM_Base_Start_IT( LED->Update_HTIMx );
 
    return SD_LED_SUCCESS;
}