xref: /netbsd-src/sys/dev/ic/pckbcvar.h (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /* $NetBSD: pckbcvar.h,v 1.20 2012/10/13 18:14:09 jdc Exp $ */
2 
3 /*
4  * Copyright (c) 1998
5  *	Matthias Drochner.  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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  */
28 
29 #ifndef _DEV_IC_PCKBCVAR_H_
30 #define _DEV_IC_PCKBCVAR_H_
31 
32 #include <sys/callout.h>
33 #include <sys/pmf.h>
34 
35 #include <dev/pckbport/pckbportvar.h>
36 
37 
38 
39 #include <sys/rnd.h>
40 
41 typedef void *pckbc_tag_t;
42 typedef int pckbc_slot_t;
43 #define	PCKBC_KBD_SLOT	0
44 #define	PCKBC_AUX_SLOT	1
45 #define	PCKBC_NSLOTS	2
46 
47 /* Simple cmd/slot ringbuffer structure */
48 struct pckbc_rbuf_item {
49 	int data;
50 	int slot;
51 };
52 
53 #define	PCKBC_RBUF_SIZE	32	/* number of rbuf entries */
54 
55 /*
56  * external representation (pckbc_tag_t),
57  * needed early for console operation
58  */
59 struct pckbc_internal {
60 	pckbport_tag_t t_pt;
61 	bus_space_tag_t t_iot;
62 	bus_space_handle_t t_ioh_d, t_ioh_c; /* data port, cmd port */
63 	bus_addr_t t_addr;
64 	u_char t_cmdbyte; /* shadow */
65 	int t_flags;
66 #define	PCKBC_CANT_TRANSLATE	0x0001	/* can't translate to XT scancodes */
67 #define	PCKBC_NEED_AUXWRITE	0x0002	/* need auxwrite command to find aux */
68 
69 	int t_haveaux; /* controller has an aux port */
70 	struct pckbc_slotdata *t_slotdata[PCKBC_NSLOTS];
71 
72 	struct pckbc_softc *t_sc; /* back pointer */
73 
74 	struct callout t_cleanup;
75 
76 	struct pckbc_rbuf_item rbuf[PCKBC_RBUF_SIZE];
77 	int rbuf_read;
78 	int rbuf_write;
79 };
80 
81 typedef void (*pckbc_inputfcn)(void *, int);
82 
83 /*
84  * State per device.
85  */
86 struct pckbc_softc {
87 	device_t sc_dv;
88 	struct pckbc_internal *id;
89 
90 	void (*intr_establish)(struct pckbc_softc *, pckbc_slot_t);
91 };
92 
93 struct pckbc_attach_args {
94 	pckbc_tag_t pa_tag;
95 	pckbc_slot_t pa_slot;
96 };
97 
98 extern const char * const pckbc_slot_names[];
99 extern struct pckbc_internal pckbc_consdata;
100 extern int pckbc_console_attached;
101 
102 /* These functions are sometimes called by match routines */
103 int pckbc_send_cmd(bus_space_tag_t, bus_space_handle_t, u_char);
104 int pckbc_poll_data1(void *, pckbc_slot_t);
105 
106 /* More normal calls from attach routines */
107 void pckbc_attach(struct pckbc_softc *);
108 int pckbc_cnattach(bus_space_tag_t, bus_addr_t, bus_size_t, pckbc_slot_t, int);
109 int pckbc_is_console(bus_space_tag_t, bus_addr_t);
110 int pckbcintr(void *);
111 int pckbcintr_hard(void *);
112 void pckbcintr_soft(void *);
113 
114 /* md hook for use without mi wscons */
115 int pckbc_machdep_cnattach(pckbc_tag_t, pckbc_slot_t);
116 
117 /* power management */
118 bool pckbc_resume(device_t, const pmf_qual_t *);
119 
120 #endif /* _DEV_IC_PCKBCVAR_H_ */
121