xref: /freebsd/sys/dev/ath/ath_hal/ah_regdomain/ah_rd_regenum.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: ISC
3  *
4  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
5  * Copyright (c) 2005-2011 Atheros Communications, Inc.
6  * All rights reserved.
7  *
8  * Permission to use, copy, modify, and/or distribute this software for any
9  * purpose with or without fee is hereby granted, provided that the above
10  * copyright notice and this permission notice appear in all copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19  */
20 
21 #ifndef	__AH_REGDOMAIN_REGENUM_H__
22 #define	__AH_REGDOMAIN_REGENUM_H__
23 
24 /*
25  * Enumerated Regulatory Domain Information 8 bit values indicate that
26  * the regdomain is really a pair of unitary regdomains.  12 bit values
27  * are the real unitary regdomains and are the only ones which have the
28  * frequency bitmasks and flags set.
29  */
30 enum {
31 	/*
32 	 * The following regulatory domain definitions are
33 	 * found in the EEPROM. Each regulatory domain
34 	 * can operate in either a 5GHz or 2.4GHz wireless mode or
35 	 * both 5GHz and 2.4GHz wireless modes.
36 	 * In general, the value holds no special
37 	 * meaning and is used to decode into either specific
38 	 * 2.4GHz or 5GHz wireless mode for that particular
39 	 * regulatory domain.
40 	 */
41 	NO_ENUMRD	= 0x00,
42 	NULL1_WORLD	= 0x03,		/* For 11b-only countries (no 11a allowed) */
43 	NULL1_ETSIB	= 0x07,		/* Israel */
44 	NULL1_ETSIC	= 0x08,
45 	FCC1_FCCA	= 0x10,		/* USA */
46 	FCC1_WORLD	= 0x11,		/* Hong Kong */
47 	FCC4_FCCA	= 0x12,		/* USA - Public Safety */
48 	FCC5_FCCB	= 0x13,		/* USA w/ 1/2 and 1/4 width channels */
49 	FCC6_FCCA	= 0x14,		/* Canada for AP only */
50 
51 	FCC2_FCCA	= 0x20,		/* Canada */
52 	FCC2_WORLD	= 0x21,		/* Australia & HK */
53 	FCC2_ETSIC	= 0x22,
54 	FCC_UBNT	= 0x2A,		/* Ubiquity PicoStation M2HP */
55 	FRANCE_RES	= 0x31,		/* Legacy France for OEM */
56 	FCC3_FCCA	= 0x3A,		/* USA & Canada w/5470 band, 11h, DFS enabled */
57 	FCC3_WORLD	= 0x3B,		/* USA & Canada w/5470 band, 11h, DFS enabled */
58 
59 	ETSI1_WORLD	= 0x37,
60 	ETSI3_ETSIA	= 0x32,		/* France (optional) */
61 	ETSI2_WORLD	= 0x35,		/* Hungary & others */
62 	ETSI3_WORLD	= 0x36,		/* France & others */
63 	ETSI4_WORLD	= 0x30,
64 	ETSI4_ETSIC	= 0x38,
65 	ETSI5_WORLD	= 0x39,
66 	ETSI6_WORLD	= 0x34,		/* Bulgaria */
67 	ETSI8_WORLD	= 0x3D,		/* Russia */
68 	ETSI9_WORLD	= 0x3E,		/* Ukraine */
69 	ETSI_RESERVED	= 0x33,		/* Reserved (Do not used) */
70 
71 	MKK1_MKKA	= 0x40,		/* Japan (JP1) */
72 	MKK1_MKKB	= 0x41,		/* Japan (JP0) */
73 	APL4_WORLD	= 0x42,		/* Singapore */
74 	MKK2_MKKA	= 0x43,		/* Japan with 4.9G channels */
75 	APL_RESERVED	= 0x44,		/* Reserved (Do not used)  */
76 	APL2_WORLD	= 0x45,		/* Korea */
77 	APL2_APLC	= 0x46,
78 	APL3_WORLD	= 0x47,
79 	MKK1_FCCA	= 0x48,		/* Japan (JP1-1) */
80 	APL2_APLD	= 0x49,		/* Korea with 2.3G channels */
81 	MKK1_MKKA1	= 0x4A,		/* Japan (JE1) */
82 	MKK1_MKKA2	= 0x4B,		/* Japan (JE2) */
83 	MKK1_MKKC	= 0x4C,		/* Japan (MKK1_MKKA,except Ch14) */
84 	APL2_FCCA	= 0x4D,		/* Mobile customer */
85 
86 	APL3_FCCA	= 0x50,
87 	APL1_WORLD	= 0x52,		/* Latin America */
88 	APL1_FCCA	= 0x53,
89 	APL1_APLA	= 0x54,
90 	APL1_ETSIC	= 0x55,
91 	APL2_ETSIC	= 0x56,		/* Venezuela */
92 	APL5_WORLD	= 0x58,		/* Chile */
93 	APL6_WORLD	= 0x5B,		/* Singapore */
94 	APL7_FCCA	= 0x5C,		/* Taiwan 5.47 Band */
95 	APL8_WORLD	= 0x5D,		/* Malaysia 5GHz */
96 	APL9_WORLD	= 0x5E,		/* Korea 5GHz; before 11/2007; now APs only */
97 	APL10_WORLD	= 0x5F,		/* Korea 5GHz; After 11/2007; STAs only */
98 
99 	/*
100 	 * World mode SKUs
101 	 */
102 	WOR0_WORLD	= 0x60,		/* World0 (WO0 SKU) */
103 	WOR1_WORLD	= 0x61,		/* World1 (WO1 SKU) */
104 	WOR2_WORLD	= 0x62,		/* World2 (WO2 SKU) */
105 	WOR3_WORLD	= 0x63,		/* World3 (WO3 SKU) */
106 	WOR4_WORLD	= 0x64,		/* World4 (WO4 SKU) */
107 	WOR5_ETSIC	= 0x65,		/* World5 (WO5 SKU) */
108 
109 	WOR01_WORLD	= 0x66,		/* World0-1 (WW0-1 SKU) */
110 	WOR02_WORLD	= 0x67,		/* World0-2 (WW0-2 SKU) */
111 	EU1_WORLD	= 0x68,		/* Same as World0-2 (WW0-2 SKU), except active scan ch1-13. No ch14 */
112 
113 	WOR9_WORLD	= 0x69,		/* World9 (WO9 SKU) */
114 	WORA_WORLD	= 0x6A,		/* WorldA (WOA SKU) */
115 	WORB_WORLD	= 0x6B,		/* WorldB (WOB SKU) */
116 	WORC_WORLD	= 0x6C,		/* WorldC (WOC SKU) */
117 
118 	MKK3_MKKB	= 0x80,		/* Japan UNI-1 even + MKKB */
119 	MKK3_MKKA2	= 0x81,		/* Japan UNI-1 even + MKKA2 */
120 	MKK3_MKKC	= 0x82,		/* Japan UNI-1 even + MKKC */
121 
122 	MKK4_MKKB	= 0x83,		/* Japan UNI-1 even + UNI-2 + MKKB */
123 	MKK4_MKKA2	= 0x84,		/* Japan UNI-1 even + UNI-2 + MKKA2 */
124 	MKK4_MKKC	= 0x85,		/* Japan UNI-1 even + UNI-2 + MKKC */
125 
126 	MKK5_MKKB	= 0x86,		/* Japan UNI-1 even + UNI-2 + mid-band + MKKB */
127 	MKK5_MKKA2	= 0x87,		/* Japan UNI-1 even + UNI-2 + mid-band + MKKA2 */
128 	MKK5_MKKC	= 0x88,		/* Japan UNI-1 even + UNI-2 + mid-band + MKKC */
129 
130 	MKK6_MKKB	= 0x89,		/* Japan UNI-1 even + UNI-1 odd MKKB */
131 	MKK6_MKKA2	= 0x8A,		/* Japan UNI-1 even + UNI-1 odd + MKKA2 */
132 	MKK6_MKKC	= 0x8B,		/* Japan UNI-1 even + UNI-1 odd + MKKC */
133 
134 	MKK7_MKKB	= 0x8C,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + MKKB */
135 	MKK7_MKKA2	= 0x8D,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + MKKA2 */
136 	MKK7_MKKC	= 0x8E,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + MKKC */
137 
138 	MKK8_MKKB	= 0x8F,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + MKKB */
139 	MKK8_MKKA2	= 0x90,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + MKKA2 */
140 	MKK8_MKKC	= 0x91,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + MKKC */
141 
142 	MKK14_MKKA1	= 0x92,		/* Japan UNI-1 even + UNI-1 odd + 4.9GHz + MKKA1 */
143 	MKK15_MKKA1	= 0x93,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + 4.9GHz + MKKA1 */
144 
145 	MKK10_FCCA	= 0xD0,		/* Japan UNI-1 even + UNI-2 + 4.9GHz + FCCA */
146 	MKK10_MKKA1	= 0xD1,		/* Japan UNI-1 even + UNI-2 + 4.9GHz + MKKA1 */
147 	MKK10_MKKC	= 0xD2,		/* Japan UNI-1 even + UNI-2 + 4.9GHz + MKKC */
148 	MKK10_MKKA2	= 0xD3,		/* Japan UNI-1 even + UNI-2 + 4.9GHz + MKKA2 */
149 
150 	MKK11_MKKA	= 0xD4,		/* Japan UNI-1 even + UNI-2 + mid-band + 4.9GHz + MKKA */
151 	MKK11_FCCA	= 0xD5,		/* Japan UNI-1 even + UNI-2 + mid-band + 4.9GHz + FCCA */
152 	MKK11_MKKA1	= 0xD6,		/* Japan UNI-1 even + UNI-2 + mid-band + 4.9GHz + MKKA1 */
153 	MKK11_MKKC	= 0xD7,		/* Japan UNI-1 even + UNI-2 + mid-band + 4.9GHz + MKKC */
154 	MKK11_MKKA2	= 0xD8,		/* Japan UNI-1 even + UNI-2 + mid-band + 4.9GHz + MKKA2 */
155 
156 	MKK12_MKKA	= 0xD9,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + 4.9GHz + MKKA */
157 	MKK12_FCCA	= 0xDA,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + 4.9GHz + FCCA */
158 	MKK12_MKKA1	= 0xDB,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + 4.9GHz + MKKA1 */
159 	MKK12_MKKC	= 0xDC,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + 4.9GHz + MKKC */
160 	MKK12_MKKA2	= 0xDD,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + 4.9GHz + MKKA2 */
161 
162 	MKK13_MKKB	= 0xDE,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + mid-band + MKKB + All passive + no adhoc */
163 
164 	/*
165 	 * Following definitions are used only by s/w to map old
166 	 * Japan SKUs.
167 	 */
168 	MKK3_MKKA	= 0xF0,		/* Japan UNI-1 even + MKKA */
169 	MKK3_MKKA1	= 0xF1,		/* Japan UNI-1 even + MKKA1 */
170 	MKK3_FCCA	= 0xF2,		/* Japan UNI-1 even + FCCA */
171 	MKK4_MKKA	= 0xF3,		/* Japan UNI-1 even + UNI-2 + MKKA */
172 	MKK4_MKKA1	= 0xF4,		/* Japan UNI-1 even + UNI-2 + MKKA1 */
173 	MKK4_FCCA	= 0xF5,		/* Japan UNI-1 even + UNI-2 + FCCA */
174 	MKK9_MKKA	= 0xF6,		/* Japan UNI-1 even + 4.9GHz */
175 	MKK10_MKKA	= 0xF7,		/* Japan UNI-1 even + UNI-2 + 4.9GHz */
176 	MKK6_MKKA1	= 0xF8,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + MKKA1 */
177 	MKK6_FCCA	= 0xF9,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + FCCA */
178 	MKK7_MKKA1	= 0xFA,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + MKKA1 */
179 	MKK7_FCCA	= 0xFB,		/* Japan UNI-1 even + UNI-1 odd + UNI-2 + FCCA */
180 	MKK9_FCCA	= 0xFC,		/* Japan UNI-1 even + 4.9GHz + FCCA */
181 	MKK9_MKKA1	= 0xFD,		/* Japan UNI-1 even + 4.9GHz + MKKA1 */
182 	MKK9_MKKC	= 0xFE,		/* Japan UNI-1 even + 4.9GHz + MKKC */
183 	MKK9_MKKA2	= 0xFF,		/* Japan UNI-1 even + 4.9GHz + MKKA2 */
184 
185 	/*
186 	 * Regulator domains ending in a number (e.g. APL1,
187 	 * MK1, ETSI4, etc) apply to 5GHz channel and power
188 	 * information.  Regulator domains ending in a letter
189 	 * (e.g. APLA, FCCA, etc) apply to 2.4GHz channel and
190 	 * power information.
191 	 */
192 	APL1		= 0x0150,	/* LAT & Asia */
193 	APL2		= 0x0250,	/* LAT & Asia */
194 	APL3		= 0x0350,	/* Taiwan */
195 	APL4		= 0x0450,	/* Jordan */
196 	APL5		= 0x0550,	/* Chile */
197 	APL6		= 0x0650,	/* Singapore */
198 	APL7		= 0x0750,	/* Taiwan, disable ch52 */
199 	APL8		= 0x0850,	/* Malaysia */
200 	APL9		= 0x0950,	/* Korea. Before 11/2007. Now used only by APs */
201 	APL10		= 0x1050,	/* Korea. After 11/2007. For STAs only */
202 
203 	ETSI1		= 0x0130,	/* Europe & others */
204 	ETSI2		= 0x0230,	/* Europe & others */
205 	ETSI3		= 0x0330,	/* Europe & others */
206 	ETSI4		= 0x0430,	/* Europe & others */
207 	ETSI5		= 0x0530,	/* Europe & others */
208 	ETSI6		= 0x0630,	/* Europe & others */
209 	ETSI8		= 0x0830,	/* Russia */
210 	ETSI9		= 0x0930,	/* Ukraine */
211 	ETSIA		= 0x0A30,	/* France */
212 	ETSIB		= 0x0B30,	/* Israel */
213 	ETSIC		= 0x0C30,	/* Latin America */
214 
215 	FCC1		= 0x0110,	/* US & others */
216 	FCC2		= 0x0120,	/* Canada, Australia & New Zealand */
217 	FCC3		= 0x0160,	/* US w/new middle band & DFS */
218 	FCC4		= 0x0165,	/* US Public Safety */
219 	FCC5		= 0x0166,	/* US w/ 1/2 and 1/4 width channels */
220 	FCC6		= 0x0610,	/* Canada and Australia */
221 	FCCA		= 0x0A10,
222 	FCCB		= 0x0A11,	/* US w/ 1/2 and 1/4 width channels */
223 
224 	APLD		= 0x0D50,	/* South Korea */
225 
226 	MKK1		= 0x0140,	/* Japan (UNI-1 odd)*/
227 	MKK2		= 0x0240,	/* Japan (4.9 GHz + UNI-1 odd) */
228 	MKK3		= 0x0340,	/* Japan (UNI-1 even) */
229 	MKK4		= 0x0440,	/* Japan (UNI-1 even + UNI-2) */
230 	MKK5		= 0x0540,	/* Japan (UNI-1 even + UNI-2 + mid-band) */
231 	MKK6		= 0x0640,	/* Japan (UNI-1 odd + UNI-1 even) */
232 	MKK7		= 0x0740,	/* Japan (UNI-1 odd + UNI-1 even + UNI-2 */
233 	MKK8		= 0x0840,	/* Japan (UNI-1 odd + UNI-1 even + UNI-2 + mid-band) */
234 	MKK9		= 0x0940,	/* Japan (UNI-1 even + 4.9 GHZ) */
235 	MKK10		= 0x0B40,	/* Japan (UNI-1 even + UNI-2 + 4.9 GHZ) */
236 	MKK11		= 0x1140,	/* Japan (UNI-1 even + UNI-2 + 4.9 GHZ) */
237 	MKK12		= 0x1240,	/* Japan (UNI-1 even + UNI-2 + 4.9 GHZ) */
238 	MKK13		= 0x0C40,	/* Same as MKK8 but all passive and no adhoc 11a */
239 	MKK14		= 0x1440,	/* Japan UNI-1 even + UNI-1 odd + 4.9GHz */
240 	MKK15		= 0x1540,	/* Japan UNI-1 even + UNI-1 odd + UNI-2 + 4.9GHz */
241 
242 	MKKA		= 0x0A40,	/* Japan */
243 	MKKC		= 0x0A50,
244 
245 	NULL1		= 0x0198,
246 	WORLD		= 0x0199,
247 	DEBUG_REG_DMN	= 0x01ff,
248 };
249 
250 #endif
251