xref: /dragonfly/sbin/ifconfig/regdomain.h (revision f1699cf2fc932a411e565782d09c34554ceeaa40)
1 /*-
2  * Copyright (c) 2007-2008 Sam Leffler, Errno Consulting
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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * $FreeBSD: head/sbin/ifconfig/regdomain.h 188258 2009-02-07 01:12:51Z sam $
26  */
27 #ifndef _LIB80211_H_
28 #define _LIB80211_H_
29 
30 #include <sys/cdefs.h>
31 #include <sys/queue.h>
32 
33 #include <netproto/802_11/ieee80211_regdomain.h>
34 
35 __BEGIN_DECLS
36 
37 struct freqband {
38           uint16_t  freqStart;          /* starting frequency (MHz) */
39           uint16_t  freqEnd;  /* ending frequency (MHz) */
40           uint8_t             chanWidth;          /* channel width (MHz) */
41           uint8_t             chanSep;  /* channel sepaaration (MHz) */
42           uint32_t  flags;              /* common operational constraints */
43 
44           const void          *id;
45           LIST_ENTRY(freqband) next;
46 };
47 
48 /* private flags, don't pass to os */
49 #define   REQ_ECM             0x1                 /* enable if ECM set */
50 #define   REQ_INDOOR          0x2                 /* enable only for indoor operation */
51 #define   REQ_OUTDOOR         0x4                 /* enable only for outdoor operation */
52 
53 #define   REQ_FLAGS (REQ_ECM|REQ_INDOOR|REQ_OUTDOOR)
54 
55 struct netband {
56           const struct freqband *band;  /* channel list description */
57           uint8_t             maxPower; /* regulatory cap on tx power (dBm) */
58           uint8_t             maxPowerDFS;        /* regulatory cap w/ DFS (dBm) */
59           uint8_t             maxAntGain;         /* max allowed antenna gain (.5 dBm) */
60           uint32_t  flags;              /* net80211 channel flags */
61 
62           LIST_ENTRY(netband) next;
63 };
64 typedef LIST_HEAD(, netband) netband_head;
65 
66 struct country;
67 
68 struct regdomain {
69           enum RegdomainCode  sku;      /* regdomain code/SKU */
70           const char                    *name;    /* printable name */
71           const struct country          *cc;      /* country code for 1-1/default map */
72 
73           netband_head         bands_11b;         /* 11b operation */
74           netband_head         bands_11g;         /* 11g operation */
75           netband_head         bands_11a;         /* 11a operation */
76           netband_head         bands_11ng;        /* 11ng operation */
77           netband_head         bands_11na;        /* 11na operation */
78           netband_head         bands_11ac;        /* 11ac 5GHz operation */
79           netband_head         bands_11acg;       /* 11ac 2GHz operation */
80 
81           LIST_ENTRY(regdomain)         next;
82 };
83 
84 struct country {
85           enum ISOCountryCode code;
86 #define   NO_COUNTRY          0xffff
87           const struct regdomain        *rd;
88           const char*                   isoname;
89           const char*                   name;
90 
91           LIST_ENTRY(country) next;
92 };
93 
94 enum IdentType { DOMAIN, COUNTRY, FREQBAND };
95 
96 struct ident {
97           const void *id;
98           void *p;
99           enum IdentType type;
100 };
101 
102 struct regdata {
103           LIST_HEAD(, country)          countries;          /* country code table */
104           LIST_HEAD(, regdomain)        domains;  /* regulatory domains */
105           LIST_HEAD(, freqband)         freqbands;          /* frequency band table */
106           struct ident                  *ident;             /* identifier table */
107 };
108 
109 #define   _PATH_REGDOMAIN     "/etc/regdomain.xml"
110 
111 struct regdata *lib80211_alloc_regdata(void);
112 void      lib80211_free_regdata(struct regdata *);
113 
114 int       lib80211_regdomain_readconfig(struct regdata *, const void *, size_t);
115 void      lib80211_regdomain_cleanup(struct regdata *);
116 
117 const struct regdomain *lib80211_regdomain_findbysku(const struct regdata *,
118           enum RegdomainCode);
119 const struct regdomain *lib80211_regdomain_findbyname(const struct regdata *,
120           const char *);
121 
122 const struct country *lib80211_country_findbycc(const struct regdata *,
123           enum ISOCountryCode);
124 const struct country *lib80211_country_findbyname(const struct regdata *,
125           const char *);
126 
127 __END_DECLS
128 
129 #endif /* _LIB80211_H_ */
130