wireshark/wsutil/frequency-utils.h

73 lines
1.6 KiB
C

/* frequency-utils.h
* Frequency conversion utility definitions
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 2007 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __FREQUENCY_UTILS_H__
#define __FREQUENCY_UTILS_H__
#include "ws_symbol_export.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** @file
* Frequency and channel conversion utilities.
*/
/**
* Given a center frequency in MHz, return a channel number.
* @param freq Frequency in MHz.
* @return The equivalent channel or -1 if no match is found.
*/
WS_DLL_PUBLIC
gint
ieee80211_mhz_to_chan(guint freq);
/**
* Given a channel number and a band type, return a center frequency.
* @param chan Channel number
* @param is_bg TRUE if the channel is a b/g channel, FALSE otherwise.
* @return The equivalent frequency or 0 if no match is found.
*/
WS_DLL_PUBLIC
guint
ieee80211_chan_to_mhz(gint chan, gboolean is_bg);
/**
* Given a frequency in MHz, return a string representation.
* @param freq Frequench in MHz.
* @return A string showing the frequency, channel number, and type. The string must be freed with g_free() after use.
*/
WS_DLL_PUBLIC
gchar*
ieee80211_mhz_to_str(guint freq);
/* Should this be "(freq < 4920)", or something else? */
#define FREQ_IS_BG(freq) (freq <= 2484)
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __FREQUENCY_UTILS_H__ */
/*
* Editor modelines
*
* Local Variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/