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>
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;
266 struct typec_altmode *partner_adev;
271 adev = &altmode->adev;
272 partner_adev = &partner->adev;
274 if (is_typec_plug(adev->dev.parent)) {
275 struct typec_plug *plug = to_typec_plug(adev->dev.parent);
277 partner->plug[plug->index] = NULL;
279 partner->partner = NULL;
281 put_device(&partner_adev->dev);
285 * typec_altmode_update_active - Report Enter/Exit mode
286 * @adev: Handle to the alternate mode
287 * @active: True when the mode has been entered
289 * If a partner or cable plug executes Enter/Exit Mode command successfully, the
290 * drivers use this routine to report the updated state of the mode.
292 void typec_altmode_update_active(struct typec_altmode *adev, bool active)
296 if (adev->active == active)
299 if (!is_typec_port(adev->dev.parent) && adev->dev.driver) {
301 module_put(adev->dev.driver->owner);
303 WARN_ON(!try_module_get(adev->dev.driver->owner));
306 adev->active = active;
307 snprintf(dir, sizeof(dir), "mode%d", adev->mode);
308 sysfs_notify(&adev->dev.kobj, dir, "active");
309 sysfs_notify(&adev->dev.kobj, NULL, "active");
310 kobject_uevent(&adev->dev.kobj, KOBJ_CHANGE);
312 EXPORT_SYMBOL_GPL(typec_altmode_update_active);
315 * typec_altmode2port - Alternate Mode to USB Type-C port
316 * @alt: The Alternate Mode
318 * Returns handle to the port that a cable plug or partner with @alt is
321 struct typec_port *typec_altmode2port(struct typec_altmode *alt)
323 if (is_typec_plug(alt->dev.parent))
324 return to_typec_port(alt->dev.parent->parent->parent);
325 if (is_typec_partner(alt->dev.parent))
326 return to_typec_port(alt->dev.parent->parent);
327 if (is_typec_port(alt->dev.parent))
328 return to_typec_port(alt->dev.parent);
332 EXPORT_SYMBOL_GPL(typec_altmode2port);
335 vdo_show(struct device *dev, struct device_attribute *attr, char *buf)
337 struct typec_altmode *alt = to_typec_altmode(dev);
339 return sprintf(buf, "0x%08x\n", alt->vdo);
341 static DEVICE_ATTR_RO(vdo);
344 description_show(struct device *dev, struct device_attribute *attr, char *buf)
346 struct typec_altmode *alt = to_typec_altmode(dev);
348 return sprintf(buf, "%s\n", alt->desc ? alt->desc : "");
350 static DEVICE_ATTR_RO(description);
353 active_show(struct device *dev, struct device_attribute *attr, char *buf)
355 struct typec_altmode *alt = to_typec_altmode(dev);
357 return sprintf(buf, "%s\n", alt->active ? "yes" : "no");
360 static ssize_t active_store(struct device *dev, struct device_attribute *attr,
361 const char *buf, size_t size)
363 struct typec_altmode *adev = to_typec_altmode(dev);
364 struct altmode *altmode = to_altmode(adev);
368 ret = kstrtobool(buf, &enter);
372 if (adev->active == enter)
375 if (is_typec_port(adev->dev.parent)) {
376 typec_altmode_update_active(adev, enter);
378 /* Make sure that the partner exits the mode before disabling */
379 if (altmode->partner && !enter && altmode->partner->adev.active)
380 typec_altmode_exit(&altmode->partner->adev);
381 } else if (altmode->partner) {
382 if (enter && !altmode->partner->adev.active) {
383 dev_warn(dev, "port has the mode disabled\n");
388 /* Note: If there is no driver, the mode will not be entered */
389 if (adev->ops && adev->ops->activate) {
390 ret = adev->ops->activate(adev, enter);
397 static DEVICE_ATTR_RW(active);
400 supported_roles_show(struct device *dev, struct device_attribute *attr,
403 struct altmode *alt = to_altmode(to_typec_altmode(dev));
406 switch (alt->roles) {
408 ret = sprintf(buf, "source\n");
411 ret = sprintf(buf, "sink\n");
415 ret = sprintf(buf, "source sink\n");
420 static DEVICE_ATTR_RO(supported_roles);
423 mode_show(struct device *dev, struct device_attribute *attr, char *buf)
425 struct typec_altmode *adev = to_typec_altmode(dev);
427 return sprintf(buf, "%u\n", adev->mode);
429 static DEVICE_ATTR_RO(mode);
432 svid_show(struct device *dev, struct device_attribute *attr, char *buf)
434 struct typec_altmode *adev = to_typec_altmode(dev);
436 return sprintf(buf, "%04x\n", adev->svid);
438 static DEVICE_ATTR_RO(svid);
440 static struct attribute *typec_altmode_attrs[] = {
441 &dev_attr_active.attr,
448 static umode_t typec_altmode_attr_is_visible(struct kobject *kobj,
449 struct attribute *attr, int n)
451 struct typec_altmode *adev = to_typec_altmode(kobj_to_dev(kobj));
453 if (attr == &dev_attr_active.attr)
454 if (!adev->ops || !adev->ops->activate)
460 static const struct attribute_group typec_altmode_group = {
461 .is_visible = typec_altmode_attr_is_visible,
462 .attrs = typec_altmode_attrs,
465 static const struct attribute_group *typec_altmode_groups[] = {
466 &typec_altmode_group,
470 static int altmode_id_get(struct device *dev)
474 if (is_typec_partner(dev))
475 ids = &to_typec_partner(dev)->mode_ids;
476 else if (is_typec_plug(dev))
477 ids = &to_typec_plug(dev)->mode_ids;
479 ids = &to_typec_port(dev)->mode_ids;
481 return ida_alloc(ids, GFP_KERNEL);
484 static void altmode_id_remove(struct device *dev, int id)
488 if (is_typec_partner(dev))
489 ids = &to_typec_partner(dev)->mode_ids;
490 else if (is_typec_plug(dev))
491 ids = &to_typec_plug(dev)->mode_ids;
493 ids = &to_typec_port(dev)->mode_ids;
498 static void typec_altmode_release(struct device *dev)
500 struct altmode *alt = to_altmode(to_typec_altmode(dev));
502 if (!is_typec_port(dev->parent))
503 typec_altmode_put_partner(alt);
505 altmode_id_remove(alt->adev.dev.parent, alt->id);
509 const struct device_type typec_altmode_dev_type = {
510 .name = "typec_alternate_mode",
511 .groups = typec_altmode_groups,
512 .release = typec_altmode_release,
515 static struct typec_altmode *
516 typec_register_altmode(struct device *parent,
517 const struct typec_altmode_desc *desc)
519 unsigned int id = altmode_id_get(parent);
520 bool is_port = is_typec_port(parent);
524 alt = kzalloc(sizeof(*alt), GFP_KERNEL);
526 altmode_id_remove(parent, id);
527 return ERR_PTR(-ENOMEM);
530 alt->adev.svid = desc->svid;
531 alt->adev.mode = desc->mode;
532 alt->adev.vdo = desc->vdo;
533 alt->roles = desc->roles;
536 alt->attrs[0] = &dev_attr_vdo.attr;
537 alt->attrs[1] = &dev_attr_description.attr;
538 alt->attrs[2] = &dev_attr_active.attr;
541 alt->attrs[3] = &dev_attr_supported_roles.attr;
542 alt->adev.active = true; /* Enabled by default */
545 sprintf(alt->group_name, "mode%d", desc->mode);
546 alt->group.name = alt->group_name;
547 alt->group.attrs = alt->attrs;
548 alt->groups[0] = &alt->group;
550 alt->adev.dev.parent = parent;
551 alt->adev.dev.groups = alt->groups;
552 alt->adev.dev.type = &typec_altmode_dev_type;
553 dev_set_name(&alt->adev.dev, "%s.%u", dev_name(parent), id);
555 /* Link partners and plugs with the ports */
557 typec_altmode_set_partner(alt);
559 /* The partners are bind to drivers */
560 if (is_typec_partner(parent))
561 alt->adev.dev.bus = &typec_bus;
563 /* Plug alt modes need a class to generate udev events. */
564 if (is_typec_plug(parent))
565 alt->adev.dev.class = &typec_class;
567 ret = device_register(&alt->adev.dev);
569 dev_err(parent, "failed to register alternate mode (%d)\n",
571 put_device(&alt->adev.dev);
579 * typec_unregister_altmode - Unregister Alternate Mode
580 * @adev: The alternate mode to be unregistered
582 * Unregister device created with typec_partner_register_altmode(),
583 * typec_plug_register_altmode() or typec_port_register_altmode().
585 void typec_unregister_altmode(struct typec_altmode *adev)
587 if (IS_ERR_OR_NULL(adev))
589 typec_retimer_put(to_altmode(adev)->retimer);
590 typec_mux_put(to_altmode(adev)->mux);
591 device_unregister(&adev->dev);
593 EXPORT_SYMBOL_GPL(typec_unregister_altmode);
595 /* ------------------------------------------------------------------------- */
596 /* Type-C Partners */
598 static ssize_t accessory_mode_show(struct device *dev,
599 struct device_attribute *attr,
602 struct typec_partner *p = to_typec_partner(dev);
604 return sprintf(buf, "%s\n", typec_accessory_modes[p->accessory]);
606 static DEVICE_ATTR_RO(accessory_mode);
608 static ssize_t supports_usb_power_delivery_show(struct device *dev,
609 struct device_attribute *attr,
612 struct typec_partner *p = to_typec_partner(dev);
614 return sprintf(buf, "%s\n", p->usb_pd ? "yes" : "no");
616 static DEVICE_ATTR_RO(supports_usb_power_delivery);
618 static ssize_t number_of_alternate_modes_show(struct device *dev, struct device_attribute *attr,
621 struct typec_partner *partner;
622 struct typec_plug *plug;
625 if (is_typec_partner(dev)) {
626 partner = to_typec_partner(dev);
627 num_altmodes = partner->num_altmodes;
628 } else if (is_typec_plug(dev)) {
629 plug = to_typec_plug(dev);
630 num_altmodes = plug->num_altmodes;
635 return sysfs_emit(buf, "%d\n", num_altmodes);
637 static DEVICE_ATTR_RO(number_of_alternate_modes);
639 static struct attribute *typec_partner_attrs[] = {
640 &dev_attr_accessory_mode.attr,
641 &dev_attr_supports_usb_power_delivery.attr,
642 &dev_attr_number_of_alternate_modes.attr,
644 &dev_attr_usb_power_delivery_revision.attr,
648 static umode_t typec_partner_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
650 struct typec_partner *partner = to_typec_partner(kobj_to_dev(kobj));
652 if (attr == &dev_attr_number_of_alternate_modes.attr) {
653 if (partner->num_altmodes < 0)
657 if (attr == &dev_attr_type.attr)
658 if (!get_pd_product_type(kobj_to_dev(kobj)))
664 static const struct attribute_group typec_partner_group = {
665 .is_visible = typec_partner_attr_is_visible,
666 .attrs = typec_partner_attrs
669 static const struct attribute_group *typec_partner_groups[] = {
670 &typec_partner_group,
674 static void typec_partner_release(struct device *dev)
676 struct typec_partner *partner = to_typec_partner(dev);
678 ida_destroy(&partner->mode_ids);
682 const struct device_type typec_partner_dev_type = {
683 .name = "typec_partner",
684 .groups = typec_partner_groups,
685 .release = typec_partner_release,
688 static void typec_partner_link_device(struct typec_partner *partner, struct device *dev)
692 ret = sysfs_create_link(&dev->kobj, &partner->dev.kobj, "typec");
696 ret = sysfs_create_link(&partner->dev.kobj, &dev->kobj, dev_name(dev));
698 sysfs_remove_link(&dev->kobj, "typec");
703 partner->attach(partner, dev);
706 static void typec_partner_unlink_device(struct typec_partner *partner, struct device *dev)
708 sysfs_remove_link(&partner->dev.kobj, dev_name(dev));
709 sysfs_remove_link(&dev->kobj, "typec");
711 if (partner->deattach)
712 partner->deattach(partner, dev);
716 * typec_partner_set_identity - Report result from Discover Identity command
717 * @partner: The partner updated identity values
719 * This routine is used to report that the result of Discover Identity USB power
720 * delivery command has become available.
722 int typec_partner_set_identity(struct typec_partner *partner)
724 if (!partner->identity)
727 typec_report_identity(&partner->dev);
730 EXPORT_SYMBOL_GPL(typec_partner_set_identity);
733 * typec_partner_set_pd_revision - Set the PD revision supported by the partner
734 * @partner: The partner to be updated.
735 * @pd_revision: USB Power Delivery Specification Revision supported by partner
737 * This routine is used to report that the PD revision of the port partner has
740 void typec_partner_set_pd_revision(struct typec_partner *partner, u16 pd_revision)
742 if (partner->pd_revision == pd_revision)
745 partner->pd_revision = pd_revision;
746 sysfs_notify(&partner->dev.kobj, NULL, "usb_power_delivery_revision");
747 if (pd_revision != 0 && !partner->usb_pd) {
749 sysfs_notify(&partner->dev.kobj, NULL,
750 "supports_usb_power_delivery");
752 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
754 EXPORT_SYMBOL_GPL(typec_partner_set_pd_revision);
757 * typec_partner_set_usb_power_delivery - Declare USB Power Delivery Contract.
758 * @partner: The partner device.
759 * @pd: The USB PD instance.
761 * This routine can be used to declare USB Power Delivery Contract with @partner
762 * by linking @partner to @pd which contains the objects that were used during the
763 * negotiation of the contract.
765 * If @pd is NULL, the link is removed and the contract with @partner has ended.
767 int typec_partner_set_usb_power_delivery(struct typec_partner *partner,
768 struct usb_power_delivery *pd)
772 if (IS_ERR_OR_NULL(partner) || partner->pd == pd)
776 ret = usb_power_delivery_link_device(pd, &partner->dev);
780 usb_power_delivery_unlink_device(partner->pd, &partner->dev);
787 EXPORT_SYMBOL_GPL(typec_partner_set_usb_power_delivery);
790 * typec_partner_set_num_altmodes - Set the number of available partner altmodes
791 * @partner: The partner to be updated.
792 * @num_altmodes: The number of altmodes we want to specify as available.
794 * This routine is used to report the number of alternate modes supported by the
795 * partner. This value is *not* enforced in alternate mode registration routines.
797 * @partner.num_altmodes is set to -1 on partner registration, denoting that
798 * a valid value has not been set for it yet.
800 * Returns 0 on success or negative error number on failure.
802 int typec_partner_set_num_altmodes(struct typec_partner *partner, int num_altmodes)
806 if (num_altmodes < 0)
809 partner->num_altmodes = num_altmodes;
810 ret = sysfs_update_group(&partner->dev.kobj, &typec_partner_group);
814 sysfs_notify(&partner->dev.kobj, NULL, "number_of_alternate_modes");
815 kobject_uevent(&partner->dev.kobj, KOBJ_CHANGE);
819 EXPORT_SYMBOL_GPL(typec_partner_set_num_altmodes);
822 * typec_partner_register_altmode - Register USB Type-C Partner Alternate Mode
823 * @partner: USB Type-C Partner that supports the alternate mode
824 * @desc: Description of the alternate mode
826 * This routine is used to register each alternate mode individually that
827 * @partner has listed in response to Discover SVIDs command. The modes for a
828 * SVID listed in response to Discover Modes command need to be listed in an
831 * Returns handle to the alternate mode on success or ERR_PTR on failure.
833 struct typec_altmode *
834 typec_partner_register_altmode(struct typec_partner *partner,
835 const struct typec_altmode_desc *desc)
837 return typec_register_altmode(&partner->dev, desc);
839 EXPORT_SYMBOL_GPL(typec_partner_register_altmode);
842 * typec_partner_set_svdm_version - Set negotiated Structured VDM (SVDM) Version
843 * @partner: USB Type-C Partner that supports SVDM
844 * @svdm_version: Negotiated SVDM Version
846 * This routine is used to save the negotiated SVDM Version.
848 void typec_partner_set_svdm_version(struct typec_partner *partner,
849 enum usb_pd_svdm_ver svdm_version)
851 partner->svdm_version = svdm_version;
853 EXPORT_SYMBOL_GPL(typec_partner_set_svdm_version);
856 * typec_partner_usb_power_delivery_register - Register Type-C partner USB Power Delivery Support
857 * @partner: Type-C partner device.
858 * @desc: Description of the USB PD contract.
860 * This routine is a wrapper around usb_power_delivery_register(). It registers
861 * USB Power Delivery Capabilities for a Type-C partner device. Specifically,
862 * it sets the Type-C partner device as a parent for the resulting USB Power Delivery object.
864 * Returns handle to struct usb_power_delivery or ERR_PTR.
866 struct usb_power_delivery *
867 typec_partner_usb_power_delivery_register(struct typec_partner *partner,
868 struct usb_power_delivery_desc *desc)
870 return usb_power_delivery_register(&partner->dev, desc);
872 EXPORT_SYMBOL_GPL(typec_partner_usb_power_delivery_register);
875 * typec_register_partner - Register a USB Type-C Partner
876 * @port: The USB Type-C Port the partner is connected to
877 * @desc: Description of the partner
879 * Registers a device for USB Type-C Partner described in @desc.
881 * Returns handle to the partner on success or ERR_PTR on failure.
883 struct typec_partner *typec_register_partner(struct typec_port *port,
884 struct typec_partner_desc *desc)
886 struct typec_partner *partner;
889 partner = kzalloc(sizeof(*partner), GFP_KERNEL);
891 return ERR_PTR(-ENOMEM);
893 ida_init(&partner->mode_ids);
894 partner->usb_pd = desc->usb_pd;
895 partner->accessory = desc->accessory;
896 partner->num_altmodes = -1;
897 partner->pd_revision = desc->pd_revision;
898 partner->svdm_version = port->cap->svdm_version;
899 partner->attach = desc->attach;
900 partner->deattach = desc->deattach;
902 if (desc->identity) {
904 * Creating directory for the identity only if the driver is
905 * able to provide data to it.
907 partner->dev.groups = usb_pd_id_groups;
908 partner->identity = desc->identity;
911 partner->dev.class = &typec_class;
912 partner->dev.parent = &port->dev;
913 partner->dev.type = &typec_partner_dev_type;
914 dev_set_name(&partner->dev, "%s-partner", dev_name(&port->dev));
916 ret = device_register(&partner->dev);
918 dev_err(&port->dev, "failed to register partner (%d)\n", ret);
919 put_device(&partner->dev);
924 typec_partner_link_device(partner, port->usb2_dev);
926 typec_partner_link_device(partner, port->usb3_dev);
930 EXPORT_SYMBOL_GPL(typec_register_partner);
933 * typec_unregister_partner - Unregister a USB Type-C Partner
934 * @partner: The partner to be unregistered
936 * Unregister device created with typec_register_partner().
938 void typec_unregister_partner(struct typec_partner *partner)
940 struct typec_port *port;
942 if (IS_ERR_OR_NULL(partner))
945 port = to_typec_port(partner->dev.parent);
948 typec_partner_unlink_device(partner, port->usb2_dev);
950 typec_partner_unlink_device(partner, port->usb3_dev);
952 device_unregister(&partner->dev);
954 EXPORT_SYMBOL_GPL(typec_unregister_partner);
956 /* ------------------------------------------------------------------------- */
957 /* Type-C Cable Plugs */
959 static void typec_plug_release(struct device *dev)
961 struct typec_plug *plug = to_typec_plug(dev);
963 ida_destroy(&plug->mode_ids);
967 static struct attribute *typec_plug_attrs[] = {
968 &dev_attr_number_of_alternate_modes.attr,
972 static umode_t typec_plug_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
974 struct typec_plug *plug = to_typec_plug(kobj_to_dev(kobj));
976 if (attr == &dev_attr_number_of_alternate_modes.attr) {
977 if (plug->num_altmodes < 0)
984 static const struct attribute_group typec_plug_group = {
985 .is_visible = typec_plug_attr_is_visible,
986 .attrs = typec_plug_attrs
989 static const struct attribute_group *typec_plug_groups[] = {
994 const struct device_type typec_plug_dev_type = {
995 .name = "typec_plug",
996 .groups = typec_plug_groups,
997 .release = typec_plug_release,
1001 * typec_plug_set_num_altmodes - Set the number of available plug altmodes
1002 * @plug: The plug to be updated.
1003 * @num_altmodes: The number of altmodes we want to specify as available.
1005 * This routine is used to report the number of alternate modes supported by the
1006 * plug. This value is *not* enforced in alternate mode registration routines.
1008 * @plug.num_altmodes is set to -1 on plug registration, denoting that
1009 * a valid value has not been set for it yet.
1011 * Returns 0 on success or negative error number on failure.
1013 int typec_plug_set_num_altmodes(struct typec_plug *plug, int num_altmodes)
1017 if (num_altmodes < 0)
1020 plug->num_altmodes = num_altmodes;
1021 ret = sysfs_update_group(&plug->dev.kobj, &typec_plug_group);
1025 sysfs_notify(&plug->dev.kobj, NULL, "number_of_alternate_modes");
1026 kobject_uevent(&plug->dev.kobj, KOBJ_CHANGE);
1030 EXPORT_SYMBOL_GPL(typec_plug_set_num_altmodes);
1033 * typec_plug_register_altmode - Register USB Type-C Cable Plug Alternate Mode
1034 * @plug: USB Type-C Cable Plug that supports the alternate mode
1035 * @desc: Description of the alternate mode
1037 * This routine is used to register each alternate mode individually that @plug
1038 * has listed in response to Discover SVIDs command. The modes for a SVID that
1039 * the plug lists in response to Discover Modes command need to be listed in an
1042 * Returns handle to the alternate mode on success or ERR_PTR on failure.
1044 struct typec_altmode *
1045 typec_plug_register_altmode(struct typec_plug *plug,
1046 const struct typec_altmode_desc *desc)
1048 return typec_register_altmode(&plug->dev, desc);
1050 EXPORT_SYMBOL_GPL(typec_plug_register_altmode);
1053 * typec_register_plug - Register a USB Type-C Cable Plug
1054 * @cable: USB Type-C Cable with the plug
1055 * @desc: Description of the cable plug
1057 * Registers a device for USB Type-C Cable Plug described in @desc. A USB Type-C
1058 * Cable Plug represents a plug with electronics in it that can response to USB
1059 * Power Delivery SOP Prime or SOP Double Prime packages.
1061 * Returns handle to the cable plug on success or ERR_PTR on failure.
1063 struct typec_plug *typec_register_plug(struct typec_cable *cable,
1064 struct typec_plug_desc *desc)
1066 struct typec_plug *plug;
1070 plug = kzalloc(sizeof(*plug), GFP_KERNEL);
1072 return ERR_PTR(-ENOMEM);
1074 sprintf(name, "plug%d", desc->index);
1076 ida_init(&plug->mode_ids);
1077 plug->num_altmodes = -1;
1078 plug->index = desc->index;
1079 plug->dev.class = &typec_class;
1080 plug->dev.parent = &cable->dev;
1081 plug->dev.type = &typec_plug_dev_type;
1082 dev_set_name(&plug->dev, "%s-%s", dev_name(cable->dev.parent), name);
1084 ret = device_register(&plug->dev);
1086 dev_err(&cable->dev, "failed to register plug (%d)\n", ret);
1087 put_device(&plug->dev);
1088 return ERR_PTR(ret);
1093 EXPORT_SYMBOL_GPL(typec_register_plug);
1096 * typec_unregister_plug - Unregister a USB Type-C Cable Plug
1097 * @plug: The cable plug to be unregistered
1099 * Unregister device created with typec_register_plug().
1101 void typec_unregister_plug(struct typec_plug *plug)
1103 if (!IS_ERR_OR_NULL(plug))
1104 device_unregister(&plug->dev);
1106 EXPORT_SYMBOL_GPL(typec_unregister_plug);
1110 static const char * const typec_plug_types[] = {
1111 [USB_PLUG_NONE] = "unknown",
1112 [USB_PLUG_TYPE_A] = "type-a",
1113 [USB_PLUG_TYPE_B] = "type-b",
1114 [USB_PLUG_TYPE_C] = "type-c",
1115 [USB_PLUG_CAPTIVE] = "captive",
1118 static ssize_t plug_type_show(struct device *dev,
1119 struct device_attribute *attr, char *buf)
1121 struct typec_cable *cable = to_typec_cable(dev);
1123 return sprintf(buf, "%s\n", typec_plug_types[cable->type]);
1125 static DEVICE_ATTR_RO(plug_type);
1127 static struct attribute *typec_cable_attrs[] = {
1128 &dev_attr_type.attr,
1129 &dev_attr_plug_type.attr,
1130 &dev_attr_usb_power_delivery_revision.attr,
1133 ATTRIBUTE_GROUPS(typec_cable);
1135 static void typec_cable_release(struct device *dev)
1137 struct typec_cable *cable = to_typec_cable(dev);
1142 const struct device_type typec_cable_dev_type = {
1143 .name = "typec_cable",
1144 .groups = typec_cable_groups,
1145 .release = typec_cable_release,
1148 static int cable_match(struct device *dev, void *data)
1150 return is_typec_cable(dev);
1154 * typec_cable_get - Get a reference to the USB Type-C cable
1155 * @port: The USB Type-C Port the cable is connected to
1157 * The caller must decrement the reference count with typec_cable_put() after
1160 struct typec_cable *typec_cable_get(struct typec_port *port)
1164 dev = device_find_child(&port->dev, NULL, cable_match);
1168 return to_typec_cable(dev);
1170 EXPORT_SYMBOL_GPL(typec_cable_get);
1173 * typec_cable_put - Decrement the reference count on USB Type-C cable
1174 * @cable: The USB Type-C cable
1176 void typec_cable_put(struct typec_cable *cable)
1178 put_device(&cable->dev);
1180 EXPORT_SYMBOL_GPL(typec_cable_put);
1183 * typec_cable_is_active - Check is the USB Type-C cable active or passive
1184 * @cable: The USB Type-C Cable
1186 * Return 1 if the cable is active or 0 if it's passive.
1188 int typec_cable_is_active(struct typec_cable *cable)
1190 return cable->active;
1192 EXPORT_SYMBOL_GPL(typec_cable_is_active);
1195 * typec_cable_set_identity - Report result from Discover Identity command
1196 * @cable: The cable updated identity values
1198 * This routine is used to report that the result of Discover Identity USB power
1199 * delivery command has become available.
1201 int typec_cable_set_identity(struct typec_cable *cable)
1203 if (!cable->identity)
1206 typec_report_identity(&cable->dev);
1209 EXPORT_SYMBOL_GPL(typec_cable_set_identity);
1212 * typec_register_cable - Register a USB Type-C Cable
1213 * @port: The USB Type-C Port the cable is connected to
1214 * @desc: Description of the cable
1216 * Registers a device for USB Type-C Cable described in @desc. The cable will be
1217 * parent for the optional cable plug devises.
1219 * Returns handle to the cable on success or ERR_PTR on failure.
1221 struct typec_cable *typec_register_cable(struct typec_port *port,
1222 struct typec_cable_desc *desc)
1224 struct typec_cable *cable;
1227 cable = kzalloc(sizeof(*cable), GFP_KERNEL);
1229 return ERR_PTR(-ENOMEM);
1231 cable->type = desc->type;
1232 cable->active = desc->active;
1233 cable->pd_revision = desc->pd_revision;
1235 if (desc->identity) {
1237 * Creating directory for the identity only if the driver is
1238 * able to provide data to it.
1240 cable->dev.groups = usb_pd_id_groups;
1241 cable->identity = desc->identity;
1244 cable->dev.class = &typec_class;
1245 cable->dev.parent = &port->dev;
1246 cable->dev.type = &typec_cable_dev_type;
1247 dev_set_name(&cable->dev, "%s-cable", dev_name(&port->dev));
1249 ret = device_register(&cable->dev);
1251 dev_err(&port->dev, "failed to register cable (%d)\n", ret);
1252 put_device(&cable->dev);
1253 return ERR_PTR(ret);
1258 EXPORT_SYMBOL_GPL(typec_register_cable);
1261 * typec_unregister_cable - Unregister a USB Type-C Cable
1262 * @cable: The cable to be unregistered
1264 * Unregister device created with typec_register_cable().
1266 void typec_unregister_cable(struct typec_cable *cable)
1268 if (!IS_ERR_OR_NULL(cable))
1269 device_unregister(&cable->dev);
1271 EXPORT_SYMBOL_GPL(typec_unregister_cable);
1273 /* ------------------------------------------------------------------------- */
1274 /* USB Type-C ports */
1277 * typec_port_set_usb_power_delivery - Assign USB PD for port.
1278 * @port: USB Type-C port.
1279 * @pd: USB PD instance.
1281 * This routine can be used to set the USB Power Delivery Capabilities for @port
1282 * that it will advertise to the partner.
1284 * If @pd is NULL, the assignment is removed.
1286 int typec_port_set_usb_power_delivery(struct typec_port *port, struct usb_power_delivery *pd)
1290 if (IS_ERR_OR_NULL(port) || port->pd == pd)
1294 ret = usb_power_delivery_link_device(pd, &port->dev);
1298 usb_power_delivery_unlink_device(port->pd, &port->dev);
1305 EXPORT_SYMBOL_GPL(typec_port_set_usb_power_delivery);
1307 static ssize_t select_usb_power_delivery_store(struct device *dev,
1308 struct device_attribute *attr,
1309 const char *buf, size_t size)
1311 struct typec_port *port = to_typec_port(dev);
1312 struct usb_power_delivery *pd;
1315 if (!port->ops || !port->ops->pd_set)
1318 pd = usb_power_delivery_find(buf);
1322 ret = port->ops->pd_set(port, pd);
1329 static ssize_t select_usb_power_delivery_show(struct device *dev,
1330 struct device_attribute *attr, char *buf)
1332 struct typec_port *port = to_typec_port(dev);
1333 struct usb_power_delivery **pds;
1336 if (!port->ops || !port->ops->pd_get)
1339 pds = port->ops->pd_get(port);
1343 for (i = 0; pds[i]; i++) {
1344 if (pds[i] == port->pd)
1345 ret += sysfs_emit_at(buf, ret, "[%s] ", dev_name(&pds[i]->dev));
1347 ret += sysfs_emit_at(buf, ret, "%s ", dev_name(&pds[i]->dev));
1350 buf[ret - 1] = '\n';
1354 static DEVICE_ATTR_RW(select_usb_power_delivery);
1356 static struct attribute *port_attrs[] = {
1357 &dev_attr_select_usb_power_delivery.attr,
1361 static umode_t port_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n)
1363 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1365 if (!port->pd || !port->ops || !port->ops->pd_get)
1367 if (!port->ops->pd_set)
1373 static const struct attribute_group pd_group = {
1374 .is_visible = port_attr_is_visible,
1375 .attrs = port_attrs,
1378 static const char * const typec_orientations[] = {
1379 [TYPEC_ORIENTATION_NONE] = "unknown",
1380 [TYPEC_ORIENTATION_NORMAL] = "normal",
1381 [TYPEC_ORIENTATION_REVERSE] = "reverse",
1384 static const char * const typec_roles[] = {
1385 [TYPEC_SINK] = "sink",
1386 [TYPEC_SOURCE] = "source",
1389 static const char * const typec_data_roles[] = {
1390 [TYPEC_DEVICE] = "device",
1391 [TYPEC_HOST] = "host",
1394 static const char * const typec_port_power_roles[] = {
1395 [TYPEC_PORT_SRC] = "source",
1396 [TYPEC_PORT_SNK] = "sink",
1397 [TYPEC_PORT_DRP] = "dual",
1400 static const char * const typec_port_data_roles[] = {
1401 [TYPEC_PORT_DFP] = "host",
1402 [TYPEC_PORT_UFP] = "device",
1403 [TYPEC_PORT_DRD] = "dual",
1406 static const char * const typec_port_types_drp[] = {
1407 [TYPEC_PORT_SRC] = "dual [source] sink",
1408 [TYPEC_PORT_SNK] = "dual source [sink]",
1409 [TYPEC_PORT_DRP] = "[dual] source sink",
1413 preferred_role_store(struct device *dev, struct device_attribute *attr,
1414 const char *buf, size_t size)
1416 struct typec_port *port = to_typec_port(dev);
1420 if (port->cap->type != TYPEC_PORT_DRP) {
1421 dev_dbg(dev, "Preferred role only supported with DRP ports\n");
1425 if (!port->ops || !port->ops->try_role) {
1426 dev_dbg(dev, "Setting preferred role not supported\n");
1430 role = sysfs_match_string(typec_roles, buf);
1432 if (sysfs_streq(buf, "none"))
1433 role = TYPEC_NO_PREFERRED_ROLE;
1438 ret = port->ops->try_role(port, role);
1442 port->prefer_role = role;
1447 preferred_role_show(struct device *dev, struct device_attribute *attr,
1450 struct typec_port *port = to_typec_port(dev);
1452 if (port->cap->type != TYPEC_PORT_DRP)
1455 if (port->prefer_role < 0)
1458 return sprintf(buf, "%s\n", typec_roles[port->prefer_role]);
1460 static DEVICE_ATTR_RW(preferred_role);
1462 static ssize_t data_role_store(struct device *dev,
1463 struct device_attribute *attr,
1464 const char *buf, size_t size)
1466 struct typec_port *port = to_typec_port(dev);
1469 if (!port->ops || !port->ops->dr_set) {
1470 dev_dbg(dev, "data role swapping not supported\n");
1474 ret = sysfs_match_string(typec_data_roles, buf);
1478 mutex_lock(&port->port_type_lock);
1479 if (port->cap->data != TYPEC_PORT_DRD) {
1481 goto unlock_and_ret;
1484 ret = port->ops->dr_set(port, ret);
1486 goto unlock_and_ret;
1490 mutex_unlock(&port->port_type_lock);
1494 static ssize_t data_role_show(struct device *dev,
1495 struct device_attribute *attr, char *buf)
1497 struct typec_port *port = to_typec_port(dev);
1499 if (port->cap->data == TYPEC_PORT_DRD)
1500 return sprintf(buf, "%s\n", port->data_role == TYPEC_HOST ?
1501 "[host] device" : "host [device]");
1503 return sprintf(buf, "[%s]\n", typec_data_roles[port->data_role]);
1505 static DEVICE_ATTR_RW(data_role);
1507 static ssize_t power_role_store(struct device *dev,
1508 struct device_attribute *attr,
1509 const char *buf, size_t size)
1511 struct typec_port *port = to_typec_port(dev);
1514 if (!port->ops || !port->ops->pr_set) {
1515 dev_dbg(dev, "power role swapping not supported\n");
1519 if (port->pwr_opmode != TYPEC_PWR_MODE_PD) {
1520 dev_dbg(dev, "partner unable to swap power role\n");
1524 ret = sysfs_match_string(typec_roles, buf);
1528 mutex_lock(&port->port_type_lock);
1529 if (port->port_type != TYPEC_PORT_DRP) {
1530 dev_dbg(dev, "port type fixed at \"%s\"",
1531 typec_port_power_roles[port->port_type]);
1533 goto unlock_and_ret;
1536 ret = port->ops->pr_set(port, ret);
1538 goto unlock_and_ret;
1542 mutex_unlock(&port->port_type_lock);
1546 static ssize_t power_role_show(struct device *dev,
1547 struct device_attribute *attr, char *buf)
1549 struct typec_port *port = to_typec_port(dev);
1551 if (port->cap->type == TYPEC_PORT_DRP)
1552 return sprintf(buf, "%s\n", port->pwr_role == TYPEC_SOURCE ?
1553 "[source] sink" : "source [sink]");
1555 return sprintf(buf, "[%s]\n", typec_roles[port->pwr_role]);
1557 static DEVICE_ATTR_RW(power_role);
1560 port_type_store(struct device *dev, struct device_attribute *attr,
1561 const char *buf, size_t size)
1563 struct typec_port *port = to_typec_port(dev);
1565 enum typec_port_type type;
1567 if (port->cap->type != TYPEC_PORT_DRP ||
1568 !port->ops || !port->ops->port_type_set) {
1569 dev_dbg(dev, "changing port type not supported\n");
1573 ret = sysfs_match_string(typec_port_power_roles, buf);
1578 mutex_lock(&port->port_type_lock);
1580 if (port->port_type == type) {
1582 goto unlock_and_ret;
1585 ret = port->ops->port_type_set(port, type);
1587 goto unlock_and_ret;
1589 port->port_type = type;
1593 mutex_unlock(&port->port_type_lock);
1598 port_type_show(struct device *dev, struct device_attribute *attr,
1601 struct typec_port *port = to_typec_port(dev);
1603 if (port->cap->type == TYPEC_PORT_DRP)
1604 return sprintf(buf, "%s\n",
1605 typec_port_types_drp[port->port_type]);
1607 return sprintf(buf, "[%s]\n", typec_port_power_roles[port->cap->type]);
1609 static DEVICE_ATTR_RW(port_type);
1611 static const char * const typec_pwr_opmodes[] = {
1612 [TYPEC_PWR_MODE_USB] = "default",
1613 [TYPEC_PWR_MODE_1_5A] = "1.5A",
1614 [TYPEC_PWR_MODE_3_0A] = "3.0A",
1615 [TYPEC_PWR_MODE_PD] = "usb_power_delivery",
1618 static ssize_t power_operation_mode_show(struct device *dev,
1619 struct device_attribute *attr,
1622 struct typec_port *port = to_typec_port(dev);
1624 return sprintf(buf, "%s\n", typec_pwr_opmodes[port->pwr_opmode]);
1626 static DEVICE_ATTR_RO(power_operation_mode);
1628 static ssize_t vconn_source_store(struct device *dev,
1629 struct device_attribute *attr,
1630 const char *buf, size_t size)
1632 struct typec_port *port = to_typec_port(dev);
1636 if (!port->cap->pd_revision) {
1637 dev_dbg(dev, "VCONN swap depends on USB Power Delivery\n");
1641 if (!port->ops || !port->ops->vconn_set) {
1642 dev_dbg(dev, "VCONN swapping not supported\n");
1646 ret = kstrtobool(buf, &source);
1650 ret = port->ops->vconn_set(port, (enum typec_role)source);
1657 static ssize_t vconn_source_show(struct device *dev,
1658 struct device_attribute *attr, char *buf)
1660 struct typec_port *port = to_typec_port(dev);
1662 return sprintf(buf, "%s\n",
1663 port->vconn_role == TYPEC_SOURCE ? "yes" : "no");
1665 static DEVICE_ATTR_RW(vconn_source);
1667 static ssize_t supported_accessory_modes_show(struct device *dev,
1668 struct device_attribute *attr,
1671 struct typec_port *port = to_typec_port(dev);
1675 for (i = 0; i < ARRAY_SIZE(port->cap->accessory); i++) {
1676 if (port->cap->accessory[i])
1677 ret += sprintf(buf + ret, "%s ",
1678 typec_accessory_modes[port->cap->accessory[i]]);
1682 return sprintf(buf, "none\n");
1684 buf[ret - 1] = '\n';
1688 static DEVICE_ATTR_RO(supported_accessory_modes);
1690 static ssize_t usb_typec_revision_show(struct device *dev,
1691 struct device_attribute *attr,
1694 struct typec_port *port = to_typec_port(dev);
1695 u16 rev = port->cap->revision;
1697 return sprintf(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1699 static DEVICE_ATTR_RO(usb_typec_revision);
1701 static ssize_t usb_power_delivery_revision_show(struct device *dev,
1702 struct device_attribute *attr,
1707 if (is_typec_partner(dev)) {
1708 struct typec_partner *partner = to_typec_partner(dev);
1710 rev = partner->pd_revision;
1711 } else if (is_typec_cable(dev)) {
1712 struct typec_cable *cable = to_typec_cable(dev);
1714 rev = cable->pd_revision;
1715 } else if (is_typec_port(dev)) {
1716 struct typec_port *p = to_typec_port(dev);
1718 rev = p->cap->pd_revision;
1720 return sysfs_emit(buf, "%d.%d\n", (rev >> 8) & 0xff, (rev >> 4) & 0xf);
1723 static ssize_t orientation_show(struct device *dev,
1724 struct device_attribute *attr,
1727 struct typec_port *port = to_typec_port(dev);
1729 return sprintf(buf, "%s\n", typec_orientations[port->orientation]);
1731 static DEVICE_ATTR_RO(orientation);
1733 static struct attribute *typec_attrs[] = {
1734 &dev_attr_data_role.attr,
1735 &dev_attr_power_operation_mode.attr,
1736 &dev_attr_power_role.attr,
1737 &dev_attr_preferred_role.attr,
1738 &dev_attr_supported_accessory_modes.attr,
1739 &dev_attr_usb_power_delivery_revision.attr,
1740 &dev_attr_usb_typec_revision.attr,
1741 &dev_attr_vconn_source.attr,
1742 &dev_attr_port_type.attr,
1743 &dev_attr_orientation.attr,
1747 static umode_t typec_attr_is_visible(struct kobject *kobj,
1748 struct attribute *attr, int n)
1750 struct typec_port *port = to_typec_port(kobj_to_dev(kobj));
1752 if (attr == &dev_attr_data_role.attr) {
1753 if (port->cap->data != TYPEC_PORT_DRD ||
1754 !port->ops || !port->ops->dr_set)
1756 } else if (attr == &dev_attr_power_role.attr) {
1757 if (port->cap->type != TYPEC_PORT_DRP ||
1758 !port->ops || !port->ops->pr_set)
1760 } else if (attr == &dev_attr_vconn_source.attr) {
1761 if (!port->cap->pd_revision ||
1762 !port->ops || !port->ops->vconn_set)
1764 } else if (attr == &dev_attr_preferred_role.attr) {
1765 if (port->cap->type != TYPEC_PORT_DRP ||
1766 !port->ops || !port->ops->try_role)
1768 } else if (attr == &dev_attr_port_type.attr) {
1769 if (!port->ops || !port->ops->port_type_set)
1771 if (port->cap->type != TYPEC_PORT_DRP)
1773 } else if (attr == &dev_attr_orientation.attr) {
1774 if (port->cap->orientation_aware)
1782 static const struct attribute_group typec_group = {
1783 .is_visible = typec_attr_is_visible,
1784 .attrs = typec_attrs,
1787 static const struct attribute_group *typec_groups[] = {
1793 static int typec_uevent(const struct device *dev, struct kobj_uevent_env *env)
1797 ret = add_uevent_var(env, "TYPEC_PORT=%s", dev_name(dev));
1799 dev_err(dev, "failed to add uevent TYPEC_PORT\n");
1804 static void typec_release(struct device *dev)
1806 struct typec_port *port = to_typec_port(dev);
1808 ida_free(&typec_index_ida, port->id);
1809 ida_destroy(&port->mode_ids);
1810 typec_switch_put(port->sw);
1811 typec_mux_put(port->mux);
1812 typec_retimer_put(port->retimer);
1817 const struct device_type typec_port_dev_type = {
1818 .name = "typec_port",
1819 .groups = typec_groups,
1820 .uevent = typec_uevent,
1821 .release = typec_release,
1824 /* --------------------------------------- */
1825 /* Driver callbacks to report role updates */
1827 static int partner_match(struct device *dev, void *data)
1829 return is_typec_partner(dev);
1832 static struct typec_partner *typec_get_partner(struct typec_port *port)
1836 dev = device_find_child(&port->dev, NULL, partner_match);
1840 return to_typec_partner(dev);
1843 static void typec_partner_attach(struct typec_connector *con, struct device *dev)
1845 struct typec_port *port = container_of(con, struct typec_port, con);
1846 struct typec_partner *partner = typec_get_partner(port);
1847 struct usb_device *udev = to_usb_device(dev);
1849 if (udev->speed < USB_SPEED_SUPER)
1850 port->usb2_dev = dev;
1852 port->usb3_dev = dev;
1855 typec_partner_link_device(partner, dev);
1856 put_device(&partner->dev);
1860 static void typec_partner_deattach(struct typec_connector *con, struct device *dev)
1862 struct typec_port *port = container_of(con, struct typec_port, con);
1863 struct typec_partner *partner = typec_get_partner(port);
1866 typec_partner_unlink_device(partner, dev);
1867 put_device(&partner->dev);
1870 if (port->usb2_dev == dev)
1871 port->usb2_dev = NULL;
1872 else if (port->usb3_dev == dev)
1873 port->usb3_dev = NULL;
1877 * typec_set_data_role - Report data role change
1878 * @port: The USB Type-C Port where the role was changed
1879 * @role: The new data role
1881 * This routine is used by the port drivers to report data role changes.
1883 void typec_set_data_role(struct typec_port *port, enum typec_data_role role)
1885 struct typec_partner *partner;
1887 if (port->data_role == role)
1890 port->data_role = role;
1891 sysfs_notify(&port->dev.kobj, NULL, "data_role");
1892 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1894 partner = typec_get_partner(port);
1898 if (partner->identity)
1899 typec_product_type_notify(&partner->dev);
1901 put_device(&partner->dev);
1903 EXPORT_SYMBOL_GPL(typec_set_data_role);
1906 * typec_set_pwr_role - Report power role change
1907 * @port: The USB Type-C Port where the role was changed
1908 * @role: The new data role
1910 * This routine is used by the port drivers to report power role changes.
1912 void typec_set_pwr_role(struct typec_port *port, enum typec_role role)
1914 if (port->pwr_role == role)
1917 port->pwr_role = role;
1918 sysfs_notify(&port->dev.kobj, NULL, "power_role");
1919 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1921 EXPORT_SYMBOL_GPL(typec_set_pwr_role);
1924 * typec_set_vconn_role - Report VCONN source change
1925 * @port: The USB Type-C Port which VCONN role changed
1926 * @role: Source when @port is sourcing VCONN, or Sink when it's not
1928 * This routine is used by the port drivers to report if the VCONN source is
1931 void typec_set_vconn_role(struct typec_port *port, enum typec_role role)
1933 if (port->vconn_role == role)
1936 port->vconn_role = role;
1937 sysfs_notify(&port->dev.kobj, NULL, "vconn_source");
1938 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1940 EXPORT_SYMBOL_GPL(typec_set_vconn_role);
1943 * typec_set_pwr_opmode - Report changed power operation mode
1944 * @port: The USB Type-C Port where the mode was changed
1945 * @opmode: New power operation mode
1947 * This routine is used by the port drivers to report changed power operation
1948 * mode in @port. The modes are USB (default), 1.5A, 3.0A as defined in USB
1949 * Type-C specification, and "USB Power Delivery" when the power levels are
1950 * negotiated with methods defined in USB Power Delivery specification.
1952 void typec_set_pwr_opmode(struct typec_port *port,
1953 enum typec_pwr_opmode opmode)
1955 struct device *partner_dev;
1957 if (port->pwr_opmode == opmode)
1960 port->pwr_opmode = opmode;
1961 sysfs_notify(&port->dev.kobj, NULL, "power_operation_mode");
1962 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
1964 partner_dev = device_find_child(&port->dev, NULL, partner_match);
1966 struct typec_partner *partner = to_typec_partner(partner_dev);
1968 if (opmode == TYPEC_PWR_MODE_PD && !partner->usb_pd) {
1969 partner->usb_pd = 1;
1970 sysfs_notify(&partner_dev->kobj, NULL,
1971 "supports_usb_power_delivery");
1972 kobject_uevent(&partner_dev->kobj, KOBJ_CHANGE);
1974 put_device(partner_dev);
1977 EXPORT_SYMBOL_GPL(typec_set_pwr_opmode);
1980 * typec_find_pwr_opmode - Get the typec power operation mode capability
1981 * @name: power operation mode string
1983 * This routine is used to find the typec_pwr_opmode by its string @name.
1985 * Returns typec_pwr_opmode if success, otherwise negative error code.
1987 int typec_find_pwr_opmode(const char *name)
1989 return match_string(typec_pwr_opmodes,
1990 ARRAY_SIZE(typec_pwr_opmodes), name);
1992 EXPORT_SYMBOL_GPL(typec_find_pwr_opmode);
1995 * typec_find_orientation - Convert orientation string to enum typec_orientation
1996 * @name: Orientation string
1998 * This routine is used to find the typec_orientation by its string name @name.
2000 * Returns the orientation value on success, otherwise negative error code.
2002 int typec_find_orientation(const char *name)
2004 return match_string(typec_orientations, ARRAY_SIZE(typec_orientations),
2007 EXPORT_SYMBOL_GPL(typec_find_orientation);
2010 * typec_find_port_power_role - Get the typec port power capability
2011 * @name: port power capability string
2013 * This routine is used to find the typec_port_type by its string name.
2015 * Returns typec_port_type if success, otherwise negative error code.
2017 int typec_find_port_power_role(const char *name)
2019 return match_string(typec_port_power_roles,
2020 ARRAY_SIZE(typec_port_power_roles), name);
2022 EXPORT_SYMBOL_GPL(typec_find_port_power_role);
2025 * typec_find_power_role - Find the typec one specific power role
2026 * @name: power role string
2028 * This routine is used to find the typec_role by its string name.
2030 * Returns typec_role if success, otherwise negative error code.
2032 int typec_find_power_role(const char *name)
2034 return match_string(typec_roles, ARRAY_SIZE(typec_roles), name);
2036 EXPORT_SYMBOL_GPL(typec_find_power_role);
2039 * typec_find_port_data_role - Get the typec port data capability
2040 * @name: port data capability string
2042 * This routine is used to find the typec_port_data by its string name.
2044 * Returns typec_port_data if success, otherwise negative error code.
2046 int typec_find_port_data_role(const char *name)
2048 return match_string(typec_port_data_roles,
2049 ARRAY_SIZE(typec_port_data_roles), name);
2051 EXPORT_SYMBOL_GPL(typec_find_port_data_role);
2053 /* ------------------------------------------ */
2054 /* API for Multiplexer/DeMultiplexer Switches */
2057 * typec_set_orientation - Set USB Type-C cable plug orientation
2058 * @port: USB Type-C Port
2059 * @orientation: USB Type-C cable plug orientation
2061 * Set cable plug orientation for @port.
2063 int typec_set_orientation(struct typec_port *port,
2064 enum typec_orientation orientation)
2068 ret = typec_switch_set(port->sw, orientation);
2072 port->orientation = orientation;
2073 sysfs_notify(&port->dev.kobj, NULL, "orientation");
2074 kobject_uevent(&port->dev.kobj, KOBJ_CHANGE);
2078 EXPORT_SYMBOL_GPL(typec_set_orientation);
2081 * typec_get_orientation - Get USB Type-C cable plug orientation
2082 * @port: USB Type-C Port
2084 * Get current cable plug orientation for @port.
2086 enum typec_orientation typec_get_orientation(struct typec_port *port)
2088 return port->orientation;
2090 EXPORT_SYMBOL_GPL(typec_get_orientation);
2093 * typec_set_mode - Set mode of operation for USB Type-C connector
2094 * @port: USB Type-C connector
2095 * @mode: Accessory Mode, USB Operation or Safe State
2097 * Configure @port for Accessory Mode @mode. This function will configure the
2098 * muxes needed for @mode.
2100 int typec_set_mode(struct typec_port *port, int mode)
2102 struct typec_mux_state state = { };
2106 return typec_mux_set(port->mux, &state);
2108 EXPORT_SYMBOL_GPL(typec_set_mode);
2110 /* --------------------------------------- */
2113 * typec_get_negotiated_svdm_version - Get negotiated SVDM Version
2114 * @port: USB Type-C Port.
2116 * Get the negotiated SVDM Version. The Version is set to the port default
2117 * value stored in typec_capability on partner registration, and updated after
2118 * a successful Discover Identity if the negotiated value is less than the
2121 * Returns usb_pd_svdm_ver if the partner has been registered otherwise -ENODEV.
2123 int typec_get_negotiated_svdm_version(struct typec_port *port)
2125 enum usb_pd_svdm_ver svdm_version;
2126 struct device *partner_dev;
2128 partner_dev = device_find_child(&port->dev, NULL, partner_match);
2132 svdm_version = to_typec_partner(partner_dev)->svdm_version;
2133 put_device(partner_dev);
2135 return svdm_version;
2137 EXPORT_SYMBOL_GPL(typec_get_negotiated_svdm_version);
2140 * typec_get_drvdata - Return private driver data pointer
2141 * @port: USB Type-C port
2143 void *typec_get_drvdata(struct typec_port *port)
2145 return dev_get_drvdata(&port->dev);
2147 EXPORT_SYMBOL_GPL(typec_get_drvdata);
2149 int typec_get_fw_cap(struct typec_capability *cap,
2150 struct fwnode_handle *fwnode)
2152 const char *cap_str;
2155 cap->fwnode = fwnode;
2157 ret = fwnode_property_read_string(fwnode, "power-role", &cap_str);
2161 ret = typec_find_port_power_role(cap_str);
2166 /* USB data support is optional */
2167 ret = fwnode_property_read_string(fwnode, "data-role", &cap_str);
2169 ret = typec_find_port_data_role(cap_str);
2175 /* Get the preferred power role for a DRP */
2176 if (cap->type == TYPEC_PORT_DRP) {
2177 cap->prefer_role = TYPEC_NO_PREFERRED_ROLE;
2179 ret = fwnode_property_read_string(fwnode, "try-power-role", &cap_str);
2181 ret = typec_find_power_role(cap_str);
2184 cap->prefer_role = ret;
2190 EXPORT_SYMBOL_GPL(typec_get_fw_cap);
2193 * typec_port_register_altmode - Register USB Type-C Port Alternate Mode
2194 * @port: USB Type-C Port that supports the alternate mode
2195 * @desc: Description of the alternate mode
2197 * This routine is used to register an alternate mode that @port is capable of
2200 * Returns handle to the alternate mode on success or ERR_PTR on failure.
2202 struct typec_altmode *
2203 typec_port_register_altmode(struct typec_port *port,
2204 const struct typec_altmode_desc *desc)
2206 struct typec_altmode *adev;
2207 struct typec_mux *mux;
2208 struct typec_retimer *retimer;
2210 mux = typec_mux_get(&port->dev);
2212 return ERR_CAST(mux);
2214 retimer = typec_retimer_get(&port->dev);
2215 if (IS_ERR(retimer)) {
2217 return ERR_CAST(retimer);
2220 adev = typec_register_altmode(&port->dev, desc);
2222 typec_retimer_put(retimer);
2225 to_altmode(adev)->mux = mux;
2226 to_altmode(adev)->retimer = retimer;
2231 EXPORT_SYMBOL_GPL(typec_port_register_altmode);
2233 void typec_port_register_altmodes(struct typec_port *port,
2234 const struct typec_altmode_ops *ops, void *drvdata,
2235 struct typec_altmode **altmodes, size_t n)
2237 struct fwnode_handle *altmodes_node, *child;
2238 struct typec_altmode_desc desc;
2239 struct typec_altmode *alt;
2245 altmodes_node = device_get_named_child_node(&port->dev, "altmodes");
2247 return; /* No altmodes specified */
2249 fwnode_for_each_child_node(altmodes_node, child) {
2250 ret = fwnode_property_read_u16(child, "svid", &svid);
2252 dev_err(&port->dev, "Error reading svid for altmode %s\n",
2253 fwnode_get_name(child));
2257 ret = fwnode_property_read_u32(child, "vdo", &vdo);
2259 dev_err(&port->dev, "Error reading vdo for altmode %s\n",
2260 fwnode_get_name(child));
2265 dev_err(&port->dev, "Error not enough space for altmode %s\n",
2266 fwnode_get_name(child));
2272 desc.mode = index + 1;
2273 alt = typec_port_register_altmode(port, &desc);
2275 dev_err(&port->dev, "Error registering altmode %s\n",
2276 fwnode_get_name(child));
2281 typec_altmode_set_drvdata(alt, drvdata);
2282 altmodes[index] = alt;
2286 EXPORT_SYMBOL_GPL(typec_port_register_altmodes);
2289 * typec_register_port - Register a USB Type-C Port
2290 * @parent: Parent device
2291 * @cap: Description of the port
2293 * Registers a device for USB Type-C Port described in @cap.
2295 * Returns handle to the port on success or ERR_PTR on failure.
2297 struct typec_port *typec_register_port(struct device *parent,
2298 const struct typec_capability *cap)
2300 struct typec_port *port;
2304 port = kzalloc(sizeof(*port), GFP_KERNEL);
2306 return ERR_PTR(-ENOMEM);
2308 id = ida_alloc(&typec_index_ida, GFP_KERNEL);
2314 switch (cap->type) {
2315 case TYPEC_PORT_SRC:
2316 port->pwr_role = TYPEC_SOURCE;
2317 port->vconn_role = TYPEC_SOURCE;
2319 case TYPEC_PORT_SNK:
2320 port->pwr_role = TYPEC_SINK;
2321 port->vconn_role = TYPEC_SINK;
2323 case TYPEC_PORT_DRP:
2324 if (cap->prefer_role != TYPEC_NO_PREFERRED_ROLE)
2325 port->pwr_role = cap->prefer_role;
2327 port->pwr_role = TYPEC_SINK;
2331 switch (cap->data) {
2332 case TYPEC_PORT_DFP:
2333 port->data_role = TYPEC_HOST;
2335 case TYPEC_PORT_UFP:
2336 port->data_role = TYPEC_DEVICE;
2338 case TYPEC_PORT_DRD:
2339 if (cap->prefer_role == TYPEC_SOURCE)
2340 port->data_role = TYPEC_HOST;
2342 port->data_role = TYPEC_DEVICE;
2346 ida_init(&port->mode_ids);
2347 mutex_init(&port->port_type_lock);
2350 port->ops = cap->ops;
2351 port->port_type = cap->type;
2352 port->prefer_role = cap->prefer_role;
2353 port->con.attach = typec_partner_attach;
2354 port->con.deattach = typec_partner_deattach;
2356 device_initialize(&port->dev);
2357 port->dev.class = &typec_class;
2358 port->dev.parent = parent;
2359 port->dev.fwnode = cap->fwnode;
2360 port->dev.type = &typec_port_dev_type;
2361 dev_set_name(&port->dev, "port%d", id);
2362 dev_set_drvdata(&port->dev, cap->driver_data);
2364 port->cap = kmemdup(cap, sizeof(*cap), GFP_KERNEL);
2366 put_device(&port->dev);
2367 return ERR_PTR(-ENOMEM);
2370 port->sw = typec_switch_get(&port->dev);
2371 if (IS_ERR(port->sw)) {
2372 ret = PTR_ERR(port->sw);
2373 put_device(&port->dev);
2374 return ERR_PTR(ret);
2377 port->mux = typec_mux_get(&port->dev);
2378 if (IS_ERR(port->mux)) {
2379 ret = PTR_ERR(port->mux);
2380 put_device(&port->dev);
2381 return ERR_PTR(ret);
2384 port->retimer = typec_retimer_get(&port->dev);
2385 if (IS_ERR(port->retimer)) {
2386 ret = PTR_ERR(port->retimer);
2387 put_device(&port->dev);
2388 return ERR_PTR(ret);
2393 ret = device_add(&port->dev);
2395 dev_err(parent, "failed to register port (%d)\n", ret);
2396 put_device(&port->dev);
2397 return ERR_PTR(ret);
2400 ret = usb_power_delivery_link_device(port->pd, &port->dev);
2402 dev_err(&port->dev, "failed to link pd\n");
2403 device_unregister(&port->dev);
2404 return ERR_PTR(ret);
2407 ret = typec_link_ports(port);
2409 dev_warn(&port->dev, "failed to create symlinks (%d)\n", ret);
2413 EXPORT_SYMBOL_GPL(typec_register_port);
2416 * typec_unregister_port - Unregister a USB Type-C Port
2417 * @port: The port to be unregistered
2419 * Unregister device created with typec_register_port().
2421 void typec_unregister_port(struct typec_port *port)
2423 if (!IS_ERR_OR_NULL(port)) {
2424 typec_unlink_ports(port);
2425 typec_port_set_usb_power_delivery(port, NULL);
2426 device_unregister(&port->dev);
2429 EXPORT_SYMBOL_GPL(typec_unregister_port);
2431 static int __init typec_init(void)
2435 ret = bus_register(&typec_bus);
2439 ret = class_register(&typec_mux_class);
2441 goto err_unregister_bus;
2443 ret = class_register(&retimer_class);
2445 goto err_unregister_mux_class;
2447 ret = class_register(&typec_class);
2449 goto err_unregister_retimer_class;
2451 ret = usb_power_delivery_init();
2453 goto err_unregister_class;
2457 err_unregister_class:
2458 class_unregister(&typec_class);
2460 err_unregister_retimer_class:
2461 class_unregister(&retimer_class);
2463 err_unregister_mux_class:
2464 class_unregister(&typec_mux_class);
2467 bus_unregister(&typec_bus);
2471 subsys_initcall(typec_init);
2473 static void __exit typec_exit(void)
2475 usb_power_delivery_exit();
2476 class_unregister(&typec_class);
2477 ida_destroy(&typec_index_ida);
2478 bus_unregister(&typec_bus);
2479 class_unregister(&typec_mux_class);
2480 class_unregister(&retimer_class);
2482 module_exit(typec_exit);
2484 MODULE_AUTHOR("Heikki Krogerus <heikki.krogerus@linux.intel.com>");
2485 MODULE_LICENSE("GPL v2");
2486 MODULE_DESCRIPTION("USB Type-C Connector Class");