1/*
2 * Copyright (C) 2004, 2007-2010, 2011-2012 Synopsys, Inc. (www.synopsys.com)
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 */
8
9#ifndef _ASM_BITOPS_H
10#define _ASM_BITOPS_H
11
12#ifndef _LINUX_BITOPS_H
13#error only <linux/bitops.h> can be included directly
14#endif
15
16#ifndef __ASSEMBLY__
17
18#include <linux/types.h>
19#include <linux/compiler.h>
20#include <asm/barrier.h>
21#ifndef CONFIG_ARC_HAS_LLSC
22#include <asm/smp.h>
23#endif
24
25#if defined(CONFIG_ARC_HAS_LLSC)
26
27/*
28 * Hardware assisted Atomic-R-M-W
29 */
30
31#define BIT_OP(op, c_op, asm_op)					\
32static inline void op##_bit(unsigned long nr, volatile unsigned long *m)\
33{									\
34	unsigned int temp;						\
35									\
36	m += nr >> 5;							\
37									\
38	/*								\
39	 * ARC ISA micro-optimization:					\
40	 *								\
41	 * Instructions dealing with bitpos only consider lower 5 bits	\
42	 * e.g (x << 33) is handled like (x << 1) by ASL instruction	\
43	 *  (mem pointer still needs adjustment to point to next word)	\
44	 *								\
45	 * Hence the masking to clamp @nr arg can be elided in general.	\
46	 *								\
47	 * However if @nr is a constant (above assumed in a register),	\
48	 * and greater than 31, gcc can optimize away (x << 33) to 0,	\
49	 * as overflow, given the 32-bit ISA. Thus masking needs to be	\
50	 * done for const @nr, but no code is generated due to gcc	\
51	 * const prop.							\
52	 */								\
53	nr &= 0x1f;							\
54									\
55	__asm__ __volatile__(						\
56	"1:	llock       %0, [%1]		\n"			\
57	"	" #asm_op " %0, %0, %2	\n"				\
58	"	scond       %0, [%1]		\n"			\
59	"	bnz         1b			\n"			\
60	: "=&r"(temp)	/* Early clobber, to prevent reg reuse */	\
61	: "r"(m),	/* Not "m": llock only supports reg direct addr mode */	\
62	  "ir"(nr)							\
63	: "cc");							\
64}
65
66/*
67 * Semantically:
68 *    Test the bit
69 *    if clear
70 *        set it and return 0 (old value)
71 *    else
72 *        return 1 (old value).
73 *
74 * Since ARC lacks a equivalent h/w primitive, the bit is set unconditionally
75 * and the old value of bit is returned
76 */
77#define TEST_N_BIT_OP(op, c_op, asm_op)					\
78static inline int test_and_##op##_bit(unsigned long nr, volatile unsigned long *m)\
79{									\
80	unsigned long old, temp;					\
81									\
82	m += nr >> 5;							\
83									\
84	nr &= 0x1f;							\
85									\
86	/*								\
87	 * Explicit full memory barrier needed before/after as		\
88	 * LLOCK/SCOND themselves don't provide any such smenatic	\
89	 */								\
90	smp_mb();							\
91									\
92	__asm__ __volatile__(						\
93	"1:	llock       %0, [%2]	\n"				\
94	"	" #asm_op " %1, %0, %3	\n"				\
95	"	scond       %1, [%2]	\n"				\
96	"	bnz         1b		\n"				\
97	: "=&r"(old), "=&r"(temp)					\
98	: "r"(m), "ir"(nr)						\
99	: "cc");							\
100									\
101	smp_mb();							\
102									\
103	return (old & (1 << nr)) != 0;					\
104}
105
106#else	/* !CONFIG_ARC_HAS_LLSC */
107
108/*
109 * Non hardware assisted Atomic-R-M-W
110 * Locking would change to irq-disabling only (UP) and spinlocks (SMP)
111 *
112 * There's "significant" micro-optimization in writing our own variants of
113 * bitops (over generic variants)
114 *
115 * (1) The generic APIs have "signed" @nr while we have it "unsigned"
116 *     This avoids extra code to be generated for pointer arithmatic, since
117 *     is "not sure" that index is NOT -ve
118 * (2) Utilize the fact that ARCompact bit fidding insn (BSET/BCLR/ASL) etc
119 *     only consider bottom 5 bits of @nr, so NO need to mask them off.
120 *     (GCC Quirk: however for constant @nr we still need to do the masking
121 *             at compile time)
122 */
123
124#define BIT_OP(op, c_op, asm_op)					\
125static inline void op##_bit(unsigned long nr, volatile unsigned long *m)\
126{									\
127	unsigned long temp, flags;					\
128	m += nr >> 5;							\
129									\
130	/*								\
131	 * spin lock/unlock provide the needed smp_mb() before/after	\
132	 */								\
133	bitops_lock(flags);						\
134									\
135	temp = *m;							\
136	*m = temp c_op (1UL << (nr & 0x1f));					\
137									\
138	bitops_unlock(flags);						\
139}
140
141#define TEST_N_BIT_OP(op, c_op, asm_op)					\
142static inline int test_and_##op##_bit(unsigned long nr, volatile unsigned long *m)\
143{									\
144	unsigned long old, flags;					\
145	m += nr >> 5;							\
146									\
147	bitops_lock(flags);						\
148									\
149	old = *m;							\
150	*m = old c_op (1UL << (nr & 0x1f));				\
151									\
152	bitops_unlock(flags);						\
153									\
154	return (old & (1UL << (nr & 0x1f))) != 0;			\
155}
156
157#endif /* CONFIG_ARC_HAS_LLSC */
158
159/***************************************
160 * Non atomic variants
161 **************************************/
162
163#define __BIT_OP(op, c_op, asm_op)					\
164static inline void __##op##_bit(unsigned long nr, volatile unsigned long *m)	\
165{									\
166	unsigned long temp;						\
167	m += nr >> 5;							\
168									\
169	temp = *m;							\
170	*m = temp c_op (1UL << (nr & 0x1f));				\
171}
172
173#define __TEST_N_BIT_OP(op, c_op, asm_op)				\
174static inline int __test_and_##op##_bit(unsigned long nr, volatile unsigned long *m)\
175{									\
176	unsigned long old;						\
177	m += nr >> 5;							\
178									\
179	old = *m;							\
180	*m = old c_op (1UL << (nr & 0x1f));				\
181									\
182	return (old & (1UL << (nr & 0x1f))) != 0;			\
183}
184
185#define BIT_OPS(op, c_op, asm_op)					\
186									\
187	/* set_bit(), clear_bit(), change_bit() */			\
188	BIT_OP(op, c_op, asm_op)					\
189									\
190	/* test_and_set_bit(), test_and_clear_bit(), test_and_change_bit() */\
191	TEST_N_BIT_OP(op, c_op, asm_op)					\
192									\
193	/* __set_bit(), __clear_bit(), __change_bit() */		\
194	__BIT_OP(op, c_op, asm_op)					\
195									\
196	/* __test_and_set_bit(), __test_and_clear_bit(), __test_and_change_bit() */\
197	__TEST_N_BIT_OP(op, c_op, asm_op)
198
199BIT_OPS(set, |, bset)
200BIT_OPS(clear, & ~, bclr)
201BIT_OPS(change, ^, bxor)
202
203/*
204 * This routine doesn't need to be atomic.
205 */
206static inline int
207test_bit(unsigned int nr, const volatile unsigned long *addr)
208{
209	unsigned long mask;
210
211	addr += nr >> 5;
212
213	mask = 1UL << (nr & 0x1f);
214
215	return ((mask & *addr) != 0);
216}
217
218/*
219 * Count the number of zeros, starting from MSB
220 * Helper for fls( ) friends
221 * This is a pure count, so (1-32) or (0-31) doesn't apply
222 * It could be 0 to 32, based on num of 0's in there
223 * clz(0x8000_0000) = 0, clz(0xFFFF_FFFF)=0, clz(0) = 32, clz(1) = 31
224 */
225static inline __attribute__ ((const)) int clz(unsigned int x)
226{
227	unsigned int res;
228
229	__asm__ __volatile__(
230	"	norm.f  %0, %1		\n"
231	"	mov.n   %0, 0		\n"
232	"	add.p   %0, %0, 1	\n"
233	: "=r"(res)
234	: "r"(x)
235	: "cc");
236
237	return res;
238}
239
240static inline int constant_fls(int x)
241{
242	int r = 32;
243
244	if (!x)
245		return 0;
246	if (!(x & 0xffff0000u)) {
247		x <<= 16;
248		r -= 16;
249	}
250	if (!(x & 0xff000000u)) {
251		x <<= 8;
252		r -= 8;
253	}
254	if (!(x & 0xf0000000u)) {
255		x <<= 4;
256		r -= 4;
257	}
258	if (!(x & 0xc0000000u)) {
259		x <<= 2;
260		r -= 2;
261	}
262	if (!(x & 0x80000000u)) {
263		x <<= 1;
264		r -= 1;
265	}
266	return r;
267}
268
269/*
270 * fls = Find Last Set in word
271 * @result: [1-32]
272 * fls(1) = 1, fls(0x80000000) = 32, fls(0) = 0
273 */
274static inline __attribute__ ((const)) int fls(unsigned long x)
275{
276	if (__builtin_constant_p(x))
277	       return constant_fls(x);
278
279	return 32 - clz(x);
280}
281
282/*
283 * __fls: Similar to fls, but zero based (0-31)
284 */
285static inline __attribute__ ((const)) int __fls(unsigned long x)
286{
287	if (!x)
288		return 0;
289	else
290		return fls(x) - 1;
291}
292
293/*
294 * ffs = Find First Set in word (LSB to MSB)
295 * @result: [1-32], 0 if all 0's
296 */
297#define ffs(x)	({ unsigned long __t = (x); fls(__t & -__t); })
298
299/*
300 * __ffs: Similar to ffs, but zero based (0-31)
301 */
302static inline __attribute__ ((const)) int __ffs(unsigned long word)
303{
304	if (!word)
305		return word;
306
307	return ffs(word) - 1;
308}
309
310/*
311 * ffz = Find First Zero in word.
312 * @return:[0-31], 32 if all 1's
313 */
314#define ffz(x)	__ffs(~(x))
315
316#include <asm-generic/bitops/hweight.h>
317#include <asm-generic/bitops/fls64.h>
318#include <asm-generic/bitops/sched.h>
319#include <asm-generic/bitops/lock.h>
320
321#include <asm-generic/bitops/find.h>
322#include <asm-generic/bitops/le.h>
323#include <asm-generic/bitops/ext2-atomic-setbit.h>
324
325#endif /* !__ASSEMBLY__ */
326
327#endif
328