1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
3 * Copyright 2013-2016 Freescale Semiconductor Inc.
6 #include <fsl_mc_sys.h>
7 #include <fsl_mc_cmd.h>
9 #include <fsl_dpci_cmd.h>
12 * dpci_open() - Open a control session for the specified object
13 * @mc_io: Pointer to MC portal's I/O object
14 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
15 * @dpci_id: DPCI unique ID
16 * @token: Returned token; use in subsequent API calls
18 * This function can be used to open a control session for an
19 * already created object; an object may have been declared in
20 * the DPL or by calling the dpci_create() function.
21 * This function returns a unique authentication token,
22 * associated with the specific object ID and the specific MC
23 * portal; this token must be used in all subsequent commands for
24 * this specific object.
26 * Return: '0' on Success; Error code otherwise.
28 int dpci_open(struct fsl_mc_io
*mc_io
,
33 struct dpci_cmd_open
*cmd_params
;
34 struct mc_command cmd
= { 0 };
38 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_OPEN
,
41 cmd_params
= (struct dpci_cmd_open
*)cmd
.params
;
42 cmd_params
->dpci_id
= cpu_to_le32(dpci_id
);
44 /* send command to mc*/
45 err
= mc_send_command(mc_io
, &cmd
);
49 /* retrieve response parameters */
50 *token
= mc_cmd_hdr_read_token(&cmd
);
56 * dpci_close() - Close the control session of the object
57 * @mc_io: Pointer to MC portal's I/O object
58 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
59 * @token: Token of DPCI object
61 * After this function is called, no further operations are
62 * allowed on the object without opening a new control session.
64 * Return: '0' on Success; Error code otherwise.
66 int dpci_close(struct fsl_mc_io
*mc_io
,
70 struct mc_command cmd
= { 0 };
73 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_CLOSE
,
77 /* send command to mc*/
78 return mc_send_command(mc_io
, &cmd
);
82 * dpci_create() - Create the DPCI object.
83 * @mc_io: Pointer to MC portal's I/O object
84 * @dprc_token: Parent container token; '0' for default container
85 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
86 * @cfg: Configuration structure
87 * @obj_id: Returned object id
89 * Create the DPCI object, allocate required resources and perform required
92 * The object can be created either by declaring it in the
93 * DPL file, or by calling this function.
95 * The function accepts an authentication token of a parent
96 * container that this object should be assigned to. The token
97 * can be '0' so the object will be assigned to the default container.
98 * The newly created object can be opened with the returned
99 * object id and using the container's associated tokens and MC portals.
101 * Return: '0' on Success; Error code otherwise.
103 int dpci_create(struct fsl_mc_io
*mc_io
,
106 const struct dpci_cfg
*cfg
,
109 struct dpci_cmd_create
*cmd_params
;
110 struct mc_command cmd
= { 0 };
113 /* prepare command */
114 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_CREATE
,
117 cmd_params
= (struct dpci_cmd_create
*)cmd
.params
;
118 cmd_params
->num_of_priorities
= cfg
->num_of_priorities
;
120 /* send command to mc*/
121 err
= mc_send_command(mc_io
, &cmd
);
125 /* retrieve response parameters */
126 *obj_id
= mc_cmd_read_object_id(&cmd
);
132 * dpci_destroy() - Destroy the DPCI object and release all its resources.
133 * @mc_io: Pointer to MC portal's I/O object
134 * @dprc_token: Parent container token; '0' for default container
135 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
136 * @object_id: The object id; it must be a valid id within the container that
137 * created this object;
139 * The function accepts the authentication token of the parent container that
140 * created the object (not the one that currently owns the object). The object
141 * is searched within parent using the provided 'object_id'.
142 * All tokens to the object must be closed before calling destroy.
144 * Return: '0' on Success; error code otherwise.
146 int dpci_destroy(struct fsl_mc_io
*mc_io
,
151 struct dpci_cmd_destroy
*cmd_params
;
152 struct mc_command cmd
= { 0 };
154 /* prepare command */
155 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_DESTROY
,
158 cmd_params
= (struct dpci_cmd_destroy
*)cmd
.params
;
159 cmd_params
->dpci_id
= cpu_to_le32(object_id
);
161 /* send command to mc*/
162 return mc_send_command(mc_io
, &cmd
);
166 * dpci_enable() - Enable the DPCI, allow sending and receiving frames.
167 * @mc_io: Pointer to MC portal's I/O object
168 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
169 * @token: Token of DPCI object
171 * Return: '0' on Success; Error code otherwise.
173 int dpci_enable(struct fsl_mc_io
*mc_io
,
177 struct mc_command cmd
= { 0 };
179 /* prepare command */
180 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_ENABLE
,
184 /* send command to mc*/
185 return mc_send_command(mc_io
, &cmd
);
189 * dpci_disable() - Disable the DPCI, stop sending and receiving frames.
190 * @mc_io: Pointer to MC portal's I/O object
191 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
192 * @token: Token of DPCI object
194 * Return: '0' on Success; Error code otherwise.
196 int dpci_disable(struct fsl_mc_io
*mc_io
,
200 struct mc_command cmd
= { 0 };
202 /* prepare command */
203 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_DISABLE
,
207 /* send command to mc*/
208 return mc_send_command(mc_io
, &cmd
);
212 * dpci_is_enabled() - Check if the DPCI is enabled.
213 * @mc_io: Pointer to MC portal's I/O object
214 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
215 * @token: Token of DPCI object
216 * @en: Returns '1' if object is enabled; '0' otherwise
218 * Return: '0' on Success; Error code otherwise.
220 int dpci_is_enabled(struct fsl_mc_io
*mc_io
,
225 struct dpci_rsp_is_enabled
*rsp_params
;
226 struct mc_command cmd
= { 0 };
229 /* prepare command */
230 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_IS_ENABLED
, cmd_flags
,
233 /* send command to mc*/
234 err
= mc_send_command(mc_io
, &cmd
);
238 /* retrieve response parameters */
239 rsp_params
= (struct dpci_rsp_is_enabled
*)cmd
.params
;
240 *en
= dpci_get_field(rsp_params
->en
, ENABLE
);
246 * dpci_reset() - Reset the DPCI, returns the object to initial state.
247 * @mc_io: Pointer to MC portal's I/O object
248 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
249 * @token: Token of DPCI object
251 * Return: '0' on Success; Error code otherwise.
253 int dpci_reset(struct fsl_mc_io
*mc_io
,
257 struct mc_command cmd
= { 0 };
259 /* prepare command */
260 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_RESET
,
264 /* send command to mc*/
265 return mc_send_command(mc_io
, &cmd
);
268 int dpci_get_attributes(struct fsl_mc_io
*mc_io
,
271 struct dpci_attr
*attr
)
273 struct dpci_rsp_get_attr
*rsp_params
;
274 struct mc_command cmd
= { 0 };
277 /* prepare command */
278 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_GET_ATTR
,
282 /* send command to mc*/
283 err
= mc_send_command(mc_io
, &cmd
);
287 /* retrieve response parameters */
288 rsp_params
= (struct dpci_rsp_get_attr
*)cmd
.params
;
289 attr
->id
= le32_to_cpu(rsp_params
->id
);
290 attr
->num_of_priorities
= rsp_params
->num_of_priorities
;
295 int dpci_set_rx_queue(struct fsl_mc_io
*mc_io
,
299 const struct dpci_rx_queue_cfg
*cfg
)
301 struct dpci_cmd_set_rx_queue
*cmd_params
;
302 struct mc_command cmd
= { 0 };
304 /* prepare command */
305 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_SET_RX_QUEUE
,
308 cmd_params
= (struct dpci_cmd_set_rx_queue
*)cmd
.params
;
309 cmd_params
->dest_id
= cpu_to_le32(cfg
->dest_cfg
.dest_id
);
310 cmd_params
->dest_priority
= cfg
->dest_cfg
.priority
;
311 cmd_params
->priority
= priority
;
312 cmd_params
->user_ctx
= cpu_to_le64(cfg
->user_ctx
);
313 cmd_params
->options
= cpu_to_le32(cfg
->options
);
314 dpci_set_field(cmd_params
->dest_type
,
316 cfg
->dest_cfg
.dest_type
);
318 /* send command to mc*/
319 return mc_send_command(mc_io
, &cmd
);
323 * dpci_get_rx_queue() - Retrieve Rx queue attributes.
324 * @mc_io: Pointer to MC portal's I/O object
325 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
326 * @token: Token of DPCI object
327 * @priority: Select the queue relative to number of
328 * priorities configured at DPCI creation
329 * @attr: Returned Rx queue attributes
331 * Return: '0' on Success; Error code otherwise.
333 int dpci_get_rx_queue(struct fsl_mc_io
*mc_io
,
337 struct dpci_rx_queue_attr
*attr
)
339 struct dpci_cmd_get_queue
*cmd_params
;
340 struct dpci_rsp_get_rx_queue
*rsp_params
;
341 struct mc_command cmd
= { 0 };
344 /* prepare command */
345 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_GET_RX_QUEUE
,
348 cmd_params
= (struct dpci_cmd_get_queue
*)cmd
.params
;
349 cmd_params
->priority
= priority
;
351 /* send command to mc*/
352 err
= mc_send_command(mc_io
, &cmd
);
356 /* retrieve response parameters */
357 rsp_params
= (struct dpci_rsp_get_rx_queue
*)cmd
.params
;
358 attr
->user_ctx
= le64_to_cpu(rsp_params
->user_ctx
);
359 attr
->fqid
= le32_to_cpu(rsp_params
->fqid
);
360 attr
->dest_cfg
.dest_id
= le32_to_cpu(rsp_params
->dest_id
);
361 attr
->dest_cfg
.priority
= rsp_params
->dest_priority
;
362 attr
->dest_cfg
.dest_type
= dpci_get_field(rsp_params
->dest_type
,
369 * dpci_get_tx_queue() - Retrieve Tx queue attributes.
370 * @mc_io: Pointer to MC portal's I/O object
371 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
372 * @token: Token of DPCI object
373 * @priority: Select the queue relative to number of
374 * priorities of the peer DPCI object
375 * @attr: Returned Tx queue attributes
377 * Return: '0' on Success; Error code otherwise.
379 int dpci_get_tx_queue(struct fsl_mc_io
*mc_io
,
383 struct dpci_tx_queue_attr
*attr
)
385 struct dpci_cmd_get_queue
*cmd_params
;
386 struct dpci_rsp_get_tx_queue
*rsp_params
;
387 struct mc_command cmd
= { 0 };
390 /* prepare command */
391 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_GET_TX_QUEUE
,
394 cmd_params
= (struct dpci_cmd_get_queue
*)cmd
.params
;
395 cmd_params
->priority
= priority
;
397 /* send command to mc*/
398 err
= mc_send_command(mc_io
, &cmd
);
402 /* retrieve response parameters */
403 rsp_params
= (struct dpci_rsp_get_tx_queue
*)cmd
.params
;
404 attr
->fqid
= le32_to_cpu(rsp_params
->fqid
);
410 * dpci_get_api_version() - Get communication interface API version
411 * @mc_io: Pointer to MC portal's I/O object
412 * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
413 * @major_ver: Major version of data path communication interface API
414 * @minor_ver: Minor version of data path communication interface API
416 * Return: '0' on Success; Error code otherwise.
418 int dpci_get_api_version(struct fsl_mc_io
*mc_io
,
423 struct dpci_rsp_get_api_version
*rsp_params
;
424 struct mc_command cmd
= { 0 };
427 cmd
.header
= mc_encode_cmd_header(DPCI_CMDID_GET_API_VERSION
,
431 err
= mc_send_command(mc_io
, &cmd
);
435 rsp_params
= (struct dpci_rsp_get_api_version
*)cmd
.params
;
436 *major_ver
= le16_to_cpu(rsp_params
->major
);
437 *minor_ver
= le16_to_cpu(rsp_params
->minor
);