ufs.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2013-2014, The Linux Foundation. All rights reserved.
  4. */
  5. #undef TRACE_SYSTEM
  6. #define TRACE_SYSTEM ufs
  7. #if !defined(_TRACE_UFS_H) || defined(TRACE_HEADER_MULTI_READ)
  8. #define _TRACE_UFS_H
  9. #include <linux/tracepoint.h>
  10. #define str_opcode(opcode) \
  11. __print_symbolic(opcode, \
  12. { WRITE_16, "WRITE_16" }, \
  13. { WRITE_10, "WRITE_10" }, \
  14. { READ_16, "READ_16" }, \
  15. { READ_10, "READ_10" }, \
  16. { SYNCHRONIZE_CACHE, "SYNC" }, \
  17. { UNMAP, "UNMAP" })
  18. #define UFS_LINK_STATES \
  19. EM(UIC_LINK_OFF_STATE, "UIC_LINK_OFF_STATE") \
  20. EM(UIC_LINK_ACTIVE_STATE, "UIC_LINK_ACTIVE_STATE") \
  21. EMe(UIC_LINK_HIBERN8_STATE, "UIC_LINK_HIBERN8_STATE")
  22. #define UFS_PWR_MODES \
  23. EM(UFS_ACTIVE_PWR_MODE, "UFS_ACTIVE_PWR_MODE") \
  24. EM(UFS_SLEEP_PWR_MODE, "UFS_SLEEP_PWR_MODE") \
  25. EM(UFS_POWERDOWN_PWR_MODE, "UFS_POWERDOWN_PWR_MODE") \
  26. EMe(UFS_DEEPSLEEP_PWR_MODE, "UFS_DEEPSLEEP_PWR_MODE")
  27. #define UFSCHD_CLK_GATING_STATES \
  28. EM(CLKS_OFF, "CLKS_OFF") \
  29. EM(CLKS_ON, "CLKS_ON") \
  30. EM(REQ_CLKS_OFF, "REQ_CLKS_OFF") \
  31. EMe(REQ_CLKS_ON, "REQ_CLKS_ON")
  32. #define UFS_CMD_TRACE_STRINGS \
  33. EM(UFS_CMD_SEND, "send_req") \
  34. EM(UFS_CMD_COMP, "complete_rsp") \
  35. EM(UFS_DEV_COMP, "dev_complete") \
  36. EM(UFS_QUERY_SEND, "query_send") \
  37. EM(UFS_QUERY_COMP, "query_complete") \
  38. EM(UFS_QUERY_ERR, "query_complete_err") \
  39. EM(UFS_TM_SEND, "tm_send") \
  40. EM(UFS_TM_COMP, "tm_complete") \
  41. EMe(UFS_TM_ERR, "tm_complete_err")
  42. #define UFS_CMD_TRACE_TSF_TYPES \
  43. EM(UFS_TSF_CDB, "CDB") \
  44. EM(UFS_TSF_OSF, "OSF") \
  45. EM(UFS_TSF_TM_INPUT, "TM_INPUT") \
  46. EMe(UFS_TSF_TM_OUTPUT, "TM_OUTPUT")
  47. /* Enums require being exported to userspace, for user tool parsing */
  48. #undef EM
  49. #undef EMe
  50. #define EM(a, b) TRACE_DEFINE_ENUM(a);
  51. #define EMe(a, b) TRACE_DEFINE_ENUM(a);
  52. UFS_LINK_STATES;
  53. UFS_PWR_MODES;
  54. UFSCHD_CLK_GATING_STATES;
  55. UFS_CMD_TRACE_STRINGS
  56. UFS_CMD_TRACE_TSF_TYPES
  57. /*
  58. * Now redefine the EM() and EMe() macros to map the enums to the strings
  59. * that will be printed in the output.
  60. */
  61. #undef EM
  62. #undef EMe
  63. #define EM(a, b) {a, b},
  64. #define EMe(a, b) {a, b}
  65. #define show_ufs_cmd_trace_str(str_t) \
  66. __print_symbolic(str_t, UFS_CMD_TRACE_STRINGS)
  67. #define show_ufs_cmd_trace_tsf(tsf) \
  68. __print_symbolic(tsf, UFS_CMD_TRACE_TSF_TYPES)
  69. TRACE_EVENT(ufshcd_clk_gating,
  70. TP_PROTO(const char *dev_name, int state),
  71. TP_ARGS(dev_name, state),
  72. TP_STRUCT__entry(
  73. __string(dev_name, dev_name)
  74. __field(int, state)
  75. ),
  76. TP_fast_assign(
  77. __assign_str(dev_name, dev_name);
  78. __entry->state = state;
  79. ),
  80. TP_printk("%s: gating state changed to %s",
  81. __get_str(dev_name),
  82. __print_symbolic(__entry->state, UFSCHD_CLK_GATING_STATES))
  83. );
  84. TRACE_EVENT(ufshcd_clk_scaling,
  85. TP_PROTO(const char *dev_name, const char *state, const char *clk,
  86. u32 prev_state, u32 curr_state),
  87. TP_ARGS(dev_name, state, clk, prev_state, curr_state),
  88. TP_STRUCT__entry(
  89. __string(dev_name, dev_name)
  90. __string(state, state)
  91. __string(clk, clk)
  92. __field(u32, prev_state)
  93. __field(u32, curr_state)
  94. ),
  95. TP_fast_assign(
  96. __assign_str(dev_name, dev_name);
  97. __assign_str(state, state);
  98. __assign_str(clk, clk);
  99. __entry->prev_state = prev_state;
  100. __entry->curr_state = curr_state;
  101. ),
  102. TP_printk("%s: %s %s from %u to %u Hz",
  103. __get_str(dev_name), __get_str(state), __get_str(clk),
  104. __entry->prev_state, __entry->curr_state)
  105. );
  106. TRACE_EVENT(ufshcd_auto_bkops_state,
  107. TP_PROTO(const char *dev_name, const char *state),
  108. TP_ARGS(dev_name, state),
  109. TP_STRUCT__entry(
  110. __string(dev_name, dev_name)
  111. __string(state, state)
  112. ),
  113. TP_fast_assign(
  114. __assign_str(dev_name, dev_name);
  115. __assign_str(state, state);
  116. ),
  117. TP_printk("%s: auto bkops - %s",
  118. __get_str(dev_name), __get_str(state))
  119. );
  120. DECLARE_EVENT_CLASS(ufshcd_profiling_template,
  121. TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
  122. int err),
  123. TP_ARGS(dev_name, profile_info, time_us, err),
  124. TP_STRUCT__entry(
  125. __string(dev_name, dev_name)
  126. __string(profile_info, profile_info)
  127. __field(s64, time_us)
  128. __field(int, err)
  129. ),
  130. TP_fast_assign(
  131. __assign_str(dev_name, dev_name);
  132. __assign_str(profile_info, profile_info);
  133. __entry->time_us = time_us;
  134. __entry->err = err;
  135. ),
  136. TP_printk("%s: %s: took %lld usecs, err %d",
  137. __get_str(dev_name), __get_str(profile_info),
  138. __entry->time_us, __entry->err)
  139. );
  140. DEFINE_EVENT(ufshcd_profiling_template, ufshcd_profile_hibern8,
  141. TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
  142. int err),
  143. TP_ARGS(dev_name, profile_info, time_us, err));
  144. DEFINE_EVENT(ufshcd_profiling_template, ufshcd_profile_clk_gating,
  145. TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
  146. int err),
  147. TP_ARGS(dev_name, profile_info, time_us, err));
  148. DEFINE_EVENT(ufshcd_profiling_template, ufshcd_profile_clk_scaling,
  149. TP_PROTO(const char *dev_name, const char *profile_info, s64 time_us,
  150. int err),
  151. TP_ARGS(dev_name, profile_info, time_us, err));
  152. DECLARE_EVENT_CLASS(ufshcd_template,
  153. TP_PROTO(const char *dev_name, int err, s64 usecs,
  154. int dev_state, int link_state),
  155. TP_ARGS(dev_name, err, usecs, dev_state, link_state),
  156. TP_STRUCT__entry(
  157. __field(s64, usecs)
  158. __field(int, err)
  159. __string(dev_name, dev_name)
  160. __field(int, dev_state)
  161. __field(int, link_state)
  162. ),
  163. TP_fast_assign(
  164. __entry->usecs = usecs;
  165. __entry->err = err;
  166. __assign_str(dev_name, dev_name);
  167. __entry->dev_state = dev_state;
  168. __entry->link_state = link_state;
  169. ),
  170. TP_printk(
  171. "%s: took %lld usecs, dev_state: %s, link_state: %s, err %d",
  172. __get_str(dev_name),
  173. __entry->usecs,
  174. __print_symbolic(__entry->dev_state, UFS_PWR_MODES),
  175. __print_symbolic(__entry->link_state, UFS_LINK_STATES),
  176. __entry->err
  177. )
  178. );
  179. DEFINE_EVENT(ufshcd_template, ufshcd_system_suspend,
  180. TP_PROTO(const char *dev_name, int err, s64 usecs,
  181. int dev_state, int link_state),
  182. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  183. DEFINE_EVENT(ufshcd_template, ufshcd_system_resume,
  184. TP_PROTO(const char *dev_name, int err, s64 usecs,
  185. int dev_state, int link_state),
  186. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  187. DEFINE_EVENT(ufshcd_template, ufshcd_runtime_suspend,
  188. TP_PROTO(const char *dev_name, int err, s64 usecs,
  189. int dev_state, int link_state),
  190. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  191. DEFINE_EVENT(ufshcd_template, ufshcd_runtime_resume,
  192. TP_PROTO(const char *dev_name, int err, s64 usecs,
  193. int dev_state, int link_state),
  194. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  195. DEFINE_EVENT(ufshcd_template, ufshcd_init,
  196. TP_PROTO(const char *dev_name, int err, s64 usecs,
  197. int dev_state, int link_state),
  198. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  199. DEFINE_EVENT(ufshcd_template, ufshcd_wl_suspend,
  200. TP_PROTO(const char *dev_name, int err, s64 usecs,
  201. int dev_state, int link_state),
  202. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  203. DEFINE_EVENT(ufshcd_template, ufshcd_wl_resume,
  204. TP_PROTO(const char *dev_name, int err, s64 usecs,
  205. int dev_state, int link_state),
  206. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  207. DEFINE_EVENT(ufshcd_template, ufshcd_wl_runtime_suspend,
  208. TP_PROTO(const char *dev_name, int err, s64 usecs,
  209. int dev_state, int link_state),
  210. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  211. DEFINE_EVENT(ufshcd_template, ufshcd_wl_runtime_resume,
  212. TP_PROTO(const char *dev_name, int err, s64 usecs,
  213. int dev_state, int link_state),
  214. TP_ARGS(dev_name, err, usecs, dev_state, link_state));
  215. TRACE_EVENT(ufshcd_command,
  216. TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t,
  217. unsigned int tag, u32 doorbell, u32 hwq_id, int transfer_len,
  218. u32 intr, u64 lba, u8 opcode, u8 group_id),
  219. TP_ARGS(dev_name, str_t, tag, doorbell, hwq_id, transfer_len,
  220. intr, lba, opcode, group_id),
  221. TP_STRUCT__entry(
  222. __string(dev_name, dev_name)
  223. __field(enum ufs_trace_str_t, str_t)
  224. __field(unsigned int, tag)
  225. __field(u32, doorbell)
  226. __field(u32, hwq_id)
  227. __field(u32, intr)
  228. __field(u64, lba)
  229. __field(int, transfer_len)
  230. __field(u8, opcode)
  231. __field(u8, group_id)
  232. ),
  233. TP_fast_assign(
  234. __assign_str(dev_name, dev_name);
  235. __entry->str_t = str_t;
  236. __entry->tag = tag;
  237. __entry->doorbell = doorbell;
  238. __entry->hwq_id = hwq_id;
  239. __entry->intr = intr;
  240. __entry->lba = lba;
  241. __entry->transfer_len = transfer_len;
  242. __entry->opcode = opcode;
  243. __entry->group_id = group_id;
  244. ),
  245. TP_printk(
  246. "%s: %s: tag: %u, DB: 0x%x, size: %d, IS: %u, LBA: %llu, opcode: 0x%x (%s), group_id: 0x%x, hwq_id: %d",
  247. show_ufs_cmd_trace_str(__entry->str_t), __get_str(dev_name),
  248. __entry->tag, __entry->doorbell, __entry->transfer_len, __entry->intr,
  249. __entry->lba, (u32)__entry->opcode, str_opcode(__entry->opcode),
  250. (u32)__entry->group_id, __entry->hwq_id
  251. )
  252. );
  253. TRACE_EVENT(ufshcd_uic_command,
  254. TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t, u32 cmd,
  255. u32 arg1, u32 arg2, u32 arg3),
  256. TP_ARGS(dev_name, str_t, cmd, arg1, arg2, arg3),
  257. TP_STRUCT__entry(
  258. __string(dev_name, dev_name)
  259. __field(enum ufs_trace_str_t, str_t)
  260. __field(u32, cmd)
  261. __field(u32, arg1)
  262. __field(u32, arg2)
  263. __field(u32, arg3)
  264. ),
  265. TP_fast_assign(
  266. __assign_str(dev_name, dev_name);
  267. __entry->str_t = str_t;
  268. __entry->cmd = cmd;
  269. __entry->arg1 = arg1;
  270. __entry->arg2 = arg2;
  271. __entry->arg3 = arg3;
  272. ),
  273. TP_printk(
  274. "%s: %s: cmd: 0x%x, arg1: 0x%x, arg2: 0x%x, arg3: 0x%x",
  275. show_ufs_cmd_trace_str(__entry->str_t), __get_str(dev_name),
  276. __entry->cmd, __entry->arg1, __entry->arg2, __entry->arg3
  277. )
  278. );
  279. TRACE_EVENT(ufshcd_upiu,
  280. TP_PROTO(const char *dev_name, enum ufs_trace_str_t str_t, void *hdr,
  281. void *tsf, enum ufs_trace_tsf_t tsf_t),
  282. TP_ARGS(dev_name, str_t, hdr, tsf, tsf_t),
  283. TP_STRUCT__entry(
  284. __string(dev_name, dev_name)
  285. __field(enum ufs_trace_str_t, str_t)
  286. __array(unsigned char, hdr, 12)
  287. __array(unsigned char, tsf, 16)
  288. __field(enum ufs_trace_tsf_t, tsf_t)
  289. ),
  290. TP_fast_assign(
  291. __assign_str(dev_name, dev_name);
  292. __entry->str_t = str_t;
  293. memcpy(__entry->hdr, hdr, sizeof(__entry->hdr));
  294. memcpy(__entry->tsf, tsf, sizeof(__entry->tsf));
  295. __entry->tsf_t = tsf_t;
  296. ),
  297. TP_printk(
  298. "%s: %s: HDR:%s, %s:%s",
  299. show_ufs_cmd_trace_str(__entry->str_t), __get_str(dev_name),
  300. __print_hex(__entry->hdr, sizeof(__entry->hdr)),
  301. show_ufs_cmd_trace_tsf(__entry->tsf_t),
  302. __print_hex(__entry->tsf, sizeof(__entry->tsf))
  303. )
  304. );
  305. TRACE_EVENT(ufshcd_exception_event,
  306. TP_PROTO(const char *dev_name, u16 status),
  307. TP_ARGS(dev_name, status),
  308. TP_STRUCT__entry(
  309. __string(dev_name, dev_name)
  310. __field(u16, status)
  311. ),
  312. TP_fast_assign(
  313. __assign_str(dev_name, dev_name);
  314. __entry->status = status;
  315. ),
  316. TP_printk("%s: status 0x%x",
  317. __get_str(dev_name), __entry->status
  318. )
  319. );
  320. #endif /* if !defined(_TRACE_UFS_H) || defined(TRACE_HEADER_MULTI_READ) */
  321. /* This part must be outside protection */
  322. #include <trace/define_trace.h>