af81d51195444fe0f0a0cc187f349f7a1ff08a86
[dpdk.git] / drivers / bus / fslmc / mc / fsl_dpcon.h
1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
2  *
3  * Copyright 2013-2016 Freescale Semiconductor Inc.
4  * Copyright 2017-2019 NXP
5  *
6  */
7 #ifndef __FSL_DPCON_H
8 #define __FSL_DPCON_H
9
10 /* Data Path Concentrator API
11  * Contains initialization APIs and runtime control APIs for DPCON
12  */
13
14 struct fsl_mc_io;
15
16 /** General DPCON macros */
17
18 /**
19  * Use it to disable notifications; see dpcon_set_notification()
20  */
21 #define DPCON_INVALID_DPIO_ID           (int)(-1)
22
23 int dpcon_open(struct fsl_mc_io *mc_io,
24                uint32_t cmd_flags,
25                int dpcon_id,
26                uint16_t *token);
27
28 int dpcon_close(struct fsl_mc_io *mc_io,
29                 uint32_t cmd_flags,
30                 uint16_t token);
31
32 /**
33  * struct dpcon_cfg - Structure representing DPCON configuration
34  * @num_priorities: Number of priorities for the DPCON channel (1-8)
35  */
36 struct dpcon_cfg {
37         uint8_t num_priorities;
38 };
39
40 int dpcon_create(struct fsl_mc_io *mc_io,
41                  uint16_t dprc_token,
42                  uint32_t cmd_flags,
43                  const struct dpcon_cfg *cfg,
44                  uint32_t *obj_id);
45
46 int dpcon_destroy(struct fsl_mc_io *mc_io,
47                   uint16_t dprc_token,
48                   uint32_t cmd_flags,
49                   uint32_t obj_id);
50
51 int dpcon_enable(struct fsl_mc_io *mc_io,
52                  uint32_t cmd_flags,
53                  uint16_t token);
54
55 int dpcon_disable(struct fsl_mc_io *mc_io,
56                   uint32_t cmd_flags,
57                   uint16_t token);
58
59 int dpcon_is_enabled(struct fsl_mc_io *mc_io,
60                      uint32_t cmd_flags,
61                      uint16_t token,
62                      int *en);
63
64 int dpcon_reset(struct fsl_mc_io *mc_io,
65                 uint32_t cmd_flags,
66                 uint16_t token);
67
68 /**
69  * struct dpcon_attr - Structure representing DPCON attributes
70  * @id:                 DPCON object ID
71  * @qbman_ch_id:        Channel ID to be used by dequeue operation
72  * @num_priorities:     Number of priorities for the DPCON channel (1-8)
73  */
74 struct dpcon_attr {
75         int id;
76         uint16_t qbman_ch_id;
77         uint8_t num_priorities;
78 };
79
80 int dpcon_get_attributes(struct fsl_mc_io *mc_io,
81                          uint32_t cmd_flags,
82                          uint16_t token,
83                          struct dpcon_attr *attr);
84
85 int dpcon_get_api_version(struct fsl_mc_io *mc_io,
86                           uint32_t cmd_flags,
87                           uint16_t *major_ver,
88                           uint16_t *minor_ver);
89
90 #endif /* __FSL_DPCON_H */