libnm-core/nm-setting-wireless.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
   2
   3 /*
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301 USA.
  18  *
  19  * Copyright 2007 - 2014 Red Hat, Inc.
  20  * Copyright 2007 - 2008 Novell, Inc.
  21  */
  22
  23 #ifndef __NM_SETTING_WIRELESS_H__
  24 #define __NM_SETTING_WIRELESS_H__
  25
  26 #if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
  27 #error "Only <NetworkManager.h> can be included directly."
  28 #endif
  29
  30 #include <nm-setting.h>
  31 #include <nm-setting-wireless-security.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define NM_TYPE_SETTING_WIRELESS            (nm_setting_wireless_get_type ())
  36 #define NM_SETTING_WIRELESS(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SETTING_WIRELESS, NMSettingWireless))
  37 #define NM_SETTING_WIRELESS_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SETTING_WIRELESS, NMSettingWirelessClass))
  38 #define NM_IS_SETTING_WIRELESS(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SETTING_WIRELESS))
  39 #define NM_IS_SETTING_WIRELESS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SETTING_WIRELESS))
  40 #define NM_SETTING_WIRELESS_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SETTING_WIRELESS, NMSettingWirelessClass))
  41
  42 #define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
  43
  44 #define NM_SETTING_WIRELESS_SSID        "ssid"
  45 #define NM_SETTING_WIRELESS_MODE        "mode"
  46 #define NM_SETTING_WIRELESS_BAND        "band"
  47 #define NM_SETTING_WIRELESS_CHANNEL     "channel"
  48 #define NM_SETTING_WIRELESS_BSSID       "bssid"
  49 #define NM_SETTING_WIRELESS_RATE        "rate"
  50 #define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
  51 #define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
  52 #define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
  53 #define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
  54 #define NM_SETTING_WIRELESS_MTU         "mtu"
  55 #define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
  56 #define NM_SETTING_WIRELESS_HIDDEN      "hidden"
  57 #define NM_SETTING_WIRELESS_POWERSAVE   "powersave"
  58 #define NM_SETTING_WIRELESS_MAC_ADDRESS_RANDOMIZATION   "mac-address-randomization"
  59
  60 /**
  61  * NM_SETTING_WIRELESS_MODE_ADHOC:
  62  *
  63  * Indicates Ad-Hoc mode where no access point is expected to be present.
  64  */
  65 #define NM_SETTING_WIRELESS_MODE_ADHOC  "adhoc"
  66
  67 /**
  68  * NM_SETTING_WIRELESS_MODE_AP:
  69  *
  70  * Indicates AP/master mode where the wireless device is started as an access
  71  * point/hotspot.
  72  */
  73 #define NM_SETTING_WIRELESS_MODE_AP     "ap"
  74
  75 /**
  76  * NM_SETTING_WIRELESS_MODE_INFRA:
  77  *
  78  * Indicates infrastructure mode where an access point is expected to be present
  79  * for this connection.
  80  */
  81 #define NM_SETTING_WIRELESS_MODE_INFRA  "infrastructure"
  82
  83 /**
  84  * NMSettingWirelessPowersave:
  85  * @NM_SETTING_WIRELESS_POWERSAVE_DEFAULT: use the default value
  86  * @NM_SETTING_WIRELESS_POWERSAVE_IGNORE: don't touch existing setting
  87  * @NM_SETTING_WIRELESS_POWERSAVE_DISABLE: disable powersave
  88  * @NM_SETTING_WIRELESS_POWERSAVE_ENABLE: enable powersave
  89  *
  90  * These flags indicate whether wireless powersave must be enabled.
  91  **/
  92 typedef enum {
  93         NM_SETTING_WIRELESS_POWERSAVE_DEFAULT       = 0,
  94         NM_SETTING_WIRELESS_POWERSAVE_IGNORE        = 1,
  95         NM_SETTING_WIRELESS_POWERSAVE_DISABLE       = 2,
  96         NM_SETTING_WIRELESS_POWERSAVE_ENABLE        = 3,
  97         _NM_SETTING_WIRELESS_POWERSAVE_NUM, /*< skip >*/
  98         NM_SETTING_WIRELESS_POWERSAVE_LAST          =  _NM_SETTING_WIRELESS_POWERSAVE_NUM - 1, /*< skip >*/
  99 } NMSettingWirelessPowersave;
 100
 101
 102 struct _NMSettingWireless {
 103         NMSetting parent;
 104 };
 105
 106 typedef struct {
 107         NMSettingClass parent;
 108
 109         /*< private >*/
 110         gpointer padding[4];
 111 } NMSettingWirelessClass;
 112
 113 GType nm_setting_wireless_get_type (void);
 114
 115 NMSetting *nm_setting_wireless_new (void);
 116
 117 GBytes           *nm_setting_wireless_get_ssid               (NMSettingWireless *setting);
 118 const char       *nm_setting_wireless_get_mode               (NMSettingWireless *setting);
 119 const char       *nm_setting_wireless_get_band               (NMSettingWireless *setting);
 120 guint32           nm_setting_wireless_get_channel            (NMSettingWireless *setting);
 121 const char       *nm_setting_wireless_get_bssid              (NMSettingWireless *setting);
 122 guint32           nm_setting_wireless_get_rate               (NMSettingWireless *setting);
 123 guint32           nm_setting_wireless_get_tx_power           (NMSettingWireless *setting);
 124 const char       *nm_setting_wireless_get_mac_address        (NMSettingWireless *setting);
 125 const char       *nm_setting_wireless_get_cloned_mac_address (NMSettingWireless *setting);
 126
 127 const char * const *nm_setting_wireless_get_mac_address_blacklist   (NMSettingWireless *setting);
 128 guint32           nm_setting_wireless_get_num_mac_blacklist_items (NMSettingWireless *setting);
 129 const char *      nm_setting_wireless_get_mac_blacklist_item      (NMSettingWireless *setting,
 130                                                                    guint32 idx);
 131 gboolean          nm_setting_wireless_add_mac_blacklist_item      (NMSettingWireless *setting,
 132                                                                    const char *mac);
 133 void              nm_setting_wireless_remove_mac_blacklist_item   (NMSettingWireless *setting,
 134                                                                    guint32 idx);
 135 gboolean          nm_setting_wireless_remove_mac_blacklist_item_by_value (NMSettingWireless *setting,
 136                                                                           const char *mac);
 137 void              nm_setting_wireless_clear_mac_blacklist_items   (NMSettingWireless *setting);
 138
 139 guint32           nm_setting_wireless_get_mtu                (NMSettingWireless *setting);
 140 gboolean          nm_setting_wireless_get_hidden             (NMSettingWireless *setting);
 141 NM_AVAILABLE_IN_1_2
 142 guint32           nm_setting_wireless_get_powersave          (NMSettingWireless *setting);
 143
 144 NM_AVAILABLE_IN_1_2
 145 NMSettingMacRandomization nm_setting_wireless_get_mac_address_randomization (NMSettingWireless *setting);
 146
 147 gboolean          nm_setting_wireless_add_seen_bssid         (NMSettingWireless *setting,
 148                                                               const char *bssid);
 149
 150 guint32           nm_setting_wireless_get_num_seen_bssids    (NMSettingWireless *setting);
 151 const char       *nm_setting_wireless_get_seen_bssid         (NMSettingWireless *setting,
 152                                                               guint32 i);
 153
 154 gboolean          nm_setting_wireless_ap_security_compatible (NMSettingWireless *s_wireless,
 155                                                               NMSettingWirelessSecurity *s_wireless_sec,
 156                                                               NM80211ApFlags ap_flags,
 157                                                               NM80211ApSecurityFlags ap_wpa,
 158                                                               NM80211ApSecurityFlags ap_rsn,
 159                                                               NM80211Mode ap_mode);
 160
 161 G_END_DECLS
 162
 163 #endif /* __NM_SETTING_WIRELESS_H__ */