usb: typec: tps6598x: Add trace event for IRQ events
authorGuido Günther <agx@sigxcpu.org>
Mon, 15 Feb 2021 11:46:42 +0000 (12:46 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Wed, 10 Mar 2021 08:37:14 +0000 (09:37 +0100)
Allow to get irq event information via the tracing framework.  This
allows to inspect USB-C negotiation at runtime.

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Signed-off-by: Guido Günther <agx@sigxcpu.org>
Link: https://lore.kernel.org/r/11444ae487d69da98ec20a18f2e49259e68319e3.1613389531.git.agx@sigxcpu.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/usb/typec/Makefile
drivers/usb/typec/tps6598x.c
drivers/usb/typec/tps6598x.h [new file with mode: 0644]
drivers/usb/typec/tps6598x_trace.h [new file with mode: 0644]

index d03b48c..27aa121 100644 (file)
@@ -1,4 +1,7 @@
 # SPDX-License-Identifier: GPL-2.0
+# define_trace.h needs to know how to find our header
+CFLAGS_tps6598x.o              := -I$(src)
+
 obj-$(CONFIG_TYPEC)            += typec.o
 typec-y                                := class.o mux.o bus.o
 obj-$(CONFIG_TYPEC)            += altmodes/
index 6e6ef63..bc34b35 100644 (file)
@@ -6,6 +6,8 @@
  * Author: Heikki Krogerus <heikki.krogerus@linux.intel.com>
  */
 
+#include "tps6598x.h"
+
 #include <linux/i2c.h>
 #include <linux/acpi.h>
 #include <linux/module.h>
@@ -15,6 +17,9 @@
 #include <linux/usb/typec.h>
 #include <linux/usb/role.h>
 
+#define CREATE_TRACE_POINTS
+#include "tps6598x_trace.h"
+
 /* Register offsets */
 #define TPS_REG_VID                    0x00
 #define TPS_REG_MODE                   0x03
@@ -32,9 +37,6 @@
 #define TPS_REG_POWER_STATUS           0x3f
 #define TPS_REG_RX_IDENTITY_SOP                0x48
 
-/* TPS_REG_INT_* bits */
-#define TPS_REG_INT_PLUG_EVENT         BIT(3)
-
 /* TPS_REG_STATUS bits */
 #define TPS_STATUS_PLUG_PRESENT                BIT(0)
 #define TPS_STATUS_ORIENTATION         BIT(4)
@@ -428,6 +430,7 @@ static irqreturn_t tps6598x_interrupt(int irq, void *data)
                dev_err(tps->dev, "%s: failed to read events\n", __func__);
                goto err_unlock;
        }
