xref: /openbmc/u-boot/arch/x86/include/asm/bitops.h (revision 8abebe3eadb35222a1147078da4010b4cbfe5858)
1fea25720SGraeme Russ #ifndef _I386_BITOPS_H
2fea25720SGraeme Russ #define _I386_BITOPS_H
3fea25720SGraeme Russ 
4fea25720SGraeme Russ /*
5fea25720SGraeme Russ  * Copyright 1992, Linus Torvalds.
6fea25720SGraeme Russ  */
7fea25720SGraeme Russ 
8fea25720SGraeme Russ 
9fea25720SGraeme Russ /*
10fea25720SGraeme Russ  * These have to be done with inline assembly: that way the bit-setting
11fea25720SGraeme Russ  * is guaranteed to be atomic. All bit operations return 0 if the bit
12fea25720SGraeme Russ  * was cleared before the operation and != 0 if it was not.
13fea25720SGraeme Russ  *
14fea25720SGraeme Russ  * bit 0 is the LSB of addr; bit 32 is the LSB of (addr+1).
15fea25720SGraeme Russ  */
16fea25720SGraeme Russ 
17fea25720SGraeme Russ #ifdef CONFIG_SMP
18fea25720SGraeme Russ #define LOCK_PREFIX "lock ; "
19fea25720SGraeme Russ #else
20fea25720SGraeme Russ #define LOCK_PREFIX ""
21fea25720SGraeme Russ #endif
22fea25720SGraeme Russ 
23fea25720SGraeme Russ #define ADDR (*(volatile long *) addr)
24fea25720SGraeme Russ 
25fea25720SGraeme Russ /**
26fea25720SGraeme Russ  * set_bit - Atomically set a bit in memory
27fea25720SGraeme Russ  * @nr: the bit to set
28fea25720SGraeme Russ  * @addr: the address to start counting from
29fea25720SGraeme Russ  *
30fea25720SGraeme Russ  * This function is atomic and may not be reordered.  See __set_bit()
31fea25720SGraeme Russ  * if you do not require the atomic guarantees.
32fea25720SGraeme Russ  * Note that @nr may be almost arbitrarily large; this function is not
33fea25720SGraeme Russ  * restricted to acting on a single-word quantity.
34fea25720SGraeme Russ  */
35fea25720SGraeme Russ static __inline__ void set_bit(int nr, volatile void * addr)
36fea25720SGraeme Russ {
37fea25720SGraeme Russ 	__asm__ __volatile__( LOCK_PREFIX
38fea25720SGraeme Russ 		"btsl %1,%0"
39fea25720SGraeme Russ 		:"=m" (ADDR)
40fea25720SGraeme Russ 		:"Ir" (nr));
41fea25720SGraeme Russ }
42fea25720SGraeme Russ 
43fea25720SGraeme Russ /**
44fea25720SGraeme Russ  * __set_bit - Set a bit in memory
45fea25720SGraeme Russ  * @nr: the bit to set
46fea25720SGraeme Russ  * @addr: the address to start counting from
47fea25720SGraeme Russ  *
48fea25720SGraeme Russ  * Unlike set_bit(), this function is non-atomic and may be reordered.
49fea25720SGraeme Russ  * If it's called on the same region of memory simultaneously, the effect
50fea25720SGraeme Russ  * may be that only one operation succeeds.
51fea25720SGraeme Russ  */
52fea25720SGraeme Russ static __inline__ void __set_bit(int nr, volatile void * addr)
53fea25720SGraeme Russ {
54fea25720SGraeme Russ 	__asm__(
55fea25720SGraeme Russ 		"btsl %1,%0"
56fea25720SGraeme Russ 		:"=m" (ADDR)
57fea25720SGraeme Russ 		:"Ir" (nr));
58fea25720SGraeme Russ }
59fea25720SGraeme Russ 
60fea25720SGraeme Russ /**
61fea25720SGraeme Russ  * clear_bit - Clears a bit in memory
62fea25720SGraeme Russ  * @nr: Bit to clear
63fea25720SGraeme Russ  * @addr: Address to start counting from
64fea25720SGraeme Russ  *
65fea25720SGraeme Russ  * clear_bit() is atomic and may not be reordered.  However, it does
66fea25720SGraeme Russ  * not contain a memory barrier, so if it is used for locking purposes,
67fea25720SGraeme Russ  * you should call smp_mb__before_clear_bit() and/or smp_mb__after_clear_bit()
68fea25720SGraeme Russ  * in order to ensure changes are visible on other processors.
69fea25720SGraeme Russ  */
70fea25720SGraeme Russ static __inline__ void clear_bit(int nr, volatile void * addr)
71fea25720SGraeme Russ {
72fea25720SGraeme Russ 	__asm__ __volatile__( LOCK_PREFIX
73fea25720SGraeme Russ 		"btrl %1,%0"
74fea25720SGraeme Russ 		:"=m" (ADDR)
75fea25720SGraeme Russ 		:"Ir" (nr));
76fea25720SGraeme Russ }
77fea25720SGraeme Russ #define smp_mb__before_clear_bit()	barrier()
78fea25720SGraeme Russ #define smp_mb__after_clear_bit()	barrier()
79fea25720SGraeme Russ 
80fea25720SGraeme Russ /**
81fea25720SGraeme Russ  * __change_bit - Toggle a bit in memory
82fea25720SGraeme Russ  * @nr: the bit to set
83fea25720SGraeme Russ  * @addr: the address to start counting from
84fea25720SGraeme Russ  *
85fea25720SGraeme Russ  * Unlike change_bit(), this function is non-atomic and may be reordered.
86fea25720SGraeme Russ  * If it's called on the same region of memory simultaneously, the effect
87fea25720SGraeme Russ  * may be that only one operation succeeds.
88fea25720SGraeme Russ  */
89fea25720SGraeme Russ static __inline__ void __change_bit(int nr, volatile void * addr)
90fea25720SGraeme Russ {
91fea25720SGraeme Russ 	__asm__ __volatile__(
92fea25720SGraeme Russ 		"btcl %1,%0"
93fea25720SGraeme Russ 		:"=m" (ADDR)
94fea25720SGraeme Russ 		:"Ir" (nr));
95fea25720SGraeme Russ }
96fea25720SGraeme Russ 
97fea25720SGraeme Russ /**
98fea25720SGraeme Russ  * change_bit - Toggle a bit in memory
99fea25720SGraeme Russ  * @nr: Bit to clear
100fea25720SGraeme Russ  * @addr: Address to start counting from
101fea25720SGraeme Russ  *
102fea25720SGraeme Russ  * change_bit() is atomic and may not be reordered.
103fea25720SGraeme Russ  * Note that @nr may be almost arbitrarily large; this function is not
104fea25720SGraeme Russ  * restricted to acting on a single-word quantity.
105fea25720SGraeme Russ  */
106fea25720SGraeme Russ static __inline__ void change_bit(int nr, volatile void * addr)
107fea25720SGraeme Russ {
108fea25720SGraeme Russ 	__asm__ __volatile__( LOCK_PREFIX
109fea25720SGraeme Russ 		"btcl %1,%0"
110fea25720SGraeme Russ 		:"=m" (ADDR)
111fea25720SGraeme Russ 		:"Ir" (nr));
112fea25720SGraeme Russ }
113fea25720SGraeme Russ 
114fea25720SGraeme Russ /**
115fea25720SGraeme Russ  * test_and_set_bit - Set a bit and return its old value
116fea25720SGraeme Russ  * @nr: Bit to set
117fea25720SGraeme Russ  * @addr: Address to count from
118fea25720SGraeme Russ  *
119fea25720SGraeme Russ  * This operation is atomic and cannot be reordered.
120fea25720SGraeme Russ  * It also implies a memory barrier.
121fea25720SGraeme Russ  */
122fea25720SGraeme Russ static __inline__ int test_and_set_bit(int nr, volatile void * addr)
123fea25720SGraeme Russ {
124fea25720SGraeme Russ 	int oldbit;
125fea25720SGraeme Russ 
126fea25720SGraeme Russ 	__asm__ __volatile__( LOCK_PREFIX
127fea25720SGraeme Russ 		"btsl %2,%1\n\tsbbl %0,%0"
128fea25720SGraeme Russ 		:"=r" (oldbit),"=m" (ADDR)
129fea25720SGraeme Russ 		:"Ir" (nr) : "memory");
130fea25720SGraeme Russ 	return oldbit;
131fea25720SGraeme Russ }
132fea25720SGraeme Russ 
133fea25720SGraeme Russ /**
134fea25720SGraeme Russ  * __test_and_set_bit - Set a bit and return its old value
135fea25720SGraeme Russ  * @nr: Bit to set
136fea25720SGraeme Russ  * @addr: Address to count from
137fea25720SGraeme Russ  *
138fea25720SGraeme Russ  * This operation is non-atomic and can be reordered.
139fea25720SGraeme Russ  * If two examples of this operation race, one can appear to succeed
140fea25720SGraeme Russ  * but actually fail.  You must protect multiple accesses with a lock.
141fea25720SGraeme Russ  */
142fea25720SGraeme Russ static __inline__ int __test_and_set_bit(int nr, volatile void * addr)
143fea25720SGraeme Russ {
144fea25720SGraeme Russ 	int oldbit;
145fea25720SGraeme Russ 
146fea25720SGraeme Russ 	__asm__(
147fea25720SGraeme Russ 		"btsl %2,%1\n\tsbbl %0,%0"
148fea25720SGraeme Russ 		:"=r" (oldbit),"=m" (ADDR)
149fea25720SGraeme Russ 		:"Ir" (nr));
150fea25720SGraeme Russ 	return oldbit;
151fea25720SGraeme Russ }
152fea25720SGraeme Russ 
153fea25720SGraeme Russ /**
154fea25720SGraeme Russ  * test_and_clear_bit - Clear a bit and return its old value
155fea25720SGraeme Russ  * @nr: Bit to set
156fea25720SGraeme Russ  * @addr: Address to count from
157fea25720SGraeme Russ  *
158fea25720SGraeme Russ  * This operation is atomic and cannot be reordered.
159fea25720SGraeme Russ  * It also implies a memory barrier.
160fea25720SGraeme Russ  */
161fea25720SGraeme Russ static __inline__ int test_and_clear_bit(int nr, volatile void * addr)
162fea25720SGraeme Russ {
163fea25720SGraeme Russ 	int oldbit;
164fea25720SGraeme Russ 
165fea25720SGraeme Russ 	__asm__ __volatile__( LOCK_PREFIX
166fea25720SGraeme Russ 		"btrl %2,%1\n\tsbbl %0,%0"
167fea25720SGraeme Russ 		:"=r" (oldbit),"=m" (ADDR)
168fea25720SGraeme Russ 		:"Ir" (nr) : "memory");
169fea25720SGraeme Russ 	return oldbit;
170fea25720SGraeme Russ }
171fea25720SGraeme Russ 
172fea25720SGraeme Russ /**
173fea25720SGraeme Russ  * __test_and_clear_bit - Clear a bit and return its old value
174fea25720SGraeme Russ  * @nr: Bit to set
175fea25720SGraeme Russ  * @addr: Address to count from
176fea25720SGraeme Russ  *
177fea25720SGraeme Russ  * This operation is non-atomic and can be reordered.
178fea25720SGraeme Russ  * If two examples of this operation race, one can appear to succeed
179fea25720SGraeme Russ  * but actually fail.  You must protect multiple accesses with a lock.
180fea25720SGraeme Russ  */
181fea25720SGraeme Russ static __inline__ int __test_and_clear_bit(int nr, volatile void * addr)
182fea25720SGraeme Russ {
183fea25720SGraeme Russ 	int oldbit;
184fea25720SGraeme Russ 
185fea25720SGraeme Russ 	__asm__(
186fea25720SGraeme Russ 		"btrl %2,%1\n\tsbbl %0,%0"
187fea25720SGraeme Russ 		:"=r" (oldbit),"=m" (ADDR)
188fea25720SGraeme Russ 		:"Ir" (nr));
189fea25720SGraeme Russ 	return oldbit;
190fea25720SGraeme Russ }
191fea25720SGraeme Russ 
192fea25720SGraeme Russ /* WARNING: non atomic and it can be reordered! */
193fea25720SGraeme Russ static __inline__ int __test_and_change_bit(int nr, volatile void * addr)
194fea25720SGraeme Russ {
195fea25720SGraeme Russ 	int oldbit;
196fea25720SGraeme Russ 
197fea25720SGraeme Russ 	__asm__ __volatile__(
198fea25720SGraeme Russ 		"btcl %2,%1\n\tsbbl %0,%0"
199fea25720SGraeme Russ 		:"=r" (oldbit),"=m" (ADDR)
200fea25720SGraeme Russ 		:"Ir" (nr) : "memory");
201fea25720SGraeme Russ 	return oldbit;
202fea25720SGraeme Russ }
203fea25720SGraeme Russ 
204fea25720SGraeme Russ /**
205fea25720SGraeme Russ  * test_and_change_bit - Change a bit and return its new value
206fea25720SGraeme Russ  * @nr: Bit to set
207fea25720SGraeme Russ  * @addr: Address to count from
208fea25720SGraeme Russ  *
209fea25720SGraeme Russ  * This operation is atomic and cannot be reordered.
210fea25720SGraeme Russ  * It also implies a memory barrier.
211fea25720SGraeme Russ  */
212fea25720SGraeme Russ static __inline__ int test_and_change_bit(int nr, volatile void * addr)
213fea25720SGraeme Russ {
214fea25720SGraeme Russ 	int oldbit;
215fea25720SGraeme Russ 
216fea25720SGraeme Russ 	__asm__ __volatile__( LOCK_PREFIX
217fea25720SGraeme Russ 		"btcl %2,%1\n\tsbbl %0,%0"
218fea25720SGraeme Russ 		:"=r" (oldbit),"=m" (ADDR)
219fea25720SGraeme Russ 		:"Ir" (nr) : "memory");
220fea25720SGraeme Russ 	return oldbit;
221fea25720SGraeme Russ }
222fea25720SGraeme Russ 
223fea25720SGraeme Russ #if 0 /* Fool kernel-doc since it doesn't do macros yet */
224fea25720SGraeme Russ /**
225fea25720SGraeme Russ  * test_bit - Determine whether a bit is set
226fea25720SGraeme Russ  * @nr: bit number to test
227fea25720SGraeme Russ  * @addr: Address to start counting from
228fea25720SGraeme Russ  */
229fea25720SGraeme Russ static int test_bit(int nr, const volatile void * addr);
230fea25720SGraeme Russ #endif
231fea25720SGraeme Russ 
232fea25720SGraeme Russ static __inline__ int constant_test_bit(int nr, const volatile void * addr)
233fea25720SGraeme Russ {
234fea25720SGraeme Russ 	return ((1UL << (nr & 31)) & (((const volatile unsigned int *) addr)[nr >> 5])) != 0;
235fea25720SGraeme Russ }
236fea25720SGraeme Russ 
237fea25720SGraeme Russ static __inline__ int variable_test_bit(int nr, volatile void * addr)
238fea25720SGraeme Russ {
239fea25720SGraeme Russ 	int oldbit;
240fea25720SGraeme Russ 
241fea25720SGraeme Russ 	__asm__ __volatile__(
242fea25720SGraeme Russ 		"btl %2,%1\n\tsbbl %0,%0"
243fea25720SGraeme Russ 		:"=r" (oldbit)
244fea25720SGraeme Russ 		:"m" (ADDR),"Ir" (nr));
245fea25720SGraeme Russ 	return oldbit;
246fea25720SGraeme Russ }
247fea25720SGraeme Russ 
248fea25720SGraeme Russ #define test_bit(nr,addr) \
249fea25720SGraeme Russ (__builtin_constant_p(nr) ? \
250fea25720SGraeme Russ  constant_test_bit((nr),(addr)) : \
251fea25720SGraeme Russ  variable_test_bit((nr),(addr)))
252fea25720SGraeme Russ 
253fea25720SGraeme Russ /**
254fea25720SGraeme Russ  * find_first_zero_bit - find the first zero bit in a memory region
255fea25720SGraeme Russ  * @addr: The address to start the search at
256fea25720SGraeme Russ  * @size: The maximum size to search
257fea25720SGraeme Russ  *
258fea25720SGraeme Russ  * Returns the bit-number of the first zero bit, not the number of the byte
259fea25720SGraeme Russ  * containing a bit.
260fea25720SGraeme Russ  */
261fea25720SGraeme Russ static __inline__ int find_first_zero_bit(void * addr, unsigned size)
262fea25720SGraeme Russ {
263fea25720SGraeme Russ 	int d0, d1, d2;
264fea25720SGraeme Russ 	int res;
265fea25720SGraeme Russ 
266fea25720SGraeme Russ 	if (!size)
267fea25720SGraeme Russ 		return 0;
268fea25720SGraeme Russ 	/* This looks at memory. Mark it volatile to tell gcc not to move it around */
269fea25720SGraeme Russ 	__asm__ __volatile__(
270fea25720SGraeme Russ 		"movl $-1,%%eax\n\t"
271fea25720SGraeme Russ 		"xorl %%edx,%%edx\n\t"
272fea25720SGraeme Russ 		"repe; scasl\n\t"
273fea25720SGraeme Russ 		"je 1f\n\t"
274fea25720SGraeme Russ 		"xorl -4(%%edi),%%eax\n\t"
275fea25720SGraeme Russ 		"subl $4,%%edi\n\t"
276fea25720SGraeme Russ 		"bsfl %%eax,%%edx\n"
277fea25720SGraeme Russ 		"1:\tsubl %%ebx,%%edi\n\t"
278fea25720SGraeme Russ 		"shll $3,%%edi\n\t"
279fea25720SGraeme Russ 		"addl %%edi,%%edx"
280fea25720SGraeme Russ 		:"=d" (res), "=&c" (d0), "=&D" (d1), "=&a" (d2)
281fea25720SGraeme Russ 		:"1" ((size + 31) >> 5), "2" (addr), "b" (addr));
282fea25720SGraeme Russ 	return res;
283fea25720SGraeme Russ }
284fea25720SGraeme Russ 
285fea25720SGraeme Russ /**
286fea25720SGraeme Russ  * find_next_zero_bit - find the first zero bit in a memory region
287fea25720SGraeme Russ  * @addr: The address to base the search on
288fea25720SGraeme Russ  * @offset: The bitnumber to start searching at
289fea25720SGraeme Russ  * @size: The maximum size to search
290fea25720SGraeme Russ  */
291fea25720SGraeme Russ static __inline__ int find_next_zero_bit (void * addr, int size, int offset)
292fea25720SGraeme Russ {
293fea25720SGraeme Russ 	unsigned long * p = ((unsigned long *) addr) + (offset >> 5);
294fea25720SGraeme Russ 	int set = 0, bit = offset & 31, res;
295fea25720SGraeme Russ 
296fea25720SGraeme Russ 	if (bit) {
297fea25720SGraeme Russ 		/*
298fea25720SGraeme Russ 		 * Look for zero in first byte
299fea25720SGraeme Russ 		 */
300fea25720SGraeme Russ 		__asm__("bsfl %1,%0\n\t"
301fea25720SGraeme Russ 			"jne 1f\n\t"
302fea25720SGraeme Russ 			"movl $32, %0\n"
303fea25720SGraeme Russ 			"1:"
304fea25720SGraeme Russ 			: "=r" (set)
305fea25720SGraeme Russ 			: "r" (~(*p >> bit)));
306fea25720SGraeme Russ 		if (set < (32 - bit))
307fea25720SGraeme Russ 			return set + offset;
308fea25720SGraeme Russ 		set = 32 - bit;
309fea25720SGraeme Russ 		p++;
310fea25720SGraeme Russ 	}
311fea25720SGraeme Russ 	/*
312fea25720SGraeme Russ 	 * No zero yet, search remaining full bytes for a zero
313fea25720SGraeme Russ 	 */
314fea25720SGraeme Russ 	res = find_first_zero_bit (p, size - 32 * (p - (unsigned long *) addr));
315fea25720SGraeme Russ 	return (offset + set + res);
316fea25720SGraeme Russ }
317fea25720SGraeme Russ 
318fea25720SGraeme Russ /**
319fea25720SGraeme Russ  * ffz - find first zero in word.
320fea25720SGraeme Russ  * @word: The word to search
321fea25720SGraeme Russ  *
322fea25720SGraeme Russ  * Undefined if no zero exists, so code should check against ~0UL first.
323fea25720SGraeme Russ  */
324fea25720SGraeme Russ static __inline__ unsigned long ffz(unsigned long word)
325fea25720SGraeme Russ {
326fea25720SGraeme Russ 	__asm__("bsfl %1,%0"
327fea25720SGraeme Russ 		:"=r" (word)
328fea25720SGraeme Russ 		:"r" (~word));
329fea25720SGraeme Russ 	return word;
330fea25720SGraeme Russ }
331fea25720SGraeme Russ 
332fea25720SGraeme Russ #ifdef __KERNEL__
333fea25720SGraeme Russ 
334fea25720SGraeme Russ /**
335fea25720SGraeme Russ  * ffs - find first bit set
336fea25720SGraeme Russ  * @x: the word to search
337fea25720SGraeme Russ  *
338fea25720SGraeme Russ  * This is defined the same way as
339fea25720SGraeme Russ  * the libc and compiler builtin ffs routines, therefore
340fea25720SGraeme Russ  * differs in spirit from the above ffz (man ffs).
341fea25720SGraeme Russ  */
342fea25720SGraeme Russ static __inline__ int ffs(int x)
343fea25720SGraeme Russ {
344fea25720SGraeme Russ 	int r;
345fea25720SGraeme Russ 
346fea25720SGraeme Russ 	__asm__("bsfl %1,%0\n\t"
347fea25720SGraeme Russ 		"jnz 1f\n\t"
348fea25720SGraeme Russ 		"movl $-1,%0\n"
349fea25720SGraeme Russ 		"1:" : "=r" (r) : "g" (x));
350fea25720SGraeme Russ 	return r+1;
351fea25720SGraeme Russ }
352fea25720SGraeme Russ #define PLATFORM_FFS
353fea25720SGraeme Russ 
354*8abebe3eSGraeme Russ static inline int __ilog2(unsigned int x)
355*8abebe3eSGraeme Russ {
356*8abebe3eSGraeme Russ 	return generic_fls(x) - 1;
357*8abebe3eSGraeme Russ }
358*8abebe3eSGraeme Russ 
359fea25720SGraeme Russ /**
360fea25720SGraeme Russ  * hweightN - returns the hamming weight of a N-bit word
361fea25720SGraeme Russ  * @x: the word to weigh
362fea25720SGraeme Russ  *
363fea25720SGraeme Russ  * The Hamming Weight of a number is the total number of bits set in it.
364fea25720SGraeme Russ  */
365fea25720SGraeme Russ 
366fea25720SGraeme Russ #define hweight32(x) generic_hweight32(x)
367fea25720SGraeme Russ #define hweight16(x) generic_hweight16(x)
368fea25720SGraeme Russ #define hweight8(x) generic_hweight8(x)
369fea25720SGraeme Russ 
370fea25720SGraeme Russ #endif /* __KERNEL__ */
371fea25720SGraeme Russ 
372fea25720SGraeme Russ #ifdef __KERNEL__
373fea25720SGraeme Russ 
374fea25720SGraeme Russ #define ext2_set_bit                 __test_and_set_bit
375fea25720SGraeme Russ #define ext2_clear_bit               __test_and_clear_bit
376fea25720SGraeme Russ #define ext2_test_bit                test_bit
377fea25720SGraeme Russ #define ext2_find_first_zero_bit     find_first_zero_bit
378fea25720SGraeme Russ #define ext2_find_next_zero_bit      find_next_zero_bit
379fea25720SGraeme Russ 
380fea25720SGraeme Russ /* Bitmap functions for the minix filesystem.  */
381fea25720SGraeme Russ #define minix_test_and_set_bit(nr,addr) __test_and_set_bit(nr,addr)
382fea25720SGraeme Russ #define minix_set_bit(nr,addr) __set_bit(nr,addr)
383fea25720SGraeme Russ #define minix_test_and_clear_bit(nr,addr) __test_and_clear_bit(nr,addr)
384fea25720SGraeme Russ #define minix_test_bit(nr,addr) test_bit(nr,addr)
385fea25720SGraeme Russ #define minix_find_first_zero_bit(addr,size) find_first_zero_bit(addr,size)
386fea25720SGraeme Russ 
387fea25720SGraeme Russ #endif /* __KERNEL__ */
388fea25720SGraeme Russ 
389fea25720SGraeme Russ #endif /* _I386_BITOPS_H */
390