Skip to contentSkip to conversation

USB Type-C Connector class

PATCH Applied Heikki Krogerus 5 participants 20 messages Aug 29, 2016 – Aug 31, 2016

Subsystems (5)

v6 of 18 Applied Latest is v18 →

lore
Share & tools
lore

Heikki Krogerus

author maintainer
#0 lore raw

v6 cover USB Type-C Connector class

The USB Type-C class is meant to provide unified interface to the userspace to present the USB Type-C ports in a system.

Changes since v6:
- current_vconn_role attr renamed to vconn_source (no API changes)
- Small documentation improvements proposed by Vincent Palatin

Changes since v5:
- Only updating the roles based on driver notifications
- Added MODULE_ALIAS for the WhiskeyCove module
- Including the patch that creates the actual platform device for the WhiskeyCove Type-C PHY in this series.

Changes since v4:
- Remove the port lock completely

Changes since v3:
- Documentation cleanup as proposed by Roger Quadros
- Setting partner altmodes member to NULL on removal and fixing a warning, as proposed by Guenter Roeck
- Added the following attributes for partners and cables:
* supports_usb_power_delivery
* id_header_vdo
- "id_header_vdo" is visible only when the partner or cable supports USB Power Delivery communication.
- Partner attribute "accessory" is hidden when the partner type is not "Accessory".

Changes since v2:
- Notification on role and alternate mode changes
- cleanups

Changes since v1:
- Completely rewrote alternate mode support
- Patners, cables and cable plugs presented as devices.

Heikki Krogerus (3):
usb: USB Type-C connector class
usb: typec: add driver for Intel Whiskey Cove PMIC USB Type-C PHY
mfd: intel_soc_pmic_bxtwc: add support for USB Type-C PHY on
WhiskeyCove

 Documentation/ABI/testing/sysfs-class-typec |  205 +++++
 Documentation/usb/typec.txt                 |  103 +++
 MAINTAINERS                                 |    9 +
 drivers/mfd/intel_soc_pmic_bxtwc.c          |   11 +
 drivers/usb/Kconfig                         |    2 +
 drivers/usb/Makefile                        |    2 +
 drivers/usb/typec/Kconfig                   |   21 +
 drivers/usb/typec/Makefile                  |    2 +
 drivers/usb/typec/typec.c                   | 1091 +++++++++++++++++++++++++++
 drivers/usb/typec/typec_wcove.c             |  372 +++++++++
 include/linux/usb/typec.h                   |  260 +++++++
 11 files changed, 2078 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-typec
 create mode 100644 Documentation/usb/typec.txt
 create mode 100644 drivers/usb/typec/Kconfig
 create mode 100644 drivers/usb/typec/Makefile
 create mode 100644 drivers/usb/typec/typec.c
 create mode 100644 drivers/usb/typec/typec_wcove.c
 create mode 100644 include/linux/usb/typec.h
Signature · 1 line
2.8.1
author maintainer
#1 lore raw

PATCH v6 1/3 usb: USB Type-C connector class

The purpose of USB Type-C connector class is to provide unified interface for the user space to get the status and basic information about USB Type-C connectors on a system, control over data role swapping, and when the port supports USB Power Delivery, also control over power role swapping and Alternate Modes.

---
 Documentation/ABI/testing/sysfs-class-typec |  205 +++++
 Documentation/usb/typec.txt                 |  103 +++
 MAINTAINERS                                 |    9 +
 drivers/usb/Kconfig                         |    2 +
 drivers/usb/Makefile                        |    2 +
 drivers/usb/typec/Kconfig                   |    7 +
 drivers/usb/typec/Makefile                  |    1 +
 drivers/usb/typec/typec.c                   | 1091 +++++++++++++++++++++++++++
 include/linux/usb/typec.h                   |  260 +++++++
 9 files changed, 1680 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-typec
 create mode 100644 Documentation/usb/typec.txt
 create mode 100644 drivers/usb/typec/Kconfig
 create mode 100644 drivers/usb/typec/Makefile
 create mode 100644 drivers/usb/typec/typec.c
 create mode 100644 include/linux/usb/typec.h
Documentation/ABI/testing/sysfs-class-typec new file +205 -0
new file mode 100644
index 0000000..53fdd11
@@ -0,0 +1,205 @@
+USB Type-C port devices (eg. /sys/class/typec/usbc0/)
+
+What:		/sys/class/typec/<port>/current_data_role
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		The current USB data role the port is operating in. This
+		attribute can be used for requesting data role swapping on the
+		port. Swapping is only supported as an asynchronous operation
+		and requires polling of the attribute in order to know the
+		result, so successful write operation does not mean successful
+		swap.
+
+		Valid values:
+		- host
+		- device
+
+What:		/sys/class/typec/<port>/current_power_role
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		The current power role of the port. This attribute can be used
+		to request power role swap on the port when the port supports
+		USB Power Delivery. Swapping is only supported as an
+		asynchronous operation and requires polling of the attribute in
+		order to know the result, so successful write operation does not
+		mean successful swap.
+
+		Valid values:
+		- source
+		- sink
+
+What:		/sys/class/typec/<port>/vconn_source
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows is the port VCONN Source. This attribute can be used to
+		request VCONN swap to change the VCONN Source during connection
+		when both the port and the partner support USB Power Delivery.
+
+		Valid values are:
+		- 0 when the port is not the VCONN Source
+		- 1 when the port is the VCONN Source
+
+What:		/sys/class/typec/<port>/power_operation_mode
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows the current power operational mode the port is in.
+
+		Valid values:
+		- USB - Normal power levels defined in USB specifications
+		- BC1.2 - Power levels defined in Battery Charging Specification
+			  v1.2
+		- USB Type-C 1.5A - Higher 1.5A current defined in USB Type-C
+				    specification.
+		- USB Type-C 3.0A - Higher 3A current defined in USB Type-C
+				    specification.
+                - USB Power Delivery - The voltages and currents defined in USB
+				       Power Delivery specification
+
+What:		/sys/class/typec/<port>/preferred_role
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		The user space can notify the driver about the preferred role.
+		It should be handled as enabling of Try.SRC or Try.SNK, as
+		defined in USB Type-C specification, in the port drivers. By
+		default there is no preferred role.
+
+		Valid values:
+		- host
+		- device
+		- For example "none" to remove preference (anything else except
+		  "host" or "device")
+
+What:		/sys/class/typec/<port>/supported_accessory_modes
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Lists the Accessory Modes, defined in the USB Type-C
+		specification, the port supports.
+
+What:		/sys/class/typec/<port>/supported_data_roles
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Lists the USB data roles the port is capable of supporting.
+
+		Valid values:
+		- device
+		- host
+		- device, host (DRD as defined in USB Type-C specification v1.2)
+
+What:		/sys/class/typec/<port>/supported_power_roles
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Lists the power roles the port is capable of supporting.
+
+		Valid values:
+		- source
+		- sink
+
+What:		/sys/class/typec/<port>/supports_usb_power_delivery
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows if the port supports USB Power Delivery.
+		- 1 if USB Power Delivery is supported
+		- 0 when it's not
+
+
+USB Type-C partner devices (eg. /sys/class/typec/usbc0-partner/)
+
+What:		/sys/class/typec/<port>-partner/accessory
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		The attribute is visible only when the partner's type is
+		"Accessory". The type can be read from its own attribute.
+
+		Shows the name of the Accessory Mode. The Accessory Modes are
+		defined in USB Type-C Specification.
+
+What:		/sys/class/typec/<port>-partner/type
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows the type of the partner. Can be one of the following:
+		- USB - When the partner is normal USB host/peripheral.
+		- Charger - When the partner has been identified as dedicated
+			    charger.
+		- Alternate Mode - When the partner supports Alternate Modes.
+		- Accessory - When the partner is one of the accessories with
+			      specific Accessory Mode defined in USB Type-C
+			      specification.
+
+
+USB Type-C cable devices (eg. /sys/class/typec/usbc0-cable/)
+
+Note: Electronically Marked Cables will have a device also for one cable plug
+(eg. /sys/class/typec/usbc0-plug0). If the cable is active and has also SOP
+Double Prime controller (USB Power Deliver specification ch. 2.4) it will have
+second device also for the other plug. Both plugs may have their alternate modes
+as described in USB Type-C and USB Power Delivery specifications.
+
+What:		/sys/class/typec/<port>-cable/active
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows if the cable is active or passive.
+
+		Valid values:
+		- 0 when the cable is passive
+		- 1 when the cable is active
+
+What:		/sys/class/typec/<port>-cable/plug_type
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows type of the plug on the cable:
+		- Type-A - Standard A
+		- Type-B - Standard B
+		- Type-C - USB Type-C
+		- Captive - Non-standard
+
+
+Alternate Mode devices (For example,
+/sys/class/typec/usbc0-partner/usbc0-partner.svid:xxxx/). The ports, partners
+and cable plugs can have alternate modes.
+
+What:		/sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/active
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows if the mode is active or not. The attribute can be used
+		for entering/exiting the mode with partners and cable plugs, and
+		with the port alternate modes it can be used for disabling
+		support for specific alternate modes.
+
+What:		/sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/description
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows description of the mode. The description is optional for
+		the drivers, just like with the Billboard Devices.
+
+What:		/sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/vdo
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows the VDO in hexadecimal returned from the Discover Modes
+		command.
+
+What:		/sys/class/typec/<port>/<port>.svid:<svid>/<mode>/supported_roles
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows the roles, source or sink, the mode is supported with.
+
+		This attribute is available for the devices describing the
+		alternate modes a port supports, and it will not be exposed with
+		the devices presenting the alternate modes the partners or cable
+		plugs support.
Documentation/usb/typec.txt new file +103 -0

103 lines not on this page · raw message

MAINTAINERS +9 -0
index d8e81b1..fe65f43 100644
@@ -12370,6 +12370,15 @@ F:	drivers/usb/
 F:	include/linux/usb.h
 F:	include/linux/usb/
 
+USB TYPEC SUBSYSTEM
+M:	Heikki Krogerus <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	Documentation/ABI/testing/sysfs-class-typec
+F:	Documentation/usb/typec.txt
+F:	drivers/usb/typec/
+F:	include/linux/usb/typec.h
+
 USB UHCI DRIVER
 M:	Alan Stern <[email protected]>
 L:	[email protected]
drivers/usb/Kconfig +2 -0
index 8689dcb..f42a3d3 100644
@@ -150,6 +150,8 @@ source "drivers/usb/phy/Kconfig"
 
 source "drivers/usb/gadget/Kconfig"
 
+source "drivers/usb/typec/Kconfig"
+
 config USB_LED_TRIG
 	bool "USB LED Triggers"
 	depends on LEDS_CLASS && USB_COMMON && LEDS_TRIGGERS
drivers/usb/Makefile +2 -0
index dca7856..51e381e 100644
@@ -61,3 +61,5 @@ obj-$(CONFIG_USB_GADGET)	+= gadget/
 obj-$(CONFIG_USB_COMMON)	+= common/
 
 obj-$(CONFIG_USBIP_CORE)	+= usbip/
+
+obj-$(CONFIG_TYPEC)		+= typec/
drivers/usb/typec/Kconfig new file +7 -0
new file mode 100644
index 0000000..b229fb9
@@ -0,0 +1,7 @@
+
+menu "USB PD and Type-C drivers"
+
+config TYPEC
+	tristate
+
+endmenu
drivers/usb/typec/Makefile new file +1 -0
new file mode 100644
index 0000000..1012a8b
@@ -0,0 +1 @@
+obj-$(CONFIG_TYPEC)		+= typec.o
drivers/usb/typec/typec.c new file +1091 -0

1,091 lines not on this page · raw message

include/linux/usb/typec.h new file +260 -0

260 lines not on this page · raw message

Signature · 1 line
2.8.1
Acked-by on v6 1/3
#2 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Quoted 8 lines · Heikki Krogerus

The purpose of USB Type-C connector class is to provide unified interface for the user space to get the status and basic information about USB Type-C connectors on a system, control over data role swapping, and when the port supports USB Power Delivery, also control over power role swapping and Alternate Modes.

Quoted 1,767 lines
---
 Documentation/ABI/testing/sysfs-class-typec |  205 +++++
 Documentation/usb/typec.txt                 |  103 +++
 MAINTAINERS                                 |    9 +
 drivers/usb/Kconfig                         |    2 +
 drivers/usb/Makefile                        |    2 +
 drivers/usb/typec/Kconfig                   |    7 +
 drivers/usb/typec/Makefile                  |    1 +
 drivers/usb/typec/typec.c                   | 1091 +++++++++++++++++++++++++++
 include/linux/usb/typec.h                   |  260 +++++++
 9 files changed, 1680 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-typec
 create mode 100644 Documentation/usb/typec.txt
 create mode 100644 drivers/usb/typec/Kconfig
 create mode 100644 drivers/usb/typec/Makefile
 create mode 100644 drivers/usb/typec/typec.c
 create mode 100644 include/linux/usb/typec.h
