Skip to content

Commit

Permalink
usb: typec: tps6598x: Add trace event for status register
Browse files Browse the repository at this point in the history 
This allows to trace status information which helps to debug problems
with role switching, etc.

Signed-off-by: Guido Günther <agx@sigxcpu.org>
  • Loading branch information
@agx @intel-lab-lkp
agx authored and intel-lab-lkp committed Feb 11, 2021
1 parent bb7c408 commit 17785e4
Show file tree
Hide file tree
Showing 3 changed files with 171 additions and 15 deletions.
26 changes: 11 additions & 15 deletions drivers/usb/typec/tps6598x.c
View file
Expand Up @@ -37,13 +37,6 @@
#define TPS_REG_POWER_STATUS 0x3f
#define TPS_REG_RX_IDENTITY_SOP 0x48

/* TPS_REG_STATUS bits */
#define TPS_STATUS_PLUG_PRESENT BIT(0)
#define TPS_STATUS_ORIENTATION BIT(4)
#define TPS_STATUS_PORTROLE(s) (!!((s) & BIT(5)))
#define TPS_STATUS_DATAROLE(s) (!!((s) & BIT(6)))
#define TPS_STATUS_VCONN(s) (!!((s) & BIT(7)))

/* TPS_REG_SYSTEM_CONF bits */
#define TPS_SYSCONF_PORTINFO(c) ((c) & 7)

Expand Down Expand Up @@ -258,9 +251,9 @@ static int tps6598x_connect(struct tps6598x *tps, u32 status)
}

typec_set_pwr_opmode(tps->port, mode);
typec_set_pwr_role(tps->port, TPS_STATUS_PORTROLE(status));
typec_set_vconn_role(tps->port, TPS_STATUS_VCONN(status));
tps6598x_set_data_role(tps, TPS_STATUS_DATAROLE(status), true);
typec_set_pwr_role(tps->port, TPS_STATUS_TO_TYPEC_PORTROLE(status));
typec_set_vconn_role(tps->port, TPS_STATUS_TO_TYPEC_VCONN(status));
tps6598x_set_data_role(tps, TPS_STATUS_TO_TYPEC_DATAROLE(status), true);

tps->partner = typec_register_partner(tps->port, &desc);
if (IS_ERR(tps->partner))
Expand All @@ -280,9 +273,10 @@ static void tps6598x_disconnect(struct tps6598x *tps, u32 status)
typec_unregister_partner(tps->partner);
tps->partner = NULL;
typec_set_pwr_opmode(tps->port, TYPEC_PWR_MODE_USB);
typec_set_pwr_role(tps->port, TPS_STATUS_PORTROLE(status));
typec_set_vconn_role(tps->port, TPS_STATUS_VCONN(status));
tps6598x_set_data_role(tps, TPS_STATUS_DATAROLE(status), false);
typec_set_pwr_role(tps->port, TPS_STATUS_TO_TYPEC_PORTROLE(status));
typec_set_vconn_role(tps->port, TPS_STATUS_TO_TYPEC_VCONN(status));
tps6598x_set_data_role(tps, TPS_STATUS_TO_TYPEC_DATAROLE(status), false);

power_supply_changed(tps->psy);
}

Expand Down Expand Up @@ -366,7 +360,7 @@ static int tps6598x_dr_set(struct typec_port *port, enum typec_data_role role)
if (ret)
goto out_unlock;

