lcd.h

#ifndef _AVRIO_LCD_H_
#define _AVRIO_LCD_H_ 1

#include <avrio/defs.h>

__BEGIN_C_DECLS
  /* ======================================================================== */
#include <stdio.h>
#include "lcd/lcd_defs.h"
#include "lcd/io/lcd_io.h"
#include "lcd/ctrl/lcd_ctrl.h"

/* internal public functions ================================================ */
int8_t iLcdInit (void);

void vLcdPutChar (char cChar);

void vLcdPutString (const char *pcString);

void vLcdClearChars (xLcdCoord xX, xLcdCoord xY, uint8_t uLen);

void vLcdGotoXY (xLcdCoord xX, xLcdCoord xY);

void vLcdBargraphInit (const uint8_t * pucBarPatterns);

void vLcdBargraph (uint16_t uValue, uint16_t uMax, xLcdCoord uWidth);

/* public variables ========================================================= */
extern FILE xLcd;

#if defined(__DOXYGEN__)
/*
 * __DOXYGEN__ defined
 * Partie documentation ne devant pas être compilée.
 * =============================================================================
 */

uint8_t ucLcdContrastSet (uint8_t ucContrast);

uint8_t ucLcdBacklightSet (uint8_t ucLevel);

void vLcdClear (void);

void vLcdEnableCursor (eLcdCursor eCursor);

xLcdCoord xLcdGetX (void);

xLcdCoord xLcdWidth (void);

xLcdCoord xLcdGetY (void);

xLcdCoord xLcdHeight (void);

void vLcdClearCurrentLine (void);

void vLcdClearLine (xLcdCoord xY);

void vLcdSetIcon (uint8_t ucCode, const uint8_t * pucIconPattern);

#else
/*
 * __DOXYGEN__ not defined
 * Partie ne devant pas être documentée.
 * =============================================================================
 */
#include "avrio-config.h"

#ifdef AVRIO_LCD_ENABLE
/* ========================================================================== */
#include "avrio-board-lcd.h"

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (uint8_t
  ucLcdContrastSet (uint8_t ucContrast)) {

    return ucLcdCtrlContrastSet (ucContrast);
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (void
  vLcdClear (void)) {

    vLcdCtrlClear();
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (void
  vLcdEnableCursor (eLcdCursor eCursor)) {

    vLcdCtrlEnableCursor (eCursor);
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (xLcdCoord
  xLcdGetX (void)) {

    return xLcdCtrlGetX();
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (xLcdCoord
  xLcdGetY (void)) {

    return xLcdCtrlGetY();
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (xLcdCoord
  xLcdWidth (void)) {

    return (xLcdCoord)LCD_WIDTH;
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (xLcdCoord
  xLcdHeight (void)) {

    return (xLcdCoord)LCD_HEIGHT;
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (void
  vLcdClearCurrentLine (void)) {

    vLcdClearChars (0, xLcdCtrlGetY(), LCD_WIDTH);
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (void
  vLcdClearLine (xLcdCoord xY)) {

    vLcdClearChars (0, xY, LCD_WIDTH);
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (void
  vLcdSetIcon (uint8_t ucIndex, const uint8_t * pucIconPattern)) {

    vLcdCtrlSetIcon (ucIndex, pucIconPattern);
  }

  // ---------------------------------------------------------------------------
  __STATIC_ALWAYS_INLINE (uint8_t
  ucLcdBacklightSet (uint8_t ucLevel)) {

#ifdef LCD_CTRL_BACKLIGHT_ENABLE
    return ucLcdCtrlBacklightSet (ucLevel);
#else
    return 0;
#endif
  }

/* ========================================================================== */
#endif /* AVRIO_LCD_ENABLE defined */
#endif /* __DOXYGEN__ not defined */
/* ========================================================================== */
__END_C_DECLS
#endif /* _AVRIO_LCD_H_ */