Documentation/ABI/testing/sysfs-class-typec new file +205 -0
new file mode 100644
index 0000000..53fdd11
@@ -0,0 +1,205 @@
+USB Type-C port devices (eg. /sys/class/typec/usbc0/)
+
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in. This
+               attribute can be used for requesting data role swapping on the
+               port. Swapping is only supported as an asynchronous operation
+               and requires polling of the attribute in order to know the
+               result, so successful write operation does not mean successful
+               swap.
+
+               Valid values:
+               - host
+               - device
+
+What:          /sys/class/typec/<port>/current_power_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current power role of the port. This attribute can be used
+               to request power role swap on the port when the port supports
+               USB Power Delivery. Swapping is only supported as an
+               asynchronous operation and requires polling of the attribute in
+               order to know the result, so successful write operation does not
+               mean successful swap.
+
+               Valid values:
+               - source
+               - sink
+
+What:          /sys/class/typec/<port>/vconn_source
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows is the port VCONN Source. This attribute can be used to
+               request VCONN swap to change the VCONN Source during connection
+               when both the port and the partner support USB Power Delivery.
+
+               Valid values are:
+               - 0 when the port is not the VCONN Source
+               - 1 when the port is the VCONN Source
+
+What:          /sys/class/typec/<port>/power_operation_mode
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows the current power operational mode the port is in.
+
+               Valid values:
+               - USB - Normal power levels defined in USB specifications
+               - BC1.2 - Power levels defined in Battery Charging Specification
+                         v1.2
+               - USB Type-C 1.5A - Higher 1.5A current defined in USB Type-C
+                                   specification.
+               - USB Type-C 3.0A - Higher 3A current defined in USB Type-C
+                                   specification.
+                - USB Power Delivery - The voltages and currents defined in USB
+                                      Power Delivery specification
+
+What:          /sys/class/typec/<port>/preferred_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The user space can notify the driver about the preferred role.
+               It should be handled as enabling of Try.SRC or Try.SNK, as
+               defined in USB Type-C specification, in the port drivers. By
+               default there is no preferred role.
+
+               Valid values:
+               - host
+               - device
+               - For example "none" to remove preference (anything else except
+                 "host" or "device")
+
+What:          /sys/class/typec/<port>/supported_accessory_modes
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Lists the Accessory Modes, defined in the USB Type-C
+               specification, the port supports.
+
+What:          /sys/class/typec/<port>/supported_data_roles
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Lists the USB data roles the port is capable of supporting.
+
+               Valid values:
+               - device
+               - host
+               - device, host (DRD as defined in USB Type-C specification v1.2)
+
+What:          /sys/class/typec/<port>/supported_power_roles
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Lists the power roles the port is capable of supporting.
+
+               Valid values:
+               - source
+               - sink
+
+What:          /sys/class/typec/<port>/supports_usb_power_delivery
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows if the port supports USB Power Delivery.
+               - 1 if USB Power Delivery is supported
+               - 0 when it's not
+
+
+USB Type-C partner devices (eg. /sys/class/typec/usbc0-partner/)
+
+What:          /sys/class/typec/<port>-partner/accessory
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The attribute is visible only when the partner's type is
+               "Accessory". The type can be read from its own attribute.
+
+               Shows the name of the Accessory Mode. The Accessory Modes are
+               defined in USB Type-C Specification.
+
+What:          /sys/class/typec/<port>-partner/type
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows the type of the partner. Can be one of the following:
+               - USB - When the partner is normal USB host/peripheral.
+               - Charger - When the partner has been identified as dedicated
+                           charger.
+               - Alternate Mode - When the partner supports Alternate Modes.
+               - Accessory - When the partner is one of the accessories with
+                             specific Accessory Mode defined in USB Type-C
+                             specification.
+
+
+USB Type-C cable devices (eg. /sys/class/typec/usbc0-cable/)
+
+Note: Electronically Marked Cables will have a device also for one cable plug
+(eg. /sys/class/typec/usbc0-plug0). If the cable is active and has also SOP
+Double Prime controller (USB Power Deliver specification ch. 2.4) it will have
+second device also for the other plug. Both plugs may have their alternate modes
+as described in USB Type-C and USB Power Delivery specifications.
+
+What:          /sys/class/typec/<port>-cable/active
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows if the cable is active or passive.
+
+               Valid values:
+               - 0 when the cable is passive
+               - 1 when the cable is active
+
+What:          /sys/class/typec/<port>-cable/plug_type
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows type of the plug on the cable:
+               - Type-A - Standard A
+               - Type-B - Standard B
+               - Type-C - USB Type-C
+               - Captive - Non-standard
+
+
+Alternate Mode devices (For example,
+/sys/class/typec/usbc0-partner/usbc0-partner.svid:xxxx/). The ports, partners
+and cable plugs can have alternate modes.
+
+What:          /sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/active
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows if the mode is active or not. The attribute can be used
+               for entering/exiting the mode with partners and cable plugs, and
+               with the port alternate modes it can be used for disabling
+               support for specific alternate modes.
+
+What:          /sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/description
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows description of the mode. The description is optional for
+               the drivers, just like with the Billboard Devices.
+
+What:          /sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/vdo
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows the VDO in hexadecimal returned from the Discover Modes
+               command.
+
+What:          /sys/class/typec/<port>/<port>.svid:<svid>/<mode>/supported_roles
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               Shows the roles, source or sink, the mode is supported with.
+
+               This attribute is available for the devices describing the
+               alternate modes a port supports, and it will not be exposed with
+               the devices presenting the alternate modes the partners or cable
+               plugs support.
Documentation/usb/typec.txt new file +103 -0
new file mode 100644
index 0000000..7095a2a
@@ -0,0 +1,103 @@
+USB Type-C connector class
+==========================
+
+Introduction
+------------
+The typec class is meant for describing the USB Type-C ports in a system to the
+user space in unified fashion. The class is designed to provide nothing else
+except the user space interface implementation in hope that it can be utilized
+on as many platforms as possible.
+
+The platforms are expected to register every USB Type-C port they have with the
+class. In a normal case the registration will be done by a USB Type-C or PD PHY
+driver, but it may be a driver for firmware interface such as UCSI, driver for
+USB PD controller or even driver for Thunderbolt3 controller. This document
+considers the component registering the USB Type-C ports with the class as "port
+driver".
+
+On top of showing the capabilities, the class also offer the user space control
+over the roles and alternate modes they support when the port driver is capable
+of supporting those features.
+
+The class provides an API for the port drivers described in this document. The
+attributes are described in Documentation/ABI/testing/sysfs-class-typec.
+
+
+Interface
+---------
+Every port will be presented as its own device under /sys/class/typec/. The
+first port will be named "usbc0", the second "usbc1" and so on.
+
+When connected, the partner will be presented also as its own device under
+/sys/class/typec/. The parent of the partner device will always be the port. The
+partner attached to port "usbc0" will be named "usbc0-partner". Full path to the
+device would be /sys/class/typec/usb0/usb0-partner/.
+
+The cable and the two plugs on it may also be optionally presented as their own
+devices under /sys/class/typec/. The cable attached to the port "usbc0" port
+will be named usbc0-cable and the plug on the SOP Prime end (see USB Power
+Delivery Specification ch. 2.4) will be named "usbc-plug0" and on the SOP Double
+Prime end "usbc0-plug1". The parent of a cable will always be the port, and the
+parent of the cable plugs will always be the cable.
+
+If the port, partner or cable plug support Alternate Modes, every Alternate Mode
+SVID will have their own device describing them. The Alternate Modes will not be
+attached to the typec class. For the port's "usbc0" partner, the Alternate Modes
+would have devices presented under /sys/class/typec/usbc0-partner/. Every mode
+that is supported will have its own group under the Alternate Mode device named
+"mode<id>". For example /sys/class/typec/usbc0/usbc0.svid:xxxx/mode0/. The
+requests for entering/exiting the modes happens with the "active" attribute in
+that group.
+
+
+API
+---
+
+* Registering the ports
+
+The port drivers will describe every Type-C port they control with struct
+typec_capability data structure, and register them with the following API:
+
+struct typec_port *typec_register_port(struct device *dev,
+                                      const struct typec_capability *cap);
+
+The class will provide handle to struct typec_port on success and ERR_PTR on
+failure. The un-registration of the port happens with the following API:
+
+void typec_unregister_port(struct typec_port *port);
+
+
+* Notifications
+
+When connection happens on a port, the port driver fills struct typec_connection
+which is passed to the class. The class provides the following API for reporting
+connection/disconnection:
+
+int typec_connect(struct typec_port *port, struct typec_connection *);
+void typec_disconnect(struct typec_port *);
+
+When the partner end has executed a role change, the port driver uses the
+following APIs to report it to the class:
+
+void typec_set_data_role(struct typec_port *, enum typec_data_role);
+void typec_set_pwr_role(struct typec_port *, enum typec_role);
+void typec_set_vconn_role(struct typec_port *, enum typec_role);
+void typec_set_pwr_opmode(struct typec_port *, enum typec_pwr_opmode);
+
+
+* Alternate Modes
+
+After connection, the port drivers register the alternate modes the partner
+and/or cable plugs support. And before reporting disconnection, the port driver
+_must_ unregister all the alternate modes registered for the partner and cable
+plugs. The API takes the struct device of the partner or the cable plug as
+parameter:
+
+int typec_register_altmodes(struct device *, struct typec_altmode *);
+void typec_unregister_altmodes(struct device *);
+
+When the partner end enters or exits the modes, the port driver needs to notify
+the class with the following API:
+
+void typec_altmode_update_active(struct typec_altmode *alt, int mode,
+                                bool active);
MAINTAINERS +9 -0
index d8e81b1..fe65f43 100644
@@ -12370,6 +12370,15 @@ F:     drivers/usb/
 F:     include/linux/usb.h
 F:     include/linux/usb/
 
+USB TYPEC SUBSYSTEM
+M:     Heikki Krogerus <[email protected]>
+L:     [email protected]
+S:     Maintained
+F:     Documentation/ABI/testing/sysfs-class-typec
+F:     Documentation/usb/typec.txt
+F:     drivers/usb/typec/
+F:     include/linux/usb/typec.h
+
 USB UHCI DRIVER
 M:     Alan Stern <[email protected]>
 L:     [email protected]
drivers/usb/Kconfig +2 -0
index 8689dcb..f42a3d3 100644
@@ -150,6 +150,8 @@ source "drivers/usb/phy/Kconfig"
 
 source "drivers/usb/gadget/Kconfig"
 
+source "drivers/usb/typec/Kconfig"
+
 config USB_LED_TRIG
        bool "USB LED Triggers"
        depends on LEDS_CLASS && USB_COMMON && LEDS_TRIGGERS
drivers/usb/Makefile +2 -0
index dca7856..51e381e 100644
@@ -61,3 +61,5 @@ obj-$(CONFIG_USB_GADGET)      += gadget/
 obj-$(CONFIG_USB_COMMON)       += common/
 
 obj-$(CONFIG_USBIP_CORE)       += usbip/
