alcddrv.h

Go to the documentation of this file.

#ifndef ALCDDRV_H_INCLUDED
#define ALCDDRV_H_INCLUDED

#include <stdint.h>
#include "alcddrv_config.h"
#include "alcddrv_cmd.h"
#include "eppl.h"

/* Default pins configuration (not present) */
#ifndef ALCD_RS
   #define ALCD_RS EPPL_NP
#endif
#ifndef ALCD_RW
   #define ALCD_RW EPPL_NP
#endif
#ifndef ALCD_E
   #define ALCD_E  EPPL_NP
#endif
#ifndef ALCD_D0
   #define ALCD_D0 EPPL_NP
#endif
#ifndef ALCD_D1
   #define ALCD_D1 EPPL_NP
#endif
#ifndef ALCD_D2
   #define ALCD_D2 EPPL_NP
#endif
#ifndef ALCD_D3
   #define ALCD_D3 EPPL_NP
#endif
#ifndef ALCD_D4
   #define ALCD_D4 EPPL_NP
#endif
#ifndef ALCD_D5
   #define ALCD_D5 EPPL_NP
#endif
#ifndef ALCD_D6
   #define ALCD_D6 EPPL_NP
#endif
#ifndef ALCD_D7
   #define ALCD_D7 EPPL_NP
#endif

/* Default display size */
#ifndef ALCD_SX
   #warning No SX diamension of ALCD defined - using default value.
   #define ALCD_SX 16
#endif
/* Default display size */
#ifndef ALCD_SY
   #warning No SY diamension of ALCD defined - using default value.
   #define ALCD_SY 2
#endif
   
#define ALCD_PINCONFIG \
   EPPL_SC(ALCD_D7, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_D6, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_D5, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_D4, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_D3, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_D2, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_D1, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_D0, ALCD_DOutMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_RW, ALCD_CtrlMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_RS, ALCD_CtrlMode | EPPL_outSet_0),\
   EPPL_SC(ALCD_E,  ALCD_CtrlMode | EPPL_outSet_0)

#define ALCD_PIN_DEFINED(p) ((p) != EPPL_NP)
   
#define ALCD_CANREAD ALCD_PIN_DEFINED(ALCD_RW)

void alcd_cmd(uint8_t cmd);

void alcd_data(uint8_t data);

char alcd_rdata(void);

void alcd_init(void);

void alcd_puts(const char *pstr);

void alcd_read(char *pstr, uint8_t size);

void alcd_puts_P(const __flash char *pstr);

void alcd_defineChar(char c, const char *ppat);

void alcd_defineChar_P(char c, const __flash char *ppat);

void alcd_readDefinedChar(char c, char *ppat);

static inline void alcd_cls(void)
{
   alcd_cmd(ALCD_CMD_Clear);
}

static inline void alcd_home(void)
{
   alcd_cmd(ALCD_CMD_Home);
}

static inline void alcd_turnOnOff(uint8_t display, uint8_t cursor, uint8_t blink)
{
   alcd_cmd(ALCD_CMD_On | 
      (display ? ALCD_CMD_On_Display : 0) | 
      (cursor ? ALCD_CMD_On_Cursor : 0) | 
      (blink ? ALCD_CMD_On_Blink : 0)
   );
}

static inline void alcd_shift(uint8_t right_left, uint8_t display_cursor)
{
   alcd_cmd(ALCD_CMD_Shift | 
      (right_left ? ALCD_CMD_Shift_Left : ALCD_CMD_Shift_Right) |
      (display_cursor ? ALCD_CMD_Shift_Display : ALCD_CMD_Shift_Cursor)
   );
}

static inline void alcd_entryMode(uint8_t inc_dec, uint8_t shift)
{
   alcd_cmd(ALCD_CMD_Mode | 
      (inc_dec ? ALCD_CMD_Mode_Increment : ALCD_CMD_Mode_Decrement) |
      (shift ? ALCD_CMD_Mode_DisplayShift : 0)
   );
}

static inline void alcd_goto(uint8_t y, uint8_t x)
{
   uint8_t pos = x;
   
   if(1 < ALCD_SY)
   {
      if(0 != (y & 1))
         pos += ALCD_SecondLineAddr;
      if(2 < ALCD_SY)
      {
         if(0 != (y & 2))
            pos += ALCD_SX;
      }
   }
   alcd_cmd(ALCD_CMD_SetDDRAM | pos);
}

static inline void alcd_putc(char c)
{
   alcd_data(c);
}

static inline char alcd_getc(void)
{
   return alcd_rdata();
}

#endif /* ALCDDRV_H_INCLUDED */