summaryrefslogtreecommitdiff
path: root/sys/arch/evbarm/dev/plcomvar.h
blob: 428603b751edd0c5c1c98d3b984ab557852104e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*	$NetBSD: plcomvar.h,v 1.20 2023/04/11 12:56:07 riastradh Exp $	*/

/*
 * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Christopher G. Demetriou
 *	for the NetBSD Project.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef	_SYS_ARCH_EVBARM_DEV_PLCOMVAR_H_
#define	_SYS_ARCH_EVBARM_DEV_PLCOMVAR_H_

#include "opt_multiprocessor.h"
#include "opt_lockdebug.h"
#include "opt_plcom.h"
#include "opt_kgdb.h"

#ifdef RND_COM
#include <sys/rndsource.h>
#endif

#include <sys/callout.h>
#include <sys/timepps.h>

struct plcom_instance;

int  plcomcnattach	(struct plcom_instance *, int, int, tcflag_t, int);
void plcomcndetach	(void);

#ifdef KGDB
int  plcom_kgdb_attach	(struct plcom_instance *, int, int, tcflag_t, int);
#endif

int  plcom_is_console	(bus_space_tag_t, bus_addr_t, bus_space_handle_t *);

/* Hardware flag masks */
#define	PLCOM_HW_NOIEN		0x01
#define	PLCOM_HW_FIFO		0x02
#define	PLCOM_HW_HAYESP		0x04
#define	PLCOM_HW_FLOW		0x08
#define	PLCOM_HW_DEV_OK		0x20
#define	PLCOM_HW_CONSOLE	0x40
#define	PLCOM_HW_KGDB		0x80
#define	PLCOM_HW_TXFIFO_DISABLE	0x100

/* Buffer size for character buffer */
#define	PLCOM_RING_SIZE		2048

struct plcom_instance {
	u_int			pi_type;
#define	PLCOM_TYPE_PL010 0
#define	PLCOM_TYPE_PL011 1
#define	PLCOM_TYPE_GENERIC_UART 2		/* SBSA generic uart */

	uint32_t		pi_flags;	/* flags for this PLCOM */
#define	PLC_FLAG_USE_DMA		0x0001
#define	PLC_FLAG_32BIT_ACCESS		0x0002
	uint32_t		pi_periphid;

	void 			*pi_cookie;

	bus_space_tag_t		pi_iot;
	bus_space_handle_t	pi_ioh;
	bus_addr_t		pi_iobase;
	bus_addr_t		pi_size;
	struct plcom_registers	*pi_regs;
};

struct plcom_softc {
	device_t sc_dev;

	struct tty *sc_tty;
	void *sc_si;

	struct callout sc_diag_callout;

 	int sc_frequency;

	struct plcom_instance sc_pi;

	u_int sc_overflows,
	      sc_floods,
	      sc_errors;

	int sc_hwflags,
	    sc_swflags;
	u_int sc_fifolen;
	u_int sc_burstlen;

	struct timeval sc_hup_pending;

	u_int sc_r_hiwat,
	      sc_r_lowat;
	u_char *volatile sc_rbget,
	       *volatile sc_rbput;
 	volatile u_int sc_rbavail;
	u_char *sc_rbuf,
	       *sc_ebuf;

 	u_char *sc_tba;
 	u_int sc_tbc,
	      sc_heldtbc;

	volatile u_char sc_rx_flags,
#define	RX_TTY_BLOCKED		0x01
#define	RX_TTY_OVERFLOWED	0x02
#define	RX_IBUF_BLOCKED		0x04
#define	RX_IBUF_OVERFLOWED	0x08
#define	RX_ANY_BLOCK		0x0f
			sc_tx_busy,
			sc_tx_done,
			sc_tx_stopped,
			sc_st_check,
			sc_rx_ready;

	volatile u_char sc_heldchange;
	volatile uint32_t sc_cr, sc_ratel, sc_rateh, sc_imsc;
	volatile uint32_t sc_msr, sc_msr_delta, sc_msr_mask;
	volatile uint32_t sc_lcr, sc_ifls;
	volatile u_char sc_mcr, sc_mcr_active;
	u_char sc_mcr_dtr, sc_mcr_rts, sc_msr_cts, sc_msr_dcd;
	u_int sc_fifo;

	/* Support routine to program mcr lines for PL010, if present.  */
	void	(*sc_set_mcr)(void *, int, u_int);
	void	*sc_set_mcr_arg;

	/* power management hooks */
	int (*enable) (struct plcom_softc *);
	void (*disable) (struct plcom_softc *);
	int enabled;

	/* PPS signal on DCD, with or without inkernel clock disciplining */
	u_char	sc_ppsmask;			/* pps signal mask */
	u_char	sc_ppsassert;			/* pps leading edge */
	u_char	sc_ppsclear;			/* pps trailing edge */
	pps_info_t ppsinfo;
	pps_params_t ppsparam;

#ifdef RND_COM
	krndsource_t  rnd_source;
#endif
	kmutex_t		sc_lock;
};

#if 0
int  plcomprobe1	(bus_space_tag_t, bus_space_handle_t);
#endif
int  plcomintr		(void *);
void plcom_attach_subr	(struct plcom_softc *);
int  plcom_detach	(device_t, int);
int  plcom_activate	(device_t, enum devact);

#endif	/* _SYS_ARCH_EVBARM_DEV_PLCOMVAR_H_ */