+
+obj-$(CONFIG_TYPEC)            += typec/
drivers/usb/typec/Kconfig new file +7 -0
new file mode 100644
index 0000000..b229fb9
@@ -0,0 +1,7 @@
+
+menu "USB PD and Type-C drivers"
+
+config TYPEC
+       tristate
+
+endmenu
drivers/usb/typec/Makefile new file +1 -0
new file mode 100644
index 0000000..1012a8b
@@ -0,0 +1 @@
+obj-$(CONFIG_TYPEC)            += typec.o
drivers/usb/typec/typec.c new file +1091 -0
new file mode 100644
index 0000000..ae0f691
@@ -0,0 +1,1091 @@
+/*
+ * USB Type-C Connector Class
+ *
+ * Copyright (C) 2016, Intel Corporation
+ * Author: Heikki Krogerus <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#include <linux/device.h>
+#include <linux/module.h>
+#include <linux/slab.h>
+#include <linux/usb/typec.h>
+
+struct typec_port {
+       unsigned int            id;
+       struct device           dev;
+
+       int                     prefer_role;
+
+       enum typec_data_role    data_role;
+       enum typec_role         pwr_role;
+       enum typec_role         vconn_role;
+       enum typec_pwr_opmode   pwr_opmode;
+
+       struct typec_partner    *partner;
+       struct typec_cable      *cable;
+
+       unsigned int            connected:1;
+
+       const struct typec_capability *cap;
+};
+
+#define to_typec_port(p) container_of(p, struct typec_port, dev)
+
+static DEFINE_IDA(typec_index_ida);
+
+static struct class typec_class = {
+       .name = "typec",
+};
+
+static const char * const typec_accessory_modes[] = {
+       [TYPEC_ACCESSORY_NONE]          = "none",
+       [TYPEC_ACCESSORY_AUDIO]         = "Audio",
+       [TYPEC_ACCESSORY_DEBUG]         = "Debug",
+       [TYPEC_ACCESSORY_DAUDIO]        = "Digital Audio",
+};
+
+static int sysfs_strmatch(const char * const *array, size_t n, const char *str)
+{
+       const char *item;
+       int index;
+
+       for (index = 0; index < n; index++) {
+               item = array[index];
+               if (!item)
+                       break;
+               if (!sysfs_streq(item, str))
+                       return index;
+       }
+
+       return -EINVAL;
+}
+
+/* ------------------------------------------------------------------------- */
+/* Type-C Partners */
+
+static void typec_dev_release(struct device *dev)
+{
+}
+
+static const char * const typec_partner_types[] = {
+       [TYPEC_PARTNER_USB]             = "USB",
+       [TYPEC_PARTNER_CHARGER]         = "Charger",
+       [TYPEC_PARTNER_ALTMODE]         = "Alternate Mode",
+       [TYPEC_PARTNER_ACCESSORY]       = "Accessory",
+};
+
+static ssize_t
+partner_type_show(struct device *dev, struct device_attribute *attr, char *buf)
+{
+       struct typec_partner *partner = container_of(dev, struct typec_partner,
+                                                    dev);
+
+       return sprintf(buf, "%s\n", typec_partner_types[partner->type]);
+}
+
+static struct device_attribute dev_attr_partner_type = {
+       .attr = {
+               .name = "type",
+               .mode = S_IRUGO,
+       },
+       .show = partner_type_show,
+};
+
+static ssize_t
+partner_accessory_mode_show(struct device *dev, struct device_attribute *attr,
+                           char *buf)
+{
+       struct typec_partner *partner = container_of(dev, struct typec_partner,
+                                                    dev);
+
+       return sprintf(buf, "%s\n", typec_accessory_modes[partner->accessory]);
+}
+
+static struct device_attribute dev_attr_partner_accessory = {
+       .attr = {
+               .name = "accessory",
+               .mode = S_IRUGO,
+       },
+       .show = partner_accessory_mode_show,
+};
+
+static struct attribute *typec_partner_attrs[] = {
+       &dev_attr_partner_accessory.attr,
+       &dev_attr_partner_type.attr,
+       NULL
+};
+
+static umode_t
+partner_is_visible(struct kobject *kobj, struct attribute *attr, int n)
+{
+       struct device *dev = container_of(kobj, struct device, kobj);
+       struct typec_partner *partner = container_of(dev, struct typec_partner,
+                                                    dev);
+
+       if (attr == &dev_attr_partner_accessory.attr &&
+           partner->type != TYPEC_PARTNER_ACCESSORY)
+               return 0;
+
+       return attr->mode;
+}
+
+static struct attribute_group typec_partner_group = {
+       .attrs = typec_partner_attrs,
+       .is_visible = partner_is_visible,
+};
+
+static const struct attribute_group *typec_partner_groups[] = {
+       &typec_partner_group,
+       NULL
+};
+
+static struct device_type typec_partner_dev_type = {
+       .name = "typec_partner_device",
+       .groups = typec_partner_groups,
+       .release = typec_dev_release,
+};
+
+static int
+typec_add_partner(struct typec_port *port, struct typec_partner *partner)
+{
+       struct device *dev = &partner->dev;
+       int ret;
+
+       dev->class = &typec_class;
+       dev->parent = &port->dev;
+       dev->type = &typec_partner_dev_type;
+       dev_set_name(dev, "%s-partner", dev_name(&port->dev));
+
+       ret = device_register(dev);
+       if (ret) {
+               put_device(dev);
+               return ret;
+       }
+
+       port->partner = partner;
+       return 0;
+}
+
+static void typec_remove_partner(struct typec_port *port)
+{
+       WARN_ON(port->partner->alt_modes);
+       device_unregister(&port->partner->dev);
+}
+
+/* ------------------------------------------------------------------------- */
+/* Type-C Cable Plugs */
+
+static struct device_type typec_plug_dev_type = {
+       .name = "typec_plug_device",
+       .release = typec_dev_release,
+};
+
+static int
+typec_add_plug(struct typec_port *port, struct typec_plug *plug)
+{
+       struct device *dev = &plug->dev;
+       char name[8];
+       int ret;
+
+       sprintf(name, "plug%d", plug->index);
+
+       dev->class = &typec_class;
+       dev->parent = &port->cable->dev;
+       dev->type = &typec_plug_dev_type;
+       dev_set_name(dev, "%s-%s", dev_name(&port->dev), name);
+
+       ret = device_register(dev);
+       if (ret) {
+               put_device(dev);
+               return ret;
+       }
+
+       return 0;
+}
+
+static void typec_remove_plug(struct typec_plug *plug)
+{
+       WARN_ON(plug->alt_modes);
+       device_unregister(&plug->dev);
+}
+
+/* Type-C Cables */
+
+static ssize_t
+cable_active_show(struct device *dev, struct device_attribute *attr, char *buf)
+{
+       struct typec_cable *cable = container_of(dev, struct typec_cable, dev);
+
+       return sprintf(buf, "%d\n", cable->active);
+}
+
+static struct device_attribute dev_attr_cable_active = {
+       .attr = {
+               .name = "active",
+               .mode = S_IRUGO,
+       },
+       .show = cable_active_show,
+};
+
+static const char * const typec_plug_types[] = {
+       [USB_PLUG_NONE]         = "unknown",
+       [USB_PLUG_TYPE_A]       = "Type-A",
+       [USB_PLUG_TYPE_B]       = "Type-B",
+       [USB_PLUG_TYPE_C]       = "Type-C",
+       [USB_PLUG_CAPTIVE]      = "Captive",
+};
+
+static ssize_t
+cable_plug_type_show(struct device *dev, struct device_attribute *attr,
+                    char *buf)
+{
+       struct typec_cable *cable = container_of(dev, struct typec_cable, dev);
+
+       return sprintf(buf, "%s\n", typec_plug_types[cable->type]);
+}
+
+static struct device_attribute dev_attr_plug_type = {
+       .attr = {
+               .name = "plug_type",
+               .mode = S_IRUGO,
+       },
+       .show = cable_plug_type_show,
+};
+
+static struct attribute *typec_cable_attrs[] = {
+       &dev_attr_cable_active.attr,
+       &dev_attr_plug_type.attr,
+       NULL
+};
+
+static struct attribute_group typec_cable_group = {
+       .attrs = typec_cable_attrs,
+};
+
+static const struct attribute_group *typec_cable_groups[] = {
+       &typec_cable_group,
+       NULL
+};
+
+static struct device_type typec_cable_dev_type = {
+       .name = "typec_cable_device",
+       .groups = typec_cable_groups,
+       .release = typec_dev_release,
+};
+
+static int typec_add_cable(struct typec_port *port, struct typec_cable *cable)
+{
+       struct device *dev = &cable->dev;
+       int ret;
+
+       dev->class = &typec_class;
+       dev->parent = &port->dev;
+       dev->type = &typec_cable_dev_type;
+       dev_set_name(dev, "%s-cable", dev_name(&port->dev));
+
+       ret = device_register(dev);
+       if (ret) {
+               put_device(dev);
+               return ret;
+       }
+
+       /* Plug1 */
+       if (!cable->usb_pd)
+               return 0;
+
+       cable->plug[0].index = 1;
+       ret = typec_add_plug(port, &cable->plug[0]);
+       if (ret) {
+               device_unregister(dev);
+               return ret;
+       }
+
+       /* Plug2 */
+       if (!cable->active || !cable->sop_pp_controller)
+               return 0;
+
+       cable->plug[1].index = 2;
+       ret = typec_add_plug(port, &cable->plug[1]);
+       if (ret) {
+               typec_remove_plug(&cable->plug[0]);
+               device_unregister(dev);
+               return ret;
+       }
+
+       port->cable = cable;
+       return 0;
+}
+
+static void typec_remove_cable(struct typec_port *port)
+{
+       if (port->cable->active) {
+               typec_remove_plug(&port->cable->plug[0]);
+               if (port->cable->sop_pp_controller)
+                       typec_remove_plug(&port->cable->plug[1]);
+       }
+       device_unregister(&port->cable->dev);
+}
+
+/* ------------------------------------------------------------------------- */
+/* API for the port drivers */
+
+static void typec_init_roles(struct typec_port *port)
+{
+       if (port->prefer_role < 0)
+               return;
+
+       if (port->prefer_role == TYPEC_SOURCE) {
+               port->data_role = TYPEC_HOST;
+               port->pwr_role = TYPEC_SOURCE;
+               port->vconn_role = TYPEC_SOURCE;
+       } else {
+               /* Device mode as default also by default with DRP ports */
+               port->data_role = TYPEC_DEVICE;
+               port->pwr_role = TYPEC_SINK;
+               port->vconn_role = TYPEC_SINK;
+       }
+}
+
+int typec_connect(struct typec_port *port, struct typec_connection *con)
+{
+       int ret;
+
+       if (!con->partner && !con->cable)
+               return -EINVAL;
+
+       port->connected = 1;
+       port->data_role = con->data_role;
+       port->pwr_role = con->pwr_role;
+       port->vconn_role = con->vconn_role;
+       port->pwr_opmode = con->pwr_opmode;
+
+       kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
+
+       if (con->cable) {
+               ret = typec_add_cable(port, con->cable);
+               if (ret)
+                       return ret;
+       }
+
+       if (con->partner) {
+               ret = typec_add_partner(port, con->partner);
+               if (ret) {
+                       if (con->cable)
+                               typec_remove_cable(port);
+                       return ret;
+               }
+       }
+
+       return 0;
+}
+EXPORT_SYMBOL_GPL(typec_connect);
+
+void typec_disconnect(struct typec_port *port)
+{
+       if (port->partner)
+               typec_remove_partner(port);
+
+       if (port->cable)
+               typec_remove_cable(port);
+
+       port->connected = 0;
+       port->partner = NULL;
+       port->cable = NULL;
+
+       port->pwr_opmode = TYPEC_PWR_MODE_USB;
+
+       typec_init_roles(port);
+
+       kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
+}
+EXPORT_SYMBOL_GPL(typec_disconnect);
+
+/* --------------------------------------- */
+/* Driver callbacks to report role updates */
+
+void typec_set_data_role(struct typec_port *port, enum typec_data_role role)
+{
+       port->data_role = role;
+       sysfs_notify(&port->dev.kobj, NULL, "current_data_role");
+}
+EXPORT_SYMBOL(typec_set_data_role);
+
+void typec_set_pwr_role(struct typec_port *port, enum typec_role role)
+{
+       port->pwr_role = role;
+       sysfs_notify(&port->dev.kobj, NULL, "current_power_role");
+}
+EXPORT_SYMBOL(typec_set_pwr_role);
+
+void typec_set_vconn_role(struct typec_port *port, enum typec_role role)
+{
+       port->vconn_role = role;
+       sysfs_notify(&port->dev.kobj, NULL, "current_vconn_role");
+}
+EXPORT_SYMBOL(typec_set_vconn_role);
+
+void typec_set_pwr_opmode(struct typec_port *port,
+                         enum typec_pwr_opmode opmode)
+{
+       port->pwr_opmode = opmode;
+       sysfs_notify(&port->dev.kobj, NULL, "power_operation_mode");
+}
+EXPORT_SYMBOL(typec_set_pwr_opmode);
+
+/* -------------------------------- */
+/* Alternate Modes */
+
+/*
+ * typec_altmode_update_active - Notify about Enter/Exit mode
+ * @alt: Handle to the Alternate Mode
+ * @mode: Mode id
+ * @active: True when the mode has been enterred
+ */
+void typec_altmode_update_active(struct typec_altmode *alt, int mode,
+                                bool active)
+{
+       struct typec_mode *m = alt->modes + mode;
+       char dir[6];
+
+       m->active = active;
+       snprintf(dir, 6, "mode%d", mode);
+       sysfs_notify(&alt->dev.kobj, dir, "active");
+}
+EXPORT_SYMBOL(typec_altmode_update_active);
+
+static struct device_type typec_port_dev_type;
+
+/*
+ * typec_altmode2port - Alternate Mode to USB Type-C port
+ * @alt: The Alternate Mode
+ *
+ * Returns the port that the cable plug or partner with @alt is connected to.
+ */
+struct typec_port *typec_altmode2port(struct typec_altmode *alt)
+{
+       if (alt->dev.parent->type == &typec_plug_dev_type)
+               return to_typec_port(alt->dev.parent->parent->parent);
+       if (alt->dev.parent->type == &typec_partner_dev_type)
+               return to_typec_port(alt->dev.parent->parent);
+       if (alt->dev.parent->type == &typec_port_dev_type)
+               return to_typec_port(alt->dev.parent);
+
+       return NULL;
+}
+EXPORT_SYMBOL_GPL(typec_altmode2port);
+
+static void typec_altmode_release(struct device *dev)
+{
+       struct typec_altmode *alt = to_altmode(dev);
+
+       kfree(alt->mode_groups);
+}
+
+static ssize_t
+typec_altmode_vdo_show(struct device *dev, struct device_attribute *attr,
+                      char *buf)
+{
+       struct typec_mode *mode = container_of(attr, struct typec_mode,
+                                              vdo_attr);
+
+       return sprintf(buf, "0x%08x\n", mode->vdo);
+}
+
+static ssize_t
+typec_altmode_desc_show(struct device *dev, struct device_attribute *attr,
+                       char *buf)
+{
+       struct typec_mode *mode = container_of(attr, struct typec_mode,
+                                              desc_attr);
+
+       return sprintf(buf, "%s\n", mode->desc ? mode->desc : "");
+}
+
+static ssize_t
+typec_altmode_active_show(struct device *dev, struct device_attribute *attr,
+                         char *buf)
+{
+       struct typec_mode *mode = container_of(attr, struct typec_mode,
+                                              active_attr);
+
+       return sprintf(buf, "%d\n", mode->active);
+}
+
+static ssize_t
+typec_altmode_active_store(struct device *dev, struct device_attribute *attr,
+                          const char *buf, size_t size)
+{
+       struct typec_mode *mode = container_of(attr, struct typec_mode,
+                                              active_attr);
+       struct typec_port *port = typec_altmode2port(mode->alt_mode);
+       bool activate;
+       int ret;
+
+       ret = kstrtobool(buf, &activate);
+       if (ret)
+               return ret;
+
+       ret = port->cap->activate_mode(mode->alt_mode, mode->index, activate);
+       if (ret)
+               return ret;
+
+       return size;
+}
+
+static ssize_t
+typec_altmode_roles_show(struct device *dev, struct device_attribute *attr,
+                        char *buf)
+{
+       struct typec_mode *mode = container_of(attr, struct typec_mode,
+                                              roles_attr);
+       ssize_t ret;
+
+       switch (mode->roles) {
+       case TYPEC_PORT_DFP:
+               ret =  sprintf(buf, "source\n");
+               break;
+       case TYPEC_PORT_UFP:
+               ret = sprintf(buf, "sink\n");
+               break;
+       case TYPEC_PORT_DRP:
+       default:
+               ret = sprintf(buf, "source, sink\n");
+               break;
+       }
+       return ret;
+}
+
+static void typec_init_modes(struct typec_altmode *alt, int is_port)
+{
+       struct typec_mode *mode = alt->modes;
+       int i;
+
+       for (i = 0; i < alt->n_modes; i++, mode++) {
+               mode->alt_mode = alt;
+               mode->index = i;
+               sprintf(mode->group_name, "mode%d", i);
+
+               sysfs_attr_init(&mode->vdo_attr.attr);
+               mode->vdo_attr.attr.name = "vdo";
+               mode->vdo_attr.attr.mode = S_IRUGO;
+               mode->vdo_attr.show = typec_altmode_vdo_show;
+
+               sysfs_attr_init(&mode->desc_attr.attr);
+               mode->desc_attr.attr.name = "description";
+               mode->desc_attr.attr.mode = S_IRUGO;
+               mode->desc_attr.show = typec_altmode_desc_show;
+
+               sysfs_attr_init(&mode->active_attr.attr);
+               mode->active_attr.attr.name = "active";
+               mode->active_attr.attr.mode = S_IWUSR | S_IRUGO;
+               mode->active_attr.show = typec_altmode_active_show;
+               mode->active_attr.store = typec_altmode_active_store;
+
+               mode->attrs[0] = &mode->vdo_attr.attr;
+               mode->attrs[1] = &mode->desc_attr.attr;
+               mode->attrs[2] = &mode->active_attr.attr;
+
+               /* With ports, list the roles that the mode is supported with */
+               if (is_port) {
+                       sysfs_attr_init(&mode->roles_attr.attr);
+                       mode->roles_attr.attr.name = "supported_roles";
+                       mode->roles_attr.attr.mode = S_IRUGO;
+                       mode->roles_attr.show = typec_altmode_roles_show;
+
+                       mode->attrs[3] = &mode->roles_attr.attr;
+               }
+
+               mode->group.attrs = mode->attrs;
+               mode->group.name = mode->group_name;
+
+               alt->mode_groups[i] = &mode->group;
+       }
+}
+
+static int
+typec_add_altmode(struct device *parent, struct typec_altmode *alt, int is_port)
+{
+       struct device *dev = &alt->dev;
+       int ret;
+
+       alt->mode_groups = kcalloc(alt->n_modes + 1,
+                                  sizeof(struct attibute_group *), GFP_KERNEL);
+       if (!alt->mode_groups)
+               return -ENOMEM;
+
+       typec_init_modes(alt, is_port);
+
+       dev->groups = alt->mode_groups;
+       dev->release = typec_altmode_release;
+       dev->parent = parent;
+       /* TODO: if (!is_port) dev->bus = &typec_altmode_bus; */
+
+       dev_set_name(dev, "%s.svid:%04x", dev_name(parent), alt->svid);
+
+       ret = device_register(dev);
+       if (ret) {
+               put_device(dev);
+               kfree(alt->mode_groups);
+               return ret;
+       }
+
+       return 0;
+}
+
+static int __typec_register_altmodes(struct device *parent,
+                                    struct typec_altmode *alt_modes,
+                                    int is_port)
+{
+       struct typec_altmode *alt;
+       int index;
+       int ret;
+
+       if (!alt_modes)
+               return 0;
+
+       for (alt = alt_modes, index = 0; alt->svid; alt++, index++) {
+               ret = typec_add_altmode(parent, alt, is_port);
+               if (ret)
+                       goto err;
+       }
+
+       return 0;
+err:
+       for (alt = alt_modes + index; index; alt--, index--)
+               device_unregister(&alt->dev);
+
+       return ret;
+}
+
+int typec_register_altmodes(struct device *dev, struct typec_altmode *alt_modes)
+{
+       if (dev->type == &typec_partner_dev_type) {
+               struct typec_partner *p = container_of(dev,
+                                                      struct typec_partner,
+                                                      dev);
+               p->alt_modes = alt_modes;
+       } else if (dev->type == &typec_plug_dev_type) {
+               struct typec_plug *p = container_of(dev, struct typec_plug,
+                                                   dev);
+               p->alt_modes = alt_modes;
+       } else {
+               return -ENODEV;
+       }
+
+       return __typec_register_altmodes(dev, alt_modes, false);
+}
+EXPORT_SYMBOL_GPL(typec_register_altmodes);
+
+void typec_unregister_altmodes(struct device *dev)
+{
+       struct typec_altmode *alt_modes = NULL;
+       struct typec_altmode *alt;
+
+       if (dev->type == &typec_partner_dev_type) {
+               struct typec_partner *p = container_of(dev,
+                                                      struct typec_partner,
+                                                      dev);
+               alt_modes = p->alt_modes;
+               p->alt_modes = NULL;
+       } else if (dev->type == &typec_plug_dev_type) {
+               struct typec_plug *p = container_of(dev, struct typec_plug,
+                                                   dev);
+               alt_modes = p->alt_modes;
+               p->alt_modes = NULL;
+       }
+
+       if (!alt_modes)
+               return;
+
+       for (alt = alt_modes; alt->svid; alt++)
+               device_unregister(&alt->dev);
+}
+EXPORT_SYMBOL_GPL(typec_unregister_altmodes);
+
+/* ------------------------------------------------------------------------- */
+/* USB Type-C ports */
+
+static const char * const typec_roles[] = {
+       [TYPEC_SINK]    = "sink",
+       [TYPEC_SOURCE]  = "source",
+};
+
+static const char * const typec_data_roles[] = {
+       [TYPEC_DEVICE]  = "device",
+       [TYPEC_HOST]    = "host",
+};
+
+static ssize_t
+preferred_role_store(struct device *dev, struct device_attribute *attr,
+                    const char *buf, size_t size)
+{
+       struct typec_port *port = to_typec_port(dev);
+       enum typec_role role;
+       int ret;
+
+       if (port->cap->type != TYPEC_PORT_DRP) {
+               dev_dbg(dev, "Preferred role only supported with DRP ports\n");
+               return -EOPNOTSUPP;
+       }
+
+       if (!port->cap->try_role) {
+               dev_dbg(dev, "Setting preferred role not supported\n");
+               return -EOPNOTSUPP;
+       }
+
+       ret = sysfs_strmatch(typec_roles, ARRAY_SIZE(typec_roles), buf);
+       if (ret < 0) {
+               port->prefer_role = -1;
+               return size;
+       }
+
+       role = ret;
+
+       ret = port->cap->try_role(port->cap, role);
+       if (ret)
+               return ret;
+
+       port->prefer_role = role;
+       return size;
+}
+
+static ssize_t
+preferred_role_show(struct device *dev, struct device_attribute *attr,
+                   char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       if (port->prefer_role < 0)
+               return 0;
+
+       return sprintf(buf, "%s\n", typec_roles[port->prefer_role]);
+}
+static DEVICE_ATTR_RW(preferred_role);
+
+static ssize_t
+current_data_role_store(struct device *dev, struct device_attribute *attr,
+                       const char *buf, size_t size)
+{
+       struct typec_port *port = to_typec_port(dev);
+       enum typec_role role;
+       int ret;
+
+       if (port->cap->type != TYPEC_PORT_DRP) {
+               dev_dbg(dev, "data role swap only supported with DRP ports\n");
+               return -EOPNOTSUPP;
+       }
+
+       if (!port->cap->dr_set) {
+               dev_dbg(dev, "data role swapping not supported\n");
+               return -EOPNOTSUPP;
+       }
+
+       ret = sysfs_strmatch(typec_data_roles, ARRAY_SIZE(typec_data_roles),
+                            buf);
+       if (ret < 0)
+               return ret;
+
+       role = ret;
+
+       ret = port->cap->dr_set(port->cap, role);
+       if (ret)
+               return ret;
+
+       return size;
+}
+
+static ssize_t
+current_data_role_show(struct device *dev, struct device_attribute *attr,
+                      char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       return sprintf(buf, "%s\n", typec_data_roles[port->data_role]);
+}
+static DEVICE_ATTR_RW(current_data_role);
+
+static ssize_t supported_data_roles_show(struct device *dev,
+                                        struct device_attribute *attr,
+                                        char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       if (port->cap->type == TYPEC_PORT_DRP)
+               return sprintf(buf, "host, device\n");
+
+       return sprintf(buf, "%s\n", typec_data_roles[port->data_role]);
+}
+static DEVICE_ATTR_RO(supported_data_roles);
+
+static ssize_t current_power_role_store(struct device *dev,
+                                       struct device_attribute *attr,
+                                       const char *buf, size_t size)
+{
+       struct typec_port *port = to_typec_port(dev);
+       enum typec_role role;
+       int ret = size;
+
+       if (!port->cap->usb_pd) {
+               dev_dbg(dev, "power role swap only supported with USB PD\n");
+               return -EOPNOTSUPP;
+       }
+
+       if (!port->cap->pr_set) {
+               dev_dbg(dev, "power role swapping not supported\n");
+               return -EOPNOTSUPP;
+       }
+
+       if (port->pwr_opmode != TYPEC_PWR_MODE_PD) {
+               dev_dbg(dev, "partner unable to swap power role\n");
+               return -EIO;
+       }
+
+       ret = sysfs_strmatch(typec_roles, ARRAY_SIZE(typec_roles), buf);
+       if (ret < 0)
+               return ret;
+
+       role = ret;
+
+       ret = port->cap->pr_set(port->cap, role);
+       if (ret)
+               return ret;
+
+       return size;
+}
+
+static ssize_t current_power_role_show(struct device *dev,
+                                      struct device_attribute *attr, char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       return sprintf(buf, "%s\n", typec_roles[port->pwr_role]);
+}
+static DEVICE_ATTR_RW(current_power_role);
+
+static ssize_t supported_power_roles_show(struct device *dev,
+                                         struct device_attribute *attr,
+                                         char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       if (port->cap->usb_pd || port->cap->type == TYPEC_PORT_DRP)
+               return sprintf(buf, "source, sink\n");
+
+       return sprintf(buf, "%s\n", typec_roles[port->pwr_role]);
+}
+static DEVICE_ATTR_RO(supported_power_roles);
+
+static const char * const typec_pwr_opmodes[] = {
+       [TYPEC_PWR_MODE_USB]    = "USB",
+       [TYPEC_PWR_MODE_1_5A]   = "USB Type-C 1.5A",
+       [TYPEC_PWR_MODE_3_0A]   = "USB Type-C 3.0A",
+       [TYPEC_PWR_MODE_PD]     = "USB Power Delivery",
+};
+
+static ssize_t power_operation_mode_show(struct device *dev,
+                                        struct device_attribute *attr,
+                                        char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       return sprintf(buf, "%s\n", typec_pwr_opmodes[port->pwr_opmode]);
+}
+static DEVICE_ATTR_RO(power_operation_mode);
+
+static ssize_t vconn_source_store(struct device *dev,
+                                 struct device_attribute *attr,
+                                 const char *buf, size_t size)
+{
+       struct typec_port *port = to_typec_port(dev);
+       enum typec_role role;
+       int ret;
+
+       if (!port->cap->usb_pd) {
+               dev_dbg(dev, "vconn swap only supported with USB PD\n");
+               return -EOPNOTSUPP;
+       }
+
+       if (!port->cap->vconn_set) {
+               dev_dbg(dev, "vconn swapping not supported\n");
+               return -EOPNOTSUPP;
+       }
+
+       if (sysfs_streq(buf, "1"))
+               role = TYPEC_SOURCE;
+       else if (sysfs_streq(buf, "0"))
+               role = TYPEC_SINK;
+       else
+               return -EINVAL;
+
+       ret = port->cap->vconn_set(port->cap, role);
+       if (ret)
+               return ret;
+
+       return size;
+}
+
+static ssize_t vconn_source_show(struct device *dev,
+                                struct device_attribute *attr, char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       return sprintf(buf, "%d\n", port->vconn_role == TYPEC_SOURCE ? 1 : 0);
+}
+static DEVICE_ATTR_RW(vconn_source);
+
+static ssize_t supported_accessory_modes_show(struct device *dev,
+                                             struct device_attribute *attr,
+                                             char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+       enum typec_accessory *accessory;
+       ssize_t ret = 0;
+       int i;
+
+       if (port->cap->accessory)
+               for (accessory = port->cap->accessory, i = 0;
+                    i < port->cap->num_accessory; accessory++, i++)
+                       ret += sprintf(buf, "%s\n",
+                                      typec_accessory_modes[*accessory]);
+       return ret;
+}
+static DEVICE_ATTR_RO(supported_accessory_modes);
+
+static ssize_t supports_usb_power_delivery_show(struct device *dev,
+                                               struct device_attribute *attr,
+                                               char *buf)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       return sprintf(buf, "%d\n", port->cap->usb_pd);
+}
+static DEVICE_ATTR_RO(supports_usb_power_delivery);
+
+static struct attribute *typec_attrs[] = {
+       &dev_attr_current_power_role.attr,
+       &dev_attr_current_data_role.attr,
+       &dev_attr_power_operation_mode.attr,
+       &dev_attr_preferred_role.attr,
+       &dev_attr_supported_accessory_modes.attr,
+       &dev_attr_supported_data_roles.attr,
+       &dev_attr_supported_power_roles.attr,
+       &dev_attr_supports_usb_power_delivery.attr,
+       &dev_attr_vconn_source.attr,
+       NULL,
+};
+
+static const struct attribute_group typec_group = {
+       .attrs = typec_attrs,
+};
+
+static const struct attribute_group *typec_groups[] = {
+       &typec_group,
+       NULL,
+};
+
+static int typec_uevent(struct device *dev, struct kobj_uevent_env *env)
+{
+       int ret;
+
+       ret = add_uevent_var(env, "TYPEC_PORT=%s", dev_name(dev));
+       if (ret)
+               dev_err(dev, "failed to add uevent TYPEC_PORT\n");
+
+       return ret;
+}
+
+static void typec_release(struct device *dev)
+{
+       struct typec_port *port = to_typec_port(dev);
+
+       ida_simple_remove(&typec_index_ida, port->id);
+       kfree(port);
+}
+
+static struct device_type typec_port_dev_type = {
+       .name = "typec_port",
+       .groups = typec_groups,
+       .uevent = typec_uevent,
+       .release = typec_release,
+};
+
+struct typec_port *typec_register_port(struct device *dev,
+                                      const struct typec_capability *cap)
+{
+       struct typec_port *port;
+       int ret;
+       int id;
+
+       port = kzalloc(sizeof(*port), GFP_KERNEL);
+       if (!port)
+               return ERR_PTR(-ENOMEM);
+
+       id = ida_simple_get(&typec_index_ida, 0, 0, GFP_KERNEL);
+       if (id < 0) {
+               kfree(port);
+               return ERR_PTR(id);
+       }
+
+       /* FIXME: a better approach for this */
+       port->prefer_role = -1;
+
+       port->id = id;
+       port->cap = cap;
+       port->dev.type = &typec_port_dev_type;
+       port->dev.class = &typec_class;
+       port->dev.parent = dev;
+       dev_set_name(&port->dev, "usbc%d", id);
+
+       typec_init_roles(port);
+
+       ret = device_register(&port->dev);
+       if (ret)
+               goto reg_err;
+
+       ret = __typec_register_altmodes(&port->dev, cap->alt_modes, true);
+       if (ret)
+               goto alt_err;
+
+       return port;
+alt_err:
+       device_unregister(&port->dev);
+reg_err:
+       ida_simple_remove(&typec_index_ida, id);
+       put_device(&port->dev);
+       kfree(port);
+       return ERR_PTR(ret);
+}
+EXPORT_SYMBOL_GPL(typec_register_port);
+
+void typec_unregister_port(struct typec_port *port)
+{
+       struct typec_altmode *alt;
+
+       WARN_ON(port->connected);
+
+       if (port->cap->alt_modes)
+               for (alt = port->cap->alt_modes; alt->svid; alt++)
+                       device_unregister(&alt->dev);
+       device_unregister(&port->dev);
+}
+EXPORT_SYMBOL_GPL(typec_unregister_port);
+
+static int __init typec_init(void)
+{
+       return class_register(&typec_class);
+}
+subsys_initcall(typec_init);
+
+static void __exit typec_exit(void)
+{
+       class_unregister(&typec_class);
+}
+module_exit(typec_exit);
+
+MODULE_AUTHOR("Heikki Krogerus <[email protected]>");
+MODULE_LICENSE("GPL v2");
+MODULE_DESCRIPTION("USB Type-C Connector Class");
include/linux/usb/typec.h new file +260 -1
new file mode 100644
index 0000000..eda6747
@@ -0,0 +1,260 @@
+
+#ifndef __LINUX_USB_TYPEC_H
+#define __LINUX_USB_TYPEC_H
+
+#include <linux/device.h>
+#include <linux/types.h>
+
+struct typec_port;
+
+enum typec_port_type {
+       TYPEC_PORT_DFP,
+       TYPEC_PORT_UFP,
+       TYPEC_PORT_DRP,
+};
+
+enum typec_partner_type {
+       TYPEC_PARTNER_USB,
+       TYPEC_PARTNER_CHARGER,
+       TYPEC_PARTNER_ALTMODE,
+       TYPEC_PARTNER_ACCESSORY,
+};
+
+enum typec_plug_type {
+       USB_PLUG_NONE,
+       USB_PLUG_TYPE_A,
+       USB_PLUG_TYPE_B,
+       USB_PLUG_TYPE_C,
+       USB_PLUG_CAPTIVE,
+};
+
+enum typec_data_role {
+       TYPEC_DEVICE,
+       TYPEC_HOST,
+};
+
+enum typec_role {
+       TYPEC_SINK,
+       TYPEC_SOURCE,
+};
+
+enum typec_pwr_opmode {
+       TYPEC_PWR_MODE_USB,
+       TYPEC_PWR_MODE_1_5A,
+       TYPEC_PWR_MODE_3_0A,
+       TYPEC_PWR_MODE_PD,
+};
+
+enum typec_accessory {
+       TYPEC_ACCESSORY_NONE,
+       TYPEC_ACCESSORY_AUDIO,
+       TYPEC_ACCESSORY_DEBUG,
+       TYPEC_ACCESSORY_DAUDIO,
+};
+
+/*
+ * struct typec_mode - Individual Mode of an Alternate Mode
+ * @vdo: VDO returned by Discover Modes USB PD command
+ * @desc: Mode description
+ * @active: Tells if the mode is currently entered or not
+ * @index: Index of the mode
+ * @group_name: Name for the sysfs folder in form "mode<index>"
+ * @group: The sysfs group (folder) for the mode
+ * @attrs: The attributes for the sysfs group
+ * @vdo_attr: Device attribute to expose the VDO of the mode
+ * @desc_attr: Device attribute to expose the description of the mode
+ * @active_attr: Device attribute to expose active of the mode
+ * @roles: Only for ports. DRP if the mode is awailable in both roles
+ * @roles_attr: Device attribute, only for ports, to expose the supported roles
+ *
+ * Details about a mode of an Alternate Mode which a connector, cable plug or
+ * partner supports. Every mode will have it's own sysfs group. The details are
+ * the VDO returned by discover modes command, description for the mode and
+ * active flag telling is the mode currently active or not.
+ */
+struct typec_mode {
+       u32                     vdo;
+       char                    *desc;
+       unsigned int            active:1;
+       /* Only for ports */
+       enum typec_port_type    roles;
+
+       struct typec_altmode    *alt_mode;
+
+       int                     index;
+       char                    group_name[8];
+       struct attribute_group  group;
+       struct attribute        *attrs[5];
+       struct device_attribute vdo_attr;
+       struct device_attribute desc_attr;
+       struct device_attribute active_attr;
+       /* Only for ports */
+       struct device_attribute roles_attr;
+};
+
+/*
+ * struct typec_altmode - USB Type-C Alternate Mode
+ * @dev: struct device instance
+ * @name: Name for the Alternate Mode (optional)
+ * @svid: Standard or Vendor ID
+ * @n_modes: Number of modes
+ * @modes: Array of modes supported by the Alternat Mode
+ * @mode_groups: The modes as attribute groups to be exposed in sysfs
+ *
+ * Representation of an Alternate Mode that has SVID assigned by USB-IF. The
+ * array of modes will list the modes of a particular SVID that are supported by
+ * a connector, partner of a cable plug.
+ */
+struct typec_altmode {
+       struct device           dev;
+       char                    *name;
+
+       u16                     svid;
+       int                     n_modes;
+       struct typec_mode       *modes;
+
+       const struct attribute_group **mode_groups;
+};
+
+#define to_altmode(d) container_of(d, struct typec_altmode, dev)
+
+struct typec_port *typec_altmode2port(struct typec_altmode *);
+
+void typec_altmode_update_active(struct typec_altmode *alt, int mode,
+                                bool active);
+
+int typec_register_altmodes(struct device *, struct typec_altmode *);
+void typec_unregister_altmodes(struct device *);
+
+/*
+ * struct typec_plug - USB Type-C Cable Plug
+ * @dev: struct device instance
+ * @index: 1 for the plug connected to DFP and 2 for the plug connected to UFP
+ * @alt_modes: Alternate Modes the cable plug supports (null terminated)
+ *
+ * Represents USB Type-C Cable Plug.
+ */
+struct typec_plug {
+       struct device           dev;
+       int                     index;
+       struct typec_altmode    *alt_modes;
+};
+
+/*
+ * struct typec_cable - USB Type-C Cable
+ * @dev: struct device instance
+ * @type: The plug type from USB PD Cable VDO
+ * @usb_pd: Electronically Marked Cable
+ * @active: Is the cable active or passive
+ * @sop_pp_controller: Tells whether both cable plugs are configurable or not
+ * @plug: The two plugs in the cable.
+ *
+ * Represents USB Type-C Cable attached to USB Type-C port. Two plugs are
+ * created if the cable has SOP Double Prime controller as defined in USB PD
+ * specification. Otherwise only one will be created if the cable is active. For
+ * passive cables no plugs are created.
+ */
+struct typec_cable {
+       struct device           dev;
+       enum typec_plug_type    type;
+       u32                     vdo;
+       unsigned int            usb_pd:1;
+       unsigned int            active:1;
+       unsigned int            sop_pp_controller:1;
+
+       struct typec_plug       plug[2];
+};
+
+/*
+ * struct typec_partner - USB Type-C Partner
+ * @dev: struct device instance
+ * @type: Normal USB device, charger, Alternate Mode or Accessory
+ * @usb_pd: USB Power Delivery support
+ * @vdo: VDO returned by Discover Identity USB PD command
+ * @alt_modes: Alternate Modes the partner supports (null terminated)
+ *
+ * Details about a partner that is attached to USB Type-C port.
+ */
+struct typec_partner {
+       struct device           dev;
+       enum typec_partner_type type;
+       unsigned int            usb_pd:1;
+       u32                     vdo;
+       enum typec_accessory    accessory;
+       struct typec_altmode    *alt_modes;
+};
+
+/*
+ * struct typec_capability - USB Type-C Port Capabilities
+ * @role: DFP (Host-only), UFP (Device-only) or DRP (Dual Role)
+ * @usb_pd: USB Power Delivery support
+ * @accessory: Supported Accessory Modes
+ * @num_accessory: Number of supported Accessory Modes
+ * @alt_modes: Alternate Modes the connector supports (null terminated)
+ * @try_role: Set a fixed data role for DRP port
+ * @dr_set: Set Data Role
+ * @pr_set: Set Power Role
+ * @vconn_set: Set VCONN Role
+ * @activate_mode: Enter/exit given Alternate Mode
+ *
+ * Static capabilities of a single USB Type-C port.
+ */
+struct typec_capability {
+       enum typec_port_type    type;
+       unsigned int            usb_pd:1;
+       enum typec_accessory    *accessory;
+       unsigned int            num_accessory;
+       struct typec_altmode    *alt_modes;
+
+       int                     (*try_role)(const struct typec_capability *,
+                                           enum typec_role);
+
+       int                     (*dr_set)(const struct typec_capability *,
+                                         enum typec_data_role);
+       int                     (*pr_set)(const struct typec_capability *,
+                                         enum typec_role);
+       int                     (*vconn_set)(const struct typec_capability *,
+                                            enum typec_role);
+
+       int                     (*activate_mode)(struct typec_altmode *,
+                                                int mode, int activate);
+};
+
+/*
+ * struct typec_connection - Details about USB Type-C port connection event
+ * @partner: The attached partner
+ * @cable: The attached cable
+ * @data_role: Initial USB data role (host or device)
+ * @pwr_role: Initial Power role (source or sink)
+ * @vconn_role: Initial VCONN role (source or sink)
+ * @pwr_opmode: The power mode of the connection
+ *
+ * All the relevant details about a connection event. Wrapper that is passed to
+ * typec_connect(). The context is copied when typec_connect() is called and the
+ * structure is not used for anything else.
+ */
+struct typec_connection {
+       struct typec_partner    *partner;
+       struct typec_cable      *cable;
+
+       enum typec_data_role    data_role;
+       enum typec_role         pwr_role;
+       enum typec_role         vconn_role;
+       enum typec_pwr_opmode   pwr_opmode;
+};
+
+struct typec_port *typec_register_port(struct device *dev,
+                                      const struct typec_capability *cap);
+void typec_unregister_port(struct typec_port *port);
+
+int typec_connect(struct typec_port *port, struct typec_connection *con);
+void typec_disconnect(struct typec_port *port);
+
+/* Callbacks from driver */
+
+void typec_set_data_role(struct typec_port *, enum typec_data_role);
+void typec_set_pwr_role(struct typec_port *, enum typec_role);
+void typec_set_vconn_role(struct typec_port *, enum typec_role);
+void typec_set_pwr_opmode(struct typec_port *, enum typec_pwr_opmode);
+
+#endif /* __LINUX_USB_TYPEC_H */
--

