1 // SPDX-License-Identifier: GPL-2.0
3 * USB Type-C Connector Class
5 * Copyright (C) 2017, Intel Corporation
6 * Author: Heikki Krogerus <heikki.krogerus@linux.intel.com>
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>
21 static DEFINE_IDA(typec_index_ida);
23 struct class typec_class = {
27 /* ------------------------------------------------------------------------- */
28 /* Common attributes */
30 static const char * const typec_accessory_modes[] = {
31 [TYPEC_ACCESSORY_NONE] = "none",
32 [TYPEC_ACCESSORY_AUDIO] = "analog_audio",
33 [TYPEC_ACCESSORY_DEBUG] = "debug",
36 /* Product types defined in USB PD Specification R3.0 V2.0 */
37 static const char * const product_type_ufp[8] = {
38 [IDH_PTYPE_NOT_UFP] = "not_ufp",
39 [IDH_PTYPE_HUB] = "hub",
40 [IDH_PTYPE_PERIPH] = "peripheral",
41 [IDH_PTYPE_PSD] = "psd",
42 [IDH_PTYPE_AMA] = "ama",
45 static const char * const product_type_dfp[8] = {
46 [IDH_PTYPE_NOT_DFP] = "not_dfp",
47 [IDH_PTYPE_DFP_HUB] = "hub",
48 [IDH_PTYPE_DFP_HOST] = "host",
49 [IDH_PTYPE_DFP_PB] = "power_brick",
52 static const char * const product_type_cable[8] = {
53 [IDH_PTYPE_NOT_CABLE] = "not_cable",
54 [IDH_PTYPE_PCABLE] = "passive",
55 [IDH_PTYPE_ACABLE] = "active",
56 [IDH_PTYPE_VPD] = "vpd",
59 static struct usb_pd_identity *get_pd_identity(struct device *dev)
61 if (is_typec_partner(dev)) {
62 struct typec_partner *partner = to_typec_partner(dev);
64 return partner->identity;
65 } else if (is_typec_cable(dev)) {
66 struct typec_cable *cable = to_typec_cable(dev);
68 return cable->identity;
73 static const char *get_pd_product_type(struct device *dev)
75 struct typec_port *port = to_typec_port(dev->parent);
76 struct usb_pd_identity *id = get_pd_identity(dev);
77 const char *ptype = NULL;
79 if (is_typec_partner(dev)) {
83 if (port->data_role == TYPEC_HOST)
84 ptype = product_type_ufp[PD_IDH_PTYPE(id->id_header)];
86 ptype = product_type_dfp[PD_IDH_DFP_PTYPE(id->id_header)];
87 } else if (is_typec_cable(dev)) {
89 ptype = product_type_cable[PD_IDH_PTYPE(id->id_header)];
91 ptype = to_typec_cable(dev)->active ?
92 product_type_cable[IDH_PTYPE_ACABLE] :
93 product_type_cable[IDH_PTYPE_PCABLE];
99 static ssize_t id_header_show(struct device *dev, struct device_attribute *attr,
102 struct usb_pd_identity *id = get_pd_identity(dev);
104 return sprintf(buf, "0x%08x\n", id->id_header);
106 static DEVICE_ATTR_RO(id_header);
108 static ssize_t cert_stat_show(struct device *dev, struct device_attribute *attr,
111 struct usb_pd_identity *id = get_pd_identity(dev);
113 return sprintf(buf, "0x%08x\n", id->cert_stat);
115 static DEVICE_ATTR_RO(cert_stat);
117 static ssize_t product_show(struct device *dev, struct device_attribute *attr,
120 struct usb_pd_identity *id = get_pd_identity(dev);
122 return sprintf(buf, "0x%08x\n", id->product);
124 static DEVICE_ATTR_RO(product);
126 static ssize_t product_type_vdo1_show(struct device *dev, struct device_attribute *attr,
129 struct usb_pd_identity *id = get_pd_identity(dev);
131 return sysfs_emit(buf, "0x%08x\n", id->vdo[0]);
133 static DEVICE_ATTR_RO(product_type_vdo1);
135 static ssize_t product_type_vdo2_show(struct device *dev, struct device_attribute *attr,
138 struct usb_pd_identity *id = get_pd_identity(dev);
140 return sysfs_emit(buf, "0x%08x\n", id->vdo[1]);
142 static DEVICE_ATTR_RO(product_type_vdo2);
144 static ssize_t product_type_vdo3_show(struct device *dev, struct device_attribute *attr,
147 struct usb_pd_identity *id = get_pd_identity(dev);
149 return sysfs_emit(buf, "0x%08x\n", id->vdo[2]);
151 static DEVICE_ATTR_RO(product_type_vdo3);
153 static struct attribute *usb_pd_id_attrs[] = {
154 &dev_attr_id_header.attr,
155 &dev_attr_cert_stat.attr,
156 &dev_attr_product.attr,
157 &dev_attr_product_type_vdo1.attr,
158 &dev_attr_product_type_vdo2.attr,
159 &dev_attr_product_type_vdo3.attr,
163 static const struct attribute_group usb_pd_id_group = {
165 .attrs = usb_pd_id_attrs,
168 static const struct attribute_group *usb_pd_id_groups[] = {
173 static void typec_product_type_notify(struct device *dev)
178 ptype = get_pd_product_type(dev);
182 sysfs_notify(&dev->kobj, NULL, "type");
184 envp[0] = kasprintf(GFP_KERNEL, "PRODUCT_TYPE=%s", ptype);
188 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
192 static void typec_report_identity(struct device *dev)
194 sysfs_notify(&dev->kobj, "identity", "id_header");
195 sysfs_notify(&dev->kobj, "identity", "cert_stat");
196 sysfs_notify(&dev->kobj, "identity", "product");
197 sysfs_notify(&dev->kobj, "identity", "product_type_vdo1");
198 sysfs_notify(&dev->kobj, "identity", "product_type_vdo2");
199 sysfs_notify(&dev->kobj, "identity", "product_type_vdo3");
200 typec_product_type_notify(dev);
204 type_show(struct device *dev, struct device_attribute *attr, char *buf)
208 ptype = get_pd_product_type(dev);
212 return sysfs_emit(buf, "%s\n", ptype);
214 static DEVICE_ATTR_RO(type);
216 static ssize_t usb_power_delivery_revision_show(struct device *dev,
217 struct device_attribute *attr,
219 static DEVICE_ATTR_RO(usb_power_delivery_revision);
221 /* ------------------------------------------------------------------------- */
222 /* Alternate Modes */
224 static int altmode_match(struct device *dev, void *data)
226 struct typec_altmode *adev = to_typec_altmode(dev);
227 struct typec_device_id *id = data;
229 if (!is_typec_altmode(dev))
232 return ((adev->svid == id->svid) && (adev->mode == id->mode));
235 static void typec_altmode_set_partner(struct altmode *altmode)
237 struct typec_altmode *adev = &altmode->adev;
238 struct typec_device_id id = { adev->svid, adev->mode, };
239 struct typec_port *port = typec_altmode2port(adev);
240 struct altmode *partner;
243 dev = device_find_child(&port->dev, &id, altmode_match);
247 /* Bind the port alt mode to the partner/plug alt mode. */
248 partner = to_altmode(to_typec_altmode(dev));
249 altmode->partner = partner;
251 /* Bind the partner/plug alt mode to the port alt mode. */
252 if (is_typec_plug(adev->dev.parent)) {
253 struct typec_plug *plug = to_typec_plug(adev->dev.parent);
255 partner->plug[plug->index] = altmode;
257 partner->partner = altmode;
261 static void typec_altmode_put_partner(struct altmode *altmode)
263 struct altmode *partner = altmode->partner;
264 struct typec_altmode *adev;
265 struct typec_altmode *partner_adev;
270 adev = &altmode->adev;
271 partner_adev = &partner->adev;
273 if (is_typec_plug(adev->dev.parent)) {
274 struct typec_plug *plug = to_typec_plug(adev->dev.parent);
276 partner->plug[plug->index] = NULL;
278 partner->partner = NULL;
280 put_device(&partner_adev->dev);
284 * typec_altmode_update_active - Report Enter/Exit mode
285 * @adev: Handle to the alternate mode
286 * @active: True when the mode has been entered
288 * If a partner or cable plug executes Enter/Exit Mode command successfully, the
289 * drivers use this routine to report the updated state of the mode.
291 void typec_altmode_update_active(struct typec_altmode *adev, bool active)
295 if (adev->active == active)
298 if (!is_typec_port(adev->dev.parent) && adev->dev.driver) {
300 module_put(adev->dev.driver->owner);
302 WARN_ON(!try_module_get(adev->dev.driver->owner));
305 adev->active = active;
306 snprintf(dir, sizeof(dir), "mode%d", adev->mode);
307 sysfs_notify(&adev->dev.kobj, dir, "active");
308 sysfs_notify(&adev->dev.kobj, NULL, "active");
309 kobject_uevent(&adev->dev.kobj, KOBJ_CHANGE);
311 EXPORT_SYMBOL_GPL(typec_altmode_update_active);
314 * typec_altmode2port - Alternate Mode to USB Type-C port
315 * @alt: The Alternate Mode
317 * Returns handle to the port that a cable plug or partner with @alt is
320 struct typec_port *typec_altmode2port(struct typec_altmode *alt)
322 if (is_typec_plug(alt->dev.parent))
323 return to_typec_port(alt->dev.parent->parent->parent);
324 if (is_typec_partner(alt->dev.parent))
325 return to_typec_port(alt->dev.parent->parent);
326 if (is_typec_port(alt->dev.parent))
327 return to_typec_port(alt->dev.parent);
331 EXPORT_SYMBOL_GPL(typec_altmode2port);
334 vdo_show(struct device *dev, struct device_attribute *attr, char *buf)
336 struct typec_altmode *alt = to_typec_altmode(dev);
338 return sprintf(buf, "0x%08x\n", alt->vdo);
340 static DEVICE_ATTR_RO(vdo);
343 description_show(struct device *dev, struct device_attribute *attr, char *buf)
345 struct typec_altmode *alt = to_typec_altmode(dev);
347 return sprintf(buf, "%s\n", alt->desc ? alt->desc : "");
349 static DEVICE_ATTR_RO(description);
352 active_show(struct device *dev, struct device_attribute *attr, char *buf)
354 struct typec_altmode *alt = to_typec_altmode(dev);
356 return sprintf(buf, "%s\n", alt->active ? "yes" : "no");
359 static ssize_t active_store(struct device *dev, struct device_attribute *attr,
360 const char *buf, size_t size)
362 struct typec_altmode *adev = to_typec_altmode(dev);
363 struct altmode *altmode = to_altmode(adev);
367 ret = kstrtobool(buf, &enter);
371 if (adev->active == enter)
374 if (is_typec_port(adev->dev.parent)) {
375 typec_altmode_update_active(adev, enter);
377 /* Make sure that the partner exits the mode before disabling */
378 if (altmode->partner && !enter && altmode->partner->adev.active)
379 typec_altmode_exit(&altmode->partner->adev);
380 } else if (altmode->partner) {
381 if (enter && !altmode->partner->adev.active) {
382 dev_warn(dev, "port has the mode disabled\n");
387 /* Note: If there is no driver, the mode will not be entered */
388 if (adev->ops && adev->ops->activate) {
389 ret = adev->ops->activate(adev, enter);
396 static DEVICE_ATTR_RW(active);
399 supported_roles_show(struct device *dev, struct device_attribute *attr,
402 struct altmode *alt = to_altmode(to_typec_altmode(dev));
405 switch (alt->roles) {
407 ret = sprintf(buf, "source\n");
410 ret = sprintf(buf, "sink\n");
414 ret = sprintf(buf, "source sink\n");
419 static DEVICE_ATTR_RO(supported_roles);
422 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
424 struct typec_altmode *adev = to_typec_altmode(dev);
426 return sprintf(buf, "%u\n", adev->mode);
428 static DEVICE_ATTR_RO(mode);
431 svid_show(struct device *dev, struct device_attribute *attr, char *buf)
433 struct typec_altmode *adev = to_typec_altmode(dev);
435 return sprintf(buf, "%04x\n", adev->svid);
437 static DEVICE_ATTR_RO(svid);
439 static struct attribute *typec_altmode_attrs[] = {
440 &dev_attr_active.attr,
447 static umode_t typec_altmode_attr_is_visible(struct kobject *kobj,
448 struct attribute *attr, int n)
450 struct typec_altmode *adev = to_typec_altmode(kobj_to_dev(kobj));
452 if (attr == &dev_attr_active.attr)
453 if (!adev->ops || !adev->ops->activate)
459 static const struct attribute_group typec_altmode_group = {
460 .is_visible = typec_altmode_attr_is_visible,
461 .attrs = typec_altmode_attrs,
464 static const struct attribute_group *typec_altmode_groups[] = {
465 &typec_altmode_group,
469 static int altmode_id_get(struct device *dev)
473 if (is_typec_partner(dev))
474 ids = &to_typec_partner(dev)->mode_ids;
475 else if (is_typec_plug(dev))
476 ids = &to_typec_plug(dev)->mode_ids;
478 ids = &to_typec_port(dev)->mode_ids;
480 return ida_simple_get(ids, 0, 0, GFP_KERNEL);
483 static void altmode_id_remove(struct device *dev, int id)
487 if (is_typec_partner(dev))
488 ids = &to_typec_partner(dev)->mode_ids;
489 else if (is_typec_plug(dev))
490 ids = &to_typec_plug(dev)->mode_ids;
492 ids = &to_typec_port(dev)->mode_ids;
494 ida_simple_remove(ids, id);
497 static void typec_altmode_release(struct device *dev)
499 struct altmode *alt = to_altmode(to_typec_altmode(dev));
501 if (!is_typec_port(dev->parent))
502 typec_altmode_put_partner(alt);
504 altmode_id_remove(alt->adev.dev.parent, alt->id);
508 const struct device_type typec_altmode_dev_type = {
509 .name = "typec_alternate_mode",
510 .groups = typec_altmode_groups,
511 .release = typec_altmode_release,
514 static struct typec_altmode *
515 typec_register_altmode(struct device *parent,
516 const struct typec_altmode_desc *desc)
518 unsigned int id = altmode_id_get(parent);
519 bool is_port = is_typec_port(parent);
523 alt = kzalloc(sizeof(*alt), GFP_KERNEL);
525 altmode_id_remove(parent, id);
526 return ERR_PTR(-ENOMEM);
529 alt->adev.svid = desc->svid;
530 alt->adev.mode = desc->mode;
531 alt->adev.vdo = desc->vdo;
532 alt->roles = desc->roles;
535 alt->attrs[0] = &dev_attr_vdo.attr;
536 alt->attrs[1] = &dev_attr_description.attr;
537 alt->attrs[2] = &dev_attr_active.attr;
540 alt->attrs[3] = &dev_attr_supported_roles.attr;
541 alt->adev.active = true; /* Enabled by default */
544 sprintf(alt->group_name, "mode%d", desc->mode);
545 alt->group.name = alt->group_name;
546 alt->group.attrs = alt->attrs;
547 alt->groups[0] = &alt->group;
549 alt->adev.dev.parent = parent;
550 alt->adev.dev.groups = alt->groups;
551 alt->adev.dev.type = &typec_altmode_dev_type;
552 dev_set_name(&alt->adev.dev, "%s.%u", dev_name(parent), id);
554 /* Link partners and plugs with the ports */
556 typec_altmode_set_partner(alt);
558 /* The partners are bind to drivers */
559 if (is_typec_partner(parent))
560 alt->adev.dev.bus = &typec_bus;
562 /* Plug alt modes need a class to generate udev events. */
563 if (is_typec_plug(parent))
564 alt->adev.dev.class = &typec_class;
566 ret = device_register(&alt->adev.dev);
568 dev_err(parent, "failed to register alternate mode (%d)\n",
570 put_device(&alt->adev.dev);
578 * typec_unregister_altmode - Unregister Alternate Mode
579 * @adev: The alternate mode to be unregistered
581 * Unregister device created with typec_partner_register_altmode(),
582 * typec_plug_register_altmode() or typec_port_register_altmode().
584 void typec_unregister_altmode(struct typec_altmode *adev)
586 if (IS_ERR_OR_NULL(adev))
588 typec_retimer_put(to_altmode(adev)->retimer);
589 typec_mux_put(to_altmode(adev)->mux);
590 device_unregister(&adev->dev);
592 EXPORT_SYMBOL_GPL(typec_unregister_altmode);
594 /* ------------------------------------------------------------------------- */
595 /* Type-C Partners */
597 static ssize_t accessory_mode_show(struct device *dev,
598 struct device_attribute *attr,
601 struct typec_partner *p = to_typec_partner(dev);
603 return sprintf(buf, "%s\n", typec_accessory_modes[p->accessory]);
605 static DEVICE_ATTR_RO(accessory_mode);
607 static ssize_t supports_usb_power_delivery_show(struct device *dev,
608 struct device_attribute *attr,
611 struct typec_partner *p = to_typec_partner(dev);
613 return sprintf(buf, "%s\n", p->usb_pd ? "yes" : "no");
615 static DEVICE_ATTR_RO(supports_usb_power_delivery);
617 static ssize_t number_of_alternate_modes_show(struct device *dev, struct device_attribute *attr,
620 struct typec_partner *partner;
621 struct typec_plug *plug;
624 if (is_typec_partner(dev)) {
625 partner = to_typec_partner(dev);
626 num_altmodes = partner->num_altmodes;
627 } else if (is_typec_plug(dev)) {
628 plug = to_typec_plug(dev);
629 num_altmodes = plug->num_altmodes;
634 return sysfs_emit(buf, "%d\n", num_altmodes);
636 static DEVICE_ATTR_RO(number_of_alternate_modes);
638 static struct attribute *typec_partner_attrs[] = {
639 &dev_attr_accessory_mode.attr,
640 &dev_attr_supports_usb_power_delivery.attr,
641 &dev_attr_number_of_alternate_modes.attr,
643 &dev_attr_usb_power_delivery_revision.attr,
647 static umode_t typec_partner_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
649 struct typec_partner *partner = to_typec_partner(kobj_to_dev(kobj));
651 if (attr == &dev_attr_number_of_alternate_modes.attr) {
652 if (partner->num_altmodes < 0)
656 if (attr == &dev_attr_type.attr)
657 if (!get_pd_product_type(kobj_to_dev(kobj)))
663 static const struct attribute_group typec_partner_group = {
664 .is_visible = typec_partner_attr_is_visible,
665 .attrs = typec_partner_attrs
668 static const struct attribute_group *typec_partner_groups[] = {
669 &typec_partner_group,
673 static void typec_partner_release(struct device *dev)
675 struct typec_partner *partner = to_typec_partner(dev);
677 ida_destroy(&partner->mode_ids);
681 const struct device_type typec_partner_dev_type = {
682 .name = "typec_partner",
683 .groups = typec_partner_groups,
684 .release = typec_partner_release,
688 * typec_partner_set_identity - Report result from Discover Identity command
689 * @partner: The partner updated identity values
691 * This routine is used to report that the result of Discover Identity USB power
692 * delivery command has become available.
694 int typec_partner_set_identity(struct typec_partner *partner)
696 if (!partner->identity)
699 typec_report_identity(&partner->dev);
702 EXPORT_SYMBOL_GPL(typec_partner_set_identity);
705 * typec_partner_set_pd_revision - Set the PD revision supported by the partner
706 * @partner: The partner to be updated.
707 * @pd_revision: USB Power Delivery Specification Revision supported by partner
709 * This routine is used to report that the PD revision of the port partner has
712 void typec_partner_set_pd_revision(struct typec_partner *partner, u16 pd_revision)
714 if (partner->pd_revision == pd_revision)
717 partner->pd_revision = pd_revision;
718 sysfs_notify(&partner->dev.kobj, NULL, "usb_power_delivery_revision");
719 if (pd_revision != 0 && !partner->usb_pd) {
721 sysfs_notify(&partner->dev.kobj, NULL,
722 "supports_usb_power_delivery");
724 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
726 EXPORT_SYMBOL_GPL(typec_partner_set_pd_revision);
729 * typec_partner_set_usb_power_delivery - Declare USB Power Delivery Contract.
730 * @partner: The partner device.
731 * @pd: The USB PD instance.
733 * This routine can be used to declare USB Power Delivery Contract with @partner
734 * by linking @partner to @pd which contains the objects that were used during the
735 * negotiation of the contract.
737 * If @pd is NULL, the link is removed and the contract with @partner has ended.
739 int typec_partner_set_usb_power_delivery(struct typec_partner *partner,
740 struct usb_power_delivery *pd)
744 if (IS_ERR_OR_NULL(partner) || partner->pd == pd)
748 ret = usb_power_delivery_link_device(pd, &partner->dev);
752 usb_power_delivery_unlink_device(partner->pd, &partner->dev);
759 EXPORT_SYMBOL_GPL(typec_partner_set_usb_power_delivery);
762 * typec_partner_set_num_altmodes - Set the number of available partner altmodes
763 * @partner: The partner to be updated.
764 * @num_altmodes: The number of altmodes we want to specify as available.
766 * This routine is used to report the number of alternate modes supported by the
767 * partner. This value is *not* enforced in alternate mode registration routines.
769 * @partner.num_altmodes is set to -1 on partner registration, denoting that
770 * a valid value has not been set for it yet.
772 * Returns 0 on success or negative error number on failure.
774 int typec_partner_set_num_altmodes(struct typec_partner *partner, int num_altmodes)
778 if (num_altmodes < 0)
781 partner->num_altmodes = num_altmodes;
782 ret = sysfs_update_group(&partner->dev.kobj, &typec_partner_group);
786 sysfs_notify(&partner->dev.kobj, NULL, "number_of_alternate_modes");
787 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
791 EXPORT_SYMBOL_GPL(typec_partner_set_num_altmodes);
794 * typec_partner_register_altmode - Register USB Type-C Partner Alternate Mode
795 * @partner: USB Type-C Partner that supports the alternate mode
796 * @desc: Description of the alternate mode
798 * This routine is used to register each alternate mode individually that
799 * @partner has listed in response to Discover SVIDs command. The modes for a
800 * SVID listed in response to Discover Modes command need to be listed in an
803 * Returns handle to the alternate mode on success or ERR_PTR on failure.
805 struct typec_altmode *
806 typec_partner_register_altmode(struct typec_partner *partner,
807 const struct typec_altmode_desc *desc)
809 return typec_register_altmode(&partner->dev, desc);
811 EXPORT_SYMBOL_GPL(typec_partner_register_altmode);
814 * typec_partner_set_svdm_version - Set negotiated Structured VDM (SVDM) Version
815 * @partner: USB Type-C Partner that supports SVDM
816 * @svdm_version: Negotiated SVDM Version
818 * This routine is used to save the negotiated SVDM Version.
820 void typec_partner_set_svdm_version(struct typec_partner *partner,
821 enum usb_pd_svdm_ver svdm_version)
823 partner->svdm_version = svdm_version;
825 EXPORT_SYMBOL_GPL(typec_partner_set_svdm_version);
828 * typec_partner_usb_power_delivery_register - Register Type-C partner USB Power Delivery Support
829 * @partner: Type-C partner device.
830 * @desc: Description of the USB PD contract.
832 * This routine is a wrapper around usb_power_delivery_register(). It registers
833 * USB Power Delivery Capabilities for a Type-C partner device. Specifically,
834 * it sets the Type-C partner device as a parent for the resulting USB Power Delivery object.
836 * Returns handle to struct usb_power_delivery or ERR_PTR.
838 struct usb_power_delivery *
839 typec_partner_usb_power_delivery_register(struct typec_partner *partner,
840 struct usb_power_delivery_desc *desc)
842 return usb_power_delivery_register(&partner->dev, desc);
844 EXPORT_SYMBOL_GPL(typec_partner_usb_power_delivery_register);
847 * typec_register_partner - Register a USB Type-C Partner
848 * @port: The USB Type-C Port the partner is connected to
849 * @desc: Description of the partner
851 * Registers a device for USB Type-C Partner described in @desc.
853 * Returns handle to the partner on success or ERR_PTR on failure.
855 struct typec_partner *typec_register_partner(struct typec_port *port,
856 struct typec_partner_desc *desc)
858 struct typec_partner *partner;
861 partner = kzalloc(sizeof(*partner), GFP_KERNEL);
863 return ERR_PTR(-ENOMEM);
865 ida_init(&partner->mode_ids);
866 partner->usb_pd = desc->usb_pd;
867 partner->accessory = desc->accessory;
868 partner->num_altmodes = -1;
869 partner->pd_revision = desc->pd_revision;
870 partner->svdm_version = port->cap->svdm_version;
872 if (desc->identity) {
874 * Creating directory for the identity only if the driver is
875 * able to provide data to it.
877 partner->dev.groups = usb_pd_id_groups;
878 partner->identity = desc->identity;
881 partner->dev.class = &typec_class;
882 partner->dev.parent = &port->dev;
883 partner->dev.type = &typec_partner_dev_type;
884 dev_set_name(&partner->dev, "%s-partner", dev_name(&port->dev));
886 ret = device_register(&partner->dev);
888 dev_err(&port->dev, "failed to register partner (%d)\n", ret);
889 put_device(&partner->dev);
895 EXPORT_SYMBOL_GPL(typec_register_partner);
898 * typec_unregister_partner - Unregister a USB Type-C Partner
899 * @partner: The partner to be unregistered
901 * Unregister device created with typec_register_partner().
903 void typec_unregister_partner(struct typec_partner *partner)
905 if (!IS_ERR_OR_NULL(partner))
906 device_unregister(&partner->dev);
908 EXPORT_SYMBOL_GPL(typec_unregister_partner);
910 /* ------------------------------------------------------------------------- */
911 /* Type-C Cable Plugs */
913 static void typec_plug_release(struct device *dev)
915 struct typec_plug *plug = to_typec_plug(dev);
917 ida_destroy(&plug->mode_ids);
921 static struct attribute *typec_plug_attrs[] = {
922 &dev_attr_number_of_alternate_modes.attr,
926 static umode_t typec_plug_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
928 struct typec_plug *plug = to_typec_plug(kobj_to_dev(kobj));
930 if (attr == &dev_attr_number_of_alternate_modes.attr) {
931 if (plug->num_altmodes < 0)
938 static const struct attribute_group typec_plug_group = {
939 .is_visible = typec_plug_attr_is_visible,
940 .attrs = typec_plug_attrs
943 static const struct attribute_group *typec_plug_groups[] = {
948 const struct device_type typec_plug_dev_type = {
949 .name = "typec_plug",
950 .groups = typec_plug_groups,
951 .release = typec_plug_release,
955 * typec_plug_set_num_altmodes - Set the number of available plug altmodes
956 * @plug: The plug to be updated.
957 * @num_altmodes: The number of altmodes we want to specify as available.
959 * This routine is used to report the number of alternate modes supported by the
960 * plug. This value is *not* enforced in alternate mode registration routines.
962 * @plug.num_altmodes is set to -1 on plug registration, denoting that
963 * a valid value has not been set for it yet.
965 * Returns 0 on success or negative error number on failure.
967 int typec_plug_set_num_altmodes(struct typec_plug *plug, int num_altmodes)
971 if (num_altmodes < 0)
974 plug->num_altmodes = num_altmodes;
975 ret = sysfs_update_group(&plug->dev.kobj, &typec_plug_group);
979 sysfs_notify(&plug->dev.kobj, NULL, "number_of_alternate_modes");
980 kobject_uevent(&plug->dev.kobj, KOBJ_CHANGE);
984 EXPORT_SYMBOL_GPL(typec_plug_set_num_altmodes);
987 * typec_plug_register_altmode - Register USB Type-C Cable Plug Alternate Mode
988 * @plug: USB Type-C Cable Plug that supports the alternate mode
989 * @desc: Description of the alternate mode
991 * This routine is used to register each alternate mode individually that @plug
992 * has listed in response to Discover SVIDs command. The modes for a SVID that
993 * the plug lists in response to Discover Modes command need to be listed in an
996 * Returns handle to the alternate mode on success or ERR_PTR on failure.
998 struct typec_altmode *
999 typec_plug_register_altmode(struct typec_plug *plug,
1000 const struct typec_altmode_desc *desc)
1002 return typec_register_altmode(&plug->dev, desc);
1004 EXPORT_SYMBOL_GPL(typec_plug_register_altmode);
1007 * typec_register_plug - Register a USB Type-C Cable Plug
1008 * @cable: USB Type-C Cable with the plug
1009 * @desc: Description of the cable plug
1011 * Registers a device for USB Type-C Cable Plug described in @desc. A USB Type-C
1012 * Cable Plug represents a plug with electronics in it that can response to USB
1013 * Power Delivery SOP Prime or SOP Double Prime packages.
1015 * Returns handle to the cable plug on success or ERR_PTR on failure.
1017 struct typec_plug *typec_register_plug(struct typec_cable *cable,
1018 struct typec_plug_desc *desc)
1020 struct typec_plug *plug;
1024 plug = kzalloc(sizeof(*plug), GFP_KERNEL);
1026 return ERR_PTR(-ENOMEM);
1028 sprintf(name, "plug%d", desc->index);
1030 ida_init(&plug->mode_ids);
1031 plug->num_altmodes = -1;
1032 plug->index = desc->index;
1033 plug->dev.class = &typec_class;
1034 plug->dev.parent = &cable->dev;
1035 plug->dev.type = &typec_plug_dev_type;
1036 dev_set_name(&plug->dev, "%s-%s", dev_name(cable->dev.parent), name);
1038 ret = device_register(&plug->dev);
1040 dev_err(&cable->dev, "failed to register plug (%d)\n", ret);
1041 put_device(&plug->dev);
1042 return ERR_PTR(ret);
1047 EXPORT_SYMBOL_GPL(typec_register_plug);
1050 * typec_unregister_plug - Unregister a USB Type-C Cable Plug
1051 * @plug: The cable plug to be unregistered
1053 * Unregister device created with typec_register_plug().
1055 void typec_unregister_plug(struct typec_plug *plug)
1057 if (!IS_ERR_OR_NULL(plug))
1058 device_unregister(&plug->dev);
1060 EXPORT_SYMBOL_GPL(typec_unregister_plug);
1064 static const char * const typec_plug_types[] = {
1065 [USB_PLUG_NONE] = "unknown",
1066 [USB_PLUG_TYPE_A] = "type-a",
1067 [USB_PLUG_TYPE_B] = "type-b",
1068 [USB_PLUG_TYPE_C] = "type-c",
1069 [USB_PLUG_CAPTIVE] = "captive",
1072 static ssize_t plug_type_show(struct device *dev,
1073 struct device_attribute *attr, char *buf)
1075 struct typec_cable *cable = to_typec_cable(dev);
1077 return sprintf(buf, "%s\n", typec_plug_types[cable->type]);
1079 static DEVICE_ATTR_RO(plug_type);
1081 static struct attribute *typec_cable_attrs[] = {
1082 &dev_attr_type.attr,
1083 &dev_attr_plug_type.attr,
1084 &dev_attr_usb_power_delivery_revision.attr,
1087 ATTRIBUTE_GROUPS(typec_cable);
1089 static void typec_cable_release(struct device *dev)
1091 struct typec_cable *cable = to_typec_cable(dev);
1096 const struct device_type typec_cable_dev_type = {
1097 .name = "typec_cable",
1098 .groups = typec_cable_groups,
1099 .release = typec_cable_release,
1102 static int cable_match(struct device *dev, void *data)
1104 return is_typec_cable(dev);
1108 * typec_cable_get - Get a reference to the USB Type-C cable
1109 * @port: The USB Type-C Port the cable is connected to
1111 * The caller must decrement the reference count with typec_cable_put() after
1114 struct typec_cable *typec_cable_get(struct typec_port *port)
1118 dev = device_find_child(&port->dev, NULL, cable_match);
1122 return to_typec_cable(dev);
1124 EXPORT_SYMBOL_GPL(typec_cable_get);
1127 * typec_cable_put - Decrement the reference count on USB Type-C cable
1128 * @cable: The USB Type-C cable
1130 void typec_cable_put(struct typec_cable *cable)
1132 put_device(&cable->dev);
1134 EXPORT_SYMBOL_GPL(typec_cable_put);
1137 * typec_cable_is_active - Check is the USB Type-C cable active or passive
1138 * @cable: The USB Type-C Cable
1140 * Return 1 if the cable is active or 0 if it's passive.
1142 int typec_cable_is_active(struct typec_cable *cable)
1144 return cable->active;
1146 EXPORT_SYMBOL_GPL(typec_cable_is_active);
1149 * typec_cable_set_identity - Report result from Discover Identity command
1150 * @cable: The cable updated identity values
1152 * This routine is used to report that the result of Discover Identity USB power
1153 * delivery command has become available.
1155 int typec_cable_set_identity(struct typec_cable *cable)
1157 if (!cable->identity)
1160 typec_report_identity(&cable->dev);
1163 EXPORT_SYMBOL_GPL(typec_cable_set_identity);
1166 * typec_register_cable - Register a USB Type-C Cable
1167 * @port: The USB Type-C Port the cable is connected to
1168 * @desc: Description of the cable
1170 * Registers a device for USB Type-C Cable described in @desc. The cable will be
1171 * parent for the optional cable plug devises.
1173 * Returns handle to the cable on success or ERR_PTR on failure.
1175 struct typec_cable *typec_register_cable(struct typec_port *port,
1176 struct typec_cable_desc *desc)
1178 struct typec_cable *cable;
1181 cable = kzalloc(sizeof(*cable), GFP_KERNEL);
1183 return ERR_PTR(-ENOMEM);
1185 cable->type = desc->type;
1186 cable->active = desc->active;
1187 cable->pd_revision = desc->pd_revision;
1189 if (desc->identity) {
1191 * Creating directory for the identity only if the driver is
1192 * able to provide data to it.
1194 cable->dev.groups = usb_pd_id_groups;
1195 cable->identity = desc->identity;
1198 cable->dev.class = &typec_class;
1199 cable->dev.parent = &port->dev;
1200 cable->dev.type = &typec_cable_dev_type;
1201 dev_set_name(&cable->dev, "%s-cable", dev_name(&port->dev));
1203 ret = device_register(&cable->dev);
1205 dev_err(&port->dev, "failed to register cable (%d)\n", ret);
1206 put_device(&cable->dev);
1207 return ERR_PTR(ret);
1212 EXPORT_SYMBOL_GPL(typec_register_cable);
1215 * typec_unregister_cable - Unregister a USB Type-C Cable
1216 * @cable: The cable to be unregistered
1218 * Unregister device created with typec_register_cable().
1220 void typec_unregister_cable(struct typec_cable *cable)
1222 if (!IS_ERR_OR_NULL(cable))
1223 device_unregister(&cable->dev);
1225 EXPORT_SYMBOL_GPL(typec_unregister_cable);
1227 /* ------------------------------------------------------------------------- */
1228 /* USB Type-C ports */
1231 * typec_port_set_usb_power_delivery - Assign USB PD for port.
1232 * @port: USB Type-C port.
1233 * @pd: USB PD instance.
1235 * This routine can be used to set the USB Power Delivery Capabilities for @port
1236 * that it will advertise to the partner.
1238 * If @pd is NULL, the assignment is removed.
1240 int typec_port_set_usb_power_delivery(struct typec_port *port, struct usb_power_delivery *pd)
1244 if (IS_ERR_OR_NULL(port) || port->pd == pd)
1248 ret = usb_power_delivery_link_device(pd, &port->dev);
1252 usb_power_delivery_unlink_device(port->pd, &port->dev);
1259 EXPORT_SYMBOL_GPL(typec_port_set_usb_power_delivery);
1261 static ssize_t select_usb_power_delivery_store(struct device *dev,
1262 struct device_attribute *attr,
1263 const char *buf, size_t size)
1265 struct typec_port *port = to_typec_port(dev);
1266 struct usb_power_delivery *pd;
1268 if (!port->ops || !port->ops->pd_set)
1271 pd = usb_power_delivery_find(buf);
1275 return port->ops->pd_set(port, pd);
1278 static ssize_t select_usb_power_delivery_show(struct device *dev,
1279 struct device_attribute *attr, char *buf)
1281 struct typec_port *port = to_typec_port(dev);
1282 struct usb_power_delivery **pds;
1285 if (!port->ops || !port->ops->pd_get)
1288 pds = port->ops->pd_get(port);
1292 for (i = 0; pds[i]; i++) {
1293 if (pds[i] == port->pd)
1294 ret += sysfs_emit_at(buf, ret, "[%s] ", dev_name(&pds[i]->dev));
1296 ret += sysfs_emit_at(buf, ret, "%s ", dev_name(&pds[i]->dev));
1299 buf[ret - 1] = '\n';
1303 static DEVICE_ATTR_RW(select_usb_power_delivery);
1305 static struct attribute *port_attrs[] = {
1306 &dev_attr_select_usb_power_delivery.attr,
1310 static umode_t port_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
1312 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1314 if (!port->pd || !port->ops || !port->ops->pd_get)
1316 if (!port->ops->pd_set)
1322 static const struct attribute_group pd_group = {
1323 .is_visible = port_attr_is_visible,
1324 .attrs = port_attrs,
1327 static const char * const typec_orientations[] = {
1328 [TYPEC_ORIENTATION_NONE] = "unknown",
1329 [TYPEC_ORIENTATION_NORMAL] = "normal",
1330 [TYPEC_ORIENTATION_REVERSE] = "reverse",
1333 static const char * const typec_roles[] = {
1334 [TYPEC_SINK] = "sink",
1335 [TYPEC_SOURCE] = "source",
1338 static const char * const typec_data_roles[] = {
1339 [TYPEC_DEVICE] = "device",
1340 [TYPEC_HOST] = "host",
1343 static const char * const typec_port_power_roles[] = {
1344 [TYPEC_PORT_SRC] = "source",
1345 [TYPEC_PORT_SNK] = "sink",
1346 [TYPEC_PORT_DRP] = "dual",
1349 static const char * const typec_port_data_roles[] = {
1350 [TYPEC_PORT_DFP] = "host",
1351 [TYPEC_PORT_UFP] = "device",
1352 [TYPEC_PORT_DRD] = "dual",
1355 static const char * const typec_port_types_drp[] = {
1356 [TYPEC_PORT_SRC] = "dual [source] sink",
1357 [TYPEC_PORT_SNK] = "dual source [sink]",
1358 [TYPEC_PORT_DRP] = "[dual] source sink",
1362 preferred_role_store(struct device *dev, struct device_attribute *attr,
1363 const char *buf, size_t size)
1365 struct typec_port *port = to_typec_port(dev);
1369 if (port->cap->type != TYPEC_PORT_DRP) {
1370 dev_dbg(dev, "Preferred role only supported with DRP ports\n");
1374 if (!port->ops || !port->ops->try_role) {
1375 dev_dbg(dev, "Setting preferred role not supported\n");
1379 role = sysfs_match_string(typec_roles, buf);
1381 if (sysfs_streq(buf, "none"))
1382 role = TYPEC_NO_PREFERRED_ROLE;
1387 ret = port->ops->try_role(port, role);
1391 port->prefer_role = role;
1396 preferred_role_show(struct device *dev, struct device_attribute *attr,
1399 struct typec_port *port = to_typec_port(dev);
1401 if (port->cap->type != TYPEC_PORT_DRP)
1404 if (port->prefer_role < 0)
1407 return sprintf(buf, "%s\n", typec_roles[port->prefer_role]);
1409 static DEVICE_ATTR_RW(preferred_role);
1411 static ssize_t data_role_store(struct device *dev,
1412 struct device_attribute *attr,
1413 const char *buf, size_t size)
1415 struct typec_port *port = to_typec_port(dev);
1418 if (!port->ops || !port->ops->dr_set) {
1419 dev_dbg(dev, "data role swapping not supported\n");
1423 ret = sysfs_match_string(typec_data_roles, buf);
1427 mutex_lock(&port->port_type_lock);
1428 if (port->cap->data != TYPEC_PORT_DRD) {
1430 goto unlock_and_ret;
1433 ret = port->ops->dr_set(port, ret);
1435 goto unlock_and_ret;
1439 mutex_unlock(&port->port_type_lock);
1443 static ssize_t data_role_show(struct device *dev,
1444 struct device_attribute *attr, char *buf)
1446 struct typec_port *port = to_typec_port(dev);
1448 if (port->cap->data == TYPEC_PORT_DRD)
1449 return sprintf(buf, "%s\n", port->data_role == TYPEC_HOST ?
1450 "[host] device" : "host [device]");
1452 return sprintf(buf, "[%s]\n", typec_data_roles[port->data_role]);
1454 static DEVICE_ATTR_RW(data_role);
1456 static ssize_t power_role_store(struct device *dev,
1457 struct device_attribute *attr,
1458 const char *buf, size_t size)
1460 struct typec_port *port = to_typec_port(dev);
1463 if (!port->ops || !port->ops->pr_set) {
1464 dev_dbg(dev, "power role swapping not supported\n");
1468 if (port->pwr_opmode != TYPEC_PWR_MODE_PD) {
1469 dev_dbg(dev, "partner unable to swap power role\n");
1473 ret = sysfs_match_string(typec_roles, buf);
1477 mutex_lock(&port->port_type_lock);
1478 if (port->port_type != TYPEC_PORT_DRP) {
1479 dev_dbg(dev, "port type fixed at \"%s\"",
1480 typec_port_power_roles[port->port_type]);
1482 goto unlock_and_ret;
1485 ret = port->ops->pr_set(port, ret);
1487 goto unlock_and_ret;
1491 mutex_unlock(&port->port_type_lock);
1495 static ssize_t power_role_show(struct device *dev,
1496 struct device_attribute *attr, char *buf)
1498 struct typec_port *port = to_typec_port(dev);
1500 if (port->cap->type == TYPEC_PORT_DRP)
1501 return sprintf(buf, "%s\n", port->pwr_role == TYPEC_SOURCE ?
1502 "[source] sink" : "source [sink]");
1504 return sprintf(buf, "[%s]\n", typec_roles[port->pwr_role]);
1506 static DEVICE_ATTR_RW(power_role);
1509 port_type_store(struct device *dev, struct device_attribute *attr,
1510 const char *buf, size_t size)
1512 struct typec_port *port = to_typec_port(dev);
1514 enum typec_port_type type;
1516 if (port->cap->type != TYPEC_PORT_DRP ||
1517 !port->ops || !port->ops->port_type_set) {
1518 dev_dbg(dev, "changing port type not supported\n");
1522 ret = sysfs_match_string(typec_port_power_roles, buf);
1527 mutex_lock(&port->port_type_lock);
1529 if (port->port_type == type) {
1531 goto unlock_and_ret;
1534 ret = port->ops->port_type_set(port, type);
1536 goto unlock_and_ret;
1538 port->port_type = type;
1542 mutex_unlock(&port->port_type_lock);
1547 port_type_show(struct device *dev, struct device_attribute *attr,
1550 struct typec_port *port = to_typec_port(dev);
1552 if (port->cap->type == TYPEC_PORT_DRP)
1553 return sprintf(buf, "%s\n",
1554 typec_port_types_drp[port->port_type]);
1556 return sprintf(buf, "[%s]\n", typec_port_power_roles[port->cap->type]);
1558 static DEVICE_ATTR_RW(port_type);
1560 static const char * const typec_pwr_opmodes[] = {
1561 [TYPEC_PWR_MODE_USB] = "default",
1562 [TYPEC_PWR_MODE_1_5A] = "1.5A",
1563 [TYPEC_PWR_MODE_3_0A] = "3.0A",
1564 [TYPEC_PWR_MODE_PD] = "usb_power_delivery",
1567 static ssize_t power_operation_mode_show(struct device *dev,
1568 struct device_attribute *attr,
1571 struct typec_port *port = to_typec_port(dev);
1573 return sprintf(buf, "%s\n", typec_pwr_opmodes[port->pwr_opmode]);
1575 static DEVICE_ATTR_RO(power_operation_mode);
1577 static ssize_t vconn_source_store(struct device *dev,
1578 struct device_attribute *attr,
1579 const char *buf, size_t size)
1581 struct typec_port *port = to_typec_port(dev);
1585 if (!port->cap->pd_revision) {
1586 dev_dbg(dev, "VCONN swap depends on USB Power Delivery\n");
1590 if (!port->ops || !port->ops->vconn_set) {
1591 dev_dbg(dev, "VCONN swapping not supported\n");
1595 ret = kstrtobool(buf, &source);
1599 ret = port->ops->vconn_set(port, (enum typec_role)source);
1606 static ssize_t vconn_source_show(struct device *dev,
1607 struct device_attribute *attr, char *buf)
1609 struct typec_port *port = to_typec_port(dev);
1611 return sprintf(buf, "%s\n",
1612 port->vconn_role == TYPEC_SOURCE ? "yes" : "no");
1614 static DEVICE_ATTR_RW(vconn_source);
1616 static ssize_t supported_accessory_modes_show(struct device *dev,
1617 struct device_attribute *attr,
1620 struct typec_port *port = to_typec_port(dev);
1624 for (i = 0; i < ARRAY_SIZE(port->cap->accessory); i++) {
1625 if (port->cap->accessory[i])
1626 ret += sprintf(buf + ret, "%s ",
1627 typec_accessory_modes[port->cap->accessory[i]]);
1631 return sprintf(buf, "none\n");
1633 buf[ret - 1] = '\n';
1637 static DEVICE_ATTR_RO(supported_accessory_modes);
1639 static ssize_t usb_typec_revision_show(struct device *dev,
1640 struct device_attribute *attr,
1643 struct typec_port *port = to_typec_port(dev);
1644 u16 rev = port->cap->revision;
1646 return sprintf(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1648 static DEVICE_ATTR_RO(usb_typec_revision);
1650 static ssize_t usb_power_delivery_revision_show(struct device *dev,
1651 struct device_attribute *attr,
1656 if (is_typec_partner(dev)) {
1657 struct typec_partner *partner = to_typec_partner(dev);
1659 rev = partner->pd_revision;
1660 } else if (is_typec_cable(dev)) {
1661 struct typec_cable *cable = to_typec_cable(dev);
1663 rev = cable->pd_revision;
1664 } else if (is_typec_port(dev)) {
1665 struct typec_port *p = to_typec_port(dev);
1667 rev = p->cap->pd_revision;
1669 return sysfs_emit(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1672 static ssize_t orientation_show(struct device *dev,
1673 struct device_attribute *attr,
1676 struct typec_port *port = to_typec_port(dev);
1678 return sprintf(buf, "%s\n", typec_orientations[port->orientation]);
1680 static DEVICE_ATTR_RO(orientation);
1682 static struct attribute *typec_attrs[] = {
1683 &dev_attr_data_role.attr,
1684 &dev_attr_power_operation_mode.attr,
1685 &dev_attr_power_role.attr,
1686 &dev_attr_preferred_role.attr,
1687 &dev_attr_supported_accessory_modes.attr,
1688 &dev_attr_usb_power_delivery_revision.attr,
1689 &dev_attr_usb_typec_revision.attr,
1690 &dev_attr_vconn_source.attr,
1691 &dev_attr_port_type.attr,
1692 &dev_attr_orientation.attr,
1696 static umode_t typec_attr_is_visible(struct kobject *kobj,
1697 struct attribute *attr, int n)
1699 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1701 if (attr == &dev_attr_data_role.attr) {
1702 if (port->cap->data != TYPEC_PORT_DRD ||
1703 !port->ops || !port->ops->dr_set)
1705 } else if (attr == &dev_attr_power_role.attr) {
1706 if (port->cap->type != TYPEC_PORT_DRP ||
1707 !port->ops || !port->ops->pr_set)
1709 } else if (attr == &dev_attr_vconn_source.attr) {
1710 if (!port->cap->pd_revision ||
1711 !port->ops || !port->ops->vconn_set)
1713 } else if (attr == &dev_attr_preferred_role.attr) {
1714 if (port->cap->type != TYPEC_PORT_DRP ||
1715 !port->ops || !port->ops->try_role)
1717 } else if (attr == &dev_attr_port_type.attr) {
1718 if (!port->ops || !port->ops->port_type_set)
1720 if (port->cap->type != TYPEC_PORT_DRP)
1722 } else if (attr == &dev_attr_orientation.attr) {
1723 if (port->cap->orientation_aware)
1731 static const struct attribute_group typec_group = {
1732 .is_visible = typec_attr_is_visible,
1733 .attrs = typec_attrs,
1736 static const struct attribute_group *typec_groups[] = {
1742 static int typec_uevent(const struct device *dev, struct kobj_uevent_env *env)
1746 ret = add_uevent_var(env, "TYPEC_PORT=%s", dev_name(dev));
1748 dev_err(dev, "failed to add uevent TYPEC_PORT\n");
1753 static void typec_release(struct device *dev)
1755 struct typec_port *port = to_typec_port(dev);
1757 ida_simple_remove(&typec_index_ida, port->id);
1758 ida_destroy(&port->mode_ids);
1759 typec_switch_put(port->sw);
1760 typec_mux_put(port->mux);
1761 typec_retimer_put(port->retimer);
1766 const struct device_type typec_port_dev_type = {
1767 .name = "typec_port",
1768 .groups = typec_groups,
1769 .uevent = typec_uevent,
1770 .release = typec_release,
1773 /* --------------------------------------- */
1774 /* Driver callbacks to report role updates */
1776 static int partner_match(struct device *dev, void *data)
1778 return is_typec_partner(dev);
1782 * typec_set_data_role - Report data role change
1783 * @port: The USB Type-C Port where the role was changed
1784 * @role: The new data role
1786 * This routine is used by the port drivers to report data role changes.
1788 void typec_set_data_role(struct typec_port *port, enum typec_data_role role)
1790 struct device *partner_dev;
1792 if (port->data_role == role)
1795 port->data_role = role;
1796 sysfs_notify(&port->dev.kobj, NULL, "data_role");
1797 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1799 partner_dev = device_find_child(&port->dev, NULL, partner_match);
1803 if (to_typec_partner(partner_dev)->identity)
1804 typec_product_type_notify(partner_dev);
1806 put_device(partner_dev);
1808 EXPORT_SYMBOL_GPL(typec_set_data_role);
1811 * typec_set_pwr_role - Report power role change
1812 * @port: The USB Type-C Port where the role was changed
1813 * @role: The new data role
1815 * This routine is used by the port drivers to report power role changes.
1817 void typec_set_pwr_role(struct typec_port *port, enum typec_role role)
1819 if (port->pwr_role == role)
1822 port->pwr_role = role;
1823 sysfs_notify(&port->dev.kobj, NULL, "power_role");
1824 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1826 EXPORT_SYMBOL_GPL(typec_set_pwr_role);
1829 * typec_set_vconn_role - Report VCONN source change
1830 * @port: The USB Type-C Port which VCONN role changed
1831 * @role: Source when @port is sourcing VCONN, or Sink when it's not
1833 * This routine is used by the port drivers to report if the VCONN source is
1836 void typec_set_vconn_role(struct typec_port *port, enum typec_role role)
1838 if (port->vconn_role == role)
1841 port->vconn_role = role;
1842 sysfs_notify(&port->dev.kobj, NULL, "vconn_source");
1843 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1845 EXPORT_SYMBOL_GPL(typec_set_vconn_role);
1848 * typec_set_pwr_opmode - Report changed power operation mode
1849 * @port: The USB Type-C Port where the mode was changed
1850 * @opmode: New power operation mode
1852 * This routine is used by the port drivers to report changed power operation
1853 * mode in @port. The modes are USB (default), 1.5A, 3.0A as defined in USB
1854 * Type-C specification, and "USB Power Delivery" when the power levels are
1855 * negotiated with methods defined in USB Power Delivery specification.
1857 void typec_set_pwr_opmode(struct typec_port *port,
1858 enum typec_pwr_opmode opmode)
1860 struct device *partner_dev;
1862 if (port->pwr_opmode == opmode)
1865 port->pwr_opmode = opmode;
1866 sysfs_notify(&port->dev.kobj, NULL, "power_operation_mode");
1867 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1869 partner_dev = device_find_child(&port->dev, NULL, partner_match);
1871 struct typec_partner *partner = to_typec_partner(partner_dev);
1873 if (opmode == TYPEC_PWR_MODE_PD && !partner->usb_pd) {
1874 partner->usb_pd = 1;
1875 sysfs_notify(&partner_dev->kobj, NULL,
1876 "supports_usb_power_delivery");
1877 kobject_uevent(&partner_dev->kobj, KOBJ_CHANGE);
1879 put_device(partner_dev);
1882 EXPORT_SYMBOL_GPL(typec_set_pwr_opmode);
1885 * typec_find_pwr_opmode - Get the typec power operation mode capability
1886 * @name: power operation mode string
1888 * This routine is used to find the typec_pwr_opmode by its string @name.
1890 * Returns typec_pwr_opmode if success, otherwise negative error code.
1892 int typec_find_pwr_opmode(const char *name)
1894 return match_string(typec_pwr_opmodes,
1895 ARRAY_SIZE(typec_pwr_opmodes), name);
1897 EXPORT_SYMBOL_GPL(typec_find_pwr_opmode);
1900 * typec_find_orientation - Convert orientation string to enum typec_orientation
1901 * @name: Orientation string
1903 * This routine is used to find the typec_orientation by its string name @name.
1905 * Returns the orientation value on success, otherwise negative error code.
1907 int typec_find_orientation(const char *name)
1909 return match_string(typec_orientations, ARRAY_SIZE(typec_orientations),
1912 EXPORT_SYMBOL_GPL(typec_find_orientation);
1915 * typec_find_port_power_role - Get the typec port power capability
1916 * @name: port power capability string
1918 * This routine is used to find the typec_port_type by its string name.
1920 * Returns typec_port_type if success, otherwise negative error code.
1922 int typec_find_port_power_role(const char *name)
1924 return match_string(typec_port_power_roles,
1925 ARRAY_SIZE(typec_port_power_roles), name);
1927 EXPORT_SYMBOL_GPL(typec_find_port_power_role);
1930 * typec_find_power_role - Find the typec one specific power role
1931 * @name: power role string
1933 * This routine is used to find the typec_role by its string name.
1935 * Returns typec_role if success, otherwise negative error code.
1937 int typec_find_power_role(const char *name)
1939 return match_string(typec_roles, ARRAY_SIZE(typec_roles), name);
1941 EXPORT_SYMBOL_GPL(typec_find_power_role);
1944 * typec_find_port_data_role - Get the typec port data capability
1945 * @name: port data capability string
1947 * This routine is used to find the typec_port_data by its string name.
1949 * Returns typec_port_data if success, otherwise negative error code.
1951 int typec_find_port_data_role(const char *name)
1953 return match_string(typec_port_data_roles,
1954 ARRAY_SIZE(typec_port_data_roles), name);
1956 EXPORT_SYMBOL_GPL(typec_find_port_data_role);
1958 /* ------------------------------------------ */
1959 /* API for Multiplexer/DeMultiplexer Switches */
1962 * typec_set_orientation - Set USB Type-C cable plug orientation
1963 * @port: USB Type-C Port
1964 * @orientation: USB Type-C cable plug orientation
1966 * Set cable plug orientation for @port.
1968 int typec_set_orientation(struct typec_port *port,
1969 enum typec_orientation orientation)
1973 ret = typec_switch_set(port->sw, orientation);
1977 port->orientation = orientation;
1978 sysfs_notify(&port->dev.kobj, NULL, "orientation");
1979 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1983 EXPORT_SYMBOL_GPL(typec_set_orientation);
1986 * typec_get_orientation - Get USB Type-C cable plug orientation
1987 * @port: USB Type-C Port
1989 * Get current cable plug orientation for @port.
1991 enum typec_orientation typec_get_orientation(struct typec_port *port)
1993 return port->orientation;
1995 EXPORT_SYMBOL_GPL(typec_get_orientation);
1998 * typec_set_mode - Set mode of operation for USB Type-C connector
1999 * @port: USB Type-C connector
2000 * @mode: Accessory Mode, USB Operation or Safe State
2002 * Configure @port for Accessory Mode @mode. This function will configure the
2003 * muxes needed for @mode.
2005 int typec_set_mode(struct typec_port *port, int mode)
2007 struct typec_mux_state state = { };
2011 return typec_mux_set(port->mux, &state);
2013 EXPORT_SYMBOL_GPL(typec_set_mode);
2015 /* --------------------------------------- */
2018 * typec_get_negotiated_svdm_version - Get negotiated SVDM Version
2019 * @port: USB Type-C Port.
2021 * Get the negotiated SVDM Version. The Version is set to the port default
2022 * value stored in typec_capability on partner registration, and updated after
2023 * a successful Discover Identity if the negotiated value is less than the
2026 * Returns usb_pd_svdm_ver if the partner has been registered otherwise -ENODEV.
2028 int typec_get_negotiated_svdm_version(struct typec_port *port)
2030 enum usb_pd_svdm_ver svdm_version;
2031 struct device *partner_dev;
2033 partner_dev = device_find_child(&port->dev, NULL, partner_match);
2037 svdm_version = to_typec_partner(partner_dev)->svdm_version;
2038 put_device(partner_dev);
2040 return svdm_version;
2042 EXPORT_SYMBOL_GPL(typec_get_negotiated_svdm_version);
2045 * typec_get_drvdata - Return private driver data pointer
2046 * @port: USB Type-C port
2048 void *typec_get_drvdata(struct typec_port *port)
2050 return dev_get_drvdata(&port->dev);
2052 EXPORT_SYMBOL_GPL(typec_get_drvdata);
2054 int typec_get_fw_cap(struct typec_capability *cap,
2055 struct fwnode_handle *fwnode)
2057 const char *cap_str;
2060 cap->fwnode = fwnode;
2062 ret = fwnode_property_read_string(fwnode, "power-role", &cap_str);
2066 ret = typec_find_port_power_role(cap_str);
2071 /* USB data support is optional */
2072 ret = fwnode_property_read_string(fwnode, "data-role", &cap_str);
2074 ret = typec_find_port_data_role(cap_str);
2080 /* Get the preferred power role for a DRP */
2081 if (cap->type == TYPEC_PORT_DRP) {
2082 cap->prefer_role = TYPEC_NO_PREFERRED_ROLE;
2084 ret = fwnode_property_read_string(fwnode, "try-power-role", &cap_str);
2086 ret = typec_find_power_role(cap_str);
2089 cap->prefer_role = ret;
2095 EXPORT_SYMBOL_GPL(typec_get_fw_cap);
2098 * typec_port_register_altmode - Register USB Type-C Port Alternate Mode
2099 * @port: USB Type-C Port that supports the alternate mode
2100 * @desc: Description of the alternate mode
2102 * This routine is used to register an alternate mode that @port is capable of
2105 * Returns handle to the alternate mode on success or ERR_PTR on failure.
2107 struct typec_altmode *
2108 typec_port_register_altmode(struct typec_port *port,
2109 const struct typec_altmode_desc *desc)
2111 struct typec_altmode *adev;
2112 struct typec_mux *mux;
2113 struct typec_retimer *retimer;
2115 mux = typec_mux_get(&port->dev);
2117 return ERR_CAST(mux);
2119 retimer = typec_retimer_get(&port->dev);
2120 if (IS_ERR(retimer)) {
2122 return ERR_CAST(retimer);
2125 adev = typec_register_altmode(&port->dev, desc);
2127 typec_retimer_put(retimer);
2130 to_altmode(adev)->mux = mux;
2131 to_altmode(adev)->retimer = retimer;
2136 EXPORT_SYMBOL_GPL(typec_port_register_altmode);
2138 void typec_port_register_altmodes(struct typec_port *port,
2139 const struct typec_altmode_ops *ops, void *drvdata,
2140 struct typec_altmode **altmodes, size_t n)
2142 struct fwnode_handle *altmodes_node, *child;
2143 struct typec_altmode_desc desc;
2144 struct typec_altmode *alt;
2149 altmodes_node = device_get_named_child_node(&port->dev, "altmodes");
2151 return; /* No altmodes specified */
2153 fwnode_for_each_child_node(altmodes_node, child) {
2154 ret = fwnode_property_read_u32(child, "svid", &svid);
2156 dev_err(&port->dev, "Error reading svid for altmode %s\n",
2157 fwnode_get_name(child));
2161 ret = fwnode_property_read_u32(child, "vdo", &vdo);
2163 dev_err(&port->dev, "Error reading vdo for altmode %s\n",
2164 fwnode_get_name(child));
2169 dev_err(&port->dev, "Error not enough space for altmode %s\n",
2170 fwnode_get_name(child));
2176 desc.mode = index + 1;
2177 alt = typec_port_register_altmode(port, &desc);
2179 dev_err(&port->dev, "Error registering altmode %s\n",
2180 fwnode_get_name(child));
2185 typec_altmode_set_drvdata(alt, drvdata);
2186 altmodes[index] = alt;
2190 EXPORT_SYMBOL_GPL(typec_port_register_altmodes);
2193 * typec_register_port - Register a USB Type-C Port
2194 * @parent: Parent device
2195 * @cap: Description of the port
2197 * Registers a device for USB Type-C Port described in @cap.
2199 * Returns handle to the port on success or ERR_PTR on failure.
2201 struct typec_port *typec_register_port(struct device *parent,
2202 const struct typec_capability *cap)
2204 struct typec_port *port;
2208 port = kzalloc(sizeof(*port), GFP_KERNEL);
2210 return ERR_PTR(-ENOMEM);
2212 id = ida_simple_get(&typec_index_ida, 0, 0, GFP_KERNEL);
2218 switch (cap->type) {
2219 case TYPEC_PORT_SRC:
2220 port->pwr_role = TYPEC_SOURCE;
2221 port->vconn_role = TYPEC_SOURCE;
2223 case TYPEC_PORT_SNK:
2224 port->pwr_role = TYPEC_SINK;
2225 port->vconn_role = TYPEC_SINK;
2227 case TYPEC_PORT_DRP:
2228 if (cap->prefer_role != TYPEC_NO_PREFERRED_ROLE)
2229 port->pwr_role = cap->prefer_role;
2231 port->pwr_role = TYPEC_SINK;
2235 switch (cap->data) {
2236 case TYPEC_PORT_DFP:
2237 port->data_role = TYPEC_HOST;
2239 case TYPEC_PORT_UFP:
2240 port->data_role = TYPEC_DEVICE;
2242 case TYPEC_PORT_DRD:
2243 if (cap->prefer_role == TYPEC_SOURCE)
2244 port->data_role = TYPEC_HOST;
2246 port->data_role = TYPEC_DEVICE;
2250 ida_init(&port->mode_ids);
2251 mutex_init(&port->port_type_lock);
2254 port->ops = cap->ops;
2255 port->port_type = cap->type;
2256 port->prefer_role = cap->prefer_role;
2258 device_initialize(&port->dev);
2259 port->dev.class = &typec_class;
2260 port->dev.parent = parent;
2261 port->dev.fwnode = cap->fwnode;
2262 port->dev.type = &typec_port_dev_type;
2263 dev_set_name(&port->dev, "port%d", id);
2264 dev_set_drvdata(&port->dev, cap->driver_data);
2266 port->cap = kmemdup(cap, sizeof(*cap), GFP_KERNEL);
2268 put_device(&port->dev);
2269 return ERR_PTR(-ENOMEM);
2272 port->sw = typec_switch_get(&port->dev);
2273 if (IS_ERR(port->sw)) {
2274 ret = PTR_ERR(port->sw);
2275 put_device(&port->dev);
2276 return ERR_PTR(ret);
2279 port->mux = typec_mux_get(&port->dev);
2280 if (IS_ERR(port->mux)) {
2281 ret = PTR_ERR(port->mux);
2282 put_device(&port->dev);
2283 return ERR_PTR(ret);
2286 port->retimer = typec_retimer_get(&port->dev);
2287 if (IS_ERR(port->retimer)) {
2288 ret = PTR_ERR(port->retimer);
2289 put_device(&port->dev);
2290 return ERR_PTR(ret);
2295 ret = device_add(&port->dev);
2297 dev_err(parent, "failed to register port (%d)\n", ret);
2298 put_device(&port->dev);
2299 return ERR_PTR(ret);
2302 ret = usb_power_delivery_link_device(port->pd, &port->dev);
2304 dev_err(&port->dev, "failed to link pd\n");
2305 device_unregister(&port->dev);
2306 return ERR_PTR(ret);
2309 ret = typec_link_ports(port);
2311 dev_warn(&port->dev, "failed to create symlinks (%d)\n", ret);
2315 EXPORT_SYMBOL_GPL(typec_register_port);
2318 * typec_unregister_port - Unregister a USB Type-C Port
2319 * @port: The port to be unregistered
2321 * Unregister device created with typec_register_port().
2323 void typec_unregister_port(struct typec_port *port)
2325 if (!IS_ERR_OR_NULL(port)) {
2326 typec_unlink_ports(port);
2327 typec_port_set_usb_power_delivery(port, NULL);
2328 device_unregister(&port->dev);
2331 EXPORT_SYMBOL_GPL(typec_unregister_port);
2333 static int __init typec_init(void)
2337 ret = bus_register(&typec_bus);
2341 ret = class_register(&typec_mux_class);
2343 goto err_unregister_bus;
2345 ret = class_register(&retimer_class);
2347 goto err_unregister_mux_class;
2349 ret = class_register(&typec_class);
2351 goto err_unregister_retimer_class;
2353 ret = usb_power_delivery_init();
2355 goto err_unregister_class;
2359 err_unregister_class:
2360 class_unregister(&typec_class);
2362 err_unregister_retimer_class:
2363 class_unregister(&retimer_class);
2365 err_unregister_mux_class:
2366 class_unregister(&typec_mux_class);
2369 bus_unregister(&typec_bus);
2373 subsys_initcall(typec_init);
2375 static void __exit typec_exit(void)
2377 usb_power_delivery_exit();
2378 class_unregister(&typec_class);
2379 ida_destroy(&typec_index_ida);
2380 bus_unregister(&typec_bus);
2381 class_unregister(&typec_mux_class);
2382 class_unregister(&retimer_class);
2384 module_exit(typec_exit);
2386 MODULE_AUTHOR("Heikki Krogerus <heikki.krogerus@linux.intel.com>");
2387 MODULE_LICENSE("GPL v2");
2388 MODULE_DESCRIPTION("USB Type-C Connector Class");