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