1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2002, 2003 Wasabi Systems, Inc.
5 * All rights reserved.
6 *
7 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 *    must display the following acknowledgement:
19 *	This product includes software developed for the NetBSD Project by
20 *	Wasabi Systems, Inc.
21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 *    or promote products derived from this software without specific prior
23 *    written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 *
37 * from: FreeBSD: //depot/projects/arm/src/sys/arm/xscale/pxa2x0/pxa2x0var.h, rev 1
38 *
39 * $FreeBSD$
40 */
41
42#ifndef _MVVAR_H_
43#define _MVVAR_H_
44
45#include <sys/rman.h>
46#include <machine/bus.h>
47#include <vm/vm.h>
48#include <vm/pmap.h>
49
50#include <dev/ofw/openfirm.h>
51
52#define	MV_TYPE_PCI		0
53#define	MV_TYPE_PCIE		1
54
55#define MV_MODE_ENDPOINT	0
56#define MV_MODE_ROOT		1
57
58enum soc_family{
59	MV_SOC_ARMADA_38X 	= 0x00,
60	MV_SOC_ARMADA_XP	= 0x01,
61	MV_SOC_ARMV5		= 0x02,
62	MV_SOC_UNSUPPORTED	= 0xff,
63};
64
65struct gpio_config {
66	int		gc_gpio;	/* GPIO number */
67	uint32_t	gc_flags;	/* GPIO flags */
68	int		gc_output;	/* GPIO output value */
69};
70
71struct decode_win {
72	int		target;		/* Mbus unit ID */
73	int		attr;		/* Attributes of the target interface */
74	vm_paddr_t	base;		/* Physical base addr */
75	uint32_t	size;
76	vm_paddr_t	remap;
77};
78
79extern const struct gpio_config mv_gpio_config[];
80extern const struct decode_win *cpu_wins;
81extern const struct decode_win *idma_wins;
82extern const struct decode_win *xor_wins;
83extern int idma_wins_no;
84extern int xor_wins_no;
85
86int soc_decode_win(void);
87void soc_id(uint32_t *dev, uint32_t *rev);
88void soc_dump_decode_win(void);
89uint32_t soc_power_ctrl_get(uint32_t mask);
90void soc_power_ctrl_set(uint32_t mask);
91
92int decode_win_cpu_set(int target, int attr, vm_paddr_t base, uint32_t size,
93    vm_paddr_t remap);
94int decode_win_overlap(int, int, const struct decode_win *);
95int win_cpu_can_remap(int);
96void decode_win_pcie_setup(u_long);
97
98void ddr_disable(int i);
99int ddr_is_active(int i);
100uint32_t ddr_base(int i);
101uint32_t ddr_size(int i);
102uint32_t ddr_attr(int i);
103uint32_t ddr_target(int i);
104
105uint32_t cpu_extra_feat(void);
106uint32_t get_tclk(void);
107uint32_t get_cpu_freq(void);
108uint32_t get_l2clk(void);
109uint32_t read_cpu_ctrl(uint32_t);
110void write_cpu_ctrl(uint32_t, uint32_t);
111
112uint32_t read_cpu_mp_clocks(uint32_t reg);
113void write_cpu_mp_clocks(uint32_t reg, uint32_t val);
114uint32_t read_cpu_misc(uint32_t reg);
115void write_cpu_misc(uint32_t reg, uint32_t val);
116
117int mv_pcib_bar_win_set(device_t dev, uint32_t base, uint32_t size,
118    uint32_t remap, int winno, int busno);
119int mv_pcib_cpu_win_remap(device_t dev, uint32_t remap, uint32_t size);
120
121void mv_mask_endpoint_irq(uintptr_t nb, int unit);
122void mv_unmask_endpoint_irq(uintptr_t nb, int unit);
123
124int	mv_drbl_get_next_irq(int dir, int unit);
125void	mv_drbl_mask_all(int unit);
126void	mv_drbl_mask_irq(uint32_t irq, int dir, int unit);
127void	mv_drbl_unmask_irq(uint32_t irq, int dir, int unit);
128void	mv_drbl_set_mask(uint32_t val, int dir, int unit);
129uint32_t mv_drbl_get_mask(int dir, int unit);
130void	mv_drbl_set_cause(uint32_t val, int dir, int unit);
131uint32_t mv_drbl_get_cause(int dir, int unit);
132void	mv_drbl_set_msg(uint32_t val, int mnr, int dir, int unit);
133uint32_t mv_drbl_get_msg(int mnr, int dir, int unit);
134
135int	mv_msi_data(int irq, uint64_t *addr, uint32_t *data);
136
137struct devmap_entry;
138
139int mv_pci_devmap(phandle_t, struct devmap_entry *, vm_offset_t,
140    vm_offset_t);
141int fdt_localbus_devmap(phandle_t, struct devmap_entry *, int, int *);
142enum soc_family mv_check_soc_family(void);
143
144int mv_fdt_is_type(phandle_t, const char *);
145int mv_fdt_pm(phandle_t);
146
147uint32_t get_tclk_armadaxp(void);
148uint32_t get_tclk_armada38x(void);
149uint32_t get_cpu_freq_armadaxp(void);
150uint32_t get_cpu_freq_armada38x(void);
151#endif /* _MVVAR_H_ */
152