xref: /freebsd/sys/dev/dpaa/fman.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * Copyright (c) 2011-2012 Semihalf.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef FMAN_H_
28 #define FMAN_H_
29 
30 #include <dev/fdt/simplebus.h>
31 
32 /**
33  * FMan driver instance data.
34  */
35 struct fman_softc {
36 	struct simplebus_softc sc_base;
37 	struct resource *mem_res;
38 	struct resource *irq_res;
39 	struct resource *err_irq_res;
40 	struct rman	rman;
41 	int mem_rid;
42 	int irq_rid;
43 	int err_irq_rid;
44 	int qman_chan_base;
45 	int qman_chan_count;
46 
47 	t_Handle fm_handle;
48 	t_Handle muram_handle;
49 };
50 
51 
52 /**
53  * @group QMan bus interface.
54  * @{
55  */
56 struct resource * fman_alloc_resource(device_t bus, device_t child, int type,
57     int *rid, rman_res_t start, rman_res_t end, rman_res_t count, u_int flags);
58 int fman_activate_resource(device_t bus, device_t child,
59     int type, int rid, struct resource *res);
60 int fman_release_resource(device_t bus, device_t child, int type, int rid,
61     struct resource *res);
62 int	fman_attach(device_t dev);
63 int	fman_detach(device_t dev);
64 int	fman_suspend(device_t dev);
65 int	fman_resume_dev(device_t dev);
66 int	fman_shutdown(device_t dev);
67 int	fman_read_ivar(device_t dev, device_t child, int index,
68 	    uintptr_t *result);
69 int	fman_qman_channel_id(device_t, int);
70 /** @} */
71 
72 uint32_t	fman_get_clock(struct fman_softc *sc);
73 int	fman_get_handle(device_t dev, t_Handle *fmh);
74 int	fman_get_muram_handle(device_t dev, t_Handle *muramh);
75 int	fman_get_bushandle(device_t dev, vm_offset_t *fm_base);
76 
77 #endif /* FMAN_H_ */
78