cam_cpas_api.h 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2017-2021, The Linux Foundation. All rights reserved.
  4. * Copyright (c) 2022-2023, Qualcomm Innovation Center, Inc. All rights reserved.
  5. */
  6. #ifndef _CAM_CPAS_API_H_
  7. #define _CAM_CPAS_API_H_
  8. #include <linux/device.h>
  9. #include <linux/platform_device.h>
  10. #include <media/cam_cpas.h>
  11. #include "cam_soc_util.h"
  12. #include "cam_req_mgr_interface.h"
  13. #define CAM_HW_IDENTIFIER_LENGTH 128
  14. /* Default AXI Bandwidth vote */
  15. #define CAM_CPAS_DEFAULT_AXI_BW 1024
  16. /* Default RT AXI Bandwidth vote */
  17. #define CAM_CPAS_DEFAULT_RT_AXI_BW 2000000000L
  18. #define CAM_CPAS_MAX_PATHS_PER_CLIENT 15
  19. #define CAM_CPAS_API_PATH_DATA_STD_START 512
  20. #define CAM_CPAS_VOTE_LEVEL_NONE 0
  21. #define CAM_CPAS_VOTE_LEVEL_MAX 3
  22. /* Qos Selection mask */
  23. #define CAM_CPAS_QOS_DEFAULT_SETTINGS_MASK 0x1
  24. #define CAM_CPAS_QOS_CUSTOM_SETTINGS_MASK 0x2
  25. /**
  26. * enum cam_cpas_regbase_types - Enum for cpas regbase available for clients
  27. * to read/write
  28. */
  29. enum cam_cpas_regbase_types {
  30. CAM_CPAS_REGBASE_CPASTOP,
  31. CAM_CPAS_REGBASE_MAX
  32. };
  33. /**
  34. * enum cam_cpas_vote_type - Enum for cpas vote type
  35. */
  36. enum cam_cpas_vote_type {
  37. CAM_CPAS_VOTE_TYPE_HLOS,
  38. CAM_CPAS_VOTE_TYPE_DRV,
  39. CAM_CPAS_VOTE_TYPE_MAX,
  40. };
  41. /**
  42. * enum cam_cpas_hw_index - Enum for identify HW index
  43. */
  44. enum cam_cpas_hw_index {
  45. CAM_CPAS_HW_IDX_ANY = 0,
  46. CAM_CPAS_HW_IDX_0 = 1<<0,
  47. CAM_CPAS_HW_IDX_1 = 1<<1,
  48. CAM_CPAS_HW_IDX_2 = 1<<2,
  49. CAM_CPAS_HW_IDX_3 = 1<<3,
  50. CAM_CPAS_HW_IDX_4 = 1<<4,
  51. CAM_CPAS_HW_IDX_5 = 1<<5,
  52. CAM_CPAS_HW_IDX_6 = 1<<6,
  53. CAM_CPAS_HW_IDX_7 = 1<<7,
  54. CAM_CPAS_HW_IDX_MAX = 1<<8
  55. };
  56. /**
  57. * enum cam_cpas_camera_version Enum for Titan Camera Versions
  58. */
  59. enum cam_cpas_camera_version {
  60. CAM_CPAS_CAMERA_VERSION_NONE = 0,
  61. CAM_CPAS_CAMERA_VERSION_150 = 0x00010500,
  62. CAM_CPAS_CAMERA_VERSION_170 = 0x00010700,
  63. CAM_CPAS_CAMERA_VERSION_175 = 0x00010705,
  64. CAM_CPAS_CAMERA_VERSION_480 = 0x00040800,
  65. CAM_CPAS_CAMERA_VERSION_520 = 0x00050200,
  66. CAM_CPAS_CAMERA_VERSION_540 = 0x00050400,
  67. CAM_CPAS_CAMERA_VERSION_580 = 0x00050800,
  68. CAM_CPAS_CAMERA_VERSION_545 = 0x00050405,
  69. CAM_CPAS_CAMERA_VERSION_570 = 0x00050700,
  70. CAM_CPAS_CAMERA_VERSION_680 = 0x00060800,
  71. CAM_CPAS_CAMERA_VERSION_165 = 0x00010605,
  72. CAM_CPAS_CAMERA_VERSION_780 = 0x00070800,
  73. CAM_CPAS_CAMERA_VERSION_640 = 0x00060400,
  74. CAM_CPAS_CAMERA_VERSION_880 = 0x00080800,
  75. CAM_CPAS_CAMERA_VERSION_980 = 0x00090800,
  76. CAM_CPAS_CAMERA_VERSION_860 = 0x00080600,
  77. CAM_CPAS_CAMERA_VERSION_770 = 0x00070700,
  78. CAM_CPAS_CAMERA_VERSION_MAX
  79. };
  80. /**
  81. * enum cam_cpas_version Enum for Titan CPAS Versions
  82. */
  83. enum cam_cpas_version {
  84. CAM_CPAS_VERSION_NONE = 0,
  85. CAM_CPAS_VERSION_100 = 0x10000000,
  86. CAM_CPAS_VERSION_101 = 0x10000001,
  87. CAM_CPAS_VERSION_110 = 0x10010000,
  88. CAM_CPAS_VERSION_120 = 0x10020000,
  89. CAM_CPAS_VERSION_130 = 0x10030000,
  90. CAM_CPAS_VERSION_200 = 0x20000000,
  91. CAM_CPAS_VERSION_210 = 0x20010000,
  92. CAM_CPAS_VERSION_MAX
  93. };
  94. /**
  95. * enum cam_cpas_camera_version_map_id Enum for camera version map id
  96. * This enum is mapped with cam_cpas_camera_version
  97. */
  98. enum cam_cpas_camera_version_map_id {
  99. CAM_CPAS_CAMERA_VERSION_ID_150 = 0x0,
  100. CAM_CPAS_CAMERA_VERSION_ID_170 = 0x1,
  101. CAM_CPAS_CAMERA_VERSION_ID_175 = 0x2,
  102. CAM_CPAS_CAMERA_VERSION_ID_480 = 0x3,
  103. CAM_CPAS_CAMERA_VERSION_ID_580 = 0x4,
  104. CAM_CPAS_CAMERA_VERSION_ID_520 = 0x5,
  105. CAM_CPAS_CAMERA_VERSION_ID_540 = 0x6,
  106. CAM_CPAS_CAMERA_VERSION_ID_545 = 0x7,
  107. CAM_CPAS_CAMERA_VERSION_ID_570 = 0x8,
  108. CAM_CPAS_CAMERA_VERSION_ID_680 = 0x9,
  109. CAM_CPAS_CAMERA_VERSION_ID_165 = 0xA,
  110. CAM_CPAS_CAMERA_VERSION_ID_780 = 0xB,
  111. CAM_CPAS_CAMERA_VERSION_ID_640 = 0xC,
  112. CAM_CPAS_CAMERA_VERSION_ID_880 = 0xD,
  113. CAM_CPAS_CAMERA_VERSION_ID_980 = 0xE,
  114. CAM_CPAS_CAMERA_VERSION_ID_860 = 0xF,
  115. CAM_CPAS_CAMERA_VERSION_ID_770 = 0x10,
  116. CAM_CPAS_CAMERA_VERSION_ID_MAX
  117. };
  118. /**
  119. * enum cam_cpas_version_map_id Enum for cpas version map id
  120. * This enum is mapped with cam_cpas_version
  121. */
  122. enum cam_cpas_version_map_id {
  123. CAM_CPAS_VERSION_ID_100 = 0x0,
  124. CAM_CPAS_VERSION_ID_101 = 0x1,
  125. CAM_CPAS_VERSION_ID_110 = 0x2,
  126. CAM_CPAS_VERSION_ID_120 = 0x3,
  127. CAM_CPAS_VERSION_ID_130 = 0x4,
  128. CAM_CPAS_VERSION_ID_200 = 0x5,
  129. CAM_CPAS_VERSION_ID_210 = 0x6,
  130. CAM_CPAS_VERSION_ID_MAX
  131. };
  132. /**
  133. * enum cam_cpas_hw_version - Enum for Titan CPAS HW Versions
  134. */
  135. enum cam_cpas_hw_version {
  136. CAM_CPAS_TITAN_NONE = 0,
  137. CAM_CPAS_TITAN_150_V100 = 0x150100,
  138. CAM_CPAS_TITAN_165_V100 = 0x165100,
  139. CAM_CPAS_TITAN_170_V100 = 0x170100,
  140. CAM_CPAS_TITAN_170_V110 = 0x170110,
  141. CAM_CPAS_TITAN_170_V120 = 0x170120,
  142. CAM_CPAS_TITAN_170_V200 = 0x170200,
  143. CAM_CPAS_TITAN_175_V100 = 0x175100,
  144. CAM_CPAS_TITAN_175_V101 = 0x175101,
  145. CAM_CPAS_TITAN_175_V120 = 0x175120,
  146. CAM_CPAS_TITAN_175_V130 = 0x175130,
  147. CAM_CPAS_TITAN_480_V100 = 0x480100,
  148. CAM_CPAS_TITAN_580_V100 = 0x580100,
  149. CAM_CPAS_TITAN_540_V100 = 0x540100,
  150. CAM_CPAS_TITAN_520_V100 = 0x520100,
  151. CAM_CPAS_TITAN_545_V100 = 0x545100,
  152. CAM_CPAS_TITAN_570_V100 = 0x570100,
  153. CAM_CPAS_TITAN_570_V200 = 0x570200,
  154. CAM_CPAS_TITAN_680_V100 = 0x680100,
  155. CAM_CPAS_TITAN_680_V110 = 0x680110,
  156. CAM_CPAS_TITAN_780_V100 = 0x780100,
  157. CAM_CPAS_TITAN_640_V200 = 0x640200,
  158. CAM_CPAS_TITAN_640_V210 = 0x640210,
  159. CAM_CPAS_TITAN_880_V100 = 0x880100,
  160. CAM_CPAS_TITAN_980_V100 = 0x980100,
  161. CAM_CPAS_TITAN_860_V100 = 0x860100,
  162. CAM_CPAS_TITAN_770_V100 = 0x770100,
  163. CAM_CPAS_TITAN_MAX
  164. };
  165. /**
  166. * enum cam_camnoc_slave_error_codes - Enum for camnoc slave error codes
  167. *
  168. */
  169. enum cam_camnoc_slave_error_codes {
  170. CAM_CAMNOC_TARGET_ERROR,
  171. CAM_CAMNOC_ADDRESS_DECODE_ERROR,
  172. CAM_CAMNOC_UNSUPPORTED_REQUEST_ERROR,
  173. CAM_CAMNOC_DISCONNECTED_TARGET_ERROR,
  174. CAM_CAMNOC_SECURITY_VIOLATION,
  175. CAM_CAMNOC_HIDDEN_SECURITY_VIOLATION,
  176. CAM_CAMNOC_TIME_OUT,
  177. CAM_CAMNOC_UNUSED,
  178. };
  179. /**
  180. * enum cam_camnoc_irq_type - Enum for camnoc irq types
  181. *
  182. * @CAM_CAMNOC_IRQ_SLAVE_ERROR: Each slave port in CAMNOC (3 QSB ports and
  183. * 1 QHB port) has an error logger. The error
  184. * observed at any slave port is logged into
  185. * the error logger register and an IRQ is
  186. * triggered
  187. * @CAM_CAMNOC_IRQ_IFE_UBWC_ENCODE_ERROR : Triggered if any error detected
  188. * in the IFE UBWC encoder instance
  189. * @CAM_CAMNOC_IRQ_IFE_UBWC_STATS_ENCODE_ERROR: Triggered if any error detected
  190. * in the IFE UBWC-Stats encoder
  191. * instance
  192. * @CAM_CAMNOC_IRQ_IFE02_UBWC_ENCODE_ERROR : Triggered if any error detected
  193. * in the IFE0 UBWC encoder instance
  194. * @CAM_CAMNOC_IRQ_IFE13_UBWC_ENCODE_ERROR : Triggered if any error detected
  195. * in the IFE1 or IFE3 UBWC encoder
  196. * instance
  197. * @CAM_CAMNOC_IRQ_IFE0_UBWC_ENCODE_ERROR : Triggered if any error detected
  198. * in the IFE0 UBWC encoder instance
  199. * @CAM_CAMNOC_IRQ_IFE1_WR_UBWC_ENCODE_ERROR : Triggered if any error detected
  200. * in the IFE1 UBWC encoder
  201. * instance
  202. * @CAM_CAMNOC_IRQ_IPE_UBWC_ENCODE_ERROR : Triggered if any error detected
  203. * in the IPE write path encoder
  204. * instance
  205. * @CAM_CAMNOC_IRQ_BPS_UBWC_ENCODE_ERROR : Triggered if any error detected
  206. * in the BPS write path encoder
  207. * instance
  208. * @CAM_CAMNOC_IRQ_IPE1_BPS_UBWC_DECODE_ERROR: Triggered if any error detected
  209. * in the IPE1/BPS read path decoder
  210. * instance
  211. * @CAM_CAMNOC_IRQ_IPE0_UBWC_DECODE_ERROR : Triggered if any error detected
  212. * in the IPE0 read path decoder
  213. * instance
  214. * @CAM_CAMNOC_IRQ_IPE1_UBWC_DECODE_ERROR : Triggered if any error detected
  215. * in the IPE1 read path decoder
  216. * instance
  217. * @CAM_CAMNOC_IRQ_IPE_BPS_UBWC_DECODE_ERROR: Triggered if any error detected
  218. * in the IPE/BPS UBWC decoder
  219. * instance
  220. * @CAM_CAMNOC_IRQ_IPE_BPS_UBWC_ENCODE_ERROR: Triggered if any error detected
  221. * in the IPE/BPS UBWC encoder
  222. * instance
  223. * @CAM_CAMNOC_IRQ_OFE_WR_UBWC_ENCODE_ERROR : Triggered if any error detected
  224. * in the OFE write UBWC decoder
  225. * instance
  226. * @CAM_CAMNOC_IRQ_OFE_RD_UBWC_DECODE_ERROR : Triggered if any error detected
  227. * in the OFE read UBWC decoder
  228. * instance
  229. * @CAM_CAMNOC_IRQ_TFE_UBWC_ENCODE_ERROR : Triggered if any error detected
  230. * in the TFE UBWC encoder
  231. * instance
  232. * @CAM_CAMNOC_IRQ_AHB_TIMEOUT : Triggered when the QHS_ICP slave
  233. * times out after 4000 AHB cycles
  234. */
  235. enum cam_camnoc_irq_type {
  236. CAM_CAMNOC_IRQ_SLAVE_ERROR,
  237. CAM_CAMNOC_IRQ_IFE_UBWC_ENCODE_ERROR,
  238. CAM_CAMNOC_IRQ_IFE_UBWC_STATS_ENCODE_ERROR,
  239. CAM_CAMNOC_IRQ_IFE_UBWC_STATS_1_ENCODE_ERROR,
  240. CAM_CAMNOC_IRQ_IFE02_UBWC_ENCODE_ERROR,
  241. CAM_CAMNOC_IRQ_IFE13_UBWC_ENCODE_ERROR,
  242. CAM_CAMNOC_IRQ_IFE0_UBWC_ENCODE_ERROR,
  243. CAM_CAMNOC_IRQ_IFE1_WRITE_UBWC_ENCODE_ERROR,
  244. CAM_CAMNOC_IRQ_IPE_UBWC_ENCODE_ERROR,
  245. CAM_CAMNOC_IRQ_BPS_UBWC_ENCODE_ERROR,
  246. CAM_CAMNOC_IRQ_IPE1_BPS_UBWC_DECODE_ERROR,
  247. CAM_CAMNOC_IRQ_IPE0_UBWC_DECODE_ERROR,
  248. CAM_CAMNOC_IRQ_IPE1_UBWC_DECODE_ERROR,
  249. CAM_CAMNOC_IRQ_IPE_BPS_UBWC_DECODE_ERROR,
  250. CAM_CAMNOC_IRQ_IPE_BPS_UBWC_ENCODE_ERROR,
  251. CAM_CAMNOC_IRQ_OFE_WR_UBWC_ENCODE_ERROR,
  252. CAM_CAMNOC_IRQ_OFE_RD_UBWC_DECODE_ERROR,
  253. CAM_CAMNOC_IRQ_TFE_UBWC_ENCODE_ERROR,
  254. CAM_CAMNOC_IRQ_AHB_TIMEOUT,
  255. };
  256. /**
  257. * enum cam_sys_cache_config_types - Enum for camera llc's
  258. */
  259. enum cam_sys_cache_config_types {
  260. CAM_LLCC_SMALL_1 = 0,
  261. CAM_LLCC_SMALL_2 = 1,
  262. CAM_LLCC_LARGE_1 = 2,
  263. CAM_LLCC_LARGE_2 = 3,
  264. CAM_LLCC_LARGE_3 = 4,
  265. CAM_LLCC_LARGE_4 = 5,
  266. CAM_LLCC_MAX = 6,
  267. };
  268. /**
  269. * enum cam_sys_cache_llcc_staling_mode - Enum for camera llc's stalling mode
  270. */
  271. enum cam_sys_cache_llcc_staling_mode {
  272. CAM_LLCC_STALING_MODE_CAPACITY,
  273. CAM_LLCC_STALING_MODE_NOTIFY,
  274. CAM_LLCC_STALING_MODE_MAX,
  275. };
  276. /**
  277. * enum cam_sys_cache_llcc_staling_mode - Enum for camera llc's stalling mode
  278. */
  279. enum cam_sys_cache_llcc_staling_op_type {
  280. CAM_LLCC_NOTIFY_STALING_EVICT,
  281. CAM_LLCC_NOTIFY_STALING_FORGET,
  282. CAM_LLCC_NOTIFY_STALING_OPS_MAX
  283. };
  284. /**
  285. * enum cam_subparts_index - Enum for camera subparts indices
  286. */
  287. enum cam_subparts_index {
  288. CAM_IFE_HW_IDX,
  289. CAM_IFE_LITE_HW_IDX,
  290. CAM_SFE_HW_IDX,
  291. CAM_CUSTOM_HW_IDX
  292. };
  293. /**
  294. * struct cam_camnoc_irq_slave_err_data : Data for Slave error.
  295. *
  296. * @mainctrl : Err logger mainctrl info
  297. * @errvld : Err logger errvld info
  298. * @errlog0_low : Err logger errlog0_low info
  299. * @errlog0_high : Err logger errlog0_high info
  300. * @errlog1_low : Err logger errlog1_low info
  301. * @errlog1_high : Err logger errlog1_high info
  302. * @errlog2_low : Err logger errlog2_low info
  303. * @errlog2_high : Err logger errlog2_high info
  304. * @errlog3_low : Err logger errlog3_low info
  305. * @errlog3_high : Err logger errlog3_high info
  306. *
  307. */
  308. struct cam_camnoc_irq_slave_err_data {
  309. union {
  310. struct {
  311. uint32_t stall_en : 1; /* bit 0 */
  312. uint32_t fault_en : 1; /* bit 1 */
  313. uint32_t rsv : 30; /* bits 2-31 */
  314. };
  315. uint32_t value;
  316. } mainctrl;
  317. union {
  318. struct {
  319. uint32_t err_vld : 1; /* bit 0 */
  320. uint32_t rsv : 31; /* bits 1-31 */
  321. };
  322. uint32_t value;
  323. } errvld;
  324. union {
  325. struct {
  326. uint32_t loginfo_vld : 1; /* bit 0 */
  327. uint32_t word_error : 1; /* bit 1 */
  328. uint32_t non_secure : 1; /* bit 2 */
  329. uint32_t device : 1; /* bit 3 */
  330. uint32_t opc : 3; /* bits 4 - 6 */
  331. uint32_t rsv0 : 1; /* bit 7 */
  332. uint32_t err_code : 3; /* bits 8 - 10 */
  333. uint32_t sizef : 3; /* bits 11 - 13 */
  334. uint32_t rsv1 : 2; /* bits 14 - 15 */
  335. uint32_t addr_space : 6; /* bits 16 - 21 */
  336. uint32_t rsv2 : 10; /* bits 22 - 31 */
  337. };
  338. uint32_t value;
  339. } errlog0_low;
  340. union {
  341. struct {
  342. uint32_t len1 : 10; /* bits 0 - 9 */
  343. uint32_t rsv : 22; /* bits 10 - 31 */
  344. };
  345. uint32_t value;
  346. } errlog0_high;
  347. union {
  348. struct {
  349. uint32_t path : 16; /* bits 0 - 15 */
  350. uint32_t rsv : 16; /* bits 16 - 31 */
  351. };
  352. uint32_t value;
  353. } errlog1_low;
  354. union {
  355. struct {
  356. uint32_t extid : 18; /* bits 0 - 17 */
  357. uint32_t rsv : 14; /* bits 18 - 31 */
  358. };
  359. uint32_t value;
  360. } errlog1_high;
  361. union {
  362. struct {
  363. uint32_t errlog2_lsb : 32; /* bits 0 - 31 */
  364. };
  365. uint32_t value;
  366. } errlog2_low;
  367. union {
  368. struct {
  369. uint32_t errlog2_msb : 16; /* bits 0 - 16 */
  370. uint32_t rsv : 16; /* bits 16 - 31 */
  371. };
  372. uint32_t value;
  373. } errlog2_high;
  374. union {
  375. struct {
  376. uint32_t errlog3_lsb : 32; /* bits 0 - 31 */
  377. };
  378. uint32_t value;
  379. } errlog3_low;
  380. union {
  381. struct {
  382. uint32_t errlog3_msb : 32; /* bits 0 - 31 */
  383. };
  384. uint32_t value;
  385. } errlog3_high;
  386. };
  387. /**
  388. * struct cam_camnoc_irq_ubwc_enc_data : Data for UBWC Encode error.
  389. *
  390. * @encerr_status : Encode error status
  391. *
  392. */
  393. struct cam_camnoc_irq_ubwc_enc_data {
  394. union {
  395. struct {
  396. uint32_t encerrstatus : 3; /* bits 0 - 2 */
  397. uint32_t rsv : 29; /* bits 3 - 31 */
  398. };
  399. uint32_t value;
  400. } encerr_status;
  401. };
  402. /**
  403. * struct cam_camnoc_irq_ubwc_dec_data : Data for UBWC Decode error.
  404. *
  405. * @decerr_status : Decoder error status
  406. * @thr_err : Set to 1 if
  407. * At least one of the bflc_len fields in the bit steam exceeds
  408. * its threshold value. This error is possible only for
  409. * RGBA1010102, TP10, and RGB565 formats
  410. * @fcl_err : Set to 1 if
  411. * Fast clear with a legal non-RGB format
  412. * @len_md_err : Set to 1 if
  413. * The calculated burst length does not match burst length
  414. * specified by the metadata value
  415. * @format_err : Set to 1 if
  416. * Illegal format
  417. * 1. bad format :2,3,6
  418. * 2. For 32B MAL, metadata=6
  419. * 3. For 32B MAL RGB565, Metadata != 0,1,7
  420. * 4. For 64B MAL RGB565, metadata[3:1] == 1,2
  421. *
  422. */
  423. struct cam_camnoc_irq_ubwc_dec_data {
  424. union {
  425. struct {
  426. uint32_t thr_err : 1; /* bit 0 */
  427. uint32_t fcl_err : 1; /* bit 1 */
  428. uint32_t len_md_err : 1; /* bit 2 */
  429. uint32_t format_err : 1; /* bit 3 */
  430. uint32_t rsv : 28; /* bits 4 - 31 */
  431. };
  432. uint32_t value;
  433. } decerr_status;
  434. };
  435. struct cam_camnoc_irq_ahb_timeout_data {
  436. uint32_t data;
  437. };
  438. /**
  439. * struct cam_cpas_irq_data : CAMNOC IRQ data
  440. *
  441. * @irq_type : To identify the type of IRQ
  442. * @u : Union of irq err data information
  443. * @slave_err : Data for Slave error.
  444. * Valid if type is CAM_CAMNOC_IRQ_SLAVE_ERROR
  445. * @enc_err : Data for UBWC Encode error.
  446. * Valid if type is one of below:
  447. * CAM_CAMNOC_IRQ_IFE02_UBWC_ENCODE_ERROR
  448. * CAM_CAMNOC_IRQ_IFE13_UBWC_ENCODE_ERROR
  449. * CAM_CAMNOC_IRQ_IPE_BPS_UBWC_ENCODE_ERROR
  450. * @dec_err : Data for UBWC Decode error.
  451. * Valid if type is CAM_CAMNOC_IRQ_IPE_BPS_UBWC_DECODE_ERROR
  452. * @ahb_err : Data for Slave error.
  453. * Valid if type is CAM_CAMNOC_IRQ_AHB_TIMEOUT
  454. *
  455. */
  456. struct cam_cpas_irq_data {
  457. enum cam_camnoc_irq_type irq_type;
  458. union {
  459. struct cam_camnoc_irq_slave_err_data slave_err;
  460. struct cam_camnoc_irq_ubwc_enc_data enc_err;
  461. struct cam_camnoc_irq_ubwc_dec_data dec_err;
  462. struct cam_camnoc_irq_ahb_timeout_data ahb_err;
  463. } u;
  464. };
  465. /*
  466. * CPAS client callback
  467. *
  468. * @client_handle : CPAS client handle
  469. * @userdata : User data given at the time of register
  470. * @irq_data : Event data
  471. */
  472. typedef bool (*cam_cpas_client_cb_func)(
  473. uint32_t client_handle, void *userdata,
  474. struct cam_cpas_irq_data *irq_data);
  475. /**
  476. * struct cam_cpas_register_params : Register params for cpas client
  477. *
  478. * @identifier : Input identifier string which is the device label
  479. * from dt like vfe, ife, jpeg etc
  480. * @cell_index : Input integer identifier pointing to the cell index
  481. * from dt of the device. This can be used to form a
  482. * unique string with @identifier like vfe0, ife1,
  483. * jpeg0, etc
  484. * @dev : device handle
  485. * @userdata : Input private data which will be passed as
  486. * an argument while callback.
  487. * @cam_cpas_callback : Input callback pointer for triggering the
  488. * callbacks from CPAS driver.
  489. * @client_handle : Output Unique handle generated for this register
  490. *
  491. */
  492. struct cam_cpas_register_params {
  493. char identifier[CAM_HW_IDENTIFIER_LENGTH];
  494. uint32_t cell_index;
  495. struct device *dev;
  496. void *userdata;
  497. cam_cpas_client_cb_func cam_cpas_client_cb;
  498. uint32_t client_handle;
  499. };
  500. /**
  501. * enum cam_vote_type - Enum for voting type
  502. *
  503. * @CAM_VOTE_ABSOLUTE : Absolute vote
  504. * @CAM_VOTE_DYNAMIC : Dynamic vote
  505. */
  506. enum cam_vote_type {
  507. CAM_VOTE_ABSOLUTE,
  508. CAM_VOTE_DYNAMIC,
  509. };
  510. /**
  511. * struct cam_ahb_vote : AHB vote
  512. *
  513. * @type : AHB voting type.
  514. * CAM_VOTE_ABSOLUTE : vote based on the value 'level' is set
  515. * CAM_VOTE_DYNAMIC : vote calculated dynamically using 'freq'
  516. * and 'dev' handle is set
  517. * @level : AHB vote level
  518. * @freq : AHB vote dynamic frequency
  519. *
  520. */
  521. struct cam_ahb_vote {
  522. enum cam_vote_type type;
  523. union {
  524. enum cam_vote_level level;
  525. unsigned long freq;
  526. } vote;
  527. };
  528. /**
  529. * struct cam_cpas_axi_per_path_bw_vote - Internal per path bandwidth vote information
  530. *
  531. * @usage_data: client usage data (left/right/rdi)
  532. * @transac_type: Transaction type on the path (read/write)
  533. * @path_data_type: Path for which vote is given (video, display, rdi)
  534. * @vote_level: Vote level for this path
  535. * @camnoc_bw: CAMNOC bw for this path
  536. * @mnoc_ab_bw: MNOC AB bw for this path
  537. * @mnoc_ib_bw: MNOC IB bw for this path
  538. */
  539. struct cam_cpas_axi_per_path_bw_vote {
  540. uint32_t usage_data;
  541. uint32_t transac_type;
  542. uint32_t path_data_type;
  543. uint32_t vote_level;
  544. uint64_t camnoc_bw;
  545. uint64_t mnoc_ab_bw;
  546. uint64_t mnoc_ib_bw;
  547. };
  548. /**
  549. * struct cam_axi_vote : AXI vote
  550. *
  551. * @num_paths: Number of paths on which BW vote is sent to CPAS
  552. * @axi_path: Per path BW vote info
  553. *
  554. */
  555. struct cam_axi_vote {
  556. uint32_t num_paths;
  557. struct cam_cpas_axi_per_path_bw_vote axi_path[CAM_CPAS_MAX_PATHS_PER_CLIENT];
  558. };
  559. /**
  560. * cam_cpas_prepare_subpart_info()
  561. *
  562. * @brief: API to update the number of ifes, ife_lites, sfes and custom
  563. * in the struct cam_cpas_private_soc.
  564. *
  565. * @idx : Camera subpart index
  566. * @num_subpart_available : Number of available subparts
  567. * @num_subpart_functional: Number of functional subparts
  568. *
  569. * @returns 0 on success & -EINVAL when @subpart_type is invalid.
  570. *
  571. */
  572. int cam_cpas_prepare_subpart_info(
  573. enum cam_subparts_index idx, uint32_t num_subpart_available,
  574. uint32_t num_subpart_functional);
  575. /**
  576. * cam_cpas_register_client()
  577. *
  578. * @brief: API to register cpas client
  579. *
  580. * @register_params: Input params to register as a client to CPAS
  581. *
  582. * @return 0 on success.
  583. *
  584. */
  585. int cam_cpas_register_client(
  586. struct cam_cpas_register_params *register_params);
  587. /**
  588. * cam_cpas_unregister_client()
  589. *
  590. * @brief: API to unregister cpas client
  591. *
  592. * @client_handle: Client handle to be unregistered
  593. *
  594. * @return 0 on success.
  595. *
  596. */
  597. int cam_cpas_unregister_client(uint32_t client_handle);
  598. /**
  599. * cam_cpas_start()
  600. *
  601. * @brief: API to start cpas client hw. Clients have to vote for minimal
  602. * bandwidth requirements for AHB, AXI. Use cam_cpas_update_ahb_vote
  603. * to scale bandwidth after start.
  604. *
  605. * @client_handle: client cpas handle
  606. * @ahb_vote : Pointer to ahb vote info
  607. * @axi_vote : Pointer to axi bandwidth vote info
  608. *
  609. * If AXI vote is not applicable to a particular client, use the value exposed
  610. * by CAM_CPAS_DEFAULT_AXI_BW as the default vote request.
  611. *
  612. * @return 0 on success.
  613. *
  614. */
  615. int cam_cpas_start(
  616. uint32_t client_handle,
  617. struct cam_ahb_vote *ahb_vote,
  618. struct cam_axi_vote *axi_vote);
  619. /**
  620. * cam_cpas_stop()
  621. *
  622. * @brief: API to stop cpas client hw. Bandwidth for AHB, AXI votes
  623. * would be removed for this client on this call. Clients should not
  624. * use cam_cpas_update_ahb_vote or cam_cpas_update_axi_vote
  625. * to remove their bandwidth vote.
  626. *
  627. * @client_handle: client cpas handle
  628. *
  629. * @return 0 on success.
  630. *
  631. */
  632. int cam_cpas_stop(uint32_t client_handle);
  633. /**
  634. * cam_cpas_update_ahb_vote()
  635. *
  636. * @brief: API to update AHB vote requirement. Use this function only
  637. * between cam_cpas_start and cam_cpas_stop in case clients wants
  638. * to scale to different vote level. Do not use this function to de-vote,
  639. * removing client's vote is implicit on cam_cpas_stop
  640. *
  641. * @client_handle : Client cpas handle
  642. * @ahb_vote : Pointer to ahb vote info
  643. *
  644. * @return 0 on success.
  645. *
  646. */
  647. int cam_cpas_update_ahb_vote(
  648. uint32_t client_handle,
  649. struct cam_ahb_vote *ahb_vote);
  650. /**
  651. * cam_cpas_update_axi_vote()
  652. *
  653. * @brief: API to update AXI vote requirement. Use this function only
  654. * between cam_cpas_start and cam_cpas_stop in case clients wants
  655. * to scale to different vote level. Do not use this function to de-vote,
  656. * removing client's vote is implicit on cam_cpas_stop
  657. *
  658. * @client_handle : Client cpas handle
  659. * @axi_vote : Pointer to axi bandwidth vote info
  660. *
  661. * @return 0 on success.
  662. *
  663. */
  664. int cam_cpas_update_axi_vote(
  665. uint32_t client_handle,
  666. struct cam_axi_vote *axi_vote);
  667. /**
  668. * cam_cpas_reg_write()
  669. *
  670. * @brief: API to write a register value in CPAS register space
  671. *
  672. * @client_handle : Client cpas handle
  673. * @reg_base : Register base identifier
  674. * @offset : Offset from the register base address
  675. * @mb : Whether to do reg write with memory barrier
  676. * @value : Value to be written in register
  677. *
  678. * @return 0 on success.
  679. *
  680. */
  681. int cam_cpas_reg_write(
  682. uint32_t client_handle,
  683. enum cam_cpas_regbase_types reg_base,
  684. uint32_t offset,
  685. bool mb,
  686. uint32_t value);
  687. /**
  688. * cam_cpas_reg_read()
  689. *
  690. * @brief: API to read a register value from CPAS register space
  691. *
  692. * @client_handle : Client cpas handle
  693. * @reg_base : Register base identifier
  694. * @offset : Offset from the register base address
  695. * @mb : Whether to do reg read with memory barrier
  696. * @value : Value to be red from register
  697. *
  698. * @return 0 on success.
  699. *
  700. */
  701. int cam_cpas_reg_read(
  702. uint32_t client_handle,
  703. enum cam_cpas_regbase_types reg_base,
  704. uint32_t offset,
  705. bool mb,
  706. uint32_t *value);
  707. /**
  708. * cam_cpas_get_hw_info()
  709. *
  710. * @brief: API to get camera hw information
  711. *
  712. * @camera_family : Camera family type. One of
  713. * CAM_FAMILY_CAMERA_SS
  714. * CAM_FAMILY_CPAS_SS
  715. * @camera_version : Camera platform version
  716. * @cpas_version : Camera cpas version
  717. * @cam_caps : Camera capability array
  718. * @num_cap_mask : number of capability masks
  719. * @cam_fuse_info : Camera fuse info
  720. * @domain_id_info : Domain id info
  721. *
  722. * @return 0 on success.
  723. *
  724. */
  725. int cam_cpas_get_hw_info(
  726. uint32_t *camera_family,
  727. struct cam_hw_version *camera_version,
  728. struct cam_hw_version *cpas_version,
  729. uint32_t **cam_caps,
  730. uint32_t *num_cap_mask,
  731. struct cam_cpas_fuse_info *cam_fuse_info,
  732. struct cam_cpas_domain_id_caps *domain_id_info);
  733. /**
  734. * cam_cpas_get_cpas_hw_version()
  735. *
  736. * @brief: API to get camera cpas hw version
  737. *
  738. * @hw_version : Camera cpas hw version
  739. *
  740. * @return 0 on success.
  741. *
  742. */
  743. int cam_cpas_get_cpas_hw_version(uint32_t *hw_version);
  744. /**
  745. * cam_cpas_is_feature_supported()
  746. *
  747. * @brief: API to get camera features
  748. *
  749. * @flag : Camera hw features to check
  750. *
  751. * @hw_map : To indicate which HWs are supported
  752. *
  753. * @fule_val : Return fule value in case of value type feature
  754. *
  755. * @return 1 if feature is supported
  756. *
  757. */
  758. bool cam_cpas_is_feature_supported(uint32_t flag, uint32_t hw_map,
  759. uint32_t *fuse_val);
  760. /**
  761. * cam_cpas_axi_util_path_type_to_string()
  762. *
  763. * @brief: API to get string for given path type
  764. *
  765. * @path_data_type : Path type
  766. *
  767. * @return string.
  768. *
  769. */
  770. const char *cam_cpas_axi_util_path_type_to_string(
  771. uint32_t path_data_type);
  772. /**
  773. * cam_cpas_axi_util_trans_type_to_string()
  774. *
  775. * @brief: API to get string for given transaction type
  776. *
  777. * @path_data_type : Transaction type
  778. *
  779. * @return string.
  780. *
  781. */
  782. const char *cam_cpas_axi_util_trans_type_to_string(
  783. uint32_t path_data_type);
  784. /**
  785. * cam_cpas_axi_util_drv_vote_lvl_to_string()
  786. *
  787. * @brief: API to get string for given DRV vote level
  788. *
  789. * @vote_lvl : DRV vote level
  790. *
  791. * @return string.
  792. *
  793. */
  794. const char *cam_cpas_axi_util_drv_vote_lvl_to_string(
  795. uint32_t vote_lvl);
  796. /**
  797. * cam_cpas_util_vote_type_to_string()
  798. *
  799. * @brief: API to get string for given vote type
  800. *
  801. * @vote_type : DRV vote level
  802. *
  803. * @return string.
  804. *
  805. */
  806. const char *cam_cpas_util_vote_type_to_string(enum cam_cpas_vote_type vote_type);
  807. /**
  808. * cam_cpas_log_votes()
  809. *
  810. * @brief: API to print the all bw votes of axi client. It also print the
  811. * applied camnoc axi clock vote value and ahb vote value
  812. *
  813. * @ddr_only: Print only DDR info
  814. *
  815. * @return 0 on success.
  816. *
  817. */
  818. void cam_cpas_log_votes(bool ddr_only);
  819. /**
  820. * cam_cpas_select_qos_settings()
  821. *
  822. * @brief: API to select specific qos settings based on usecase requirements
  823. *
  824. * @return 0 on success.
  825. *
  826. */
  827. int cam_cpas_select_qos_settings(uint32_t selection_mask);
  828. /**
  829. * cam_cpas_notify_event()
  830. *
  831. * @brief: API that clients can notify about their events. CPAS save the event
  832. * and any other useful information related to this event. This will
  833. * be printed while cpas state dump - cam_cpas_log_votes.
  834. * One such example is IFE notifiying SOF or EPOCH to cpas and cpas
  835. * saving axi clock information (camnoc_axi, mnoc_hf) at that point
  836. * and printing latest history on IFE overflow.
  837. *
  838. * @identifier_string: Identifier string passed by caller
  839. * @identifier_value: Identifier value passed by caller
  840. *
  841. * @return 0 on success.
  842. *
  843. */
  844. int cam_cpas_notify_event(const char *identifier_string,
  845. int32_t identifier_value);
  846. /**
  847. * cam_cpas_get_scid()
  848. *
  849. * @brief: API to obtain slice id for the given type
  850. *
  851. * @type: Cache type
  852. *
  853. * @return slice id, -1 for invalid id.
  854. *
  855. */
  856. int cam_cpas_get_scid(enum cam_sys_cache_config_types type);
  857. /**
  858. * cam_cpas_activate_llcc()
  859. *
  860. * @brief: API to activate system cache
  861. *
  862. * @type: Cache type
  863. *
  864. * @return 0 for success.
  865. *
  866. */
  867. int cam_cpas_activate_llcc(enum cam_sys_cache_config_types type);
  868. /**
  869. * cam_cpas_deactivate_llcc()
  870. *
  871. * @brief: API to de-activate system cache
  872. *
  873. * @type: Cache type
  874. *
  875. * @return 0 for success.
  876. *
  877. */
  878. int cam_cpas_deactivate_llcc(enum cam_sys_cache_config_types type);
  879. /**
  880. * cam_cpas_configure_staling_llcc()
  881. *
  882. * @brief: Configure cache staling mode by setting the
  883. * staling_mode and corresponding params
  884. *
  885. * @type: Cache type
  886. * @mode_param: llcc stalling mode params
  887. * @operation_type: cache operation type
  888. * @stalling_distance: llcc sys cache stalling distance
  889. *
  890. * @return 0 for success.
  891. *
  892. */
  893. int cam_cpas_configure_staling_llcc(
  894. enum cam_sys_cache_config_types type,
  895. enum cam_sys_cache_llcc_staling_mode mode_param,
  896. enum cam_sys_cache_llcc_staling_op_type operation_type,
  897. uint32_t staling_distance);
  898. /**
  899. * cam_cpas_notif_increment_staling_counter()
  900. *
  901. * @brief: This will increment the stalling counter
  902. * depends on what operation it does.
  903. * The operation mode what we have setup in other function.
  904. *
  905. * @type: Cache type
  906. *
  907. * @return 0 for success.
  908. *
  909. */
  910. int cam_cpas_notif_increment_staling_counter(
  911. enum cam_sys_cache_config_types type);
  912. /**
  913. * cam_cpas_dump_camnoc_buff_fill_info()
  914. *
  915. * @brief: API to dump camnoc buffer fill level info
  916. *
  917. * @client_handle : Client cpas handle
  918. *
  919. * @return 0 on success
  920. *
  921. */
  922. int cam_cpas_dump_camnoc_buff_fill_info(uint32_t client_handle);
  923. /**
  924. * cam_cpas_csid_input_core_info_update()
  925. *
  926. * @brief: API to communicate csid input core info to cpas
  927. *
  928. * @csid_idx: csid hw index connected to particular sfe
  929. * @sfe_idx: sfe idx to be connected to particular DRV path
  930. * @set_port: Indicates whether to set or reset DRV port info in dynamic client
  931. *
  932. * @return 0 on success
  933. *
  934. */
  935. int cam_cpas_csid_input_core_info_update(int csid_idx, int sfe_idx, bool set_port);
  936. /**
  937. * cam_cpas_csid_process_resume()
  938. *
  939. * @brief: API to process csid resume in cpas
  940. * @csid_idx: CSID idx to notify resume for
  941. *
  942. * @return 0 on success
  943. *
  944. */
  945. int cam_cpas_csid_process_resume(uint32_t csid_idx);
  946. /**
  947. * cam_cpas_query_drv_enable()
  948. *
  949. * @brief: API to indicate DRV enabled on hw or not
  950. * @is_ddr_drv_enabled: If DDR DRV enabled
  951. * @is_clk_drv_enabled: If Clock Cesta DRV enabled
  952. *
  953. * @return 0 on success
  954. *
  955. */
  956. int cam_cpas_query_drv_enable(bool *is_ddr_drv_enabled, bool *is_clk_drv_enabled);
  957. /**
  958. * cam_cpas_query_domain_id_security_support()
  959. * @brief: API to determine if target supports domain id feature
  960. * This information is determined by cpas during probe
  961. *
  962. * @return true if there's support, false otherwise
  963. */
  964. bool cam_cpas_query_domain_id_security_support(void);
  965. /**
  966. * cam_cpas_enable_clks_for_domain_id()
  967. *
  968. * @brief: API to enable/disable clocks for domain id support.
  969. * All CSIDs including those not in use for a ctxt
  970. * needs to be programmed in a secure session.
  971. * @enable: True to turn on, false otherwise.
  972. * @return 0 on success
  973. */
  974. int cam_cpas_enable_clks_for_domain_id(bool enable);
  975. /**
  976. * cam_cpas_is_notif_staling_supported()
  977. *
  978. * @brief: API to check stalling feature is supported or not
  979. *
  980. * @return rue if supported
  981. */
  982. bool cam_cpas_is_notif_staling_supported(void);
  983. /**
  984. * cam_cpas_dump_state_monitor_info()
  985. *
  986. * @brief: API to dump the state monitor info of cpas.
  987. * @info: Dump information.
  988. * @return 0 on success
  989. */
  990. int cam_cpas_dump_state_monitor_info(struct cam_req_mgr_dump_info *info);
  991. #endif /* _CAM_CPAS_API_H_ */