2 * Copyright (c) 2012 Neratec Solutions AG
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include <linux/slab.h>
18 #include <linux/export.h>
20 #include "dfs_pattern_detector.h"
21 #include "dfs_pri_detector.h"
24 * tolerated deviation of radar time stamp in usecs on both sides
25 * TODO: this might need to be HW-dependent
27 #define PRI_TOLERANCE 16
30 * struct radar_types - contains array of patterns defined for one DFS domain
31 * @domain: DFS regulatory domain
32 * @num_radar_types: number of radar types to follow
33 * @radar_types: radar types array
36 enum nl80211_dfs_regions region
;
38 const struct radar_detector_specs
*radar_types
;
41 /* percentage on ppb threshold to trigger detection */
42 #define MIN_PPB_THRESH 50
43 #define PPB_THRESH(PPB) ((PPB * MIN_PPB_THRESH + 50) / 100)
44 #define PRF2PRI(PRF) ((1000000 + PRF / 2) / PRF)
46 #define ETSI_PATTERN(ID, WMIN, WMAX, PMIN, PMAX, PRF, PPB) \
48 ID, WMIN, WMAX, (PRF2PRI(PMAX) - PRI_TOLERANCE), \
49 (PRF2PRI(PMIN) * PRF + PRI_TOLERANCE), PRF, PPB * PRF, \
50 PPB_THRESH(PPB), PRI_TOLERANCE, \
53 /* radar types as defined by ETSI EN-301-893 v1.5.1 */
54 static const struct radar_detector_specs etsi_radar_ref_types_v15
[] = {
55 ETSI_PATTERN(0, 0, 1, 700, 700, 1, 18),
56 ETSI_PATTERN(1, 0, 5, 200, 1000, 1, 10),
57 ETSI_PATTERN(2, 0, 15, 200, 1600, 1, 15),
58 ETSI_PATTERN(3, 0, 15, 2300, 4000, 1, 25),
59 ETSI_PATTERN(4, 20, 30, 2000, 4000, 1, 20),
60 ETSI_PATTERN(5, 0, 2, 300, 400, 3, 10),
61 ETSI_PATTERN(6, 0, 2, 400, 1200, 3, 15),
64 static const struct radar_types etsi_radar_types_v15
= {
65 .region
= NL80211_DFS_ETSI
,
66 .num_radar_types
= ARRAY_SIZE(etsi_radar_ref_types_v15
),
67 .radar_types
= etsi_radar_ref_types_v15
,
70 /* for now, we support ETSI radar types, FCC and JP are TODO */
71 static const struct radar_types
*dfs_domains
[] = {
72 &etsi_radar_types_v15
,
76 * get_dfs_domain_radar_types() - get radar types for a given DFS domain
77 * @param domain DFS domain
78 * @return radar_types ptr on success, NULL if DFS domain is not supported
80 static const struct radar_types
*
81 get_dfs_domain_radar_types(enum nl80211_dfs_regions region
)
84 for (i
= 0; i
< ARRAY_SIZE(dfs_domains
); i
++) {
85 if (dfs_domains
[i
]->region
== region
)
86 return dfs_domains
[i
];
92 * struct channel_detector - detector elements for a DFS channel
94 * @freq: frequency for this channel detector in MHz
95 * @detectors: array of dynamically created detector elements for this freq
97 * Channel detectors are required to provide multi-channel DFS detection, e.g.
98 * to support off-channel scanning. A pattern detector has a list of channels
99 * radar pulses have been reported for in the past.
101 struct channel_detector
{
102 struct list_head head
;
104 struct pri_detector
**detectors
;
107 /* channel_detector_reset() - reset detector lines for a given channel */
108 static void channel_detector_reset(struct dfs_pattern_detector
*dpd
,
109 struct channel_detector
*cd
)
114 for (i
= 0; i
< dpd
->num_radar_types
; i
++)
115 cd
->detectors
[i
]->reset(cd
->detectors
[i
], dpd
->last_pulse_ts
);
118 /* channel_detector_exit() - destructor */
119 static void channel_detector_exit(struct dfs_pattern_detector
*dpd
,
120 struct channel_detector
*cd
)
126 for (i
= 0; i
< dpd
->num_radar_types
; i
++) {
127 struct pri_detector
*de
= cd
->detectors
[i
];
131 kfree(cd
->detectors
);
135 static struct channel_detector
*
136 channel_detector_create(struct dfs_pattern_detector
*dpd
, u16 freq
)
139 struct channel_detector
*cd
;
141 cd
= kmalloc(sizeof(*cd
), GFP_KERNEL
);
145 INIT_LIST_HEAD(&cd
->head
);
147 sz
= sizeof(cd
->detectors
) * dpd
->num_radar_types
;
148 cd
->detectors
= kzalloc(sz
, GFP_KERNEL
);
149 if (cd
->detectors
== NULL
)
152 for (i
= 0; i
< dpd
->num_radar_types
; i
++) {
153 const struct radar_detector_specs
*rs
= &dpd
->radar_spec
[i
];
154 struct pri_detector
*de
= pri_detector_init(rs
);
157 cd
->detectors
[i
] = de
;
159 list_add(&cd
->head
, &dpd
->channel_detectors
);
163 pr_err("failed to allocate channel_detector for freq=%d\n", freq
);
164 channel_detector_exit(dpd
, cd
);
169 * channel_detector_get() - get channel detector for given frequency
170 * @param dpd instance pointer
171 * @param freq frequency in MHz
172 * @return pointer to channel detector on success, NULL otherwise
174 * Return existing channel detector for the given frequency or return a
177 static struct channel_detector
*
178 channel_detector_get(struct dfs_pattern_detector
*dpd
, u16 freq
)
180 struct channel_detector
*cd
;
181 list_for_each_entry(cd
, &dpd
->channel_detectors
, head
) {
182 if (cd
->freq
== freq
)
185 return channel_detector_create(dpd
, freq
);
189 * DFS Pattern Detector
192 /* dpd_reset(): reset all channel detectors */
193 static void dpd_reset(struct dfs_pattern_detector
*dpd
)
195 struct channel_detector
*cd
;
196 if (!list_empty(&dpd
->channel_detectors
))
197 list_for_each_entry(cd
, &dpd
->channel_detectors
, head
)
198 channel_detector_reset(dpd
, cd
);
201 static void dpd_exit(struct dfs_pattern_detector
*dpd
)
203 struct channel_detector
*cd
, *cd0
;
204 if (!list_empty(&dpd
->channel_detectors
))
205 list_for_each_entry_safe(cd
, cd0
, &dpd
->channel_detectors
, head
)
206 channel_detector_exit(dpd
, cd
);
211 dpd_add_pulse(struct dfs_pattern_detector
*dpd
, struct pulse_event
*event
)
215 struct channel_detector
*cd
;
217 if (dpd
->region
== NL80211_DFS_UNSET
) {
219 * pulses received for a non-supported or un-initialized
220 * domain are treated as detected radars
225 cd
= channel_detector_get(dpd
, event
->freq
);
229 ts_wraparound
= (event
->ts
< dpd
->last_pulse_ts
);
230 dpd
->last_pulse_ts
= event
->ts
;
233 * reset detector on time stamp wraparound
234 * with monotonic time stamps, this should never happen
236 pr_warn("DFS: time stamp wraparound detected, resetting\n");
239 /* do type individual pattern matching */
240 for (i
= 0; i
< dpd
->num_radar_types
; i
++) {
241 if (cd
->detectors
[i
]->add_pulse(cd
->detectors
[i
], event
) != 0) {
242 channel_detector_reset(dpd
, cd
);
249 static bool dpd_set_domain(struct dfs_pattern_detector
*dpd
,
250 enum nl80211_dfs_regions region
)
252 const struct radar_types
*rt
;
253 struct channel_detector
*cd
, *cd0
;
255 if (dpd
->region
== region
)
258 dpd
->region
= NL80211_DFS_UNSET
;
260 rt
= get_dfs_domain_radar_types(region
);
264 /* delete all channel detectors for previous DFS domain */
265 if (!list_empty(&dpd
->channel_detectors
))
266 list_for_each_entry_safe(cd
, cd0
, &dpd
->channel_detectors
, head
)
267 channel_detector_exit(dpd
, cd
);
268 dpd
->radar_spec
= rt
->radar_types
;
269 dpd
->num_radar_types
= rt
->num_radar_types
;
271 dpd
->region
= region
;
275 static struct dfs_pattern_detector default_dpd
= {
277 .set_domain
= dpd_set_domain
,
278 .add_pulse
= dpd_add_pulse
,
279 .region
= NL80211_DFS_UNSET
,
282 struct dfs_pattern_detector
*
283 dfs_pattern_detector_init(enum nl80211_dfs_regions region
)
285 struct dfs_pattern_detector
*dpd
;
286 dpd
= kmalloc(sizeof(*dpd
), GFP_KERNEL
);
288 pr_err("allocation of dfs_pattern_detector failed\n");
292 INIT_LIST_HEAD(&dpd
->channel_detectors
);
294 if (dpd
->set_domain(dpd
, region
))
297 pr_err("Could not set DFS domain to %d. ", region
);
300 EXPORT_SYMBOL(dfs_pattern_detector_init
);