2.8.1

#3 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

In reply to Heikki Krogerus
Quoted 14 lines · Heikki Krogerus
Documentation/ABI/testing/sysfs-class-typec new file +5 -0
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in.

This
+ attribute can be used for requesting data role
swapping on the
+ port. Swapping is only supported as an asynchronous
operation
+ and requires polling of the attribute in order to know
the
+ result, so successful write operation does not mean
successful

Review

Quoted 2 lines
(quoted diff) +2 -0
+               swap.
+

That is badly formulated. Does it mean that poll() or select() can be used or does the value need to be repearedly read? And how would you learn about an error?

Regards
Oliver

author maintainer
#4 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Hi Oliver,

Quoted 12 lines · Oliver Neukum
Quoted 11 lines · Heikki Krogerus
Documentation/ABI/testing/sysfs-class-typec new file +5 -0
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in.

This
+ attribute can be used for requesting data role
swapping on the
+ port. Swapping is only supported as an asynchronous
operation
+ and requires polling of the attribute in order to know

Quoted 8 lines

Review

Quoted 5 lines

the
+ result, so successful write operation does not mean
successful

(quoted diff) +2 -0
+               swap.
+

That is badly formulated. Does it mean that poll() or select() can be used or does the value need to be repearedly read?

Does polling not always mean poll/select?

