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 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;
270 adev = &altmode->adev;
272 if (is_typec_plug(adev->dev.parent)) {
273 struct typec_plug *plug = to_typec_plug(adev->dev.parent);
275 partner->plug[plug->index] = NULL;
277 partner->partner = NULL;
279 put_device(&adev->dev);
283 * typec_altmode_update_active - Report Enter/Exit mode
284 * @adev: Handle to the alternate mode
285 * @active: True when the mode has been entered
287 * If a partner or cable plug executes Enter/Exit Mode command successfully, the
288 * drivers use this routine to report the updated state of the mode.
290 void typec_altmode_update_active(struct typec_altmode *adev, bool active)
294 if (adev->active == active)
297 if (!is_typec_port(adev->dev.parent) && adev->dev.driver) {
299 module_put(adev->dev.driver->owner);
301 WARN_ON(!try_module_get(adev->dev.driver->owner));
304 adev->active = active;
305 snprintf(dir, sizeof(dir), "mode%d", adev->mode);
306 sysfs_notify(&adev->dev.kobj, dir, "active");
307 sysfs_notify(&adev->dev.kobj, NULL, "active");
308 kobject_uevent(&adev->dev.kobj, KOBJ_CHANGE);
310 EXPORT_SYMBOL_GPL(typec_altmode_update_active);
313 * typec_altmode2port - Alternate Mode to USB Type-C port
314 * @alt: The Alternate Mode
316 * Returns handle to the port that a cable plug or partner with @alt is
319 struct typec_port *typec_altmode2port(struct typec_altmode *alt)
321 if (is_typec_plug(alt->dev.parent))
322 return to_typec_port(alt->dev.parent->parent->parent);
323 if (is_typec_partner(alt->dev.parent))
324 return to_typec_port(alt->dev.parent->parent);
325 if (is_typec_port(alt->dev.parent))
326 return to_typec_port(alt->dev.parent);
330 EXPORT_SYMBOL_GPL(typec_altmode2port);
333 vdo_show(struct device *dev, struct device_attribute *attr, char *buf)
335 struct typec_altmode *alt = to_typec_altmode(dev);
337 return sprintf(buf, "0x%08x\n", alt->vdo);
339 static DEVICE_ATTR_RO(vdo);
342 description_show(struct device *dev, struct device_attribute *attr, char *buf)
344 struct typec_altmode *alt = to_typec_altmode(dev);
346 return sprintf(buf, "%s\n", alt->desc ? alt->desc : "");
348 static DEVICE_ATTR_RO(description);
351 active_show(struct device *dev, struct device_attribute *attr, char *buf)
353 struct typec_altmode *alt = to_typec_altmode(dev);
355 return sprintf(buf, "%s\n", alt->active ? "yes" : "no");
358 static ssize_t active_store(struct device *dev, struct device_attribute *attr,
359 const char *buf, size_t size)
361 struct typec_altmode *adev = to_typec_altmode(dev);
362 struct altmode *altmode = to_altmode(adev);
366 ret = kstrtobool(buf, &enter);
370 if (adev->active == enter)
373 if (is_typec_port(adev->dev.parent)) {
374 typec_altmode_update_active(adev, enter);
376 /* Make sure that the partner exits the mode before disabling */
377 if (altmode->partner && !enter && altmode->partner->adev.active)
378 typec_altmode_exit(&altmode->partner->adev);
379 } else if (altmode->partner) {
380 if (enter && !altmode->partner->adev.active) {
381 dev_warn(dev, "port has the mode disabled\n");
386 /* Note: If there is no driver, the mode will not be entered */
387 if (adev->ops && adev->ops->activate) {
388 ret = adev->ops->activate(adev, enter);
395 static DEVICE_ATTR_RW(active);
398 supported_roles_show(struct device *dev, struct device_attribute *attr,
401 struct altmode *alt = to_altmode(to_typec_altmode(dev));
404 switch (alt->roles) {
406 ret = sprintf(buf, "source\n");
409 ret = sprintf(buf, "sink\n");
413 ret = sprintf(buf, "source sink\n");
418 static DEVICE_ATTR_RO(supported_roles);
421 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
423 struct typec_altmode *adev = to_typec_altmode(dev);
425 return sprintf(buf, "%u\n", adev->mode);
427 static DEVICE_ATTR_RO(mode);
430 svid_show(struct device *dev, struct device_attribute *attr, char *buf)
432 struct typec_altmode *adev = to_typec_altmode(dev);
434 return sprintf(buf, "%04x\n", adev->svid);
436 static DEVICE_ATTR_RO(svid);
438 static struct attribute *typec_altmode_attrs[] = {
439 &dev_attr_active.attr,
446 static umode_t typec_altmode_attr_is_visible(struct kobject *kobj,
447 struct attribute *attr, int n)
449 struct typec_altmode *adev = to_typec_altmode(kobj_to_dev(kobj));
451 if (attr == &dev_attr_active.attr)
452 if (!adev->ops || !adev->ops->activate)
458 static const struct attribute_group typec_altmode_group = {
459 .is_visible = typec_altmode_attr_is_visible,
460 .attrs = typec_altmode_attrs,
463 static const struct attribute_group *typec_altmode_groups[] = {
464 &typec_altmode_group,
468 static int altmode_id_get(struct device *dev)
472 if (is_typec_partner(dev))
473 ids = &to_typec_partner(dev)->mode_ids;
474 else if (is_typec_plug(dev))
475 ids = &to_typec_plug(dev)->mode_ids;
477 ids = &to_typec_port(dev)->mode_ids;
479 return ida_simple_get(ids, 0, 0, GFP_KERNEL);
482 static void altmode_id_remove(struct device *dev, int id)
486 if (is_typec_partner(dev))
487 ids = &to_typec_partner(dev)->mode_ids;
488 else if (is_typec_plug(dev))
489 ids = &to_typec_plug(dev)->mode_ids;
491 ids = &to_typec_port(dev)->mode_ids;
493 ida_simple_remove(ids, id);
496 static void typec_altmode_release(struct device *dev)
498 struct altmode *alt = to_altmode(to_typec_altmode(dev));
500 if (!is_typec_port(dev->parent))
501 typec_altmode_put_partner(alt);
503 altmode_id_remove(alt->adev.dev.parent, alt->id);
507 const struct device_type typec_altmode_dev_type = {
508 .name = "typec_alternate_mode",
509 .groups = typec_altmode_groups,
510 .release = typec_altmode_release,
513 static struct typec_altmode *
514 typec_register_altmode(struct device *parent,
515 const struct typec_altmode_desc *desc)
517 unsigned int id = altmode_id_get(parent);
518 bool is_port = is_typec_port(parent);
522 alt = kzalloc(sizeof(*alt), GFP_KERNEL);
524 altmode_id_remove(parent, id);
525 return ERR_PTR(-ENOMEM);
528 alt->adev.svid = desc->svid;
529 alt->adev.mode = desc->mode;
530 alt->adev.vdo = desc->vdo;
531 alt->roles = desc->roles;
534 alt->attrs[0] = &dev_attr_vdo.attr;
535 alt->attrs[1] = &dev_attr_description.attr;
536 alt->attrs[2] = &dev_attr_active.attr;
539 alt->attrs[3] = &dev_attr_supported_roles.attr;
540 alt->adev.active = true; /* Enabled by default */
543 sprintf(alt->group_name, "mode%d", desc->mode);
544 alt->group.name = alt->group_name;
545 alt->group.attrs = alt->attrs;
546 alt->groups[0] = &alt->group;
548 alt->adev.dev.parent = parent;
549 alt->adev.dev.groups = alt->groups;
550 alt->adev.dev.type = &typec_altmode_dev_type;
551 dev_set_name(&alt->adev.dev, "%s.%u", dev_name(parent), id);
553 /* Link partners and plugs with the ports */
555 typec_altmode_set_partner(alt);
557 /* The partners are bind to drivers */
558 if (is_typec_partner(parent))
559 alt->adev.dev.bus = &typec_bus;
561 /* Plug alt modes need a class to generate udev events. */
562 if (is_typec_plug(parent))
563 alt->adev.dev.class = &typec_class;
565 ret = device_register(&alt->adev.dev);
567 dev_err(parent, "failed to register alternate mode (%d)\n",
569 put_device(&alt->adev.dev);
577 * typec_unregister_altmode - Unregister Alternate Mode
578 * @adev: The alternate mode to be unregistered
580 * Unregister device created with typec_partner_register_altmode(),
581 * typec_plug_register_altmode() or typec_port_register_altmode().
583 void typec_unregister_altmode(struct typec_altmode *adev)
585 if (IS_ERR_OR_NULL(adev))
587 typec_retimer_put(to_altmode(adev)->retimer);
588 typec_mux_put(to_altmode(adev)->mux);
589 device_unregister(&adev->dev);
591 EXPORT_SYMBOL_GPL(typec_unregister_altmode);
593 /* ------------------------------------------------------------------------- */
594 /* Type-C Partners */
596 static ssize_t accessory_mode_show(struct device *dev,
597 struct device_attribute *attr,
600 struct typec_partner *p = to_typec_partner(dev);
602 return sprintf(buf, "%s\n", typec_accessory_modes[p->accessory]);
604 static DEVICE_ATTR_RO(accessory_mode);
606 static ssize_t supports_usb_power_delivery_show(struct device *dev,
607 struct device_attribute *attr,
610 struct typec_partner *p = to_typec_partner(dev);
612 return sprintf(buf, "%s\n", p->usb_pd ? "yes" : "no");
614 static DEVICE_ATTR_RO(supports_usb_power_delivery);
616 static ssize_t number_of_alternate_modes_show(struct device *dev, struct device_attribute *attr,
619 struct typec_partner *partner;
620 struct typec_plug *plug;
623 if (is_typec_partner(dev)) {
624 partner = to_typec_partner(dev);
625 num_altmodes = partner->num_altmodes;
626 } else if (is_typec_plug(dev)) {
627 plug = to_typec_plug(dev);
628 num_altmodes = plug->num_altmodes;
633 return sysfs_emit(buf, "%d\n", num_altmodes);
635 static DEVICE_ATTR_RO(number_of_alternate_modes);
637 static struct attribute *typec_partner_attrs[] = {
638 &dev_attr_accessory_mode.attr,
639 &dev_attr_supports_usb_power_delivery.attr,
640 &dev_attr_number_of_alternate_modes.attr,
642 &dev_attr_usb_power_delivery_revision.attr,
646 static umode_t typec_partner_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
648 struct typec_partner *partner = to_typec_partner(kobj_to_dev(kobj));
650 if (attr == &dev_attr_number_of_alternate_modes.attr) {
651 if (partner->num_altmodes < 0)
655 if (attr == &dev_attr_type.attr)
656 if (!get_pd_product_type(kobj_to_dev(kobj)))
662 static const struct attribute_group typec_partner_group = {
663 .is_visible = typec_partner_attr_is_visible,
664 .attrs = typec_partner_attrs
667 static const struct attribute_group *typec_partner_groups[] = {
668 &typec_partner_group,
672 static void typec_partner_release(struct device *dev)
674 struct typec_partner *partner = to_typec_partner(dev);
676 ida_destroy(&partner->mode_ids);
680 const struct device_type typec_partner_dev_type = {
681 .name = "typec_partner",
682 .groups = typec_partner_groups,
683 .release = typec_partner_release,
686 static void typec_partner_link_device(struct typec_partner *partner, struct device *dev)
690 ret = sysfs_create_link(&dev->kobj, &partner->dev.kobj, "typec");
694 ret = sysfs_create_link(&partner->dev.kobj, &dev->kobj, dev_name(dev));
696 sysfs_remove_link(&dev->kobj, "typec");
701 partner->attach(partner, dev);
704 static void typec_partner_unlink_device(struct typec_partner *partner, struct device *dev)
706 sysfs_remove_link(&partner->dev.kobj, dev_name(dev));
707 sysfs_remove_link(&dev->kobj, "typec");
709 if (partner->deattach)
710 partner->deattach(partner, dev);
714 * typec_partner_set_identity - Report result from Discover Identity command
715 * @partner: The partner updated identity values
717 * This routine is used to report that the result of Discover Identity USB power
718 * delivery command has become available.
720 int typec_partner_set_identity(struct typec_partner *partner)
722 if (!partner->identity)
725 typec_report_identity(&partner->dev);
728 EXPORT_SYMBOL_GPL(typec_partner_set_identity);
731 * typec_partner_set_pd_revision - Set the PD revision supported by the partner
732 * @partner: The partner to be updated.
733 * @pd_revision: USB Power Delivery Specification Revision supported by partner
735 * This routine is used to report that the PD revision of the port partner has
738 void typec_partner_set_pd_revision(struct typec_partner *partner, u16 pd_revision)
740 if (partner->pd_revision == pd_revision)
743 partner->pd_revision = pd_revision;
744 sysfs_notify(&partner->dev.kobj, NULL, "usb_power_delivery_revision");
745 if (pd_revision != 0 && !partner->usb_pd) {
747 sysfs_notify(&partner->dev.kobj, NULL,
748 "supports_usb_power_delivery");
750 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
752 EXPORT_SYMBOL_GPL(typec_partner_set_pd_revision);
755 * typec_partner_set_usb_power_delivery - Declare USB Power Delivery Contract.
756 * @partner: The partner device.
757 * @pd: The USB PD instance.
759 * This routine can be used to declare USB Power Delivery Contract with @partner
760 * by linking @partner to @pd which contains the objects that were used during the
761 * negotiation of the contract.
763 * If @pd is NULL, the link is removed and the contract with @partner has ended.
765 int typec_partner_set_usb_power_delivery(struct typec_partner *partner,
766 struct usb_power_delivery *pd)
770 if (IS_ERR_OR_NULL(partner) || partner->pd == pd)
774 ret = usb_power_delivery_link_device(pd, &partner->dev);
778 usb_power_delivery_unlink_device(partner->pd, &partner->dev);
785 EXPORT_SYMBOL_GPL(typec_partner_set_usb_power_delivery);
788 * typec_partner_set_num_altmodes - Set the number of available partner altmodes
789 * @partner: The partner to be updated.
790 * @num_altmodes: The number of altmodes we want to specify as available.
792 * This routine is used to report the number of alternate modes supported by the
793 * partner. This value is *not* enforced in alternate mode registration routines.
795 * @partner.num_altmodes is set to -1 on partner registration, denoting that
796 * a valid value has not been set for it yet.
798 * Returns 0 on success or negative error number on failure.
800 int typec_partner_set_num_altmodes(struct typec_partner *partner, int num_altmodes)
804 if (num_altmodes < 0)
807 partner->num_altmodes = num_altmodes;
808 ret = sysfs_update_group(&partner->dev.kobj, &typec_partner_group);
812 sysfs_notify(&partner->dev.kobj, NULL, "number_of_alternate_modes");
813 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
817 EXPORT_SYMBOL_GPL(typec_partner_set_num_altmodes);
820 * typec_partner_register_altmode - Register USB Type-C Partner Alternate Mode
821 * @partner: USB Type-C Partner that supports the alternate mode
822 * @desc: Description of the alternate mode
824 * This routine is used to register each alternate mode individually that
825 * @partner has listed in response to Discover SVIDs command. The modes for a
826 * SVID listed in response to Discover Modes command need to be listed in an
829 * Returns handle to the alternate mode on success or ERR_PTR on failure.
831 struct typec_altmode *
832 typec_partner_register_altmode(struct typec_partner *partner,
833 const struct typec_altmode_desc *desc)
835 return typec_register_altmode(&partner->dev, desc);
837 EXPORT_SYMBOL_GPL(typec_partner_register_altmode);
840 * typec_partner_set_svdm_version - Set negotiated Structured VDM (SVDM) Version
841 * @partner: USB Type-C Partner that supports SVDM
842 * @svdm_version: Negotiated SVDM Version
844 * This routine is used to save the negotiated SVDM Version.
846 void typec_partner_set_svdm_version(struct typec_partner *partner,
847 enum usb_pd_svdm_ver svdm_version)
849 partner->svdm_version = svdm_version;
851 EXPORT_SYMBOL_GPL(typec_partner_set_svdm_version);
854 * typec_partner_usb_power_delivery_register - Register Type-C partner USB Power Delivery Support
855 * @partner: Type-C partner device.
856 * @desc: Description of the USB PD contract.
858 * This routine is a wrapper around usb_power_delivery_register(). It registers
859 * USB Power Delivery Capabilities for a Type-C partner device. Specifically,
860 * it sets the Type-C partner device as a parent for the resulting USB Power Delivery object.
862 * Returns handle to struct usb_power_delivery or ERR_PTR.
864 struct usb_power_delivery *
865 typec_partner_usb_power_delivery_register(struct typec_partner *partner,
866 struct usb_power_delivery_desc *desc)
868 return usb_power_delivery_register(&partner->dev, desc);
870 EXPORT_SYMBOL_GPL(typec_partner_usb_power_delivery_register);
873 * typec_register_partner - Register a USB Type-C Partner
874 * @port: The USB Type-C Port the partner is connected to
875 * @desc: Description of the partner
877 * Registers a device for USB Type-C Partner described in @desc.
879 * Returns handle to the partner on success or ERR_PTR on failure.
881 struct typec_partner *typec_register_partner(struct typec_port *port,
882 struct typec_partner_desc *desc)
884 struct typec_partner *partner;
887 partner = kzalloc(sizeof(*partner), GFP_KERNEL);
889 return ERR_PTR(-ENOMEM);
891 ida_init(&partner->mode_ids);
892 partner->usb_pd = desc->usb_pd;
893 partner->accessory = desc->accessory;
894 partner->num_altmodes = -1;
895 partner->pd_revision = desc->pd_revision;
896 partner->svdm_version = port->cap->svdm_version;
897 partner->attach = desc->attach;
898 partner->deattach = desc->deattach;
900 if (desc->identity) {
902 * Creating directory for the identity only if the driver is
903 * able to provide data to it.
905 partner->dev.groups = usb_pd_id_groups;
906 partner->identity = desc->identity;
909 partner->dev.class = &typec_class;
910 partner->dev.parent = &port->dev;
911 partner->dev.type = &typec_partner_dev_type;
912 dev_set_name(&partner->dev, "%s-partner", dev_name(&port->dev));
914 ret = device_register(&partner->dev);
916 dev_err(&port->dev, "failed to register partner (%d)\n", ret);
917 put_device(&partner->dev);
922 typec_partner_link_device(partner, port->usb2_dev);
924 typec_partner_link_device(partner, port->usb3_dev);
928 EXPORT_SYMBOL_GPL(typec_register_partner);
931 * typec_unregister_partner - Unregister a USB Type-C Partner
932 * @partner: The partner to be unregistered
934 * Unregister device created with typec_register_partner().
936 void typec_unregister_partner(struct typec_partner *partner)
938 struct typec_port *port;
940 if (IS_ERR_OR_NULL(partner))
943 port = to_typec_port(partner->dev.parent);
946 typec_partner_unlink_device(partner, port->usb2_dev);
948 typec_partner_unlink_device(partner, port->usb3_dev);
950 device_unregister(&partner->dev);
952 EXPORT_SYMBOL_GPL(typec_unregister_partner);
954 /* ------------------------------------------------------------------------- */
955 /* Type-C Cable Plugs */
957 static void typec_plug_release(struct device *dev)
959 struct typec_plug *plug = to_typec_plug(dev);
961 ida_destroy(&plug->mode_ids);
965 static struct attribute *typec_plug_attrs[] = {
966 &dev_attr_number_of_alternate_modes.attr,
970 static umode_t typec_plug_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
972 struct typec_plug *plug = to_typec_plug(kobj_to_dev(kobj));
974 if (attr == &dev_attr_number_of_alternate_modes.attr) {
975 if (plug->num_altmodes < 0)
982 static const struct attribute_group typec_plug_group = {
983 .is_visible = typec_plug_attr_is_visible,
984 .attrs = typec_plug_attrs
987 static const struct attribute_group *typec_plug_groups[] = {
992 const struct device_type typec_plug_dev_type = {
993 .name = "typec_plug",
994 .groups = typec_plug_groups,
995 .release = typec_plug_release,
999 * typec_plug_set_num_altmodes - Set the number of available plug altmodes
1000 * @plug: The plug to be updated.
1001 * @num_altmodes: The number of altmodes we want to specify as available.
1003 * This routine is used to report the number of alternate modes supported by the
1004 * plug. This value is *not* enforced in alternate mode registration routines.
1006 * @plug.num_altmodes is set to -1 on plug registration, denoting that
1007 * a valid value has not been set for it yet.
1009 * Returns 0 on success or negative error number on failure.
1011 int typec_plug_set_num_altmodes(struct typec_plug *plug, int num_altmodes)
1015 if (num_altmodes < 0)
1018 plug->num_altmodes = num_altmodes;
1019 ret = sysfs_update_group(&plug->dev.kobj, &typec_plug_group);
1023 sysfs_notify(&plug->dev.kobj, NULL, "number_of_alternate_modes");
1024 kobject_uevent(&plug->dev.kobj, KOBJ_CHANGE);
1028 EXPORT_SYMBOL_GPL(typec_plug_set_num_altmodes);
1031 * typec_plug_register_altmode - Register USB Type-C Cable Plug Alternate Mode
1032 * @plug: USB Type-C Cable Plug that supports the alternate mode
1033 * @desc: Description of the alternate mode
1035 * This routine is used to register each alternate mode individually that @plug
1036 * has listed in response to Discover SVIDs command. The modes for a SVID that
1037 * the plug lists in response to Discover Modes command need to be listed in an
1040 * Returns handle to the alternate mode on success or ERR_PTR on failure.
1042 struct typec_altmode *
1043 typec_plug_register_altmode(struct typec_plug *plug,
1044 const struct typec_altmode_desc *desc)
1046 return typec_register_altmode(&plug->dev, desc);
1048 EXPORT_SYMBOL_GPL(typec_plug_register_altmode);
1051 * typec_register_plug - Register a USB Type-C Cable Plug
1052 * @cable: USB Type-C Cable with the plug
1053 * @desc: Description of the cable plug
1055 * Registers a device for USB Type-C Cable Plug described in @desc. A USB Type-C
1056 * Cable Plug represents a plug with electronics in it that can response to USB
1057 * Power Delivery SOP Prime or SOP Double Prime packages.
1059 * Returns handle to the cable plug on success or ERR_PTR on failure.
1061 struct typec_plug *typec_register_plug(struct typec_cable *cable,
1062 struct typec_plug_desc *desc)
1064 struct typec_plug *plug;
1068 plug = kzalloc(sizeof(*plug), GFP_KERNEL);
1070 return ERR_PTR(-ENOMEM);
1072 sprintf(name, "plug%d", desc->index);
1074 ida_init(&plug->mode_ids);
1075 plug->num_altmodes = -1;
1076 plug->index = desc->index;
1077 plug->dev.class = &typec_class;
1078 plug->dev.parent = &cable->dev;
1079 plug->dev.type = &typec_plug_dev_type;
1080 dev_set_name(&plug->dev, "%s-%s", dev_name(cable->dev.parent), name);
1082 ret = device_register(&plug->dev);
1084 dev_err(&cable->dev, "failed to register plug (%d)\n", ret);
1085 put_device(&plug->dev);
1086 return ERR_PTR(ret);
1091 EXPORT_SYMBOL_GPL(typec_register_plug);
1094 * typec_unregister_plug - Unregister a USB Type-C Cable Plug
1095 * @plug: The cable plug to be unregistered
1097 * Unregister device created with typec_register_plug().
1099 void typec_unregister_plug(struct typec_plug *plug)
1101 if (!IS_ERR_OR_NULL(plug))
1102 device_unregister(&plug->dev);
1104 EXPORT_SYMBOL_GPL(typec_unregister_plug);
1108 static const char * const typec_plug_types[] = {
1109 [USB_PLUG_NONE] = "unknown",
1110 [USB_PLUG_TYPE_A] = "type-a",
1111 [USB_PLUG_TYPE_B] = "type-b",
1112 [USB_PLUG_TYPE_C] = "type-c",
1113 [USB_PLUG_CAPTIVE] = "captive",
1116 static ssize_t plug_type_show(struct device *dev,
1117 struct device_attribute *attr, char *buf)
1119 struct typec_cable *cable = to_typec_cable(dev);
1121 return sprintf(buf, "%s\n", typec_plug_types[cable->type]);
1123 static DEVICE_ATTR_RO(plug_type);
1125 static struct attribute *typec_cable_attrs[] = {
1126 &dev_attr_type.attr,
1127 &dev_attr_plug_type.attr,
1128 &dev_attr_usb_power_delivery_revision.attr,
1131 ATTRIBUTE_GROUPS(typec_cable);
1133 static void typec_cable_release(struct device *dev)
1135 struct typec_cable *cable = to_typec_cable(dev);
1140 const struct device_type typec_cable_dev_type = {
1141 .name = "typec_cable",
1142 .groups = typec_cable_groups,
1143 .release = typec_cable_release,
1146 static int cable_match(struct device *dev, void *data)
1148 return is_typec_cable(dev);
1152 * typec_cable_get - Get a reference to the USB Type-C cable
1153 * @port: The USB Type-C Port the cable is connected to
1155 * The caller must decrement the reference count with typec_cable_put() after
1158 struct typec_cable *typec_cable_get(struct typec_port *port)
1162 dev = device_find_child(&port->dev, NULL, cable_match);
1166 return to_typec_cable(dev);
1168 EXPORT_SYMBOL_GPL(typec_cable_get);
1171 * typec_cable_put - Decrement the reference count on USB Type-C cable
1172 * @cable: The USB Type-C cable
1174 void typec_cable_put(struct typec_cable *cable)
1176 put_device(&cable->dev);
1178 EXPORT_SYMBOL_GPL(typec_cable_put);
1181 * typec_cable_is_active - Check is the USB Type-C cable active or passive
1182 * @cable: The USB Type-C Cable
1184 * Return 1 if the cable is active or 0 if it's passive.
1186 int typec_cable_is_active(struct typec_cable *cable)
1188 return cable->active;
1190 EXPORT_SYMBOL_GPL(typec_cable_is_active);
1193 * typec_cable_set_identity - Report result from Discover Identity command
1194 * @cable: The cable updated identity values
1196 * This routine is used to report that the result of Discover Identity USB power
1197 * delivery command has become available.
1199 int typec_cable_set_identity(struct typec_cable *cable)
1201 if (!cable->identity)
1204 typec_report_identity(&cable->dev);
1207 EXPORT_SYMBOL_GPL(typec_cable_set_identity);
1210 * typec_register_cable - Register a USB Type-C Cable
1211 * @port: The USB Type-C Port the cable is connected to
1212 * @desc: Description of the cable
1214 * Registers a device for USB Type-C Cable described in @desc. The cable will be
1215 * parent for the optional cable plug devises.
1217 * Returns handle to the cable on success or ERR_PTR on failure.
1219 struct typec_cable *typec_register_cable(struct typec_port *port,
1220 struct typec_cable_desc *desc)
1222 struct typec_cable *cable;
1225 cable = kzalloc(sizeof(*cable), GFP_KERNEL);
1227 return ERR_PTR(-ENOMEM);
1229 cable->type = desc->type;
1230 cable->active = desc->active;
1231 cable->pd_revision = desc->pd_revision;
1233 if (desc->identity) {
1235 * Creating directory for the identity only if the driver is
1236 * able to provide data to it.
1238 cable->dev.groups = usb_pd_id_groups;
1239 cable->identity = desc->identity;
1242 cable->dev.class = &typec_class;
1243 cable->dev.parent = &port->dev;
1244 cable->dev.type = &typec_cable_dev_type;
1245 dev_set_name(&cable->dev, "%s-cable", dev_name(&port->dev));
1247 ret = device_register(&cable->dev);
1249 dev_err(&port->dev, "failed to register cable (%d)\n", ret);
1250 put_device(&cable->dev);
1251 return ERR_PTR(ret);
1256 EXPORT_SYMBOL_GPL(typec_register_cable);
1259 * typec_unregister_cable - Unregister a USB Type-C Cable
1260 * @cable: The cable to be unregistered
1262 * Unregister device created with typec_register_cable().
1264 void typec_unregister_cable(struct typec_cable *cable)
1266 if (!IS_ERR_OR_NULL(cable))
1267 device_unregister(&cable->dev);
1269 EXPORT_SYMBOL_GPL(typec_unregister_cable);
1271 /* ------------------------------------------------------------------------- */
1272 /* USB Type-C ports */
1275 * typec_port_set_usb_power_delivery - Assign USB PD for port.
1276 * @port: USB Type-C port.
1277 * @pd: USB PD instance.
1279 * This routine can be used to set the USB Power Delivery Capabilities for @port
1280 * that it will advertise to the partner.
1282 * If @pd is NULL, the assignment is removed.
1284 int typec_port_set_usb_power_delivery(struct typec_port *port, struct usb_power_delivery *pd)
1288 if (IS_ERR_OR_NULL(port) || port->pd == pd)
1292 ret = usb_power_delivery_link_device(pd, &port->dev);
1296 usb_power_delivery_unlink_device(port->pd, &port->dev);
1303 EXPORT_SYMBOL_GPL(typec_port_set_usb_power_delivery);
1305 static ssize_t select_usb_power_delivery_store(struct device *dev,
1306 struct device_attribute *attr,
1307 const char *buf, size_t size)
1309 struct typec_port *port = to_typec_port(dev);
1310 struct usb_power_delivery *pd;
1312 if (!port->ops || !port->ops->pd_set)
1315 pd = usb_power_delivery_find(buf);
1319 return port->ops->pd_set(port, pd);
1322 static ssize_t select_usb_power_delivery_show(struct device *dev,
1323 struct device_attribute *attr, char *buf)
1325 struct typec_port *port = to_typec_port(dev);
1326 struct usb_power_delivery **pds;
1329 if (!port->ops || !port->ops->pd_get)
1332 pds = port->ops->pd_get(port);
1336 for (i = 0; pds[i]; i++) {
1337 if (pds[i] == port->pd)
1338 ret += sysfs_emit_at(buf, ret, "[%s] ", dev_name(&pds[i]->dev));
1340 ret += sysfs_emit_at(buf, ret, "%s ", dev_name(&pds[i]->dev));
1343 buf[ret - 1] = '\n';
1347 static DEVICE_ATTR_RW(select_usb_power_delivery);
1349 static struct attribute *port_attrs[] = {
1350 &dev_attr_select_usb_power_delivery.attr,
1354 static umode_t port_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
1356 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1358 if (!port->pd || !port->ops || !port->ops->pd_get)
1360 if (!port->ops->pd_set)
1366 static const struct attribute_group pd_group = {
1367 .is_visible = port_attr_is_visible,
1368 .attrs = port_attrs,
1371 static const char * const typec_orientations[] = {
1372 [TYPEC_ORIENTATION_NONE] = "unknown",
1373 [TYPEC_ORIENTATION_NORMAL] = "normal",
1374 [TYPEC_ORIENTATION_REVERSE] = "reverse",
1377 static const char * const typec_roles[] = {
1378 [TYPEC_SINK] = "sink",
1379 [TYPEC_SOURCE] = "source",
1382 static const char * const typec_data_roles[] = {
1383 [TYPEC_DEVICE] = "device",
1384 [TYPEC_HOST] = "host",
1387 static const char * const typec_port_power_roles[] = {
1388 [TYPEC_PORT_SRC] = "source",
1389 [TYPEC_PORT_SNK] = "sink",
1390 [TYPEC_PORT_DRP] = "dual",
1393 static const char * const typec_port_data_roles[] = {
1394 [TYPEC_PORT_DFP] = "host",
1395 [TYPEC_PORT_UFP] = "device",
1396 [TYPEC_PORT_DRD] = "dual",
1399 static const char * const typec_port_types_drp[] = {
1400 [TYPEC_PORT_SRC] = "dual [source] sink",
1401 [TYPEC_PORT_SNK] = "dual source [sink]",
1402 [TYPEC_PORT_DRP] = "[dual] source sink",
1406 preferred_role_store(struct device *dev, struct device_attribute *attr,
1407 const char *buf, size_t size)
1409 struct typec_port *port = to_typec_port(dev);
1413 if (port->cap->type != TYPEC_PORT_DRP) {
1414 dev_dbg(dev, "Preferred role only supported with DRP ports\n");
1418 if (!port->ops || !port->ops->try_role) {
1419 dev_dbg(dev, "Setting preferred role not supported\n");
1423 role = sysfs_match_string(typec_roles, buf);
1425 if (sysfs_streq(buf, "none"))
1426 role = TYPEC_NO_PREFERRED_ROLE;
1431 ret = port->ops->try_role(port, role);
1435 port->prefer_role = role;
1440 preferred_role_show(struct device *dev, struct device_attribute *attr,
1443 struct typec_port *port = to_typec_port(dev);
1445 if (port->cap->type != TYPEC_PORT_DRP)
1448 if (port->prefer_role < 0)
1451 return sprintf(buf, "%s\n", typec_roles[port->prefer_role]);
1453 static DEVICE_ATTR_RW(preferred_role);
1455 static ssize_t data_role_store(struct device *dev,
1456 struct device_attribute *attr,
1457 const char *buf, size_t size)
1459 struct typec_port *port = to_typec_port(dev);
1462 if (!port->ops || !port->ops->dr_set) {
1463 dev_dbg(dev, "data role swapping not supported\n");
1467 ret = sysfs_match_string(typec_data_roles, buf);
1471 mutex_lock(&port->port_type_lock);
1472 if (port->cap->data != TYPEC_PORT_DRD) {
1474 goto unlock_and_ret;
1477 ret = port->ops->dr_set(port, ret);
1479 goto unlock_and_ret;
1483 mutex_unlock(&port->port_type_lock);
1487 static ssize_t data_role_show(struct device *dev,
1488 struct device_attribute *attr, char *buf)
1490 struct typec_port *port = to_typec_port(dev);
1492 if (port->cap->data == TYPEC_PORT_DRD)
1493 return sprintf(buf, "%s\n", port->data_role == TYPEC_HOST ?
1494 "[host] device" : "host [device]");
1496 return sprintf(buf, "[%s]\n", typec_data_roles[port->data_role]);
1498 static DEVICE_ATTR_RW(data_role);
1500 static ssize_t power_role_store(struct device *dev,
1501 struct device_attribute *attr,
1502 const char *buf, size_t size)
1504 struct typec_port *port = to_typec_port(dev);
1507 if (!port->ops || !port->ops->pr_set) {
1508 dev_dbg(dev, "power role swapping not supported\n");
1512 if (port->pwr_opmode != TYPEC_PWR_MODE_PD) {
1513 dev_dbg(dev, "partner unable to swap power role\n");
1517 ret = sysfs_match_string(typec_roles, buf);
1521 mutex_lock(&port->port_type_lock);
1522 if (port->port_type != TYPEC_PORT_DRP) {
1523 dev_dbg(dev, "port type fixed at \"%s\"",
1524 typec_port_power_roles[port->port_type]);
1526 goto unlock_and_ret;
1529 ret = port->ops->pr_set(port, ret);
1531 goto unlock_and_ret;
1535 mutex_unlock(&port->port_type_lock);
1539 static ssize_t power_role_show(struct device *dev,
1540 struct device_attribute *attr, char *buf)
1542 struct typec_port *port = to_typec_port(dev);
1544 if (port->cap->type == TYPEC_PORT_DRP)
1545 return sprintf(buf, "%s\n", port->pwr_role == TYPEC_SOURCE ?
1546 "[source] sink" : "source [sink]");
1548 return sprintf(buf, "[%s]\n", typec_roles[port->pwr_role]);
1550 static DEVICE_ATTR_RW(power_role);
1553 port_type_store(struct device *dev, struct device_attribute *attr,
1554 const char *buf, size_t size)
1556 struct typec_port *port = to_typec_port(dev);
1558 enum typec_port_type type;
1560 if (port->cap->type != TYPEC_PORT_DRP ||
1561 !port->ops || !port->ops->port_type_set) {
1562 dev_dbg(dev, "changing port type not supported\n");
1566 ret = sysfs_match_string(typec_port_power_roles, buf);
1571 mutex_lock(&port->port_type_lock);
1573 if (port->port_type == type) {
1575 goto unlock_and_ret;
1578 ret = port->ops->port_type_set(port, type);
1580 goto unlock_and_ret;
1582 port->port_type = type;
1586 mutex_unlock(&port->port_type_lock);
1591 port_type_show(struct device *dev, struct device_attribute *attr,
1594 struct typec_port *port = to_typec_port(dev);
1596 if (port->cap->type == TYPEC_PORT_DRP)
1597 return sprintf(buf, "%s\n",
1598 typec_port_types_drp[port->port_type]);
1600 return sprintf(buf, "[%s]\n", typec_port_power_roles[port->cap->type]);
1602 static DEVICE_ATTR_RW(port_type);
1604 static const char * const typec_pwr_opmodes[] = {
1605 [TYPEC_PWR_MODE_USB] = "default",
1606 [TYPEC_PWR_MODE_1_5A] = "1.5A",
1607 [TYPEC_PWR_MODE_3_0A] = "3.0A",
1608 [TYPEC_PWR_MODE_PD] = "usb_power_delivery",
1611 static ssize_t power_operation_mode_show(struct device *dev,
1612 struct device_attribute *attr,
1615 struct typec_port *port = to_typec_port(dev);
1617 return sprintf(buf, "%s\n", typec_pwr_opmodes[port->pwr_opmode]);
1619 static DEVICE_ATTR_RO(power_operation_mode);
1621 static ssize_t vconn_source_store(struct device *dev,
1622 struct device_attribute *attr,
1623 const char *buf, size_t size)
1625 struct typec_port *port = to_typec_port(dev);
1629 if (!port->cap->pd_revision) {
1630 dev_dbg(dev, "VCONN swap depends on USB Power Delivery\n");
1634 if (!port->ops || !port->ops->vconn_set) {
1635 dev_dbg(dev, "VCONN swapping not supported\n");
1639 ret = kstrtobool(buf, &source);
1643 ret = port->ops->vconn_set(port, (enum typec_role)source);
1650 static ssize_t vconn_source_show(struct device *dev,
1651 struct device_attribute *attr, char *buf)
1653 struct typec_port *port = to_typec_port(dev);
1655 return sprintf(buf, "%s\n",
1656 port->vconn_role == TYPEC_SOURCE ? "yes" : "no");
1658 static DEVICE_ATTR_RW(vconn_source);
1660 static ssize_t supported_accessory_modes_show(struct device *dev,
1661 struct device_attribute *attr,
1664 struct typec_port *port = to_typec_port(dev);
1668 for (i = 0; i < ARRAY_SIZE(port->cap->accessory); i++) {
1669 if (port->cap->accessory[i])
1670 ret += sprintf(buf + ret, "%s ",
1671 typec_accessory_modes[port->cap->accessory[i]]);
1675 return sprintf(buf, "none\n");
1677 buf[ret - 1] = '\n';
1681 static DEVICE_ATTR_RO(supported_accessory_modes);
1683 static ssize_t usb_typec_revision_show(struct device *dev,
1684 struct device_attribute *attr,
1687 struct typec_port *port = to_typec_port(dev);
1688 u16 rev = port->cap->revision;
1690 return sprintf(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1692 static DEVICE_ATTR_RO(usb_typec_revision);
1694 static ssize_t usb_power_delivery_revision_show(struct device *dev,
1695 struct device_attribute *attr,
1700 if (is_typec_partner(dev)) {
1701 struct typec_partner *partner = to_typec_partner(dev);
1703 rev = partner->pd_revision;
1704 } else if (is_typec_cable(dev)) {
1705 struct typec_cable *cable = to_typec_cable(dev);
1707 rev = cable->pd_revision;
1708 } else if (is_typec_port(dev)) {
1709 struct typec_port *p = to_typec_port(dev);
1711 rev = p->cap->pd_revision;
1713 return sysfs_emit(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1716 static ssize_t orientation_show(struct device *dev,
1717 struct device_attribute *attr,
1720 struct typec_port *port = to_typec_port(dev);
1722 return sprintf(buf, "%s\n", typec_orientations[port->orientation]);
1724 static DEVICE_ATTR_RO(orientation);
1726 static struct attribute *typec_attrs[] = {
1727 &dev_attr_data_role.attr,
1728 &dev_attr_power_operation_mode.attr,
1729 &dev_attr_power_role.attr,
1730 &dev_attr_preferred_role.attr,
1731 &dev_attr_supported_accessory_modes.attr,
1732 &dev_attr_usb_power_delivery_revision.attr,
1733 &dev_attr_usb_typec_revision.attr,
1734 &dev_attr_vconn_source.attr,
1735 &dev_attr_port_type.attr,
1736 &dev_attr_orientation.attr,
1740 static umode_t typec_attr_is_visible(struct kobject *kobj,
1741 struct attribute *attr, int n)
1743 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1745 if (attr == &dev_attr_data_role.attr) {
1746 if (port->cap->data != TYPEC_PORT_DRD ||
1747 !port->ops || !port->ops->dr_set)
1749 } else if (attr == &dev_attr_power_role.attr) {
1750 if (port->cap->type != TYPEC_PORT_DRP ||
1751 !port->ops || !port->ops->pr_set)
1753 } else if (attr == &dev_attr_vconn_source.attr) {
1754 if (!port->cap->pd_revision ||
1755 !port->ops || !port->ops->vconn_set)
1757 } else if (attr == &dev_attr_preferred_role.attr) {
1758 if (port->cap->type != TYPEC_PORT_DRP ||
1759 !port->ops || !port->ops->try_role)
1761 } else if (attr == &dev_attr_port_type.attr) {
1762 if (!port->ops || !port->ops->port_type_set)
1764 if (port->cap->type != TYPEC_PORT_DRP)
1766 } else if (attr == &dev_attr_orientation.attr) {
1767 if (port->cap->orientation_aware)
1775 static const struct attribute_group typec_group = {
1776 .is_visible = typec_attr_is_visible,
1777 .attrs = typec_attrs,
1780 static const struct attribute_group *typec_groups[] = {
1786 static int typec_uevent(const struct device *dev, struct kobj_uevent_env *env)
1790 ret = add_uevent_var(env, "TYPEC_PORT=%s", dev_name(dev));
1792 dev_err(dev, "failed to add uevent TYPEC_PORT\n");
1797 static void typec_release(struct device *dev)
1799 struct typec_port *port = to_typec_port(dev);
1801 ida_simple_remove(&typec_index_ida, port->id);
1802 ida_destroy(&port->mode_ids);
1803 typec_switch_put(port->sw);
1804 typec_mux_put(port->mux);
1805 typec_retimer_put(port->retimer);
1810 const struct device_type typec_port_dev_type = {
1811 .name = "typec_port",
1812 .groups = typec_groups,
1813 .uevent = typec_uevent,
1814 .release = typec_release,
1817 /* --------------------------------------- */
1818 /* Driver callbacks to report role updates */
1820 static int partner_match(struct device *dev, void *data)
1822 return is_typec_partner(dev);
1825 static struct typec_partner *typec_get_partner(struct typec_port *port)
1829 dev = device_find_child(&port->dev, NULL, partner_match);
1833 return to_typec_partner(dev);
1836 static void typec_partner_attach(struct typec_connector *con, struct device *dev)
1838 struct typec_port *port = container_of(con, struct typec_port, con);
1839 struct typec_partner *partner = typec_get_partner(port);
1840 struct usb_device *udev = to_usb_device(dev);
1842 if (udev->speed < USB_SPEED_SUPER)
1843 port->usb2_dev = dev;
1845 port->usb3_dev = dev;
1848 typec_partner_link_device(partner, dev);
1849 put_device(&partner->dev);
1853 static void typec_partner_deattach(struct typec_connector *con, struct device *dev)
1855 struct typec_port *port = container_of(con, struct typec_port, con);
1856 struct typec_partner *partner = typec_get_partner(port);
1859 typec_partner_unlink_device(partner, dev);
1860 put_device(&partner->dev);
1863 if (port->usb2_dev == dev)
1864 port->usb2_dev = NULL;
1865 else if (port->usb3_dev == dev)
1866 port->usb3_dev = NULL;
1870 * typec_set_data_role - Report data role change
1871 * @port: The USB Type-C Port where the role was changed
1872 * @role: The new data role
1874 * This routine is used by the port drivers to report data role changes.
1876 void typec_set_data_role(struct typec_port *port, enum typec_data_role role)
1878 struct typec_partner *partner;
1880 if (port->data_role == role)
1883 port->data_role = role;
1884 sysfs_notify(&port->dev.kobj, NULL, "data_role");
1885 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1887 partner = typec_get_partner(port);
1891 if (partner->identity)
1892 typec_product_type_notify(&partner->dev);
1894 put_device(&partner->dev);
1896 EXPORT_SYMBOL_GPL(typec_set_data_role);
1899 * typec_set_pwr_role - Report power role change
1900 * @port: The USB Type-C Port where the role was changed
1901 * @role: The new data role
1903 * This routine is used by the port drivers to report power role changes.
1905 void typec_set_pwr_role(struct typec_port *port, enum typec_role role)
1907 if (port->pwr_role == role)
1910 port->pwr_role = role;
1911 sysfs_notify(&port->dev.kobj, NULL, "power_role");
1912 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1914 EXPORT_SYMBOL_GPL(typec_set_pwr_role);
1917 * typec_set_vconn_role - Report VCONN source change
1918 * @port: The USB Type-C Port which VCONN role changed
1919 * @role: Source when @port is sourcing VCONN, or Sink when it's not
1921 * This routine is used by the port drivers to report if the VCONN source is
1924 void typec_set_vconn_role(struct typec_port *port, enum typec_role role)
1926 if (port->vconn_role == role)
1929 port->vconn_role = role;
1930 sysfs_notify(&port->dev.kobj, NULL, "vconn_source");
1931 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1933 EXPORT_SYMBOL_GPL(typec_set_vconn_role);
1936 * typec_set_pwr_opmode - Report changed power operation mode
1937 * @port: The USB Type-C Port where the mode was changed
1938 * @opmode: New power operation mode
1940 * This routine is used by the port drivers to report changed power operation
1941 * mode in @port. The modes are USB (default), 1.5A, 3.0A as defined in USB
1942 * Type-C specification, and "USB Power Delivery" when the power levels are
1943 * negotiated with methods defined in USB Power Delivery specification.
1945 void typec_set_pwr_opmode(struct typec_port *port,
1946 enum typec_pwr_opmode opmode)
1948 struct device *partner_dev;
1950 if (port->pwr_opmode == opmode)
1953 port->pwr_opmode = opmode;
1954 sysfs_notify(&port->dev.kobj, NULL, "power_operation_mode");
1955 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1957 partner_dev = device_find_child(&port->dev, NULL, partner_match);
1959 struct typec_partner *partner = to_typec_partner(partner_dev);
1961 if (opmode == TYPEC_PWR_MODE_PD && !partner->usb_pd) {
1962 partner->usb_pd = 1;
1963 sysfs_notify(&partner_dev->kobj, NULL,
1964 "supports_usb_power_delivery");
1965 kobject_uevent(&partner_dev->kobj, KOBJ_CHANGE);
1967 put_device(partner_dev);
1970 EXPORT_SYMBOL_GPL(typec_set_pwr_opmode);
1973 * typec_find_pwr_opmode - Get the typec power operation mode capability
1974 * @name: power operation mode string
1976 * This routine is used to find the typec_pwr_opmode by its string @name.
1978 * Returns typec_pwr_opmode if success, otherwise negative error code.
1980 int typec_find_pwr_opmode(const char *name)
1982 return match_string(typec_pwr_opmodes,
1983 ARRAY_SIZE(typec_pwr_opmodes), name);
1985 EXPORT_SYMBOL_GPL(typec_find_pwr_opmode);
1988 * typec_find_orientation - Convert orientation string to enum typec_orientation
1989 * @name: Orientation string
1991 * This routine is used to find the typec_orientation by its string name @name.
1993 * Returns the orientation value on success, otherwise negative error code.
1995 int typec_find_orientation(const char *name)
1997 return match_string(typec_orientations, ARRAY_SIZE(typec_orientations),
2000 EXPORT_SYMBOL_GPL(typec_find_orientation);
2003 * typec_find_port_power_role - Get the typec port power capability
2004 * @name: port power capability string
2006 * This routine is used to find the typec_port_type by its string name.
2008 * Returns typec_port_type if success, otherwise negative error code.
2010 int typec_find_port_power_role(const char *name)
2012 return match_string(typec_port_power_roles,
2013 ARRAY_SIZE(typec_port_power_roles), name);
2015 EXPORT_SYMBOL_GPL(typec_find_port_power_role);
2018 * typec_find_power_role - Find the typec one specific power role
2019 * @name: power role string
2021 * This routine is used to find the typec_role by its string name.
2023 * Returns typec_role if success, otherwise negative error code.
2025 int typec_find_power_role(const char *name)
2027 return match_string(typec_roles, ARRAY_SIZE(typec_roles), name);
2029 EXPORT_SYMBOL_GPL(typec_find_power_role);
2032 * typec_find_port_data_role - Get the typec port data capability
2033 * @name: port data capability string
2035 * This routine is used to find the typec_port_data by its string name.
2037 * Returns typec_port_data if success, otherwise negative error code.
2039 int typec_find_port_data_role(const char *name)
2041 return match_string(typec_port_data_roles,
2042 ARRAY_SIZE(typec_port_data_roles), name);
2044 EXPORT_SYMBOL_GPL(typec_find_port_data_role);
2046 /* ------------------------------------------ */
2047 /* API for Multiplexer/DeMultiplexer Switches */
2050 * typec_set_orientation - Set USB Type-C cable plug orientation
2051 * @port: USB Type-C Port
2052 * @orientation: USB Type-C cable plug orientation
2054 * Set cable plug orientation for @port.
2056 int typec_set_orientation(struct typec_port *port,
2057 enum typec_orientation orientation)
2061 ret = typec_switch_set(port->sw, orientation);
2065 port->orientation = orientation;
2066 sysfs_notify(&port->dev.kobj, NULL, "orientation");
2067 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
2071 EXPORT_SYMBOL_GPL(typec_set_orientation);
2074 * typec_get_orientation - Get USB Type-C cable plug orientation
2075 * @port: USB Type-C Port
2077 * Get current cable plug orientation for @port.
2079 enum typec_orientation typec_get_orientation(struct typec_port *port)
2081 return port->orientation;
2083 EXPORT_SYMBOL_GPL(typec_get_orientation);
2086 * typec_set_mode - Set mode of operation for USB Type-C connector
2087 * @port: USB Type-C connector
2088 * @mode: Accessory Mode, USB Operation or Safe State
2090 * Configure @port for Accessory Mode @mode. This function will configure the
2091 * muxes needed for @mode.
2093 int typec_set_mode(struct typec_port *port, int mode)
2095 struct typec_mux_state state = { };
2099 return typec_mux_set(port->mux, &state);
2101 EXPORT_SYMBOL_GPL(typec_set_mode);
2103 /* --------------------------------------- */
2106 * typec_get_negotiated_svdm_version - Get negotiated SVDM Version
2107 * @port: USB Type-C Port.
2109 * Get the negotiated SVDM Version. The Version is set to the port default
2110 * value stored in typec_capability on partner registration, and updated after
2111 * a successful Discover Identity if the negotiated value is less than the
2114 * Returns usb_pd_svdm_ver if the partner has been registered otherwise -ENODEV.
2116 int typec_get_negotiated_svdm_version(struct typec_port *port)
2118 enum usb_pd_svdm_ver svdm_version;
2119 struct device *partner_dev;
2121 partner_dev = device_find_child(&port->dev, NULL, partner_match);
2125 svdm_version = to_typec_partner(partner_dev)->svdm_version;
2126 put_device(partner_dev);
2128 return svdm_version;
2130 EXPORT_SYMBOL_GPL(typec_get_negotiated_svdm_version);
2133 * typec_get_drvdata - Return private driver data pointer
2134 * @port: USB Type-C port
2136 void *typec_get_drvdata(struct typec_port *port)
2138 return dev_get_drvdata(&port->dev);
2140 EXPORT_SYMBOL_GPL(typec_get_drvdata);
2142 int typec_get_fw_cap(struct typec_capability *cap,
2143 struct fwnode_handle *fwnode)
2145 const char *cap_str;
2148 cap->fwnode = fwnode;
2150 ret = fwnode_property_read_string(fwnode, "power-role", &cap_str);
2154 ret = typec_find_port_power_role(cap_str);
2159 /* USB data support is optional */
2160 ret = fwnode_property_read_string(fwnode, "data-role", &cap_str);
2162 ret = typec_find_port_data_role(cap_str);
2168 /* Get the preferred power role for a DRP */
2169 if (cap->type == TYPEC_PORT_DRP) {
2170 cap->prefer_role = TYPEC_NO_PREFERRED_ROLE;
2172 ret = fwnode_property_read_string(fwnode, "try-power-role", &cap_str);
2174 ret = typec_find_power_role(cap_str);
2177 cap->prefer_role = ret;
2183 EXPORT_SYMBOL_GPL(typec_get_fw_cap);
2186 * typec_port_register_altmode - Register USB Type-C Port Alternate Mode
2187 * @port: USB Type-C Port that supports the alternate mode
2188 * @desc: Description of the alternate mode
2190 * This routine is used to register an alternate mode that @port is capable of
2193 * Returns handle to the alternate mode on success or ERR_PTR on failure.
2195 struct typec_altmode *
2196 typec_port_register_altmode(struct typec_port *port,
2197 const struct typec_altmode_desc *desc)
2199 struct typec_altmode *adev;
2200 struct typec_mux *mux;
2201 struct typec_retimer *retimer;
2203 mux = typec_mux_get(&port->dev);
2205 return ERR_CAST(mux);
2207 retimer = typec_retimer_get(&port->dev);
2208 if (IS_ERR(retimer)) {
2210 return ERR_CAST(retimer);
2213 adev = typec_register_altmode(&port->dev, desc);
2215 typec_retimer_put(retimer);
2218 to_altmode(adev)->mux = mux;
2219 to_altmode(adev)->retimer = retimer;
2224 EXPORT_SYMBOL_GPL(typec_port_register_altmode);
2226 void typec_port_register_altmodes(struct typec_port *port,
2227 const struct typec_altmode_ops *ops, void *drvdata,
2228 struct typec_altmode **altmodes, size_t n)
2230 struct fwnode_handle *altmodes_node, *child;
2231 struct typec_altmode_desc desc;
2232 struct typec_altmode *alt;
2237 altmodes_node = device_get_named_child_node(&port->dev, "altmodes");
2239 return; /* No altmodes specified */
2241 fwnode_for_each_child_node(altmodes_node, child) {
2242 ret = fwnode_property_read_u32(child, "svid", &svid);
2244 dev_err(&port->dev, "Error reading svid for altmode %s\n",
2245 fwnode_get_name(child));
2249 ret = fwnode_property_read_u32(child, "vdo", &vdo);
2251 dev_err(&port->dev, "Error reading vdo for altmode %s\n",
2252 fwnode_get_name(child));
2257 dev_err(&port->dev, "Error not enough space for altmode %s\n",
2258 fwnode_get_name(child));
2264 desc.mode = index + 1;
2265 alt = typec_port_register_altmode(port, &desc);
2267 dev_err(&port->dev, "Error registering altmode %s\n",
2268 fwnode_get_name(child));
2273 typec_altmode_set_drvdata(alt, drvdata);
2274 altmodes[index] = alt;
2278 EXPORT_SYMBOL_GPL(typec_port_register_altmodes);
2281 * typec_register_port - Register a USB Type-C Port
2282 * @parent: Parent device
2283 * @cap: Description of the port
2285 * Registers a device for USB Type-C Port described in @cap.
2287 * Returns handle to the port on success or ERR_PTR on failure.
2289 struct typec_port *typec_register_port(struct device *parent,
2290 const struct typec_capability *cap)
2292 struct typec_port *port;
2296 port = kzalloc(sizeof(*port), GFP_KERNEL);
2298 return ERR_PTR(-ENOMEM);
2300 id = ida_simple_get(&typec_index_ida, 0, 0, GFP_KERNEL);
2306 switch (cap->type) {
2307 case TYPEC_PORT_SRC:
2308 port->pwr_role = TYPEC_SOURCE;
2309 port->vconn_role = TYPEC_SOURCE;
2311 case TYPEC_PORT_SNK:
2312 port->pwr_role = TYPEC_SINK;
2313 port->vconn_role = TYPEC_SINK;
2315 case TYPEC_PORT_DRP:
2316 if (cap->prefer_role != TYPEC_NO_PREFERRED_ROLE)
2317 port->pwr_role = cap->prefer_role;
2319 port->pwr_role = TYPEC_SINK;
2323 switch (cap->data) {
2324 case TYPEC_PORT_DFP:
2325 port->data_role = TYPEC_HOST;
2327 case TYPEC_PORT_UFP:
2328 port->data_role = TYPEC_DEVICE;
2330 case TYPEC_PORT_DRD:
2331 if (cap->prefer_role == TYPEC_SOURCE)
2332 port->data_role = TYPEC_HOST;
2334 port->data_role = TYPEC_DEVICE;
2338 ida_init(&port->mode_ids);
2339 mutex_init(&port->port_type_lock);
2342 port->ops = cap->ops;
2343 port->port_type = cap->type;
2344 port->prefer_role = cap->prefer_role;
2345 port->con.attach = typec_partner_attach;
2346 port->con.deattach = typec_partner_deattach;
2348 device_initialize(&port->dev);
2349 port->dev.class = &typec_class;
2350 port->dev.parent = parent;
2351 port->dev.fwnode = cap->fwnode;
2352 port->dev.type = &typec_port_dev_type;
2353 dev_set_name(&port->dev, "port%d", id);
2354 dev_set_drvdata(&port->dev, cap->driver_data);
2356 port->cap = kmemdup(cap, sizeof(*cap), GFP_KERNEL);
2358 put_device(&port->dev);
2359 return ERR_PTR(-ENOMEM);
2362 port->sw = typec_switch_get(&port->dev);
2363 if (IS_ERR(port->sw)) {
2364 ret = PTR_ERR(port->sw);
2365 put_device(&port->dev);
2366 return ERR_PTR(ret);
2369 port->mux = typec_mux_get(&port->dev);
2370 if (IS_ERR(port->mux)) {
2371 ret = PTR_ERR(port->mux);
2372 put_device(&port->dev);
2373 return ERR_PTR(ret);
2376 port->retimer = typec_retimer_get(&port->dev);
2377 if (IS_ERR(port->retimer)) {
2378 ret = PTR_ERR(port->retimer);
2379 put_device(&port->dev);
2380 return ERR_PTR(ret);
2385 ret = device_add(&port->dev);
2387 dev_err(parent, "failed to register port (%d)\n", ret);
2388 put_device(&port->dev);
2389 return ERR_PTR(ret);
2392 ret = usb_power_delivery_link_device(port->pd, &port->dev);
2394 dev_err(&port->dev, "failed to link pd\n");
2395 device_unregister(&port->dev);
2396 return ERR_PTR(ret);
2399 ret = typec_link_ports(port);
2401 dev_warn(&port->dev, "failed to create symlinks (%d)\n", ret);
2405 EXPORT_SYMBOL_GPL(typec_register_port);
2408 * typec_unregister_port - Unregister a USB Type-C Port
2409 * @port: The port to be unregistered
2411 * Unregister device created with typec_register_port().
2413 void typec_unregister_port(struct typec_port *port)
2415 if (!IS_ERR_OR_NULL(port)) {
2416 typec_unlink_ports(port);
2417 typec_port_set_usb_power_delivery(port, NULL);
2418 device_unregister(&port->dev);
2421 EXPORT_SYMBOL_GPL(typec_unregister_port);
2423 static int __init typec_init(void)
2427 ret = bus_register(&typec_bus);
2431 ret = class_register(&typec_mux_class);
2433 goto err_unregister_bus;
2435 ret = class_register(&retimer_class);
2437 goto err_unregister_mux_class;
2439 ret = class_register(&typec_class);
2441 goto err_unregister_retimer_class;
2443 ret = usb_power_delivery_init();
2445 goto err_unregister_class;
2449 err_unregister_class:
2450 class_unregister(&typec_class);
2452 err_unregister_retimer_class:
2453 class_unregister(&retimer_class);
2455 err_unregister_mux_class:
2456 class_unregister(&typec_mux_class);
2459 bus_unregister(&typec_bus);
2463 subsys_initcall(typec_init);
2465 static void __exit typec_exit(void)
2467 usb_power_delivery_exit();
2468 class_unregister(&typec_class);
2469 ida_destroy(&typec_index_ida);
2470 bus_unregister(&typec_bus);
2471 class_unregister(&typec_mux_class);
2472 class_unregister(&retimer_class);
2474 module_exit(typec_exit);
2477 MODULE_LICENSE("GPL v2");
2478 MODULE_DESCRIPTION("USB Type-C Connector Class");