Lines Matching defs:framer
11 #include <linux/framer/framer.h>
12 #include <linux/framer/framer-provider.h>
23 .name = "framer",
31 #define dev_to_framer(a) (container_of((a), struct framer, dev))
33 int framer_pm_runtime_get(struct framer *framer)
37 if (!pm_runtime_enabled(&framer->dev))
40 ret = pm_runtime_get(&framer->dev);
42 pm_runtime_put_noidle(&framer->dev);
48 int framer_pm_runtime_get_sync(struct framer *framer)
52 if (!pm_runtime_enabled(&framer->dev))
55 ret = pm_runtime_get_sync(&framer->dev);
57 pm_runtime_put_sync(&framer->dev);
63 int framer_pm_runtime_put(struct framer *framer)
65 if (!pm_runtime_enabled(&framer->dev))
68 return pm_runtime_put(&framer->dev);
72 int framer_pm_runtime_put_sync(struct framer *framer)
74 if (!pm_runtime_enabled(&framer->dev))
77 return pm_runtime_put_sync(&framer->dev);
82 * framer_init - framer internal initialization before framer operation
83 * @framer: the framer returned by framer_get()
85 * Used to allow framer's driver to perform framer internal initialization,
87 * is required by the framer to perform the start of operation.
92 int framer_init(struct framer *framer)
97 ret = framer_pm_runtime_get_sync(framer);
102 mutex_lock(&framer->mutex);
103 if (framer->power_count > framer->init_count)
104 dev_warn(&framer->dev, "framer_power_on was called before framer init\n");
106 if (framer->init_count == 0) {
107 if (framer->ops->init) {
108 ret = framer->ops->init(framer);
110 dev_err(&framer->dev, "framer init failed --> %d\n", ret);
114 if (framer->ops->flags & FRAMER_FLAG_POLL_STATUS)
117 ++framer->init_count;
120 mutex_unlock(&framer->mutex);
123 ret = framer_get_status(framer, &framer->prev_status);
125 dev_warn(&framer->dev, "framer get status failed --> %d\n", ret);
129 queue_delayed_work(system_power_efficient_wq, &framer->polling_work, 1 * HZ);
132 framer_pm_runtime_put(framer);
139 * @framer: the framer returned by framer_get()
143 int framer_exit(struct framer *framer)
147 ret = framer_pm_runtime_get_sync(framer);
152 mutex_lock(&framer->mutex);
153 --framer->init_count;
154 if (framer->init_count == 0) {
155 if (framer->ops->flags & FRAMER_FLAG_POLL_STATUS) {
156 mutex_unlock(&framer->mutex);
157 cancel_delayed_work_sync(&framer->polling_work);
158 mutex_lock(&framer->mutex);
161 if (framer->ops->exit)
162 framer->ops->exit(framer);
165 mutex_unlock(&framer->mutex);
166 framer_pm_runtime_put(framer);
172 * framer_power_on - Enable the framer and enter proper operation
173 * @framer: the framer returned by framer_get()
179 int framer_power_on(struct framer *framer)
183 if (framer->pwr) {
184 ret = regulator_enable(framer->pwr);
189 ret = framer_pm_runtime_get_sync(framer);
193 mutex_lock(&framer->mutex);
194 if (framer->power_count == 0 && framer->ops->power_on) {
195 ret = framer->ops->power_on(framer);
197 dev_err(&framer->dev, "framer poweron failed --> %d\n", ret);
201 ++framer->power_count;
202 mutex_unlock(&framer->mutex);
206 mutex_unlock(&framer->mutex);
207 framer_pm_runtime_put_sync(framer);
209 if (framer->pwr)
210 regulator_disable(framer->pwr);
216 * framer_power_off - Disable the framer.
217 * @framer: the framer returned by framer_get()
223 int framer_power_off(struct framer *framer)
227 mutex_lock(&framer->mutex);
228 if (framer->power_count == 1 && framer->ops->power_off) {
229 ret = framer->ops->power_off(framer);
231 dev_err(&framer->dev, "framer poweroff failed --> %d\n", ret);
232 mutex_unlock(&framer->mutex);
236 --framer->power_count;
237 mutex_unlock(&framer->mutex);
238 framer_pm_runtime_put(framer);
240 if (framer->pwr)
241 regulator_disable(framer->pwr);
248 * framer_get_status() - Gets the framer status
249 * @framer: the framer returned by framer_get()
252 * Used to get the framer status. framer_init() must have been called
253 * on the framer.
257 int framer_get_status(struct framer *framer, struct framer_status *status)
261 if (!framer->ops->get_status)
267 mutex_lock(&framer->mutex);
268 ret = framer->ops->get_status(framer, status);
269 mutex_unlock(&framer->mutex);
276 * framer_set_config() - Sets the framer configuration
277 * @framer: the framer returned by framer_get()
280 * Used to set the framer configuration. framer_init() must have been called
281 * on the framer.
285 int framer_set_config(struct framer *framer, const struct framer_config *config)
289 if (!framer->ops->set_config)
292 mutex_lock(&framer->mutex);
293 ret = framer->ops->set_config(framer, config);
294 mutex_unlock(&framer->mutex);
301 * framer_get_config() - Gets the framer configuration
302 * @framer: the framer returned by framer_get()
305 * Used to get the framer configuration. framer_init() must have been called
306 * on the framer.
310 int framer_get_config(struct framer *framer, struct framer_config *config)
314 if (!framer->ops->get_config)
317 mutex_lock(&framer->mutex);
318 ret = framer->ops->get_config(framer, config);
319 mutex_unlock(&framer->mutex);
327 struct framer *framer = container_of(work, struct framer, polling_work.work);
331 ret = framer_get_status(framer, &status);
333 dev_err(&framer->dev, "polling, get status failed (%d)\n", ret);
336 if (memcmp(&framer->prev_status, &status, sizeof(status))) {
337 blocking_notifier_call_chain(&framer->notifier_list,
339 memcpy(&framer->prev_status, &status, sizeof(status));
344 queue_delayed_work(system_power_efficient_wq, &framer->polling_work, 1 * HZ);
349 * @framer: the framer returned by framer_get()
352 * Used to register a notifier block on framer events. framer_init() must have
353 * been called on the framer.
354 * The available framer events are present in enum framer_events.
358 int framer_notifier_register(struct framer *framer, struct notifier_block *nb)
360 return blocking_notifier_chain_register(&framer->notifier_list, nb);
366 * @framer: the framer returned by framer_get()
370 * been called on the framer.
374 int framer_notifier_unregister(struct framer *framer, struct notifier_block *nb)
376 return blocking_notifier_chain_unregister(&framer->notifier_list, nb);
392 static struct framer *framer_of_get_from_provider(const struct of_phandle_args *args)
395 struct framer *framer;
400 framer = ERR_PTR(-EPROBE_DEFER);
404 framer = framer_provider->of_xlate(framer_provider->dev, args);
411 return framer;
414 static struct framer *framer_of_get_byphandle(struct device_node *np, const char *propname,
418 struct framer *framer;
421 ret = of_parse_phandle_with_optional_args(np, propname, "#framer-cells", index, &args);
426 framer = ERR_PTR(-ENODEV);
430 framer = framer_of_get_from_provider(&args);
435 return framer;
438 static struct framer *framer_of_get_byparent(struct device_node *np, int index)
441 struct framer *framer;
448 framer = framer_of_get_from_provider(&args);
449 if (IS_ERR(framer) && PTR_ERR(framer) != -EPROBE_DEFER) {
454 return framer;
461 * framer_get() - lookup and obtain a reference to a framer.
462 * @dev: device that requests the framer
463 * @con_id: name of the framer from device's point of view
465 * Returns the framer driver, after getting a refcount to it; or
466 * -ENODEV if there is no such framer. The caller is responsible for
469 struct framer *framer_get(struct device *dev, const char *con_id)
471 struct framer *framer = ERR_PTR(-ENODEV);
477 framer = framer_of_get_byphandle(dev->of_node, con_id, 0);
479 framer = framer_of_get_byparent(dev->of_node, 0);
482 if (IS_ERR(framer))
483 return framer;
485 get_device(&framer->dev);
487 if (!try_module_get(framer->ops->owner)) {
492 link = device_link_add(dev, &framer->dev, DL_FLAG_STATELESS);
494 dev_err(dev, "failed to create device_link to %s\n", dev_name(&framer->dev));
499 return framer;
502 module_put(framer->ops->owner);
504 put_device(&framer->dev);
510 * framer_put() - release the framer
511 * @dev: device that wants to release this framer
512 * @framer: the framer returned by framer_get()
516 void framer_put(struct device *dev, struct framer *framer)
518 device_link_remove(dev, &framer->dev);
520 module_put(framer->ops->owner);
521 put_device(&framer->dev);
527 struct framer *framer = *(struct framer **)res;
529 framer_put(dev, framer);
533 * devm_framer_get() - lookup and obtain a reference to a framer.
534 * @dev: device that requests this framer
535 * @con_id: name of the framer from device's point of view
537 * Gets the framer using framer_get(), and associates a device with it using
541 struct framer *devm_framer_get(struct device *dev, const char *con_id)
543 struct framer **ptr, *framer;
549 framer = framer_get(dev, con_id);
550 if (!IS_ERR(framer)) {
551 *ptr = framer;
555 return framer;
558 return framer;
564 * framer.
565 * @dev: device that requests this framer
566 * @con_id: name of the framer from device's point of view
568 * Same as devm_framer_get() except that if the framer does not exist, it is not
569 * considered an error and -ENODEV will not be returned. Instead the NULL framer
572 struct framer *devm_framer_optional_get(struct device *dev, const char *con_id)
574 struct framer *framer = devm_framer_get(dev, con_id);
576 if (PTR_ERR(framer) == -ENODEV)
577 framer = NULL;
579 return framer;
585 struct framer *framer = container_of(work, struct framer, notify_status_work);
587 blocking_notifier_call_chain(&framer->notifier_list, FRAMER_EVENT_STATUS, NULL);
590 void framer_notify_status_change(struct framer *framer)
595 queue_work(system_power_efficient_wq, &framer->notify_status_work);
600 * framer_create() - create a new framer
601 * @dev: device that is creating the new framer
602 * @node: device node of the framer. default to dev->of_node.
603 * @ops: function pointers for performing framer operations
605 * Called to create a framer using framer framework.
607 struct framer *framer_create(struct device *dev, struct device_node *node,
610 struct framer *framer;
618 framer = kzalloc(sizeof(*framer), GFP_KERNEL);
619 if (!framer)
629 device_initialize(&framer->dev);
630 mutex_init(&framer->mutex);
631 INIT_WORK(&framer->notify_status_work, framer_notify_status_work);
632 INIT_DELAYED_WORK(&framer->polling_work, framer_polling_work);
633 BLOCKING_INIT_NOTIFIER_HEAD(&framer->notifier_list);
635 framer->dev.class = &framer_class;
636 framer->dev.parent = dev;
637 framer->dev.of_node = node ? node : dev->of_node;
638 framer->id = id;
639 framer->ops = ops;
641 ret = dev_set_name(&framer->dev, "framer-%s.%d", dev_name(dev), id);
645 /* framer-supply */
646 framer->pwr = regulator_get_optional(&framer->dev, "framer");
647 if (IS_ERR(framer->pwr)) {
648 ret = PTR_ERR(framer->pwr);
652 framer->pwr = NULL;
655 ret = device_add(&framer->dev);
660 pm_runtime_enable(&framer->dev);
661 pm_runtime_no_callbacks(&framer->dev);
664 return framer;
667 put_device(&framer->dev); /* calls framer_release() which frees resources */
671 kfree(framer);
677 * framer_destroy() - destroy the framer
678 * @framer: the framer to be destroyed
680 * Called to destroy the framer.
682 void framer_destroy(struct framer *framer)
687 cancel_delayed_work_sync(&framer->polling_work);
688 cancel_work_sync(&framer->notify_status_work);
689 pm_runtime_disable(&framer->dev);
690 device_unregister(&framer->dev); /* calls framer_release() which frees resources */
696 struct framer *framer = *(struct framer **)res;
698 framer_destroy(framer);
702 * devm_framer_create() - create a new framer
703 * @dev: device that is creating the new framer
704 * @node: device node of the framer
705 * @ops: function pointers for performing framer operations
707 * Creates a new framer device adding it to the framer class.
708 * While at that, it also associates the device with the framer using devres.
712 struct framer *devm_framer_create(struct device *dev, struct device_node *node,
715 struct framer **ptr, *framer;
721 framer = framer_create(dev, node, ops);
722 if (!IS_ERR(framer)) {
723 *ptr = framer;
729 return framer;
734 * framer_provider_simple_of_xlate() - returns the framer instance from framer provider
735 * @dev: the framer provider device
738 * Intended to be used by framer provider for the common case where #framer-cells is
739 * 0. For other cases where #framer-cells is greater than '0', the framer provider
741 * the appropriate framer.
743 struct framer *framer_provider_simple_of_xlate(struct device *dev,
747 struct framer *framer;
751 framer = dev_to_framer(dev);
752 if (args->np != framer->dev.of_node)
756 return framer;
765 * __framer_provider_of_register() - create/register framer provider with the framework
766 * @dev: struct device of the framer provider
768 * @of_xlate: function pointer to obtain framer instance from framer provider
771 * This is used in the case of dt boot for finding the framer instance from
772 * framer provider.
776 struct framer *(*of_xlate)(struct device *dev,
800 * framer_provider_of_unregister() - unregister framer provider from the framework
801 * @framer_provider: framer provider returned by framer_provider_of_register()
824 * __devm_framer_provider_of_register() - create/register framer provider with
826 * @dev: struct device of the framer provider
828 * @of_xlate: function pointer to obtain framer instance from framer provider
831 * This is used in the case of dt boot for finding the framer instance from
832 * framer provider. While at that, it also associates the device with the
833 * framer provider using devres. On driver detach, release function is invoked
838 struct framer *(*of_xlate)(struct device *dev,
860 * framer_release() - release the framer
861 * @dev: the dev member within framer
868 struct framer *framer;
870 framer = dev_to_framer(dev);
871 regulator_put(framer->pwr);
872 ida_free(&framer_ida, framer->id);
873 kfree(framer);