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/simplebus.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>
52 static MALLOC_DEFINE(M_FMAN, "fman", "fman devices information");
55 * @group FMan private defines.
63 enum fman_mu_ram_map {
65 FMAN_MURAM_SIZE = 0x28000
70 uintptr_t mem_base_addr;
72 uintptr_t err_irq_num;
74 t_FmExceptionsCallback *exception_callback;
75 t_FmBusErrorCallback *bus_error_callback;
79 * @group FMan private methods/members.
83 * Frame Manager firmware.
84 * We use the same firmware for both P3041 and P2041 devices.
86 const uint32_t fman_firmware[] = FMAN_UC_IMG;
87 const uint32_t fman_firmware_size = sizeof(fman_firmware);
88 static struct fman_softc *fm_sc = NULL;
91 fman_init(struct fman_softc *sc, struct fman_config *cfg)
93 struct ofw_bus_devinfo obd;
96 t_Handle muram_handle, fm_handle;
98 t_FmRevisionInfo revision_info;
102 /* MURAM configuration */
103 muram_handle = FM_MURAM_ConfigAndInit(cfg->mem_base_addr +
104 FMAN_MURAM_OFF, FMAN_MURAM_SIZE);
105 if (muram_handle == NULL) {
106 device_printf(cfg->fman_device, "couldn't init FM MURAM module"
110 sc->muram_handle = muram_handle;
112 /* Fill in FM configuration */
113 fm_params.fmId = cfg->fm_id;
114 /* XXX we support only one partition thus each fman has master id */
115 fm_params.guestId = NCSW_MASTER_ID;
117 fm_params.baseAddr = cfg->mem_base_addr;
118 fm_params.h_FmMuram = muram_handle;
120 /* Get FMan clock in Hz */
121 if ((tmp = fman_get_clock(sc)) == 0)
124 /* Convert FMan clock to MHz */
125 clock = (uint16_t)(tmp / 1000000);
131 fm_params.fmClkFreq = clock;
132 fm_params.f_Exception = cfg->exception_callback;
133 fm_params.f_BusError = cfg->bus_error_callback;
134 fm_params.h_App = cfg->fman_device;
135 fm_params.irq = cfg->irq_num;
136 fm_params.errIrq = cfg->err_irq_num;
138 fm_params.firmware.size = fman_firmware_size;
139 fm_params.firmware.p_Code = (uint32_t*)fman_firmware;
141 fm_handle = FM_Config(&fm_params);
142 if (fm_handle == NULL) {
143 device_printf(cfg->fman_device, "couldn't configure FM "
148 FM_ConfigResetOnInit(fm_handle, TRUE);
150 error = FM_Init(fm_handle);
152 device_printf(cfg->fman_device, "couldn't init FM module\n");
156 error = FM_GetRevision(fm_handle, &revision_info);
158 device_printf(cfg->fman_device, "couldn't get FM revision\n");
162 device_printf(cfg->fman_device, "Hardware version: %d.%d.\n",
163 revision_info.majorRev, revision_info.minorRev);
165 /* Initialize the simplebus part of things */
166 simplebus_init(sc->sc_base.dev, 0);
168 node = ofw_bus_get_node(sc->sc_base.dev);
169 for (node = OF_child(node); node > 0; node = OF_peer(node)) {
170 if (ofw_bus_gen_setup_devinfo(&obd, node) != 0)
172 simplebus_add_device(sc->sc_base.dev, node, 0, NULL, -1, NULL);
180 FM_MURAM_Free(muram_handle);
185 fman_exception_callback(t_Handle app_handle, e_FmExceptions exception)
187 struct fman_softc *sc;
190 device_printf(sc->sc_base.dev, "FMan exception occurred.\n");
194 fman_error_callback(t_Handle app_handle, e_FmPortType port_type,
195 uint8_t port_id, uint64_t addr, uint8_t tnum, uint16_t liodn)
197 struct fman_softc *sc;
200 device_printf(sc->sc_base.dev, "FMan error occurred.\n");
206 * @group FMan driver interface.
211 fman_get_handle(t_Handle *fmh)
217 *fmh = fm_sc->fm_handle;
223 fman_get_muram_handle(t_Handle *muramh)
229 *muramh = fm_sc->muram_handle;
235 fman_get_bushandle(vm_offset_t *fm_base)
241 *fm_base = rman_get_bushandle(fm_sc->mem_res);
247 fman_get_dev(device_t *fm_dev)
253 *fm_dev = fm_sc->sc_base.dev;
259 fman_attach(device_t dev)
261 struct fman_softc *sc;
262 struct fman_config cfg;
263 pcell_t qchan_range[2];
266 sc = device_get_softc(dev);
267 sc->sc_base.dev = dev;
270 /* Check if MallocSmart allocator is ready */
271 if (XX_MallocSmartInit() != E_OK) {
272 device_printf(dev, "could not initialize smart allocator.\n");
276 node = ofw_bus_get_node(dev);
277 if (OF_getencprop(node, "fsl,qman-channel-range", qchan_range,
278 sizeof(qchan_range)) <= 0) {
279 device_printf(dev, "Missing QMan channel range property!\n");
282 sc->qman_chan_base = qchan_range[0];
283 sc->qman_chan_count = qchan_range[1];
285 sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->mem_rid,
286 RF_ACTIVE | RF_SHAREABLE);
288 device_printf(dev, "could not allocate memory.\n");
293 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->irq_rid,
296 device_printf(dev, "could not allocate interrupt.\n");
301 * XXX: Fix FMan interrupt. This is workaround for the issue with
302 * interrupts directed to multiple CPUs by the interrupts subsystem.
303 * Workaround is to bind the interrupt to only one CPU0.
305 XX_FmanFixIntr(rman_get_start(sc->irq_res));
308 sc->err_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
309 &sc->err_irq_rid, RF_ACTIVE | RF_SHAREABLE);
310 if (!sc->err_irq_res) {
311 device_printf(dev, "could not allocate error interrupt.\n");
315 /* Set FMan configuration */
316 cfg.fman_device = dev;
317 cfg.fm_id = device_get_unit(dev);
318 cfg.mem_base_addr = rman_get_bushandle(sc->mem_res);
319 cfg.irq_num = (uintptr_t)sc->irq_res;
320 cfg.err_irq_num = (uintptr_t)sc->err_irq_res;
321 cfg.exception_callback = fman_exception_callback;
322 cfg.bus_error_callback = fman_error_callback;
324 sc->fm_handle = fman_init(sc, &cfg);
325 if (sc->fm_handle == NULL) {
326 device_printf(dev, "could not be configured\n");
330 return (bus_generic_attach(dev));
338 fman_detach(device_t dev)
340 struct fman_softc *sc;
342 sc = device_get_softc(dev);
344 if (sc->muram_handle) {
345 FM_MURAM_Free(sc->muram_handle);
349 FM_Free(sc->fm_handle);
353 bus_release_resource(dev, SYS_RES_MEMORY, sc->mem_rid,
358 bus_release_resource(dev, SYS_RES_IRQ, sc->irq_rid,
363 bus_release_resource(dev, SYS_RES_IRQ, sc->err_irq_rid,
371 fman_suspend(device_t dev)
378 fman_resume(device_t dev)
385 fman_shutdown(device_t dev)
392 fman_qman_channel_id(device_t dev, int port)
394 struct fman_softc *sc;
395 int qman_port_id[] = {0x31, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e,
396 0x2f, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07};
399 sc = device_get_softc(dev);
400 for (i = 0; i < sc->qman_chan_count; i++) {
401 if (qman_port_id[i] == port)
402 return (sc->qman_chan_base + i);