xref: /freebsd/sys/dev/bwn/if_bwn_util.h (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1 /*-
2  * Copyright (c) 2016 Adrian Chadd <adrian@FreeBSD.org>.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  */
29 #ifndef	__IF_BWN_UTIL_H__
30 #define	__IF_BWN_UTIL_H__
31 
32 /* Hamming weight; used in the PHY routines */
33 static inline int
34 bwn_hweight32(uint32_t val)
35 {
36 	int i, r = 0;
37 	/* yes, could do it without a loop.. */
38 	for (i = 0; i < 32; i++) {
39 		r = r + (val & 1);
40 		val = val >> 1;
41 	}
42 	return r;
43 }
44 
45 /* Clamp value; PHY code */
46 static inline int
47 bwn_clamp_val(int val, int lo, int hi)
48 {
49 	if (val < lo)
50 		return lo;
51 	if (val > hi)
52 		return hi;
53 	return val;
54 }
55 
56 /* Q52 format - used in PHY routines */
57 #define	INT_TO_Q52(i)		((i) << 2)
58 #define	Q52_TO_INT(q52)		((q52) >> 2)
59 #define	Q52_FMT			"%u.%u"
60 #define	Q52_ARG(q52)		Q52_TO_INT(q52), ((((q52) & 0x3) * 100) / 4)
61 
62 extern	unsigned int bwn_sqrt(struct bwn_mac *mac, unsigned int x);
63 
64 #endif	/* __IF_BWN_UTIL_H__ */
65