Home | History | Annotate | Line # | Download | only in ic
hd44780var.h revision 1.1 
      1 /* $NetBSD: hd44780var.h,v 1.1 2005/01/11 00:57:56 joff Exp $ */
      2 
      3 /*
      4  * Copyright (c) 2002 Dennis I. Chernoivanov
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. The name of the author may not be used to endorse or promote products
     16  *    derived from this software without specific prior written permission
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28  */
     29 
     30 #ifndef _DEV_IC_HD44780VAR_H_
     31 #define _DEV_IC_HD44780VAR_H_
     32 
     33 /* IOCTL definitions */
     34 #define HLCD_DISPCTL		_IOW('h',   1, struct hd44780_dispctl)
     35 #define	HLCD_RESET		_IO('h',    2)
     36 #define	HLCD_CLEAR		_IO('h',    3)
     37 #define	HLCD_CURSOR_LEFT	_IO('h',    4)
     38 #define	HLCD_CURSOR_RIGHT	_IO('h',    5)
     39 #define	HLCD_GET_CURSOR_POS	_IOR('h',   6, struct hd44780_io)
     40 #define	HLCD_SET_CURSOR_POS	_IOW('h',   7, struct hd44780_io)
     41 #define	HLCD_GETC		_IOR('h',   8, struct hd44780_io)
     42 #define	HLCD_PUTC		_IOW('h',   9, struct hd44780_io)
     43 #define	HLCD_SHIFT_LEFT		_IO('h',   10)
     44 #define	HLCD_SHIFT_RIGHT	_IO('h',   11)
     45 #define	HLCD_HOME		_IO('h',   12)
     46 #define	HLCD_WRITE		_IOWR('h', 13, struct hd44780_io)
     47 #define	HLCD_READ		_IOWR('h', 14, struct hd44780_io)
     48 #define	HLCD_REDRAW		_IOW('h',  15, struct hd44780_io)
     49 #define	HLCD_WRITE_INST		_IOW('h',  16, struct hd44780_io)
     50 #define	HLCD_WRITE_DATA		_IOW('h',  17, struct hd44780_io)
     51 #define HLCD_GET_INFO		_IOR('h',  18, struct hd44780_info)
     52 
     53 struct hd44780_dispctl {
     54 	u_char	display_on:1,
     55 		blink_on:1,
     56 		cursor_on:1;
     57 };
     58 
     59 struct hd44780_io {
     60 	u_int8_t dat;
     61 	u_int8_t len;
     62 	u_int8_t buf[HD_MAX_CHARS];
     63 };
     64 
     65 struct hd44780_info {
     66 	u_char	lines;
     67 	u_char	phys_rows;
     68 	u_char	virt_rows;
     69 
     70 	u_char	is_wide:1,
     71 		is_bigfont:1,
     72 		kp_present:1;
     73 };
     74 
     75 #ifdef _KERNEL
     76 
     77 /* HLCD driver structure */
     78 struct hd44780_chip {
     79 #define HD_8BIT			0x01	/* 8-bit if set, 4-bit otherwise */
     80 #define HD_MULTILINE		0x02	/* 2 lines if set, 1 otherwise */
     81 #define HD_BIGFONT		0x04	/* 5x10 if set, 5x8 otherwise */
     82 #define HD_KEYPAD		0x08	/* if set, keypad is connected */
     83 #define HD_UP			0x10	/* if set, lcd has been initialized */
     84 #define HD_TIMEDOUT		0x20	/* lcd has recently stopped talking */
     85 	u_char sc_flags;
     86 
     87 	u_char sc_rows;			/* visible rows */
     88 	u_char sc_vrows;		/* virtual rows (normally 40) */
     89 	u_char sc_dev_ok;
     90 
     91 	bus_space_tag_t sc_iot;
     92 
     93 	bus_space_handle_t sc_ioir;	/* instruction register */
     94 	bus_space_handle_t sc_iodr;	/* data register */
     95 
     96 	struct device *sc_dev;		/* Pointer to parent device */
     97 
     98 	/* Generic write/read byte entries. */
     99 	void     (* sc_writereg)(struct hd44780_chip *, u_int32_t, u_int8_t);
    100 	u_int8_t (* sc_readreg)(struct hd44780_chip *, u_int32_t);
    101 };
    102 
    103 #define hd44780_ir_write(sc, dat) \
    104 	do {								\
    105 		hd44780_busy_wait(sc);					\
    106 		(sc)->sc_writereg((sc), 0, (dat));			\
    107 	} while(0)
    108 
    109 #define hd44780_ir_read(sc) \
    110 	(sc)->sc_readreg((sc), 0)
    111 
    112 #define hd44780_dr_write(sc, dat) \
    113 	(sc)->sc_writereg((sc), 1, (dat))
    114 
    115 #define hd44780_dr_read(sc) \
    116 	(sc)->sc_readreg((sc), 1)
    117 
    118 void hd44780_attach_subr(struct hd44780_chip *);
    119 void hd44780_busy_wait(struct hd44780_chip *);
    120 int  hd44780_init(struct hd44780_chip *);
    121 int  hd44780_ioctl_subr(struct hd44780_chip *, u_long, caddr_t);
    122 void hd44780_ddram_redraw(struct hd44780_chip *, struct hd44780_io *);
    123 
    124 #define HD_DDRAM_READ	0x0
    125 #define HD_DDRAM_WRITE	0x1
    126 int  hd44780_ddram_io(struct hd44780_chip *, struct hd44780_io *, u_char);
    127 
    128 #if defined(HD44780_STD_WIDE) || defined(HD44780_STD_SHORT)
    129 void     hd44780_writereg(struct hd44780_chip *, u_int32_t, u_int8_t);
    130 u_int8_t hd44780_readreg(struct hd44780_chip *, u_int32_t);
    131 #endif
    132 
    133 #endif /* _KERNEL */
    134 
    135 #endif /* _DEV_IC_HD44780VAR_H_ */
    136