/include/alld_tlc5947.h - Annotate - AMiRo-OS - Research for Cognitive Interaction

amiro-lld / include / alld_tlc5947.h @ ef078306

History | View | Annotate | Download (4.845 KB)

-            d6728c5b
+/*
 AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
-            f125ae07
+Copyright (C) 2016..2019  Thomas Schöpping et al.
-            d6728c5b
+            Thomas Schöpping
 This program is free software: you can redistribute it and/or modify
-            f0ca400f
+it under the terms of the GNU Lesser General Public License as published by
-            d6728c5b
+the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 This program 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
-            f0ca400f
+GNU Lesser General Public License for more details.
-            d6728c5b
+            Thomas Schöpping
-            f0ca400f
+You should have received a copy of the GNU Lesser General Public License
-            d6728c5b
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
-e2f673b
+/**
  * @file    alld_tlc5947.h
  * @brief   LED Driver macros and structures.
+ *
  * @addtogroup lld_leddriver
  * @{
  */
-c47f14b
+#ifndef AMIROLLD_TLC5947_H
 #define AMIROLLD_TLC5947_H
-            d6728c5b
+            Thomas Schöpping
 #include <amiro-lld.h>
 #if defined(AMIROLLD_CFG_USE_TLC5947) || defined(__DOXYGEN__)
-            ef078306
+/******************************************************************************/
 /* CONSTANTS                                                                  */
 /******************************************************************************/
-            d6728c5b
+/**
  * @brief   Active state of the BLANK signal.
  */
 #define TLC5947_LLD_BLANK_ACTIVE_STATE          APAL_GPIO_ACTIVE_HIGH
 /**
  * @brief   Active state of the XLAT signal.
  */
 #define TLC5947_LLD_XLAT_ACTIVE_STATE           APAL_GPIO_ACTIVE_HIGH
 /**
  * @brief   Number of PWM channels.
  */
 #define TLC5947_LLD_NUM_CHANNELS                24
 /**
  * @brief   Resulotion of the PWM channels in bits.
  */
 #define TLC5947_LLD_PWM_RESOLUTION_BITS         12
 /**
  * @brief   Size of the TLC grayscale buffer in bytes.
  */
 #define TLC5947_LLD_BUFFER_SIZE                 (TLC5947_LLD_NUM_CHANNELS * TLC5947_LLD_PWM_RESOLUTION_BITS / 8)
-            ef078306
+/******************************************************************************/
 /* SETTINGS                                                                   */
 /******************************************************************************/
 /******************************************************************************/
 /* CHECKS                                                                     */
 /******************************************************************************/
 /******************************************************************************/
 /* DATA STRUCTURES AND TYPES                                                  */
 /******************************************************************************/
-            d6728c5b
+/**
  * @brief The TLC5947Driver struct
  */
 typedef struct {
-            cf1f756b
+  apalSPIDriver_t* spi_driver;    /**< @brief The SPI Driver.                           */
-ad8
+  const apalControlGpio_t* blank_gpio;  /**< @brief The identifier of the BLANK signal GPIO.  */
   const apalControlGpio_t* xlat_gpio;   /**< @brief The identifier of the XLAT signal GPIO.   */
-            d6728c5b
+} TLC5947Driver;
 /**
  * @brief The blank state of the TLC5947 driver.
  */
 typedef enum {
   TLC5947_LLD_BLANK_ENABLE = 0,   /**< 'blank on' state of the TLC5947 driver.  */
   TLC5947_LLD_BLANK_DISABLE = 1,  /**< 'blank off' state of the TLC5947 driver. */
 } tlc5947_lld_blank_t;
 /**
  * @brief TLC5947 buffer struct.
  */
 typedef struct {
   uint8_t data[TLC5947_LLD_BUFFER_SIZE]; /**< The raw buffer data. */
 } tlc5947_lld_buffer_t;
-            ef078306
+/******************************************************************************/
 /* MACROS                                                                     */
 /******************************************************************************/
 /******************************************************************************/
 /* EXTERN DECLARATIONS                                                        */
 /******************************************************************************/
-            d6728c5b
+#ifdef __cplusplus
 extern "C" {
 #endif
   apalExitStatus_t tlc5947_lld_setBlank(const TLC5947Driver* const tlc5947, const tlc5947_lld_blank_t blank);
   apalExitStatus_t tlc5947_lld_getBlank(const TLC5947Driver* const tlc5947, tlc5947_lld_blank_t* const blank);
   apalExitStatus_t tlc5947_lld_update(const TLC5947Driver* const tlc5947);
   apalExitStatus_t tlc5947_lld_write(const TLC5947Driver* const tlc5947, const tlc5947_lld_buffer_t* const buffer);
   void tlc5947_lld_setBuffer(tlc5947_lld_buffer_t* const buffer, const uint8_t channel, const uint16_t value);
   uint16_t tlc5947_lld_getBuffer(const tlc5947_lld_buffer_t* const buffer, const uint8_t channel);
 #ifdef __cplusplus
+}
 #endif
-            ef078306
+/******************************************************************************/
 /* INLINE FUNCTIONS                                                           */
 /******************************************************************************/
-            d6728c5b
+#endif /* defined(AMIROLLD_CFG_USE_TLC5947) */
-c47f14b
+#endif /* AMIROLLD_TLC5947_H */
-e2f673b
+            Marc Rothmann
 /** @} */