+       trace_tps6598x_irq(event1, event2);
 
        ret = tps6598x_read32(tps, TPS_REG_STATUS, &status);
        if (ret) {
diff --git a/drivers/usb/typec/tps6598x.h b/drivers/usb/typec/tps6598x.h
new file mode 100644 (file)
index 0000000..b83b8a6
--- /dev/null
@@ -0,0 +1,64 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+/*
+ * Driver for TI TPS6598x USB Power Delivery controller family
+ *
+ * Copyright (C) 2017, Intel Corporation
+ * Author: Heikki Krogerus <heikki.krogerus@linux.intel.com>
+ */
+
+#include <linux/bits.h>
+#include <linux/bitfield.h>
+
+#ifndef __TPS6598X_H__
+#define __TPS6598X_H__
+
+
+/* TPS_REG_INT_* bits */
+#define TPS_REG_INT_USER_VID_ALT_MODE_OTHER_VDM                BIT_ULL(27+32)
+#define TPS_REG_INT_USER_VID_ALT_MODE_ATTN_VDM         BIT_ULL(26+32)
+#define TPS_REG_INT_USER_VID_ALT_MODE_EXIT             BIT_ULL(25+32)
+#define TPS_REG_INT_USER_VID_ALT_MODE_ENTERED          BIT_ULL(24+32)
+#define TPS_REG_INT_EXIT_MODES_COMPLETE                        BIT_ULL(20+32)
+#define TPS_REG_INT_DISCOVER_MODES_COMPLETE            BIT_ULL(19+32)
+#define TPS_REG_INT_VDM_MSG_SENT                       BIT_ULL(18+32)
+#define TPS_REG_INT_VDM_ENTERED_MODE                   BIT_ULL(17+32)
+#define TPS_REG_INT_ERROR_UNABLE_TO_SOURCE             BIT_ULL(14+32)
+#define TPS_REG_INT_SRC_TRANSITION                     BIT_ULL(10+32)
+#define TPS_REG_INT_ERROR_DISCHARGE_FAILED             BIT_ULL(9+32)
+#define TPS_REG_INT_ERROR_MESSAGE_DATA                 BIT_ULL(7+32)
+#define TPS_REG_INT_ERROR_PROTOCOL_ERROR               BIT_ULL(6+32)
+#define TPS_REG_INT_ERROR_MISSING_GET_CAP_MESSAGE      BIT_ULL(4+32)
+#define TPS_REG_INT_ERROR_POWER_EVENT_OCCURRED         BIT_ULL(3+32)
+#define TPS_REG_INT_ERROR_CAN_PROVIDE_PWR_LATER                BIT_ULL(2+32)
+#define TPS_REG_INT_ERROR_CANNOT_PROVIDE_PWR           BIT_ULL(1+32)
+#define TPS_REG_INT_ERROR_DEVICE_INCOMPATIBLE          BIT_ULL(0+32)
+#define TPS_REG_INT_CMD2_COMPLETE                      BIT(31)
+#define TPS_REG_INT_CMD1_COMPLETE                      BIT(30)
+#define TPS_REG_INT_ADC_HIGH_THRESHOLD                 BIT(29)
+#define TPS_REG_INT_ADC_LOW_THRESHOLD                  BIT(28)
+#define TPS_REG_INT_PD_STATUS_UPDATE                   BIT(27)
+#define TPS_REG_INT_STATUS_UPDATE                      BIT(26)
+#define TPS_REG_INT_DATA_STATUS_UPDATE                 BIT(25)
+#define TPS_REG_INT_POWER_STATUS_UPDATE                        BIT(24)
+#define TPS_REG_INT_PP_SWITCH_CHANGED                  BIT(23)
+#define TPS_REG_INT_HIGH_VOLTAGE_WARNING               BIT(22)
+#define TPS_REG_INT_USB_HOST_PRESENT_NO_LONGER         BIT(21)
+#define TPS_REG_INT_USB_HOST_PRESENT                   BIT(20)
+#define TPS_REG_INT_GOTO_MIN_RECEIVED                  BIT(19)
+#define TPS_REG_INT_PR_SWAP_REQUESTED                  BIT(17)
+#define TPS_REG_INT_SINK_CAP_MESSAGE_READY             BIT(15)
+#define TPS_REG_INT_SOURCE_CAP_MESSAGE_READY           BIT(14)
+#define TPS_REG_INT_NEW_CONTRACT_AS_PROVIDER           BIT(13)
+#define TPS_REG_INT_NEW_CONTRACT_AS_CONSUMER           BIT(12)
+#define TPS_REG_INT_VDM_RECEIVED                       BIT(11)
+#define TPS_REG_INT_ATTENTION_RECEIVED                 BIT(10)
+#define TPS_REG_INT_OVERCURRENT                                BIT(9)
+#define TPS_REG_INT_BIST                               BIT(8)
+#define TPS_REG_INT_RDO_RECEIVED_FROM_SINK             BIT(7)
+#define TPS_REG_INT_DR_SWAP_COMPLETE                   BIT(5)
+#define TPS_REG_INT_PR_SWAP_COMPLETE                   BIT(4)
+#define TPS_REG_INT_PLUG_EVENT                         BIT(3)
+#define TPS_REG_INT_HARD_RESET                         BIT(1)
+#define TPS_REG_INT_PD_SOFT_RESET                      BIT(0)
+
+#endif /* __TPS6598X_H__ */
diff --git a/drivers/usb/typec/tps6598x_trace.h b/drivers/usb/typec/tps6598x_trace.h
new file mode 100644 (file)
index 0000000..4ec96e3
--- /dev/null
@@ -0,0 +1,97 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+/*
+ * Driver for TI TPS6598x USB Power Delivery controller family
+ *
+ * Copyright (C) 2020 Purism SPC
+ * Author: Guido Günther <agx@sigxcpu.org>
+ */
+
+#undef TRACE_SYSTEM
+#define TRACE_SYSTEM tps6598x
+
+#if !defined(_TPS6598x_TRACE_H_) || defined(TRACE_HEADER_MULTI_READ)
+#define _TPS6598X_TRACE_H_
+
+#include "tps6598x.h"
+
+#include <linux/stringify.h>
+#include <linux/types.h>
+#include <linux/tracepoint.h>
+
+#define show_irq_flags(flags) \
+       __print_flags_u64(flags, "|", \
+               { TPS_REG_INT_PD_SOFT_RESET,                    "PD_SOFT_RESET" }, \
+               { TPS_REG_INT_HARD_RESET,                       "HARD_RESET" }, \
+               { TPS_REG_INT_PLUG_EVENT,                       "PLUG_EVENT" }, \
+               { TPS_REG_INT_PR_SWAP_COMPLETE,                 "PR_SWAP_COMPLETE" }, \
+               { TPS_REG_INT_DR_SWAP_COMPLETE,                 "DR_SWAP_COMPLETE" }, \
+               { TPS_REG_INT_RDO_RECEIVED_FROM_SINK,           "RDO_RECEIVED_FROM_SINK" }, \
+               { TPS_REG_INT_BIST,                             "BIST" }, \
+               { TPS_REG_INT_OVERCURRENT,                      "OVERCURRENT" }, \
+               { TPS_REG_INT_ATTENTION_RECEIVED,               "ATTENTION_RECEIVED" }, \
+               { TPS_REG_INT_VDM_RECEIVED,                     "VDM_RECEIVED" }, \
+               { TPS_REG_INT_NEW_CONTRACT_AS_CONSUMER,         "NEW_CONTRACT_AS_CONSUMER" }, \
+               { TPS_REG_INT_NEW_CONTRACT_AS_PROVIDER,         "NEW_CONTRACT_AS_PROVIDER" }, \
+               { TPS_REG_INT_SOURCE_CAP_MESSAGE_READY,         "SOURCE_CAP_MESSAGE_READY" }, \
+               { TPS_REG_INT_SINK_CAP_MESSAGE_READY,           "SINK_CAP_MESSAGE_READY" }, \
+               { TPS_REG_INT_PR_SWAP_REQUESTED,                "PR_SWAP_REQUESTED" }, \
+               { TPS_REG_INT_GOTO_MIN_RECEIVED,                "GOTO_MIN_RECEIVED" }, \
+               { TPS_REG_INT_USB_HOST_PRESENT,                 "USB_HOST_PRESENT" }, \
+               { TPS_REG_INT_USB_HOST_PRESENT_NO_LONGER,       "USB_HOST_PRESENT_NO_LONGER" }, \
+               { TPS_REG_INT_HIGH_VOLTAGE_WARNING,             "HIGH_VOLTAGE_WARNING" }, \
+               { TPS_REG_INT_PP_SWITCH_CHANGED,                "PP_SWITCH_CHANGED" }, \
+               { TPS_REG_INT_POWER_STATUS_UPDATE,              "POWER_STATUS_UPDATE" }, \
+               { TPS_REG_INT_DATA_STATUS_UPDATE,               "DATA_STATUS_UPDATE" }, \
+               { TPS_REG_INT_STATUS_UPDATE,                    "STATUS_UPDATE" }, \
+               { TPS_REG_INT_PD_STATUS_UPDATE,                 "PD_STATUS_UPDATE" }, \
+               { TPS_REG_INT_ADC_LOW_THRESHOLD,                "ADC_LOW_THRESHOLD" }, \
+               { TPS_REG_INT_ADC_HIGH_THRESHOLD,               "ADC_HIGH_THRESHOLD" }, \
+               { TPS_REG_INT_CMD1_COMPLETE,                    "CMD1_COMPLETE" }, \
+               { TPS_REG_INT_CMD2_COMPLETE,                    "CMD2_COMPLETE" }, \
+               { TPS_REG_INT_ERROR_DEVICE_INCOMPATIBLE,        "ERROR_DEVICE_INCOMPATIBLE" }, \
+               { TPS_REG_INT_ERROR_CANNOT_PROVIDE_PWR,         "ERROR_CANNOT_PROVIDE_PWR" }, \
+               { TPS_REG_INT_ERROR_CAN_PROVIDE_PWR_LATER,      "ERROR_CAN_PROVIDE_PWR_LATER" }, \
+               { TPS_REG_INT_ERROR_POWER_EVENT_OCCURRED,       "ERROR_POWER_EVENT_OCCURRED" }, \
+               { TPS_REG_INT_ERROR_MISSING_GET_CAP_MESSAGE,    "ERROR_MISSING_GET_CAP_MESSAGE" }, \
+               { TPS_REG_INT_ERROR_PROTOCOL_ERROR,             "ERROR_PROTOCOL_ERROR" }, \
+               { TPS_REG_INT_ERROR_MESSAGE_DATA,               "ERROR_MESSAGE_DATA" }, \
+               { TPS_REG_INT_ERROR_DISCHARGE_FAILED,           "ERROR_DISCHARGE_FAILED" }, \
+               { TPS_REG_INT_SRC_TRANSITION,                   "SRC_TRANSITION" }, \
+               { TPS_REG_INT_ERROR_UNABLE_TO_SOURCE,           "ERROR_UNABLE_TO_SOURCE" }, \
+               { TPS_REG_INT_VDM_ENTERED_MODE,                 "VDM_ENTERED_MODE" }, \
+               { TPS_REG_INT_VDM_MSG_SENT,                     "VDM_MSG_SENT" }, \
+               { TPS_REG_INT_DISCOVER_MODES_COMPLETE,          "DISCOVER_MODES_COMPLETE" }, \
+               { TPS_REG_INT_EXIT_MODES_COMPLETE,              "EXIT_MODES_COMPLETE" }, \
+               { TPS_REG_INT_USER_VID_ALT_MODE_ENTERED,        "USER_VID_ALT_MODE_ENTERED" }, \
+               { TPS_REG_INT_USER_VID_ALT_MODE_EXIT,           "USER_VID_ALT_MODE_EXIT" }, \
+               { TPS_REG_INT_USER_VID_ALT_MODE_ATTN_VDM,       "USER_VID_ALT_MODE_ATTN_VDM" }, \
+               { TPS_REG_INT_USER_VID_ALT_MODE_OTHER_VDM,      "USER_VID_ALT_MODE_OTHER_VDM" })
+
+TRACE_EVENT(tps6598x_irq,
+           TP_PROTO(u64 event1,
+                    u64 event2),
+           TP_ARGS(event1, event2),
+
+           TP_STRUCT__entry(
+                            __field(u64, event1)
+                            __field(u64, event2)
+                            ),
+
+           TP_fast_assign(
+                          __entry->event1 = event1;
+                          __entry->event2 = event2;
+                          ),
+
+           TP_printk("event1=%s, event2=%s",
+                     show_irq_flags(__entry->event1),
+                     show_irq_flags(__entry->event2))
+);
+
+#endif /* _TPS6598X_TRACE_H_ */
+
+/* This part must be outside protection */
+#undef TRACE_INCLUDE_PATH
+#define TRACE_INCLUDE_FILE tps6598x_trace
+#undef TRACE_INCLUDE_PATH
+#define TRACE_INCLUDE_PATH .
+#include <trace/define_trace.h>