1 /*        $NetBSD: bcm53xx_var.h,v 1.7 2021/09/19 10:34:08 andvar Exp $         */
2 /*-
3  * Copyright (c) 2012 The NetBSD Foundation, Inc.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The NetBSD Foundation
7  * by Matt Thomas of 3am Software Foundry.
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  *
18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef _ARM_BROADCOM_BCM53XX_VAR_H_
32 #define _ARM_BROADCOM_BCM53XX_VAR_H_
33 
34 #include <sys/bus.h>
35 #include <sys/cpu.h>
36 
37 struct bcm_locators {
38           const char *loc_name;
39           bus_size_t loc_offset;
40           bus_size_t loc_size;
41           int loc_port;
42           uint8_t loc_nintrs;
43           u_int loc_intrs[8];
44           int loc_mdio;
45           int loc_phy;
46 };
47 
48 struct bcmccb_attach_args {
49           bus_space_tag_t ccbaa_ccb_bst;
50           bus_space_handle_t ccbaa_ccb_bsh;
51           bus_dma_tag_t ccbaa_dmat;
52 
53           struct bcm_locators ccbaa_loc;
54 };
55 
56 struct bcm53xx_clock_info {
57           uint32_t clk_ref;   // 25MHZ
58           uint32_t clk_sys;   // 200MHZ
59           uint32_t clk_ddr;
60           uint32_t clk_ddr_mhz;
61           uint32_t clk_cpu;
62           uint32_t clk_apb;
63           uint32_t clk_lcpll; // LCPLL out
64           uint32_t clk_pcie_ref;        // LCPLL CH0
65           uint32_t clk_sdio;  // LCPLL CH1
66           uint32_t clk_ddr_ref;         // LCPLL CH2
67           uint32_t clk_axi;   // LCPLL CH3
68           uint32_t clk_genpll;          // GENPLL out
69           uint32_t clk_mac;   // GENPLL CH0
70           uint32_t clk_robo;  // GENPLL CH1
71           uint32_t clk_usb2;  // GENPLL CH2
72           uint32_t clk_iproc; // GENPLL CH3
73           uint32_t clk_usb_ref;         // 1920MHz USB Reference Clock
74 };
75 
76 /*
77  * Used by BCMETH (gmac)
78  */
79 struct bcmmdio_softc {
80           device_t sc_dev;
81           bus_space_tag_t sc_bst;
82           bus_space_handle_t sc_bsh;
83           kmutex_t *sc_lock;
84 };
85 
86 int       bcmmdio_mii_readreg(device_t, int, int);
87 void      bcmmdio_mii_writereg(device_t, int, int, int);
88 
89 
90 struct cpu_softc {
91           struct cpu_info *cpu_ci;
92           bus_space_tag_t cpu_ioreg_bst;
93           bus_space_tag_t cpu_armcore_bst;
94           bus_space_handle_t cpu_ioreg_bsh;
95           bus_space_handle_t cpu_armcore_bsh;
96 
97           struct bcm53xx_clock_info cpu_clk;
98           uint32_t cpu_chipid;
99 };
100 
101 
102 #ifdef _KERNEL
103 void      bcm53xx_bootstrap(vaddr_t);
104 void      bcm53xx_cpu_hatch(struct cpu_info *);
105 void      bcm53xx_cpu_softc_init(struct cpu_info *);
106 bool      bcm53xx_idm_device_init(const struct bcm_locators *, bus_space_tag_t,
107               bus_space_handle_t);
108 void      bcm53xx_device_register(device_t, void *);
109 psize_t   bcm53xx_memprobe(void);
110 void      bcm53xx_dma_bootstrap(psize_t);
111 void      bcm53xx_print_clocks(void);
112 void      bcm53xx_rng_start(bus_space_tag_t, bus_space_handle_t);
113 void      bcm53xx_srab_init(void);
114 uint32_t  bcm53xx_srab_read_4(u_int);
115 uint64_t  bcm53xx_srab_read_8(u_int);
116 void      bcm53xx_srab_write_4(u_int, uint32_t);
117 void      bcm53xx_srab_write_8(u_int, uint64_t);
118 extern struct arm32_bus_dma_tag bcm53xx_dma_tag, bcm53xx_coherent_dma_tag;
119 #ifdef _ARM32_NEED_BUS_DMA_BOUNCE
120 extern struct arm32_bus_dma_tag bcm53xx_bounce_dma_tag;
121 #endif
122 extern struct bus_space bcmgen_bs_tag;
123 extern bus_space_tag_t bcm53xx_ioreg_bst;
124 extern bus_space_handle_t bcm53xx_ioreg_bsh;
125 extern bus_space_tag_t bcm53xx_armcore_bst;
126 extern bus_space_handle_t bcm53xx_armcore_bsh;
127 #endif
128 
129 #endif /* _ARM_BROADCOM_BCM53XX_VAR_H_ */
130