| 1 | ===========================
|
| 2 | Hardware Spinlock Framework
|
| 3 | ===========================
|
| 4 |
|
| 5 | Introduction
|
| 6 | ============
|
| 7 |
|
| 8 | Hardware spinlock modules provide hardware assistance for synchronization
|
| 9 | and mutual exclusion between heterogeneous processors and those not operating
|
| 10 | under a single, shared operating system.
|
| 11 |
|
| 12 | For example, OMAP4 has dual Cortex-A9, dual Cortex-M3 and a C64x+ DSP,
|
| 13 | each of which is running a different Operating System (the master, A9,
|
| 14 | is usually running Linux and the slave processors, the M3 and the DSP,
|
| 15 | are running some flavor of RTOS).
|
| 16 |
|
| 17 | A generic hwspinlock framework allows platform-independent drivers to use
|
| 18 | the hwspinlock device in order to access data structures that are shared
|
| 19 | between remote processors, that otherwise have no alternative mechanism
|
| 20 | to accomplish synchronization and mutual exclusion operations.
|
| 21 |
|
| 22 | This is necessary, for example, for Inter-processor communications:
|
| 23 | on OMAP4, cpu-intensive multimedia tasks are offloaded by the host to the
|
| 24 | remote M3 and/or C64x+ slave processors (by an IPC subsystem called Syslink).
|
| 25 |
|
| 26 | To achieve fast message-based communications, a minimal kernel support
|
| 27 | is needed to deliver messages arriving from a remote processor to the
|
| 28 | appropriate user process.
|
| 29 |
|
| 30 | This communication is based on simple data structures that is shared between
|
| 31 | the remote processors, and access to it is synchronized using the hwspinlock
|
| 32 | module (remote processor directly places new messages in this shared data
|
| 33 | structure).
|
| 34 |
|
| 35 | A common hwspinlock interface makes it possible to have generic, platform-
|
| 36 | independent, drivers.
|
| 37 |
|
| 38 | User API
|
| 39 | ========
|
| 40 |
|
| 41 | ::
|
| 42 |
|
| 43 | struct hwspinlock *hwspin_lock_request_specific(unsigned int id);
|
| 44 |
|
| 45 | Assign a specific hwspinlock id and return its address, or NULL
|
| 46 | if that hwspinlock is already in use. Usually board code will
|
| 47 | be calling this function in order to reserve specific hwspinlock
|
| 48 | ids for predefined purposes.
|
| 49 |
|
| 50 | Should be called from a process context (might sleep).
|
| 51 |
|
| 52 | ::
|
| 53 |
|
| 54 | int of_hwspin_lock_get_id(struct device_node *np, int index);
|
| 55 |
|
| 56 | Retrieve the global lock id for an OF phandle-based specific lock.
|
| 57 | This function provides a means for DT users of a hwspinlock module
|
| 58 | to get the global lock id of a specific hwspinlock, so that it can
|
| 59 | be requested using the normal hwspin_lock_request_specific() API.
|
| 60 |
|
| 61 | The function returns a lock id number on success, -EPROBE_DEFER if
|
| 62 | the hwspinlock device is not yet registered with the core, or other
|
| 63 | error values.
|
| 64 |
|
| 65 | Should be called from a process context (might sleep).
|
| 66 |
|
| 67 | ::
|
| 68 |
|
| 69 | int hwspin_lock_free(struct hwspinlock *hwlock);
|
| 70 |
|
| 71 | Free a previously-assigned hwspinlock; returns 0 on success, or an
|
| 72 | appropriate error code on failure (e.g. -EINVAL if the hwspinlock
|
| 73 | is already free).
|
| 74 |
|
| 75 | Should be called from a process context (might sleep).
|
| 76 |
|
| 77 | ::
|
| 78 |
|
| 79 | int hwspin_lock_bust(struct hwspinlock *hwlock, unsigned int id);
|
| 80 |
|
| 81 | After verifying the owner of the hwspinlock, release a previously acquired
|
| 82 | hwspinlock; returns 0 on success, or an appropriate error code on failure
|
| 83 | (e.g. -EOPNOTSUPP if the bust operation is not defined for the specific
|
| 84 | hwspinlock).
|
| 85 |
|
| 86 | Should be called from a process context (might sleep).
|
| 87 |
|
| 88 | ::
|
| 89 |
|
| 90 | int hwspin_lock_timeout(struct hwspinlock *hwlock, unsigned int timeout);
|
| 91 |
|
| 92 | Lock a previously-assigned hwspinlock with a timeout limit (specified in
|
| 93 | msecs). If the hwspinlock is already taken, the function will busy loop
|
| 94 | waiting for it to be released, but give up when the timeout elapses.
|
| 95 | Upon a successful return from this function, preemption is disabled so
|
| 96 | the caller must not sleep, and is advised to release the hwspinlock as
|
| 97 | soon as possible, in order to minimize remote cores polling on the
|
| 98 | hardware interconnect.
|
| 99 |
|
| 100 | Returns 0 when successful and an appropriate error code otherwise (most
|
| 101 | notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
|
| 102 | The function will never sleep.
|
| 103 |
|
| 104 | ::
|
| 105 |
|
| 106 | int hwspin_lock_timeout_irq(struct hwspinlock *hwlock, unsigned int timeout);
|
| 107 |
|
| 108 | Lock a previously-assigned hwspinlock with a timeout limit (specified in
|
| 109 | msecs). If the hwspinlock is already taken, the function will busy loop
|
| 110 | waiting for it to be released, but give up when the timeout elapses.
|
| 111 | Upon a successful return from this function, preemption and the local
|
| 112 | interrupts are disabled, so the caller must not sleep, and is advised to
|
| 113 | release the hwspinlock as soon as possible.
|
| 114 |
|
| 115 | Returns 0 when successful and an appropriate error code otherwise (most
|
| 116 | notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
|
| 117 | The function will never sleep.
|
| 118 |
|
| 119 | ::
|
| 120 |
|
| 121 | int hwspin_lock_timeout_irqsave(struct hwspinlock *hwlock, unsigned int to,
|
| 122 | unsigned long *flags);
|
| 123 |
|
| 124 | Lock a previously-assigned hwspinlock with a timeout limit (specified in
|
| 125 | msecs). If the hwspinlock is already taken, the function will busy loop
|
| 126 | waiting for it to be released, but give up when the timeout elapses.
|
| 127 | Upon a successful return from this function, preemption is disabled,
|
| 128 | local interrupts are disabled and their previous state is saved at the
|
| 129 | given flags placeholder. The caller must not sleep, and is advised to
|
| 130 | release the hwspinlock as soon as possible.
|
| 131 |
|
| 132 | Returns 0 when successful and an appropriate error code otherwise (most
|
| 133 | notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
|
| 134 |
|
| 135 | The function will never sleep.
|
| 136 |
|
| 137 | ::
|
| 138 |
|
| 139 | int hwspin_lock_timeout_raw(struct hwspinlock *hwlock, unsigned int timeout);
|
| 140 |
|
| 141 | Lock a previously-assigned hwspinlock with a timeout limit (specified in
|
| 142 | msecs). If the hwspinlock is already taken, the function will busy loop
|
| 143 | waiting for it to be released, but give up when the timeout elapses.
|
| 144 |
|
| 145 | Caution: User must protect the routine of getting hardware lock with mutex
|
| 146 | or spinlock to avoid dead-lock, that will let user can do some time-consuming
|
| 147 | or sleepable operations under the hardware lock.
|
| 148 |
|
| 149 | Returns 0 when successful and an appropriate error code otherwise (most
|
| 150 | notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
|
| 151 |
|
| 152 | The function will never sleep.
|
| 153 |
|
| 154 | ::
|
| 155 |
|
| 156 | int hwspin_lock_timeout_in_atomic(struct hwspinlock *hwlock, unsigned int to);
|
| 157 |
|
| 158 | Lock a previously-assigned hwspinlock with a timeout limit (specified in
|
| 159 | msecs). If the hwspinlock is already taken, the function will busy loop
|
| 160 | waiting for it to be released, but give up when the timeout elapses.
|
| 161 |
|
| 162 | This function shall be called only from an atomic context and the timeout
|
| 163 | value shall not exceed a few msecs.
|
| 164 |
|
| 165 | Returns 0 when successful and an appropriate error code otherwise (most
|
| 166 | notably -ETIMEDOUT if the hwspinlock is still busy after timeout msecs).
|
| 167 |
|
| 168 | The function will never sleep.
|
| 169 |
|
| 170 | ::
|
| 171 |
|
| 172 | int hwspin_trylock(struct hwspinlock *hwlock);
|
| 173 |
|
| 174 |
|
| 175 | Attempt to lock a previously-assigned hwspinlock, but immediately fail if
|
| 176 | it is already taken.
|
| 177 |
|
| 178 | Upon a successful return from this function, preemption is disabled so
|
| 179 | caller must not sleep, and is advised to release the hwspinlock as soon as
|
| 180 | possible, in order to minimize remote cores polling on the hardware
|
| 181 | interconnect.
|
| 182 |
|
| 183 | Returns 0 on success and an appropriate error code otherwise (most
|
| 184 | notably -EBUSY if the hwspinlock was already taken).
|
| 185 | The function will never sleep.
|
| 186 |
|
| 187 | ::
|
| 188 |
|
| 189 | int hwspin_trylock_irq(struct hwspinlock *hwlock);
|
| 190 |
|
| 191 |
|
| 192 | Attempt to lock a previously-assigned hwspinlock, but immediately fail if
|
| 193 | it is already taken.
|
| 194 |
|
| 195 | Upon a successful return from this function, preemption and the local
|
| 196 | interrupts are disabled so caller must not sleep, and is advised to
|
| 197 | release the hwspinlock as soon as possible.
|
| 198 |
|
| 199 | Returns 0 on success and an appropriate error code otherwise (most
|
| 200 | notably -EBUSY if the hwspinlock was already taken).
|
| 201 |
|
| 202 | The function will never sleep.
|
| 203 |
|
| 204 | ::
|
| 205 |
|
| 206 | int hwspin_trylock_irqsave(struct hwspinlock *hwlock, unsigned long *flags);
|
| 207 |
|
| 208 | Attempt to lock a previously-assigned hwspinlock, but immediately fail if
|
| 209 | it is already taken.
|
| 210 |
|
| 211 | Upon a successful return from this function, preemption is disabled,
|
| 212 | the local interrupts are disabled and their previous state is saved
|
| 213 | at the given flags placeholder. The caller must not sleep, and is advised
|
| 214 | to release the hwspinlock as soon as possible.
|
| 215 |
|
| 216 | Returns 0 on success and an appropriate error code otherwise (most
|
| 217 | notably -EBUSY if the hwspinlock was already taken).
|
| 218 | The function will never sleep.
|
| 219 |
|
| 220 | ::
|
| 221 |
|
| 222 | int hwspin_trylock_raw(struct hwspinlock *hwlock);
|
| 223 |
|
| 224 | Attempt to lock a previously-assigned hwspinlock, but immediately fail if
|
| 225 | it is already taken.
|
| 226 |
|
| 227 | Caution: User must protect the routine of getting hardware lock with mutex
|
| 228 | or spinlock to avoid dead-lock, that will let user can do some time-consuming
|
| 229 | or sleepable operations under the hardware lock.
|
| 230 |
|
| 231 | Returns 0 on success and an appropriate error code otherwise (most
|
| 232 | notably -EBUSY if the hwspinlock was already taken).
|
| 233 | The function will never sleep.
|
| 234 |
|
| 235 | ::
|
| 236 |
|
| 237 | int hwspin_trylock_in_atomic(struct hwspinlock *hwlock);
|
| 238 |
|
| 239 | Attempt to lock a previously-assigned hwspinlock, but immediately fail if
|
| 240 | it is already taken.
|
| 241 |
|
| 242 | This function shall be called only from an atomic context.
|
| 243 |
|
| 244 | Returns 0 on success and an appropriate error code otherwise (most
|
| 245 | notably -EBUSY if the hwspinlock was already taken).
|
| 246 | The function will never sleep.
|
| 247 |
|
| 248 | ::
|
| 249 |
|
| 250 | void hwspin_unlock(struct hwspinlock *hwlock);
|
| 251 |
|
| 252 | Unlock a previously-locked hwspinlock. Always succeed, and can be called
|
| 253 | from any context (the function never sleeps).
|
| 254 |
|
| 255 | .. note::
|
| 256 |
|
| 257 | code should **never** unlock an hwspinlock which is already unlocked
|
| 258 | (there is no protection against this).
|
| 259 |
|
| 260 | ::
|
| 261 |
|
| 262 | void hwspin_unlock_irq(struct hwspinlock *hwlock);
|
| 263 |
|
| 264 | Unlock a previously-locked hwspinlock and enable local interrupts.
|
| 265 | The caller should **never** unlock an hwspinlock which is already unlocked.
|
| 266 |
|
| 267 | Doing so is considered a bug (there is no protection against this).
|
| 268 | Upon a successful return from this function, preemption and local
|
| 269 | interrupts are enabled. This function will never sleep.
|
| 270 |
|
| 271 | ::
|
| 272 |
|
| 273 | void
|
| 274 | hwspin_unlock_irqrestore(struct hwspinlock *hwlock, unsigned long *flags);
|
| 275 |
|
| 276 | Unlock a previously-locked hwspinlock.
|
| 277 |
|
| 278 | The caller should **never** unlock an hwspinlock which is already unlocked.
|
| 279 | Doing so is considered a bug (there is no protection against this).
|
| 280 | Upon a successful return from this function, preemption is reenabled,
|
| 281 | and the state of the local interrupts is restored to the state saved at
|
| 282 | the given flags. This function will never sleep.
|
| 283 |
|
| 284 | ::
|
| 285 |
|
| 286 | void hwspin_unlock_raw(struct hwspinlock *hwlock);
|
| 287 |
|
| 288 | Unlock a previously-locked hwspinlock.
|
| 289 |
|
| 290 | The caller should **never** unlock an hwspinlock which is already unlocked.
|
| 291 | Doing so is considered a bug (there is no protection against this).
|
| 292 | This function will never sleep.
|
| 293 |
|
| 294 | ::
|
| 295 |
|
| 296 | void hwspin_unlock_in_atomic(struct hwspinlock *hwlock);
|
| 297 |
|
| 298 | Unlock a previously-locked hwspinlock.
|
| 299 |
|
| 300 | The caller should **never** unlock an hwspinlock which is already unlocked.
|
| 301 | Doing so is considered a bug (there is no protection against this).
|
| 302 | This function will never sleep.
|
| 303 |
|
| 304 | Typical usage
|
| 305 | =============
|
| 306 |
|
| 307 | ::
|
| 308 |
|
| 309 | #include <linux/hwspinlock.h>
|
| 310 | #include <linux/err.h>
|
| 311 |
|
| 312 | int hwspinlock_example(void)
|
| 313 | {
|
| 314 | struct hwspinlock *hwlock;
|
| 315 | int ret;
|
| 316 |
|
| 317 | /*
|
| 318 | * assign a specific hwspinlock id - this should be called early
|
| 319 | * by board init code.
|
| 320 | */
|
| 321 | hwlock = hwspin_lock_request_specific(PREDEFINED_LOCK_ID);
|
| 322 | if (!hwlock)
|
| 323 | ...
|
| 324 |
|
| 325 | /* try to take it, but don't spin on it */
|
| 326 | ret = hwspin_trylock(hwlock);
|
| 327 | if (!ret) {
|
| 328 | pr_info("lock is already taken\n");
|
| 329 | return -EBUSY;
|
| 330 | }
|
| 331 |
|
| 332 | /*
|
| 333 | * we took the lock, do our thing now, but do NOT sleep
|
| 334 | */
|
| 335 |
|
| 336 | /* release the lock */
|
| 337 | hwspin_unlock(hwlock);
|
| 338 |
|
| 339 | /* free the lock */
|
| 340 | ret = hwspin_lock_free(hwlock);
|
| 341 | if (ret)
|
| 342 | ...
|
| 343 |
|
| 344 | return ret;
|
| 345 | }
|
| 346 |
|
| 347 |
|
| 348 | API for implementors
|
| 349 | ====================
|
| 350 |
|
| 351 | ::
|
| 352 |
|
| 353 | int hwspin_lock_register(struct hwspinlock_device *bank, struct device *dev,
|
| 354 | const struct hwspinlock_ops *ops, int base_id, int num_locks);
|
| 355 |
|
| 356 | To be called from the underlying platform-specific implementation, in
|
| 357 | order to register a new hwspinlock device (which is usually a bank of
|
| 358 | numerous locks). Should be called from a process context (this function
|
| 359 | might sleep).
|
| 360 |
|
| 361 | Returns 0 on success, or appropriate error code on failure.
|
| 362 |
|
| 363 | ::
|
| 364 |
|
| 365 | int hwspin_lock_unregister(struct hwspinlock_device *bank);
|
| 366 |
|
| 367 | To be called from the underlying vendor-specific implementation, in order
|
| 368 | to unregister an hwspinlock device (which is usually a bank of numerous
|
| 369 | locks).
|
| 370 |
|
| 371 | Should be called from a process context (this function might sleep).
|
| 372 |
|
| 373 | Returns the address of hwspinlock on success, or NULL on error (e.g.
|
| 374 | if the hwspinlock is still in use).
|
| 375 |
|
| 376 | Important structs
|
| 377 | =================
|
| 378 |
|
| 379 | struct hwspinlock_device is a device which usually contains a bank
|
| 380 | of hardware locks. It is registered by the underlying hwspinlock
|
| 381 | implementation using the hwspin_lock_register() API.
|
| 382 |
|
| 383 | ::
|
| 384 |
|
| 385 | /**
|
| 386 | * struct hwspinlock_device - a device which usually spans numerous hwspinlocks
|
| 387 | * @dev: underlying device, will be used to invoke runtime PM api
|
| 388 | * @ops: platform-specific hwspinlock handlers
|
| 389 | * @base_id: id index of the first lock in this device
|
| 390 | * @num_locks: number of locks in this device
|
| 391 | * @lock: dynamically allocated array of 'struct hwspinlock'
|
| 392 | */
|
| 393 | struct hwspinlock_device {
|
| 394 | struct device *dev;
|
| 395 | const struct hwspinlock_ops *ops;
|
| 396 | int base_id;
|
| 397 | int num_locks;
|
| 398 | struct hwspinlock lock[0];
|
| 399 | };
|
| 400 |
|
| 401 | struct hwspinlock_device contains an array of hwspinlock structs, each
|
| 402 | of which represents a single hardware lock::
|
| 403 |
|
| 404 | /**
|
| 405 | * struct hwspinlock - this struct represents a single hwspinlock instance
|
| 406 | * @bank: the hwspinlock_device structure which owns this lock
|
| 407 | * @lock: initialized and used by hwspinlock core
|
| 408 | * @priv: private data, owned by the underlying platform-specific hwspinlock drv
|
| 409 | */
|
| 410 | struct hwspinlock {
|
| 411 | struct hwspinlock_device *bank;
|
| 412 | spinlock_t lock;
|
| 413 | void *priv;
|
| 414 | };
|
| 415 |
|
| 416 | When registering a bank of locks, the hwspinlock driver only needs to
|
| 417 | set the priv members of the locks. The rest of the members are set and
|
| 418 | initialized by the hwspinlock core itself.
|
| 419 |
|
| 420 | Implementation callbacks
|
| 421 | ========================
|
| 422 |
|
| 423 | There are three possible callbacks defined in 'struct hwspinlock_ops'::
|
| 424 |
|
| 425 | struct hwspinlock_ops {
|
| 426 | int (*trylock)(struct hwspinlock *lock);
|
| 427 | void (*unlock)(struct hwspinlock *lock);
|
| 428 | void (*relax)(struct hwspinlock *lock);
|
| 429 | };
|
| 430 |
|
| 431 | The first two callbacks are mandatory:
|
| 432 |
|
| 433 | The ->trylock() callback should make a single attempt to take the lock, and
|
| 434 | return 0 on failure and 1 on success. This callback may **not** sleep.
|
| 435 |
|
| 436 | The ->unlock() callback releases the lock. It always succeed, and it, too,
|
| 437 | may **not** sleep.
|
| 438 |
|
| 439 | The ->relax() callback is optional. It is called by hwspinlock core while
|
| 440 | spinning on a lock, and can be used by the underlying implementation to force
|
| 441 | a delay between two successive invocations of ->trylock(). It may **not** sleep.
|