1 // SPDX-License-Identifier: GPL-2.0
3 * Driver for Intel PMC USB mux control
5 * Copyright (C) 2020 Intel Corporation
6 * Author: Heikki Krogerus <heikki.krogerus@linux.intel.com>
9 #include <linux/acpi.h>
10 #include <linux/module.h>
11 #include <linux/platform_device.h>
12 #include <linux/property.h>
13 #include <linux/usb/pd.h>
14 #include <linux/usb/role.h>
15 #include <linux/usb/typec_mux.h>
16 #include <linux/usb/typec_dp.h>
17 #include <linux/usb/typec_tbt.h>
19 #include <asm/intel_scu_ipc.h>
21 #define PMC_USBC_CMD 0xa7
23 /* Response status bits */
24 #define PMC_USB_RESP_STATUS_FAILURE BIT(0)
25 #define PMC_USB_RESP_STATUS_FATAL BIT(1)
27 /* "Usage" OOB Message field values */
36 #define PMC_USB_MSG_USB2_PORT_SHIFT 0
37 #define PMC_USB_MSG_USB3_PORT_SHIFT 4
38 #define PMC_USB_MSG_UFP_SHIFT 4
39 #define PMC_USB_MSG_ORI_HSL_SHIFT 5
40 #define PMC_USB_MSG_ORI_AUX_SHIFT 6
42 /* Alt Mode Request */
51 #define PMC_USB_MODE_TYPE_SHIFT 4
54 PMC_USB_MODE_TYPE_USB,
56 PMC_USB_MODE_TYPE_TBT,
59 /* Common Mode Data bits */
60 #define PMC_USB_ALTMODE_ACTIVE_CABLE BIT(2)
62 #define PMC_USB_ALTMODE_ORI_SHIFT 1
63 #define PMC_USB_ALTMODE_UFP_SHIFT 3
65 /* DP specific Mode Data bits */
66 #define PMC_USB_ALTMODE_DP_MODE_SHIFT 8
68 /* TBT specific Mode Data bits */
69 #define PMC_USB_ALTMODE_TBT_TYPE BIT(17)
70 #define PMC_USB_ALTMODE_CABLE_TYPE BIT(18)
71 #define PMC_USB_ALTMODE_ACTIVE_LINK BIT(20)
72 #define PMC_USB_ALTMODE_FORCE_LSR BIT(23)
73 #define PMC_USB_ALTMODE_CABLE_SPD(_s_) (((_s_) & GENMASK(2, 0)) << 25)
74 #define PMC_USB_ALTMODE_CABLE_USB31 1
75 #define PMC_USB_ALTMODE_CABLE_10GPS 2
76 #define PMC_USB_ALTMODE_CABLE_20GPS 3
77 #define PMC_USB_ALTMODE_TBT_GEN(_g_) (((_g_) & GENMASK(1, 0)) << 28)
79 /* Display HPD Request bits */
80 #define PMC_USB_DP_HPD_LVL BIT(4)
81 #define PMC_USB_DP_HPD_IRQ BIT(5)
84 * Input Output Manager (IOM) PORT STATUS
86 #define IOM_PORT_STATUS_ACTIVITY_TYPE_MASK GENMASK(9, 6)
87 #define IOM_PORT_STATUS_ACTIVITY_TYPE_SHIFT 6
88 #define IOM_PORT_STATUS_ACTIVITY_TYPE_USB 0x03
89 /* activity type: Safe Mode */
90 #define IOM_PORT_STATUS_ACTIVITY_TYPE_SAFE_MODE 0x04
91 /* activity type: Display Port */
92 #define IOM_PORT_STATUS_ACTIVITY_TYPE_DP 0x05
93 /* activity type: Display Port Multi Function Device */
94 #define IOM_PORT_STATUS_ACTIVITY_TYPE_DP_MFD 0x06
95 /* activity type: Thunderbolt */
96 #define IOM_PORT_STATUS_ACTIVITY_TYPE_TBT 0x07
97 #define IOM_PORT_STATUS_ACTIVITY_TYPE_ALT_MODE_USB 0x0c
98 #define IOM_PORT_STATUS_ACTIVITY_TYPE_ALT_MODE_TBT_USB 0x0d
99 /* Upstream Facing Port Information */
100 #define IOM_PORT_STATUS_UFP BIT(10)
101 /* Display Port Hot Plug Detect status */
102 #define IOM_PORT_STATUS_DHPD_HPD_STATUS_MASK GENMASK(13, 12)
103 #define IOM_PORT_STATUS_DHPD_HPD_STATUS_SHIFT 12
104 #define IOM_PORT_STATUS_DHPD_HPD_STATUS_ASSERT 0x01
105 #define IOM_PORT_STATUS_DHPD_HPD_SOURCE_TBT BIT(14)
106 #define IOM_PORT_STATUS_CONNECTED BIT(31)
108 #define IOM_PORT_ACTIVITY_IS(_status_, _type_) \
109 ((((_status_) & IOM_PORT_STATUS_ACTIVITY_TYPE_MASK) >> \
110 IOM_PORT_STATUS_ACTIVITY_TYPE_SHIFT) == \
111 (IOM_PORT_STATUS_ACTIVITY_TYPE_##_type_))
113 #define IOM_PORT_HPD_ASSERTED(_status_) \
114 ((((_status_) & IOM_PORT_STATUS_DHPD_HPD_STATUS_MASK) >> \
115 IOM_PORT_STATUS_DHPD_HPD_STATUS_SHIFT) & \
116 IOM_PORT_STATUS_DHPD_HPD_STATUS_ASSERT)
120 struct pmc_usb_port {
124 struct typec_mux *typec_mux;
125 struct typec_switch *typec_sw;
126 struct usb_role_switch *usb_sw;
128 enum typec_orientation orientation;
134 enum typec_orientation sbu_orientation;
135 enum typec_orientation hsl_orientation;
141 struct intel_scu_ipc_dev *ipc;
142 struct pmc_usb_port *port;
143 struct acpi_device *iom_adev;
144 void __iomem *iom_base;
145 u32 iom_port_status_offset;
148 static void update_port_status(struct pmc_usb_port *port)
152 /* SoC expects the USB Type-C port numbers to start with 0 */
153 port_num = port->usb3_port - 1;
155 port->iom_status = readl(port->pmc->iom_base +
156 port->pmc->iom_port_status_offset +
157 port_num * sizeof(u32));
160 static int sbu_orientation(struct pmc_usb_port *port)
162 if (port->sbu_orientation)
163 return port->sbu_orientation - 1;
165 return port->orientation - 1;
168 static int hsl_orientation(struct pmc_usb_port *port)
170 if (port->hsl_orientation)
171 return port->hsl_orientation - 1;
173 return port->orientation - 1;
176 static int pmc_usb_command(struct pmc_usb_port *port, u8 *msg, u32 len)
182 * Error bit will always be 0 with the USBC command.
183 * Status can be checked from the response message if the
184 * function intel_scu_ipc_dev_command succeeds.
186 ret = intel_scu_ipc_dev_command(port->pmc->ipc, PMC_USBC_CMD, 0, msg,
187 len, response, sizeof(response));
192 if (response[2] & PMC_USB_RESP_STATUS_FAILURE) {
193 if (response[2] & PMC_USB_RESP_STATUS_FATAL)
202 pmc_usb_mux_dp_hpd(struct pmc_usb_port *port, struct typec_displayport_data *dp)
207 msg[0] = PMC_USB_DP_HPD;
208 msg[0] |= port->usb3_port << PMC_USB_MSG_USB3_PORT_SHIFT;
210 /* Configure HPD first if HPD,IRQ comes together */
211 if (!IOM_PORT_HPD_ASSERTED(port->iom_status) &&
212 dp->status & DP_STATUS_IRQ_HPD &&
213 dp->status & DP_STATUS_HPD_STATE) {
214 msg[1] = PMC_USB_DP_HPD_LVL;
215 ret = pmc_usb_command(port, msg, sizeof(msg));
220 if (dp->status & DP_STATUS_IRQ_HPD)
221 msg[1] = PMC_USB_DP_HPD_IRQ;
223 if (dp->status & DP_STATUS_HPD_STATE)
224 msg[1] |= PMC_USB_DP_HPD_LVL;
226 return pmc_usb_command(port, msg, sizeof(msg));
230 pmc_usb_mux_dp(struct pmc_usb_port *port, struct typec_mux_state *state)
232 struct typec_displayport_data *data = state->data;
233 struct altmode_req req = { };
236 if (IOM_PORT_ACTIVITY_IS(port->iom_status, DP) ||
237 IOM_PORT_ACTIVITY_IS(port->iom_status, DP_MFD)) {
238 if (IOM_PORT_HPD_ASSERTED(port->iom_status) &&
239 (!(data->status & DP_STATUS_IRQ_HPD) &&
240 data->status & DP_STATUS_HPD_STATE))
243 return pmc_usb_mux_dp_hpd(port, state->data);
246 req.usage = PMC_USB_ALT_MODE;
247 req.usage |= port->usb3_port << PMC_USB_MSG_USB3_PORT_SHIFT;
248 req.mode_type = PMC_USB_MODE_TYPE_DP << PMC_USB_MODE_TYPE_SHIFT;
250 req.mode_data = (port->orientation - 1) << PMC_USB_ALTMODE_ORI_SHIFT;
251 req.mode_data |= (port->role - 1) << PMC_USB_ALTMODE_UFP_SHIFT;
253 req.mode_data |= (state->mode - TYPEC_STATE_MODAL) <<
254 PMC_USB_ALTMODE_DP_MODE_SHIFT;
256 ret = pmc_usb_command(port, (void *)&req, sizeof(req));
260 if (data->status & (DP_STATUS_IRQ_HPD | DP_STATUS_HPD_STATE))
261 return pmc_usb_mux_dp_hpd(port, state->data);
267 pmc_usb_mux_tbt(struct pmc_usb_port *port, struct typec_mux_state *state)
269 struct typec_thunderbolt_data *data = state->data;
270 u8 cable_speed = TBT_CABLE_SPEED(data->cable_mode);
271 struct altmode_req req = { };
273 if (IOM_PORT_ACTIVITY_IS(port->iom_status, TBT) ||
274 IOM_PORT_ACTIVITY_IS(port->iom_status, ALT_MODE_TBT_USB))
277 req.usage = PMC_USB_ALT_MODE;
278 req.usage |= port->usb3_port << PMC_USB_MSG_USB3_PORT_SHIFT;
279 req.mode_type = PMC_USB_MODE_TYPE_TBT << PMC_USB_MODE_TYPE_SHIFT;
281 req.mode_data = (port->orientation - 1) << PMC_USB_ALTMODE_ORI_SHIFT;
282 req.mode_data |= (port->role - 1) << PMC_USB_ALTMODE_UFP_SHIFT;
284 if (TBT_ADAPTER(data->device_mode) == TBT_ADAPTER_TBT3)
285 req.mode_data |= PMC_USB_ALTMODE_TBT_TYPE;
287 if (data->cable_mode & TBT_CABLE_OPTICAL)
288 req.mode_data |= PMC_USB_ALTMODE_CABLE_TYPE;
290 if (data->cable_mode & TBT_CABLE_LINK_TRAINING)
291 req.mode_data |= PMC_USB_ALTMODE_ACTIVE_LINK;
293 if (data->enter_vdo & TBT_ENTER_MODE_ACTIVE_CABLE)
294 req.mode_data |= PMC_USB_ALTMODE_ACTIVE_CABLE;
296 req.mode_data |= PMC_USB_ALTMODE_CABLE_SPD(cable_speed);
298 return pmc_usb_command(port, (void *)&req, sizeof(req));
302 pmc_usb_mux_usb4(struct pmc_usb_port *port, struct typec_mux_state *state)
304 struct enter_usb_data *data = state->data;
305 struct altmode_req req = { };
308 if (IOM_PORT_ACTIVITY_IS(port->iom_status, TBT) ||
309 IOM_PORT_ACTIVITY_IS(port->iom_status, ALT_MODE_TBT_USB))
312 req.usage = PMC_USB_ALT_MODE;
313 req.usage |= port->usb3_port << PMC_USB_MSG_USB3_PORT_SHIFT;
314 req.mode_type = PMC_USB_MODE_TYPE_TBT << PMC_USB_MODE_TYPE_SHIFT;
317 req.mode_data = PMC_USB_ALTMODE_FORCE_LSR;
319 if (data->active_link_training)
320 req.mode_data |= PMC_USB_ALTMODE_ACTIVE_LINK;
322 req.mode_data |= (port->orientation - 1) << PMC_USB_ALTMODE_ORI_SHIFT;
323 req.mode_data |= (port->role - 1) << PMC_USB_ALTMODE_UFP_SHIFT;
325 switch ((data->eudo & EUDO_CABLE_TYPE_MASK) >> EUDO_CABLE_TYPE_SHIFT) {
326 case EUDO_CABLE_TYPE_PASSIVE:
328 case EUDO_CABLE_TYPE_OPTICAL:
329 req.mode_data |= PMC_USB_ALTMODE_CABLE_TYPE;
332 req.mode_data |= PMC_USB_ALTMODE_ACTIVE_CABLE;
336 cable_speed = (data->eudo & EUDO_CABLE_SPEED_MASK) >> EUDO_CABLE_SPEED_SHIFT;
337 req.mode_data |= PMC_USB_ALTMODE_CABLE_SPD(cable_speed);
339 return pmc_usb_command(port, (void *)&req, sizeof(req));
342 static int pmc_usb_mux_safe_state(struct pmc_usb_port *port)
346 if (IOM_PORT_ACTIVITY_IS(port->iom_status, SAFE_MODE))
349 msg = PMC_USB_SAFE_MODE;
350 msg |= port->usb3_port << PMC_USB_MSG_USB3_PORT_SHIFT;
352 return pmc_usb_command(port, &msg, sizeof(msg));
355 static int pmc_usb_disconnect(struct pmc_usb_port *port)
357 struct typec_displayport_data data = { };
360 if (!(port->iom_status & IOM_PORT_STATUS_CONNECTED))
363 /* Clear DisplayPort HPD if it's still asserted. */
364 if (IOM_PORT_HPD_ASSERTED(port->iom_status))
365 pmc_usb_mux_dp_hpd(port, &data);
367 msg[0] = PMC_USB_DISCONNECT;
368 msg[0] |= port->usb3_port << PMC_USB_MSG_USB3_PORT_SHIFT;
370 msg[1] = port->usb2_port << PMC_USB_MSG_USB2_PORT_SHIFT;
372 return pmc_usb_command(port, msg, sizeof(msg));
375 static int pmc_usb_connect(struct pmc_usb_port *port, enum usb_role role)
377 u8 ufp = role == USB_ROLE_DEVICE ? 1 : 0;
381 if (port->orientation == TYPEC_ORIENTATION_NONE)
384 if (port->iom_status & IOM_PORT_STATUS_CONNECTED) {
385 if (port->role == role || port->role == USB_ROLE_NONE)
389 ret = pmc_usb_disconnect(port);
394 msg[0] = PMC_USB_CONNECT;
395 msg[0] |= port->usb3_port << PMC_USB_MSG_USB3_PORT_SHIFT;
397 msg[1] = port->usb2_port << PMC_USB_MSG_USB2_PORT_SHIFT;
398 msg[1] |= ufp << PMC_USB_MSG_UFP_SHIFT;
399 msg[1] |= hsl_orientation(port) << PMC_USB_MSG_ORI_HSL_SHIFT;
400 msg[1] |= sbu_orientation(port) << PMC_USB_MSG_ORI_AUX_SHIFT;
402 return pmc_usb_command(port, msg, sizeof(msg));
406 pmc_usb_mux_set(struct typec_mux *mux, struct typec_mux_state *state)
408 struct pmc_usb_port *port = typec_mux_get_drvdata(mux);
410 update_port_status(port);
412 if (port->orientation == TYPEC_ORIENTATION_NONE || port->role == USB_ROLE_NONE)
415 if (state->mode == TYPEC_STATE_SAFE)
416 return pmc_usb_mux_safe_state(port);
417 if (state->mode == TYPEC_STATE_USB)
418 return pmc_usb_connect(port, port->role);
421 switch (state->alt->svid) {
422 case USB_TYPEC_TBT_SID:
423 return pmc_usb_mux_tbt(port, state);
424 case USB_TYPEC_DP_SID:
425 return pmc_usb_mux_dp(port, state);
428 switch (state->mode) {
429 case TYPEC_MODE_USB2:
430 /* REVISIT: Try with usb3_port set to 0? */
432 case TYPEC_MODE_USB3:
433 return pmc_usb_connect(port, port->role);
434 case TYPEC_MODE_USB4:
435 return pmc_usb_mux_usb4(port, state);
442 static int pmc_usb_set_orientation(struct typec_switch *sw,
443 enum typec_orientation orientation)
445 struct pmc_usb_port *port = typec_switch_get_drvdata(sw);
447 update_port_status(port);
449 port->orientation = orientation;
454 static int pmc_usb_set_role(struct usb_role_switch *sw, enum usb_role role)
456 struct pmc_usb_port *port = usb_role_switch_get_drvdata(sw);
459 update_port_status(port);
461 if (role == USB_ROLE_NONE)
462 ret = pmc_usb_disconnect(port);
464 ret = pmc_usb_connect(port, role);
471 static int pmc_usb_register_port(struct pmc_usb *pmc, int index,
472 struct fwnode_handle *fwnode)
474 struct pmc_usb_port *port = &pmc->port[index];
475 struct usb_role_switch_desc desc = { };
476 struct typec_switch_desc sw_desc = { };
477 struct typec_mux_desc mux_desc = { };
481 ret = fwnode_property_read_u8(fwnode, "usb2-port-number", &port->usb2_port);
485 ret = fwnode_property_read_u8(fwnode, "usb3-port-number", &port->usb3_port);
489 ret = fwnode_property_read_string(fwnode, "sbu-orientation", &str);
491 port->sbu_orientation = typec_find_orientation(str);
493 ret = fwnode_property_read_string(fwnode, "hsl-orientation", &str);
495 port->hsl_orientation = typec_find_orientation(str);
500 sw_desc.fwnode = fwnode;
501 sw_desc.drvdata = port;
502 sw_desc.name = fwnode_get_name(fwnode);
503 sw_desc.set = pmc_usb_set_orientation;
505 port->typec_sw = typec_switch_register(pmc->dev, &sw_desc);
506 if (IS_ERR(port->typec_sw))
507 return PTR_ERR(port->typec_sw);
509 mux_desc.fwnode = fwnode;
510 mux_desc.drvdata = port;
511 mux_desc.name = fwnode_get_name(fwnode);
512 mux_desc.set = pmc_usb_mux_set;
514 port->typec_mux = typec_mux_register(pmc->dev, &mux_desc);
515 if (IS_ERR(port->typec_mux)) {
516 ret = PTR_ERR(port->typec_mux);
517 goto err_unregister_switch;
520 desc.fwnode = fwnode;
521 desc.driver_data = port;
522 desc.name = fwnode_get_name(fwnode);
523 desc.set = pmc_usb_set_role;
525 port->usb_sw = usb_role_switch_register(pmc->dev, &desc);
526 if (IS_ERR(port->usb_sw)) {
527 ret = PTR_ERR(port->usb_sw);
528 goto err_unregister_mux;
534 typec_mux_unregister(port->typec_mux);
536 err_unregister_switch:
537 typec_switch_unregister(port->typec_sw);
542 static int is_memory(struct acpi_resource *res, void *data)
544 struct resource_win win = {};
545 struct resource *r = &win.res;
547 return !(acpi_dev_resource_memory(res, r) ||
548 acpi_dev_resource_address_space(res, &win));
551 /* IOM ACPI IDs and IOM_PORT_STATUS_OFFSET */
552 static const struct acpi_device_id iom_acpi_ids[] = {
554 { "INTC1072", 0x560, },
557 { "INTC1079", 0x160, },
560 { "INTC107A", 0x160, },
564 static int pmc_usb_probe_iom(struct pmc_usb *pmc)
566 struct list_head resource_list;
567 struct resource_entry *rentry;
568 static const struct acpi_device_id *dev_id;
569 struct acpi_device *adev = NULL;
572 for (dev_id = &iom_acpi_ids[0]; dev_id->id[0]; dev_id++) {
573 if (acpi_dev_present(dev_id->id, NULL, -1)) {
574 pmc->iom_port_status_offset = (u32)dev_id->driver_data;
575 adev = acpi_dev_get_first_match_dev(dev_id->id, NULL, -1);
583 INIT_LIST_HEAD(&resource_list);
584 ret = acpi_dev_get_resources(adev, &resource_list, is_memory, NULL);
588 rentry = list_first_entry_or_null(&resource_list, struct resource_entry, node);
590 pmc->iom_base = devm_ioremap_resource(pmc->dev, rentry->res);
592 acpi_dev_free_resource_list(&resource_list);
594 if (!pmc->iom_base) {
595 put_device(&adev->dev);
599 if (IS_ERR(pmc->iom_base)) {
600 put_device(&adev->dev);
601 return PTR_ERR(pmc->iom_base);
604 pmc->iom_adev = adev;
609 static int pmc_usb_probe(struct platform_device *pdev)
611 struct fwnode_handle *fwnode = NULL;
616 pmc = devm_kzalloc(&pdev->dev, sizeof(*pmc), GFP_KERNEL);
620 device_for_each_child_node(&pdev->dev, fwnode)
623 /* The IOM microcontroller has a limitation of max 4 ports. */
624 if (pmc->num_ports > 4) {
625 dev_err(&pdev->dev, "driver limited to 4 ports\n");
629 pmc->port = devm_kcalloc(&pdev->dev, pmc->num_ports,
630 sizeof(struct pmc_usb_port), GFP_KERNEL);
634 pmc->ipc = devm_intel_scu_ipc_dev_get(&pdev->dev);
638 pmc->dev = &pdev->dev;
640 ret = pmc_usb_probe_iom(pmc);
645 * For every physical USB connector (USB2 and USB3 combo) there is a
646 * child ACPI device node under the PMC mux ACPI device object.
648 for (i = 0; i < pmc->num_ports; i++) {
649 fwnode = device_get_next_child_node(pmc->dev, fwnode);
653 ret = pmc_usb_register_port(pmc, i, fwnode);
655 fwnode_handle_put(fwnode);
656 goto err_remove_ports;
660 platform_set_drvdata(pdev, pmc);
665 for (i = 0; i < pmc->num_ports; i++) {
666 typec_switch_unregister(pmc->port[i].typec_sw);
667 typec_mux_unregister(pmc->port[i].typec_mux);
668 usb_role_switch_unregister(pmc->port[i].usb_sw);
671 put_device(&pmc->iom_adev->dev);
676 static int pmc_usb_remove(struct platform_device *pdev)
678 struct pmc_usb *pmc = platform_get_drvdata(pdev);
681 for (i = 0; i < pmc->num_ports; i++) {
682 typec_switch_unregister(pmc->port[i].typec_sw);
683 typec_mux_unregister(pmc->port[i].typec_mux);
684 usb_role_switch_unregister(pmc->port[i].usb_sw);
687 put_device(&pmc->iom_adev->dev);
692 static const struct acpi_device_id pmc_usb_acpi_ids[] = {
696 MODULE_DEVICE_TABLE(acpi, pmc_usb_acpi_ids);
698 static struct platform_driver pmc_usb_driver = {
700 .name = "intel_pmc_usb",
701 .acpi_match_table = ACPI_PTR(pmc_usb_acpi_ids),
703 .probe = pmc_usb_probe,
704 .remove = pmc_usb_remove,
707 module_platform_driver(pmc_usb_driver);
709 MODULE_AUTHOR("Heikki Krogerus <heikki.krogerus@linux.intel.com>");
710 MODULE_LICENSE("GPL v2");
711 MODULE_DESCRIPTION("Intel PMC USB mux control");