include/device.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2014  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef __CONNMAN_DEVICE_H
  23 #define __CONNMAN_DEVICE_H
  24
  25 #include <connman/network.h>
  26 #include <connman/service.h>
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /**
  33  * SECTION:device
  34  * @title: Device premitives
  35  * @short_description: Functions for handling devices
  36  */
  37
  38 enum connman_device_type {
  39         CONNMAN_DEVICE_TYPE_UNKNOWN   = 0,
  40         CONNMAN_DEVICE_TYPE_ETHERNET  = 1,
  41         CONNMAN_DEVICE_TYPE_WIFI      = 2,
  42         CONNMAN_DEVICE_TYPE_BLUETOOTH = 3,
  43         CONNMAN_DEVICE_TYPE_CELLULAR  = 4,
  44         CONNMAN_DEVICE_TYPE_GPS       = 5,
  45         CONNMAN_DEVICE_TYPE_GADGET    = 6,
  46         CONNMAN_DEVICE_TYPE_VENDOR    = 10000,
  47 };
  48
  49 #define CONNMAN_DEVICE_PRIORITY_LOW      -100
  50 #define CONNMAN_DEVICE_PRIORITY_DEFAULT     0
  51 #define CONNMAN_DEVICE_PRIORITY_HIGH      100
  52
  53 struct connman_device_scan_params {
  54         enum connman_service_type type;
  55         const char *ssid;
  56         unsigned int ssid_len;
  57         const char *identity;
  58         const char* passphrase;
  59         const char *security;
  60         bool force_full_scan;
  61         void *user_data;
  62 };
  63
  64 struct connman_device;
  65
  66 struct connman_device *connman_device_create(const char *node,
  67                                                 enum connman_device_type type);
  68
  69 #define connman_device_ref(device) \
  70         connman_device_ref_debug(device, __FILE__, __LINE__, __func__)
  71
  72 #define connman_device_unref(device) \
  73         connman_device_unref_debug(device, __FILE__, __LINE__, __func__)
  74
  75 struct connman_device *
  76 connman_device_ref_debug(struct connman_device *device,
  77                         const char *file, int line, const char *caller);
  78 void connman_device_unref_debug(struct connman_device *device,
  79                         const char *file, int line, const char *caller);
  80
  81 enum connman_device_type connman_device_get_type(struct connman_device *device);
  82 void connman_device_set_index(struct connman_device *device, int index);
  83 int connman_device_get_index(struct connman_device *device);
  84 void connman_device_set_interface(struct connman_device *device,
  85                                                 const char *interface);
  86
  87 void connman_device_set_ident(struct connman_device *device,
  88                                                 const char *ident);
  89 const char *connman_device_get_ident(struct connman_device *device);
  90
  91 int connman_device_set_powered(struct connman_device *device,
  92                                                 bool powered);
  93 bool connman_device_get_powered(struct connman_device *device);
  94 int connman_device_set_scanning(struct connman_device *device,
  95                                 enum connman_service_type type, bool scanning);
  96 bool connman_device_get_scanning(struct connman_device *device,
  97                                 enum connman_service_type type);
  98 void connman_device_reset_scanning(struct connman_device *device);
  99
 100 int connman_device_set_string(struct connman_device *device,
 101                                         const char *key, const char *value);
 102 const char *connman_device_get_string(struct connman_device *device,
 103                                                         const char *key);
 104
 105 int connman_device_add_network(struct connman_device *device,
 106                                         struct connman_network *network);
 107 struct connman_network *connman_device_get_network(struct connman_device *device,
 108                                                         const char *identifier);
 109 int connman_device_remove_network(struct connman_device *device,
 110                                         struct connman_network *network);
 111
 112 int connman_device_register(struct connman_device *device);
 113 void connman_device_unregister(struct connman_device *device);
 114
 115 void *connman_device_get_data(struct connman_device *device);
 116 void connman_device_set_data(struct connman_device *device, void *data);
 117
 118 int connman_device_set_regdom(struct connman_device *device,
 119                                                 const char *alpha2);
 120 void connman_device_regdom_notify(struct connman_device *device,
 121                                         int result, const char *alpha2);
 122 struct connman_device *connman_device_create_from_index(int index);
 123 struct connman_device *connman_device_find_by_index(int index);
 124 int connman_device_reconnect_service(struct connman_device *device);
 125
 126 struct connman_device_driver {
 127         const char *name;
 128         enum connman_device_type type;
 129         int priority;
 130         int (*probe) (struct connman_device *device);
 131         void (*remove) (struct connman_device *device);
 132         int (*enable) (struct connman_device *device);
 133         int (*disable) (struct connman_device *device);
 134         int (*scan)(struct connman_device *device,
 135                         struct connman_device_scan_params *params);
 136         void (*stop_scan) (enum connman_service_type type,
 137                         struct connman_device *device);
 138         int (*set_regdom) (struct connman_device *device,
 139                                                 const char *alpha2);
 140 };
 141
 142 int connman_device_driver_register(struct connman_device_driver *driver);
 143 void connman_device_driver_unregister(struct connman_device_driver *driver);
 144
 145 #ifdef __cplusplus
 146 }
 147 #endif
 148
 149 #endif /* __CONNMAN_DEVICE_H */