cam_sync.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. /* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */
  2. /*
  3. * Copyright (c) 2016-2021, 2020 The Linux Foundation. All rights reserved.
  4. */
  5. #ifndef __UAPI_CAM_SYNC_H__
  6. #define __UAPI_CAM_SYNC_H__
  7. #include <linux/videodev2.h>
  8. #include <linux/types.h>
  9. #include <linux/ioctl.h>
  10. #include <linux/media.h>
  11. #define CAM_SYNC_DEVICE_NAME "cam_sync_device"
  12. /* V4L event which user space will subscribe to */
  13. #define CAM_SYNC_V4L_EVENT (V4L2_EVENT_PRIVATE_START + 0)
  14. #define CAM_SYNC_V4L_EVENT_V2 (V4L2_EVENT_PRIVATE_START + 1)
  15. /* Specific event ids to get notified in user space */
  16. #define CAM_SYNC_V4L_EVENT_ID_CB_TRIG 0
  17. /* Size of opaque payload sent to kernel for safekeeping until signal time */
  18. #define CAM_SYNC_USER_PAYLOAD_SIZE 2
  19. /* Device type for sync device needed for device discovery */
  20. #define CAM_SYNC_DEVICE_TYPE (MEDIA_ENT_F_OLD_BASE)
  21. #define CAM_SYNC_GET_PAYLOAD_PTR(ev, type) \
  22. (type *)((char *)ev.u.data + sizeof(struct cam_sync_ev_header))
  23. #define CAM_SYNC_GET_HEADER_PTR(ev) \
  24. ((struct cam_sync_ev_header *)ev.u.data)
  25. #define CAM_SYNC_GET_PAYLOAD_PTR_V2(ev, type) \
  26. (type *)((char *)ev.u.data + sizeof(struct cam_sync_ev_header_v2))
  27. #define CAM_SYNC_GET_HEADER_PTR_V2(ev) \
  28. ((struct cam_sync_ev_header_v2 *)ev.u.data)
  29. #define CAM_SYNC_STATE_INVALID 0
  30. #define CAM_SYNC_STATE_ACTIVE 1
  31. #define CAM_SYNC_STATE_SIGNALED_SUCCESS 2
  32. #define CAM_SYNC_STATE_SIGNALED_ERROR 3
  33. #define CAM_SYNC_STATE_SIGNALED_CANCEL 4
  34. /* Top level common sync event reason types */
  35. #define CAM_SYNC_COMMON_EVENT_START 0
  36. #define CAM_SYNC_COMMON_EVENT_UNUSED (CAM_SYNC_COMMON_EVENT_START + 0)
  37. #define CAM_SYNC_COMMON_EVENT_SUCCESS (CAM_SYNC_COMMON_EVENT_START + 1)
  38. #define CAM_SYNC_COMMON_EVENT_FLUSH (CAM_SYNC_COMMON_EVENT_START + 2)
  39. #define CAM_SYNC_COMMON_EVENT_STOP (CAM_SYNC_COMMON_EVENT_START + 3)
  40. #define CAM_SYNC_COMMON_EVENT_SYNX (CAM_SYNC_COMMON_EVENT_START + 4)
  41. #define CAM_SYNC_COMMON_REG_PAYLOAD_EVENT (CAM_SYNC_COMMON_EVENT_START + 5)
  42. #define CAM_SYNC_COMMON_SYNC_SIGNAL_EVENT (CAM_SYNC_COMMON_EVENT_START + 6)
  43. #define CAM_SYNC_COMMON_RELEASE_EVENT (CAM_SYNC_COMMON_EVENT_START + 7)
  44. #define CAM_SYNC_COMMON_EVENT_END (CAM_SYNC_COMMON_EVENT_START + 50)
  45. /* ISP Sync event reason types */
  46. #define CAM_SYNC_ISP_EVENT_START (CAM_SYNC_COMMON_EVENT_END + 1)
  47. #define CAM_SYNC_ISP_EVENT_UNKNOWN (CAM_SYNC_ISP_EVENT_START + 0)
  48. #define CAM_SYNC_ISP_EVENT_BUBBLE (CAM_SYNC_ISP_EVENT_START + 1)
  49. #define CAM_SYNC_ISP_EVENT_OVERFLOW (CAM_SYNC_ISP_EVENT_START + 2)
  50. #define CAM_SYNC_ISP_EVENT_P2I_ERROR (CAM_SYNC_ISP_EVENT_START + 3)
  51. #define CAM_SYNC_ISP_EVENT_VIOLATION (CAM_SYNC_ISP_EVENT_START + 4)
  52. #define CAM_SYNC_ISP_EVENT_BUSIF_OVERFLOW (CAM_SYNC_ISP_EVENT_START + 5)
  53. #define CAM_SYNC_ISP_EVENT_FLUSH (CAM_SYNC_ISP_EVENT_START + 6)
  54. #define CAM_SYNC_ISP_EVENT_HW_STOP (CAM_SYNC_ISP_EVENT_START + 7)
  55. #define CAM_SYNC_ISP_EVENT_RECOVERY_OVERFLOW (CAM_SYNC_ISP_EVENT_START + 8)
  56. #define CAM_SYNC_ISP_EVENT_CSID_OUTPUT_FIFO_OVERFLOW (CAM_SYNC_ISP_EVENT_START + 9)
  57. #define CAM_SYNC_ISP_EVENT_CSID_RX_ERROR (CAM_SYNC_ISP_EVENT_START + 10)
  58. #define CAM_SYNC_ISP_EVENT_CSID_SENSOR_SWITCH_ERROR (CAM_SYNC_ISP_EVENT_START + 11)
  59. #define CAM_SYNC_ISP_EVENT_END (CAM_SYNC_ISP_EVENT_START + 50)
  60. /* ICP Sync event reason types */
  61. #define CAM_SYNC_ICP_EVENT_START (CAM_SYNC_ISP_EVENT_END + 1)
  62. #define CAM_SYNC_ICP_EVENT_UNKNOWN (CAM_SYNC_ICP_EVENT_START + 0)
  63. #define CAM_SYNC_ICP_EVENT_FRAME_PROCESS_FAILURE (CAM_SYNC_ICP_EVENT_START + 1)
  64. #define CAM_SYNC_ICP_EVENT_CONFIG_ERR (CAM_SYNC_ICP_EVENT_START + 2)
  65. #define CAM_SYNC_ICP_EVENT_NO_MEMORY (CAM_SYNC_ICP_EVENT_START + 3)
  66. #define CAM_SYNC_ICP_EVENT_BAD_STATE (CAM_SYNC_ICP_EVENT_START + 4)
  67. #define CAM_SYNC_ICP_EVENT_BAD_PARAM (CAM_SYNC_ICP_EVENT_START + 5)
  68. #define CAM_SYNC_ICP_EVENT_BAD_ITEM (CAM_SYNC_ICP_EVENT_START + 6)
  69. #define CAM_SYNC_ICP_EVENT_INVALID_FORMAT (CAM_SYNC_ICP_EVENT_START + 7)
  70. #define CAM_SYNC_ICP_EVENT_UNSUPPORTED (CAM_SYNC_ICP_EVENT_START + 8)
  71. #define CAM_SYNC_ICP_EVENT_OUT_OF_BOUND (CAM_SYNC_ICP_EVENT_START + 9)
  72. #define CAM_SYNC_ICP_EVENT_TIME_OUT (CAM_SYNC_ICP_EVENT_START + 10)
  73. #define CAM_SYNC_ICP_EVENT_ABORTED (CAM_SYNC_ICP_EVENT_START + 11)
  74. #define CAM_SYNC_ICP_EVENT_HW_VIOLATION (CAM_SYNC_ICP_EVENT_START + 12)
  75. #define CAM_SYNC_ICP_EVENT_CMD_ERROR (CAM_SYNC_ICP_EVENT_START + 13)
  76. #define CAM_SYNC_ICP_EVENT_HFI_ERR_COMMAND_SIZE (CAM_SYNC_ICP_EVENT_START + 14)
  77. #define CAM_SYNC_ICP_EVENT_HFI_ERR_MESSAGE_SIZE (CAM_SYNC_ICP_EVENT_START + 15)
  78. #define CAM_SYNC_ICP_EVENT_HFI_ERR_QUEUE_EMPTY (CAM_SYNC_ICP_EVENT_START + 16)
  79. #define CAM_SYNC_ICP_EVENT_HFI_ERR_QUEUE_FULL (CAM_SYNC_ICP_EVENT_START + 17)
  80. #define CAM_SYNC_ICP_EVENT_END (CAM_SYNC_ICP_EVENT_START + 50)
  81. /* JPEG Sync event reason types */
  82. #define CAM_SYNC_JPEG_EVENT_START (CAM_SYNC_ICP_EVENT_END + 1)
  83. #define CAM_SYNC_JPEG_EVENT_UNKNOWN (CAM_SYNC_JPEG_EVENT_START + 0)
  84. #define CAM_SYNC_JPEG_EVENT_INVLD_CMD (CAM_SYNC_JPEG_EVENT_START + 1)
  85. #define CAM_SYNC_JPEG_EVENT_SET_IRQ_CB (CAM_SYNC_JPEG_EVENT_START + 2)
  86. #define CAM_SYNC_JPEG_EVENT_HW_RESET_FAILED (CAM_SYNC_JPEG_EVENT_START + 3)
  87. #define CAM_SYNC_JPEG_EVENT_CDM_CHANGE_BASE_ERR (CAM_SYNC_JPEG_EVENT_START + 4)
  88. #define CAM_SYNC_JPEG_EVENT_CDM_CONFIG_ERR (CAM_SYNC_JPEG_EVENT_START + 5)
  89. #define CAM_SYNC_JPEG_EVENT_START_HW_ERR (CAM_SYNC_JPEG_EVENT_START + 6)
  90. #define CAM_SYNC_JPEG_EVENT_START_HW_HANG (CAM_SYNC_JPEG_EVENT_START + 7)
  91. #define CAM_SYNC_JPEG_EVENT_END (CAM_SYNC_JPEG_EVENT_START + 50)
  92. /* FD Sync event reason types */
  93. #define CAM_SYNC_FD_EVENT_START (CAM_SYNC_JPEG_EVENT_END + 1)
  94. #define CAM_SYNC_FD_EVENT_UNKNOWN (CAM_SYNC_FD_EVENT_START + 0)
  95. #define CAM_SYNC_FD_EVENT_IRQ_FRAME_DONE (CAM_SYNC_FD_EVENT_START + 1)
  96. #define CAM_SYNC_FD_EVENT_IRQ_RESET_DONE (CAM_SYNC_FD_EVENT_START + 2)
  97. #define CAM_SYNC_FD_EVENT_HALT (CAM_SYNC_FD_EVENT_START + 3)
  98. #define CAM_SYNC_FD_EVENT_END (CAM_SYNC_FD_EVENT_START + 50)
  99. /* LRME Sync event reason types */
  100. #define CAM_SYNC_LRME_EVENT_START (CAM_SYNC_FD_EVENT_END + 1)
  101. #define CAM_SYNC_LRME_EVENT_UNKNOWN (CAM_SYNC_LRME_EVENT_START + 0)
  102. #define CAM_SYNC_LRME_EVENT_CB_ERROR (CAM_SYNC_LRME_EVENT_START + 1)
  103. #define CAM_SYNC_LRME_EVENT_END (CAM_SYNC_LRME_EVENT_START + 50)
  104. /* OPE Sync event reason types */
  105. #define CAM_SYNC_OPE_EVENT_START (CAM_SYNC_LRME_EVENT_END + 1)
  106. #define CAM_SYNC_OPE_EVENT_UNKNOWN (CAM_SYNC_OPE_EVENT_START + 0)
  107. #define CAM_SYNC_OPE_EVENT_PAGE_FAULT (CAM_SYNC_OPE_EVENT_START + 1)
  108. #define CAM_SYNC_OPE_EVENT_HW_HANG (CAM_SYNC_OPE_EVENT_START + 2)
  109. #define CAM_SYNC_OPE_EVENT_HALT (CAM_SYNC_OPE_EVENT_START + 3)
  110. #define CAM_SYNC_OPE_EVENT_CONFIG_ERR (CAM_SYNC_OPE_EVENT_START + 4)
  111. #define CAM_SYNC_OPE_EVENT_HW_FLUSH (CAM_SYNC_OPE_EVENT_START + 5)
  112. #define CAM_SYNC_OPE_EVENT_HW_RESUBMIT (CAM_SYNC_OPE_EVENT_START + 6)
  113. #define CAM_SYNC_OPE_EVENT_HW_RESET_DONE (CAM_SYNC_OPE_EVENT_START + 7)
  114. #define CAM_SYNC_OPE_EVENT_HW_ERROR (CAM_SYNC_OPE_EVENT_START + 8)
  115. #define CAM_SYNC_OPE_EVENT_INVLD_CMD (CAM_SYNC_OPE_EVENT_START + 9)
  116. #define CAM_SYNC_OPE_EVENT_HW_RESET_FAILED (CAM_SYNC_OPE_EVENT_START + 10)
  117. #define CAM_SYNC_OPE_EVENT_END (CAM_SYNC_OPE_EVENT_START + 50)
  118. /* CRE Sync event reason types */
  119. #define CAM_SYNC_CRE_EVENT_START (CAM_SYNC_OPE_EVENT_END + 1)
  120. #define CAM_SYNC_CRE_EVENT_UNKNOWN (CAM_SYNC_CRE_EVENT_START + 0)
  121. #define CAM_SYNC_CRE_EVENT_CONFIG_ERR (CAM_SYNC_CRE_EVENT_START + 1)
  122. #define CAM_SYNC_CRE_EVENT_INVLD_CMD (CAM_SYNC_CRE_EVENT_START + 2)
  123. #define CAM_SYNC_CRE_EVENT_SET_IRQ_CB (CAM_SYNC_CRE_EVENT_START + 3)
  124. #define CAM_SYNC_CRE_EVENT_HW_RESET_FAILED (CAM_SYNC_CRE_EVENT_START + 4)
  125. #define CAM_SYNC_CRE_EVENT_HW_ERR (CAM_SYNC_CRE_EVENT_START + 5)
  126. #define CAM_SYNC_CRE_EVENT_END (CAM_SYNC_CRE_EVENT_START + 50)
  127. #define CAM_SYNC_EVENT_MAX 8
  128. #define CAM_SYNC_EVENT_REASON_CODE_INDEX 0
  129. /**
  130. * struct cam_sync_ev_header - Event header for sync event notification
  131. *
  132. * @sync_obj: Sync object
  133. * @status: Status of the object
  134. */
  135. struct cam_sync_ev_header {
  136. __s32 sync_obj;
  137. __s32 status;
  138. };
  139. /**
  140. * struct cam_sync_ev_header_v2 - Event header for sync event notification
  141. *
  142. * @sync_obj: Sync object
  143. * @status: Status of the object
  144. * @version: sync driver version
  145. * @evt_param: event parameter
  146. */
  147. struct cam_sync_ev_header_v2 {
  148. __s32 sync_obj;
  149. __s32 status;
  150. uint32_t version;
  151. uint32_t evt_param[CAM_SYNC_EVENT_MAX];
  152. };
  153. /**
  154. * struct cam_sync_info - Sync object creation information
  155. *
  156. * @name: Optional string representation of the sync object
  157. * @sync_obj: Sync object returned after creation in kernel
  158. */
  159. struct cam_sync_info {
  160. char name[64];
  161. __s32 sync_obj;
  162. };
  163. /**
  164. * struct cam_sync_signal - Sync object signaling struct
  165. *
  166. * @sync_obj: Sync object to be signaled
  167. * @sync_state: State of the sync object to which it should be signaled
  168. */
  169. struct cam_sync_signal {
  170. __s32 sync_obj;
  171. __u32 sync_state;
  172. };
  173. /**
  174. * struct cam_sync_merge - Merge information for sync objects
  175. *
  176. * @sync_objs: Pointer to sync objects
  177. * @num_objs: Number of objects in the array
  178. * @merged: Merged sync object
  179. */
  180. struct cam_sync_merge {
  181. __u64 sync_objs;
  182. __u32 num_objs;
  183. __s32 merged;
  184. };
  185. /**
  186. * struct cam_sync_userpayload_info - Payload info from user space
  187. *
  188. * @sync_obj: Sync object for which payload has to be registered for
  189. * @reserved: Reserved
  190. * @payload: Pointer to user payload
  191. */
  192. struct cam_sync_userpayload_info {
  193. __s32 sync_obj;
  194. __u32 reserved;
  195. __u64 payload[CAM_SYNC_USER_PAYLOAD_SIZE];
  196. };
  197. /**
  198. * struct cam_sync_wait - Sync object wait information
  199. *
  200. * @sync_obj: Sync object to wait on
  201. * @reserved: Reserved
  202. * @timeout_ms: Timeout in milliseconds
  203. */
  204. struct cam_sync_wait {
  205. __s32 sync_obj;
  206. __u32 reserved;
  207. uint64_t timeout_ms;
  208. };
  209. /**
  210. * struct cam_private_ioctl_arg - Sync driver ioctl argument
  211. *
  212. * @id: IOCTL command id
  213. * @size: Size of command payload
  214. * @result: Result of command execution
  215. * @reserved: Reserved
  216. * @ioctl_ptr: Pointer to user data
  217. */
  218. struct cam_private_ioctl_arg {
  219. __u32 id;
  220. __u32 size;
  221. __u32 result;
  222. __u32 reserved;
  223. __u64 ioctl_ptr;
  224. };
  225. #define CAM_PRIVATE_IOCTL_CMD \
  226. _IOWR('V', BASE_VIDIOC_PRIVATE, struct cam_private_ioctl_arg)
  227. #define CAM_SYNC_CREATE 0
  228. #define CAM_SYNC_DESTROY 1
  229. #define CAM_SYNC_SIGNAL 2
  230. #define CAM_SYNC_MERGE 3
  231. #define CAM_SYNC_REGISTER_PAYLOAD 4
  232. #define CAM_SYNC_DEREGISTER_PAYLOAD 5
  233. #define CAM_SYNC_WAIT 6
  234. #endif /* __UAPI_CAM_SYNC_H__ */