/* File: LCD.H */

/****************************************************************************
*
* STK16XSW.LCD
* ============
*
* Routines for controlling LCD with 2x16 characters on I2C bus
*                 
* TQ-Systems GmbH                                                         
* ---------------                                                         
* Customer: TQ-Components
* Project : STK16XSW
* Tools   : uVision 2.05
*
* Rev: Date:     Name:            Modification:
* ----+---------+----------------+------------------------------------------
* 100  16.01.01  A. Lichte        taken over from STK16X.506                
*      04.05.01  A. Lichte        Display read back status 
*****************************************************************************/

#include "header.h"

/*==========================================================================*
* extern available definitions (#DEFINE):
*===========================================================================*/

/*--------------------------------------------------------------------------*
* general definitions:
*---------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*
* display definitions:
*---------------------------------------------------------------------------*/
/* 2x16 LCD (2 rows, 16 columns) */
#define LCD_COLUMNS 16
#define LCD_ROWS     2

/* control commands: */
#ifndef LF
#define LF          10
#endif
#ifndef CR
#define CR          13
#endif

#define LCD_I2C_ADR 0x20             /* I2C address for LCD                */

/*==========================================================================*
* extern available type definitions (TYPEDEF):
*===========================================================================*/

/*==========================================================================*
* extern available constants (CONST):
*===========================================================================*/

/*==========================================================================*
* globale extern available variables (EXTERN):
*===========================================================================*/

/*==========================================================================*
* extern available functions:
*===========================================================================*/

/*--------------------------------------------------------------------------*
* BYTE lcd_init(void)
*---------------------------------------------------------------------------*
* FT: initialization LCD
* EP: -
* RW: 0: Initialisation successfully; >0 : Timeout on Initialisation Step (RW)
* GP: lcd_pos = cursor position
*---------------------------------------------------------------------------*/
BYTE lcd_init(void);

/*--------------------------------------------------------------------------*
* BYTE lcd_clr(void)
*---------------------------------------------------------------------------*
* FT: clear LCD
* EP: -
* RW: Success; 1: Timeout 
* GP: lcd_pos = cursor position
*---------------------------------------------------------------------------*/
BYTE lcd_clr(void);

/*--------------------------------------------------------------------------*
* BYTE lcd_setpos(BYTE new_pos)
*---------------------------------------------------------------------------*
* FT: set cursor to any position on the display
* EP: new_pos: position on display
*              +----------------------------------------------------+
*              | 0: upper left corner         15: upper right corner|
*              |64: lower left corner         79: lower right corner|
*              +----------------------------------------------------+
* RW: Success; 1: Timeout
* GP: lcd_pos = cursor position
*---------------------------------------------------------------------------*/
BYTE lcd_setpos(BYTE new_pos);

/*--------------------------------------------------------------------------*
* BYTE lcd_home(void)
*---------------------------------------------------------------------------*
* FT: set cursor on upper left corner on display
* EP: -
* RW: Success; 1: Timeout
* GP: lcd_pos = cursor position
*---------------------------------------------------------------------------*/
BYTE lcd_home(void);

/*--------------------------------------------------------------------------*
* BYTE lcd_newline(void)
*---------------------------------------------------------------------------*
* FT: change to next line on display
*     previous line = 1: change to line 2
*     previous line = 2: change to line 1
* EP: -
* RW: Success; 1: Timeout
* GP: lcd_pos = cursor position
*---------------------------------------------------------------------------*/
BYTE lcd_newline(void);

/*--------------------------------------------------------------------------*
* BYTE lcd_left(void)
*---------------------------------------------------------------------------*
* FT: move cursor one step left
* EP: -
* RW: Success; 1: Timeout
* GP: lcd_pos = cursor position
*---------------------------------------------------------------------------*/
BYTE lcd_left(void);

/*--------------------------------------------------------------------------*
* BYTE lcd_right(void)
*---------------------------------------------------------------------------*
* FT: move cursor one step right
* EP: -
* RW: Success; 1: Timeout
* GP: lcd_pos = cursor position
*---------------------------------------------------------------------------*/
BYTE lcd_right(void);

/*--------------------------------------------------------------------------*
* BYTE lcd_charout(BYTE c)
*---------------------------------------------------------------------------*
* FT: write character c to display at actual cursor position
*     and move cursor one step right
* EP: c = character to be written
* RW: Success; 1: Timeout
* GP: -
*---------------------------------------------------------------------------*/
BYTE lcd_charout(BYTE c);

/*--------------------------------------------------------------------------*
* BYTE lcd_strout(char *s)
*---------------------------------------------------------------------------*
* FT: write textstring s to display beginning at actual cursor position
* EP: s = pointer to string to be displayed
* RW: Success; 1: Timeout
* GP: -
*---------------------------------------------------------------------------*/
BYTE lcd_strout(char *s);

/*--------------------------------------------------------------------------*
* BYTE lcd_char_at(BYTE x, BYTE y, BYTE c)
*---------------------------------------------------------------------------*
* FT: write character c to display at position (x,y)
* EP: c = character to be written
*     x = display column (0 .. 15)       0                        15
*     y = display line   (0 .. 1)       +---------------------------+
*                                     0 |                           |
*                                     1 |                           |
*                                       +---------------------------*
* RW: Success; 1: Timeout
* GP: -
*---------------------------------------------------------------------------*/
BYTE lcd_char_at(BYTE x, BYTE y, BYTE c);

/*--------------------------------------------------------------------------*
* BYTE lcd_center(BYTE y, char *s)
*---------------------------------------------------------------------------*
* FT: write textstring s centered in line y
* EP: s = pointer to string to be displayed
*     y = display line (0 .. 1)
* RW: Success; 1: Timeout
* GP: -
*---------------------------------------------------------------------------*/
BYTE lcd_center(BYTE y, char *s);