1 // SPDX-License-Identifier: GPL-2.0+
3 * Power supply driver for ChromeOS EC based USB PD Charger.
5 * Copyright (c) 2014 - 2018 Google, Inc
8 #include <linux/module.h>
9 #include <linux/mfd/cros_ec.h>
10 #include <linux/mfd/cros_ec_commands.h>
11 #include <linux/platform_device.h>
12 #include <linux/power_supply.h>
13 #include <linux/slab.h>
15 #define CHARGER_USBPD_DIR_NAME "CROS_USBPD_CHARGER%d"
16 #define CHARGER_DEDICATED_DIR_NAME "CROS_DEDICATED_CHARGER"
17 #define CHARGER_DIR_NAME_LENGTH (sizeof(CHARGER_USBPD_DIR_NAME) >= \
18 sizeof(CHARGER_DEDICATED_DIR_NAME) ? \
19 sizeof(CHARGER_USBPD_DIR_NAME) : \
20 sizeof(CHARGER_DEDICATED_DIR_NAME))
21 #define CHARGER_CACHE_UPDATE_DELAY msecs_to_jiffies(500)
22 #define CHARGER_MANUFACTURER_MODEL_LENGTH 32
24 #define DRV_NAME "cros-usbpd-charger"
28 char name[CHARGER_DIR_NAME_LENGTH];
29 char manufacturer[CHARGER_MANUFACTURER_MODEL_LENGTH];
30 char model_name[CHARGER_MANUFACTURER_MODEL_LENGTH];
31 struct power_supply *psy;
32 struct power_supply_desc psy_desc;
37 int psy_voltage_max_design;
40 struct charger_data *charger;
41 unsigned long last_update;
46 struct cros_ec_dev *ec_dev;
47 struct cros_ec_device *ec_device;
48 int num_charger_ports;
50 int num_registered_psy;
51 struct port_data *ports[EC_USB_PD_MAX_PORTS];
52 struct notifier_block notifier;
55 static enum power_supply_property cros_usbpd_charger_props[] = {
56 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
57 POWER_SUPPLY_PROP_INPUT_VOLTAGE_LIMIT,
58 POWER_SUPPLY_PROP_ONLINE,
59 POWER_SUPPLY_PROP_STATUS,
60 POWER_SUPPLY_PROP_CURRENT_MAX,
61 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
62 POWER_SUPPLY_PROP_VOLTAGE_NOW,
63 POWER_SUPPLY_PROP_MODEL_NAME,
64 POWER_SUPPLY_PROP_MANUFACTURER,
65 POWER_SUPPLY_PROP_USB_TYPE
68 static enum power_supply_property cros_usbpd_dedicated_charger_props[] = {
69 POWER_SUPPLY_PROP_ONLINE,
70 POWER_SUPPLY_PROP_STATUS,
71 POWER_SUPPLY_PROP_VOLTAGE_NOW,
74 static enum power_supply_usb_type cros_usbpd_charger_usb_types[] = {
75 POWER_SUPPLY_USB_TYPE_UNKNOWN,
76 POWER_SUPPLY_USB_TYPE_SDP,
77 POWER_SUPPLY_USB_TYPE_DCP,
78 POWER_SUPPLY_USB_TYPE_CDP,
79 POWER_SUPPLY_USB_TYPE_C,
80 POWER_SUPPLY_USB_TYPE_PD,
81 POWER_SUPPLY_USB_TYPE_PD_DRP,
82 POWER_SUPPLY_USB_TYPE_APPLE_BRICK_ID
85 /* Input voltage/current limit in mV/mA. Default to none. */
86 static u16 input_voltage_limit = EC_POWER_LIMIT_NONE;
87 static u16 input_current_limit = EC_POWER_LIMIT_NONE;
89 static bool cros_usbpd_charger_port_is_dedicated(struct port_data *port)
91 return port->port_number >= port->charger->num_usbpd_ports;
94 static int cros_usbpd_charger_ec_command(struct charger_data *charger,
102 struct cros_ec_dev *ec_dev = charger->ec_dev;
103 struct cros_ec_command *msg;
106 msg = kzalloc(sizeof(*msg) + max(outsize, insize), GFP_KERNEL);
110 msg->version = version;
111 msg->command = ec_dev->cmd_offset + command;
112 msg->outsize = outsize;
113 msg->insize = insize;
116 memcpy(msg->data, outdata, outsize);
118 ret = cros_ec_cmd_xfer_status(charger->ec_device, msg);
119 if (ret >= 0 && insize)
120 memcpy(indata, msg->data, insize);
126 static int cros_usbpd_charger_get_num_ports(struct charger_data *charger)
128 struct ec_response_charge_port_count resp;
131 ret = cros_usbpd_charger_ec_command(charger, 0,
132 EC_CMD_CHARGE_PORT_COUNT,
133 NULL, 0, &resp, sizeof(resp));
135 dev_err(charger->dev,
136 "Unable to get the number of ports (err:0x%x)\n", ret);
140 return resp.port_count;
143 static int cros_usbpd_charger_get_usbpd_num_ports(struct charger_data *charger)
145 struct ec_response_usb_pd_ports resp;
148 ret = cros_usbpd_charger_ec_command(charger, 0, EC_CMD_USB_PD_PORTS,
149 NULL, 0, &resp, sizeof(resp));
151 dev_err(charger->dev,
152 "Unable to get the number or ports (err:0x%x)\n", ret);
156 return resp.num_ports;
159 static int cros_usbpd_charger_get_discovery_info(struct port_data *port)
161 struct charger_data *charger = port->charger;
162 struct ec_params_usb_pd_discovery_entry resp;
163 struct ec_params_usb_pd_info_request req;
166 req.port = port->port_number;
168 ret = cros_usbpd_charger_ec_command(charger, 0,
169 EC_CMD_USB_PD_DISCOVERY,
171 &resp, sizeof(resp));
173 dev_err(charger->dev,
174 "Unable to query discovery info (err:0x%x)\n", ret);
178 dev_dbg(charger->dev, "Port %d: VID = 0x%x, PID=0x%x, PTYPE=0x%x\n",
179 port->port_number, resp.vid, resp.pid, resp.ptype);
181 snprintf(port->manufacturer, sizeof(port->manufacturer), "%x",
183 snprintf(port->model_name, sizeof(port->model_name), "%x", resp.pid);
188 static int cros_usbpd_charger_get_power_info(struct port_data *port)
190 struct charger_data *charger = port->charger;
191 struct ec_response_usb_pd_power_info resp;
192 struct ec_params_usb_pd_power_info req;
193 int last_psy_status, last_psy_usb_type;
194 struct device *dev = charger->dev;
197 req.port = port->port_number;
198 ret = cros_usbpd_charger_ec_command(charger, 0,
199 EC_CMD_USB_PD_POWER_INFO,
201 &resp, sizeof(resp));
203 dev_err(dev, "Unable to query PD power info (err:0x%x)\n", ret);
207 last_psy_status = port->psy_status;
208 last_psy_usb_type = port->psy_usb_type;
211 case USB_PD_PORT_POWER_DISCONNECTED:
212 port->psy_status = POWER_SUPPLY_STATUS_NOT_CHARGING;
213 port->psy_online = 0;
215 case USB_PD_PORT_POWER_SOURCE:
216 port->psy_status = POWER_SUPPLY_STATUS_NOT_CHARGING;
217 port->psy_online = 0;
219 case USB_PD_PORT_POWER_SINK:
220 port->psy_status = POWER_SUPPLY_STATUS_CHARGING;
221 port->psy_online = 1;
223 case USB_PD_PORT_POWER_SINK_NOT_CHARGING:
224 port->psy_status = POWER_SUPPLY_STATUS_NOT_CHARGING;
225 port->psy_online = 1;
228 dev_err(dev, "Unknown role %d\n", resp.role);
232 port->psy_voltage_max_design = resp.meas.voltage_max;
233 port->psy_voltage_now = resp.meas.voltage_now;
234 port->psy_current_max = resp.meas.current_max;
235 port->psy_power_max = resp.max_power;
238 case USB_CHG_TYPE_BC12_SDP:
239 case USB_CHG_TYPE_VBUS:
240 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_SDP;
242 case USB_CHG_TYPE_NONE:
244 * For dual-role devices when we are a source, the firmware
245 * reports the type as NONE. Report such chargers as type
248 if (resp.role == USB_PD_PORT_POWER_SOURCE && resp.dualrole)
249 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_PD_DRP;
251 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_SDP;
253 case USB_CHG_TYPE_OTHER:
254 case USB_CHG_TYPE_PROPRIETARY:
255 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_APPLE_BRICK_ID;
258 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_C;
260 case USB_CHG_TYPE_BC12_DCP:
261 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_DCP;
263 case USB_CHG_TYPE_BC12_CDP:
264 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_CDP;
266 case USB_CHG_TYPE_PD:
268 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_PD_DRP;
270 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_PD;
272 case USB_CHG_TYPE_UNKNOWN:
274 * While the EC is trying to determine the type of charger that
275 * has been plugged in, it will report the charger type as
276 * unknown. Additionally since the power capabilities are
277 * unknown, report the max current and voltage as zero.
279 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_UNKNOWN;
280 port->psy_voltage_max_design = 0;
281 port->psy_current_max = 0;
284 dev_err(dev, "Port %d: default case!\n", port->port_number);
285 port->psy_usb_type = POWER_SUPPLY_USB_TYPE_SDP;
288 if (cros_usbpd_charger_port_is_dedicated(port))
289 port->psy_desc.type = POWER_SUPPLY_TYPE_MAINS;
291 port->psy_desc.type = POWER_SUPPLY_TYPE_USB;
294 "Port %d: type=%d vmax=%d vnow=%d cmax=%d clim=%d pmax=%d\n",
295 port->port_number, resp.type, resp.meas.voltage_max,
296 resp.meas.voltage_now, resp.meas.current_max,
297 resp.meas.current_lim, resp.max_power);
300 * If power supply type or status changed, explicitly call
301 * power_supply_changed. This results in udev event getting generated
302 * and allows user mode apps to react quicker instead of waiting for
303 * their next poll of power supply status.
305 if (last_psy_usb_type != port->psy_usb_type ||
306 last_psy_status != port->psy_status)
307 power_supply_changed(port->psy);
312 static int cros_usbpd_charger_get_port_status(struct port_data *port,
318 time_is_after_jiffies(port->last_update +
319 CHARGER_CACHE_UPDATE_DELAY))
322 ret = cros_usbpd_charger_get_power_info(port);
326 if (!cros_usbpd_charger_port_is_dedicated(port))
327 ret = cros_usbpd_charger_get_discovery_info(port);
328 port->last_update = jiffies;
333 static int cros_usbpd_charger_set_ext_power_limit(struct charger_data *charger,
337 struct ec_params_external_power_limit_v1 req;
340 req.current_lim = current_lim;
341 req.voltage_lim = voltage_lim;
343 ret = cros_usbpd_charger_ec_command(charger, 0,
344 EC_CMD_EXTERNAL_POWER_LIMIT,
345 &req, sizeof(req), NULL, 0);
347 dev_err(charger->dev,
348 "Unable to set the 'External Power Limit': %d\n", ret);
353 static void cros_usbpd_charger_power_changed(struct power_supply *psy)
355 struct port_data *port = power_supply_get_drvdata(psy);
356 struct charger_data *charger = port->charger;
359 for (i = 0; i < charger->num_registered_psy; i++)
360 cros_usbpd_charger_get_port_status(charger->ports[i], false);
363 static int cros_usbpd_charger_get_prop(struct power_supply *psy,
364 enum power_supply_property psp,
365 union power_supply_propval *val)
367 struct port_data *port = power_supply_get_drvdata(psy);
368 struct charger_data *charger = port->charger;
369 struct cros_ec_device *ec_device = charger->ec_device;
370 struct device *dev = charger->dev;
373 /* Only refresh ec_port_status for dynamic properties */
375 case POWER_SUPPLY_PROP_ONLINE:
377 * If mkbp_event_supported, then we can be assured that
378 * the driver's state for the online property is consistent
379 * with the hardware. However, if we aren't event driven,
380 * the optimization before to skip an ec_port_status get
381 * and only returned cached values of the online property will
382 * cause a delay in detecting a cable attach until one of the
383 * other properties are read.
385 * Allow an ec_port_status refresh for online property check
386 * if we're not already online to check for plug events if
387 * not mkbp_event_supported.
389 if (ec_device->mkbp_event_supported || port->psy_online)
392 case POWER_SUPPLY_PROP_CURRENT_MAX:
393 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
394 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
395 ret = cros_usbpd_charger_get_port_status(port, true);
397 dev_err(dev, "Failed to get port status (err:0x%x)\n",
407 case POWER_SUPPLY_PROP_ONLINE:
408 val->intval = port->psy_online;
410 case POWER_SUPPLY_PROP_STATUS:
411 val->intval = port->psy_status;
413 case POWER_SUPPLY_PROP_CURRENT_MAX:
414 val->intval = port->psy_current_max * 1000;
416 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
417 val->intval = port->psy_voltage_max_design * 1000;
419 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
420 val->intval = port->psy_voltage_now * 1000;
422 case POWER_SUPPLY_PROP_USB_TYPE:
423 val->intval = port->psy_usb_type;
425 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
426 if (input_current_limit == EC_POWER_LIMIT_NONE)
429 val->intval = input_current_limit * 1000;
431 case POWER_SUPPLY_PROP_INPUT_VOLTAGE_LIMIT:
432 if (input_voltage_limit == EC_POWER_LIMIT_NONE)
435 val->intval = input_voltage_limit * 1000;
437 case POWER_SUPPLY_PROP_MODEL_NAME:
438 val->strval = port->model_name;
440 case POWER_SUPPLY_PROP_MANUFACTURER:
441 val->strval = port->manufacturer;
450 static int cros_usbpd_charger_set_prop(struct power_supply *psy,
451 enum power_supply_property psp,
452 const union power_supply_propval *val)
454 struct port_data *port = power_supply_get_drvdata(psy);
455 struct charger_data *charger = port->charger;
456 struct device *dev = charger->dev;
460 /* U16_MAX in mV/mA is the maximum supported value */
461 if (val->intval >= U16_MAX * 1000)
463 /* A negative number is used to clear the limit */
465 intval = EC_POWER_LIMIT_NONE;
466 else /* Convert from uA/uV to mA/mV */
467 intval = val->intval / 1000;
470 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
471 ret = cros_usbpd_charger_set_ext_power_limit(charger, intval,
472 input_voltage_limit);
476 input_current_limit = intval;
477 if (input_current_limit == EC_POWER_LIMIT_NONE)
479 "External Current Limit cleared for all ports\n");
482 "External Current Limit set to %dmA for all ports\n",
483 input_current_limit);
485 case POWER_SUPPLY_PROP_INPUT_VOLTAGE_LIMIT:
486 ret = cros_usbpd_charger_set_ext_power_limit(charger,
492 input_voltage_limit = intval;
493 if (input_voltage_limit == EC_POWER_LIMIT_NONE)
495 "External Voltage Limit cleared for all ports\n");
498 "External Voltage Limit set to %dmV for all ports\n",
499 input_voltage_limit);
508 static int cros_usbpd_charger_property_is_writeable(struct power_supply *psy,
509 enum power_supply_property psp)
514 case POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT:
515 case POWER_SUPPLY_PROP_INPUT_VOLTAGE_LIMIT:
525 static int cros_usbpd_charger_ec_event(struct notifier_block *nb,
526 unsigned long queued_during_suspend,
529 struct cros_ec_device *ec_device;
530 struct charger_data *charger;
533 charger = container_of(nb, struct charger_data, notifier);
534 ec_device = charger->ec_device;
536 host_event = cros_ec_get_host_event(ec_device);
537 if (host_event & EC_HOST_EVENT_MASK(EC_HOST_EVENT_PD_MCU)) {
538 cros_usbpd_charger_power_changed(charger->ports[0]->psy);
545 static void cros_usbpd_charger_unregister_notifier(void *data)
547 struct charger_data *charger = data;
548 struct cros_ec_device *ec_device = charger->ec_device;
550 blocking_notifier_chain_unregister(&ec_device->event_notifier,
554 static int cros_usbpd_charger_probe(struct platform_device *pd)
556 struct cros_ec_dev *ec_dev = dev_get_drvdata(pd->dev.parent);
557 struct cros_ec_device *ec_device = ec_dev->ec_dev;
558 struct power_supply_desc *psy_desc;
559 struct device *dev = &pd->dev;
560 struct charger_data *charger;
561 struct power_supply *psy;
562 struct port_data *port;
566 charger = devm_kzalloc(dev, sizeof(struct charger_data),
572 charger->ec_dev = ec_dev;
573 charger->ec_device = ec_device;
575 platform_set_drvdata(pd, charger);
578 * We need to know the number of USB PD ports in order to know whether
579 * there is a dedicated port. The dedicated port will always be
580 * after the USB PD ports, and there should be only one.
582 charger->num_usbpd_ports =
583 cros_usbpd_charger_get_usbpd_num_ports(charger);
584 if (charger->num_usbpd_ports <= 0) {
586 * This can happen on a system that doesn't support USB PD.
587 * Log a message, but no need to warn.
589 dev_info(dev, "No USB PD charging ports found\n");
592 charger->num_charger_ports = cros_usbpd_charger_get_num_ports(charger);
593 if (charger->num_charger_ports < 0) {
595 * This can happen on a system that doesn't support USB PD.
596 * Log a message, but no need to warn.
597 * Older ECs do not support the above command, in that case
598 * let's set up the number of charger ports equal to the number
601 dev_info(dev, "Could not get charger port count\n");
602 charger->num_charger_ports = charger->num_usbpd_ports;
605 if (charger->num_charger_ports <= 0) {
607 * This can happen on a system that doesn't support USB PD and
608 * doesn't have a dedicated port.
609 * Log a message, but no need to warn.
611 dev_info(dev, "No charging ports found\n");
617 * Sanity checks on the number of ports:
618 * there should be at most 1 dedicated port
620 if (charger->num_charger_ports < charger->num_usbpd_ports ||
621 charger->num_charger_ports > (charger->num_usbpd_ports + 1)) {
622 dev_err(dev, "Unexpected number of charge port count\n");
627 for (i = 0; i < charger->num_charger_ports; i++) {
628 struct power_supply_config psy_cfg = {};
630 port = devm_kzalloc(dev, sizeof(struct port_data), GFP_KERNEL);
636 port->charger = charger;
637 port->port_number = i;
639 psy_desc = &port->psy_desc;
640 psy_desc->get_property = cros_usbpd_charger_get_prop;
641 psy_desc->set_property = cros_usbpd_charger_set_prop;
642 psy_desc->property_is_writeable =
643 cros_usbpd_charger_property_is_writeable;
644 psy_desc->external_power_changed =
645 cros_usbpd_charger_power_changed;
646 psy_cfg.drv_data = port;
648 if (cros_usbpd_charger_port_is_dedicated(port)) {
649 sprintf(port->name, CHARGER_DEDICATED_DIR_NAME);
650 psy_desc->type = POWER_SUPPLY_TYPE_MAINS;
651 psy_desc->properties =
652 cros_usbpd_dedicated_charger_props;
653 psy_desc->num_properties =
654 ARRAY_SIZE(cros_usbpd_dedicated_charger_props);
656 sprintf(port->name, CHARGER_USBPD_DIR_NAME, i);
657 psy_desc->type = POWER_SUPPLY_TYPE_USB;
658 psy_desc->properties = cros_usbpd_charger_props;
659 psy_desc->num_properties =
660 ARRAY_SIZE(cros_usbpd_charger_props);
661 psy_desc->usb_types = cros_usbpd_charger_usb_types;
662 psy_desc->num_usb_types =
663 ARRAY_SIZE(cros_usbpd_charger_usb_types);
666 psy_desc->name = port->name;
668 psy = devm_power_supply_register_no_ws(dev, psy_desc,
671 dev_err(dev, "Failed to register power supply\n");
676 charger->ports[charger->num_registered_psy++] = port;
679 if (!charger->num_registered_psy) {
681 dev_err(dev, "No power supplies registered\n");
685 if (ec_device->mkbp_event_supported) {
686 /* Get PD events from the EC */
687 charger->notifier.notifier_call = cros_usbpd_charger_ec_event;
688 ret = blocking_notifier_chain_register(
689 &ec_device->event_notifier,
692 dev_warn(dev, "failed to register notifier\n");
694 ret = devm_add_action_or_reset(dev,
695 cros_usbpd_charger_unregister_notifier,
705 WARN(1, "%s: Failing probe (err:0x%x)\n", dev_name(dev), ret);
708 dev_info(dev, "Failing probe (err:0x%x)\n", ret);
712 #ifdef CONFIG_PM_SLEEP
713 static int cros_usbpd_charger_resume(struct device *dev)
715 struct charger_data *charger = dev_get_drvdata(dev);
721 for (i = 0; i < charger->num_registered_psy; i++) {
722 power_supply_changed(charger->ports[i]->psy);
723 charger->ports[i]->last_update =
724 jiffies - CHARGER_CACHE_UPDATE_DELAY;
731 static SIMPLE_DEV_PM_OPS(cros_usbpd_charger_pm_ops, NULL,
732 cros_usbpd_charger_resume);
734 static struct platform_driver cros_usbpd_charger_driver = {
737 .pm = &cros_usbpd_charger_pm_ops,
739 .probe = cros_usbpd_charger_probe
742 module_platform_driver(cros_usbpd_charger_driver);
744 MODULE_LICENSE("GPL");
745 MODULE_DESCRIPTION("ChromeOS EC USBPD charger");
746 MODULE_ALIAS("platform:" DRV_NAME);