dpdmai.h 6.1 KB

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