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