drivers/dma/fsl-dpaa2-qdma/dpdmai.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright 2019 NXP */
   3
   4 #ifndef __FSL_DPDMAI_H
   5 #define __FSL_DPDMAI_H
   6
   7 /* DPDMAI Version */
   8 #define DPDMAI_VER_MAJOR        3
   9 #define DPDMAI_VER_MINOR        3
  10
  11 #define DPDMAI_CMD_BASE_VERSION 1
  12 #define DPDMAI_CMD_ID_OFFSET    4
  13
  14 /*
  15  * Maximum number of Tx/Rx queues per DPDMAI object
  16  */
  17 #define DPDMAI_MAX_QUEUE_NUM    8
  18
  19 #define DPDMAI_CMDID_FORMAT_V(x, v)     (((x) << DPDMAI_CMD_ID_OFFSET) | (v))
  20 #define DPDMAI_CMDID_FORMAT(x)          DPDMAI_CMDID_FORMAT_V(x, DPDMAI_CMD_BASE_VERSION)
  21
  22 /* Command IDs */
  23 #define DPDMAI_CMDID_CLOSE              DPDMAI_CMDID_FORMAT(0x800)
  24 #define DPDMAI_CMDID_OPEN               DPDMAI_CMDID_FORMAT(0x80E)
  25 #define DPDMAI_CMDID_CREATE             DPDMAI_CMDID_FORMAT(0x90E)
  26 #define DPDMAI_CMDID_DESTROY            DPDMAI_CMDID_FORMAT(0x900)
  27
  28 #define DPDMAI_CMDID_ENABLE             DPDMAI_CMDID_FORMAT(0x002)
  29 #define DPDMAI_CMDID_DISABLE            DPDMAI_CMDID_FORMAT(0x003)
  30 #define DPDMAI_CMDID_GET_ATTR           DPDMAI_CMDID_FORMAT(0x004)
  31 #define DPDMAI_CMDID_RESET              DPDMAI_CMDID_FORMAT(0x005)
  32 #define DPDMAI_CMDID_IS_ENABLED         DPDMAI_CMDID_FORMAT(0x006)
  33
  34 #define DPDMAI_CMDID_SET_RX_QUEUE       DPDMAI_CMDID_FORMAT_V(0x1A0, 2)
  35 #define DPDMAI_CMDID_GET_RX_QUEUE       DPDMAI_CMDID_FORMAT_V(0x1A1, 2)
  36 #define DPDMAI_CMDID_GET_TX_QUEUE       DPDMAI_CMDID_FORMAT_V(0x1A2, 2)
  37
  38 #define MC_CMD_HDR_TOKEN_O 32  /* Token field offset */
  39 #define MC_CMD_HDR_TOKEN_S 16  /* Token field size */
  40
  41 #define MAKE_UMASK64(_width) \
  42         ((u64)((_width) < 64 ? ((u64)1 << (_width)) - 1 : (u64)-1))
  43
  44 /* Data Path DMA Interface API
  45  * Contains initialization APIs and runtime control APIs for DPDMAI
  46  */
  47
  48 /*
  49  * Maximum number of Tx/Rx priorities per DPDMAI object
  50  */
  51 #define DPDMAI_PRIO_NUM         2
  52
  53 /* DPDMAI queue modification options */
  54
  55 /*
  56  * Select to modify the user's context associated with the queue
  57  */
  58 #define DPDMAI_QUEUE_OPT_USER_CTX       0x1
  59
  60 /*
  61  * Select to modify the queue's destination
  62  */
  63 #define DPDMAI_QUEUE_OPT_DEST           0x2
  64
  65 /**
  66  * struct dpdmai_cfg - Structure representing DPDMAI configuration
  67  * @num_queues: Number of the DMA queues
  68  * @priorities: Priorities for the DMA hardware processing; valid priorities are
  69  *      configured with values 1-8; the entry following last valid entry
  70  *      should be configured with 0
  71  */
  72 struct dpdmai_cfg {
  73         u8 num_queues;
  74         u8 priorities[DPDMAI_PRIO_NUM];
  75 };
  76
  77 /**
  78  * struct dpdmai_attr - Structure representing DPDMAI attributes
  79  * @id: DPDMAI object ID
  80  * @version: DPDMAI version
  81  * @version.major: DPDMAI major version
  82  * @version.minor: DPDMAI minor version
  83  * @num_of_priorities: number of priorities
  84  * @num_of_queues: number of the DMA queues
  85  */
  86 struct dpdmai_attr {
  87         int     id;
  88         struct {
  89                 u16 major;
  90                 u16 minor;
  91         } version;
  92         u8 num_of_priorities;
  93         u8 num_of_queues;
  94 };
  95
  96 /**
  97  * enum dpdmai_dest - DPDMAI destination types
  98  * @DPDMAI_DEST_NONE: Unassigned destination; The queue is set in parked mode
  99  *      and does not generate FQDAN notifications; user is expected to dequeue
 100  *      from the queue based on polling or other user-defined method
 101  * @DPDMAI_DEST_DPIO: The queue is set in schedule mode and generates FQDAN
 102  *      notifications to the specified DPIO; user is expected to dequeue
 103  *      from the queue only after notification is received
 104  * @DPDMAI_DEST_DPCON: The queue is set in schedule mode and does not generate
 105  *      FQDAN notifications, but is connected to the specified DPCON object;
 106  *      user is expected to dequeue from the DPCON channel
 107  */
 108 enum dpdmai_dest {
 109         DPDMAI_DEST_NONE = 0,
 110         DPDMAI_DEST_DPIO = 1,
 111         DPDMAI_DEST_DPCON = 2
 112 };
 113
 114 /**
 115  * struct dpdmai_dest_cfg - Structure representing DPDMAI destination parameters
 116  * @dest_type: Destination type
 117  * @dest_id: Either DPIO ID or DPCON ID, depending on the destination type
 118  * @priority: Priority selection within the DPIO or DPCON channel; valid values
 119  *      are 0-1 or 0-7, depending on the number of priorities in that
 120  *      channel; not relevant for 'DPDMAI_DEST_NONE' option
 121  */
 122 struct dpdmai_dest_cfg {
 123         enum dpdmai_dest dest_type;
 124         int dest_id;
 125         u8 priority;
 126 };
 127
 128 /**
 129  * struct dpdmai_rx_queue_cfg - DPDMAI RX queue configuration
 130  * @options: Flags representing the suggested modifications to the queue;
 131  *      Use any combination of 'DPDMAI_QUEUE_OPT_<X>' flags
 132  * @user_ctx: User context value provided in the frame descriptor of each
 133  *      dequeued frame;
 134  *      valid only if 'DPDMAI_QUEUE_OPT_USER_CTX' is contained in 'options'
 135  * @dest_cfg: Queue destination parameters;
 136  *      valid only if 'DPDMAI_QUEUE_OPT_DEST' is contained in 'options'
 137  */
 138 struct dpdmai_rx_queue_cfg {
 139         struct dpdmai_dest_cfg dest_cfg;
 140         u32 options;
 141         u64 user_ctx;
 142
 143 };
 144
 145 /**
 146  * struct dpdmai_rx_queue_attr - Structure representing attributes of Rx queues
 147  * @user_ctx:  User context value provided in the frame descriptor of each
 148  *       dequeued frame
 149  * @dest_cfg: Queue destination configuration
 150  * @fqid: Virtual FQID value to be used for dequeue operations
 151  */
 152 struct dpdmai_rx_queue_attr {
 153         struct dpdmai_dest_cfg  dest_cfg;
 154         u64 user_ctx;
 155         u32 fqid;
 156 };
 157
 158 struct dpdmai_tx_queue_attr {
 159         u32 fqid;
 160 };
 161
 162 int dpdmai_open(struct fsl_mc_io *mc_io, u32 cmd_flags,
 163                 int dpdmai_id, u16 *token);
 164 int dpdmai_close(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token);
 165 int dpdmai_destroy(struct fsl_mc_io *mc_io, u32 cmd_flags, u32 dpdmai_id, u16 token);
 166 int dpdmai_enable(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token);
 167 int dpdmai_disable(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token);
 168 int dpdmai_reset(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token);
 169 int dpdmai_get_attributes(struct fsl_mc_io *mc_io, u32 cmd_flags,
 170                           u16 token, struct dpdmai_attr *attr);
 171 int dpdmai_set_rx_queue(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token,
 172                         u8 queue_idx, u8 priority, const struct dpdmai_rx_queue_cfg *cfg);
 173 int dpdmai_get_rx_queue(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token,
 174                         u8 queue_idx, u8 priority, struct dpdmai_rx_queue_attr *attr);
 175 int dpdmai_get_tx_queue(struct fsl_mc_io *mc_io, u32 cmd_flags,
 176                         u16 token, u8 queue_idx, u8 priority, struct dpdmai_tx_queue_attr *attr);
 177
 178 #endif /* __FSL_DPDMAI_H */