2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2004-2006 Marcel Moolenaar
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef _DEV_SCC_BFE_H_
32 #define _DEV_SCC_BFE_H_
34 #include <sys/serial.h>
37 * Bus access structure. This structure holds the minimum information needed
38 * to access the SCC. The rclk field, although not important to actually
39 * access the SCC, is important for baudrate programming, delay loops and
40 * other timing related computations.
44 bus_space_handle_t bsh;
50 #define scc_regofs(bas, reg) ((reg) << (bas)->regshft)
52 #define scc_getreg(bas, reg) \
53 bus_space_read_1((bas)->bst, (bas)->bsh, scc_regofs(bas, reg))
54 #define scc_setreg(bas, reg, value) \
55 bus_space_write_1((bas)->bst, (bas)->bsh, scc_regofs(bas, reg), value)
57 #define scc_barrier(bas) \
58 bus_space_barrier((bas)->bst, (bas)->bsh, 0, (bas)->range, \
59 BUS_SPACE_BARRIER_READ|BUS_SPACE_BARRIER_WRITE)
62 * SCC mode (child) and channel control structures.
71 struct scc_chan *m_chan;
82 serdev_intr_t *ih_src[SCC_ISRCCNT];
87 struct resource ch_rres;
88 struct resource_list ch_rlist;
90 struct resource *ch_ires; /* Interrupt resource. */
94 struct scc_mode ch_mode[SCC_NMODES];
105 * SCC class & instance (=softc)
109 u_int cl_channels; /* Number of independent channels. */
110 u_int cl_class; /* SCC bus class ID. */
111 u_int cl_modes; /* Supported modes (bitset). */
115 extern struct scc_class scc_quicc_class;
116 extern struct scc_class scc_sab82532_class;
117 extern struct scc_class scc_z8530_escc_class;
118 extern struct scc_class scc_z8530_legacy_class;
122 struct scc_class *sc_class;
123 struct scc_bas sc_bas;
126 struct mtx sc_hwmtx; /* Spinlock protecting hardware. */
128 struct resource *sc_rres; /* Register resource. */
130 int sc_rtype; /* SYS_RES_{IOPORT|MEMORY}. */
132 struct scc_chan *sc_chan;
138 uint32_t sc_hwsig; /* Signal state. Used by HW driver. */
141 extern devclass_t scc_devclass;
142 extern const char scc_driver_name[];
144 int scc_bfe_attach(device_t dev, u_int ipc);
145 int scc_bfe_detach(device_t dev);
146 int scc_bfe_probe(device_t dev, u_int regshft, u_int rclk, u_int rid);
148 struct resource *scc_bus_alloc_resource(device_t, device_t, int, int *,
149 rman_res_t, rman_res_t, rman_res_t, u_int);
150 int scc_bus_get_resource(device_t, device_t, int, int, rman_res_t *, rman_res_t *);
151 int scc_bus_read_ivar(device_t, device_t, int, uintptr_t *);
152 int scc_bus_release_resource(device_t, device_t, int, int, struct resource *);
153 int scc_bus_setup_intr(device_t, device_t, struct resource *, int,
154 driver_filter_t *, void (*)(void *), void *, void **);
155 int scc_bus_teardown_intr(device_t, device_t, struct resource *, void *);
157 #endif /* _DEV_SCC_BFE_H_ */