Re: [RFC PATCH v3 3/5] usb: typec: Bus type for alternate modes

[Heikki Krogerus]

On Sat, May 12, 2018 at 06:25:09PM -0700, Randy Dunlap wrote:
> On 05/11/2018 06:18 AM, Heikki Krogerus wrote:
> > Introducing a simple bus for the alternate modes. Bus allows
> > binding drivers to the discovered alternate modes the
> > partners support.
> > 
> > Signed-off-by: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> > ---
> >  Documentation/ABI/obsolete/sysfs-class-typec |  48 +++
> >  Documentation/ABI/testing/sysfs-bus-typec    |  51 +++
> >  Documentation/ABI/testing/sysfs-class-typec  |  62 +--
> >  Documentation/driver-api/usb/typec_bus.rst   | 136 ++++++
> >  drivers/usb/typec/Makefile                   |   2 +-
> >  drivers/usb/typec/bus.c                      | 423 +++++++++++++++++++
> >  drivers/usb/typec/bus.h                      |  38 ++
> >  drivers/usb/typec/class.c                    | 364 ++++++++++++----
> >  include/linux/mod_devicetable.h              |  15 +
> >  include/linux/usb/typec.h                    |  14 +-
> >  include/linux/usb/typec_altmode.h            | 142 +++++++
> >  scripts/mod/devicetable-offsets.c            |   4 +
> >  scripts/mod/file2alias.c                     |  13 +
> >  13 files changed, 1168 insertions(+), 144 deletions(-)
> >  create mode 100644 Documentation/ABI/obsolete/sysfs-class-typec
> >  create mode 100644 Documentation/ABI/testing/sysfs-bus-typec
> >  create mode 100644 Documentation/driver-api/usb/typec_bus.rst
> >  create mode 100644 drivers/usb/typec/bus.c
> >  create mode 100644 drivers/usb/typec/bus.h
> >  create mode 100644 include/linux/usb/typec_altmode.h
> 
> Hi,
> I have a few doc corrections for you.

Thanks, I'll fix all of them as you proposed.

