ata: libata: add qc_prep tracepoint
[platform/kernel/linux-starfive.git] / include / trace / events / libata.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #undef TRACE_SYSTEM
3 #define TRACE_SYSTEM libata
4
5 #if !defined(_TRACE_LIBATA_H) || defined(TRACE_HEADER_MULTI_READ)
6 #define _TRACE_LIBATA_H
7
8 #include <linux/ata.h>
9 #include <linux/libata.h>
10 #include <linux/tracepoint.h>
11 #include <linux/trace_seq.h>
12
13 #define ata_opcode_name(opcode) { opcode, #opcode }
14 #define show_opcode_name(val)                                   \
15         __print_symbolic(val,                                   \
16                  ata_opcode_name(ATA_CMD_DEV_RESET),            \
17                  ata_opcode_name(ATA_CMD_CHK_POWER),            \
18                  ata_opcode_name(ATA_CMD_STANDBY),              \
19                  ata_opcode_name(ATA_CMD_IDLE),                 \
20                  ata_opcode_name(ATA_CMD_EDD),                  \
21                  ata_opcode_name(ATA_CMD_DOWNLOAD_MICRO),       \
22                  ata_opcode_name(ATA_CMD_DOWNLOAD_MICRO_DMA),   \
23                  ata_opcode_name(ATA_CMD_NOP),                  \
24                  ata_opcode_name(ATA_CMD_FLUSH),                \
25                  ata_opcode_name(ATA_CMD_FLUSH_EXT),            \
26                  ata_opcode_name(ATA_CMD_ID_ATA),               \
27                  ata_opcode_name(ATA_CMD_ID_ATAPI),             \
28                  ata_opcode_name(ATA_CMD_SERVICE),              \
29                  ata_opcode_name(ATA_CMD_READ),                 \
30                  ata_opcode_name(ATA_CMD_READ_EXT),             \
31                  ata_opcode_name(ATA_CMD_READ_QUEUED),          \
32                  ata_opcode_name(ATA_CMD_READ_STREAM_EXT),      \
33                  ata_opcode_name(ATA_CMD_READ_STREAM_DMA_EXT),  \
34                  ata_opcode_name(ATA_CMD_WRITE),                \
35                  ata_opcode_name(ATA_CMD_WRITE_EXT),            \
36                  ata_opcode_name(ATA_CMD_WRITE_QUEUED),         \
37                  ata_opcode_name(ATA_CMD_WRITE_STREAM_EXT),     \
38                  ata_opcode_name(ATA_CMD_WRITE_STREAM_DMA_EXT), \
39                  ata_opcode_name(ATA_CMD_WRITE_FUA_EXT),        \
40                  ata_opcode_name(ATA_CMD_WRITE_QUEUED_FUA_EXT), \
41                  ata_opcode_name(ATA_CMD_FPDMA_READ),           \
42                  ata_opcode_name(ATA_CMD_FPDMA_WRITE),          \
43                  ata_opcode_name(ATA_CMD_NCQ_NON_DATA),         \
44                  ata_opcode_name(ATA_CMD_FPDMA_SEND),           \
45                  ata_opcode_name(ATA_CMD_FPDMA_RECV),           \
46                  ata_opcode_name(ATA_CMD_PIO_READ),             \
47                  ata_opcode_name(ATA_CMD_PIO_READ_EXT),         \
48                  ata_opcode_name(ATA_CMD_PIO_WRITE),            \
49                  ata_opcode_name(ATA_CMD_PIO_WRITE_EXT),        \
50                  ata_opcode_name(ATA_CMD_READ_MULTI),           \
51                  ata_opcode_name(ATA_CMD_READ_MULTI_EXT),       \
52                  ata_opcode_name(ATA_CMD_WRITE_MULTI),          \
53                  ata_opcode_name(ATA_CMD_WRITE_MULTI_EXT),      \
54                  ata_opcode_name(ATA_CMD_WRITE_MULTI_FUA_EXT),  \
55                  ata_opcode_name(ATA_CMD_SET_FEATURES),         \
56                  ata_opcode_name(ATA_CMD_SET_MULTI),            \
57                  ata_opcode_name(ATA_CMD_PACKET),               \
58                  ata_opcode_name(ATA_CMD_VERIFY),               \
59                  ata_opcode_name(ATA_CMD_VERIFY_EXT),           \
60                  ata_opcode_name(ATA_CMD_WRITE_UNCORR_EXT),     \
61                  ata_opcode_name(ATA_CMD_STANDBYNOW1),          \
62                  ata_opcode_name(ATA_CMD_IDLEIMMEDIATE),        \
63                  ata_opcode_name(ATA_CMD_SLEEP),                \
64                  ata_opcode_name(ATA_CMD_INIT_DEV_PARAMS),      \
65                  ata_opcode_name(ATA_CMD_READ_NATIVE_MAX),      \
66                  ata_opcode_name(ATA_CMD_READ_NATIVE_MAX_EXT),  \
67                  ata_opcode_name(ATA_CMD_SET_MAX),              \
68                  ata_opcode_name(ATA_CMD_SET_MAX_EXT),          \
69                  ata_opcode_name(ATA_CMD_READ_LOG_EXT),         \
70                  ata_opcode_name(ATA_CMD_WRITE_LOG_EXT),        \
71                  ata_opcode_name(ATA_CMD_READ_LOG_DMA_EXT),     \
72                  ata_opcode_name(ATA_CMD_WRITE_LOG_DMA_EXT),    \
73                  ata_opcode_name(ATA_CMD_TRUSTED_NONDATA),      \
74                  ata_opcode_name(ATA_CMD_TRUSTED_RCV),          \
75                  ata_opcode_name(ATA_CMD_TRUSTED_RCV_DMA),      \
76                  ata_opcode_name(ATA_CMD_TRUSTED_SND),          \
77                  ata_opcode_name(ATA_CMD_TRUSTED_SND_DMA),      \
78                  ata_opcode_name(ATA_CMD_PMP_READ),             \
79                  ata_opcode_name(ATA_CMD_PMP_READ_DMA),         \
80                  ata_opcode_name(ATA_CMD_PMP_WRITE),            \
81                  ata_opcode_name(ATA_CMD_PMP_WRITE_DMA),        \
82                  ata_opcode_name(ATA_CMD_CONF_OVERLAY),         \
83                  ata_opcode_name(ATA_CMD_SEC_SET_PASS),         \
84                  ata_opcode_name(ATA_CMD_SEC_UNLOCK),           \
85                  ata_opcode_name(ATA_CMD_SEC_ERASE_PREP),       \
86                  ata_opcode_name(ATA_CMD_SEC_ERASE_UNIT),       \
87                  ata_opcode_name(ATA_CMD_SEC_FREEZE_LOCK),      \
88                  ata_opcode_name(ATA_CMD_SEC_DISABLE_PASS),     \
89                  ata_opcode_name(ATA_CMD_CONFIG_STREAM),        \
90                  ata_opcode_name(ATA_CMD_SMART),                \
91                  ata_opcode_name(ATA_CMD_MEDIA_LOCK),           \
92                  ata_opcode_name(ATA_CMD_MEDIA_UNLOCK),         \
93                  ata_opcode_name(ATA_CMD_DSM),                  \
94                  ata_opcode_name(ATA_CMD_CHK_MED_CRD_TYP),      \
95                  ata_opcode_name(ATA_CMD_CFA_REQ_EXT_ERR),      \
96                  ata_opcode_name(ATA_CMD_CFA_WRITE_NE),         \
97                  ata_opcode_name(ATA_CMD_CFA_TRANS_SECT),       \
98                  ata_opcode_name(ATA_CMD_CFA_ERASE),            \
99                  ata_opcode_name(ATA_CMD_CFA_WRITE_MULT_NE),    \
100                  ata_opcode_name(ATA_CMD_REQ_SENSE_DATA),       \
101                  ata_opcode_name(ATA_CMD_SANITIZE_DEVICE),      \
102                  ata_opcode_name(ATA_CMD_ZAC_MGMT_IN),          \
103                  ata_opcode_name(ATA_CMD_ZAC_MGMT_OUT),         \
104                  ata_opcode_name(ATA_CMD_RESTORE),              \
105                  ata_opcode_name(ATA_CMD_READ_LONG),            \
106                  ata_opcode_name(ATA_CMD_READ_LONG_ONCE),       \
107                  ata_opcode_name(ATA_CMD_WRITE_LONG),           \
108                  ata_opcode_name(ATA_CMD_WRITE_LONG_ONCE))
109
110 #define ata_error_name(result)  { result, #result }
111 #define show_error_name(val)                            \
112         __print_symbolic(val,                           \
113                 ata_error_name(ATA_ICRC),               \
114                 ata_error_name(ATA_UNC),                \
115                 ata_error_name(ATA_MC),                 \
116                 ata_error_name(ATA_IDNF),               \
117                 ata_error_name(ATA_MCR),                \
118                 ata_error_name(ATA_ABORTED),            \
119                 ata_error_name(ATA_TRK0NF),             \
120                 ata_error_name(ATA_AMNF))
121
122 #define ata_protocol_name(proto)        { proto, #proto }
123 #define show_protocol_name(val)                         \
124         __print_symbolic(val,                           \
125                 ata_protocol_name(ATA_PROT_UNKNOWN),    \
126                 ata_protocol_name(ATA_PROT_NODATA),     \
127                 ata_protocol_name(ATA_PROT_PIO),        \
128                 ata_protocol_name(ATA_PROT_DMA),        \
129                 ata_protocol_name(ATA_PROT_NCQ),        \
130                 ata_protocol_name(ATA_PROT_NCQ_NODATA), \
131                 ata_protocol_name(ATAPI_PROT_NODATA),   \
132                 ata_protocol_name(ATAPI_PROT_PIO),      \
133                 ata_protocol_name(ATAPI_PROT_DMA))
134
135 #define ata_class_name(class)   { class, #class }
136 #define show_class_name(val)                            \
137         __print_symbolic(val,                           \
138                 ata_class_name(ATA_DEV_UNKNOWN),        \
139                 ata_class_name(ATA_DEV_ATA),            \
140                 ata_class_name(ATA_DEV_ATA_UNSUP),      \
141                 ata_class_name(ATA_DEV_ATAPI),          \
142                 ata_class_name(ATA_DEV_ATAPI_UNSUP),    \
143                 ata_class_name(ATA_DEV_PMP),            \
144                 ata_class_name(ATA_DEV_PMP_UNSUP),      \
145                 ata_class_name(ATA_DEV_SEMB),           \
146                 ata_class_name(ATA_DEV_SEMB_UNSUP),     \
147                 ata_class_name(ATA_DEV_ZAC),            \
148                 ata_class_name(ATA_DEV_ZAC_UNSUP),      \
149                 ata_class_name(ATA_DEV_NONE))
150
151 const char *libata_trace_parse_status(struct trace_seq*, unsigned char);
152 #define __parse_status(s) libata_trace_parse_status(p, s)
153
154 const char *libata_trace_parse_eh_action(struct trace_seq *, unsigned int);
155 #define __parse_eh_action(a) libata_trace_parse_eh_action(p, a)
156
157 const char *libata_trace_parse_eh_err_mask(struct trace_seq *, unsigned int);
158 #define __parse_eh_err_mask(m) libata_trace_parse_eh_err_mask(p, m)
159
160 const char *libata_trace_parse_qc_flags(struct trace_seq *, unsigned int);
161 #define __parse_qc_flags(f) libata_trace_parse_qc_flags(p, f)
162
163 const char *libata_trace_parse_subcmd(struct trace_seq *, unsigned char,
164                                       unsigned char, unsigned char);
165 #define __parse_subcmd(c,f,h) libata_trace_parse_subcmd(p, c, f, h)
166
167 DECLARE_EVENT_CLASS(ata_qc_issue_template,
168
169         TP_PROTO(struct ata_queued_cmd *qc),
170
171         TP_ARGS(qc),
172
173         TP_STRUCT__entry(
174                 __field( unsigned int,  ata_port )
175                 __field( unsigned int,  ata_dev )
176                 __field( unsigned int,  tag     )
177                 __field( unsigned char, cmd     )
178                 __field( unsigned char, dev     )
179                 __field( unsigned char, lbal    )
180                 __field( unsigned char, lbam    )
181                 __field( unsigned char, lbah    )
182                 __field( unsigned char, nsect   )
183                 __field( unsigned char, feature )
184                 __field( unsigned char, hob_lbal )
185                 __field( unsigned char, hob_lbam )
186                 __field( unsigned char, hob_lbah )
187                 __field( unsigned char, hob_nsect )
188                 __field( unsigned char, hob_feature )
189                 __field( unsigned char, ctl )
190                 __field( unsigned char, proto )
191                 __field( unsigned long, flags )
192         ),
193
194         TP_fast_assign(
195                 __entry->ata_port       = qc->ap->print_id;
196                 __entry->ata_dev        = qc->dev->link->pmp + qc->dev->devno;
197                 __entry->tag            = qc->tag;
198                 __entry->proto          = qc->tf.protocol;
199                 __entry->cmd            = qc->tf.command;
200                 __entry->dev            = qc->tf.device;
201                 __entry->lbal           = qc->tf.lbal;
202                 __entry->lbam           = qc->tf.lbam;
203                 __entry->lbah           = qc->tf.lbah;
204                 __entry->hob_lbal       = qc->tf.hob_lbal;
205                 __entry->hob_lbam       = qc->tf.hob_lbam;
206                 __entry->hob_lbah       = qc->tf.hob_lbah;
207                 __entry->feature        = qc->tf.feature;
208                 __entry->hob_feature    = qc->tf.hob_feature;
209                 __entry->nsect          = qc->tf.nsect;
210                 __entry->hob_nsect      = qc->tf.hob_nsect;
211         ),
212
213         TP_printk("ata_port=%u ata_dev=%u tag=%d proto=%s cmd=%s%s " \
214                   " tf=(%02x/%02x:%02x:%02x:%02x:%02x/%02x:%02x:%02x:%02x:%02x/%02x)",
215                   __entry->ata_port, __entry->ata_dev, __entry->tag,
216                   show_protocol_name(__entry->proto),
217                   show_opcode_name(__entry->cmd),
218                   __parse_subcmd(__entry->cmd, __entry->feature, __entry->hob_nsect),
219                   __entry->cmd, __entry->feature, __entry->nsect,
220                   __entry->lbal, __entry->lbam, __entry->lbah,
221                   __entry->hob_feature, __entry->hob_nsect,
222                   __entry->hob_lbal, __entry->hob_lbam, __entry->hob_lbah,
223                   __entry->dev)
224 );
225
226 DEFINE_EVENT(ata_qc_issue_template, ata_qc_prep,
227              TP_PROTO(struct ata_queued_cmd *qc),
228              TP_ARGS(qc));
229
230 DEFINE_EVENT(ata_qc_issue_template, ata_qc_issue,
231              TP_PROTO(struct ata_queued_cmd *qc),
232              TP_ARGS(qc));
233
234 DECLARE_EVENT_CLASS(ata_qc_complete_template,
235
236         TP_PROTO(struct ata_queued_cmd *qc),
237
238         TP_ARGS(qc),
239
240         TP_STRUCT__entry(
241                 __field( unsigned int,  ata_port )
242                 __field( unsigned int,  ata_dev )
243                 __field( unsigned int,  tag     )
244                 __field( unsigned char, status  )
245                 __field( unsigned char, dev     )
246                 __field( unsigned char, lbal    )
247                 __field( unsigned char, lbam    )
248                 __field( unsigned char, lbah    )
249                 __field( unsigned char, nsect   )
250                 __field( unsigned char, error   )
251                 __field( unsigned char, hob_lbal )
252                 __field( unsigned char, hob_lbam )
253                 __field( unsigned char, hob_lbah )
254                 __field( unsigned char, hob_nsect )
255                 __field( unsigned char, hob_feature )
256                 __field( unsigned char, ctl )
257                 __field( unsigned long, flags )
258         ),
259
260         TP_fast_assign(
261                 __entry->ata_port       = qc->ap->print_id;
262                 __entry->ata_dev        = qc->dev->link->pmp + qc->dev->devno;
263                 __entry->tag            = qc->tag;
264                 __entry->status         = qc->result_tf.command;
265                 __entry->dev            = qc->result_tf.device;
266                 __entry->lbal           = qc->result_tf.lbal;
267                 __entry->lbam           = qc->result_tf.lbam;
268                 __entry->lbah           = qc->result_tf.lbah;
269                 __entry->hob_lbal       = qc->result_tf.hob_lbal;
270                 __entry->hob_lbam       = qc->result_tf.hob_lbam;
271                 __entry->hob_lbah       = qc->result_tf.hob_lbah;
272                 __entry->error          = qc->result_tf.feature;
273                 __entry->hob_feature    = qc->result_tf.hob_feature;
274                 __entry->nsect          = qc->result_tf.nsect;
275                 __entry->hob_nsect      = qc->result_tf.hob_nsect;
276         ),
277
278         TP_printk("ata_port=%u ata_dev=%u tag=%d flags=%s status=%s " \
279                   " res=(%02x/%02x:%02x:%02x:%02x:%02x/%02x:%02x:%02x:%02x:%02x/%02x)",
280                   __entry->ata_port, __entry->ata_dev, __entry->tag,
281                   __parse_qc_flags(__entry->flags),
282                   __parse_status(__entry->status),
283                   __entry->status, __entry->error, __entry->nsect,
284                   __entry->lbal, __entry->lbam, __entry->lbah,
285                   __entry->hob_feature, __entry->hob_nsect,
286                   __entry->hob_lbal, __entry->hob_lbam, __entry->hob_lbah,
287                   __entry->dev)
288 );
289
290 DEFINE_EVENT(ata_qc_complete_template, ata_qc_complete_internal,
291              TP_PROTO(struct ata_queued_cmd *qc),
292              TP_ARGS(qc));
293
294 DEFINE_EVENT(ata_qc_complete_template, ata_qc_complete_failed,
295              TP_PROTO(struct ata_queued_cmd *qc),
296              TP_ARGS(qc));
297
298 DEFINE_EVENT(ata_qc_complete_template, ata_qc_complete_done,
299              TP_PROTO(struct ata_queued_cmd *qc),
300              TP_ARGS(qc));
301
302 TRACE_EVENT(ata_eh_link_autopsy,
303
304         TP_PROTO(struct ata_device *dev, unsigned int eh_action, unsigned int eh_err_mask),
305
306         TP_ARGS(dev, eh_action, eh_err_mask),
307
308         TP_STRUCT__entry(
309                 __field( unsigned int,  ata_port )
310                 __field( unsigned int,  ata_dev )
311                 __field( unsigned int,  eh_action )
312                 __field( unsigned int,  eh_err_mask)
313         ),
314
315         TP_fast_assign(
316                 __entry->ata_port       = dev->link->ap->print_id;
317                 __entry->ata_dev        = dev->link->pmp + dev->devno;
318                 __entry->eh_action      = eh_action;
319                 __entry->eh_err_mask    = eh_err_mask;
320         ),
321
322         TP_printk("ata_port=%u ata_dev=%u eh_action=%s err_mask=%s",
323                   __entry->ata_port, __entry->ata_dev,
324                   __parse_eh_action(__entry->eh_action),
325                   __parse_eh_err_mask(__entry->eh_err_mask))
326 );
327
328 TRACE_EVENT(ata_eh_link_autopsy_qc,
329
330         TP_PROTO(struct ata_queued_cmd *qc),
331
332         TP_ARGS(qc),
333
334         TP_STRUCT__entry(
335                 __field( unsigned int,  ata_port )
336                 __field( unsigned int,  ata_dev )
337                 __field( unsigned int,  tag     )
338                 __field( unsigned int,  qc_flags )
339                 __field( unsigned int,  eh_err_mask)
340         ),
341
342         TP_fast_assign(
343                 __entry->ata_port       = qc->ap->print_id;
344                 __entry->ata_dev        = qc->dev->link->pmp + qc->dev->devno;
345                 __entry->tag            = qc->tag;
346                 __entry->qc_flags       = qc->flags;
347                 __entry->eh_err_mask    = qc->err_mask;
348         ),
349
350         TP_printk("ata_port=%u ata_dev=%u tag=%d flags=%s err_mask=%s",
351                   __entry->ata_port, __entry->ata_dev, __entry->tag,
352                   __parse_qc_flags(__entry->qc_flags),
353                   __parse_eh_err_mask(__entry->eh_err_mask))
354 );
355
356 DECLARE_EVENT_CLASS(ata_link_reset_begin_template,
357
358         TP_PROTO(struct ata_link *link, unsigned int *class, unsigned long deadline),
359
360         TP_ARGS(link, class, deadline),
361
362         TP_STRUCT__entry(
363                 __field( unsigned int,  ata_port )
364                 __array( unsigned int,  class, 2 )
365                 __field( unsigned long, deadline )
366         ),
367
368         TP_fast_assign(
369                 __entry->ata_port       = link->ap->print_id;
370                 memcpy(__entry->class, class, 2);
371                 __entry->deadline       = deadline;
372         ),
373
374         TP_printk("ata_port=%u deadline=%lu classes=[%s,%s]",
375                   __entry->ata_port, __entry->deadline,
376                   show_class_name(__entry->class[0]),
377                   show_class_name(__entry->class[1]))
378 );
379
380 DEFINE_EVENT(ata_link_reset_begin_template, ata_link_hardreset_begin,
381              TP_PROTO(struct ata_link *link, unsigned int *class, unsigned long deadline),
382              TP_ARGS(link, class, deadline));
383
384 DEFINE_EVENT(ata_link_reset_begin_template, ata_slave_hardreset_begin,
385              TP_PROTO(struct ata_link *link, unsigned int *class, unsigned long deadline),
386              TP_ARGS(link, class, deadline));
387
388 DEFINE_EVENT(ata_link_reset_begin_template, ata_link_softreset_begin,
389              TP_PROTO(struct ata_link *link, unsigned int *class, unsigned long deadline),
390              TP_ARGS(link, class, deadline));
391
392 DECLARE_EVENT_CLASS(ata_link_reset_end_template,
393
394         TP_PROTO(struct ata_link *link, unsigned int *class, int rc),
395
396         TP_ARGS(link, class, rc),
397
398         TP_STRUCT__entry(
399                 __field( unsigned int,  ata_port )
400                 __array( unsigned int,  class, 2 )
401                 __field( int,           rc      )
402         ),
403
404         TP_fast_assign(
405                 __entry->ata_port       = link->ap->print_id;
406                 memcpy(__entry->class, class, 2);
407                 __entry->rc             = rc;
408         ),
409
410         TP_printk("ata_port=%u rc=%d class=[%s,%s]",
411                   __entry->ata_port, __entry->rc,
412                   show_class_name(__entry->class[0]),
413                   show_class_name(__entry->class[1]))
414 );
415
416 DEFINE_EVENT(ata_link_reset_end_template, ata_link_hardreset_end,
417              TP_PROTO(struct ata_link *link, unsigned int *class, int rc),
418              TP_ARGS(link, class, rc));
419
420 DEFINE_EVENT(ata_link_reset_end_template, ata_slave_hardreset_end,
421              TP_PROTO(struct ata_link *link, unsigned int *class, int rc),
422              TP_ARGS(link, class, rc));
423
424 DEFINE_EVENT(ata_link_reset_end_template, ata_link_softreset_end,
425              TP_PROTO(struct ata_link *link, unsigned int *class, int rc),
426              TP_ARGS(link, class, rc));
427
428 DEFINE_EVENT(ata_link_reset_end_template, ata_link_postreset,
429              TP_PROTO(struct ata_link *link, unsigned int *class, int rc),
430              TP_ARGS(link, class, rc));
431
432 DEFINE_EVENT(ata_link_reset_end_template, ata_slave_postreset,
433              TP_PROTO(struct ata_link *link, unsigned int *class, int rc),
434              TP_ARGS(link, class, rc));
435
436 #endif /*  _TRACE_LIBATA_H */
437
438 /* This part must be outside protection */
439 #include <trace/define_trace.h>