/*
	Based on the lis driver Copyright (C) 2006, Bernhard Walle
	Copyright (c) 2007, Daryl Fonseca-Holt <wyatt@prairieturtle.ca>

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	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
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 */
#ifndef LIS_H
#define LIS_H

#include "lcd.h"

#ifndef bool
# define bool short
# define true 1
# define false 0
#endif

///////////////////////////////////////////////////////////////////////////////
// constants
//
#define DISPLAY_VENDOR_ID	0x0403
#define DISPLAY_PRODUCT_ID	0x6001

#define CELLWIDTH  5
#define CELLHEIGHT 8

#define DEFAULT_BRIGHTNESS 1000

#define NUM_CCs 8


///////////////////////////////////////////////////////////////////////////////
// private data types
//
typedef enum {
  standard,	/* only char 0 is used for heartbeat */
  vbar,		/* vertical bars */
  hbar,		/* horizontal bars */
  bignum,	/* big numbers */
  bigchar,	/* big characters */
  custom	/* custom icons */
} CGmode;

typedef struct cgram_cache {
  unsigned char cache[CELLHEIGHT];
  int clean;
} CGram;

typedef struct {

	// the handle for the USB FTDI library
	struct ftdi_context ftdic;

	// the width and the height (in number of characters) of the display
	int width, height;
	
	// pixel width and height of each character
	int cellwidth, cellheight;

	// The framebuffer and the framebuffer for the last contents (incr. update)
	unsigned char *framebuf;

	// dirty line flags
	unsigned int *line_flags;

	// child thread flag
	int child_flag;

	// parent thread flag
	int parent_flag;

	// display brightness 0-1000
	int brightness;

	// ustom characters
	CGram cc[NUM_CCs];
	CGmode ccmode;

	// USB Vendor ID
	int VendorID;

	// USB Product ID
	int ProductID;

	/* lastline controls the use of the last line, if pixel addressable (true, default) or */
	/* underline effect (false). To avoid the underline effect in the latter case, the last */
	/* line is always zeroed for whatever redefined character */
	char lastline; 

} PrivateData;

MODULE_EXPORT int  lis_init(Driver *drvthis);
MODULE_EXPORT void lis_close (Driver *drvthis);
MODULE_EXPORT int  lis_width (Driver *drvthis);
MODULE_EXPORT int  lis_height (Driver *drvthis);
MODULE_EXPORT void lis_clear (Driver * drvthis);
MODULE_EXPORT void lis_string (Driver * drvthis, int x, int y, char string[]);
MODULE_EXPORT void lis_chr (Driver * drvthis, int x, int y, unsigned char c);
MODULE_EXPORT void lis_flush (Driver * drvthis);
MODULE_EXPORT void lis_vbar (Driver * drvthis, int x, int y, int len, int promille, int options);
MODULE_EXPORT void lis_hbar (Driver * drvthis, int x, int y, int len, int promille, int options);
MODULE_EXPORT int  lis_icon(Driver * drvthis, int x, int y, int icon);
MODULE_EXPORT int  lis_cellheight (Driver *drvthis);
MODULE_EXPORT int  lis_cellwidth (Driver *drvthis);
MODULE_EXPORT void lis_num(Driver *drvthis, int x, int num);
MODULE_EXPORT int  lis_get_free_chars(Driver *drvthis);
MODULE_EXPORT void lis_set_char(Driver *drvthis, int n, unsigned char *dat);

#endif /* LIS_H */