cros_peripheral_charger.c 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Power supply driver for ChromeOS EC based Peripheral Device Charger.
  4. *
  5. * Copyright 2020 Google LLC.
  6. */
  7. #include <linux/module.h>
  8. #include <linux/notifier.h>
  9. #include <linux/platform_data/cros_ec_commands.h>
  10. #include <linux/platform_data/cros_ec_proto.h>
  11. #include <linux/platform_device.h>
  12. #include <linux/power_supply.h>
  13. #include <linux/slab.h>
  14. #include <linux/stringify.h>
  15. #include <linux/types.h>
  16. #include <asm/unaligned.h>
  17. #define DRV_NAME "cros-ec-pchg"
  18. #define PCHG_DIR_PREFIX "peripheral"
  19. #define PCHG_DIR_NAME PCHG_DIR_PREFIX "%d"
  20. #define PCHG_DIR_NAME_LENGTH \
  21. sizeof(PCHG_DIR_PREFIX __stringify(EC_PCHG_MAX_PORTS))
  22. #define PCHG_CACHE_UPDATE_DELAY msecs_to_jiffies(500)
  23. struct port_data {
  24. int port_number;
  25. char name[PCHG_DIR_NAME_LENGTH];
  26. struct power_supply *psy;
  27. struct power_supply_desc psy_desc;
  28. int psy_status;
  29. int battery_percentage;
  30. int charge_type;
  31. struct charger_data *charger;
  32. unsigned long last_update;
  33. };
  34. struct charger_data {
  35. struct device *dev;
  36. struct cros_ec_dev *ec_dev;
  37. struct cros_ec_device *ec_device;
  38. int num_registered_psy;
  39. struct port_data *ports[EC_PCHG_MAX_PORTS];
  40. struct notifier_block notifier;
  41. };
  42. static enum power_supply_property cros_pchg_props[] = {
  43. POWER_SUPPLY_PROP_STATUS,
  44. POWER_SUPPLY_PROP_CHARGE_TYPE,
  45. POWER_SUPPLY_PROP_CAPACITY,
  46. POWER_SUPPLY_PROP_SCOPE,
  47. };
  48. static int cros_pchg_ec_command(const struct charger_data *charger,
  49. unsigned int version,
  50. unsigned int command,
  51. const void *outdata,
  52. unsigned int outsize,
  53. void *indata,
  54. unsigned int insize)
  55. {
  56. struct cros_ec_dev *ec_dev = charger->ec_dev;
  57. struct cros_ec_command *msg;
  58. int ret;
  59. msg = kzalloc(struct_size(msg, data, max(outsize, insize)), GFP_KERNEL);
  60. if (!msg)
  61. return -ENOMEM;
  62. msg->version = version;
  63. msg->command = ec_dev->cmd_offset + command;
  64. msg->outsize = outsize;
  65. msg->insize = insize;
  66. if (outsize)
  67. memcpy(msg->data, outdata, outsize);
  68. ret = cros_ec_cmd_xfer_status(charger->ec_device, msg);
  69. if (ret >= 0 && insize)
  70. memcpy(indata, msg->data, insize);
  71. kfree(msg);
  72. return ret;
  73. }
  74. static const unsigned int pchg_cmd_version = 1;
  75. static bool cros_pchg_cmd_ver_check(const struct charger_data *charger)
  76. {
  77. struct ec_params_get_cmd_versions_v1 req;
  78. struct ec_response_get_cmd_versions rsp;
  79. int ret;
  80. req.cmd = EC_CMD_PCHG;
  81. ret = cros_pchg_ec_command(charger, 1, EC_CMD_GET_CMD_VERSIONS,
  82. &req, sizeof(req), &rsp, sizeof(rsp));
  83. if (ret < 0) {
  84. dev_warn(charger->dev,
  85. "Unable to get versions of EC_CMD_PCHG (err:%d)\n",
  86. ret);
  87. return false;
  88. }
  89. return !!(rsp.version_mask & BIT(pchg_cmd_version));
  90. }
  91. static int cros_pchg_port_count(const struct charger_data *charger)
  92. {
  93. struct ec_response_pchg_count rsp;
  94. int ret;
  95. ret = cros_pchg_ec_command(charger, 0, EC_CMD_PCHG_COUNT,
  96. NULL, 0, &rsp, sizeof(rsp));
  97. if (ret < 0) {
  98. dev_warn(charger->dev,
  99. "Unable to get number or ports (err:%d)\n", ret);
  100. return ret;
  101. }
  102. return rsp.port_count;
  103. }
  104. static int cros_pchg_get_status(struct port_data *port)
  105. {
  106. struct charger_data *charger = port->charger;
  107. struct ec_params_pchg req;
  108. struct ec_response_pchg rsp;
  109. struct device *dev = charger->dev;
  110. int old_status = port->psy_status;
  111. int old_percentage = port->battery_percentage;
  112. int ret;
  113. req.port = port->port_number;
  114. ret = cros_pchg_ec_command(charger, pchg_cmd_version, EC_CMD_PCHG,
  115. &req, sizeof(req), &rsp, sizeof(rsp));
  116. if (ret < 0) {
  117. dev_err(dev, "Unable to get port.%d status (err:%d)\n",
  118. port->port_number, ret);
  119. return ret;
  120. }
  121. switch (rsp.state) {
  122. case PCHG_STATE_RESET:
  123. case PCHG_STATE_INITIALIZED:
  124. case PCHG_STATE_ENABLED:
  125. default:
  126. port->psy_status = POWER_SUPPLY_STATUS_UNKNOWN;
  127. port->charge_type = POWER_SUPPLY_CHARGE_TYPE_NONE;
  128. break;
  129. case PCHG_STATE_DETECTED:
  130. port->psy_status = POWER_SUPPLY_STATUS_CHARGING;
  131. port->charge_type = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
  132. break;
  133. case PCHG_STATE_CHARGING:
  134. port->psy_status = POWER_SUPPLY_STATUS_CHARGING;
  135. port->charge_type = POWER_SUPPLY_CHARGE_TYPE_STANDARD;
  136. break;
  137. case PCHG_STATE_FULL:
  138. port->psy_status = POWER_SUPPLY_STATUS_FULL;
  139. port->charge_type = POWER_SUPPLY_CHARGE_TYPE_NONE;
  140. break;
  141. }
  142. port->battery_percentage = rsp.battery_percentage;
  143. if (port->psy_status != old_status ||
  144. port->battery_percentage != old_percentage)
  145. power_supply_changed(port->psy);
  146. dev_dbg(dev,
  147. "Port %d: state=%d battery=%d%%\n",
  148. port->port_number, rsp.state, rsp.battery_percentage);
  149. return 0;
  150. }
  151. static int cros_pchg_get_port_status(struct port_data *port, bool ratelimit)
  152. {
  153. int ret;
  154. if (ratelimit &&
  155. time_is_after_jiffies(port->last_update + PCHG_CACHE_UPDATE_DELAY))
  156. return 0;
  157. ret = cros_pchg_get_status(port);
  158. if (ret < 0)
  159. return ret;
  160. port->last_update = jiffies;
  161. return ret;
  162. }
  163. static int cros_pchg_get_prop(struct power_supply *psy,
  164. enum power_supply_property psp,
  165. union power_supply_propval *val)
  166. {
  167. struct port_data *port = power_supply_get_drvdata(psy);
  168. switch (psp) {
  169. case POWER_SUPPLY_PROP_STATUS:
  170. case POWER_SUPPLY_PROP_CAPACITY:
  171. case POWER_SUPPLY_PROP_CHARGE_TYPE:
  172. cros_pchg_get_port_status(port, true);
  173. break;
  174. default:
  175. break;
  176. }
  177. switch (psp) {
  178. case POWER_SUPPLY_PROP_STATUS:
  179. val->intval = port->psy_status;
  180. break;
  181. case POWER_SUPPLY_PROP_CAPACITY:
  182. val->intval = port->battery_percentage;
  183. break;
  184. case POWER_SUPPLY_PROP_CHARGE_TYPE:
  185. val->intval = port->charge_type;
  186. break;
  187. case POWER_SUPPLY_PROP_SCOPE:
  188. val->intval = POWER_SUPPLY_SCOPE_DEVICE;
  189. break;
  190. default:
  191. return -EINVAL;
  192. }
  193. return 0;
  194. }
  195. static int cros_pchg_event(const struct charger_data *charger,
  196. unsigned long host_event)
  197. {
  198. int i;
  199. for (i = 0; i < charger->num_registered_psy; i++)
  200. cros_pchg_get_port_status(charger->ports[i], false);
  201. return NOTIFY_OK;
  202. }
  203. static int cros_ec_notify(struct notifier_block *nb,
  204. unsigned long queued_during_suspend,
  205. void *data)
  206. {
  207. struct cros_ec_device *ec_dev = data;
  208. struct charger_data *charger =
  209. container_of(nb, struct charger_data, notifier);
  210. u32 host_event;
  211. if (ec_dev->event_data.event_type != EC_MKBP_EVENT_PCHG ||
  212. ec_dev->event_size != sizeof(host_event))
  213. return NOTIFY_DONE;
  214. host_event = get_unaligned_le32(&ec_dev->event_data.data.host_event);
  215. if (!(host_event & EC_MKBP_PCHG_DEVICE_EVENT))
  216. return NOTIFY_DONE;
  217. return cros_pchg_event(charger, host_event);
  218. }
  219. static int cros_pchg_probe(struct platform_device *pdev)
  220. {
  221. struct device *dev = &pdev->dev;
  222. struct cros_ec_dev *ec_dev = dev_get_drvdata(dev->parent);
  223. struct cros_ec_device *ec_device = ec_dev->ec_dev;
  224. struct power_supply_desc *psy_desc;
  225. struct charger_data *charger;
  226. struct power_supply *psy;
  227. struct port_data *port;
  228. struct notifier_block *nb;
  229. int num_ports;
  230. int ret;
  231. int i;
  232. charger = devm_kzalloc(dev, sizeof(*charger), GFP_KERNEL);
  233. if (!charger)
  234. return -ENOMEM;
  235. charger->dev = dev;
  236. charger->ec_dev = ec_dev;
  237. charger->ec_device = ec_device;
  238. ret = cros_pchg_port_count(charger);
  239. if (ret <= 0) {
  240. /*
  241. * This feature is enabled by the EC and the kernel driver is
  242. * included by default for CrOS devices. Don't need to be loud
  243. * since this error can be normal.
  244. */
  245. dev_info(dev, "No peripheral charge ports (err:%d)\n", ret);
  246. return -ENODEV;
  247. }
  248. if (!cros_pchg_cmd_ver_check(charger)) {
  249. dev_err(dev, "EC_CMD_PCHG version %d isn't available.\n",
  250. pchg_cmd_version);
  251. return -EOPNOTSUPP;
  252. }
  253. num_ports = ret;
  254. if (num_ports > EC_PCHG_MAX_PORTS) {
  255. dev_err(dev, "Too many peripheral charge ports (%d)\n",
  256. num_ports);
  257. return -ENOBUFS;
  258. }
  259. dev_info(dev, "%d peripheral charge ports found\n", num_ports);
  260. for (i = 0; i < num_ports; i++) {
  261. struct power_supply_config psy_cfg = {};
  262. port = devm_kzalloc(dev, sizeof(*port), GFP_KERNEL);
  263. if (!port)
  264. return -ENOMEM;
  265. port->charger = charger;
  266. port->port_number = i;
  267. snprintf(port->name, sizeof(port->name), PCHG_DIR_NAME, i);
  268. psy_desc = &port->psy_desc;
  269. psy_desc->name = port->name;
  270. psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
  271. psy_desc->get_property = cros_pchg_get_prop;
  272. psy_desc->external_power_changed = NULL;
  273. psy_desc->properties = cros_pchg_props;
  274. psy_desc->num_properties = ARRAY_SIZE(cros_pchg_props);
  275. psy_cfg.drv_data = port;
  276. psy = devm_power_supply_register(dev, psy_desc, &psy_cfg);
  277. if (IS_ERR(psy))
  278. return dev_err_probe(dev, PTR_ERR(psy),
  279. "Failed to register power supply\n");
  280. port->psy = psy;
  281. charger->ports[charger->num_registered_psy++] = port;
  282. }
  283. if (!charger->num_registered_psy)
  284. return -ENODEV;
  285. nb = &charger->notifier;
  286. nb->notifier_call = cros_ec_notify;
  287. ret = blocking_notifier_chain_register(&ec_dev->ec_dev->event_notifier,
  288. nb);
  289. if (ret < 0)
  290. dev_err(dev, "Failed to register notifier (err:%d)\n", ret);
  291. return 0;
  292. }
  293. static struct platform_driver cros_pchg_driver = {
  294. .driver = {
  295. .name = DRV_NAME,
  296. },
  297. .probe = cros_pchg_probe
  298. };
  299. module_platform_driver(cros_pchg_driver);
  300. MODULE_LICENSE("GPL");
  301. MODULE_DESCRIPTION("ChromeOS EC peripheral device charger");
  302. MODULE_ALIAS("platform:" DRV_NAME);