hw_fence_drv_priv.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  4. */
  5. #ifndef __HW_FENCE_DRV_INTERNAL_H
  6. #define __HW_FENCE_DRV_INTERNAL_H
  7. #include <linux/kernel.h>
  8. #include <linux/device.h>
  9. #include <linux/types.h>
  10. #include <linux/dma-mapping.h>
  11. #include <linux/soc/qcom/msm_hw_fence.h>
  12. #include <linux/dma-fence-array.h>
  13. #include <linux/slab.h>
  14. /* Add define only for platforms that support IPCC in dpu-hw */
  15. #define HW_DPU_IPCC 1
  16. /* max u64 to indicate invalid fence */
  17. #define HW_FENCE_INVALID_PARENT_FENCE (~0ULL)
  18. /* hash algorithm constants */
  19. #define HW_FENCE_HASH_A_MULT 4969 /* a multiplier for Hash algorithm */
  20. #define HW_FENCE_HASH_C_MULT 907 /* c multiplier for Hash algorithm */
  21. /* number of queues per type (i.e. ctrl or client queues) */
  22. #define HW_FENCE_CTRL_QUEUES 2 /* Rx and Tx Queues */
  23. #define HW_FENCE_CLIENT_QUEUES 2 /* Rx and Tx Queues */
  24. /* hfi headers calculation */
  25. #define HW_FENCE_HFI_TABLE_HEADER_SIZE (sizeof(struct msm_hw_fence_hfi_queue_table_header))
  26. #define HW_FENCE_HFI_QUEUE_HEADER_SIZE (sizeof(struct msm_hw_fence_hfi_queue_header))
  27. #define HW_FENCE_HFI_CTRL_HEADERS_SIZE (HW_FENCE_HFI_TABLE_HEADER_SIZE + \
  28. (HW_FENCE_HFI_QUEUE_HEADER_SIZE * HW_FENCE_CTRL_QUEUES))
  29. #define HW_FENCE_HFI_CLIENT_HEADERS_SIZE(queues_num) (HW_FENCE_HFI_TABLE_HEADER_SIZE + \
  30. (HW_FENCE_HFI_QUEUE_HEADER_SIZE * queues_num))
  31. /*
  32. * Max Payload size is the bigest size of the message that we can have in the CTRL queue
  33. * in this case the max message is calculated like following, using 32-bits elements:
  34. * 1 header + 1 msg-type + 1 client_id + 2 hash + 1 error
  35. */
  36. #define HW_FENCE_CTRL_QUEUE_MAX_PAYLOAD_SIZE ((1 + 1 + 1 + 2 + 1) * sizeof(u32))
  37. #define HW_FENCE_CTRL_QUEUE_PAYLOAD HW_FENCE_CTRL_QUEUE_MAX_PAYLOAD_SIZE
  38. #define HW_FENCE_CLIENT_QUEUE_PAYLOAD (sizeof(struct msm_hw_fence_queue_payload))
  39. /* Locks area for all clients with RxQ */
  40. #define HW_FENCE_MEM_LOCKS_SIZE(rxq_clients_num) (sizeof(u64) * rxq_clients_num)
  41. #define HW_FENCE_TX_QUEUE 1
  42. #define HW_FENCE_RX_QUEUE 2
  43. /* ClientID for the internal join fence, this is used by the framework when creating a join-fence */
  44. #define HW_FENCE_JOIN_FENCE_CLIENT_ID (~(u32)0)
  45. /**
  46. * msm hw fence flags:
  47. * MSM_HW_FENCE_FLAG_SIGNAL - Flag set when the hw-fence is signaled
  48. */
  49. #define MSM_HW_FENCE_FLAG_SIGNAL BIT(0)
  50. /**
  51. * MSM_HW_FENCE_MAX_JOIN_PARENTS:
  52. * Maximum number of parents that a fence can have for a join-fence
  53. */
  54. #define MSM_HW_FENCE_MAX_JOIN_PARENTS 3
  55. /**
  56. * HW_FENCE_PAYLOAD_REV:
  57. * Payload version with major and minor version information
  58. */
  59. #define HW_FENCE_PAYLOAD_REV(major, minor) (major << 8 | (minor & 0xFF))
  60. enum hw_fence_lookup_ops {
  61. HW_FENCE_LOOKUP_OP_CREATE = 0x1,
  62. HW_FENCE_LOOKUP_OP_DESTROY,
  63. HW_FENCE_LOOKUP_OP_CREATE_JOIN,
  64. HW_FENCE_LOOKUP_OP_FIND_FENCE
  65. };
  66. /**
  67. * enum hw_fence_loopback_id - Enum with the clients having a loopback signal (i.e AP to AP signal).
  68. * HW_FENCE_LOOPBACK_DPU_CTL_0: dpu client 0. Used in platforms with no dpu-ipc.
  69. * HW_FENCE_LOOPBACK_DPU_CTL_1: dpu client 1. Used in platforms with no dpu-ipc.
  70. * HW_FENCE_LOOPBACK_DPU_CTL_2: dpu client 2. Used in platforms with no dpu-ipc.
  71. * HW_FENCE_LOOPBACK_DPU_CTL_3: dpu client 3. Used in platforms with no dpu-ipc.
  72. * HW_FENCE_LOOPBACK_DPU_CTL_4: dpu client 4. Used in platforms with no dpu-ipc.
  73. * HW_FENCE_LOOPBACK_DPU_CTL_5: dpu client 5. Used in platforms with no dpu-ipc.
  74. * HW_FENCE_LOOPBACK_DPU_CTX_0: gfx client 0. Used in platforms with no gmu support.
  75. * HW_FENCE_LOOPBACK_VAL_0: debug validation client 0.
  76. * HW_FENCE_LOOPBACK_VAL_1: debug validation client 1.
  77. * HW_FENCE_LOOPBACK_VAL_2: debug validation client 2.
  78. * HW_FENCE_LOOPBACK_VAL_3: debug validation client 3.
  79. * HW_FENCE_LOOPBACK_VAL_4: debug validation client 4.
  80. * HW_FENCE_LOOPBACK_VAL_5: debug validation client 5.
  81. * HW_FENCE_LOOPBACK_VAL_6: debug validation client 6.
  82. */
  83. enum hw_fence_loopback_id {
  84. HW_FENCE_LOOPBACK_DPU_CTL_0,
  85. HW_FENCE_LOOPBACK_DPU_CTL_1,
  86. HW_FENCE_LOOPBACK_DPU_CTL_2,
  87. HW_FENCE_LOOPBACK_DPU_CTL_3,
  88. HW_FENCE_LOOPBACK_DPU_CTL_4,
  89. HW_FENCE_LOOPBACK_DPU_CTL_5,
  90. HW_FENCE_LOOPBACK_GFX_CTX_0,
  91. #if IS_ENABLED(CONFIG_DEBUG_FS)
  92. HW_FENCE_LOOPBACK_VAL_0 = HW_FENCE_CLIENT_ID_VAL0,
  93. HW_FENCE_LOOPBACK_VAL_1,
  94. HW_FENCE_LOOPBACK_VAL_2,
  95. HW_FENCE_LOOPBACK_VAL_3,
  96. HW_FENCE_LOOPBACK_VAL_4,
  97. HW_FENCE_LOOPBACK_VAL_5,
  98. HW_FENCE_LOOPBACK_VAL_6,
  99. #endif /* CONFIG_DEBUG_FS */
  100. HW_FENCE_LOOPBACK_MAX,
  101. };
  102. #define HW_FENCE_MAX_DPU_LOOPBACK_CLIENTS (HW_FENCE_LOOPBACK_DPU_CTL_5 + 1)
  103. /**
  104. * enum hw_fence_client_data_id - Enum with the clients having client_data, an optional
  105. * parameter passed from the waiting client and returned
  106. * to it upon fence signaling. Only the first HW Fence
  107. * Client for non-VAL clients (e.g. GFX, IPE, VPU) have
  108. * client_data.
  109. * @HW_FENCE_CLIENT_DATA_ID_CTX0: GFX Client 0.
  110. * @HW_FENCE_CLIENT_DATA_ID_IPE: IPE Client 0.
  111. * @HW_FENCE_CLIENT_DATA_ID_VPU: VPU Client 0.
  112. * @HW_FENCE_CLIENT_DATA_ID_VAL0: Debug validation client 0.
  113. * @HW_FENCE_CLIENT_DATA_ID_VAL1: Debug validation client 1.
  114. * @HW_FENCE_MAX_CLIENTS_WITH_DATA: Max number of clients with data, also indicates an
  115. * invalid hw_fence_client_data_id
  116. */
  117. enum hw_fence_client_data_id {
  118. HW_FENCE_CLIENT_DATA_ID_CTX0,
  119. HW_FENCE_CLIENT_DATA_ID_IPE,
  120. HW_FENCE_CLIENT_DATA_ID_VPU,
  121. HW_FENCE_CLIENT_DATA_ID_VAL0,
  122. HW_FENCE_CLIENT_DATA_ID_VAL1,
  123. HW_FENCE_MAX_CLIENTS_WITH_DATA,
  124. };
  125. /**
  126. * struct msm_hw_fence_queue - Structure holding the data of the hw fence queues.
  127. * @va_queue: pointer to the virtual address of the queue elements
  128. * @q_size_bytes: size of the queue
  129. * @va_header: pointer to the hfi header virtual address
  130. * @pa_queue: physical address of the queue
  131. * @rd_wr_idx_start: start read and write indexes for client queue (zero by default)
  132. * @rd_wr_idx_factor: factor to multiply custom index to get index in dwords (one by default)
  133. * @skip_wr_idx: bool to indicate if update to write_index is skipped within hw fence driver and
  134. * hfi_header->tx_wm is updated instead
  135. */
  136. struct msm_hw_fence_queue {
  137. void *va_queue;
  138. u32 q_size_bytes;
  139. void *va_header;
  140. phys_addr_t pa_queue;
  141. u32 rd_wr_idx_start;
  142. u32 rd_wr_idx_factor;
  143. bool skip_wr_idx;
  144. };
  145. /**
  146. * enum payload_type - Enum with the queue payload types.
  147. */
  148. enum payload_type {
  149. HW_FENCE_PAYLOAD_TYPE_1 = 1
  150. };
  151. /**
  152. * struct msm_hw_fence_client - Structure holding the per-Client allocated resources.
  153. * @client_id: internal client_id used within HW fence driver; index into the clients struct
  154. * @client_id_ext: external client_id, equal to client_id except for clients with configurable
  155. * number of sub-clients (e.g. ife clients)
  156. * @mem_descriptor: hfi header memory descriptor
  157. * @queues: queues descriptor
  158. * @queues_num: number of client queues
  159. * @ipc_signal_id: id of the signal to be triggered for this client
  160. * @ipc_client_vid: virtual id of the ipc client for this hw fence driver client
  161. * @ipc_client_pid: physical id of the ipc client for this hw fence driver client
  162. * @update_rxq: bool to indicate if client uses rx-queue
  163. * @send_ipc: bool to indicate if client requires ipc interrupt for already signaled fences
  164. * @wait_queue: wait queue for the validation clients
  165. * @val_signal: doorbell flag to signal the validation clients in the wait queue
  166. */
  167. struct msm_hw_fence_client {
  168. enum hw_fence_client_id client_id;
  169. enum hw_fence_client_id client_id_ext;
  170. struct msm_hw_fence_mem_addr mem_descriptor;
  171. struct msm_hw_fence_queue queues[HW_FENCE_CLIENT_QUEUES];
  172. int queues_num;
  173. int ipc_signal_id;
  174. int ipc_client_vid;
  175. int ipc_client_pid;
  176. bool update_rxq;
  177. bool send_ipc;
  178. #if IS_ENABLED(CONFIG_DEBUG_FS)
  179. wait_queue_head_t wait_queue;
  180. atomic_t val_signal;
  181. #endif /* CONFIG_DEBUG_FS */
  182. };
  183. /**
  184. * struct msm_hw_fence_mem_data - Structure holding internal memory attributes
  185. *
  186. * @attrs: attributes for the memory allocation
  187. */
  188. struct msm_hw_fence_mem_data {
  189. unsigned long attrs;
  190. };
  191. /**
  192. * struct msm_hw_fence_dbg_data - Structure holding debugfs data
  193. *
  194. * @root: debugfs root
  195. * @entry_rd: flag to indicate if debugfs dumps a single line or table
  196. * @context_rd: debugfs setting to indicate which context id to dump
  197. * @seqno_rd: debugfs setting to indicate which seqno to dump
  198. * @hw_fence_sim_release_delay: delay in micro seconds for the debugfs node that simulates the
  199. * hw-fences behavior, to release the hw-fences
  200. * @create_hw_fences: boolean to continuosly create hw-fences within debugfs
  201. * @clients_list: list of debug clients registered
  202. * @clients_list_lock: lock to synchronize access to the clients list
  203. * @lock_wake_cnt: number of times that driver triggers wake-up ipcc to unlock inter-vm try-lock
  204. */
  205. struct msm_hw_fence_dbg_data {
  206. struct dentry *root;
  207. bool entry_rd;
  208. u64 context_rd;
  209. u64 seqno_rd;
  210. u32 hw_fence_sim_release_delay;
  211. bool create_hw_fences;
  212. struct list_head clients_list;
  213. struct mutex clients_list_lock;
  214. u64 lock_wake_cnt;
  215. };
  216. /**
  217. * struct hw_fence_client_type_desc - Structure holding client type properties, including static
  218. * properties and client queue properties read from device-tree.
  219. *
  220. * @name: name of client type, used to parse properties from device-tree
  221. * @init_id: initial client_id for given client type within the 'hw_fence_client_id' enum, e.g.
  222. * HW_FENCE_CLIENT_ID_CTL0 for DPU clients
  223. * @max_clients_num: maximum number of clients of given client type
  224. * @clients_num: number of clients of given client type
  225. * @queues_num: number of queues per client of given client type; either one (for only Tx Queue) or
  226. * two (for both Tx and Rx Queues)
  227. * @queue_entries: number of entries per client queue of given client type
  228. * @start_padding: size of padding between queue table header and first queue header in bytes
  229. * @end_padding: size of padding between queue header(s) and first queue payload in bytes
  230. * @mem_size: size of memory allocated for client queue(s) per client in bytes
  231. * @txq_idx_start: start read and write indexes for client tx queue (zero by default)
  232. * @txq_idx_factor: factor to multiply custom TxQ idx to get index in dwords (one by default)
  233. * @skip_txq_wr_idx: bool to indicate if update to tx queue write_index is skipped within hw fence
  234. * driver and hfi_header->tx_wm is updated instead
  235. */
  236. struct hw_fence_client_type_desc {
  237. char *name;
  238. enum hw_fence_client_id init_id;
  239. u32 max_clients_num;
  240. u32 clients_num;
  241. u32 queues_num;
  242. u32 queue_entries;
  243. u32 start_padding;
  244. u32 end_padding;
  245. u32 mem_size;
  246. u32 txq_idx_start;
  247. u32 txq_idx_factor;
  248. bool skip_txq_wr_idx;
  249. };
  250. /**
  251. * struct hw_fence_client_queue_desc - Structure holding client queue properties for a client.
  252. *
  253. * @type: pointer to client queue properties of client type
  254. * @start_offset: start offset of client queue memory region, from beginning of carved-out memory
  255. * allocation for hw fence driver
  256. */
  257. struct hw_fence_client_queue_desc {
  258. struct hw_fence_client_type_desc *type;
  259. u32 start_offset;
  260. };
  261. /**
  262. * struct hw_fence_driver_data - Structure holding internal hw-fence driver data
  263. *
  264. * @dev: device driver pointer
  265. * @resources_ready: value set by driver at end of probe, once all resources are ready
  266. * @hw_fence_table_entries: total number of hw-fences in the global table
  267. * @hw_fence_mem_fences_table_size: hw-fences global table total size
  268. * @hw_fence_queue_entries: total number of entries that can be available in the queue
  269. * @hw_fence_ctrl_queue_size: size of the ctrl queue for the payload
  270. * @hw_fence_mem_ctrl_queues_size: total size of ctrl queues, including: header + rxq + txq
  271. * @hw_fence_client_queue_size: descriptors of client queue properties for each hw fence client
  272. * @hw_fence_client_types: descriptors of properties for each hw fence client type
  273. * @rxq_clients_num: number of supported hw fence clients with rxq (configured based on device-tree)
  274. * @clients_num: number of supported hw fence clients (configured based on device-tree)
  275. * @hw_fences_tbl: pointer to the hw-fences table
  276. * @hw_fences_tbl_cnt: number of elements in the hw-fence table
  277. * @client_lock_tbl: pointer to the per-client locks table
  278. * @client_lock_tbl_cnt: number of elements in the locks table
  279. * @hw_fences_mem_desc: memory descriptor for the hw-fence table
  280. * @clients_locks_mem_desc: memory descriptor for the locks table
  281. * @ctrl_queue_mem_desc: memory descriptor for the ctrl queues
  282. * @ctrl_queues: pointer to the ctrl queues
  283. * @io_mem_base: pointer to the carved-out io memory
  284. * @res: resources for the carved out memory
  285. * @size: size of the carved-out memory
  286. * @label: label for the carved-out memory (this is used by SVM to find the memory)
  287. * @peer_name: peer name for this carved-out memory
  288. * @rm_nb: hyp resource manager notifier
  289. * @memparcel: memparcel for the allocated memory
  290. * @used_mem_size: total memory size of global table, lock region, and ctrl and client queues
  291. * @db_label: doorbell label
  292. * @rx_dbl: handle to the Rx doorbell
  293. * @debugfs_data: debugfs info
  294. * @ipcc_reg_base: base for ipcc regs mapping
  295. * @ipcc_io_mem: base for the ipcc io mem map
  296. * @ipcc_size: size of the ipcc io mem mapping
  297. * @protocol_id: ipcc protocol id used by this driver
  298. * @ipcc_client_vid: ipcc client virtual-id for this driver
  299. * @ipcc_client_pid: ipcc client physical-id for this driver
  300. * @ipc_clients_table: table with the ipcc mapping for each client of this driver
  301. * @qtime_reg_base: qtimer register base address
  302. * @qtime_io_mem: qtimer io mem map
  303. * @qtime_size: qtimer io mem map size
  304. * @ctl_start_ptr: pointer to the ctl_start registers of the display hw (platforms with no dpu-ipc)
  305. * @ctl_start_size: size of the ctl_start registers of the display hw (platforms with no dpu-ipc)
  306. * @client_id_mask: bitmask for tracking registered client_ids
  307. * @clients_register_lock: lock to synchronize clients registration and deregistration
  308. * @clients: table with the handles of the registered clients; size is equal to clients_num
  309. * @vm_ready: flag to indicate if vm has been initialized
  310. * @ipcc_dpu_initialized: flag to indicate if dpu hw is initialized
  311. */
  312. struct hw_fence_driver_data {
  313. struct device *dev;
  314. bool resources_ready;
  315. /* Table & Queues info */
  316. u32 hw_fence_table_entries;
  317. u32 hw_fence_mem_fences_table_size;
  318. u32 hw_fence_queue_entries;
  319. /* ctrl queues */
  320. u32 hw_fence_ctrl_queue_size;
  321. u32 hw_fence_mem_ctrl_queues_size;
  322. /* client queues */
  323. struct hw_fence_client_queue_desc *hw_fence_client_queue_size;
  324. struct hw_fence_client_type_desc *hw_fence_client_types;
  325. u32 rxq_clients_num;
  326. u32 clients_num;
  327. /* HW Fences Table VA */
  328. struct msm_hw_fence *hw_fences_tbl;
  329. u32 hw_fences_tbl_cnt;
  330. /* Table with a Per-Client Lock */
  331. u64 *client_lock_tbl;
  332. u32 client_lock_tbl_cnt;
  333. /* Memory Descriptors */
  334. struct msm_hw_fence_mem_addr hw_fences_mem_desc;
  335. struct msm_hw_fence_mem_addr clients_locks_mem_desc;
  336. struct msm_hw_fence_mem_addr ctrl_queue_mem_desc;
  337. struct msm_hw_fence_queue ctrl_queues[HW_FENCE_CTRL_QUEUES];
  338. /* carved out memory */
  339. void __iomem *io_mem_base;
  340. struct resource res;
  341. size_t size;
  342. u32 label;
  343. u32 peer_name;
  344. struct notifier_block rm_nb;
  345. u32 memparcel;
  346. u32 used_mem_size;
  347. /* doorbell */
  348. u32 db_label;
  349. /* VM virq */
  350. void *rx_dbl;
  351. /* debugfs */
  352. struct msm_hw_fence_dbg_data debugfs_data;
  353. /* ipcc regs */
  354. phys_addr_t ipcc_reg_base;
  355. void __iomem *ipcc_io_mem;
  356. uint32_t ipcc_size;
  357. u32 protocol_id;
  358. u32 ipcc_client_vid;
  359. u32 ipcc_client_pid;
  360. /* table with mapping of ipc client for each hw-fence client */
  361. struct hw_fence_client_ipc_map *ipc_clients_table;
  362. /* qtime reg */
  363. phys_addr_t qtime_reg_base;
  364. void __iomem *qtime_io_mem;
  365. uint32_t qtime_size;
  366. /* base address for dpu ctl start regs */
  367. void *ctl_start_ptr[HW_FENCE_MAX_DPU_LOOPBACK_CLIENTS];
  368. uint32_t ctl_start_size[HW_FENCE_MAX_DPU_LOOPBACK_CLIENTS];
  369. /* synchronize client_ids registration and deregistration */
  370. struct mutex clients_register_lock;
  371. /* table with registered client handles */
  372. struct msm_hw_fence_client **clients;
  373. bool vm_ready;
  374. #ifdef HW_DPU_IPCC
  375. /* state variables */
  376. bool ipcc_dpu_initialized;
  377. #endif /* HW_DPU_IPCC */
  378. };
  379. /**
  380. * struct msm_hw_fence_queue_payload - hardware fence clients queues payload.
  381. * @size: size of queue payload
  382. * @type: type of queue payload
  383. * @version: version of queue payload. High eight bits are for major and lower eight
  384. * bits are for minor version
  385. * @ctxt_id: context id of the dma fence
  386. * @seqno: sequence number of the dma fence
  387. * @hash: fence hash
  388. * @flags: see MSM_HW_FENCE_FLAG_* flags descriptions
  389. * @client_data: data passed from and returned to waiting client upon fence signaling
  390. * @error: error code for this fence, fence controller receives this
  391. * error from the signaling client through the tx queue and
  392. * propagates the error to the waiting client through rx queue
  393. * @timestamp_lo: low 32-bits of qtime of when the payload is written into the queue
  394. * @timestamp_hi: high 32-bits of qtime of when the payload is written into the queue
  395. */
  396. struct msm_hw_fence_queue_payload {
  397. u32 size;
  398. u16 type;
  399. u16 version;
  400. u64 ctxt_id;
  401. u64 seqno;
  402. u64 hash;
  403. u64 flags;
  404. u64 client_data;
  405. u32 error;
  406. u32 timestamp_lo;
  407. u32 timestamp_hi;
  408. u32 reserve;
  409. };
  410. /**
  411. * struct msm_hw_fence - structure holding each hw fence data.
  412. * @valid: field updated when a hw-fence is reserved. True if hw-fence is in use
  413. * @error: field to hold a hw-fence error
  414. * @ctx_id: context id
  415. * @seq_id: sequence id
  416. * @wait_client_mask: bitmask holding the waiting-clients of the fence
  417. * @fence_allocator: field to indicate the client_id that reserved the fence
  418. * @fence_signal-client:
  419. * @lock: this field is required to share information between the Driver & Driver ||
  420. * Driver & FenceCTL. Needs to be 64-bit atomic inter-processor lock.
  421. * @flags: field to indicate the state of the fence
  422. * @parent_list: list of indexes with the parents for a child-fence in a join-fence
  423. * @parent_cnt: total number of parents for a child-fence in a join-fence
  424. * @pending_child_cnt: children refcount for a parent-fence in a join-fence. Access must be atomic
  425. * or locked
  426. * @fence_create_time: debug info with the create time timestamp
  427. * @fence_trigger_time: debug info with the trigger time timestamp
  428. * @fence_wait_time: debug info with the register-for-wait timestamp
  429. * @debug_refcount: refcount used for debugging
  430. * @client_data: array of data optionally passed from and returned to clients waiting on the fence
  431. * during fence signaling
  432. */
  433. struct msm_hw_fence {
  434. u32 valid;
  435. u32 error;
  436. u64 ctx_id;
  437. u64 seq_id;
  438. u64 wait_client_mask;
  439. u32 fence_allocator;
  440. u32 fence_signal_client;
  441. u64 lock; /* Datatype must be 64-bit. */
  442. u64 flags;
  443. u64 parent_list[MSM_HW_FENCE_MAX_JOIN_PARENTS];
  444. u32 parents_cnt;
  445. u32 pending_child_cnt;
  446. u64 fence_create_time;
  447. u64 fence_trigger_time;
  448. u64 fence_wait_time;
  449. u64 debug_refcount;
  450. u64 client_data[HW_FENCE_MAX_CLIENTS_WITH_DATA];
  451. };
  452. int hw_fence_init(struct hw_fence_driver_data *drv_data);
  453. int hw_fence_alloc_client_resources(struct hw_fence_driver_data *drv_data,
  454. struct msm_hw_fence_client *hw_fence_client,
  455. struct msm_hw_fence_mem_addr *mem_descriptor);
  456. int hw_fence_init_controller_signal(struct hw_fence_driver_data *drv_data,
  457. struct msm_hw_fence_client *hw_fence_client);
  458. int hw_fence_init_controller_resources(struct msm_hw_fence_client *hw_fence_client);
  459. void hw_fence_cleanup_client(struct hw_fence_driver_data *drv_data,
  460. struct msm_hw_fence_client *hw_fence_client);
  461. void hw_fence_utils_reset_queues(struct hw_fence_driver_data *drv_data,
  462. struct msm_hw_fence_client *hw_fence_client);
  463. int hw_fence_create(struct hw_fence_driver_data *drv_data,
  464. struct msm_hw_fence_client *hw_fence_client,
  465. u64 context, u64 seqno, u64 *hash);
  466. int hw_fence_destroy(struct hw_fence_driver_data *drv_data,
  467. struct msm_hw_fence_client *hw_fence_client,
  468. u64 context, u64 seqno);
  469. int hw_fence_destroy_with_hash(struct hw_fence_driver_data *drv_data,
  470. struct msm_hw_fence_client *hw_fence_client, u64 hash);
  471. int hw_fence_process_fence_array(struct hw_fence_driver_data *drv_data,
  472. struct msm_hw_fence_client *hw_fence_client,
  473. struct dma_fence_array *array, u64 *hash_join_fence, u64 client_data);
  474. int hw_fence_process_fence(struct hw_fence_driver_data *drv_data,
  475. struct msm_hw_fence_client *hw_fence_client, struct dma_fence *fence, u64 *hash,
  476. u64 client_data);
  477. int hw_fence_update_queue(struct hw_fence_driver_data *drv_data,
  478. struct msm_hw_fence_client *hw_fence_client, u64 ctxt_id, u64 seqno, u64 hash,
  479. u64 flags, u64 client_data, u32 error, int queue_type);
  480. inline u64 hw_fence_get_qtime(struct hw_fence_driver_data *drv_data);
  481. int hw_fence_read_queue(struct msm_hw_fence_client *hw_fence_client,
  482. struct msm_hw_fence_queue_payload *payload, int queue_type);
  483. int hw_fence_register_wait_client(struct hw_fence_driver_data *drv_data,
  484. struct dma_fence *fence, struct msm_hw_fence_client *hw_fence_client, u64 context,
  485. u64 seqno, u64 *hash, u64 client_data);
  486. struct msm_hw_fence *msm_hw_fence_find(struct hw_fence_driver_data *drv_data,
  487. struct msm_hw_fence_client *hw_fence_client,
  488. u64 context, u64 seqno, u64 *hash);
  489. enum hw_fence_client_data_id hw_fence_get_client_data_id(enum hw_fence_client_id client_id);
  490. #endif /* __HW_FENCE_DRV_INTERNAL_H */