2 * Copyright (c) 2011-2012 Semihalf.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
36 #include <sys/malloc.h>
38 #include <dev/fdt/fdt_common.h>
39 #include <dev/ofw/ofw_bus.h>
40 #include <dev/ofw/ofw_bus_subr.h>
42 #include "opt_platform.h"
44 #include <contrib/ncsw/inc/Peripherals/fm_ext.h>
45 #include <contrib/ncsw/inc/Peripherals/fm_muram_ext.h>
46 #include <contrib/ncsw/inc/ncsw_ext.h>
47 #include <contrib/ncsw/integrations/fman_ucode.h>
53 * @group FMan private defines.
61 enum fman_mu_ram_map {
63 FMAN_MURAM_SIZE = 0x28000
68 uintptr_t mem_base_addr;
72 t_FmExceptionsCallback *exception_callback;
73 t_FmBusErrorCallback *bus_error_callback;
77 * @group FMan private methods/members.
81 * Frame Manager firmware.
82 * We use the same firmware for both P3041 and P2041 devices.
84 const uint32_t fman_firmware[] = FMAN_UC_IMG;
85 const uint32_t fman_firmware_size = sizeof(fman_firmware);
86 static struct fman_softc *fm_sc = NULL;
89 fman_init(struct fman_softc *sc, struct fman_config *cfg)
92 t_Handle muram_handle, fm_handle;
94 t_FmRevisionInfo revision_info;
98 /* MURAM configuration */
99 muram_handle = FM_MURAM_ConfigAndInit(cfg->mem_base_addr +
100 FMAN_MURAM_OFF, FMAN_MURAM_SIZE);
101 if (muram_handle == NULL) {
102 device_printf(cfg->fman_device, "couldn't init FM MURAM module"
106 sc->muram_handle = muram_handle;
108 /* Fill in FM configuration */
109 fm_params.fmId = cfg->fm_id;
110 /* XXX we support only one partition thus each fman has master id */
111 fm_params.guestId = NCSW_MASTER_ID;
113 fm_params.baseAddr = cfg->mem_base_addr;
114 fm_params.h_FmMuram = muram_handle;
116 /* Get FMan clock in Hz */
117 if ((tmp = fman_get_clock(sc)) == 0)
120 /* Convert FMan clock to MHz */
121 clock = (uint16_t)(tmp / 1000000);
127 fm_params.fmClkFreq = clock;
128 fm_params.f_Exception = cfg->exception_callback;
129 fm_params.f_BusError = cfg->bus_error_callback;
130 fm_params.h_App = cfg->fman_device;
131 fm_params.irq = cfg->irq_num;
132 fm_params.errIrq = cfg->err_irq_num;
134 fm_params.firmware.size = fman_firmware_size;
135 fm_params.firmware.p_Code = (uint32_t*)fman_firmware;
137 fm_handle = FM_Config(&fm_params);
138 if (fm_handle == NULL) {
139 device_printf(cfg->fman_device, "couldn't configure FM "
144 FM_ConfigResetOnInit(fm_handle, TRUE);
146 error = FM_Init(fm_handle);
148 device_printf(cfg->fman_device, "couldn't init FM module\n");
152 error = FM_GetRevision(fm_handle, &revision_info);
154 device_printf(cfg->fman_device, "couldn't get FM revision\n");
158 device_printf(cfg->fman_device, "Hardware version: %d.%d.\n",
159 revision_info.majorRev, revision_info.minorRev);
166 FM_MURAM_Free(muram_handle);
171 fman_exception_callback(t_Handle app_handle, e_FmExceptions exception)
173 struct fman_softc *sc;
176 device_printf(sc->dev, "FMan exception occurred.\n");
180 fman_error_callback(t_Handle app_handle, e_FmPortType port_type,
181 uint8_t port_id, uint64_t addr, uint8_t tnum, uint16_t liodn)
183 struct fman_softc *sc;
186 device_printf(sc->dev, "FMan error occurred.\n");
192 * @group FMan driver interface.
197 fman_get_handle(t_Handle *fmh)
203 *fmh = fm_sc->fm_handle;
209 fman_get_muram_handle(t_Handle *muramh)
215 *muramh = fm_sc->muram_handle;
221 fman_get_bushandle(vm_offset_t *fm_base)
227 *fm_base = rman_get_bushandle(fm_sc->mem_res);
233 fman_attach(device_t dev)
235 struct fman_softc *sc;
236 struct fman_config cfg;
238 sc = device_get_softc(dev);
242 /* Check if MallocSmart allocator is ready */
243 if (XX_MallocSmartInit() != E_OK) {
244 device_printf(dev, "could not initialize smart allocator.\n");
251 sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->mem_rid,
254 device_printf(dev, "could not allocate memory.\n");
259 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->irq_rid,
262 device_printf(dev, "could not allocate interrupt.\n");
267 * XXX: Fix FMan interrupt. This is workaround for the issue with
268 * interrupts directed to multiple CPUs by the interrupts subsystem.
269 * Workaround is to bind the interrupt to only one CPU0.
271 XX_FmanFixIntr(rman_get_start(sc->irq_res));
274 sc->err_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
275 &sc->err_irq_rid, RF_ACTIVE | RF_SHAREABLE);
276 if (!sc->err_irq_res) {
277 device_printf(dev, "could not allocate error interrupt.\n");
281 /* Set FMan configuration */
282 cfg.fman_device = dev;
283 cfg.fm_id = device_get_unit(dev);
284 cfg.mem_base_addr = rman_get_bushandle(sc->mem_res);
285 cfg.irq_num = (int)sc->irq_res;
286 cfg.err_irq_num = (int)sc->err_irq_res;
287 cfg.exception_callback = fman_exception_callback;
288 cfg.bus_error_callback = fman_error_callback;
290 sc->fm_handle = fman_init(sc, &cfg);
291 if (sc->fm_handle == NULL) {
292 device_printf(dev, "could not be configured\n");
296 return (bus_generic_attach(dev));
304 fman_detach(device_t dev)
306 struct fman_softc *sc;
308 sc = device_get_softc(dev);
310 if (sc->muram_handle) {
311 FM_MURAM_Free(sc->muram_handle);
315 FM_Free(sc->fm_handle);
319 bus_release_resource(dev, SYS_RES_MEMORY, sc->mem_rid,
324 bus_release_resource(dev, SYS_RES_IRQ, sc->irq_rid,
329 bus_release_resource(dev, SYS_RES_IRQ, sc->err_irq_rid,
337 fman_suspend(device_t dev)
344 fman_resume(device_t dev)
351 fman_shutdown(device_t dev)