1 // SPDX-License-Identifier: GPL-2.0
3 * USB Type-C Connector Class
5 * Copyright (C) 2017, Intel Corporation
9 #include <linux/module.h>
10 #include <linux/mutex.h>
11 #include <linux/property.h>
12 #include <linux/slab.h>
13 #include <linux/usb/pd_vdo.h>
14 #include <linux/usb/typec_mux.h>
15 #include <linux/usb/typec_retimer.h>
16 #include <linux/usb.h>
22 static DEFINE_IDA(typec_index_ida);
24 const struct class typec_class = {
28 /* ------------------------------------------------------------------------- */
29 /* Common attributes */
31 static const char * const typec_accessory_modes[] = {
32 [TYPEC_ACCESSORY_NONE] = "none",
33 [TYPEC_ACCESSORY_AUDIO] = "analog_audio",
34 [TYPEC_ACCESSORY_DEBUG] = "debug",
37 /* Product types defined in USB PD Specification R3.0 V2.0 */
38 static const char * const product_type_ufp[8] = {
39 [IDH_PTYPE_NOT_UFP] = "not_ufp",
40 [IDH_PTYPE_HUB] = "hub",
41 [IDH_PTYPE_PERIPH] = "peripheral",
42 [IDH_PTYPE_PSD] = "psd",
43 [IDH_PTYPE_AMA] = "ama",
46 static const char * const product_type_dfp[8] = {
47 [IDH_PTYPE_NOT_DFP] = "not_dfp",
48 [IDH_PTYPE_DFP_HUB] = "hub",
49 [IDH_PTYPE_DFP_HOST] = "host",
50 [IDH_PTYPE_DFP_PB] = "power_brick",
53 static const char * const product_type_cable[8] = {
54 [IDH_PTYPE_NOT_CABLE] = "not_cable",
55 [IDH_PTYPE_PCABLE] = "passive",
56 [IDH_PTYPE_ACABLE] = "active",
57 [IDH_PTYPE_VPD] = "vpd",
60 static struct usb_pd_identity *get_pd_identity(struct device *dev)
62 if (is_typec_partner(dev)) {
63 struct typec_partner *partner = to_typec_partner(dev);
65 return partner->identity;
66 } else if (is_typec_cable(dev)) {
67 struct typec_cable *cable = to_typec_cable(dev);
69 return cable->identity;
74 static const char *get_pd_product_type(struct device *dev)
76 struct typec_port *port = to_typec_port(dev->parent);
77 struct usb_pd_identity *id = get_pd_identity(dev);
78 const char *ptype = NULL;
80 if (is_typec_partner(dev)) {
84 if (port->data_role == TYPEC_HOST)
85 ptype = product_type_ufp[PD_IDH_PTYPE(id->id_header)];
87 ptype = product_type_dfp[PD_IDH_DFP_PTYPE(id->id_header)];
88 } else if (is_typec_cable(dev)) {
90 ptype = product_type_cable[PD_IDH_PTYPE(id->id_header)];
92 ptype = to_typec_cable(dev)->active ?
93 product_type_cable[IDH_PTYPE_ACABLE] :
94 product_type_cable[IDH_PTYPE_PCABLE];
100 static ssize_t id_header_show(struct device *dev, struct device_attribute *attr,
103 struct usb_pd_identity *id = get_pd_identity(dev);
105 return sprintf(buf, "0x%08x\n", id->id_header);
107 static DEVICE_ATTR_RO(id_header);
109 static ssize_t cert_stat_show(struct device *dev, struct device_attribute *attr,
112 struct usb_pd_identity *id = get_pd_identity(dev);
114 return sprintf(buf, "0x%08x\n", id->cert_stat);
116 static DEVICE_ATTR_RO(cert_stat);
118 static ssize_t product_show(struct device *dev, struct device_attribute *attr,
121 struct usb_pd_identity *id = get_pd_identity(dev);
123 return sprintf(buf, "0x%08x\n", id->product);
125 static DEVICE_ATTR_RO(product);
127 static ssize_t product_type_vdo1_show(struct device *dev, struct device_attribute *attr,
130 struct usb_pd_identity *id = get_pd_identity(dev);
132 return sysfs_emit(buf, "0x%08x\n", id->vdo[0]);
134 static DEVICE_ATTR_RO(product_type_vdo1);
136 static ssize_t product_type_vdo2_show(struct device *dev, struct device_attribute *attr,
139 struct usb_pd_identity *id = get_pd_identity(dev);
141 return sysfs_emit(buf, "0x%08x\n", id->vdo[1]);
143 static DEVICE_ATTR_RO(product_type_vdo2);
145 static ssize_t product_type_vdo3_show(struct device *dev, struct device_attribute *attr,
148 struct usb_pd_identity *id = get_pd_identity(dev);
150 return sysfs_emit(buf, "0x%08x\n", id->vdo[2]);
152 static DEVICE_ATTR_RO(product_type_vdo3);
154 static struct attribute *usb_pd_id_attrs[] = {
155 &dev_attr_id_header.attr,
156 &dev_attr_cert_stat.attr,
157 &dev_attr_product.attr,
158 &dev_attr_product_type_vdo1.attr,
159 &dev_attr_product_type_vdo2.attr,
160 &dev_attr_product_type_vdo3.attr,
164 static const struct attribute_group usb_pd_id_group = {
166 .attrs = usb_pd_id_attrs,
169 static const struct attribute_group *usb_pd_id_groups[] = {
174 static void typec_product_type_notify(struct device *dev)
179 ptype = get_pd_product_type(dev);
183 sysfs_notify(&dev->kobj, NULL, "type");
185 envp[0] = kasprintf(GFP_KERNEL, "PRODUCT_TYPE=%s", ptype);
189 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
193 static void typec_report_identity(struct device *dev)
195 sysfs_notify(&dev->kobj, "identity", "id_header");
196 sysfs_notify(&dev->kobj, "identity", "cert_stat");
197 sysfs_notify(&dev->kobj, "identity", "product");
198 sysfs_notify(&dev->kobj, "identity", "product_type_vdo1");
199 sysfs_notify(&dev->kobj, "identity", "product_type_vdo2");
200 sysfs_notify(&dev->kobj, "identity", "product_type_vdo3");
201 typec_product_type_notify(dev);
205 type_show(struct device *dev, struct device_attribute *attr, char *buf)
209 ptype = get_pd_product_type(dev);
213 return sysfs_emit(buf, "%s\n", ptype);
215 static DEVICE_ATTR_RO(type);
217 static ssize_t usb_power_delivery_revision_show(struct device *dev,
218 struct device_attribute *attr,
220 static DEVICE_ATTR_RO(usb_power_delivery_revision);
222 /* ------------------------------------------------------------------------- */
223 /* Alternate Modes */
225 static int altmode_match(struct device *dev, void *data)
227 struct typec_altmode *adev = to_typec_altmode(dev);
228 struct typec_device_id *id = data;
230 if (!is_typec_altmode(dev))
233 return ((adev->svid == id->svid) && (adev->mode == id->mode));
236 static void typec_altmode_set_partner(struct altmode *altmode)
238 struct typec_altmode *adev = &altmode->adev;
239 struct typec_device_id id = { adev->svid, adev->mode, };
240 struct typec_port *port = typec_altmode2port(adev);
241 struct altmode *partner;
244 dev = device_find_child(&port->dev, &id, altmode_match);
248 /* Bind the port alt mode to the partner/plug alt mode. */
249 partner = to_altmode(to_typec_altmode(dev));
250 altmode->partner = partner;
252 /* Bind the partner/plug alt mode to the port alt mode. */
253 if (is_typec_plug(adev->dev.parent)) {
254 struct typec_plug *plug = to_typec_plug(adev->dev.parent);
256 partner->plug[plug->index] = altmode;
258 partner->partner = altmode;
262 static void typec_altmode_put_partner(struct altmode *altmode)
264 struct altmode *partner = altmode->partner;
265 struct typec_altmode *adev;
266 struct typec_altmode *partner_adev;
271 adev = &altmode->adev;
272 partner_adev = &partner->adev;
274 if (is_typec_plug(adev->dev.parent)) {
275 struct typec_plug *plug = to_typec_plug(adev->dev.parent);
277 partner->plug[plug->index] = NULL;
279 partner->partner = NULL;
281 put_device(&partner_adev->dev);
285 * typec_altmode_update_active - Report Enter/Exit mode
286 * @adev: Handle to the alternate mode
287 * @active: True when the mode has been entered
289 * If a partner or cable plug executes Enter/Exit Mode command successfully, the
290 * drivers use this routine to report the updated state of the mode.
292 void typec_altmode_update_active(struct typec_altmode *adev, bool active)
296 if (adev->active == active)
299 if (!is_typec_port(adev->dev.parent) && adev->dev.driver) {
301 module_put(adev->dev.driver->owner);
303 WARN_ON(!try_module_get(adev->dev.driver->owner));
306 adev->active = active;
307 snprintf(dir, sizeof(dir), "mode%d", adev->mode);
308 sysfs_notify(&adev->dev.kobj, dir, "active");
309 sysfs_notify(&adev->dev.kobj, NULL, "active");
310 kobject_uevent(&adev->dev.kobj, KOBJ_CHANGE);
312 EXPORT_SYMBOL_GPL(typec_altmode_update_active);
315 * typec_altmode2port - Alternate Mode to USB Type-C port
316 * @alt: The Alternate Mode
318 * Returns handle to the port that a cable plug or partner with @alt is
321 struct typec_port *typec_altmode2port(struct typec_altmode *alt)
323 if (is_typec_plug(alt->dev.parent))
324 return to_typec_port(alt->dev.parent->parent->parent);
325 if (is_typec_partner(alt->dev.parent))
326 return to_typec_port(alt->dev.parent->parent);
327 if (is_typec_port(alt->dev.parent))
328 return to_typec_port(alt->dev.parent);
332 EXPORT_SYMBOL_GPL(typec_altmode2port);
335 vdo_show(struct device *dev, struct device_attribute *attr, char *buf)
337 struct typec_altmode *alt = to_typec_altmode(dev);
339 return sprintf(buf, "0x%08x\n", alt->vdo);
341 static DEVICE_ATTR_RO(vdo);
344 description_show(struct device *dev, struct device_attribute *attr, char *buf)
346 struct typec_altmode *alt = to_typec_altmode(dev);
348 return sprintf(buf, "%s\n", alt->desc ? alt->desc : "");
350 static DEVICE_ATTR_RO(description);
353 active_show(struct device *dev, struct device_attribute *attr, char *buf)
355 struct typec_altmode *alt = to_typec_altmode(dev);
357 return sprintf(buf, "%s\n", alt->active ? "yes" : "no");
360 static ssize_t active_store(struct device *dev, struct device_attribute *attr,
361 const char *buf, size_t size)
363 struct typec_altmode *adev = to_typec_altmode(dev);
364 struct altmode *altmode = to_altmode(adev);
368 ret = kstrtobool(buf, &enter);
372 if (adev->active == enter)
375 if (is_typec_port(adev->dev.parent)) {
376 typec_altmode_update_active(adev, enter);
378 /* Make sure that the partner exits the mode before disabling */
379 if (altmode->partner && !enter && altmode->partner->adev.active)
380 typec_altmode_exit(&altmode->partner->adev);
381 } else if (altmode->partner) {
382 if (enter && !altmode->partner->adev.active) {
383 dev_warn(dev, "port has the mode disabled\n");
388 /* Note: If there is no driver, the mode will not be entered */
389 if (adev->ops && adev->ops->activate) {
390 ret = adev->ops->activate(adev, enter);
397 static DEVICE_ATTR_RW(active);
400 supported_roles_show(struct device *dev, struct device_attribute *attr,
403 struct altmode *alt = to_altmode(to_typec_altmode(dev));
406 switch (alt->roles) {
408 ret = sprintf(buf, "source\n");
411 ret = sprintf(buf, "sink\n");
415 ret = sprintf(buf, "source sink\n");
420 static DEVICE_ATTR_RO(supported_roles);
423 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
425 struct typec_altmode *adev = to_typec_altmode(dev);
427 return sprintf(buf, "%u\n", adev->mode);
429 static DEVICE_ATTR_RO(mode);
432 svid_show(struct device *dev, struct device_attribute *attr, char *buf)
434 struct typec_altmode *adev = to_typec_altmode(dev);
436 return sprintf(buf, "%04x\n", adev->svid);
438 static DEVICE_ATTR_RO(svid);
440 static struct attribute *typec_altmode_attrs[] = {
441 &dev_attr_active.attr,
448 static umode_t typec_altmode_attr_is_visible(struct kobject *kobj,
449 struct attribute *attr, int n)
451 struct typec_altmode *adev = to_typec_altmode(kobj_to_dev(kobj));
453 if (attr == &dev_attr_active.attr)
454 if (!adev->ops || !adev->ops->activate)
460 static const struct attribute_group typec_altmode_group = {
461 .is_visible = typec_altmode_attr_is_visible,
462 .attrs = typec_altmode_attrs,
465 static const struct attribute_group *typec_altmode_groups[] = {
466 &typec_altmode_group,
471 * typec_altmode_set_ops - Set ops for altmode
472 * @adev: Handle to the alternate mode
473 * @ops: Ops for the alternate mode
475 * After setting ops, attribute visiblity needs to be refreshed if the alternate
476 * mode can be activated.
478 void typec_altmode_set_ops(struct typec_altmode *adev,
479 const struct typec_altmode_ops *ops)
482 sysfs_update_group(&adev->dev.kobj, &typec_altmode_group);
484 EXPORT_SYMBOL_GPL(typec_altmode_set_ops);
486 static int altmode_id_get(struct device *dev)
490 if (is_typec_partner(dev))
491 ids = &to_typec_partner(dev)->mode_ids;
492 else if (is_typec_plug(dev))
493 ids = &to_typec_plug(dev)->mode_ids;
495 ids = &to_typec_port(dev)->mode_ids;
497 return ida_alloc(ids, GFP_KERNEL);
500 static void altmode_id_remove(struct device *dev, int id)
504 if (is_typec_partner(dev))
505 ids = &to_typec_partner(dev)->mode_ids;
506 else if (is_typec_plug(dev))
507 ids = &to_typec_plug(dev)->mode_ids;
509 ids = &to_typec_port(dev)->mode_ids;
514 static void typec_altmode_release(struct device *dev)
516 struct altmode *alt = to_altmode(to_typec_altmode(dev));
518 if (!is_typec_port(dev->parent))
519 typec_altmode_put_partner(alt);
521 altmode_id_remove(alt->adev.dev.parent, alt->id);
525 const struct device_type typec_altmode_dev_type = {
526 .name = "typec_alternate_mode",
527 .groups = typec_altmode_groups,
528 .release = typec_altmode_release,
531 static struct typec_altmode *
532 typec_register_altmode(struct device *parent,
533 const struct typec_altmode_desc *desc)
535 unsigned int id = altmode_id_get(parent);
536 bool is_port = is_typec_port(parent);
540 alt = kzalloc(sizeof(*alt), GFP_KERNEL);
542 altmode_id_remove(parent, id);
543 return ERR_PTR(-ENOMEM);
546 alt->adev.svid = desc->svid;
547 alt->adev.mode = desc->mode;
548 alt->adev.vdo = desc->vdo;
549 alt->roles = desc->roles;
552 alt->attrs[0] = &dev_attr_vdo.attr;
553 alt->attrs[1] = &dev_attr_description.attr;
554 alt->attrs[2] = &dev_attr_active.attr;
557 alt->attrs[3] = &dev_attr_supported_roles.attr;
558 alt->adev.active = true; /* Enabled by default */
561 sprintf(alt->group_name, "mode%d", desc->mode);
562 alt->group.name = alt->group_name;
563 alt->group.attrs = alt->attrs;
564 alt->groups[0] = &alt->group;
566 alt->adev.dev.parent = parent;
567 alt->adev.dev.groups = alt->groups;
568 alt->adev.dev.type = &typec_altmode_dev_type;
569 dev_set_name(&alt->adev.dev, "%s.%u", dev_name(parent), id);
571 /* Link partners and plugs with the ports */
573 typec_altmode_set_partner(alt);
575 /* The partners are bind to drivers */
576 if (is_typec_partner(parent))
577 alt->adev.dev.bus = &typec_bus;
579 /* Plug alt modes need a class to generate udev events. */
580 if (is_typec_plug(parent))
581 alt->adev.dev.class = &typec_class;
583 ret = device_register(&alt->adev.dev);
585 dev_err(parent, "failed to register alternate mode (%d)\n",
587 put_device(&alt->adev.dev);
595 * typec_unregister_altmode - Unregister Alternate Mode
596 * @adev: The alternate mode to be unregistered
598 * Unregister device created with typec_partner_register_altmode(),
599 * typec_plug_register_altmode() or typec_port_register_altmode().
601 void typec_unregister_altmode(struct typec_altmode *adev)
603 if (IS_ERR_OR_NULL(adev))
605 typec_retimer_put(to_altmode(adev)->retimer);
606 typec_mux_put(to_altmode(adev)->mux);
607 device_unregister(&adev->dev);
609 EXPORT_SYMBOL_GPL(typec_unregister_altmode);
611 /* ------------------------------------------------------------------------- */
612 /* Type-C Partners */
614 static ssize_t accessory_mode_show(struct device *dev,
615 struct device_attribute *attr,
618 struct typec_partner *p = to_typec_partner(dev);
620 return sprintf(buf, "%s\n", typec_accessory_modes[p->accessory]);
622 static DEVICE_ATTR_RO(accessory_mode);
624 static ssize_t supports_usb_power_delivery_show(struct device *dev,
625 struct device_attribute *attr,
628 struct typec_partner *p = to_typec_partner(dev);
630 return sprintf(buf, "%s\n", p->usb_pd ? "yes" : "no");
632 static DEVICE_ATTR_RO(supports_usb_power_delivery);
634 static ssize_t number_of_alternate_modes_show(struct device *dev, struct device_attribute *attr,
637 struct typec_partner *partner;
638 struct typec_plug *plug;
641 if (is_typec_partner(dev)) {
642 partner = to_typec_partner(dev);
643 num_altmodes = partner->num_altmodes;
644 } else if (is_typec_plug(dev)) {
645 plug = to_typec_plug(dev);
646 num_altmodes = plug->num_altmodes;
651 return sysfs_emit(buf, "%d\n", num_altmodes);
653 static DEVICE_ATTR_RO(number_of_alternate_modes);
655 static struct attribute *typec_partner_attrs[] = {
656 &dev_attr_accessory_mode.attr,
657 &dev_attr_supports_usb_power_delivery.attr,
658 &dev_attr_number_of_alternate_modes.attr,
660 &dev_attr_usb_power_delivery_revision.attr,
664 static umode_t typec_partner_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
666 struct typec_partner *partner = to_typec_partner(kobj_to_dev(kobj));
668 if (attr == &dev_attr_number_of_alternate_modes.attr) {
669 if (partner->num_altmodes < 0)
673 if (attr == &dev_attr_type.attr)
674 if (!get_pd_product_type(kobj_to_dev(kobj)))
680 static const struct attribute_group typec_partner_group = {
681 .is_visible = typec_partner_attr_is_visible,
682 .attrs = typec_partner_attrs
685 static const struct attribute_group *typec_partner_groups[] = {
686 &typec_partner_group,
690 static void typec_partner_release(struct device *dev)
692 struct typec_partner *partner = to_typec_partner(dev);
694 ida_destroy(&partner->mode_ids);
698 const struct device_type typec_partner_dev_type = {
699 .name = "typec_partner",
700 .groups = typec_partner_groups,
701 .release = typec_partner_release,
704 static void typec_partner_link_device(struct typec_partner *partner, struct device *dev)
708 ret = sysfs_create_link(&dev->kobj, &partner->dev.kobj, "typec");
712 ret = sysfs_create_link(&partner->dev.kobj, &dev->kobj, dev_name(dev));
714 sysfs_remove_link(&dev->kobj, "typec");
719 partner->attach(partner, dev);
722 static void typec_partner_unlink_device(struct typec_partner *partner, struct device *dev)
724 sysfs_remove_link(&partner->dev.kobj, dev_name(dev));
725 sysfs_remove_link(&dev->kobj, "typec");
727 if (partner->deattach)
728 partner->deattach(partner, dev);
732 * typec_partner_set_identity - Report result from Discover Identity command
733 * @partner: The partner updated identity values
735 * This routine is used to report that the result of Discover Identity USB power
736 * delivery command has become available.
738 int typec_partner_set_identity(struct typec_partner *partner)
740 if (!partner->identity)
743 typec_report_identity(&partner->dev);
746 EXPORT_SYMBOL_GPL(typec_partner_set_identity);
749 * typec_partner_set_pd_revision - Set the PD revision supported by the partner
750 * @partner: The partner to be updated.
751 * @pd_revision: USB Power Delivery Specification Revision supported by partner
753 * This routine is used to report that the PD revision of the port partner has
756 void typec_partner_set_pd_revision(struct typec_partner *partner, u16 pd_revision)
758 if (partner->pd_revision == pd_revision)
761 partner->pd_revision = pd_revision;
762 sysfs_notify(&partner->dev.kobj, NULL, "usb_power_delivery_revision");
763 if (pd_revision != 0 && !partner->usb_pd) {
765 sysfs_notify(&partner->dev.kobj, NULL,
766 "supports_usb_power_delivery");
768 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
770 EXPORT_SYMBOL_GPL(typec_partner_set_pd_revision);
773 * typec_partner_set_usb_power_delivery - Declare USB Power Delivery Contract.
774 * @partner: The partner device.
775 * @pd: The USB PD instance.
777 * This routine can be used to declare USB Power Delivery Contract with @partner
778 * by linking @partner to @pd which contains the objects that were used during the
779 * negotiation of the contract.
781 * If @pd is NULL, the link is removed and the contract with @partner has ended.
783 int typec_partner_set_usb_power_delivery(struct typec_partner *partner,
784 struct usb_power_delivery *pd)
788 if (IS_ERR_OR_NULL(partner) || partner->pd == pd)
792 ret = usb_power_delivery_link_device(pd, &partner->dev);
796 usb_power_delivery_unlink_device(partner->pd, &partner->dev);
803 EXPORT_SYMBOL_GPL(typec_partner_set_usb_power_delivery);
806 * typec_partner_set_num_altmodes - Set the number of available partner altmodes
807 * @partner: The partner to be updated.
808 * @num_altmodes: The number of altmodes we want to specify as available.
810 * This routine is used to report the number of alternate modes supported by the
811 * partner. This value is *not* enforced in alternate mode registration routines.
813 * @partner.num_altmodes is set to -1 on partner registration, denoting that
814 * a valid value has not been set for it yet.
816 * Returns 0 on success or negative error number on failure.
818 int typec_partner_set_num_altmodes(struct typec_partner *partner, int num_altmodes)
822 if (num_altmodes < 0)
825 partner->num_altmodes = num_altmodes;
826 ret = sysfs_update_group(&partner->dev.kobj, &typec_partner_group);
830 sysfs_notify(&partner->dev.kobj, NULL, "number_of_alternate_modes");
831 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
835 EXPORT_SYMBOL_GPL(typec_partner_set_num_altmodes);
838 * typec_partner_register_altmode - Register USB Type-C Partner Alternate Mode
839 * @partner: USB Type-C Partner that supports the alternate mode
840 * @desc: Description of the alternate mode
842 * This routine is used to register each alternate mode individually that
843 * @partner has listed in response to Discover SVIDs command. The modes for a
844 * SVID listed in response to Discover Modes command need to be listed in an
847 * Returns handle to the alternate mode on success or ERR_PTR on failure.
849 struct typec_altmode *
850 typec_partner_register_altmode(struct typec_partner *partner,
851 const struct typec_altmode_desc *desc)
853 return typec_register_altmode(&partner->dev, desc);
855 EXPORT_SYMBOL_GPL(typec_partner_register_altmode);
858 * typec_partner_set_svdm_version - Set negotiated Structured VDM (SVDM) Version
859 * @partner: USB Type-C Partner that supports SVDM
860 * @svdm_version: Negotiated SVDM Version
862 * This routine is used to save the negotiated SVDM Version.
864 void typec_partner_set_svdm_version(struct typec_partner *partner,
865 enum usb_pd_svdm_ver svdm_version)
867 partner->svdm_version = svdm_version;
869 EXPORT_SYMBOL_GPL(typec_partner_set_svdm_version);
872 * typec_partner_usb_power_delivery_register - Register Type-C partner USB Power Delivery Support
873 * @partner: Type-C partner device.
874 * @desc: Description of the USB PD contract.
876 * This routine is a wrapper around usb_power_delivery_register(). It registers
877 * USB Power Delivery Capabilities for a Type-C partner device. Specifically,
878 * it sets the Type-C partner device as a parent for the resulting USB Power Delivery object.
880 * Returns handle to struct usb_power_delivery or ERR_PTR.
882 struct usb_power_delivery *
883 typec_partner_usb_power_delivery_register(struct typec_partner *partner,
884 struct usb_power_delivery_desc *desc)
886 return usb_power_delivery_register(&partner->dev, desc);
888 EXPORT_SYMBOL_GPL(typec_partner_usb_power_delivery_register);
891 * typec_register_partner - Register a USB Type-C Partner
892 * @port: The USB Type-C Port the partner is connected to
893 * @desc: Description of the partner
895 * Registers a device for USB Type-C Partner described in @desc.
897 * Returns handle to the partner on success or ERR_PTR on failure.
899 struct typec_partner *typec_register_partner(struct typec_port *port,
900 struct typec_partner_desc *desc)
902 struct typec_partner *partner;
905 partner = kzalloc(sizeof(*partner), GFP_KERNEL);
907 return ERR_PTR(-ENOMEM);
909 ida_init(&partner->mode_ids);
910 partner->usb_pd = desc->usb_pd;
911 partner->accessory = desc->accessory;
912 partner->num_altmodes = -1;
913 partner->pd_revision = desc->pd_revision;
914 partner->svdm_version = port->cap->svdm_version;
915 partner->attach = desc->attach;
916 partner->deattach = desc->deattach;
918 if (desc->identity) {
920 * Creating directory for the identity only if the driver is
921 * able to provide data to it.
923 partner->dev.groups = usb_pd_id_groups;
924 partner->identity = desc->identity;
927 partner->dev.class = &typec_class;
928 partner->dev.parent = &port->dev;
929 partner->dev.type = &typec_partner_dev_type;
930 dev_set_name(&partner->dev, "%s-partner", dev_name(&port->dev));
932 ret = device_register(&partner->dev);
934 dev_err(&port->dev, "failed to register partner (%d)\n", ret);
935 put_device(&partner->dev);
940 typec_partner_link_device(partner, port->usb2_dev);
942 typec_partner_link_device(partner, port->usb3_dev);
946 EXPORT_SYMBOL_GPL(typec_register_partner);
949 * typec_unregister_partner - Unregister a USB Type-C Partner
950 * @partner: The partner to be unregistered
952 * Unregister device created with typec_register_partner().
954 void typec_unregister_partner(struct typec_partner *partner)
956 struct typec_port *port;
958 if (IS_ERR_OR_NULL(partner))
961 port = to_typec_port(partner->dev.parent);
964 typec_partner_unlink_device(partner, port->usb2_dev);
966 typec_partner_unlink_device(partner, port->usb3_dev);
968 device_unregister(&partner->dev);
970 EXPORT_SYMBOL_GPL(typec_unregister_partner);
972 /* ------------------------------------------------------------------------- */
973 /* Type-C Cable Plugs */
975 static void typec_plug_release(struct device *dev)
977 struct typec_plug *plug = to_typec_plug(dev);
979 ida_destroy(&plug->mode_ids);
983 static struct attribute *typec_plug_attrs[] = {
984 &dev_attr_number_of_alternate_modes.attr,
988 static umode_t typec_plug_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
990 struct typec_plug *plug = to_typec_plug(kobj_to_dev(kobj));
992 if (attr == &dev_attr_number_of_alternate_modes.attr) {
993 if (plug->num_altmodes < 0)
1000 static const struct attribute_group typec_plug_group = {
1001 .is_visible = typec_plug_attr_is_visible,
1002 .attrs = typec_plug_attrs
1005 static const struct attribute_group *typec_plug_groups[] = {
1010 const struct device_type typec_plug_dev_type = {
1011 .name = "typec_plug",
1012 .groups = typec_plug_groups,
1013 .release = typec_plug_release,
1017 * typec_plug_set_num_altmodes - Set the number of available plug altmodes
1018 * @plug: The plug to be updated.
1019 * @num_altmodes: The number of altmodes we want to specify as available.
1021 * This routine is used to report the number of alternate modes supported by the
1022 * plug. This value is *not* enforced in alternate mode registration routines.
1024 * @plug.num_altmodes is set to -1 on plug registration, denoting that
1025 * a valid value has not been set for it yet.
1027 * Returns 0 on success or negative error number on failure.
1029 int typec_plug_set_num_altmodes(struct typec_plug *plug, int num_altmodes)
1033 if (num_altmodes < 0)
1036 plug->num_altmodes = num_altmodes;
1037 ret = sysfs_update_group(&plug->dev.kobj, &typec_plug_group);
1041 sysfs_notify(&plug->dev.kobj, NULL, "number_of_alternate_modes");
1042 kobject_uevent(&plug->dev.kobj, KOBJ_CHANGE);
1046 EXPORT_SYMBOL_GPL(typec_plug_set_num_altmodes);
1049 * typec_plug_register_altmode - Register USB Type-C Cable Plug Alternate Mode
1050 * @plug: USB Type-C Cable Plug that supports the alternate mode
1051 * @desc: Description of the alternate mode
1053 * This routine is used to register each alternate mode individually that @plug
1054 * has listed in response to Discover SVIDs command. The modes for a SVID that
1055 * the plug lists in response to Discover Modes command need to be listed in an
1058 * Returns handle to the alternate mode on success or ERR_PTR on failure.
1060 struct typec_altmode *
1061 typec_plug_register_altmode(struct typec_plug *plug,
1062 const struct typec_altmode_desc *desc)
1064 return typec_register_altmode(&plug->dev, desc);
1066 EXPORT_SYMBOL_GPL(typec_plug_register_altmode);
1069 * typec_register_plug - Register a USB Type-C Cable Plug
1070 * @cable: USB Type-C Cable with the plug
1071 * @desc: Description of the cable plug
1073 * Registers a device for USB Type-C Cable Plug described in @desc. A USB Type-C
1074 * Cable Plug represents a plug with electronics in it that can response to USB
1075 * Power Delivery SOP Prime or SOP Double Prime packages.
1077 * Returns handle to the cable plug on success or ERR_PTR on failure.
1079 struct typec_plug *typec_register_plug(struct typec_cable *cable,
1080 struct typec_plug_desc *desc)
1082 struct typec_plug *plug;
1086 plug = kzalloc(sizeof(*plug), GFP_KERNEL);
1088 return ERR_PTR(-ENOMEM);
1090 sprintf(name, "plug%d", desc->index);
1092 ida_init(&plug->mode_ids);
1093 plug->num_altmodes = -1;
1094 plug->index = desc->index;
1095 plug->dev.class = &typec_class;
1096 plug->dev.parent = &cable->dev;
1097 plug->dev.type = &typec_plug_dev_type;
1098 dev_set_name(&plug->dev, "%s-%s", dev_name(cable->dev.parent), name);
1100 ret = device_register(&plug->dev);
1102 dev_err(&cable->dev, "failed to register plug (%d)\n", ret);
1103 put_device(&plug->dev);
1104 return ERR_PTR(ret);
1109 EXPORT_SYMBOL_GPL(typec_register_plug);
1112 * typec_unregister_plug - Unregister a USB Type-C Cable Plug
1113 * @plug: The cable plug to be unregistered
1115 * Unregister device created with typec_register_plug().
1117 void typec_unregister_plug(struct typec_plug *plug)
1119 if (!IS_ERR_OR_NULL(plug))
1120 device_unregister(&plug->dev);
1122 EXPORT_SYMBOL_GPL(typec_unregister_plug);
1126 static const char * const typec_plug_types[] = {
1127 [USB_PLUG_NONE] = "unknown",
1128 [USB_PLUG_TYPE_A] = "type-a",
1129 [USB_PLUG_TYPE_B] = "type-b",
1130 [USB_PLUG_TYPE_C] = "type-c",
1131 [USB_PLUG_CAPTIVE] = "captive",
1134 static ssize_t plug_type_show(struct device *dev,
1135 struct device_attribute *attr, char *buf)
1137 struct typec_cable *cable = to_typec_cable(dev);
1139 return sprintf(buf, "%s\n", typec_plug_types[cable->type]);
1141 static DEVICE_ATTR_RO(plug_type);
1143 static struct attribute *typec_cable_attrs[] = {
1144 &dev_attr_type.attr,
1145 &dev_attr_plug_type.attr,
1146 &dev_attr_usb_power_delivery_revision.attr,
1149 ATTRIBUTE_GROUPS(typec_cable);
1151 static void typec_cable_release(struct device *dev)
1153 struct typec_cable *cable = to_typec_cable(dev);
1158 const struct device_type typec_cable_dev_type = {
1159 .name = "typec_cable",
1160 .groups = typec_cable_groups,
1161 .release = typec_cable_release,
1164 static int cable_match(struct device *dev, void *data)
1166 return is_typec_cable(dev);
1170 * typec_cable_get - Get a reference to the USB Type-C cable
1171 * @port: The USB Type-C Port the cable is connected to
1173 * The caller must decrement the reference count with typec_cable_put() after
1176 struct typec_cable *typec_cable_get(struct typec_port *port)
1180 dev = device_find_child(&port->dev, NULL, cable_match);
1184 return to_typec_cable(dev);
1186 EXPORT_SYMBOL_GPL(typec_cable_get);
1189 * typec_cable_put - Decrement the reference count on USB Type-C cable
1190 * @cable: The USB Type-C cable
1192 void typec_cable_put(struct typec_cable *cable)
1194 put_device(&cable->dev);
1196 EXPORT_SYMBOL_GPL(typec_cable_put);
1199 * typec_cable_is_active - Check is the USB Type-C cable active or passive
1200 * @cable: The USB Type-C Cable
1202 * Return 1 if the cable is active or 0 if it's passive.
1204 int typec_cable_is_active(struct typec_cable *cable)
1206 return cable->active;
1208 EXPORT_SYMBOL_GPL(typec_cable_is_active);
1211 * typec_cable_set_identity - Report result from Discover Identity command
1212 * @cable: The cable updated identity values
1214 * This routine is used to report that the result of Discover Identity USB power
1215 * delivery command has become available.
1217 int typec_cable_set_identity(struct typec_cable *cable)
1219 if (!cable->identity)
1222 typec_report_identity(&cable->dev);
1225 EXPORT_SYMBOL_GPL(typec_cable_set_identity);
1228 * typec_register_cable - Register a USB Type-C Cable
1229 * @port: The USB Type-C Port the cable is connected to
1230 * @desc: Description of the cable
1232 * Registers a device for USB Type-C Cable described in @desc. The cable will be
1233 * parent for the optional cable plug devises.
1235 * Returns handle to the cable on success or ERR_PTR on failure.
1237 struct typec_cable *typec_register_cable(struct typec_port *port,
1238 struct typec_cable_desc *desc)
1240 struct typec_cable *cable;
1243 cable = kzalloc(sizeof(*cable), GFP_KERNEL);
1245 return ERR_PTR(-ENOMEM);
1247 cable->type = desc->type;
1248 cable->active = desc->active;
1249 cable->pd_revision = desc->pd_revision;
1251 if (desc->identity) {
1253 * Creating directory for the identity only if the driver is
1254 * able to provide data to it.
1256 cable->dev.groups = usb_pd_id_groups;
1257 cable->identity = desc->identity;
1260 cable->dev.class = &typec_class;
1261 cable->dev.parent = &port->dev;
1262 cable->dev.type = &typec_cable_dev_type;
1263 dev_set_name(&cable->dev, "%s-cable", dev_name(&port->dev));
1265 ret = device_register(&cable->dev);
1267 dev_err(&port->dev, "failed to register cable (%d)\n", ret);
1268 put_device(&cable->dev);
1269 return ERR_PTR(ret);
1274 EXPORT_SYMBOL_GPL(typec_register_cable);
1277 * typec_unregister_cable - Unregister a USB Type-C Cable
1278 * @cable: The cable to be unregistered
1280 * Unregister device created with typec_register_cable().
1282 void typec_unregister_cable(struct typec_cable *cable)
1284 if (!IS_ERR_OR_NULL(cable))
1285 device_unregister(&cable->dev);
1287 EXPORT_SYMBOL_GPL(typec_unregister_cable);
1289 /* ------------------------------------------------------------------------- */
1290 /* USB Type-C ports */
1293 * typec_port_set_usb_power_delivery - Assign USB PD for port.
1294 * @port: USB Type-C port.
1295 * @pd: USB PD instance.
1297 * This routine can be used to set the USB Power Delivery Capabilities for @port
1298 * that it will advertise to the partner.
1300 * If @pd is NULL, the assignment is removed.
1302 int typec_port_set_usb_power_delivery(struct typec_port *port, struct usb_power_delivery *pd)
1306 if (IS_ERR_OR_NULL(port) || port->pd == pd)
1310 ret = usb_power_delivery_link_device(pd, &port->dev);
1314 usb_power_delivery_unlink_device(port->pd, &port->dev);
1321 EXPORT_SYMBOL_GPL(typec_port_set_usb_power_delivery);
1323 static ssize_t select_usb_power_delivery_store(struct device *dev,
1324 struct device_attribute *attr,
1325 const char *buf, size_t size)
1327 struct typec_port *port = to_typec_port(dev);
1328 struct usb_power_delivery *pd;
1331 if (!port->ops || !port->ops->pd_set)
1334 pd = usb_power_delivery_find(buf);
1338 ret = port->ops->pd_set(port, pd);
1345 static ssize_t select_usb_power_delivery_show(struct device *dev,
1346 struct device_attribute *attr, char *buf)
1348 struct typec_port *port = to_typec_port(dev);
1349 struct usb_power_delivery **pds;
1352 if (!port->ops || !port->ops->pd_get)
1355 pds = port->ops->pd_get(port);
1359 for (i = 0; pds[i]; i++) {
1360 if (pds[i] == port->pd)
1361 ret += sysfs_emit_at(buf, ret, "[%s] ", dev_name(&pds[i]->dev));
1363 ret += sysfs_emit_at(buf, ret, "%s ", dev_name(&pds[i]->dev));
1366 buf[ret - 1] = '\n';
1370 static DEVICE_ATTR_RW(select_usb_power_delivery);
1372 static struct attribute *port_attrs[] = {
1373 &dev_attr_select_usb_power_delivery.attr,
1377 static umode_t port_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
1379 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1381 if (!port->pd || !port->ops || !port->ops->pd_get)
1383 if (!port->ops->pd_set)
1389 static const struct attribute_group pd_group = {
1390 .is_visible = port_attr_is_visible,
1391 .attrs = port_attrs,
1394 static const char * const typec_orientations[] = {
1395 [TYPEC_ORIENTATION_NONE] = "unknown",
1396 [TYPEC_ORIENTATION_NORMAL] = "normal",
1397 [TYPEC_ORIENTATION_REVERSE] = "reverse",
1400 static const char * const typec_roles[] = {
1401 [TYPEC_SINK] = "sink",
1402 [TYPEC_SOURCE] = "source",
1405 static const char * const typec_data_roles[] = {
1406 [TYPEC_DEVICE] = "device",
1407 [TYPEC_HOST] = "host",
1410 static const char * const typec_port_power_roles[] = {
1411 [TYPEC_PORT_SRC] = "source",
1412 [TYPEC_PORT_SNK] = "sink",
1413 [TYPEC_PORT_DRP] = "dual",
1416 static const char * const typec_port_data_roles[] = {
1417 [TYPEC_PORT_DFP] = "host",
1418 [TYPEC_PORT_UFP] = "device",
1419 [TYPEC_PORT_DRD] = "dual",
1422 static const char * const typec_port_types_drp[] = {
1423 [TYPEC_PORT_SRC] = "dual [source] sink",
1424 [TYPEC_PORT_SNK] = "dual source [sink]",
1425 [TYPEC_PORT_DRP] = "[dual] source sink",
1429 preferred_role_store(struct device *dev, struct device_attribute *attr,
1430 const char *buf, size_t size)
1432 struct typec_port *port = to_typec_port(dev);
1436 if (port->cap->type != TYPEC_PORT_DRP) {
1437 dev_dbg(dev, "Preferred role only supported with DRP ports\n");
1441 if (!port->ops || !port->ops->try_role) {
1442 dev_dbg(dev, "Setting preferred role not supported\n");
1446 role = sysfs_match_string(typec_roles, buf);
1448 if (sysfs_streq(buf, "none"))
1449 role = TYPEC_NO_PREFERRED_ROLE;
1454 ret = port->ops->try_role(port, role);
1458 port->prefer_role = role;
1463 preferred_role_show(struct device *dev, struct device_attribute *attr,
1466 struct typec_port *port = to_typec_port(dev);
1468 if (port->cap->type != TYPEC_PORT_DRP)
1471 if (port->prefer_role < 0)
1474 return sprintf(buf, "%s\n", typec_roles[port->prefer_role]);
1476 static DEVICE_ATTR_RW(preferred_role);
1478 static ssize_t data_role_store(struct device *dev,
1479 struct device_attribute *attr,
1480 const char *buf, size_t size)
1482 struct typec_port *port = to_typec_port(dev);
1485 if (!port->ops || !port->ops->dr_set) {
1486 dev_dbg(dev, "data role swapping not supported\n");
1490 ret = sysfs_match_string(typec_data_roles, buf);
1494 mutex_lock(&port->port_type_lock);
1495 if (port->cap->data != TYPEC_PORT_DRD) {
1497 goto unlock_and_ret;
1500 ret = port->ops->dr_set(port, ret);
1502 goto unlock_and_ret;
1506 mutex_unlock(&port->port_type_lock);
1510 static ssize_t data_role_show(struct device *dev,
1511 struct device_attribute *attr, char *buf)
1513 struct typec_port *port = to_typec_port(dev);
1515 if (port->cap->data == TYPEC_PORT_DRD)
1516 return sprintf(buf, "%s\n", port->data_role == TYPEC_HOST ?
1517 "[host] device" : "host [device]");
1519 return sprintf(buf, "[%s]\n", typec_data_roles[port->data_role]);
1521 static DEVICE_ATTR_RW(data_role);
1523 static ssize_t power_role_store(struct device *dev,
1524 struct device_attribute *attr,
1525 const char *buf, size_t size)
1527 struct typec_port *port = to_typec_port(dev);
1530 if (!port->ops || !port->ops->pr_set) {
1531 dev_dbg(dev, "power role swapping not supported\n");
1535 if (port->pwr_opmode != TYPEC_PWR_MODE_PD) {
1536 dev_dbg(dev, "partner unable to swap power role\n");
1540 ret = sysfs_match_string(typec_roles, buf);
1544 mutex_lock(&port->port_type_lock);
1545 if (port->port_type != TYPEC_PORT_DRP) {
1546 dev_dbg(dev, "port type fixed at \"%s\"",
1547 typec_port_power_roles[port->port_type]);
1549 goto unlock_and_ret;
1552 ret = port->ops->pr_set(port, ret);
1554 goto unlock_and_ret;
1558 mutex_unlock(&port->port_type_lock);
1562 static ssize_t power_role_show(struct device *dev,
1563 struct device_attribute *attr, char *buf)
1565 struct typec_port *port = to_typec_port(dev);
1567 if (port->cap->type == TYPEC_PORT_DRP)
1568 return sprintf(buf, "%s\n", port->pwr_role == TYPEC_SOURCE ?
1569 "[source] sink" : "source [sink]");
1571 return sprintf(buf, "[%s]\n", typec_roles[port->pwr_role]);
1573 static DEVICE_ATTR_RW(power_role);
1576 port_type_store(struct device *dev, struct device_attribute *attr,
1577 const char *buf, size_t size)
1579 struct typec_port *port = to_typec_port(dev);
1581 enum typec_port_type type;
1583 if (port->cap->type != TYPEC_PORT_DRP ||
1584 !port->ops || !port->ops->port_type_set) {
1585 dev_dbg(dev, "changing port type not supported\n");
1589 ret = sysfs_match_string(typec_port_power_roles, buf);
1594 mutex_lock(&port->port_type_lock);
1596 if (port->port_type == type) {
1598 goto unlock_and_ret;
1601 ret = port->ops->port_type_set(port, type);
1603 goto unlock_and_ret;
1605 port->port_type = type;
1609 mutex_unlock(&port->port_type_lock);
1614 port_type_show(struct device *dev, struct device_attribute *attr,
1617 struct typec_port *port = to_typec_port(dev);
1619 if (port->cap->type == TYPEC_PORT_DRP)
1620 return sprintf(buf, "%s\n",
1621 typec_port_types_drp[port->port_type]);
1623 return sprintf(buf, "[%s]\n", typec_port_power_roles[port->cap->type]);
1625 static DEVICE_ATTR_RW(port_type);
1627 static const char * const typec_pwr_opmodes[] = {
1628 [TYPEC_PWR_MODE_USB] = "default",
1629 [TYPEC_PWR_MODE_1_5A] = "1.5A",
1630 [TYPEC_PWR_MODE_3_0A] = "3.0A",
1631 [TYPEC_PWR_MODE_PD] = "usb_power_delivery",
1634 static ssize_t power_operation_mode_show(struct device *dev,
1635 struct device_attribute *attr,
1638 struct typec_port *port = to_typec_port(dev);
1640 return sprintf(buf, "%s\n", typec_pwr_opmodes[port->pwr_opmode]);
1642 static DEVICE_ATTR_RO(power_operation_mode);
1644 static ssize_t vconn_source_store(struct device *dev,
1645 struct device_attribute *attr,
1646 const char *buf, size_t size)
1648 struct typec_port *port = to_typec_port(dev);
1652 if (!port->cap->pd_revision) {
1653 dev_dbg(dev, "VCONN swap depends on USB Power Delivery\n");
1657 if (!port->ops || !port->ops->vconn_set) {
1658 dev_dbg(dev, "VCONN swapping not supported\n");
1662 ret = kstrtobool(buf, &source);
1666 ret = port->ops->vconn_set(port, (enum typec_role)source);
1673 static ssize_t vconn_source_show(struct device *dev,
1674 struct device_attribute *attr, char *buf)
1676 struct typec_port *port = to_typec_port(dev);
1678 return sprintf(buf, "%s\n",
1679 port->vconn_role == TYPEC_SOURCE ? "yes" : "no");
1681 static DEVICE_ATTR_RW(vconn_source);
1683 static ssize_t supported_accessory_modes_show(struct device *dev,
1684 struct device_attribute *attr,
1687 struct typec_port *port = to_typec_port(dev);
1691 for (i = 0; i < ARRAY_SIZE(port->cap->accessory); i++) {
1692 if (port->cap->accessory[i])
1693 ret += sprintf(buf + ret, "%s ",
1694 typec_accessory_modes[port->cap->accessory[i]]);
1698 return sprintf(buf, "none\n");
1700 buf[ret - 1] = '\n';
1704 static DEVICE_ATTR_RO(supported_accessory_modes);
1706 static ssize_t usb_typec_revision_show(struct device *dev,
1707 struct device_attribute *attr,
1710 struct typec_port *port = to_typec_port(dev);
1711 u16 rev = port->cap->revision;
1713 return sprintf(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1715 static DEVICE_ATTR_RO(usb_typec_revision);
1717 static ssize_t usb_power_delivery_revision_show(struct device *dev,
1718 struct device_attribute *attr,
1723 if (is_typec_partner(dev)) {
1724 struct typec_partner *partner = to_typec_partner(dev);
1726 rev = partner->pd_revision;
1727 } else if (is_typec_cable(dev)) {
1728 struct typec_cable *cable = to_typec_cable(dev);
1730 rev = cable->pd_revision;
1731 } else if (is_typec_port(dev)) {
1732 struct typec_port *p = to_typec_port(dev);
1734 rev = p->cap->pd_revision;
1736 return sysfs_emit(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1739 static ssize_t orientation_show(struct device *dev,
1740 struct device_attribute *attr,
1743 struct typec_port *port = to_typec_port(dev);
1745 return sprintf(buf, "%s\n", typec_orientations[port->orientation]);
1747 static DEVICE_ATTR_RO(orientation);
1749 static struct attribute *typec_attrs[] = {
1750 &dev_attr_data_role.attr,
1751 &dev_attr_power_operation_mode.attr,
1752 &dev_attr_power_role.attr,
1753 &dev_attr_preferred_role.attr,
1754 &dev_attr_supported_accessory_modes.attr,
1755 &dev_attr_usb_power_delivery_revision.attr,
1756 &dev_attr_usb_typec_revision.attr,
1757 &dev_attr_vconn_source.attr,
1758 &dev_attr_port_type.attr,
1759 &dev_attr_orientation.attr,
1763 static umode_t typec_attr_is_visible(struct kobject *kobj,
1764 struct attribute *attr, int n)
1766 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1768 if (attr == &dev_attr_data_role.attr) {
1769 if (port->cap->data != TYPEC_PORT_DRD ||
1770 !port->ops || !port->ops->dr_set)
1772 } else if (attr == &dev_attr_power_role.attr) {
1773 if (port->cap->type != TYPEC_PORT_DRP ||
1774 !port->ops || !port->ops->pr_set)
1776 } else if (attr == &dev_attr_vconn_source.attr) {
1777 if (!port->cap->pd_revision ||
1778 !port->ops || !port->ops->vconn_set)
1780 } else if (attr == &dev_attr_preferred_role.attr) {
1781 if (port->cap->type != TYPEC_PORT_DRP ||
1782 !port->ops || !port->ops->try_role)
1784 } else if (attr == &dev_attr_port_type.attr) {
1785 if (!port->ops || !port->ops->port_type_set)
1787 if (port->cap->type != TYPEC_PORT_DRP)
1789 } else if (attr == &dev_attr_orientation.attr) {
1790 if (port->cap->orientation_aware)
1798 static const struct attribute_group typec_group = {
1799 .is_visible = typec_attr_is_visible,
1800 .attrs = typec_attrs,
1803 static const struct attribute_group *typec_groups[] = {
1809 static int typec_uevent(const struct device *dev, struct kobj_uevent_env *env)
1813 ret = add_uevent_var(env, "TYPEC_PORT=%s", dev_name(dev));
1815 dev_err(dev, "failed to add uevent TYPEC_PORT\n");
1820 static void typec_release(struct device *dev)
1822 struct typec_port *port = to_typec_port(dev);
1824 ida_free(&typec_index_ida, port->id);
1825 ida_destroy(&port->mode_ids);
1826 typec_switch_put(port->sw);
1827 typec_mux_put(port->mux);
1828 typec_retimer_put(port->retimer);
1833 const struct device_type typec_port_dev_type = {
1834 .name = "typec_port",
1835 .groups = typec_groups,
1836 .uevent = typec_uevent,
1837 .release = typec_release,
1840 /* --------------------------------------- */
1841 /* Driver callbacks to report role updates */
1843 static int partner_match(struct device *dev, void *data)
1845 return is_typec_partner(dev);
1848 static struct typec_partner *typec_get_partner(struct typec_port *port)
1852 dev = device_find_child(&port->dev, NULL, partner_match);
1856 return to_typec_partner(dev);
1859 static void typec_partner_attach(struct typec_connector *con, struct device *dev)
1861 struct typec_port *port = container_of(con, struct typec_port, con);
1862 struct typec_partner *partner = typec_get_partner(port);
1863 struct usb_device *udev = to_usb_device(dev);
1865 if (udev->speed < USB_SPEED_SUPER)
1866 port->usb2_dev = dev;
1868 port->usb3_dev = dev;
1871 typec_partner_link_device(partner, dev);
1872 put_device(&partner->dev);
1876 static void typec_partner_deattach(struct typec_connector *con, struct device *dev)
1878 struct typec_port *port = container_of(con, struct typec_port, con);
1879 struct typec_partner *partner = typec_get_partner(port);
1882 typec_partner_unlink_device(partner, dev);
1883 put_device(&partner->dev);
1886 if (port->usb2_dev == dev)
1887 port->usb2_dev = NULL;
1888 else if (port->usb3_dev == dev)
1889 port->usb3_dev = NULL;
1893 * typec_set_data_role - Report data role change
1894 * @port: The USB Type-C Port where the role was changed
1895 * @role: The new data role
1897 * This routine is used by the port drivers to report data role changes.
1899 void typec_set_data_role(struct typec_port *port, enum typec_data_role role)
1901 struct typec_partner *partner;
1903 if (port->data_role == role)
1906 port->data_role = role;
1907 sysfs_notify(&port->dev.kobj, NULL, "data_role");
1908 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1910 partner = typec_get_partner(port);
1914 if (partner->identity)
1915 typec_product_type_notify(&partner->dev);
1917 put_device(&partner->dev);
1919 EXPORT_SYMBOL_GPL(typec_set_data_role);
1922 * typec_set_pwr_role - Report power role change
1923 * @port: The USB Type-C Port where the role was changed
1924 * @role: The new data role
1926 * This routine is used by the port drivers to report power role changes.
1928 void typec_set_pwr_role(struct typec_port *port, enum typec_role role)
1930 if (port->pwr_role == role)
1933 port->pwr_role = role;
1934 sysfs_notify(&port->dev.kobj, NULL, "power_role");
1935 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1937 EXPORT_SYMBOL_GPL(typec_set_pwr_role);
1940 * typec_set_vconn_role - Report VCONN source change
1941 * @port: The USB Type-C Port which VCONN role changed
1942 * @role: Source when @port is sourcing VCONN, or Sink when it's not
1944 * This routine is used by the port drivers to report if the VCONN source is
1947 void typec_set_vconn_role(struct typec_port *port, enum typec_role role)
1949 if (port->vconn_role == role)
1952 port->vconn_role = role;
1953 sysfs_notify(&port->dev.kobj, NULL, "vconn_source");
1954 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1956 EXPORT_SYMBOL_GPL(typec_set_vconn_role);
1959 * typec_set_pwr_opmode - Report changed power operation mode
1960 * @port: The USB Type-C Port where the mode was changed
1961 * @opmode: New power operation mode
1963 * This routine is used by the port drivers to report changed power operation
1964 * mode in @port. The modes are USB (default), 1.5A, 3.0A as defined in USB
1965 * Type-C specification, and "USB Power Delivery" when the power levels are
1966 * negotiated with methods defined in USB Power Delivery specification.
1968 void typec_set_pwr_opmode(struct typec_port *port,
1969 enum typec_pwr_opmode opmode)
1971 struct device *partner_dev;
1973 if (port->pwr_opmode == opmode)
1976 port->pwr_opmode = opmode;
1977 sysfs_notify(&port->dev.kobj, NULL, "power_operation_mode");
1978 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1980 partner_dev = device_find_child(&port->dev, NULL, partner_match);
1982 struct typec_partner *partner = to_typec_partner(partner_dev);
1984 if (opmode == TYPEC_PWR_MODE_PD && !partner->usb_pd) {
1985 partner->usb_pd = 1;
1986 sysfs_notify(&partner_dev->kobj, NULL,
1987 "supports_usb_power_delivery");
1988 kobject_uevent(&partner_dev->kobj, KOBJ_CHANGE);
1990 put_device(partner_dev);
1993 EXPORT_SYMBOL_GPL(typec_set_pwr_opmode);
1996 * typec_find_pwr_opmode - Get the typec power operation mode capability
1997 * @name: power operation mode string
1999 * This routine is used to find the typec_pwr_opmode by its string @name.
2001 * Returns typec_pwr_opmode if success, otherwise negative error code.
2003 int typec_find_pwr_opmode(const char *name)
2005 return match_string(typec_pwr_opmodes,
2006 ARRAY_SIZE(typec_pwr_opmodes), name);
2008 EXPORT_SYMBOL_GPL(typec_find_pwr_opmode);
2011 * typec_find_orientation - Convert orientation string to enum typec_orientation
2012 * @name: Orientation string
2014 * This routine is used to find the typec_orientation by its string name @name.
2016 * Returns the orientation value on success, otherwise negative error code.
2018 int typec_find_orientation(const char *name)
2020 return match_string(typec_orientations, ARRAY_SIZE(typec_orientations),
2023 EXPORT_SYMBOL_GPL(typec_find_orientation);
2026 * typec_find_port_power_role - Get the typec port power capability
2027 * @name: port power capability string
2029 * This routine is used to find the typec_port_type by its string name.
2031 * Returns typec_port_type if success, otherwise negative error code.
2033 int typec_find_port_power_role(const char *name)
2035 return match_string(typec_port_power_roles,
2036 ARRAY_SIZE(typec_port_power_roles), name);
2038 EXPORT_SYMBOL_GPL(typec_find_port_power_role);
2041 * typec_find_power_role - Find the typec one specific power role
2042 * @name: power role string
2044 * This routine is used to find the typec_role by its string name.
2046 * Returns typec_role if success, otherwise negative error code.
2048 int typec_find_power_role(const char *name)
2050 return match_string(typec_roles, ARRAY_SIZE(typec_roles), name);
2052 EXPORT_SYMBOL_GPL(typec_find_power_role);
2055 * typec_find_port_data_role - Get the typec port data capability
2056 * @name: port data capability string
2058 * This routine is used to find the typec_port_data by its string name.
2060 * Returns typec_port_data if success, otherwise negative error code.
2062 int typec_find_port_data_role(const char *name)
2064 return match_string(typec_port_data_roles,
2065 ARRAY_SIZE(typec_port_data_roles), name);
2067 EXPORT_SYMBOL_GPL(typec_find_port_data_role);
2069 /* ------------------------------------------ */
2070 /* API for Multiplexer/DeMultiplexer Switches */
2073 * typec_set_orientation - Set USB Type-C cable plug orientation
2074 * @port: USB Type-C Port
2075 * @orientation: USB Type-C cable plug orientation
2077 * Set cable plug orientation for @port.
2079 int typec_set_orientation(struct typec_port *port,
2080 enum typec_orientation orientation)
2084 ret = typec_switch_set(port->sw, orientation);
2088 port->orientation = orientation;
2089 sysfs_notify(&port->dev.kobj, NULL, "orientation");
2090 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
2094 EXPORT_SYMBOL_GPL(typec_set_orientation);
2097 * typec_get_orientation - Get USB Type-C cable plug orientation
2098 * @port: USB Type-C Port
2100 * Get current cable plug orientation for @port.
2102 enum typec_orientation typec_get_orientation(struct typec_port *port)
2104 return port->orientation;
2106 EXPORT_SYMBOL_GPL(typec_get_orientation);
2109 * typec_set_mode - Set mode of operation for USB Type-C connector
2110 * @port: USB Type-C connector
2111 * @mode: Accessory Mode, USB Operation or Safe State
2113 * Configure @port for Accessory Mode @mode. This function will configure the
2114 * muxes needed for @mode.
2116 int typec_set_mode(struct typec_port *port, int mode)
2118 struct typec_mux_state state = { };
2122 return typec_mux_set(port->mux, &state);
2124 EXPORT_SYMBOL_GPL(typec_set_mode);
2126 /* --------------------------------------- */
2129 * typec_get_negotiated_svdm_version - Get negotiated SVDM Version
2130 * @port: USB Type-C Port.
2132 * Get the negotiated SVDM Version. The Version is set to the port default
2133 * value stored in typec_capability on partner registration, and updated after
2134 * a successful Discover Identity if the negotiated value is less than the
2137 * Returns usb_pd_svdm_ver if the partner has been registered otherwise -ENODEV.
2139 int typec_get_negotiated_svdm_version(struct typec_port *port)
2141 enum usb_pd_svdm_ver svdm_version;
2142 struct device *partner_dev;
2144 partner_dev = device_find_child(&port->dev, NULL, partner_match);
2148 svdm_version = to_typec_partner(partner_dev)->svdm_version;
2149 put_device(partner_dev);
2151 return svdm_version;
2153 EXPORT_SYMBOL_GPL(typec_get_negotiated_svdm_version);
2156 * typec_get_cable_svdm_version - Get cable negotiated SVDM Version
2157 * @port: USB Type-C Port.
2159 * Get the negotiated SVDM Version for the cable. The Version is set to the port
2160 * default value based on the PD Revision during cable registration, and updated
2161 * after a successful Discover Identity if the negotiated value is less than the
2164 * Returns usb_pd_svdm_ver if the cable has been registered otherwise -ENODEV.
2166 int typec_get_cable_svdm_version(struct typec_port *port)
2168 enum usb_pd_svdm_ver svdm_version;
2169 struct device *cable_dev;
2171 cable_dev = device_find_child(&port->dev, NULL, cable_match);
2175 svdm_version = to_typec_cable(cable_dev)->svdm_version;
2176 put_device(cable_dev);
2178 return svdm_version;
2180 EXPORT_SYMBOL_GPL(typec_get_cable_svdm_version);
2183 * typec_cable_set_svdm_version - Set negotiated Structured VDM (SVDM) Version
2184 * @cable: USB Type-C Active Cable that supports SVDM
2185 * @svdm_version: Negotiated SVDM Version
2187 * This routine is used to save the negotiated SVDM Version.
2189 void typec_cable_set_svdm_version(struct typec_cable *cable, enum usb_pd_svdm_ver svdm_version)
2191 cable->svdm_version = svdm_version;
2193 EXPORT_SYMBOL_GPL(typec_cable_set_svdm_version);
2196 * typec_get_drvdata - Return private driver data pointer
2197 * @port: USB Type-C port
2199 void *typec_get_drvdata(struct typec_port *port)
2201 return dev_get_drvdata(&port->dev);
2203 EXPORT_SYMBOL_GPL(typec_get_drvdata);
2205 int typec_get_fw_cap(struct typec_capability *cap,
2206 struct fwnode_handle *fwnode)
2208 const char *cap_str;
2211 cap->fwnode = fwnode;
2213 ret = fwnode_property_read_string(fwnode, "power-role", &cap_str);
2217 ret = typec_find_port_power_role(cap_str);
2222 /* USB data support is optional */
2223 ret = fwnode_property_read_string(fwnode, "data-role", &cap_str);
2225 ret = typec_find_port_data_role(cap_str);
2231 /* Get the preferred power role for a DRP */
2232 if (cap->type == TYPEC_PORT_DRP) {
2233 cap->prefer_role = TYPEC_NO_PREFERRED_ROLE;
2235 ret = fwnode_property_read_string(fwnode, "try-power-role", &cap_str);
2237 ret = typec_find_power_role(cap_str);
2240 cap->prefer_role = ret;
2246 EXPORT_SYMBOL_GPL(typec_get_fw_cap);
2249 * typec_port_register_altmode - Register USB Type-C Port Alternate Mode
2250 * @port: USB Type-C Port that supports the alternate mode
2251 * @desc: Description of the alternate mode
2253 * This routine is used to register an alternate mode that @port is capable of
2256 * Returns handle to the alternate mode on success or ERR_PTR on failure.
2258 struct typec_altmode *
2259 typec_port_register_altmode(struct typec_port *port,
2260 const struct typec_altmode_desc *desc)
2262 struct typec_altmode *adev;
2263 struct typec_mux *mux;
2264 struct typec_retimer *retimer;
2266 mux = typec_mux_get(&port->dev);
2268 return ERR_CAST(mux);
2270 retimer = typec_retimer_get(&port->dev);
2271 if (IS_ERR(retimer)) {
2273 return ERR_CAST(retimer);
2276 adev = typec_register_altmode(&port->dev, desc);
2278 typec_retimer_put(retimer);
2281 to_altmode(adev)->mux = mux;
2282 to_altmode(adev)->retimer = retimer;
2287 EXPORT_SYMBOL_GPL(typec_port_register_altmode);
2289 void typec_port_register_altmodes(struct typec_port *port,
2290 const struct typec_altmode_ops *ops, void *drvdata,
2291 struct typec_altmode **altmodes, size_t n)
2293 struct fwnode_handle *altmodes_node, *child;
2294 struct typec_altmode_desc desc;
2295 struct typec_altmode *alt;
2301 altmodes_node = device_get_named_child_node(&port->dev, "altmodes");
2303 return; /* No altmodes specified */
2305 fwnode_for_each_child_node(altmodes_node, child) {
2306 ret = fwnode_property_read_u16(child, "svid", &svid);
2308 dev_err(&port->dev, "Error reading svid for altmode %s\n",
2309 fwnode_get_name(child));
2313 ret = fwnode_property_read_u32(child, "vdo", &vdo);
2315 dev_err(&port->dev, "Error reading vdo for altmode %s\n",
2316 fwnode_get_name(child));
2321 dev_err(&port->dev, "Error not enough space for altmode %s\n",
2322 fwnode_get_name(child));
2328 desc.mode = index + 1;
2329 alt = typec_port_register_altmode(port, &desc);
2331 dev_err(&port->dev, "Error registering altmode %s\n",
2332 fwnode_get_name(child));
2336 typec_altmode_set_ops(alt, ops);
2337 typec_altmode_set_drvdata(alt, drvdata);
2338 altmodes[index] = alt;
2342 EXPORT_SYMBOL_GPL(typec_port_register_altmodes);
2345 * typec_port_register_cable_ops - Register typec_cable_ops to port altmodes
2346 * @altmodes: USB Type-C Port's altmode vector
2347 * @max_altmodes: The maximum number of alt modes supported by the port
2348 * @ops: Cable alternate mode vector
2350 void typec_port_register_cable_ops(struct typec_altmode **altmodes, int max_altmodes,
2351 const struct typec_cable_ops *ops)
2355 for (i = 0; i < max_altmodes; i++) {
2358 altmodes[i]->cable_ops = ops;
2361 EXPORT_SYMBOL_GPL(typec_port_register_cable_ops);
2364 * typec_register_port - Register a USB Type-C Port
2365 * @parent: Parent device
2366 * @cap: Description of the port
2368 * Registers a device for USB Type-C Port described in @cap.
2370 * Returns handle to the port on success or ERR_PTR on failure.
2372 struct typec_port *typec_register_port(struct device *parent,
2373 const struct typec_capability *cap)
2375 struct typec_port *port;
2379 port = kzalloc(sizeof(*port), GFP_KERNEL);
2381 return ERR_PTR(-ENOMEM);
2383 id = ida_alloc(&typec_index_ida, GFP_KERNEL);
2389 switch (cap->type) {
2390 case TYPEC_PORT_SRC:
2391 port->pwr_role = TYPEC_SOURCE;
2392 port->vconn_role = TYPEC_SOURCE;
2394 case TYPEC_PORT_SNK:
2395 port->pwr_role = TYPEC_SINK;
2396 port->vconn_role = TYPEC_SINK;
2398 case TYPEC_PORT_DRP:
2399 if (cap->prefer_role != TYPEC_NO_PREFERRED_ROLE)
2400 port->pwr_role = cap->prefer_role;
2402 port->pwr_role = TYPEC_SINK;
2406 switch (cap->data) {
2407 case TYPEC_PORT_DFP:
2408 port->data_role = TYPEC_HOST;
2410 case TYPEC_PORT_UFP:
2411 port->data_role = TYPEC_DEVICE;
2413 case TYPEC_PORT_DRD:
2414 if (cap->prefer_role == TYPEC_SOURCE)
2415 port->data_role = TYPEC_HOST;
2417 port->data_role = TYPEC_DEVICE;
2421 ida_init(&port->mode_ids);
2422 mutex_init(&port->port_type_lock);
2425 port->ops = cap->ops;
2426 port->port_type = cap->type;
2427 port->prefer_role = cap->prefer_role;
2428 port->con.attach = typec_partner_attach;
2429 port->con.deattach = typec_partner_deattach;
2431 device_initialize(&port->dev);
2432 port->dev.class = &typec_class;
2433 port->dev.parent = parent;
2434 port->dev.fwnode = cap->fwnode;
2435 port->dev.type = &typec_port_dev_type;
2436 dev_set_name(&port->dev, "port%d", id);
2437 dev_set_drvdata(&port->dev, cap->driver_data);
2439 port->cap = kmemdup(cap, sizeof(*cap), GFP_KERNEL);
2441 put_device(&port->dev);
2442 return ERR_PTR(-ENOMEM);
2445 port->sw = typec_switch_get(&port->dev);
2446 if (IS_ERR(port->sw)) {
2447 ret = PTR_ERR(port->sw);
2448 put_device(&port->dev);
2449 return ERR_PTR(ret);
2452 port->mux = typec_mux_get(&port->dev);
2453 if (IS_ERR(port->mux)) {
2454 ret = PTR_ERR(port->mux);
2455 put_device(&port->dev);
2456 return ERR_PTR(ret);
2459 port->retimer = typec_retimer_get(&port->dev);
2460 if (IS_ERR(port->retimer)) {
2461 ret = PTR_ERR(port->retimer);
2462 put_device(&port->dev);
2463 return ERR_PTR(ret);
2468 ret = device_add(&port->dev);
2470 dev_err(parent, "failed to register port (%d)\n", ret);
2471 put_device(&port->dev);
2472 return ERR_PTR(ret);
2475 ret = usb_power_delivery_link_device(port->pd, &port->dev);
2477 dev_err(&port->dev, "failed to link pd\n");
2478 device_unregister(&port->dev);
2479 return ERR_PTR(ret);
2482 ret = typec_link_ports(port);
2484 dev_warn(&port->dev, "failed to create symlinks (%d)\n", ret);
2488 EXPORT_SYMBOL_GPL(typec_register_port);
2491 * typec_unregister_port - Unregister a USB Type-C Port
2492 * @port: The port to be unregistered
2494 * Unregister device created with typec_register_port().
2496 void typec_unregister_port(struct typec_port *port)
2498 if (!IS_ERR_OR_NULL(port)) {
2499 typec_unlink_ports(port);
2500 typec_port_set_usb_power_delivery(port, NULL);
2501 device_unregister(&port->dev);
2504 EXPORT_SYMBOL_GPL(typec_unregister_port);
2506 static int __init typec_init(void)
2510 ret = bus_register(&typec_bus);
2514 ret = class_register(&typec_mux_class);
2516 goto err_unregister_bus;
2518 ret = class_register(&retimer_class);
2520 goto err_unregister_mux_class;
2522 ret = class_register(&typec_class);
2524 goto err_unregister_retimer_class;
2526 ret = usb_power_delivery_init();
2528 goto err_unregister_class;
2532 err_unregister_class:
2533 class_unregister(&typec_class);
2535 err_unregister_retimer_class:
2536 class_unregister(&retimer_class);
2538 err_unregister_mux_class:
2539 class_unregister(&typec_mux_class);
2542 bus_unregister(&typec_bus);
2546 subsys_initcall(typec_init);
2548 static void __exit typec_exit(void)
2550 usb_power_delivery_exit();
2551 class_unregister(&typec_class);
2552 ida_destroy(&typec_index_ida);
2553 bus_unregister(&typec_bus);
2554 class_unregister(&typec_mux_class);
2555 class_unregister(&retimer_class);
2557 module_exit(typec_exit);
2560 MODULE_LICENSE("GPL v2");
2561 MODULE_DESCRIPTION("USB Type-C Connector Class");