1/* $NetBSD: pckbcvar.h,v 1.21 2015/04/13 16:33:24 riastradh 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
37typedef void *pckbc_tag_t;
38typedef int pckbc_slot_t;
39#define PCKBC_KBD_SLOT 0
40#define PCKBC_AUX_SLOT 1
41#define PCKBC_NSLOTS 2
42
43/* Simple cmd/slot ringbuffer structure */
44struct pckbc_rbuf_item {
45 int data;
46 int slot;
47};
48
49#define PCKBC_RBUF_SIZE 32 /* number of rbuf entries */
50
51/*
52 * external representation (pckbc_tag_t),
53 * needed early for console operation
54 */
55struct pckbc_internal {
56 pckbport_tag_t t_pt;
57 bus_space_tag_t t_iot;
58 bus_space_handle_t t_ioh_d, t_ioh_c; /* data port, cmd port */
59 bus_addr_t t_addr;
60 u_char t_cmdbyte; /* shadow */
61 int t_flags;
62#define PCKBC_CANT_TRANSLATE 0x0001 /* can't translate to XT scancodes */
63#define PCKBC_NEED_AUXWRITE 0x0002 /* need auxwrite command to find aux */
64
65 int t_haveaux; /* controller has an aux port */
66 struct pckbc_slotdata *t_slotdata[PCKBC_NSLOTS];
67
68 struct pckbc_softc *t_sc; /* back pointer */
69
70 struct callout t_cleanup;
71
72 struct pckbc_rbuf_item rbuf[PCKBC_RBUF_SIZE];
73 int rbuf_read;
74 int rbuf_write;
75};
76
77typedef void (*pckbc_inputfcn)(void *, int);
78
79/*
80 * State per device.
81 */
82struct pckbc_softc {
83 device_t sc_dv;
84 struct pckbc_internal *id;
85
86 void (*intr_establish)(struct pckbc_softc *, pckbc_slot_t);
87};
88
89struct pckbc_attach_args {
90 pckbc_tag_t pa_tag;
91 pckbc_slot_t pa_slot;
92};
93
94extern const char * const pckbc_slot_names[];
95extern struct pckbc_internal pckbc_consdata;
96extern int pckbc_console_attached;
97
98/* These functions are sometimes called by match routines */
99int pckbc_send_cmd(bus_space_tag_t, bus_space_handle_t, u_char);
100int pckbc_poll_data1(void *, pckbc_slot_t);
101
102/* More normal calls from attach routines */
103void pckbc_attach(struct pckbc_softc *);
104int pckbc_cnattach(bus_space_tag_t, bus_addr_t, bus_size_t, pckbc_slot_t, int);
105int pckbc_is_console(bus_space_tag_t, bus_addr_t);
106int pckbcintr(void *);
107int pckbcintr_hard(void *);
108void pckbcintr_soft(void *);
109
110/* md hook for use without mi wscons */
111int pckbc_machdep_cnattach(pckbc_tag_t, pckbc_slot_t);
112
113/* power management */
114bool pckbc_resume(device_t, const pmf_qual_t *);
115
116#endif /* _DEV_IC_PCKBCVAR_H_ */
117