xref: /netbsd-src/sys/dev/ic/lcdkp_subr.h (revision 1ffa7b76c40339c17a0fb2a09fac93f287cfc046)
1 /* $NetBSD: lcdkp_subr.h,v 1.1 2003/01/20 01:26:12 soren 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_LCDKP_SUBR_H_
31 #define _DEV_IC_LCDKP_SUBR_H_
32 
33 #ifdef _KERNEL
34 #include <sys/lock.h>
35 
36 /* Key code translation */
37 struct lcdkp_xlate {
38 	u_int8_t x_keycode;
39 	u_int8_t x_outcode;
40 };
41 
42 /* Keypad control structure */
43 struct lcdkp_chip {
44 	bus_space_tag_t sc_iot;
45 	bus_space_handle_t sc_ioh;	/* keypad i/o register */
46 
47 #define LCDKP_HAS_BUF	0x1
48 	u_char sc_flags;
49 	u_int8_t sc_buf;		/* pending character */
50 
51 	u_int8_t sc_knum;		/* number of buttons */
52 	struct lcdkp_xlate *sc_kpad;	/* recognized keycodes */
53 
54 	u_int8_t (* sc_rread)(bus_space_tag_t, bus_space_handle_t);
55 
56 #if defined(MULTIPROCESSOR)
57 	struct simplelock sc_lock;
58 #endif
59 };
60 
61 #define lcdkp_dr_read(sc) \
62 	(sc)->sc_rread((sc)->sc_iot, (sc)->sc_ioh);
63 
64 #if defined(MULTIPROCESSOR)
65 #define lcdkp_lock(sc)		simple_lock(&(sc)->sc_lock)
66 #define lcdkp_unlock(sc)	simple_unlock(&(sc)->sc_lock)
67 #define lcdkp_lockaddr(sc)	(&(sc)->sc_lock)
68 #define lcdkp_lock_init(sc)	simple_lock_init(&(sc)->sc_lock)
69 #else
70 #define lcdkp_lock(sc)		((void)0)
71 #define lcdkp_unlock(sc)	((void)0)
72 #define lcdkp_lockaddr(sc)	(NULL)
73 #define lcdkp_lock_init(sc)	((void)0)
74 #endif
75 
76 void lcdkp_attach_subr(struct lcdkp_chip *);
77 int  lcdkp_scankey(struct lcdkp_chip *);
78 int  lcdkp_readkey(struct lcdkp_chip *, u_int8_t *);
79 
80 #endif /* _KERNEL */
81 
82 #endif /* _DEV_IC_LCDKP_SUBR_H_ */
83