Commit | Line | Data |
---|---|---|
357ace03 | 1 | // SPDX-License-Identifier: GPL-2.0 |
70ba4cc2 SQ |
2 | /* |
3 | * OMAP hardware spinlock driver | |
4 | * | |
b9ddb250 | 5 | * Copyright (C) 2010-2021 Texas Instruments Incorporated - https://www.ti.com |
70ba4cc2 SQ |
6 | * |
7 | * Contact: Simon Que <sque@ti.com> | |
8 | * Hari Kanigeri <h-kanigeri2@ti.com> | |
9 | * Ohad Ben-Cohen <ohad@wizery.com> | |
b9ddb250 | 10 | * Suman Anna <s-anna@ti.com> |
70ba4cc2 SQ |
11 | */ |
12 | ||
13 | #include <linux/kernel.h> | |
14 | #include <linux/module.h> | |
15 | #include <linux/device.h> | |
16 | #include <linux/delay.h> | |
17 | #include <linux/io.h> | |
18 | #include <linux/bitops.h> | |
19 | #include <linux/pm_runtime.h> | |
20 | #include <linux/slab.h> | |
21 | #include <linux/spinlock.h> | |
22 | #include <linux/hwspinlock.h> | |
65bd4341 | 23 | #include <linux/of.h> |
70ba4cc2 SQ |
24 | #include <linux/platform_device.h> |
25 | ||
26 | #include "hwspinlock_internal.h" | |
27 | ||
28 | /* Spinlock register offsets */ | |
29 | #define SYSSTATUS_OFFSET 0x0014 | |
30 | #define LOCK_BASE_OFFSET 0x0800 | |
31 | ||
32 | #define SPINLOCK_NUMLOCKS_BIT_OFFSET (24) | |
33 | ||
34 | /* Possible values of SPINLOCK_LOCK_REG */ | |
35 | #define SPINLOCK_NOTTAKEN (0) /* free */ | |
36 | #define SPINLOCK_TAKEN (1) /* locked */ | |
37 | ||
70ba4cc2 SQ |
38 | static int omap_hwspinlock_trylock(struct hwspinlock *lock) |
39 | { | |
300bab97 | 40 | void __iomem *lock_addr = lock->priv; |
70ba4cc2 SQ |
41 | |
42 | /* attempt to acquire the lock by reading its value */ | |
300bab97 | 43 | return (SPINLOCK_NOTTAKEN == readl(lock_addr)); |
70ba4cc2 SQ |
44 | } |
45 | ||
46 | static void omap_hwspinlock_unlock(struct hwspinlock *lock) | |
47 | { | |
300bab97 | 48 | void __iomem *lock_addr = lock->priv; |
70ba4cc2 SQ |
49 | |
50 | /* release the lock by writing 0 to it */ | |
300bab97 | 51 | writel(SPINLOCK_NOTTAKEN, lock_addr); |
70ba4cc2 SQ |
52 | } |
53 | ||
54 | /* | |
55 | * relax the OMAP interconnect while spinning on it. | |
56 | * | |
57 | * The specs recommended that the retry delay time will be | |
58 | * just over half of the time that a requester would be | |
59 | * expected to hold the lock. | |
60 | * | |
61 | * The number below is taken from an hardware specs example, | |
62 | * obviously it is somewhat arbitrary. | |
63 | */ | |
64 | static void omap_hwspinlock_relax(struct hwspinlock *lock) | |
65 | { | |
66 | ndelay(50); | |
67 | } | |
68 | ||
69 | static const struct hwspinlock_ops omap_hwspinlock_ops = { | |
70 | .trylock = omap_hwspinlock_trylock, | |
71 | .unlock = omap_hwspinlock_unlock, | |
72 | .relax = omap_hwspinlock_relax, | |
73 | }; | |
74 | ||
57129106 | 75 | static int omap_hwspinlock_probe(struct platform_device *pdev) |
70ba4cc2 | 76 | { |
65bd4341 | 77 | struct device_node *node = pdev->dev.of_node; |
300bab97 OBC |
78 | struct hwspinlock_device *bank; |
79 | struct hwspinlock *hwlock; | |
70ba4cc2 | 80 | void __iomem *io_base; |
300bab97 | 81 | int num_locks, i, ret; |
65bd4341 SA |
82 | /* Only a single hwspinlock block device is supported */ |
83 | int base_id = 0; | |
70ba4cc2 | 84 | |
65bd4341 | 85 | if (!node) |
c3c1250e OBC |
86 | return -ENODEV; |
87 | ||
bf274006 BW |
88 | io_base = devm_platform_ioremap_resource(pdev, 0); |
89 | if (IS_ERR(io_base)) | |
90 | return PTR_ERR(io_base); | |
70ba4cc2 | 91 | |
e1e4528f SA |
92 | /* |
93 | * make sure the module is enabled and clocked before reading | |
94 | * the module SYSSTATUS register | |
95 | */ | |
96 | pm_runtime_enable(&pdev->dev); | |
0e01d176 MC |
97 | ret = pm_runtime_resume_and_get(&pdev->dev); |
98 | if (ret < 0) | |
bf274006 | 99 | goto runtime_err; |
e1e4528f | 100 | |
70ba4cc2 SQ |
101 | /* Determine number of locks */ |
102 | i = readl(io_base + SYSSTATUS_OFFSET); | |
103 | i >>= SPINLOCK_NUMLOCKS_BIT_OFFSET; | |
104 | ||
e1e4528f SA |
105 | /* |
106 | * runtime PM will make sure the clock of this module is | |
107 | * enabled again iff at least one lock is requested | |
108 | */ | |
109 | ret = pm_runtime_put(&pdev->dev); | |
110 | if (ret < 0) | |
bf274006 | 111 | goto runtime_err; |
e1e4528f | 112 | |
70ba4cc2 SQ |
113 | /* one of the four lsb's must be set, and nothing else */ |
114 | if (hweight_long(i & 0xf) != 1 || i > 8) { | |
115 | ret = -EINVAL; | |
bf274006 | 116 | goto runtime_err; |
70ba4cc2 SQ |
117 | } |
118 | ||
300bab97 | 119 | num_locks = i * 32; /* actual number of locks in this device */ |
c97f6dd0 | 120 | |
42f291eb BW |
121 | bank = devm_kzalloc(&pdev->dev, struct_size(bank, lock, num_locks), |
122 | GFP_KERNEL); | |
300bab97 | 123 | if (!bank) { |
c97f6dd0 | 124 | ret = -ENOMEM; |
bf274006 | 125 | goto runtime_err; |
c97f6dd0 OBC |
126 | } |
127 | ||
300bab97 | 128 | platform_set_drvdata(pdev, bank); |
70ba4cc2 | 129 | |
300bab97 OBC |
130 | for (i = 0, hwlock = &bank->lock[0]; i < num_locks; i++, hwlock++) |
131 | hwlock->priv = io_base + LOCK_BASE_OFFSET + sizeof(u32) * i; | |
70ba4cc2 | 132 | |
300bab97 | 133 | ret = hwspin_lock_register(bank, &pdev->dev, &omap_hwspinlock_ops, |
65bd4341 | 134 | base_id, num_locks); |
300bab97 | 135 | if (ret) |
42f291eb | 136 | goto runtime_err; |
70ba4cc2 | 137 | |
d4d98bba SA |
138 | dev_dbg(&pdev->dev, "Registered %d locks with HwSpinlock core\n", |
139 | num_locks); | |
140 | ||
70ba4cc2 SQ |
141 | return 0; |
142 | ||
bf274006 | 143 | runtime_err: |
e1e4528f | 144 | pm_runtime_disable(&pdev->dev); |
70ba4cc2 SQ |
145 | return ret; |
146 | } | |
147 | ||
4cf16b6b | 148 | static void omap_hwspinlock_remove(struct platform_device *pdev) |
70ba4cc2 | 149 | { |
300bab97 | 150 | struct hwspinlock_device *bank = platform_get_drvdata(pdev); |
300bab97 OBC |
151 | int ret; |
152 | ||
153 | ret = hwspin_lock_unregister(bank); | |
154 | if (ret) { | |
155 | dev_err(&pdev->dev, "%s failed: %d\n", __func__, ret); | |
4cf16b6b | 156 | return; |
70ba4cc2 SQ |
157 | } |
158 | ||
159 | pm_runtime_disable(&pdev->dev); | |
70ba4cc2 SQ |
160 | } |
161 | ||
65bd4341 SA |
162 | static const struct of_device_id omap_hwspinlock_of_match[] = { |
163 | { .compatible = "ti,omap4-hwspinlock", }, | |
b9ddb250 | 164 | { .compatible = "ti,am64-hwspinlock", }, |
6fa154e2 | 165 | { .compatible = "ti,am654-hwspinlock", }, |
65bd4341 SA |
166 | { /* end */ }, |
167 | }; | |
168 | MODULE_DEVICE_TABLE(of, omap_hwspinlock_of_match); | |
169 | ||
70ba4cc2 SQ |
170 | static struct platform_driver omap_hwspinlock_driver = { |
171 | .probe = omap_hwspinlock_probe, | |
4cf16b6b | 172 | .remove_new = omap_hwspinlock_remove, |
70ba4cc2 SQ |
173 | .driver = { |
174 | .name = "omap_hwspinlock", | |
1b39e760 | 175 | .of_match_table = omap_hwspinlock_of_match, |
70ba4cc2 SQ |
176 | }, |
177 | }; | |
178 | ||
179 | static int __init omap_hwspinlock_init(void) | |
180 | { | |
181 | return platform_driver_register(&omap_hwspinlock_driver); | |
182 | } | |
183 | /* board init code might need to reserve hwspinlocks for predefined purposes */ | |
184 | postcore_initcall(omap_hwspinlock_init); | |
185 | ||
186 | static void __exit omap_hwspinlock_exit(void) | |
187 | { | |
188 | platform_driver_unregister(&omap_hwspinlock_driver); | |
189 | } | |
190 | module_exit(omap_hwspinlock_exit); | |
191 | ||
192 | MODULE_LICENSE("GPL v2"); | |
193 | MODULE_DESCRIPTION("Hardware spinlock driver for OMAP"); | |
194 | MODULE_AUTHOR("Simon Que <sque@ti.com>"); | |
195 | MODULE_AUTHOR("Hari Kanigeri <h-kanigeri2@ti.com>"); | |
196 | MODULE_AUTHOR("Ohad Ben-Cohen <ohad@wizery.com>"); |