diff mbox series

[v2,1/3] usb: typec: Add typec_port_register_altmodes()

Message ID 20210409134033.105834-2-hdegoede@redhat.com
State New
Headers show
Series [v2,1/3] usb: typec: Add typec_port_register_altmodes() | expand

Commit Message

Hans de Goede April 9, 2021, 1:40 p.m. UTC
This can be used by Type-C controller drivers which use a standard
usb-connector fwnode, with altmodes sub-node, to describe the available
altmodes.

Note there are is no devicetree bindings documentation for the altmodes
node, this is deliberate. ATM the fwnodes used to register the altmodes
are only used internally to pass platform info from a drivers/platform/x86
driver to the type-c subsystem.

When a devicetree user of this functionally comes up and the dt-bindings
have been hashed out the internal use can be adjusted to match the
dt-bindings.

Currently the typec_port_register_altmodes() function expects
an "altmodes" child fwnode on port->dev with this "altmodes" fwnode having
child fwnodes itself with each child containing 2 integer properties:

1. A "svid" property, which sets the id of the altmode, e.g. displayport
altmode has a svid of 0xff01.

2. A "vdo" property, typically used as a bitmask describing the
capabilities of the altmode, the bits in the vdo are specified in the
specification of the altmode.

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
---
Changes in v3:
- Rename typec_port_register_altmodes_from_fwnode() to
  typec_port_register_altmodes()
- Use fwnode_for_each_child_node()

Changes in v2:
- Drop the unnecessary fwnode parameter from
  typec_port_register_altmodes_from_fwnode()
- Document the expected "altmodes" fwnode in the commit message for now
  as v2 of the patch-set drops the dt-bindings since there are not DT
  users for this yet
---
 drivers/usb/typec/class.c | 54 +++++++++++++++++++++++++++++++++++++++
 include/linux/usb/typec.h |  6 +++++
 2 files changed, 60 insertions(+)

Comments

Guenter Roeck April 10, 2021, 2:12 a.m. UTC | #1
On 4/9/21 6:40 AM, Hans de Goede wrote:
> This can be used by Type-C controller drivers which use a standard

> usb-connector fwnode, with altmodes sub-node, to describe the available

> altmodes.

> 

> Note there are is no devicetree bindings documentation for the altmodes

> node, this is deliberate. ATM the fwnodes used to register the altmodes

> are only used internally to pass platform info from a drivers/platform/x86

> driver to the type-c subsystem.

> 

> When a devicetree user of this functionally comes up and the dt-bindings

> have been hashed out the internal use can be adjusted to match the

> dt-bindings.

> 

> Currently the typec_port_register_altmodes() function expects

> an "altmodes" child fwnode on port->dev with this "altmodes" fwnode having

> child fwnodes itself with each child containing 2 integer properties:

> 

> 1. A "svid" property, which sets the id of the altmode, e.g. displayport

> altmode has a svid of 0xff01.

> 

> 2. A "vdo" property, typically used as a bitmask describing the

> capabilities of the altmode, the bits in the vdo are specified in the

> specification of the altmode.

> 

> Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> Signed-off-by: Hans de Goede <hdegoede@redhat.com>


Reviewed-by: Guenter Roeck <linux@roeck-us.net>


> ---

> Changes in v3:

> - Rename typec_port_register_altmodes_from_fwnode() to

>   typec_port_register_altmodes()

> - Use fwnode_for_each_child_node()

> 

> Changes in v2:

> - Drop the unnecessary fwnode parameter from

>   typec_port_register_altmodes_from_fwnode()

> - Document the expected "altmodes" fwnode in the commit message for now

>   as v2 of the patch-set drops the dt-bindings since there are not DT

>   users for this yet

> ---

>  drivers/usb/typec/class.c | 54 +++++++++++++++++++++++++++++++++++++++

>  include/linux/usb/typec.h |  6 +++++

>  2 files changed, 60 insertions(+)

> 

> diff --git a/drivers/usb/typec/class.c b/drivers/usb/typec/class.c

> index 45f0bf65e9ab..af4b5d91a7c7 100644

> --- a/drivers/usb/typec/class.c

> +++ b/drivers/usb/typec/class.c

> @@ -1978,6 +1978,60 @@ typec_port_register_altmode(struct typec_port *port,

>  }

>  EXPORT_SYMBOL_GPL(typec_port_register_altmode);

>  

> +void typec_port_register_altmodes(struct typec_port *port,

> +	const struct typec_altmode_ops *ops, void *drvdata,

> +	struct typec_altmode **altmodes, size_t n)

> +{

> +	struct fwnode_handle *altmodes_node, *child;

> +	struct typec_altmode_desc desc;

> +	struct typec_altmode *alt;

> +	size_t index = 0;

> +	u32 svid, vdo;

> +	int ret;

> +

> +	altmodes_node = device_get_named_child_node(&port->dev, "altmodes");

> +	if (!altmodes_node)

> +		return; /* No altmodes specified */

> +

> +	fwnode_for_each_child_node(altmodes_node, child) {

> +		ret = fwnode_property_read_u32(child, "svid", &svid);

> +		if (ret) {

> +			dev_err(&port->dev, "Error reading svid for altmode %s\n",

> +				fwnode_get_name(child));

> +			continue;

> +		}

> +

> +		ret = fwnode_property_read_u32(child, "vdo", &vdo);

> +		if (ret) {

> +			dev_err(&port->dev, "Error reading vdo for altmode %s\n",

> +				fwnode_get_name(child));

> +			continue;

> +		}

> +

> +		if (index >= n) {

> +			dev_err(&port->dev, "Error not enough space for altmode %s\n",

> +				fwnode_get_name(child));

> +			continue;

> +		}

> +

> +		desc.svid = svid;

> +		desc.vdo = vdo;

> +		desc.mode = index + 1;

> +		alt = typec_port_register_altmode(port, &desc);

> +		if (IS_ERR(alt)) {

> +			dev_err(&port->dev, "Error registering altmode %s\n",

> +				fwnode_get_name(child));

> +			continue;

> +		}

> +

> +		alt->ops = ops;

> +		typec_altmode_set_drvdata(alt, drvdata);

> +		altmodes[index] = alt;

> +		index++;

> +	}

> +}

