1eebba71eSSuman Anna /* SPDX-License-Identifier: GPL-2.0 */ 2bd9a4c7dSOhad Ben-Cohen /* 3bd9a4c7dSOhad Ben-Cohen * Hardware spinlocks internal header 4bd9a4c7dSOhad Ben-Cohen * 5bd9a4c7dSOhad Ben-Cohen * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com 6bd9a4c7dSOhad Ben-Cohen * 7bd9a4c7dSOhad Ben-Cohen * Contact: Ohad Ben-Cohen <ohad@wizery.com> 8bd9a4c7dSOhad Ben-Cohen */ 9bd9a4c7dSOhad Ben-Cohen 10bd9a4c7dSOhad Ben-Cohen #ifndef __HWSPINLOCK_HWSPINLOCK_H 11bd9a4c7dSOhad Ben-Cohen #define __HWSPINLOCK_HWSPINLOCK_H 12bd9a4c7dSOhad Ben-Cohen 13bd9a4c7dSOhad Ben-Cohen #include <linux/spinlock.h> 14bd9a4c7dSOhad Ben-Cohen #include <linux/device.h> 15bd9a4c7dSOhad Ben-Cohen 16300bab97SOhad Ben-Cohen struct hwspinlock_device; 17300bab97SOhad Ben-Cohen 18bd9a4c7dSOhad Ben-Cohen /** 19bd9a4c7dSOhad Ben-Cohen * struct hwspinlock_ops - platform-specific hwspinlock handlers 20bd9a4c7dSOhad Ben-Cohen * 21bd9a4c7dSOhad Ben-Cohen * @trylock: make a single attempt to take the lock. returns 0 on 22bd9a4c7dSOhad Ben-Cohen * failure and true on success. may _not_ sleep. 23bd9a4c7dSOhad Ben-Cohen * @unlock: release the lock. always succeed. may _not_ sleep. 24bd9a4c7dSOhad Ben-Cohen * @relax: optional, platform-specific relax handler, called by hwspinlock 25bd9a4c7dSOhad Ben-Cohen * core while spinning on a lock, between two successive 26bd9a4c7dSOhad Ben-Cohen * invocations of @trylock. may _not_ sleep. 27bd9a4c7dSOhad Ben-Cohen */ 28bd9a4c7dSOhad Ben-Cohen struct hwspinlock_ops { 29bd9a4c7dSOhad Ben-Cohen int (*trylock)(struct hwspinlock *lock); 30bd9a4c7dSOhad Ben-Cohen void (*unlock)(struct hwspinlock *lock); 31bd9a4c7dSOhad Ben-Cohen void (*relax)(struct hwspinlock *lock); 32bd9a4c7dSOhad Ben-Cohen }; 33bd9a4c7dSOhad Ben-Cohen 34bd9a4c7dSOhad Ben-Cohen /** 35bd9a4c7dSOhad Ben-Cohen * struct hwspinlock - this struct represents a single hwspinlock instance 36300bab97SOhad Ben-Cohen * @bank: the hwspinlock_device structure which owns this lock 37bd9a4c7dSOhad Ben-Cohen * @lock: initialized and used by hwspinlock core 38300bab97SOhad Ben-Cohen * @priv: private data, owned by the underlying platform-specific hwspinlock drv 39bd9a4c7dSOhad Ben-Cohen */ 40bd9a4c7dSOhad Ben-Cohen struct hwspinlock { 41300bab97SOhad Ben-Cohen struct hwspinlock_device *bank; 42300bab97SOhad Ben-Cohen spinlock_t lock; 43300bab97SOhad Ben-Cohen void *priv; 44300bab97SOhad Ben-Cohen }; 45300bab97SOhad Ben-Cohen 46300bab97SOhad Ben-Cohen /** 47300bab97SOhad Ben-Cohen * struct hwspinlock_device - a device which usually spans numerous hwspinlocks 48300bab97SOhad Ben-Cohen * @dev: underlying device, will be used to invoke runtime PM api 49300bab97SOhad Ben-Cohen * @ops: platform-specific hwspinlock handlers 50300bab97SOhad Ben-Cohen * @base_id: id index of the first lock in this device 51300bab97SOhad Ben-Cohen * @num_locks: number of locks in this device 52300bab97SOhad Ben-Cohen * @lock: dynamically allocated array of 'struct hwspinlock' 53300bab97SOhad Ben-Cohen */ 54300bab97SOhad Ben-Cohen struct hwspinlock_device { 55bd9a4c7dSOhad Ben-Cohen struct device *dev; 56bd9a4c7dSOhad Ben-Cohen const struct hwspinlock_ops *ops; 57300bab97SOhad Ben-Cohen int base_id; 58300bab97SOhad Ben-Cohen int num_locks; 59ef17f519SGustavo A. R. Silva struct hwspinlock lock[]; 60bd9a4c7dSOhad Ben-Cohen }; 61bd9a4c7dSOhad Ben-Cohen hwlock_to_id(struct hwspinlock * hwlock)62300bab97SOhad Ben-Cohenstatic inline int hwlock_to_id(struct hwspinlock *hwlock) 63300bab97SOhad Ben-Cohen { 64300bab97SOhad Ben-Cohen int local_id = hwlock - &hwlock->bank->lock[0]; 65300bab97SOhad Ben-Cohen 66300bab97SOhad Ben-Cohen return hwlock->bank->base_id + local_id; 67300bab97SOhad Ben-Cohen } 68300bab97SOhad Ben-Cohen 69bd9a4c7dSOhad Ben-Cohen #endif /* __HWSPINLOCK_HWSPINLOCK_H */ 70