/*
 * Copyright (C) 2016 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @defgroup    drivers_lpd8808 LPD8808 based LED Strip
 * @ingroup     drivers
 * @brief       Driver for LPD8808 based LED strips
 *
 * LPD8808 based LED strips consist of a number of LEDs driven by LPD8808 chips.
 * In these strips, each LED can be controlled individually. For this, every two
 * LEDs are driven by a LPD8808 chip, which are chained and form a long shift
 * register. To control a certain LED, the target color value needs to be
 * shifted to the LEDs position on the strip.
 *
 * This driver implementation does not buffer the current values for each LED.
 * It expects the application to take care of this.
 *
 * @{
 * @file
 * @brief       Interface definition for the LPD8808 LED strip driver
 *
 * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
 */

#ifndef LPD8808_H
#define LPD8808_H

#include "color.h"
#include "periph/gpio.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief   Parameters needed for configuration
 */
typedef struct {
    int led_cnt;        /**< number of LEDs on the strip */
    gpio_t pin_clk;     /**< pin connected to the strip's clock signal */
    gpio_t pin_dat;     /**< pin connected to the strip's data signal */
} lpd8808_params_t;

/**
 * @brief   Device descriptor, same as the configuration parameters
 */
typedef lpd8808_params_t lpd8808_t;

/**
 * @brief   Initialize the given LPD8808 based LED strip
 *
 * @param[out] dev      device to initialize
 * @param[in]  params   parameters used for initialization
 *
 * @return  0 on success
 * @return  <0 on error
 */
int lpd8808_init(lpd8808_t *dev, const lpd8808_params_t *params);

/**
 * @brief   Set the color value of each LED on the strip
 *
 * This function sets the color value of each LED on the strip by shifting out
 * the corresponding color values one after the other. The function expects an
 * array of @p color_rgb_t values of the same length as LEDs on the strip.
 *
 * @param[in] dev       device to load color values to
 * @param[in] vals      array of color values, MUST be of same length as LEDs on
 *                      the strip
 */
void lpd8808_load_rgb(lpd8808_t *dev, color_rgb_t vals[]);

#ifdef __cplusplus
}
#endif

#endif /* LPD8808_H */
/** @} */