Quoted 1 line

And how would you learn about an error?

This is what I'm also really worried about. I'm now wondering did I give up too easily on this to Guenter in hope to move this thing forward. He said it's problematic to do these calls synchronously for him. Was it something related to potential conflicting role swaps from both ends?

Guenter, can you please elaborate? And how do you plan to report failures with the swaps?

Thanks,

Signature · 1 line
heikki
#5 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Quoted 1 line · Heikki Krogerus

On Tue, Aug 30, 2016 at 11:32:01AM +0200, Oliver Neukum wrote:

Hi,

Quoted 21 lines
Quoted 12 lines · Heikki Krogerus
Quoted 11 lines
Documentation/ABI/testing/sysfs-class-typec new file +5 -0
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in.

This
+ attribute can be used for requesting data role
swapping on the
+ port. Swapping is only supported as an asynchronous
operation
+ and requires polling of the attribute in order to know

Quoted 8 lines

Review

Quoted 5 lines

the
+ result, so successful write operation does not mean
successful

(quoted diff) +2 -0
+               swap.
+

That is badly formulated. Does it mean that poll() or select() can be used or does the value need to be repearedly read?

Quoted 1 line

Does polling not always mean poll/select?

No, it does not.

Quoted 5 lines
Quoted 1 line

And how would you learn about an error?

