a4897b03dc418818d591f034c171cb6b322cc6b4
[dpdk.git] / drivers / bus / dpaa / include / fsl_usd.h
1 /*-
2  * This file is provided under a dual BSD/GPLv2 license. When using or
3  * redistributing this file, you may do so under either license.
4  *
5  *   BSD LICENSE
6  *
7  * Copyright 2010-2011 Freescale Semiconductor, Inc.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * 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  * * Neither the name of the above-listed copyright holders nor the
18  * names of any contributors may be used to endorse or promote products
19  * derived from this software without specific prior written permission.
20  *
21  *   GPL LICENSE SUMMARY
22  *
23  * ALTERNATIVELY, this software may be distributed under the terms of the
24  * GNU General Public License ("GPL") as published by the Free Software
25  * Foundation, either version 2 of that License or (at your option) any
26  * later version.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
32  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40
41 #ifndef __FSL_USD_H
42 #define __FSL_USD_H
43
44 #include <compat.h>
45 #include <fsl_qman.h>
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 /* Thread-entry/exit hooks; */
52 int qman_thread_init(void);
53 int qman_thread_finish(void);
54
55 #define QBMAN_ANY_PORTAL_IDX 0xffffffff
56
57 /* Obtain and free raw (unitialized) portals */
58
59 struct dpaa_raw_portal {
60         /* inputs */
61
62         /* set to non zero to turn on stashing */
63         uint8_t enable_stash;
64         /* Stashing attributes for the portal */
65         uint32_t cpu;
66         uint32_t cache;
67         uint32_t window;
68
69         /* Specifies the stash request queue this portal should use */
70         uint8_t sdest;
71
72         /* Specifes a specific portal index to map or QBMAN_ANY_PORTAL_IDX
73          * for don't care.  The portal index will be populated by the
74          * driver when the ioctl() successfully completes.
75          */
76         uint32_t index;
77
78         /* outputs */
79         uint64_t cinh;
80         uint64_t cena;
81 };
82
83 int qman_allocate_raw_portal(struct dpaa_raw_portal *portal);
84 int qman_free_raw_portal(struct dpaa_raw_portal *portal);
85
86 int bman_allocate_raw_portal(struct dpaa_raw_portal *portal);
87 int bman_free_raw_portal(struct dpaa_raw_portal *portal);
88
89 /* Post-process interrupts. NB, the kernel IRQ handler disables the interrupt
90  * line before notifying us, and this post-processing re-enables it once
91  * processing is complete. As such, it is essential to call this before going
92  * into another blocking read/select/poll.
93  */
94 void qman_thread_irq(void);
95
96 /* Global setup */
97 int qman_global_init(void);
98 #ifdef __cplusplus
99 }
100 #endif
101
102 #endif /* __FSL_USD_H */