plcomvar.h revision 1.14 1 /* $NetBSD: plcomvar.h,v 1.14 2013/05/01 07:33:24 mlelstv Exp $ */
2
3 /*
4 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Christopher G. Demetriou
17 * for the NetBSD Project.
18 * 4. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #include "rnd.h"
34 #include "opt_multiprocessor.h"
35 #include "opt_lockdebug.h"
36 #include "opt_plcom.h"
37 #include "opt_kgdb.h"
38
39 #ifdef RND_COM
40 #include <sys/rnd.h>
41 #endif
42
43 #include <sys/callout.h>
44 #include <sys/timepps.h>
45 #include <sys/simplelock.h>
46
47 struct plcom_instance;
48
49 int plcomcnattach (struct plcom_instance *, int, int, tcflag_t, int);
50 void plcomcndetach (void);
51
52 #ifdef KGDB
53 int plcom_kgdb_attach (struct plcom_instance *, int, int, tcflag_t, int);
54 #endif
55
56 int plcom_is_console (bus_space_tag_t, bus_addr_t, bus_space_handle_t *);
57
58 /* Hardware flag masks */
59 #define PLCOM_HW_NOIEN 0x01
60 #define PLCOM_HW_FIFO 0x02
61 #define PLCOM_HW_HAYESP 0x04
62 #define PLCOM_HW_FLOW 0x08
63 #define PLCOM_HW_DEV_OK 0x20
64 #define PLCOM_HW_CONSOLE 0x40
65 #define PLCOM_HW_KGDB 0x80
66 #define PLCOM_HW_TXFIFO_DISABLE 0x100
67
68 /* Buffer size for character buffer */
69 #define PLCOM_RING_SIZE 2048
70
71 struct plcom_instance {
72 u_int pi_type;
73 #define PLCOM_TYPE_PL010 0
74 #define PLCOM_TYPE_PL011 1
75
76 uint32_t pi_flags; /* flags for this PLCOM */
77 #define PLC_FLAG_USE_DMA 0x0001
78 #define PLC_FLAG_32BIT_ACCESS 0x0002
79
80 void *pi_cookie;
81
82 bus_space_tag_t pi_iot;
83 bus_space_handle_t pi_ioh;
84 bus_addr_t pi_iobase;
85 bus_addr_t pi_size;
86 struct plcom_registers *pi_regs;
87 };
88
89 struct plcomcons_info {
90 int rate;
91 int frequency;
92 int type;
93
94 tcflag_t cflag;
95 };
96
97 struct plcom_softc {
98 device_t sc_dev;
99
100 struct tty *sc_tty;
101 void *sc_si;
102
103 struct callout sc_diag_callout;
104
105 int sc_frequency;
106
107 struct plcom_instance sc_pi;
108
109 u_int sc_overflows,
110 sc_floods,
111 sc_errors;
112
113 int sc_hwflags,
114 sc_swflags;
115 u_int sc_fifolen;
116
117 u_int sc_r_hiwat,
118 sc_r_lowat;
119 u_char *volatile sc_rbget,
120 *volatile sc_rbput;
121 volatile u_int sc_rbavail;
122 u_char *sc_rbuf,
123 *sc_ebuf;
124
125 u_char *sc_tba;
126 u_int sc_tbc,
127 sc_heldtbc;
128
129 volatile u_char sc_rx_flags,
130 #define RX_TTY_BLOCKED 0x01
131 #define RX_TTY_OVERFLOWED 0x02
132 #define RX_IBUF_BLOCKED 0x04
133 #define RX_IBUF_OVERFLOWED 0x08
134 #define RX_ANY_BLOCK 0x0f
135 sc_tx_busy,
136 sc_tx_done,
137 sc_tx_stopped,
138 sc_st_check,
139 sc_rx_ready;
140
141 volatile u_char sc_heldchange;
142 volatile u_int sc_cr, sc_ratel, sc_rateh, sc_imsc;
143 volatile u_int sc_msr, sc_msr_delta, sc_msr_mask;
144 volatile u_char sc_mcr, sc_mcr_active, sc_lcr;
145 u_char sc_mcr_dtr, sc_mcr_rts, sc_msr_cts, sc_msr_dcd;
146 u_int sc_fifo;
147
148 /* Support routine to program mcr lines for PL010, if present. */
149 void (*sc_set_mcr)(void *, int, u_int);
150 void *sc_set_mcr_arg;
151
152 /* power management hooks */
153 int (*enable) (struct plcom_softc *);
154 void (*disable) (struct plcom_softc *);
155 int enabled;
156
157 /* PPS signal on DCD, with or without inkernel clock disciplining */
158 u_char sc_ppsmask; /* pps signal mask */
159 u_char sc_ppsassert; /* pps leading edge */
160 u_char sc_ppsclear; /* pps trailing edge */
161 pps_info_t ppsinfo;
162 pps_params_t ppsparam;
163
164 #ifdef RND_COM
165 krndsource_t rnd_source;
166 #endif
167 kmutex_t sc_lock;
168 };
169
170 #if 0
171 int plcomprobe1 (bus_space_tag_t, bus_space_handle_t);
172 #endif
173 int plcomintr (void *);
174 void plcom_attach_subr (struct plcom_softc *);
175 int plcom_detach (device_t, int);
176 int plcom_activate (device_t, enum devact);
177
178