lcd.h

/* 
 * File: lcd.h
 *
 * Copyright (c) 2015 Manolis Agkopian
 * See the file LICENSE for copying permission.
 *
 * LCD library header file.
 */

#ifndef LCD_H
#define	LCD_H

#ifdef	__cplusplus
extern "C" {
#endif

typedef struct {
    volatile unsigned char*  PORT;  // Pointer to the LCD port e.g &PORTC
    unsigned RS :3;                 // The RS bit of the LCD PORT e.g. 2
    unsigned EN :3;                 // The EN bit of the LCD PORT e.g. 3
    unsigned D4 :3;                 // The D4 bit of the LCD PORT e.g. 4
    unsigned D5 :3;                 // The D5 bit of the LCD PORT e.g. 5
    unsigned D6 :3;                 // The D6 bit of the LCD PORT e.g. 6
    unsigned D7 :3;                 // The D7 bit of the LCD PORT e.g. 7
} LCD;

extern LCD lcd;

// Macros that correspond to LCD commands
#define LCD_Clear() LCD_Cmd(0x01)
#define LCD_Decrement_Cursor() LCD_Cmd(0x04)
#define LCD_Increment_Cursor() LCD_Cmd(0x05)
#define LCD_Shift_Display_Right() LCD_Cmd(0x06)
#define LCD_Shift_Display_Left() LCD_Cmd(0x07)
#define LCD_Shift_Right() LCD_Cmd(0x1C)
#define LCD_Shift_Left() LCD_Cmd(0x18)

// Sets the LCD cursor position
#define LCD_Set_Cursor( x, y )           \
do {                                     \
    if ( x == 0 ) {                      \
        LCD_Cmd(0x80 + y);               \
    }                                    \
    else if ( x == 1 ) {                 \
        LCD_Cmd(0xC0 + y);               \
    }                                    \
    else if ( x == 2 ) {                 \
        LCD_Cmd(0x94 + y);               \
    }                                    \
    else if ( x == 3 ) {                 \
        LCD_Cmd(0xD4 + y);               \
    }                                    \
} while ( false )

// [Internal use only] Sets the display on/off, the cursor on/off and if it will blink or not
#define LCD_Display( on, cursor, blink ) \
do {                                     \
    unsigned char cmd = 0x08;            \
                                         \
    if ( on == true ) {                  \
        cmd |= 1 << 2;                   \
    }                                    \
                                         \
    if ( cursor == true ) {              \
        cmd |= 1 << 1;                   \
    }                                    \
                                         \
    if ( blink == true ) {               \
        cmd |= 1;                        \
    }                                    \
                                         \
    LCD_Cmd(cmd);                        \
} while ( false )

// [Internal use only] Sends a command to the LCD
#define LCD_Cmd( c )                     \
do {                                     \
    LCD_Write( (c & 0xF0) >> 4 );        \
    LCD_Write( c & 0x0F);                \
} while ( false )

// Initializes the LCD (See LCD struct)
bool LCD_Init ( LCD display );

// Prints a character on the LCD
void LCD_putc ( char a );

// Prints a string on the LCD that is allocated on the RAM
void LCD_puts ( char *a );

// Prints a string on the LCD that is allocated on the program memory
void LCD_putrs ( const char *a );

// [Internal use only] Write a byte to the LCD
void LCD_Write ( unsigned char c );

// [Internal use only] Outputs the data to the LCD Port
void LCD_Out ( char a );

#ifdef	__cplusplus
}
#endif

#endif	/* LCD_H */