1 /*
2  * Copyright (c) 2012 Neratec Solutions AG
3  *
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.
7  *
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.
15  */
16 
17 #ifndef DFS_PRI_DETECTOR_H
18 #define DFS_PRI_DETECTOR_H
19 
20 #include <linux/list.h>
21 
22 extern struct ath_dfs_pool_stats global_dfs_pool_stats;
23 
24 /**
25  * struct pri_sequence - sequence of pulses matching one PRI
26  * @head: list_head
27  * @pri: pulse repetition interval (PRI) in usecs
28  * @dur: duration of sequence in usecs
29  * @count: number of pulses in this sequence
30  * @count_falses: number of not matching pulses in this sequence
31  * @first_ts: time stamp of first pulse in usecs
32  * @last_ts: time stamp of last pulse in usecs
33  * @deadline_ts: deadline when this sequence becomes invalid (first_ts + dur)
34  */
35 struct pri_sequence {
36 	struct list_head head;
37 	u32 pri;
38 	u32 dur;
39 	u32 count;
40 	u32 count_falses;
41 	u64 first_ts;
42 	u64 last_ts;
43 	u64 deadline_ts;
44 };
45 
46 /**
47  * struct pri_detector - PRI detector element for a dedicated radar type
48  * @exit(): destructor
49  * @add_pulse(): add pulse event, returns pri_sequence if pattern was detected
50  * @reset(): clear states and reset to given time stamp
51  * @rs: detector specs for this detector element
52  * @last_ts: last pulse time stamp considered for this element in usecs
53  * @sequences: list_head holding potential pulse sequences
54  * @pulses: list connecting pulse_elem objects
55  * @count: number of pulses in queue
56  * @max_count: maximum number of pulses to be queued
57  * @window_size: window size back from newest pulse time stamp in usecs
58  */
59 struct pri_detector {
60 	void (*exit)     (struct pri_detector *de);
61 	struct pri_sequence *
62 	     (*add_pulse)(struct pri_detector *de, struct pulse_event *e);
63 	void (*reset)    (struct pri_detector *de, u64 ts);
64 
65 /* private: internal use only */
66 	const struct radar_detector_specs *rs;
67 	u64 last_ts;
68 	struct list_head sequences;
69 	struct list_head pulses;
70 	u32 count;
71 	u32 max_count;
72 	u32 window_size;
73 };
74 
75 struct pri_detector *pri_detector_init(const struct radar_detector_specs *rs);
76 
77 #endif /* DFS_PRI_DETECTOR_H */
78