This is what I'm also really worried about. I'm now wondering did I give up too easily on this to Guenter in hope to move this thing forward. He said it's problematic to do these calls synchronously for

Error reporting does not require a synchronous operation. Reporting it in the next read() or write() and making it pollable is perfectly viable. It just must not be silently dropped.

Regards
Oliver

author maintainer
#6 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Quoted 32 lines · Oliver Neukum
Quoted 1 line · Heikki Krogerus

On Tue, Aug 30, 2016 at 11:32:01AM +0200, Oliver Neukum wrote:

Hi,

Quoted 21 lines
Quoted 12 lines · Heikki Krogerus
Quoted 11 lines
Documentation/ABI/testing/sysfs-class-typec new file +5 -0
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in.

This
+ attribute can be used for requesting data role
swapping on the
+ port. Swapping is only supported as an asynchronous
operation
+ and requires polling of the attribute in order to know

Quoted 8 lines

Review

Quoted 5 lines

the
+ result, so successful write operation does not mean
successful

(quoted diff) +2 -0
+               swap.
+

That is badly formulated. Does it mean that poll() or select() can be used or does the value need to be repearedly read?

Quoted 1 line

Does polling not always mean poll/select?

No, it does not.

Quoted 2 lines
Quoted 1 line

And how would you learn about an error?

Quoted 7 lines
Quoted 3 lines

This is what I'm also really worried about. I'm now wondering did I give up too easily on this to Guenter in hope to move this thing forward. He said it's problematic to do these calls synchronously for

Error reporting does not require a synchronous operation. Reporting it in the next read() or write() and making it pollable is perfectly viable. It just must not be silently dropped.

OK, I think I got it. I need to document that. I'll also add get_pr/dr/vconn hooks to the API for getting the status.

Thanks Oliver,

Signature · 1 line
heikki
author maintainer
#7 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Hi,

Quoted 7 lines · Heikki Krogerus
Quoted 3 lines · Oliver Neukum

Error reporting does not require a synchronous operation. Reporting it in the next read() or write() and making it pollable is perfectly viable. It just must not be silently dropped.

OK, I think I got it. I need to document that. I'll also add get_pr/dr/vconn hooks to the API for getting the status.

Would the attached diff do the trick? It also includes the other suggestions from Guenter.

Thanks,

Signature · 1 line
heikki
Documentation/ABI/testing/sysfs-class-typec +32 -23
index 53fdd11..9f249b2 100644
@@ -6,10 +6,12 @@ Contact:	Heikki Krogerus <[email protected]>
 Description:
 		The current USB data role the port is operating in. This
 		attribute can be used for requesting data role swapping on the
-		port. Swapping is only supported as an asynchronous operation
-		and requires polling of the attribute in order to know the
-		result, so successful write operation does not mean successful
-		swap.
+		port. Swapping is only supported as an asynchronous operation,
+		so successful write operation does not mean successful swap.
+		The attribute can be polled with poll() or select() to get
+		notification on finished operation. In case of failures, the
+		following read/write after finished operation will return error
+		code identifying the cause of the failure.
 
 		Valid values:
 		- host
@@ -22,9 +24,11 @@ Description:
 		The current power role of the port. This attribute can be used
 		to request power role swap on the port when the port supports
 		USB Power Delivery. Swapping is only supported as an
-		asynchronous operation and requires polling of the attribute in
-		order to know the result, so successful write operation does not
-		mean successful swap.
+		asynchronous operation, so successful write operation does not
+		mean successful swap. The attribute can be polled with poll() or
+		select() to get notification on finished operation. In case of
+		failures, the following read/write after finished operation will
+		return error code identifying the cause of the failure.
 
 		Valid values:
 		- source
@@ -37,6 +41,12 @@ Description:
 		Shows is the port VCONN Source. This attribute can be used to
 		request VCONN swap to change the VCONN Source during connection
 		when both the port and the partner support USB Power Delivery.
+		Swapping is only supported as an asynchronous operation, so
+		successful write operation does not mean successful swap. The
+		attribute can be polled with poll() or select() to get
+		notification on finished operation. In case of failures, the
+		following read/write after finished operation will return error
+		code identifying the cause of the failure.
 
 		Valid values are:
 		- 0 when the port is not the VCONN Source
@@ -113,28 +123,21 @@ Description:
 
 USB Type-C partner devices (eg. /sys/class/typec/usbc0-partner/)
 
-What:		/sys/class/typec/<port>-partner/accessory
+What:		/sys/class/typec/<port>-partner/accessory_mode
 Date:		June 2016
 Contact:	Heikki Krogerus <[email protected]>
 Description:
-		The attribute is visible only when the partner's type is
-		"Accessory". The type can be read from its own attribute.
+		Shows the Accessory Mode name or "no" when the partner is not an
+		Accesory Mode. The Accessory Modes are defined in USB Type-C
+		Specification.
 
-		Shows the name of the Accessory Mode. The Accessory Modes are
-		defined in USB Type-C Specification.
-
-What:		/sys/class/typec/<port>-partner/type
+What:		/sys/class/typec/<port>-partner/supports_usb_power_delivery
 Date:		June 2016
 Contact:	Heikki Krogerus <[email protected]>
 Description:
-		Shows the type of the partner. Can be one of the following:
-		- USB - When the partner is normal USB host/peripheral.
-		- Charger - When the partner has been identified as dedicated
-			    charger.
-		- Alternate Mode - When the partner supports Alternate Modes.
-		- Accessory - When the partner is one of the accessories with
-			      specific Accessory Mode defined in USB Type-C
-			      specification.
+		Shows if the partner supports USB Power Delivery.
+		- 0 when USB Power Delivery is not supported
+		- 1 when USB Power Delivery is supported
 
 
 USB Type-C cable devices (eg. /sys/class/typec/usbc0-cable/)
@@ -177,7 +180,13 @@ Description:
 		Shows if the mode is active or not. The attribute can be used
 		for entering/exiting the mode with partners and cable plugs, and
 		with the port alternate modes it can be used for disabling
-		support for specific alternate modes.
+		support for specific alternate modes. Entering/exiting modes is
+		only supported as an asynchronous operation, so successful write
+		operation does not mean successful swap. The attribute can be
+		polled with poll() or select() to get notification on finished
+		operation. In case of failures, the following read/write after
+		finished operation will return error code identifying the cause
+		of the failure.
 
 What:		/sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/description
 Date:		June 2016
drivers/usb/typec/typec.c +68 -48

224 lines not on this page · raw message

include/linux/usb/typec.h +10 -12
index eda6747..60a7376 100644
@@ -13,13 +13,6 @@ enum typec_port_type {
 	TYPEC_PORT_DRP,
 };
 
