bus/fslmc: update MC to 10.3.x
[dpdk.git] / drivers / bus / fslmc / mc / fsl_dpcon.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 2013-2016 Freescale Semiconductor Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are met:
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  * * Neither the name of the above-listed copyright holders nor the
17  * names of any contributors may be used to endorse or promote products
18  * derived from this software without specific prior written permission.
19  *
20  *   GPL LICENSE SUMMARY
21  *
22  * ALTERNATIVELY, this software may be distributed under the terms of the
23  * GNU General Public License ("GPL") as published by the Free Software
24  * Foundation, either version 2 of that License or (at your option) any
25  * later version.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
31  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 #ifndef __FSL_DPCON_H
40 #define __FSL_DPCON_H
41
42 /* Data Path Concentrator API
43  * Contains initialization APIs and runtime control APIs for DPCON
44  */
45
46 struct fsl_mc_io;
47
48 /** General DPCON macros */
49
50 /**
51  * Use it to disable notifications; see dpcon_set_notification()
52  */
53 #define DPCON_INVALID_DPIO_ID           (int)(-1)
54
55 int dpcon_open(struct fsl_mc_io *mc_io,
56                uint32_t cmd_flags,
57                int dpcon_id,
58                uint16_t *token);
59
60 int dpcon_close(struct fsl_mc_io *mc_io,
61                 uint32_t cmd_flags,
62                 uint16_t token);
63
64 /**
65  * struct dpcon_cfg - Structure representing DPCON configuration
66  * @num_priorities: Number of priorities for the DPCON channel (1-8)
67  */
68 struct dpcon_cfg {
69         uint8_t num_priorities;
70 };
71
72 int dpcon_create(struct fsl_mc_io *mc_io,
73                  uint16_t dprc_token,
74                  uint32_t cmd_flags,
75                  const struct dpcon_cfg *cfg,
76                  uint32_t *obj_id);
77
78 int dpcon_destroy(struct fsl_mc_io *mc_io,
79                   uint16_t dprc_token,
80                   uint32_t cmd_flags,
81                   uint32_t obj_id);
82
83 int dpcon_enable(struct fsl_mc_io *mc_io,
84                  uint32_t cmd_flags,
85                  uint16_t token);
86
87 int dpcon_disable(struct fsl_mc_io *mc_io,
88                   uint32_t cmd_flags,
89                   uint16_t token);
90
91 int dpcon_is_enabled(struct fsl_mc_io *mc_io,
92                      uint32_t cmd_flags,
93                      uint16_t token,
94                      int *en);
95
96 int dpcon_reset(struct fsl_mc_io *mc_io,
97                 uint32_t cmd_flags,
98                 uint16_t token);
99
100 /**
101  * struct dpcon_attr - Structure representing DPCON attributes
102  * @id:                 DPCON object ID
103  * @qbman_ch_id:        Channel ID to be used by dequeue operation
104  * @num_priorities:     Number of priorities for the DPCON channel (1-8)
105  */
106 struct dpcon_attr {
107         int id;
108         uint16_t qbman_ch_id;
109         uint8_t num_priorities;
110 };
111
112 int dpcon_get_attributes(struct fsl_mc_io *mc_io,
113                          uint32_t cmd_flags,
114                          uint16_t token,
115                          struct dpcon_attr *attr);
116
117 int dpcon_get_api_version(struct fsl_mc_io *mc_io,
118                           uint32_t cmd_flags,
119                           uint16_t *major_ver,
120                           uint16_t *minor_ver);
121
122 #endif /* __FSL_DPCON_H */