Lines Matching +full:device +full:- +full:specific
1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com
7 * Contact: Ohad Ben-Cohen <ohad@wizery.com>
19 #include <linux/radix-tree.h>
36 * and provides easy-to-use API which makes the hwspinlock core code simple
54 * as the radix-tree API requires that users provide all synchronisation.
55 * A mutex is needed because we're using non-atomic radix tree allocations.
61 * __hwspin_trylock() - attempt to lock a specific hwspinlock
72 * user need some time-consuming or sleepable operations under the hardware
87 * Returns: %0 if we successfully locked the hwspinlock or -EBUSY if
97 return -EINVAL; in __hwspin_trylock()
106 * 2. Make the hwspinlock SMP-safe (so we can take it from in __hwspin_trylock()
114 ret = spin_trylock_irqsave(&hwlock->lock, *flags); in __hwspin_trylock()
117 ret = spin_trylock_irq(&hwlock->lock); in __hwspin_trylock()
124 ret = spin_trylock(&hwlock->lock); in __hwspin_trylock()
130 return -EBUSY; in __hwspin_trylock()
132 /* try to take the hwspinlock device */ in __hwspin_trylock()
133 ret = hwlock->bank->ops->trylock(hwlock); in __hwspin_trylock()
139 spin_unlock_irqrestore(&hwlock->lock, *flags); in __hwspin_trylock()
142 spin_unlock_irq(&hwlock->lock); in __hwspin_trylock()
149 spin_unlock(&hwlock->lock); in __hwspin_trylock()
153 return -EBUSY; in __hwspin_trylock()
173 * __hwspin_lock_timeout() - lock an hwspinlock with timeout limit
186 * user need some time-consuming or sleepable operations under the hardware
190 * is handled with busy-waiting delays, hence shall not exceed few msecs.
204 * error code otherwise (most notably -ETIMEDOUT if the @hwlock is still
220 if (ret != -EBUSY) in __hwspin_lock_timeout()
231 return -ETIMEDOUT; in __hwspin_lock_timeout()
234 return -ETIMEDOUT; in __hwspin_lock_timeout()
238 * Allow platform-specific relax handlers to prevent in __hwspin_lock_timeout()
241 if (hwlock->bank->ops->relax) in __hwspin_lock_timeout()
242 hwlock->bank->ops->relax(hwlock); in __hwspin_lock_timeout()
250 * __hwspin_unlock() - unlock a specific hwspinlock
251 * @hwlock: a previously-acquired hwspinlock which we want to unlock
255 * This function will unlock a specific hwspinlock, enable preemption and
287 hwlock->bank->ops->unlock(hwlock); in __hwspin_unlock()
292 spin_unlock_irqrestore(&hwlock->lock, *flags); in __hwspin_unlock()
295 spin_unlock_irq(&hwlock->lock); in __hwspin_unlock()
302 spin_unlock(&hwlock->lock); in __hwspin_unlock()
309 * of_hwspin_lock_simple_xlate - translate hwlock_spec to return a lock id
310 * @hwlock_spec: hwlock specifier as found in the device tree
316 * or -EINVAL on invalid specifier cell count.
321 if (WARN_ON(hwlock_spec->args_count != 1)) in of_hwspin_lock_simple_xlate()
322 return -EINVAL; in of_hwspin_lock_simple_xlate()
324 return hwlock_spec->args[0]; in of_hwspin_lock_simple_xlate()
328 * of_hwspin_lock_get_id() - get lock id for an OF phandle-based specific lock
329 * @np: device node from which to request the specific hwlock
333 * get the global lock id of a specific hwspinlock using the phandle of the
334 * hwspinlock device, so that it can be requested using the normal
337 * Returns: the global lock id number on success, -EPROBE_DEFER if the
338 * hwspinlock device is not yet registered, -EINVAL on invalid args
351 ret = of_parse_phandle_with_args(np, "hwlocks", "#hwlock-cells", index, in of_hwspin_lock_get_id()
357 ret = -ENOENT; in of_hwspin_lock_get_id()
361 /* Find the hwspinlock device: we need its base_id */ in of_hwspin_lock_get_id()
362 ret = -EPROBE_DEFER; in of_hwspin_lock_get_id()
373 if (device_match_of_node(hwlock->bank->dev, args.np)) { in of_hwspin_lock_get_id()
383 if (id < 0 || id >= hwlock->bank->num_locks) { in of_hwspin_lock_get_id()
384 ret = -EINVAL; in of_hwspin_lock_get_id()
387 id += hwlock->bank->base_id; in of_hwspin_lock_get_id()
396 * of_hwspin_lock_get_id_byname() - get lock id for an specified hwlock name
397 * @np: device node from which to request the specific hwlock
401 * get the global lock id of a specific hwspinlock using the specified name of
402 * the hwspinlock device, so that it can be requested using the normal
405 * Returns: the global lock id number on success, -EPROBE_DEFER if the
406 * hwspinlock device is not yet registered, -EINVAL on invalid args
415 return -EINVAL; in of_hwspin_lock_get_id_byname()
417 index = of_property_match_string(np, "hwlock-names", name); in of_hwspin_lock_get_id_byname()
434 if (ret == -EEXIST) in hwspin_lock_register_single()
442 /* self-sanity check which should never fail */ in hwspin_lock_register_single()
476 * hwspin_lock_register() - register a new hw spinlock device
477 * @bank: the hwspinlock device, which usually provides numerous hw locks
478 * @dev: the backing device
479 * @ops: hwspinlock handlers for this device
481 * @num_locks: number of hwspinlocks provided by this device
483 * This function should be called from the underlying platform-specific
484 * implementation, to register a new hwspinlock device instance.
490 int hwspin_lock_register(struct hwspinlock_device *bank, struct device *dev, in hwspin_lock_register()
496 if (!bank || !ops || !dev || !num_locks || !ops->trylock || in hwspin_lock_register()
497 !ops->unlock) { in hwspin_lock_register()
499 return -EINVAL; in hwspin_lock_register()
502 bank->dev = dev; in hwspin_lock_register()
503 bank->ops = ops; in hwspin_lock_register()
504 bank->base_id = base_id; in hwspin_lock_register()
505 bank->num_locks = num_locks; in hwspin_lock_register()
508 hwlock = &bank->lock[i]; in hwspin_lock_register()
510 spin_lock_init(&hwlock->lock); in hwspin_lock_register()
511 hwlock->bank = bank; in hwspin_lock_register()
521 while (--i >= 0) in hwspin_lock_register()
528 * hwspin_lock_unregister() - unregister an hw spinlock device
529 * @bank: the hwspinlock device, which usually provides numerous hw locks
531 * This function should be called from the underlying platform-specific
543 for (i = 0; i < bank->num_locks; i++) { in hwspin_lock_unregister()
544 hwlock = &bank->lock[i]; in hwspin_lock_unregister()
546 tmp = hwspin_lock_unregister_single(bank->base_id + i); in hwspin_lock_unregister()
548 return -EBUSY; in hwspin_lock_unregister()
550 /* self-sanity check that should never fail */ in hwspin_lock_unregister()
558 static void devm_hwspin_lock_unreg(struct device *dev, void *res) in devm_hwspin_lock_unreg()
563 static int devm_hwspin_lock_device_match(struct device *dev, void *res, in devm_hwspin_lock_device_match()
575 * devm_hwspin_lock_unregister() - unregister an hw spinlock device for
576 * a managed device
577 * @dev: the backing device
578 * @bank: the hwspinlock device, which usually provides numerous hw locks
580 * This function should be called from the underlying platform-specific
587 int devm_hwspin_lock_unregister(struct device *dev, in devm_hwspin_lock_unregister()
601 * devm_hwspin_lock_register() - register a new hw spinlock device for
602 * a managed device
603 * @dev: the backing device
604 * @bank: the hwspinlock device, which usually provides numerous hw locks
605 * @ops: hwspinlock handlers for this device
607 * @num_locks: number of hwspinlocks provided by this device
609 * This function should be called from the underlying platform-specific
610 * implementation, to register a new hwspinlock device instance.
616 int devm_hwspin_lock_register(struct device *dev, in devm_hwspin_lock_register()
626 return -ENOMEM; in devm_hwspin_lock_register()
641 * __hwspin_lock_request() - tag an hwspinlock as used and power it up
653 struct device *dev = hwlock->bank->dev; in __hwspin_lock_request()
658 if (!try_module_get(dev->driver->owner)) { in __hwspin_lock_request()
660 return -EINVAL; in __hwspin_lock_request()
665 if (ret < 0 && ret != -EACCES) { in __hwspin_lock_request()
666 dev_err(dev, "%s: can't power on device\n", __func__); in __hwspin_lock_request()
668 module_put(dev->driver->owner); in __hwspin_lock_request()
678 /* self-sanity check that should never fail */ in __hwspin_lock_request()
685 * hwspin_lock_get_id() - retrieve id number of a given hwspinlock
688 * Returns: the id number of a given @hwlock, or -EINVAL if @hwlock is invalid.
694 return -EINVAL; in hwspin_lock_get_id()
702 * hwspin_lock_request() - request an hwspinlock
704 * This function should be called by users of the hwspinlock device,
745 * hwspin_lock_request_specific() - request for a specific hwspinlock
746 * @id: index of the specific hwspinlock that is requested
749 * in order to assign them a specific hwspinlock.
751 * reserve specific hwspinlock ids for predefined purposes.
794 * hwspin_lock_free() - free a specific hwspinlock
795 * @hwlock: the specific hwspinlock to free
807 struct device *dev; in hwspin_lock_free()
813 return -EINVAL; in hwspin_lock_free()
816 dev = hwlock->bank->dev; in hwspin_lock_free()
825 ret = -EINVAL; in hwspin_lock_free()
829 /* notify the underlying device that power is not needed */ in hwspin_lock_free()
839 module_put(dev->driver->owner); in hwspin_lock_free()
847 static int devm_hwspin_lock_match(struct device *dev, void *res, void *data) in devm_hwspin_lock_match()
857 static void devm_hwspin_lock_release(struct device *dev, void *res) in devm_hwspin_lock_release()
863 * devm_hwspin_lock_free() - free a specific hwspinlock for a managed device
864 * @dev: the device to free the specific hwspinlock
865 * @hwlock: the specific hwspinlock to free
875 int devm_hwspin_lock_free(struct device *dev, struct hwspinlock *hwlock) in devm_hwspin_lock_free()
888 * devm_hwspin_lock_request() - request an hwspinlock for a managed device
889 * @dev: the device to request an hwspinlock
891 * This function should be called by users of the hwspinlock device,
901 struct hwspinlock *devm_hwspin_lock_request(struct device *dev) in devm_hwspin_lock_request()
922 * devm_hwspin_lock_request_specific() - request for a specific hwspinlock for
923 * a managed device
924 * @dev: the device to request the specific hwspinlock
925 * @id: index of the specific hwspinlock that is requested
928 * in order to assign them a specific hwspinlock.
930 * reserve specific hwspinlock ids for predefined purposes.
936 struct hwspinlock *devm_hwspin_lock_request_specific(struct device *dev, in devm_hwspin_lock_request_specific()
958 MODULE_AUTHOR("Ohad Ben-Cohen <ohad@wizery.com>");