2 * Freescale Layerscape MC I/O wrapper
4 * Copyright (C) 2013-2016 Freescale Semiconductor, Inc.
7 * SPDX-License-Identifier: GPL-2.0+
11 * @brief Data Path Buffer Pool API
17 #define DPBP_VER_MAJOR 3
18 #define DPBP_VER_MINOR 3
21 #define DPBP_CMDID_CLOSE 0x8001
22 #define DPBP_CMDID_OPEN 0x8041
23 #define DPBP_CMDID_CREATE 0x9041
24 #define DPBP_CMDID_DESTROY 0x9841
25 #define DPBP_CMDID_GET_API_VERSION 0xa041
27 #define DPBP_CMDID_ENABLE 0x0021
28 #define DPBP_CMDID_DISABLE 0x0031
29 #define DPBP_CMDID_GET_ATTR 0x0041
30 #define DPBP_CMDID_RESET 0x0051
31 #define DPBP_CMDID_IS_ENABLED 0x0061
33 /* cmd, param, offset, width, type, arg_name */
34 #define DPBP_CMD_OPEN(cmd, dpbp_id) \
35 MC_CMD_OP(cmd, 0, 0, 32, int, dpbp_id)
37 /* cmd, param, offset, width, type, arg_name */
38 #define DPBP_RSP_GET_ATTRIBUTES(cmd, attr) \
40 MC_RSP_OP(cmd, 0, 16, 16, uint16_t, attr->bpid); \
41 MC_RSP_OP(cmd, 0, 32, 32, int, attr->id);\
44 /* Data Path Buffer Pool API
45 * Contains initialization APIs and runtime control APIs for DPBP
51 * dpbp_open() - Open a control session for the specified object.
52 * @mc_io: Pointer to MC portal's I/O object
53 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
54 * @dpbp_id: DPBP unique ID
55 * @token: Returned token; use in subsequent API calls
57 * This function can be used to open a control session for an
58 * already created object; an object may have been declared in
59 * the DPL or by calling the dpbp_create function.
60 * This function returns a unique authentication token,
61 * associated with the specific object ID and the specific MC
62 * portal; this token must be used in all subsequent commands for
63 * this specific object
65 * Return: '0' on Success; Error code otherwise.
67 int dpbp_open(struct fsl_mc_io *mc_io,
73 * dpbp_close() - Close the control session of the object
74 * @mc_io: Pointer to MC portal's I/O object
75 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
76 * @token: Token of DPBP object
78 * After this function is called, no further operations are
79 * allowed on the object without opening a new control session.
81 * Return: '0' on Success; Error code otherwise.
83 int dpbp_close(struct fsl_mc_io *mc_io,
88 * struct dpbp_cfg - Structure representing DPBP configuration
89 * @options: place holder
96 * dpbp_create() - Create the DPBP object.
97 * @mc_io: Pointer to MC portal's I/O object
98 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
99 * @cfg: Configuration structure
100 * @token: Returned token; use in subsequent API calls
102 * Create the DPBP object, allocate required resources and
103 * perform required initialization.
105 * The object can be created either by declaring it in the
106 * DPL file, or by calling this function.
107 * This function returns a unique authentication token,
108 * associated with the specific object ID and the specific MC
109 * portal; this token must be used in all subsequent calls to
110 * this specific object. For objects that are created using the
111 * DPL file, call dpbp_open function to get an authentication
114 * Return: '0' on Success; Error code otherwise.
116 int dpbp_create(struct fsl_mc_io *mc_io,
119 const struct dpbp_cfg *cfg,
123 * dpbp_destroy() - Destroy the DPBP object and release all its resources.
124 * @mc_io: Pointer to MC portal's I/O object
125 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
126 * @token: Token of DPBP object
128 * Return: '0' on Success; error code otherwise.
130 int dpbp_destroy(struct fsl_mc_io *mc_io,
136 * dpbp_enable() - Enable the DPBP.
137 * @mc_io: Pointer to MC portal's I/O object
138 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
139 * @token: Token of DPBP object
141 * Return: '0' on Success; Error code otherwise.
143 int dpbp_enable(struct fsl_mc_io *mc_io,
148 * dpbp_disable() - Disable the DPBP.
149 * @mc_io: Pointer to MC portal's I/O object
150 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
151 * @token: Token of DPBP object
153 * Return: '0' on Success; Error code otherwise.
155 int dpbp_disable(struct fsl_mc_io *mc_io,
160 * dpbp_is_enabled() - Check if the DPBP is enabled.
161 * @mc_io: Pointer to MC portal's I/O object
162 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
163 * @token: Token of DPBP object
164 * @en: Returns '1' if object is enabled; '0' otherwise
166 * Return: '0' on Success; Error code otherwise.
168 int dpbp_is_enabled(struct fsl_mc_io *mc_io,
174 * dpbp_reset() - Reset the DPBP, returns the object to initial state.
175 * @mc_io: Pointer to MC portal's I/O object
176 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
177 * @token: Token of DPBP object
179 * Return: '0' on Success; Error code otherwise.
181 int dpbp_reset(struct fsl_mc_io *mc_io,
187 * struct dpbp_attr - Structure representing DPBP attributes
188 * @id: DPBP object ID
189 * @version: DPBP version
190 * @bpid: Hardware buffer pool ID; should be used as an argument in
191 * acquire/release operations on buffers
199 * dpbp_get_attributes - Retrieve DPBP attributes.
201 * @mc_io: Pointer to MC portal's I/O object
202 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
203 * @token: Token of DPBP object
204 * @attr: Returned object's attributes
206 * Return: '0' on Success; Error code otherwise.
208 int dpbp_get_attributes(struct fsl_mc_io *mc_io,
211 struct dpbp_attr *attr);
214 * dpbp_get_api_version - Retrieve DPBP Major and Minor version info.
216 * @mc_io: Pointer to MC portal's I/O object
217 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
218 * @major_ver: DPBP major version
219 * @minor_ver: DPBP minor version
221 * Return: '0' on Success; Error code otherwise.
223 int dpbp_get_api_version(struct fsl_mc_io *mc_io,
230 #endif /* __FSL_DPBP_H */