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.
7 * Copyright 2013-2016 Freescale Semiconductor Inc.
8 * Copyright 2016-2017 NXP.
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.
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
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.
43 /* Data Path I/O Portal API
44 * Contains initialization APIs and runtime control APIs for DPIO
49 int dpio_open(struct fsl_mc_io *mc_io,
54 int dpio_close(struct fsl_mc_io *mc_io,
59 * enum dpio_channel_mode - DPIO notification channel mode
60 * @DPIO_NO_CHANNEL: No support for notification channel
61 * @DPIO_LOCAL_CHANNEL: Notifications on data availability can be received by a
62 * dedicated channel in the DPIO; user should point the queue's
63 * destination in the relevant interface to this DPIO
65 enum dpio_channel_mode {
67 DPIO_LOCAL_CHANNEL = 1,
71 * struct dpio_cfg - Structure representing DPIO configuration
72 * @channel_mode: Notification channel mode
73 * @num_priorities: Number of priorities for the notification channel (1-8);
74 * relevant only if 'channel_mode = DPIO_LOCAL_CHANNEL'
77 enum dpio_channel_mode channel_mode;
78 uint8_t num_priorities;
82 int dpio_create(struct fsl_mc_io *mc_io,
85 const struct dpio_cfg *cfg,
88 int dpio_destroy(struct fsl_mc_io *mc_io,
93 int dpio_enable(struct fsl_mc_io *mc_io,
97 int dpio_disable(struct fsl_mc_io *mc_io,
101 int dpio_is_enabled(struct fsl_mc_io *mc_io,
106 int dpio_reset(struct fsl_mc_io *mc_io,
110 int dpio_set_stashing_destination(struct fsl_mc_io *mc_io,
115 int dpio_get_stashing_destination(struct fsl_mc_io *mc_io,
120 int dpio_add_static_dequeue_channel(struct fsl_mc_io *mc_io,
124 uint8_t *channel_index);
126 int dpio_remove_static_dequeue_channel(struct fsl_mc_io *mc_io,
132 * struct dpio_attr - Structure representing DPIO attributes
133 * @id: DPIO object ID
134 * @qbman_portal_ce_offset: Offset of the software portal cache-enabled area
135 * @qbman_portal_ci_offset: Offset of the software portal
136 * cache-inhibited area
137 * @qbman_portal_id: Software portal ID
138 * @channel_mode: Notification channel mode
139 * @num_priorities: Number of priorities for the notification
140 * channel (1-8); relevant only if
141 * 'channel_mode = DPIO_LOCAL_CHANNEL'
142 * @qbman_version: QBMAN version
146 uint64_t qbman_portal_ce_offset;
147 uint64_t qbman_portal_ci_offset;
148 uint16_t qbman_portal_id;
149 enum dpio_channel_mode channel_mode;
150 uint8_t num_priorities;
151 uint32_t qbman_version;
155 int dpio_get_attributes(struct fsl_mc_io *mc_io,
158 struct dpio_attr *attr);
160 int dpio_get_api_version(struct fsl_mc_io *mc_io,
163 uint16_t *minor_ver);
165 #endif /* __FSL_DPIO_H */