> +EXPORT_SYMBOL_GPL(typec_port_register_altmodes);

> +

>  /**

>   * typec_register_port - Register a USB Type-C Port

>   * @parent: Parent device

> diff --git a/include/linux/usb/typec.h b/include/linux/usb/typec.h

> index 91b4303ca305..71b4dd6e63f1 100644

> --- a/include/linux/usb/typec.h

> +++ b/include/linux/usb/typec.h

> @@ -17,6 +17,7 @@ struct typec_partner;

>  struct typec_cable;

>  struct typec_plug;

>  struct typec_port;

> +struct typec_altmode_ops;

>  

>  struct fwnode_handle;

>  struct device;

> @@ -138,6 +139,11 @@ struct typec_altmode

>  struct typec_altmode

>  *typec_port_register_altmode(struct typec_port *port,

>  			     const struct typec_altmode_desc *desc);

> +

> +void typec_port_register_altmodes(struct typec_port *port,

> +	const struct typec_altmode_ops *ops, void *drvdata,

> +	struct typec_altmode **altmodes, size_t n);

> +

>  void typec_unregister_altmode(struct typec_altmode *altmode);

>  

>  struct typec_port *typec_altmode2port(struct typec_altmode *alt);

>
diff mbox series

Patch

diff --git a/drivers/usb/typec/class.c b/drivers/usb/typec/class.c
index 45f0bf65e9ab..af4b5d91a7c7 100644
--- a/drivers/usb/typec/class.c
+++ b/drivers/usb/typec/class.c
@@ -1978,6 +1978,60 @@  typec_port_register_altmode(struct typec_port *port,
 }
 EXPORT_SYMBOL_GPL(typec_port_register_altmode);
 
+void typec_port_register_altmodes(struct typec_port *port,
+	const struct typec_altmode_ops *ops, void *drvdata,
+	struct typec_altmode **altmodes, size_t n)
+{
+	struct fwnode_handle *altmodes_node, *child;
+	struct typec_altmode_desc desc;
+	struct typec_altmode *alt;
+	size_t index = 0;
+	u32 svid, vdo;
+	int ret;
+
+	altmodes_node = device_get_named_child_node(&port->dev, "altmodes");
+	if (!altmodes_node)
+		return; /* No altmodes specified */
+
+	fwnode_for_each_child_node(altmodes_node, child) {
+		ret = fwnode_property_read_u32(child, "svid", &svid);
+		if (ret) {
+			dev_err(&port->dev, "Error reading svid for altmode %s\n",
+				fwnode_get_name(child));
+			continue;
+		}
+
+		ret = fwnode_property_read_u32(child, "vdo", &vdo);
+		if (ret) {
+			dev_err(&port->dev, "Error reading vdo for altmode %s\n",
+				fwnode_get_name(child));
+			continue;
+		}
+
+		if (index >= n) {
+			dev_err(&port->dev, "Error not enough space for altmode %s\n",
+				fwnode_get_name(child));
+			continue;
+		}
+
+		desc.svid = svid;
+		desc.vdo = vdo;
+		desc.mode = index + 1;
+		alt = typec_port_register_altmode(port, &desc);
+		if (IS_ERR(alt)) {
+			dev_err(&port->dev, "Error registering altmode %s\n",
+				fwnode_get_name(child));
+			continue;
+		}
+
+		alt->ops = ops;
+		typec_altmode_set_drvdata(alt, drvdata);
+		altmodes[index] = alt;
+		index++;
+	}
+}
+EXPORT_SYMBOL_GPL(typec_port_register_altmodes);
+
 /**
  * typec_register_port - Register a USB Type-C Port
  * @parent: Parent device
diff --git a/include/linux/usb/typec.h b/include/linux/usb/typec.h
index 91b4303ca305..71b4dd6e63f1 100644
--- a/include/linux/usb/typec.h
+++ b/include/linux/usb/typec.h
@@ -17,6 +17,7 @@  struct typec_partner;
 struct typec_cable;
 struct typec_plug;
 struct typec_port;
+struct typec_altmode_ops;
 
 struct fwnode_handle;
 struct device;
@@ -138,6 +139,11 @@  struct typec_altmode
 struct typec_altmode
 *typec_port_register_altmode(struct typec_port *port,
 			     const struct typec_altmode_desc *desc);
+
+void typec_port_register_altmodes(struct typec_port *port,
+	const struct typec_altmode_ops *ops, void *drvdata,
+	struct typec_altmode **altmodes, size_t n);
+
 void typec_unregister_altmode(struct typec_altmode *altmode);
 
 struct typec_port *typec_altmode2port(struct typec_altmode *alt);