-enum typec_partner_type {
-	TYPEC_PARTNER_USB,
-	TYPEC_PARTNER_CHARGER,
-	TYPEC_PARTNER_ALTMODE,
-	TYPEC_PARTNER_ACCESSORY,
-};
-
 enum typec_plug_type {
 	USB_PLUG_NONE,
 	USB_PLUG_TYPE_A,
@@ -49,7 +42,6 @@ enum typec_accessory {
 	TYPEC_ACCESSORY_NONE,
 	TYPEC_ACCESSORY_AUDIO,
 	TYPEC_ACCESSORY_DEBUG,
-	TYPEC_ACCESSORY_DAUDIO,
 };
 
 /*
@@ -177,7 +169,6 @@ struct typec_cable {
  */
 struct typec_partner {
 	struct device		dev;
-	enum typec_partner_type	type;
 	unsigned int		usb_pd:1;
 	u32			vdo;
 	enum typec_accessory	accessory;
@@ -188,14 +179,17 @@ struct typec_partner {
  * struct typec_capability - USB Type-C Port Capabilities
  * @role: DFP (Host-only), UFP (Device-only) or DRP (Dual Role)
  * @usb_pd: USB Power Delivery support
- * @accessory: Supported Accessory Modes
- * @num_accessory: Number of supported Accessory Modes
+ * @accessory: Supported Accessory Modes (NULL terminated array)
  * @alt_modes: Alternate Modes the connector supports (null terminated)
  * @try_role: Set a fixed data role for DRP port
  * @dr_set: Set Data Role
+ * @dr_get: Get status from previous dr_set (mandatory with dr_set)
  * @pr_set: Set Power Role
+ * @pr_get: Get status from previous pr_get (mandatory with pr_set)
  * @vconn_set: Set VCONN Role
+ * @vconn_get: Get status from previous vconn_set (mandatory with vconn_set)
  * @activate_mode: Enter/exit given Alternate Mode
+ * @mode_status: Status from last activate_mode (mandatory with acivate_mode)
  *
  * Static capabilities of a single USB Type-C port.
  */
@@ -203,7 +197,6 @@ struct typec_capability {
 	enum typec_port_type	type;
 	unsigned int		usb_pd:1;
 	enum typec_accessory	*accessory;
-	unsigned int		num_accessory;
 	struct typec_altmode	*alt_modes;
 
 	int			(*try_role)(const struct typec_capability *,
@@ -211,13 +204,18 @@ struct typec_capability {
 
 	int			(*dr_set)(const struct typec_capability *,
 					  enum typec_data_role);
+	int			(*dr_get)(const struct typec_capability *);
 	int			(*pr_set)(const struct typec_capability *,
 					  enum typec_role);
+	int			(*pr_get)(const struct typec_capability *);
 	int			(*vconn_set)(const struct typec_capability *,
 					     enum typec_role);
+	int			(*vconn_get)(const struct typec_capability *);
 
 	int			(*activate_mode)(struct typec_altmode *,
 						 int mode, int activate);
+	int			(*mode_status)(struct typec_altmode *,
+					       int mode);
 };
 
 /*
#8 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Quoted 8 lines · Heikki Krogerus

Hi,

Quoted 5 lines · Heikki Krogerus
Quoted 3 lines · Oliver Neukum

Error reporting does not require a synchronous operation. Reporting it in the next read() or write() and making it pollable is perfectly viable. It just must not be silently dropped.

Quoted 6 lines
Quoted 2 lines

OK, I think I got it. I need to document that. I'll also add get_pr/dr/vconn hooks to the API for getting the status.

Would the attached diff do the trick? It also includes the other suggestions from Guenter.

It is not at all what I meant or asked for :-(. I'll have a closer look into the latest patch set later today.

Guenter

author maintainer
#9 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Hi guys,

Quoted 12 lines · Guenter Roeck
Quoted 11 lines · Heikki Krogerus

Hi,

Quoted 7 lines · Heikki Krogerus
Quoted 3 lines · Oliver Neukum

Error reporting does not require a synchronous operation. Reporting it in the next read() or write() and making it pollable is perfectly viable. It just must not be silently dropped.

OK, I think I got it. I need to document that. I'll also add get_pr/dr/vconn hooks to the API for getting the status.

Quoted 6 lines
Quoted 3 lines

Would the attached diff do the trick? It also includes the other suggestions from Guenter.

It is not at all what I meant or asked for :-(. I'll have a closer look into the latest patch set later today.

An other attempt. This one has just the suggestions from you Guenter (including the supports_usb_power_delivery attibute for cables as well), and update to the ABI document.

Let me know if it's OK.

Thanks,

Signature · 1 line
heikki
Documentation/ABI/testing/sysfs-class-typec +38 -24
index 53fdd11..6b60dd4 100644
@@ -6,10 +6,10 @@ Contact:	Heikki Krogerus <[email protected]>
 Description:
 		The current USB data role the port is operating in. This
 		attribute can be used for requesting data role swapping on the
-		port. Swapping is only supported as an asynchronous operation
-		and requires polling of the attribute in order to know the
-		result, so successful write operation does not mean successful
-		swap.
+		port. Swapping is supported as synchronous operation, so
+		write(2) to the attribute will not return until the operation
+		has finished. The attribute is notified about role changes so
+		that poll(2) on the attribute wakes up.
 
 		Valid values:
 		- host
@@ -21,10 +21,10 @@ Contact:	Heikki Krogerus <[email protected]>
 Description:
 		The current power role of the port. This attribute can be used
 		to request power role swap on the port when the port supports
-		USB Power Delivery. Swapping is only supported as an
-		asynchronous operation and requires polling of the attribute in
-		order to know the result, so successful write operation does not
-		mean successful swap.
+		USB Power Delivery. Swapping is supported as synchronous
+		operation, so write(2) to the attribute will not return until
+		the operation has finished. The attribute is notified about role
+		changes so that poll(2) on the attribute wakes up.
 
 		Valid values:
 		- source
@@ -37,6 +37,10 @@ Description:
 		Shows is the port VCONN Source. This attribute can be used to
 		request VCONN swap to change the VCONN Source during connection
 		when both the port and the partner support USB Power Delivery.
+		Swapping is supported as synchronous operation, so write(2) to
+		the attribute will not return until the operation has finished.
+		The attribute is notified about VCONN source changes so that
+		poll(2) on the attribute wakes up.
 
 		Valid values are:
 		- 0 when the port is not the VCONN Source
@@ -101,6 +105,7 @@ Description:
 		Valid values:
 		- source
 		- sink
+		- source, sink (DRP as defined in USB Type-C specification v1.2)
 
 What:		/sys/class/typec/<port>/supports_usb_power_delivery
 Date:		June 2016
@@ -113,28 +118,21 @@ Description:
 
 USB Type-C partner devices (eg. /sys/class/typec/usbc0-partner/)
 
-What:		/sys/class/typec/<port>-partner/accessory
+What:		/sys/class/typec/<port>-partner/accessory_mode
 Date:		June 2016
 Contact:	Heikki Krogerus <[email protected]>
 Description:
-		The attribute is visible only when the partner's type is
-		"Accessory". The type can be read from its own attribute.
+		Shows the Accessory Mode name, or "no" when the partner does not
+		support Accesory Modes. The Accessory Modes are defined in USB
+		Type-C Specification.
 
-		Shows the name of the Accessory Mode. The Accessory Modes are
-		defined in USB Type-C Specification.
-
-What:		/sys/class/typec/<port>-partner/type
+What:		/sys/class/typec/<port>-partner/supports_usb_power_delivery
 Date:		June 2016
 Contact:	Heikki Krogerus <[email protected]>
 Description:
-		Shows the type of the partner. Can be one of the following:
-		- USB - When the partner is normal USB host/peripheral.
-		- Charger - When the partner has been identified as dedicated
-			    charger.
-		- Alternate Mode - When the partner supports Alternate Modes.
-		- Accessory - When the partner is one of the accessories with
-			      specific Accessory Mode defined in USB Type-C
-			      specification.
+		Shows if the partner supports USB Power Delivery:
+		- 0 when USB Power Delivery is not supported
+		- 1 when USB Power Delivery is supported
 
 
 USB Type-C cable devices (eg. /sys/class/typec/usbc0-cable/)
@@ -165,6 +163,14 @@ Description:
 		- Type-C - USB Type-C
 		- Captive - Non-standard
 
+What:		/sys/class/typec/<port>-cable/supports_usb_power_delivery
+Date:		June 2016
+Contact:	Heikki Krogerus <[email protected]>
+Description:
+		Shows if the cable supports USB Power Delivery:
+		- 0 when USB Power Delivery is not supported
+		- 1 when USB Power Delivery is supported
+
 
 Alternate Mode devices (For example,
 /sys/class/typec/usbc0-partner/usbc0-partner.svid:xxxx/). The ports, partners
@@ -177,7 +183,15 @@ Description:
 		Shows if the mode is active or not. The attribute can be used
 		for entering/exiting the mode with partners and cable plugs, and
 		with the port alternate modes it can be used for disabling
-		support for specific alternate modes.
+		support for specific alternate modes. Entering/exiting modes is
+		supported as synchronous operation so write(2) to the attribute
+		does not return until the enter/exit mode operation has
+		finished. The attribute is notified when the mode is
+		entered/exited so poll(2) on the attribute wakes up.
+
+		Valid values:
+		- 0 when the mode is deactive
+		- 1 when the mode is active
 
 What:		/sys/class/typec/<dev>/<dev>.svid:<svid>/<mode>/description
 Date:		June 2016
drivers/usb/typec/typec.c +38 -45

145 lines not on this page · raw message

include/linux/usb/typec.h +1 -12
index eda6747..1270ca1 100644
@@ -13,13 +13,6 @@ enum typec_port_type {
 	TYPEC_PORT_DRP,
 };
 
-enum typec_partner_type {
-	TYPEC_PARTNER_USB,
-	TYPEC_PARTNER_CHARGER,
-	TYPEC_PARTNER_ALTMODE,
-	TYPEC_PARTNER_ACCESSORY,
-};
-
 enum typec_plug_type {
 	USB_PLUG_NONE,
 	USB_PLUG_TYPE_A,
@@ -49,7 +42,6 @@ enum typec_accessory {
 	TYPEC_ACCESSORY_NONE,
 	TYPEC_ACCESSORY_AUDIO,
 	TYPEC_ACCESSORY_DEBUG,
-	TYPEC_ACCESSORY_DAUDIO,
 };
 
 /*
@@ -177,7 +169,6 @@ struct typec_cable {
  */
 struct typec_partner {
 	struct device		dev;
-	enum typec_partner_type	type;
 	unsigned int		usb_pd:1;
 	u32			vdo;
 	enum typec_accessory	accessory;
@@ -188,8 +179,7 @@ struct typec_partner {
  * struct typec_capability - USB Type-C Port Capabilities
  * @role: DFP (Host-only), UFP (Device-only) or DRP (Dual Role)
  * @usb_pd: USB Power Delivery support
- * @accessory: Supported Accessory Modes
- * @num_accessory: Number of supported Accessory Modes
+ * @accessory: Supported Accessory Modes (NULL terminated array)
  * @alt_modes: Alternate Modes the connector supports (null terminated)
  * @try_role: Set a fixed data role for DRP port
  * @dr_set: Set Data Role
@@ -203,7 +193,6 @@ struct typec_capability {
 	enum typec_port_type	type;
 	unsigned int		usb_pd:1;
 	enum typec_accessory	*accessory;
-	unsigned int		num_accessory;
 	struct typec_altmode	*alt_modes;
 
 	int			(*try_role)(const struct typec_capability *,
#10 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Quoted 19 lines · Heikki Krogerus

Hi guys,

Quoted 16 lines · Guenter Roeck
Quoted 14 lines · Heikki Krogerus

Hi,

Quoted 7 lines · Heikki Krogerus
Quoted 3 lines · Oliver Neukum

Error reporting does not require a synchronous operation. Reporting it in the next read() or write() and making it pollable is perfectly viable. It just must not be silently dropped.

OK, I think I got it. I need to document that. I'll also add get_pr/dr/vconn hooks to the API for getting the status.

Would the attached diff do the trick? It also includes the other suggestions from Guenter.

Quoted 9 lines
Quoted 2 lines

It is not at all what I meant or asked for :-(. I'll have a closer look into the latest patch set later today.

An other attempt. This one has just the suggestions from you Guenter (including the supports_usb_power_delivery attibute for cables as well), and update to the ABI document.

Let me know if it's OK.

Yes, much better.

Thanks,
Guenter

#11 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

In reply to Heikki Krogerus
Quoted 28 lines · Heikki Krogerus

Hi Oliver,

Quoted 12 lines · Oliver Neukum
Quoted 11 lines · Heikki Krogerus
Documentation/ABI/testing/sysfs-class-typec new file +5 -0
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in.

This
+ attribute can be used for requesting data role
swapping on the
+ port. Swapping is only supported as an asynchronous
operation
+ and requires polling of the attribute in order to know

Quoted 8 lines

Review

Quoted 5 lines

the
+ result, so successful write operation does not mean
successful

(quoted diff) +2 -0
+               swap.
+

That is badly formulated. Does it mean that poll() or select() can be used or does the value need to be repearedly read?

Does polling not always mean poll/select?

Quoted 1 line

And how would you learn about an error?

Quoted 9 lines

This is what I'm also really worried about. I'm now wondering did I give up too easily on this to Guenter in hope to move this thing forward. He said it's problematic to do these calls synchronously for him. Was it something related to potential conflicting role swaps from both ends?

Guenter, can you please elaborate? And how do you plan to report failures with the swaps?

I thought we had this sorted out. When I said "asynchronous", I did not mean that the sysfs operation would not wait for the operation to complete. I meant that the Type-C state machine operates in a different context than the sysfs/class code. Since the state machine operates in a different context, it may have to execute a callback into the class code at any time, independently of any pending role changes triggered through sysfs. Please have a look into the patch set I submitted for details. Roughly it works as follows.

Class code context State machine context

User requests role change
Class code calls {dr,pr,vconn}_set
{dr,pr,vconn}_set code validates request
{dr,pr,vconn}_set code sends role change
request to state machine State machine gets role change request
{dr,pr,vconn}_set code waits for completion
State machine sends role change request to link partner
Partner reports Accept or Reject State machine changes state as requested State machine reports new role to class code
via callbacks
State machine informs Class code that request is complete
{dr,pr,vconn}_set code gets results
and returns to caller
Class code reports results to user

From user perspective, everything is synchronous. However, the state machine has to be able to run independently and report role and other state changes to the class code while a role change request from the class code is pending. For example, it has to be able to handle incoming role change requests from the link partner, and it has to be able to handle link state changes. All those have to be reported to the class code. This is impossible if the class code holds a lock while a role change triggered from user space is pending, which is why I asked for the locks in the class code to be removed.

Maybe my use of the term "asynchronous" was misleading, and I should have said "operates in a different context" instead. My apologies.

Thanks,
Guenter

author maintainer
#12 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

Quoted 75 lines · Guenter Roeck
Quoted 28 lines · Heikki Krogerus

Hi Oliver,

Quoted 12 lines · Oliver Neukum
Quoted 11 lines · Heikki Krogerus
Documentation/ABI/testing/sysfs-class-typec new file +5 -0
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in.

This
+ attribute can be used for requesting data role
swapping on the
+ port. Swapping is only supported as an asynchronous
operation
+ and requires polling of the attribute in order to know

Quoted 8 lines

Review

Quoted 5 lines

the
+ result, so successful write operation does not mean
successful

(quoted diff) +2 -0
+               swap.
+

That is badly formulated. Does it mean that poll() or select() can be used or does the value need to be repearedly read?

Does polling not always mean poll/select?

Quoted 1 line

And how would you learn about an error?

Quoted 9 lines

This is what I'm also really worried about. I'm now wondering did I give up too easily on this to Guenter in hope to move this thing forward. He said it's problematic to do these calls synchronously for him. Was it something related to potential conflicting role swaps from both ends?

Guenter, can you please elaborate? And how do you plan to report failures with the swaps?

I thought we had this sorted out. When I said "asynchronous", I did not mean that the sysfs operation would not wait for the operation to complete. I meant that the Type-C state machine operates in a different context than the sysfs/class code. Since the state machine operates in a different context, it may have to execute a callback into the class code at any time, independently of any pending role changes triggered through sysfs. Please have a look into the patch set I submitted for details. Roughly it works as follows.

Class code context State machine context

User requests role change
Class code calls {dr,pr,vconn}_set
{dr,pr,vconn}_set code validates request
{dr,pr,vconn}_set code sends role change
request to state machine State machine gets role change request
{dr,pr,vconn}_set code waits for completion
State machine sends role change request to link partner
Partner reports Accept or Reject State machine changes state as requested State machine reports new role to class code
via callbacks
State machine informs Class code that request is complete
{dr,pr,vconn}_set code gets results
and returns to caller
Class code reports results to user

From user perspective, everything is synchronous. However, the state machine has to be able to run independently and report role and other state changes to the class code while a role change request from the class code is pending. For example, it has to be able to handle incoming role change requests from the link partner, and it has to be able to handle link state changes. All those have to be reported to the class code. This is impossible if the class code holds a lock while a role change triggered from user space is pending, which is why I asked for the locks in the class code to be removed.

Quoted 2 lines

Maybe my use of the term "asynchronous" was misleading, and I should have said "operates in a different context" instead. My apologies.

Thanks for the explanation. I remember you did explain this before I started my parental leave, but I forgot all about it.

Thanks,

Signature · 1 line
heikki
#13 lore raw

Re: [PATCHv6 1/3] usb: USB Type-C connector class

In reply to Heikki Krogerus

Heikki,

Quoted 28 lines · Heikki Krogerus

Hi Oliver,

Quoted 12 lines · Oliver Neukum
Quoted 11 lines · Heikki Krogerus
Documentation/ABI/testing/sysfs-class-typec new file +5 -0
+What:          /sys/class/typec/<port>/current_data_role
+Date:          June 2016
+Contact:       Heikki Krogerus <[email protected]>
+Description:
+               The current USB data role the port is operating in.

This
+ attribute can be used for requesting data role
swapping on the
+ port. Swapping is only supported as an asynchronous
operation
+ and requires polling of the attribute in order to know

Quoted 8 lines

Review

Quoted 5 lines

the
+ result, so successful write operation does not mean
successful

(quoted diff) +2 -0
+               swap.
+

That is badly formulated. Does it mean that poll() or select() can be used or does the value need to be repearedly read?

Does polling not always mean poll/select?

Quoted 1 line

And how would you learn about an error?

Quoted 9 lines

This is what I'm also really worried about. I'm now wondering did I give up too easily on this to Guenter in hope to move this thing forward. He said it's problematic to do these calls synchronously for him. Was it something related to potential conflicting role swaps from both ends?

Guenter, can you please elaborate? And how do you plan to report failures with the swaps?

Following up on this again. For the record, I never meant to suggest that the ABI to userspace should be asynchronous. On the contrary, I think it should be synchronous. Reason is that it simplifies user space for the general case, where user space does not mind the wait and wants to get a valid return code as part of the operation.

The more complex case, where user space _does_ mind the wait, can always be handled by implementing a separate thread to write into sysfs attributes and wait for the result. This can be hidden in an application library which can also implement callbacks or signals to other threads as needed. It can also be tied with udev event handling to observe actual role changes (which will probably be necessary anyway).

While this may sound complicated, the code necessary to implement and support an asynchronous kernel ABI would be at least as complicated, and would probably also require a polling thread and callbacks to report results to other threads. So I don't really see a gain for user space by providing an asynchronous kernel ABI.

Thanks,
Guenter

author maintainer
#14 lore raw

PATCH v6 2/3 usb: typec: add driver for Intel Whiskey Cove PMIC USB Type-C PHY

In reply to Heikki Krogerus

This adds driver for the USB Type-C PHY on Intel WhiskeyCove PMIC which is available on some of the Intel Broxton SoC based platforms.

---
 drivers/usb/typec/Kconfig       |  14 ++
 drivers/usb/typec/Makefile      |   1 +
 drivers/usb/typec/typec_wcove.c | 372 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 387 insertions(+)
 create mode 100644 drivers/usb/typec/typec_wcove.c
drivers/usb/typec/Kconfig +14 -0
index b229fb9..7a345a4 100644
@@ -4,4 +4,18 @@ menu "USB PD and Type-C drivers"
 config TYPEC
 	tristate
 
+config TYPEC_WCOVE
+	tristate "Intel WhiskeyCove PMIC USB Type-C PHY driver"
+	depends on ACPI
+	depends on INTEL_SOC_PMIC
+	depends on INTEL_PMC_IPC
+	select TYPEC
+	help
+	  This driver adds support for USB Type-C detection on Intel Broxton
+	  platforms that have Intel Whiskey Cove PMIC. The driver can detect the
+	  role and cable orientation.
+
+	  To compile this driver as module, choose M here: the module will be
+	  called typec_wcove
+
 endmenu
drivers/usb/typec/Makefile +1 -0
index 1012a8b..b9cb862 100644
@@ -1 +1,2 @@
 obj-$(CONFIG_TYPEC)		+= typec.o
+obj-$(CONFIG_TYPEC_WCOVE)	+= typec_wcove.o
drivers/usb/typec/typec_wcove.c new file +372 -0

372 lines not on this page · raw message

Signature · 1 line
2.8.1
author maintainer
#15 lore raw

PATCH v6 3/3 mfd: intel_soc_pmic_bxtwc: add support for USB Type-C PHY on WhiskeyCove

In reply to Heikki Krogerus

Intel WhiskeyCove PMIC has also a USB Type-C PHY, so let's create a device for it.

---
 drivers/mfd/intel_soc_pmic_bxtwc.c | 11 +++++++++++
 1 file changed, 11 insertions(+)
drivers/mfd/intel_soc_pmic_bxtwc.c +11 -0
index b942876..0e61dde 100644
@@ -84,6 +84,7 @@ enum bxtwc_irqs_level2 {
 	BXTWC_THRM2_IRQ,
 	BXTWC_BCU_IRQ,
 	BXTWC_ADC_IRQ,
+	BXTWC_USBC_IRQ,
 	BXTWC_CHGR0_IRQ,
 	BXTWC_CHGR1_IRQ,
 	BXTWC_GPIO0_IRQ,
@@ -109,6 +110,7 @@ static const struct regmap_irq bxtwc_regmap_irqs_level2[] = {
 	REGMAP_IRQ_REG(BXTWC_THRM2_IRQ, 2, 0xff),
 	REGMAP_IRQ_REG(BXTWC_BCU_IRQ, 3, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_ADC_IRQ, 4, 0xff),
+	REGMAP_IRQ_REG(BXTWC_USBC_IRQ, 5, BIT(5)),
 	REGMAP_IRQ_REG(BXTWC_CHGR0_IRQ, 5, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_CHGR1_IRQ, 6, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_GPIO0_IRQ, 7, 0xff),
@@ -143,6 +145,10 @@ static struct resource adc_resources[] = {
 	DEFINE_RES_IRQ_NAMED(BXTWC_ADC_IRQ, "ADC"),
 };
 
+static struct resource usbc_resources[] = {
+	DEFINE_RES_IRQ(BXTWC_USBC_IRQ),
+};
+
 static struct resource charger_resources[] = {
 	DEFINE_RES_IRQ_NAMED(BXTWC_CHGR0_IRQ, "CHARGER"),
 	DEFINE_RES_IRQ_NAMED(BXTWC_CHGR1_IRQ, "CHARGER1"),
@@ -170,6 +176,11 @@ static struct mfd_cell bxt_wc_dev[] = {
 		.resources = thermal_resources,
 	},
 	{
+		.name = "bxt_wcove_usbc",
+		.num_resources = ARRAY_SIZE(usbc_resources),
+		.resources = usbc_resources,
+	},
+	{
 		.name = "bxt_wcove_ext_charger",
 		.num_resources = ARRAY_SIZE(charger_resources),
 		.resources = charger_resources,
Signature · 1 line
2.8.1
Applied
#16 lore raw

Re: [PATCHv6 3/3] mfd: intel_soc_pmic_bxtwc: add support for USB Type-C PHY on WhiskeyCove

Quoted 8 lines · Heikki Krogerus

Intel WhiskeyCove PMIC has also a USB Type-C PHY, so let's create a device for it.

---
 drivers/mfd/intel_soc_pmic_bxtwc.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

Applied, thanks.

Quoted 43 lines
drivers/mfd/intel_soc_pmic_bxtwc.c +11 -0
index b942876..0e61dde 100644
@@ -84,6 +84,7 @@ enum bxtwc_irqs_level2 {
 	BXTWC_THRM2_IRQ,
 	BXTWC_BCU_IRQ,
 	BXTWC_ADC_IRQ,
+	BXTWC_USBC_IRQ,
 	BXTWC_CHGR0_IRQ,
 	BXTWC_CHGR1_IRQ,
 	BXTWC_GPIO0_IRQ,
@@ -109,6 +110,7 @@ static const struct regmap_irq bxtwc_regmap_irqs_level2[] = {
 	REGMAP_IRQ_REG(BXTWC_THRM2_IRQ, 2, 0xff),
 	REGMAP_IRQ_REG(BXTWC_BCU_IRQ, 3, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_ADC_IRQ, 4, 0xff),
+	REGMAP_IRQ_REG(BXTWC_USBC_IRQ, 5, BIT(5)),
 	REGMAP_IRQ_REG(BXTWC_CHGR0_IRQ, 5, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_CHGR1_IRQ, 6, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_GPIO0_IRQ, 7, 0xff),
@@ -143,6 +145,10 @@ static struct resource adc_resources[] = {
 	DEFINE_RES_IRQ_NAMED(BXTWC_ADC_IRQ, "ADC"),
 };
 
+static struct resource usbc_resources[] = {
+	DEFINE_RES_IRQ(BXTWC_USBC_IRQ),
+};
+
 static struct resource charger_resources[] = {
 	DEFINE_RES_IRQ_NAMED(BXTWC_CHGR0_IRQ, "CHARGER"),
 	DEFINE_RES_IRQ_NAMED(BXTWC_CHGR1_IRQ, "CHARGER1"),
@@ -170,6 +176,11 @@ static struct mfd_cell bxt_wc_dev[] = {
 		.resources = thermal_resources,
 	},
 	{
+		.name = "bxt_wcove_usbc",
+		.num_resources = ARRAY_SIZE(usbc_resources),
+		.resources = usbc_resources,
+	},
+	{
 		.name = "bxt_wcove_ext_charger",
 		.num_resources = ARRAY_SIZE(charger_resources),
 		.resources = charger_resources,
Signature · 4 lines
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
#17 lore raw

Re: [PATCHv6 3/3] mfd: intel_soc_pmic_bxtwc: add support for USB Type-C PHY on WhiskeyCove

Quoted 5 lines · Lee Jones
Quoted 3 lines · Heikki Krogerus

Intel WhiskeyCove PMIC has also a USB Type-C PHY, so let's create a device for it.

Quoted 7 lines
Quoted 5 lines
---
 drivers/mfd/intel_soc_pmic_bxtwc.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

Applied, thanks.

This patch conflicts with ...

"mfd: intel_soc_pmic_bxtwc: Add bxt_wcove_usbc device"

Please re-base your changes on my tree (or -next) and resubmit if this change is still relevant.

Quoted 44 lines
Quoted 43 lines
drivers/mfd/intel_soc_pmic_bxtwc.c +11 -0
index b942876..0e61dde 100644
@@ -84,6 +84,7 @@ enum bxtwc_irqs_level2 {
 	BXTWC_THRM2_IRQ,
 	BXTWC_BCU_IRQ,
 	BXTWC_ADC_IRQ,
+	BXTWC_USBC_IRQ,
 	BXTWC_CHGR0_IRQ,
 	BXTWC_CHGR1_IRQ,
 	BXTWC_GPIO0_IRQ,
@@ -109,6 +110,7 @@ static const struct regmap_irq bxtwc_regmap_irqs_level2[] = {
 	REGMAP_IRQ_REG(BXTWC_THRM2_IRQ, 2, 0xff),
 	REGMAP_IRQ_REG(BXTWC_BCU_IRQ, 3, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_ADC_IRQ, 4, 0xff),
+	REGMAP_IRQ_REG(BXTWC_USBC_IRQ, 5, BIT(5)),
 	REGMAP_IRQ_REG(BXTWC_CHGR0_IRQ, 5, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_CHGR1_IRQ, 6, 0x1f),
 	REGMAP_IRQ_REG(BXTWC_GPIO0_IRQ, 7, 0xff),
@@ -143,6 +145,10 @@ static struct resource adc_resources[] = {
 	DEFINE_RES_IRQ_NAMED(BXTWC_ADC_IRQ, "ADC"),
 };
 
+static struct resource usbc_resources[] = {
+	DEFINE_RES_IRQ(BXTWC_USBC_IRQ),
+};
+
 static struct resource charger_resources[] = {
 	DEFINE_RES_IRQ_NAMED(BXTWC_CHGR0_IRQ, "CHARGER"),
 	DEFINE_RES_IRQ_NAMED(BXTWC_CHGR1_IRQ, "CHARGER1"),
@@ -170,6 +176,11 @@ static struct mfd_cell bxt_wc_dev[] = {
 		.resources = thermal_resources,
 	},
 	{
+		.name = "bxt_wcove_usbc",
+		.num_resources = ARRAY_SIZE(usbc_resources),
+		.resources = usbc_resources,
+	},
+	{
 		.name = "bxt_wcove_ext_charger",
 		.num_resources = ARRAY_SIZE(charger_resources),
 		.resources = charger_resources,
Signature · 4 lines
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
#18 lore raw
In reply to Heikki Krogerus
Quoted 3 lines · Heikki Krogerus

The USB Type-C class is meant to provide unified interface to the userspace to present the USB Type-C ports in a system.

The subject says "v6".

Guenter

Quoted 61 lines

Changes since v6:
- current_vconn_role attr renamed to vconn_source (no API changes)
- Small documentation improvements proposed by Vincent Palatin

Changes since v5:
- Only updating the roles based on driver notifications
- Added MODULE_ALIAS for the WhiskeyCove module
- Including the patch that creates the actual platform device for the WhiskeyCove Type-C PHY in this series.

Changes since v4:
- Remove the port lock completely

Changes since v3:
- Documentation cleanup as proposed by Roger Quadros
- Setting partner altmodes member to NULL on removal and fixing a warning, as proposed by Guenter Roeck
- Added the following attributes for partners and cables:
* supports_usb_power_delivery
* id_header_vdo
- "id_header_vdo" is visible only when the partner or cable supports USB Power Delivery communication.
- Partner attribute "accessory" is hidden when the partner type is not "Accessory".

Changes since v2:
- Notification on role and alternate mode changes
- cleanups

Changes since v1:
- Completely rewrote alternate mode support
- Patners, cables and cable plugs presented as devices.

Heikki Krogerus (3):
usb: USB Type-C connector class
usb: typec: add driver for Intel Whiskey Cove PMIC USB Type-C PHY
mfd: intel_soc_pmic_bxtwc: add support for USB Type-C PHY on
WhiskeyCove

 Documentation/ABI/testing/sysfs-class-typec |  205 +++++
 Documentation/usb/typec.txt                 |  103 +++
 MAINTAINERS                                 |    9 +
 drivers/mfd/intel_soc_pmic_bxtwc.c          |   11 +
 drivers/usb/Kconfig                         |    2 +
 drivers/usb/Makefile                        |    2 +
 drivers/usb/typec/Kconfig                   |   21 +
 drivers/usb/typec/Makefile                  |    2 +
 drivers/usb/typec/typec.c                   | 1091 +++++++++++++++++++++++++++
 drivers/usb/typec/typec_wcove.c             |  372 +++++++++
 include/linux/usb/typec.h                   |  260 +++++++
 11 files changed, 2078 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-typec
 create mode 100644 Documentation/usb/typec.txt
 create mode 100644 drivers/usb/typec/Kconfig
 create mode 100644 drivers/usb/typec/Makefile
 create mode 100644 drivers/usb/typec/typec.c
 create mode 100644 drivers/usb/typec/typec_wcove.c
 create mode 100644 include/linux/usb/typec.h
author maintainer
#19 lore raw
Quoted 5 lines · Guenter Roeck
Quoted 3 lines · Heikki Krogerus

The USB Type-C class is meant to provide unified interface to the userspace to present the USB Type-C ports in a system.

The subject says "v6".

True. I used the wrong reroll-count when formatting. I'm sorry about that.

Thanks,

Signature · 1 line
heikki