if (role != TPS_STATUS_DATAROLE(status)) {
if (role != TPS_STATUS_TO_TYPEC_DATAROLE(status)) {
ret = -EPROTO;
goto out_unlock;
}
Expand Down Expand Up @@ -396,7 +390,7 @@ static int tps6598x_pr_set(struct typec_port *port, enum typec_role role)
if (ret)
goto out_unlock;

if (role != TPS_STATUS_PORTROLE(status)) {
if (role != TPS_STATUS_TO_TYPEC_PORTROLE(status)) {
ret = -EPROTO;
goto out_unlock;
}
Expand Down Expand Up @@ -437,6 +431,7 @@ static irqreturn_t tps6598x_interrupt(int irq, void *data)
dev_err(tps->dev, "%s: failed to read status\n", __func__);
goto err_clear_ints;
}
trace_tps6598x_status(status);

/* Handle plug insert or removal */
if ((event1 | event2) & TPS_REG_INT_PLUG_EVENT) {
Expand Down Expand Up @@ -612,6 +607,7 @@ static int tps6598x_probe(struct i2c_client *client)
ret = tps6598x_read32(tps, TPS_REG_STATUS, &status);
if (ret < 0)
return ret;
trace_tps6598x_status(status);

ret = tps6598x_read32(tps, TPS_REG_SYSTEM_CONF, &conf);
if (ret < 0)
Expand Down
66 changes: 66 additions & 0 deletions drivers/usb/typec/tps6598x.h
View file
Expand Up @@ -9,6 +9,72 @@
#ifndef __TPS6598X_H__
#define __TPS6598X_H__

/* TPS_REG_STATUS bits */
#define TPS_STATUS_PLUG_PRESENT BIT(0)
#define TPS_STATUS_PLUG_UPSIDE_DOWN BIT(4)
#define TPS_STATUS_PORTROLE BIT(5)
#define TPS_STATUS_TO_TYPEC_PORTROLE(s) (!!((s) & TPS_STATUS_PORTROLE))
#define TPS_STATUS_DATAROLE BIT(6)
#define TPS_STATUS_TO_TYPEC_DATAROLE(s) (!!((s) & TPS_STATUS_DATAROLE))
#define TPS_STATUS_VCONN BIT(7)
#define TPS_STATUS_TO_TYPEC_VCONN(s) (!!((s) & TPS_STATUS_VCONN))
#define TPS_STATUS_OVERCURRENT BIT(16)
#define TPS_STATUS_GOTO_MIN_ACTIVE BIT(26)
#define TPS_STATUS_BIST BIT(27)
#define TPS_STATUS_HIGH_VOLAGE_WARNING BIT(28)
#define TPS_STATUS_HIGH_LOW_VOLTAGE_WARNING BIT(29)

#define TPS_STATUS_CONN_STATE_MASK GENMASK(3, 1)
#define TPS_STATUS_CONN_STATE(x) FIELD_GET(TPS_STATUS_CONN_STATE_MASK, (x))
#define TPS_STATUS_PP_5V0_SWITCH_MASK GENMASK(9, 8)
#define TPS_STATUS_PP_5V0_SWITCH(x) FIELD_GET(TPS_STATUS_PP_5V0_SWITCH_MASK, (x))
#define TPS_STATUS_PP_HV_SWITCH_MASK GENMASK(11, 10)
#define TPS_STATUS_PP_HV_SWITCH(x) FIELD_GET(TPS_STATUS_PP_HV_SWITCH_MASK, (x))
#define TPS_STATUS_PP_EXT_SWITCH_MASK GENMASK(13, 12)
#define TPS_STATUS_PP_EXT_SWITCH(x) FIELD_GET(TPS_STATUS_PP_EXT_SWITCH_MASK, (x))
#define TPS_STATUS_PP_CABLE_SWITCH_MASK GENMASK(15, 14)
#define TPS_STATUS_PP_CABLE_SWITCH(x) FIELD_GET(TPS_STATUS_PP_CABLE_SWITCH_MASK, (x))
#define TPS_STATUS_POWER_SOURCE_MASK GENMASK(19, 18)
#define TPS_STATUS_POWER_SOURCE(x) FIELD_GET(TPS_STATUS_POWER_SOURCE_MASK, (x))
#define TPS_STATUS_VBUS_STATUS_MASK GENMASK(21, 20)
#define TPS_STATUS_VBUS_STATUS(x) FIELD_GET(TPS_STATUS_VBUS_STATUS_MASK, (x))
#define TPS_STATUS_USB_HOST_PRESENT_MASK GENMASK(23, 22)
#define TPS_STATUS_USB_HOST_PRESENT(x) FIELD_GET(TPS_STATUS_USB_HOST_PRESENT_MASK, (x))
#define TPS_STATUS_LEGACY_MASK GENMASK(25, 24)
#define TPS_STATUS_LEGACY(x) FIELD_GET(TPS_STATUS_LEGACY_MASK, (x))

#define TPS_STATUS_CONN_STATE_NO_CONN 0
#define TPS_STATUS_CONN_STATE_DISABLED 1
#define TPS_STATUS_CONN_STATE_AUDIO_CONN 2
#define TPS_STATUS_CONN_STATE_DEBUG_CONN 3
#define TPS_STATUS_CONN_STATE_NO_CONN_R_A 4
#define TPS_STATUS_CONN_STATE_RESERVED 5
#define TPS_STATUS_CONN_STATE_CONN_NO_R_A 6
#define TPS_STATUS_CONN_STATE_CONN_WITH_R_A 7

#define TPS_STATUS_PP_SWITCH_STATE_DISABLED 0
#define TPS_STATUS_PP_SWITCH_STATE_FAULT 1
#define TPS_STATUS_PP_SWITCH_STATE_OUT 2
#define TPS_STATUS_PP_SWITCH_STATE_IN 3

#define TPS_STATUS_POWER_SOURCE_UNKNOWN 0
#define TPS_STATUS_POWER_SOURCE_VIN_3P3 1
#define TPS_STATUS_POWER_SOURCE_DEAD_BAT 2
#define TPS_STATUS_POWER_SOURCE_VBUS 3

#define TPS_STATUS_VBUS_STATUS_VSAFE0V 0
#define TPS_STATUS_VBUS_STATUS_VSAFE5V 1
#define TPS_STATUS_VBUS_STATUS_PD 2
#define TPS_STATUS_VBUS_STATUS_FAULT 3

#define TPS_STATUS_USB_HOST_PRESENT_NO 0
#define TPS_STATUS_USB_HOST_PRESENT_PD_NO_USB 1
#define TPS_STATUS_USB_HOST_PRESENT_NO_PD 2
#define TPS_STATUS_USB_HOST_PRESENT_PD_USB 3

#define TPS_STATUS_LEGACY_NO 0
#define TPS_STATUS_LEGACY_SINK 1
#define TPS_STATUS_LEGACY_SOURCE 2

/* TPS_REG_INT_* bits */
#define TPS_REG_INT_USER_VID_ALT_MODE_OTHER_VDM BIT(27+32)
Expand Down
94 changes: 94 additions & 0 deletions drivers/usb/typec/tps6598x_trace.h
View file
Expand Up @@ -67,6 +67,73 @@
{ 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" })

#define TPS6598X_STATUS_FLAGS_MASK (GENMASK(31, 0) ^ (TPS_STATUS_CONN_STATE_MASK | \
TPS_STATUS_PP_5V0_SWITCH_MASK | \
TPS_STATUS_PP_HV_SWITCH_MASK | \
TPS_STATUS_PP_EXT_SWITCH_MASK | \
TPS_STATUS_PP_CABLE_SWITCH_MASK | \
TPS_STATUS_POWER_SOURCE_MASK | \
TPS_STATUS_VBUS_STATUS_MASK | \
TPS_STATUS_USB_HOST_PRESENT_MASK | \
TPS_STATUS_LEGACY_MASK))

#define show_status_conn_state(status) \
__print_symbolic(TPS_STATUS_CONN_STATE((status)), \
{ TPS_STATUS_CONN_STATE_CONN_WITH_R_A, "conn-Ra" }, \
{ TPS_STATUS_CONN_STATE_CONN_NO_R_A, "conn-no-Ra" }, \
{ TPS_STATUS_CONN_STATE_NO_CONN_R_A, "no-conn-Ra" }, \
{ TPS_STATUS_CONN_STATE_DEBUG_CONN, "debug" }, \
{ TPS_STATUS_CONN_STATE_AUDIO_CONN, "audio" }, \
{ TPS_STATUS_CONN_STATE_DISABLED, "disabled" }, \
{ TPS_STATUS_CONN_STATE_NO_CONN, "no-conn" })

#define show_status_pp_switch_state(status) \
__print_symbolic(status, \
{ TPS_STATUS_PP_SWITCH_STATE_IN, "in" }, \
{ TPS_STATUS_PP_SWITCH_STATE_OUT, "out" }, \
{ TPS_STATUS_PP_SWITCH_STATE_FAULT, "fault" }, \
{ TPS_STATUS_PP_SWITCH_STATE_DISABLED, "off" })

#define show_status_power_sources(status) \
__print_symbolic(TPS_STATUS_POWER_SOURCE(status), \
{ TPS_STATUS_POWER_SOURCE_VBUS, "vbus" }, \
{ TPS_STATUS_POWER_SOURCE_VIN_3P3, "vin-3p3" }, \
{ TPS_STATUS_POWER_SOURCE_DEAD_BAT, "dead-battery" }, \
{ TPS_STATUS_POWER_SOURCE_UNKNOWN, "unknown" })

#define show_status_vbus_status(status) \
__print_symbolic(TPS_STATUS_VBUS_STATUS(status), \
{ TPS_STATUS_VBUS_STATUS_VSAFE0V, "vSafe0V" }, \
{ TPS_STATUS_VBUS_STATUS_VSAFE5V, "vSafe5V" }, \
{ TPS_STATUS_VBUS_STATUS_PD, "pd" }, \
{ TPS_STATUS_VBUS_STATUS_FAULT, "fault" })

#define show_status_usb_host_present(status) \
__print_symbolic(TPS_STATUS_USB_HOST_PRESENT(status), \
{ TPS_STATUS_USB_HOST_PRESENT_PD_USB, "pd-usb" }, \
{ TPS_STATUS_USB_HOST_PRESENT_NO_PD, "no-pd" }, \
{ TPS_STATUS_USB_HOST_PRESENT_PD_NO_USB, "pd-no-usb" }, \
{ TPS_STATUS_USB_HOST_PRESENT_NO, "no" })

#define show_status_legacy(status) \
__print_symbolic(TPS_STATUS_LEGACY(status), \
{ TPS_STATUS_LEGACY_SOURCE, "source" }, \
{ TPS_STATUS_LEGACY_SINK, "sink" }, \
{ TPS_STATUS_LEGACY_NO, "no" })

#define show_status_flags(flags) \
__print_flags((flags & TPS6598X_STATUS_FLAGS_MASK), "|", \
{ TPS_STATUS_PLUG_PRESENT, "PLUG_PRESENT" }, \
{ TPS_STATUS_PLUG_UPSIDE_DOWN, "UPSIDE_DOWN" }, \
{ TPS_STATUS_PORTROLE, "PORTROLE" }, \
{ TPS_STATUS_DATAROLE, "DATAROLE" }, \
{ TPS_STATUS_VCONN, "VCONN" }, \
{ TPS_STATUS_OVERCURRENT, "OVERCURRENT" }, \
{ TPS_STATUS_GOTO_MIN_ACTIVE, "GOTO_MIN_ACTIVE" }, \
{ TPS_STATUS_BIST, "BIST" }, \
{ TPS_STATUS_HIGH_VOLAGE_WARNING, "HIGH_VOLAGE_WARNING" }, \
{ TPS_STATUS_HIGH_LOW_VOLTAGE_WARNING, "HIGH_LOW_VOLTAGE_WARNING" })

TRACE_EVENT(tps6598x_irq,
TP_PROTO(u64 event1,
u64 event2),
Expand All @@ -87,6 +154,33 @@ TRACE_EVENT(tps6598x_irq,
show_irq_flags(__entry->event2))
);

TRACE_EVENT(tps6598x_status,
TP_PROTO(u32 status),
TP_ARGS(status),

TP_STRUCT__entry(
__field(u32, status)
),

TP_fast_assign(
__entry->status = status;
),

TP_printk("conn: %s, pp_5v0: %s, pp_hv: %s, pp_ext: %s, pp_cable: %s, "
"pwr-src: %s, vbus: %s, usb-host: %s, legacy: %s, flags: %s",
show_status_conn_state(__entry->status),
show_status_pp_switch_state(TPS_STATUS_PP_5V0_SWITCH(__entry->status)),
show_status_pp_switch_state(TPS_STATUS_PP_HV_SWITCH(__entry->status)),
show_status_pp_switch_state(TPS_STATUS_PP_EXT_SWITCH(__entry->status)),
show_status_pp_switch_state(TPS_STATUS_PP_CABLE_SWITCH(__entry->status)),
show_status_power_sources(__entry->status),
show_status_vbus_status(__entry->status),
show_status_usb_host_present(__entry->status),
show_status_legacy(__entry->status),
show_status_flags(__entry->status)
)
);

#endif /* _TPS6598X_TRACE_H_ */

/* This part must be outside protection */
Expand Down

0 comments on commit 17785e4

Please sign in to comment.