1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * Hardware spinlocks internal header 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com 6*4882a593Smuzhiyun * 7*4882a593Smuzhiyun * Contact: Ohad Ben-Cohen <ohad@wizery.com> 8*4882a593Smuzhiyun */ 9*4882a593Smuzhiyun 10*4882a593Smuzhiyun #ifndef __HWSPINLOCK_HWSPINLOCK_H 11*4882a593Smuzhiyun #define __HWSPINLOCK_HWSPINLOCK_H 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun #include <linux/spinlock.h> 14*4882a593Smuzhiyun #include <linux/device.h> 15*4882a593Smuzhiyun 16*4882a593Smuzhiyun struct hwspinlock_device; 17*4882a593Smuzhiyun 18*4882a593Smuzhiyun /** 19*4882a593Smuzhiyun * struct hwspinlock_ops - platform-specific hwspinlock handlers 20*4882a593Smuzhiyun * 21*4882a593Smuzhiyun * @trylock: make a single attempt to take the lock. returns 0 on 22*4882a593Smuzhiyun * failure and true on success. may _not_ sleep. 23*4882a593Smuzhiyun * @unlock: release the lock. always succeed. may _not_ sleep. 24*4882a593Smuzhiyun * @relax: optional, platform-specific relax handler, called by hwspinlock 25*4882a593Smuzhiyun * core while spinning on a lock, between two successive 26*4882a593Smuzhiyun * invocations of @trylock. may _not_ sleep. 27*4882a593Smuzhiyun */ 28*4882a593Smuzhiyun struct hwspinlock_ops { 29*4882a593Smuzhiyun int (*trylock)(struct hwspinlock *lock); 30*4882a593Smuzhiyun void (*unlock)(struct hwspinlock *lock); 31*4882a593Smuzhiyun void (*relax)(struct hwspinlock *lock); 32*4882a593Smuzhiyun }; 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun /** 35*4882a593Smuzhiyun * struct hwspinlock - this struct represents a single hwspinlock instance 36*4882a593Smuzhiyun * @bank: the hwspinlock_device structure which owns this lock 37*4882a593Smuzhiyun * @lock: initialized and used by hwspinlock core 38*4882a593Smuzhiyun * @priv: private data, owned by the underlying platform-specific hwspinlock drv 39*4882a593Smuzhiyun */ 40*4882a593Smuzhiyun struct hwspinlock { 41*4882a593Smuzhiyun struct hwspinlock_device *bank; 42*4882a593Smuzhiyun spinlock_t lock; 43*4882a593Smuzhiyun void *priv; 44*4882a593Smuzhiyun }; 45*4882a593Smuzhiyun 46*4882a593Smuzhiyun /** 47*4882a593Smuzhiyun * struct hwspinlock_device - a device which usually spans numerous hwspinlocks 48*4882a593Smuzhiyun * @dev: underlying device, will be used to invoke runtime PM api 49*4882a593Smuzhiyun * @ops: platform-specific hwspinlock handlers 50*4882a593Smuzhiyun * @base_id: id index of the first lock in this device 51*4882a593Smuzhiyun * @num_locks: number of locks in this device 52*4882a593Smuzhiyun * @lock: dynamically allocated array of 'struct hwspinlock' 53*4882a593Smuzhiyun */ 54*4882a593Smuzhiyun struct hwspinlock_device { 55*4882a593Smuzhiyun struct device *dev; 56*4882a593Smuzhiyun const struct hwspinlock_ops *ops; 57*4882a593Smuzhiyun int base_id; 58*4882a593Smuzhiyun int num_locks; 59*4882a593Smuzhiyun struct hwspinlock lock[]; 60*4882a593Smuzhiyun }; 61*4882a593Smuzhiyun hwlock_to_id(struct hwspinlock * hwlock)62*4882a593Smuzhiyunstatic inline int hwlock_to_id(struct hwspinlock *hwlock) 63*4882a593Smuzhiyun { 64*4882a593Smuzhiyun int local_id = hwlock - &hwlock->bank->lock[0]; 65*4882a593Smuzhiyun 66*4882a593Smuzhiyun return hwlock->bank->base_id + local_id; 67*4882a593Smuzhiyun } 68*4882a593Smuzhiyun 69*4882a593Smuzhiyun #endif /* __HWSPINLOCK_HWSPINLOCK_H */ 70