1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2012-2015, The Linux Foundation. All rights reserved.
5 #include <linux/kernel.h>
6 #include <linux/errno.h>
8 #include <linux/slab.h>
9 #include <linux/module.h>
11 #include <linux/of_device.h>
12 #include <linux/platform_device.h>
13 #include <linux/spmi.h>
14 #include <linux/pm_runtime.h>
16 #include <dt-bindings/spmi/spmi.h>
17 #define CREATE_TRACE_POINTS
18 #include <trace/events/spmi.h>
20 static bool is_registered;
21 static DEFINE_IDA(ctrl_ida);
23 static void spmi_dev_release(struct device *dev)
25 struct spmi_device *sdev = to_spmi_device(dev);
30 static const struct device_type spmi_dev_type = {
31 .release = spmi_dev_release,
34 static void spmi_ctrl_release(struct device *dev)
36 struct spmi_controller *ctrl = to_spmi_controller(dev);
38 ida_simple_remove(&ctrl_ida, ctrl->nr);
42 static const struct device_type spmi_ctrl_type = {
43 .release = spmi_ctrl_release,
46 static int spmi_device_match(struct device *dev, struct device_driver *drv)
48 if (of_driver_match_device(dev, drv))
52 return strncmp(dev_name(dev), drv->name,
59 * spmi_device_add() - add a device previously constructed via spmi_device_alloc()
60 * @sdev: spmi_device to be added
62 int spmi_device_add(struct spmi_device *sdev)
64 struct spmi_controller *ctrl = sdev->ctrl;
67 dev_set_name(&sdev->dev, "%d-%02x", ctrl->nr, sdev->usid);
69 err = device_add(&sdev->dev);
71 dev_err(&sdev->dev, "Can't add %s, status %d\n",
72 dev_name(&sdev->dev), err);
76 dev_dbg(&sdev->dev, "device %s registered\n", dev_name(&sdev->dev));
81 EXPORT_SYMBOL_GPL(spmi_device_add);
84 * spmi_device_remove(): remove an SPMI device
85 * @sdev: spmi_device to be removed
87 void spmi_device_remove(struct spmi_device *sdev)
89 device_unregister(&sdev->dev);
91 EXPORT_SYMBOL_GPL(spmi_device_remove);
94 spmi_cmd(struct spmi_controller *ctrl, u8 opcode, u8 sid)
98 if (!ctrl || !ctrl->cmd || ctrl->dev.type != &spmi_ctrl_type)
101 ret = ctrl->cmd(ctrl, opcode, sid);
102 trace_spmi_cmd(opcode, sid, ret);
106 static inline int spmi_read_cmd(struct spmi_controller *ctrl, u8 opcode,
107 u8 sid, u16 addr, u8 *buf, size_t len)
111 if (!ctrl || !ctrl->read_cmd || ctrl->dev.type != &spmi_ctrl_type)
114 trace_spmi_read_begin(opcode, sid, addr);
115 ret = ctrl->read_cmd(ctrl, opcode, sid, addr, buf, len);
116 trace_spmi_read_end(opcode, sid, addr, ret, len, buf);
120 static inline int spmi_write_cmd(struct spmi_controller *ctrl, u8 opcode,
121 u8 sid, u16 addr, const u8 *buf, size_t len)
125 if (!ctrl || !ctrl->write_cmd || ctrl->dev.type != &spmi_ctrl_type)
128 trace_spmi_write_begin(opcode, sid, addr, len, buf);
129 ret = ctrl->write_cmd(ctrl, opcode, sid, addr, buf, len);
130 trace_spmi_write_end(opcode, sid, addr, ret);
135 * spmi_register_read() - register read
136 * @sdev: SPMI device.
137 * @addr: slave register address (5-bit address).
138 * @buf: buffer to be populated with data from the Slave.
140 * Reads 1 byte of data from a Slave device register.
142 int spmi_register_read(struct spmi_device *sdev, u8 addr, u8 *buf)
144 /* 5-bit register address */
148 return spmi_read_cmd(sdev->ctrl, SPMI_CMD_READ, sdev->usid, addr,
151 EXPORT_SYMBOL_GPL(spmi_register_read);
154 * spmi_ext_register_read() - extended register read
155 * @sdev: SPMI device.
156 * @addr: slave register address (8-bit address).
157 * @buf: buffer to be populated with data from the Slave.
158 * @len: the request number of bytes to read (up to 16 bytes).
160 * Reads up to 16 bytes of data from the extended register space on a
163 int spmi_ext_register_read(struct spmi_device *sdev, u8 addr, u8 *buf,
166 /* 8-bit register address, up to 16 bytes */
167 if (len == 0 || len > 16)
170 return spmi_read_cmd(sdev->ctrl, SPMI_CMD_EXT_READ, sdev->usid, addr,
173 EXPORT_SYMBOL_GPL(spmi_ext_register_read);
176 * spmi_ext_register_readl() - extended register read long
177 * @sdev: SPMI device.
178 * @addr: slave register address (16-bit address).
179 * @buf: buffer to be populated with data from the Slave.
180 * @len: the request number of bytes to read (up to 8 bytes).
182 * Reads up to 8 bytes of data from the extended register space on a
183 * Slave device using 16-bit address.
185 int spmi_ext_register_readl(struct spmi_device *sdev, u16 addr, u8 *buf,
188 /* 16-bit register address, up to 8 bytes */
189 if (len == 0 || len > 8)
192 return spmi_read_cmd(sdev->ctrl, SPMI_CMD_EXT_READL, sdev->usid, addr,
195 EXPORT_SYMBOL_GPL(spmi_ext_register_readl);
198 * spmi_register_write() - register write
200 * @addr: slave register address (5-bit address).
201 * @data: buffer containing the data to be transferred to the Slave.
203 * Writes 1 byte of data to a Slave device register.
205 int spmi_register_write(struct spmi_device *sdev, u8 addr, u8 data)
207 /* 5-bit register address */
211 return spmi_write_cmd(sdev->ctrl, SPMI_CMD_WRITE, sdev->usid, addr,
214 EXPORT_SYMBOL_GPL(spmi_register_write);
217 * spmi_register_zero_write() - register zero write
218 * @sdev: SPMI device.
219 * @data: the data to be written to register 0 (7-bits).
221 * Writes data to register 0 of the Slave device.
223 int spmi_register_zero_write(struct spmi_device *sdev, u8 data)
225 return spmi_write_cmd(sdev->ctrl, SPMI_CMD_ZERO_WRITE, sdev->usid, 0,
228 EXPORT_SYMBOL_GPL(spmi_register_zero_write);
231 * spmi_ext_register_write() - extended register write
232 * @sdev: SPMI device.
233 * @addr: slave register address (8-bit address).
234 * @buf: buffer containing the data to be transferred to the Slave.
235 * @len: the request number of bytes to read (up to 16 bytes).
237 * Writes up to 16 bytes of data to the extended register space of a
240 int spmi_ext_register_write(struct spmi_device *sdev, u8 addr, const u8 *buf,
243 /* 8-bit register address, up to 16 bytes */
244 if (len == 0 || len > 16)
247 return spmi_write_cmd(sdev->ctrl, SPMI_CMD_EXT_WRITE, sdev->usid, addr,
250 EXPORT_SYMBOL_GPL(spmi_ext_register_write);
253 * spmi_ext_register_writel() - extended register write long
254 * @sdev: SPMI device.
255 * @addr: slave register address (16-bit address).
256 * @buf: buffer containing the data to be transferred to the Slave.
257 * @len: the request number of bytes to read (up to 8 bytes).
259 * Writes up to 8 bytes of data to the extended register space of a
260 * Slave device using 16-bit address.
262 int spmi_ext_register_writel(struct spmi_device *sdev, u16 addr, const u8 *buf,
265 /* 4-bit Slave Identifier, 16-bit register address, up to 8 bytes */
266 if (len == 0 || len > 8)
269 return spmi_write_cmd(sdev->ctrl, SPMI_CMD_EXT_WRITEL, sdev->usid,
272 EXPORT_SYMBOL_GPL(spmi_ext_register_writel);
275 * spmi_command_reset() - sends RESET command to the specified slave
276 * @sdev: SPMI device.
278 * The Reset command initializes the Slave and forces all registers to
279 * their reset values. The Slave shall enter the STARTUP state after
280 * receiving a Reset command.
282 int spmi_command_reset(struct spmi_device *sdev)
284 return spmi_cmd(sdev->ctrl, SPMI_CMD_RESET, sdev->usid);
286 EXPORT_SYMBOL_GPL(spmi_command_reset);
289 * spmi_command_sleep() - sends SLEEP command to the specified SPMI device
290 * @sdev: SPMI device.
292 * The Sleep command causes the Slave to enter the user defined SLEEP state.
294 int spmi_command_sleep(struct spmi_device *sdev)
296 return spmi_cmd(sdev->ctrl, SPMI_CMD_SLEEP, sdev->usid);
298 EXPORT_SYMBOL_GPL(spmi_command_sleep);
301 * spmi_command_wakeup() - sends WAKEUP command to the specified SPMI device
302 * @sdev: SPMI device.
304 * The Wakeup command causes the Slave to move from the SLEEP state to
307 int spmi_command_wakeup(struct spmi_device *sdev)
309 return spmi_cmd(sdev->ctrl, SPMI_CMD_WAKEUP, sdev->usid);
311 EXPORT_SYMBOL_GPL(spmi_command_wakeup);
314 * spmi_command_shutdown() - sends SHUTDOWN command to the specified SPMI device
315 * @sdev: SPMI device.
317 * The Shutdown command causes the Slave to enter the SHUTDOWN state.
319 int spmi_command_shutdown(struct spmi_device *sdev)
321 return spmi_cmd(sdev->ctrl, SPMI_CMD_SHUTDOWN, sdev->usid);
323 EXPORT_SYMBOL_GPL(spmi_command_shutdown);
325 static int spmi_drv_probe(struct device *dev)
327 const struct spmi_driver *sdrv = to_spmi_driver(dev->driver);
328 struct spmi_device *sdev = to_spmi_device(dev);
331 pm_runtime_get_noresume(dev);
332 pm_runtime_set_active(dev);
333 pm_runtime_enable(dev);
335 err = sdrv->probe(sdev);
342 pm_runtime_disable(dev);
343 pm_runtime_set_suspended(dev);
344 pm_runtime_put_noidle(dev);
348 static int spmi_drv_remove(struct device *dev)
350 const struct spmi_driver *sdrv = to_spmi_driver(dev->driver);
352 pm_runtime_get_sync(dev);
353 sdrv->remove(to_spmi_device(dev));
354 pm_runtime_put_noidle(dev);
356 pm_runtime_disable(dev);
357 pm_runtime_set_suspended(dev);
358 pm_runtime_put_noidle(dev);
362 static void spmi_drv_shutdown(struct device *dev)
364 const struct spmi_driver *sdrv = to_spmi_driver(dev->driver);
366 if (sdrv && sdrv->shutdown)
367 sdrv->shutdown(to_spmi_device(dev));
370 static int spmi_drv_uevent(struct device *dev, struct kobj_uevent_env *env)
374 ret = of_device_uevent_modalias(dev, env);
381 static struct bus_type spmi_bus_type = {
383 .match = spmi_device_match,
384 .probe = spmi_drv_probe,
385 .remove = spmi_drv_remove,
386 .shutdown = spmi_drv_shutdown,
387 .uevent = spmi_drv_uevent,
391 * spmi_controller_alloc() - Allocate a new SPMI device
392 * @ctrl: associated controller
394 * Caller is responsible for either calling spmi_device_add() to add the
395 * newly allocated controller, or calling spmi_device_put() to discard it.
397 struct spmi_device *spmi_device_alloc(struct spmi_controller *ctrl)
399 struct spmi_device *sdev;
401 sdev = kzalloc(sizeof(*sdev), GFP_KERNEL);
406 device_initialize(&sdev->dev);
407 sdev->dev.parent = &ctrl->dev;
408 sdev->dev.bus = &spmi_bus_type;
409 sdev->dev.type = &spmi_dev_type;
412 EXPORT_SYMBOL_GPL(spmi_device_alloc);
415 * spmi_controller_alloc() - Allocate a new SPMI controller
416 * @parent: parent device
417 * @size: size of private data
419 * Caller is responsible for either calling spmi_controller_add() to add the
420 * newly allocated controller, or calling spmi_controller_put() to discard it.
421 * The allocated private data region may be accessed via
422 * spmi_controller_get_drvdata()
424 struct spmi_controller *spmi_controller_alloc(struct device *parent,
427 struct spmi_controller *ctrl;
430 if (WARN_ON(!parent))
433 ctrl = kzalloc(sizeof(*ctrl) + size, GFP_KERNEL);
437 device_initialize(&ctrl->dev);
438 ctrl->dev.type = &spmi_ctrl_type;
439 ctrl->dev.bus = &spmi_bus_type;
440 ctrl->dev.parent = parent;
441 ctrl->dev.of_node = parent->of_node;
442 spmi_controller_set_drvdata(ctrl, &ctrl[1]);
444 id = ida_simple_get(&ctrl_ida, 0, 0, GFP_KERNEL);
447 "unable to allocate SPMI controller identifier.\n");
448 spmi_controller_put(ctrl);
453 dev_set_name(&ctrl->dev, "spmi-%d", id);
455 dev_dbg(&ctrl->dev, "allocated controller 0x%p id %d\n", ctrl, id);
458 EXPORT_SYMBOL_GPL(spmi_controller_alloc);
460 static void of_spmi_register_devices(struct spmi_controller *ctrl)
462 struct device_node *node;
465 if (!ctrl->dev.of_node)
468 for_each_available_child_of_node(ctrl->dev.of_node, node) {
469 struct spmi_device *sdev;
472 dev_dbg(&ctrl->dev, "adding child %pOF\n", node);
474 err = of_property_read_u32_array(node, "reg", reg, 2);
477 "node %pOF err (%d) does not have 'reg' property\n",
482 if (reg[1] != SPMI_USID) {
484 "node %pOF contains unsupported 'reg' entry\n",
489 if (reg[0] >= SPMI_MAX_SLAVE_ID) {
490 dev_err(&ctrl->dev, "invalid usid on node %pOF\n", node);
494 dev_dbg(&ctrl->dev, "read usid %02x\n", reg[0]);
496 sdev = spmi_device_alloc(ctrl);
500 sdev->dev.of_node = node;
501 sdev->usid = (u8)reg[0];
503 err = spmi_device_add(sdev);
506 "failure adding device. status %d\n", err);
507 spmi_device_put(sdev);
513 * spmi_controller_add() - Add an SPMI controller
514 * @ctrl: controller to be registered.
516 * Register a controller previously allocated via spmi_controller_alloc() with
519 int spmi_controller_add(struct spmi_controller *ctrl)
523 /* Can't register until after driver model init */
524 if (WARN_ON(!is_registered))
527 ret = device_add(&ctrl->dev);
531 if (IS_ENABLED(CONFIG_OF))
532 of_spmi_register_devices(ctrl);
534 dev_dbg(&ctrl->dev, "spmi-%d registered: dev:%p\n",
535 ctrl->nr, &ctrl->dev);
539 EXPORT_SYMBOL_GPL(spmi_controller_add);
541 /* Remove a device associated with a controller */
542 static int spmi_ctrl_remove_device(struct device *dev, void *data)
544 struct spmi_device *spmidev = to_spmi_device(dev);
546 if (dev->type == &spmi_dev_type)
547 spmi_device_remove(spmidev);
552 * spmi_controller_remove(): remove an SPMI controller
553 * @ctrl: controller to remove
555 * Remove a SPMI controller. Caller is responsible for calling
556 * spmi_controller_put() to discard the allocated controller.
558 void spmi_controller_remove(struct spmi_controller *ctrl)
563 device_for_each_child(&ctrl->dev, NULL, spmi_ctrl_remove_device);
564 device_del(&ctrl->dev);
566 EXPORT_SYMBOL_GPL(spmi_controller_remove);
569 * spmi_driver_register() - Register client driver with SPMI core
570 * @sdrv: client driver to be associated with client-device.
572 * This API will register the client driver with the SPMI framework.
573 * It is typically called from the driver's module-init function.
575 int __spmi_driver_register(struct spmi_driver *sdrv, struct module *owner)
577 sdrv->driver.bus = &spmi_bus_type;
578 sdrv->driver.owner = owner;
579 return driver_register(&sdrv->driver);
581 EXPORT_SYMBOL_GPL(__spmi_driver_register);
583 static void __exit spmi_exit(void)
585 bus_unregister(&spmi_bus_type);
587 module_exit(spmi_exit);
589 static int __init spmi_init(void)
593 ret = bus_register(&spmi_bus_type);
597 is_registered = true;
600 postcore_initcall(spmi_init);
602 MODULE_LICENSE("GPL v2");
603 MODULE_DESCRIPTION("SPMI module");
604 MODULE_ALIAS("platform:spmi");