drivers/net/wireless/ath/ath9k/dfs_pri_detector.h

   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 /**
  23  * struct pri_detector - PRI detector element for a dedicated radar type
  24  * @exit(): destructor
  25  * @add_pulse(): add pulse event, returns true if pattern was detected
  26  * @reset(): clear states and reset to given time stamp
  27  * @rs: detector specs for this detector element
  28  * @last_ts: last pulse time stamp considered for this element in usecs
  29  * @sequences: list_head holding potential pulse sequences
  30  * @pulses: list connecting pulse_elem objects
  31  * @count: number of pulses in queue
  32  * @max_count: maximum number of pulses to be queued
  33  * @window_size: window size back from newest pulse time stamp in usecs
  34  */
  35 struct pri_detector {
  36         void (*exit)     (struct pri_detector *de);
  37         bool (*add_pulse)(struct pri_detector *de, struct pulse_event *e);
  38         void (*reset)    (struct pri_detector *de, u64 ts);
  39
  40 /* private: internal use only */
  41         const struct radar_detector_specs *rs;
  42         u64 last_ts;
  43         struct list_head sequences;
  44         struct list_head pulses;
  45         u32 count;
  46         u32 max_count;
  47         u32 window_size;
  48 };
  49
  50 struct pri_detector *pri_detector_init(const struct radar_detector_specs *rs);
  51
  52 #endif /* DFS_PRI_DETECTOR_H */