xref: /netbsd-src/sys/arch/arm/include/mutex.h (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: mutex.h,v 1.10 2008/04/28 20:23:14 martin Exp $	*/
2 
3 /*-
4  * Copyright (c) 2002, 2007 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe and Andrew Doran.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _ARM_MUTEX_H_
33 #define	_ARM_MUTEX_H_
34 
35 /*
36  * The ARM mutex implementation is troublesome, because pre-v6 ARM lacks a
37  * compare-and-swap operation.  However, there aren't any MP pre-v6 ARM
38  * systems to speak of.  We are mostly concerned with atomicity with respect
39  * to interrupts.
40  *
41  * ARMv6, however, does have ldrex/strex, and can thus implement an MP-safe
42  * compare-and-swap.
43  *
44  * So, what we have done is impement simple mutexes using a compare-and-swap.
45  * We support pre-ARMv6 by implementing CAS as a restartable atomic sequence
46  * that is checked by the IRQ vector.  MP-safe ARMv6 support will be added later.
47  */
48 
49 #ifndef __MUTEX_PRIVATE
50 
51 struct kmutex {
52 	uintptr_t	mtx_pad1;
53 };
54 
55 #else	/* __MUTEX_PRIVATE */
56 
57 struct kmutex {
58 	union {
59 		/* Adaptive mutex */
60 		volatile uintptr_t	mtxa_owner;	/* 0-3 */
61 
62 		/* Spin mutex */
63 		struct {
64 			volatile uint8_t	mtxs_dummy;
65 			ipl_cookie_t		mtxs_ipl;
66 			__cpu_simple_lock_t	mtxs_lock;
67 			volatile uint8_t	mtxs_unused;
68 		} s;
69 	} u;
70 };
71 
72 #define	mtx_owner		u.mtxa_owner
73 #define	mtx_ipl			u.s.mtxs_ipl
74 #define	mtx_lock		u.s.mtxs_lock
75 
76 #if 0
77 #define	__HAVE_MUTEX_STUBS		1
78 #define	__HAVE_SPIN_MUTEX_STUBS		1
79 #endif
80 #define	__HAVE_SIMPLE_MUTEXES		1
81 
82 /*
83  * MUTEX_RECEIVE: no memory barrier required; we're synchronizing against
84  * interrupts, not multiple processors.
85  */
86 #define	MUTEX_RECEIVE(mtx)		/* nothing */
87 
88 /*
89  * MUTEX_GIVE: no memory barrier required; same reason.
90  */
91 #define	MUTEX_GIVE(mtx)			/* nothing */
92 
93 unsigned long	_lock_cas(volatile unsigned long *,
94     unsigned long, unsigned long);
95 
96 #define	MUTEX_CAS(p, o, n)		\
97     (_lock_cas((volatile unsigned long *)(p), (o), (n)) == (o))
98 
99 #endif	/* __MUTEX_PRIVATE */
100 
101 #endif /* _ARM_MUTEX_H_ */
102