spi_rgb.h

Go to the documentation of this file.

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * spi_rgb.h
 * Copyright (C) 2015 Simon Newton
 */

#ifndef FIRMWARE_SRC_SPI_RGB_H_
#define FIRMWARE_SRC_SPI_RGB_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "system_config.h"
#include "peripheral/spi/plib_spi.h"

typedef enum {
  RED = 0,
  GREEN = 1,
  BLUE = 2
} RGB_Color;

typedef struct {
  SPI_MODULE_ID module_id;  
  uint32_t baud_rate;  

  bool use_enhanced_buffering;
} SPIRGBConfiguration;

void SPIRGB_Init(const SPIRGBConfiguration *config);

void SPIRGB_BeginUpdate();

void SPIRGB_SetPixel(uint16_t index, RGB_Color color, uint8_t value);

void SPIRGB_CompleteUpdate();

void SPIRGB_Tasks();

#ifdef __cplusplus
}
#endif

#endif  // FIRMWARE_SRC_SPI_RGB_H_