Linux: Add support for the hwspinlock_user driver
[ipc/ipcdev.git] / linux / include / linux / hwspinlock_user.h
1 /*
2  * Userspace interface to hardware spinlocks
3  *
4  * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name Texas Instruments nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
33 #ifndef _UAPI_HWSPINLOCK_USER_H
34 #define _UAPI_HWSPINLOCK_USER_H
36 #include <linux/ioctl.h>
38 /**
39  * struct hwspinlock_user_lock - Sent to lock a specific hwspinlock
40  * @id:         hardware spinlock id
41  * @timeout:    timeout value in msecs
42  */
43 struct hwspinlock_user_lock {
44         int id;
45         unsigned int timeout;
46 };
48 /**
49  * struct hwspinlock_user_unlock - Sent to unlock a specific hwspinlock
50  * @id:         hardware spinlock id
51  */
52 struct hwspinlock_user_unlock {
53         int id;
54 };
56 #define HWSPINLOCK_IOC_MAGIC            'h'
58 #define HWSPINLOCK_USER_LOCK            _IOW(HWSPINLOCK_IOC_MAGIC, 0,   \
59                                              struct hwspinlock_user_lock)
60 #define HWSPINLOCK_USER_UNLOCK          _IOW(HWSPINLOCK_IOC_MAGIC, 1,   \
61                                              struct hwspinlock_user_unlock)
63 #endif  /* _UAPI_HWSPINLOCK_USER_H */