xref: /freebsd/sys/dev/dpaa/fman.h (revision 5dae51da3da0cc94d17bd67b308fad304ebec7e0)
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  * $FreeBSD$
27  */
28 
29 #ifndef FMAN_H_
30 #define FMAN_H_
31 
32 #include <dev/fdt/simplebus.h>
33 
34 /**
35  * FMan driver instance data.
36  */
37 struct fman_softc {
38 	struct simplebus_softc sc_base;
39 	struct resource *mem_res;
40 	struct resource *irq_res;
41 	struct resource *err_irq_res;
42 	int mem_rid;
43 	int irq_rid;
44 	int err_irq_rid;
45 
46 	t_Handle fm_handle;
47 	t_Handle muram_handle;
48 };
49 
50 
51 /**
52  * @group QMan bus interface.
53  * @{
54  */
55 int	fman_attach(device_t dev);
56 int	fman_detach(device_t dev);
57 int	fman_suspend(device_t dev);
58 int	fman_resume(device_t dev);
59 int	fman_shutdown(device_t dev);
60 int	fman_read_ivar(device_t dev, device_t child, int index,
61 	    uintptr_t *result);
62 /** @} */
63 
64 uint32_t	fman_get_clock(struct fman_softc *sc);
65 int	fman_get_handle(t_Handle *fmh);
66 int	fman_get_muram_handle(t_Handle *muramh);
67 int	fman_get_bushandle(vm_offset_t *fm_base);
68 int	fman_get_dev(device_t *fmd);
69 
70 #endif /* FMAN_H_ */
71