> > diff --git a/Documentation/driver-api/usb/typec_bus.rst b/Documentation/driver-api/usb/typec_bus.rst
> > new file mode 100644
> > index 000000000000..4184e0925567
> > --- /dev/null
> > +++ b/Documentation/driver-api/usb/typec_bus.rst
> > @@ -0,0 +1,136 @@
> > +
> > +API for USB Type-C Alternate Mode drivers
> > +=========================================
> > +
> > +Introduction
> > +------------
> > +
> > +Alternate modes require communication with the partner using Vendor Defined
> > +Messages (VDM) as defined in USB Type-C and USB Power Delivery Specifications.
> > +The communication is SVID (Standard or Vendor ID) specific, i.e. specific for
> > +every alternate mode, so every alternate mode will need custom driver.
> 
>                                                            a custom driver.
> 
> > +
> > +USB Type-C bus allows binding a driver to the discovered partner alternate
> > +modes by using the SVID and the mode number.
> > +
> > +USB Type-C Connector Class provides a device for every alternate mode a port
> > +supports, and separate device for every alternate mode the partner supports.
> > +The drivers for the alternate modes are bind to the partner alternate mode
> 
>                                        are bound
> or just:                               bind
> 
> > +devices, and the port alternate mode devices must be handled by the port
> > +drivers.
> > +
> > +When a new partner alternate mode device is registered, it is linked to the
> > +alternate mode device of the port that the partner is attached to, that has
> > +matching SVID and mode. Communication between the port driver and alternate mode
> > +driver will happen using the same API.
> > +
> > +The port alternate mode devices are used as a proxy between the partner and the
> > +alternate mode drivers, so the port drivers are only expected to pass the SVID
> > +specific commands from the alternate mode drivers to the partner, and from the
> > +partners to the alternate mode drivers. No direct SVID specific communication is
> > +needed from the port drivers, but the port drivers need to provide the operation
> > +callbacks for the port alternate mode devices, just like the alternate mode
> > +drivers need to provide them for the partner alternate mode devices.
> > +
> > +Usage:
> > +------
> > +
> > +General
> > +~~~~~~~
> > +
> > +By default, the alternate mode drivers are responsible for entering the mode.
> > +It is also possible to leave the decision about entering the mode to the user
> > +space (See Documentation/ABI/testing/sysfs-class-typec). Port drivers should not
> > +enter any modes on their own.
> > +
> > +``->vdm`` is the most important callback in the vector. It will be used to
> > +deliver all the SVID specific commands from the partner to the alternate mode
> > +driver, and vise versa in case of port drivers. The drivers send the SVID
> 
>                vice versa
> 
> > +specific commands to each other using :c:func:`typec_altmode_vmd()`.
> > +
> > +If the communication with the partner using the SVID specific commands results
> > +in need to re-configure the pins on the connector, the alternate mode driver
> 
>               reconfigure
> 
> > +needs to notify the bus using :c:func:`typec_altmode_notify()`. The driver
> > +passes the negotiated SVID specific pin configuration value to the function as
> > +parameter. The bus driver will then configure the mux behind the connector using
> > +that value as the state value for the mux, and also call blocking notification
> > +chain to notify the external drivers about the state of the connector that need
> > +to know it.
> > +
> > +NOTE: The SVID specific pin configuration values must always start from
> > +``TYPEC_STATE_MODAL``. USB Type-C specification defines two default states for
> > +the connector: ``TYPEC_STATE_USB`` and ``TYPEC_STATE_SAFE``. These values are
> > +reserved by the bus as the first possible values for the state. When the
> > +alternate mode is entered, the bus will put the connector into
> > +``TYPEC_STATE_SAFE`` before sending Enter or Exit Mode command as defined in USB
> > +Type-C Specification, and also put the connector back to ``TYPEC_STATE_USB``
> > +after the mode has been exited.
> > +
> > +An example of working definitions for SVID specific pin configurations would
> > +look like this:
> > +
> > +enum {
> > +	ALTMODEX_CONF_A = TYPEC_STATE_MODAL,
> > +	ALTMODEX_CONF_B,
> > +	...
> > +};
> > +
> > +Helper macro ``TYPEC_MODAL_STATE()`` can also be used:
> > +
> > +#define ALTMODEX_CONF_A = TYPEC_MODAL_STATE(0);
> > +#define ALTMODEX_CONF_B = TYPEC_MODAL_STATE(1);
> > +
> > +Notification chain
> > +~~~~~~~~~~~~~~~~~~
> > +
> > +The drivers for the components that the alternate modes are designed for need to
> > +get details regarding the results of the negotiation with the partner, and the
> > +pin configuration of the connector. In case of DisplayPort alternate mode for
> > +example, the GPU drivers will need to know those details. In case of
> > +Thunderbolt alternate mode, the thunderbolt drivers will need to know them, and
> > +so on.
> > +
> > +The notification chain is designed for this purpose. The drivers can register
> > +notifiers with :c:func:`typec_altmode_register_notifier()`.
> > +
> > +Cable plug alternate modes
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +The alternate mode drivers are not bind to cable plug alternate mode devices,
> 
>                               are not bound
> 
> > +only to the partner alternate mode devices. If the alternate mode supports, or
> > +requires, a cable that responds to SOP Prime, and optionally SOP Double Prime
> > +messages, the driver for that alternate mode must request handle to the cable
> > +plug alternate modes using :c:func:`typec_altmode_get_plug()`, and taking over
> 
>                                                                   and take over
> 
> > +their control.
> > +
> > +Driver API
> > +----------
> > +
> > +Alternate mode driver registering/unregistering
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +.. kernel-doc:: drivers/usb/typec/bus.c
> > +   :functions: typec_altmode_register_driver typec_altmode_unregister_driver
> > +
> > +Alternate mode driver operations
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +.. kernel-doc:: drivers/usb/typec/bus.c
> > +   :functions: typec_altmode_enter typec_altmode_exit typec_altmode_attention typec_altmode_vdm typec_altmode_notify
> > +
> > +API for the port drivers
> > +~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +.. kernel-doc:: drivers/usb/typec/bus.c
> > +   :functions: typec_match_altmode
> > +
> > +Cable Plug operations
> > +~~~~~~~~~~~~~~~~~~~~~
> > +
> > +.. kernel-doc:: drivers/usb/typec/bus.c
> > +   :functions: typec_altmode_get_plug typec_altmode_put_plug
> > +
> > +Notifications
> > +~~~~~~~~~~~~~
> > +.. kernel-doc:: drivers/usb/typec/class.c
> > +   :functions: typec_altmode_register_notifier typec_altmode_unregister_notifier


Thanks,

-- 
heikki