zigbee-daemon/zigbee-lib/src/zblib_plugin.c

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved.
   3  *
   4  * Contact: Suresh Kumar N (suresh.n@samsung.com)
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #include <dlfcn.h>
  20
  21 #include <zblib.h>
  22 #include <zblib_plugin.h>
  23 #include <zblib_driver.h>
  24 #include <zblib_service.h>
  25 #include <zblib_request.h>
  26
  27 /**< ZigBee plug-in object */
  28 struct zblib_plugin_type {
  29         gchar *plugin_name; /**< ZigBee plug-in name */
  30         const ZblibPluginDescriptor_t *descriptor; /**< ZigBee plug-in descriptor */
  31         void *plugin_handle; /**< ZigBee Plug-in .so handle */
  32
  33         GSList *driver_list; /**< List of ZigBee drivers */
  34
  35         ZigBeeService *service; /**< ZigBee Service */
  36 };
  37
  38 ZigBeePlugin *zblib_plugin_new(ZigBeeService *service,
  39         const gchar *plugin_name,
  40         const ZblibPluginDescriptor_t *descriptor,
  41         void *plugin_handle)
  42 {
  43         ZigBeePlugin *plugin = NULL;
  44
  45         /* Allocate memory */
  46         plugin = g_malloc0(sizeof(ZigBeePlugin));
  47
  48         /* Update fields */
  49         plugin->plugin_name = g_strdup(plugin_name);
  50         plugin->descriptor = descriptor;
  51         plugin->plugin_handle = plugin_handle;
  52         plugin->service = service;
  53
  54         Z_LOGI("Vendor plug-in created - Name [%s]", descriptor->name);
  55
  56         return plugin;
  57 }
  58
  59 void zblib_plugin_free(ZigBeePlugin *plugin)
  60 {
  61         zblib_check_null_ret("plugin", plugin);
  62
  63         Z_LOGI("Freeing Vendor plug-in - Name [%s]", plugin->descriptor->name);
  64
  65         if (plugin->driver_list) {
  66                 GSList *list;
  67                 ZigBeeDriver *driver;
  68
  69                 for (list = plugin->driver_list; list; list = list->next) {
  70                         driver = list->data;
  71                         if (NULL == driver)
  72                                 continue;
  73
  74                         zblib_driver_free(driver);
  75                         list->data = NULL;
  76                 }
  77
  78                 g_slist_free(plugin->driver_list);
  79                 plugin->driver_list = NULL;
  80         }
  81
  82         if (plugin->plugin_name) {
  83                 g_free(plugin->plugin_name);
  84                 plugin->plugin_name = NULL;
  85         }
  86
  87         plugin->descriptor = NULL;
  88
  89         if (plugin->plugin_handle) {
  90                 dlclose(plugin->plugin_handle);
  91                 plugin->plugin_handle = NULL;
  92         }
  93
  94         g_free(plugin);
  95 }
  96
  97 const ZblibPluginDescriptor_t *zblib_plugin_get_descriptor(ZigBeePlugin *plugin)
  98 {
  99         zblib_check_null_ret_error("plugin", plugin, NULL);
 100
 101         return plugin->descriptor;
 102 }
 103
 104 char *zblib_plugin_get_plugin_name(ZigBeePlugin *plugin)
 105 {
 106         zblib_check_null_ret_error("plugin", plugin, NULL);
 107
 108         return g_strdup(plugin->plugin_name);
 109 }
 110
 111 ZigBeeService *zblib_plugin_ref_service(ZigBeePlugin *plugin)
 112 {
 113         zblib_check_null_ret_error("plugin", plugin, NULL);
 114
 115         return plugin->service;
 116 }
 117
 118 ZigBeeDriver *zblib_plugin_ref_driver(ZigBeePlugin *plugin, ZblibDriverType_e driver_type)
 119 {
 120         ZigBeeDriver *driver = NULL;
 121         ZblibDriverType_e _driver_type;
 122         GSList *list = NULL;
 123
 124         zblib_check_null_ret_error("plugin", plugin, NULL);
 125
 126         list = plugin->driver_list;
 127         while (list) {
 128                 /* Fetch driver type of driver */
 129                 _driver_type = zblib_driver_ref_driver_type((ZigBeeDriver *)(list->data));
 130                 if (_driver_type == driver_type) {
 131                         /* Driver found */
 132                         driver = (ZigBeeDriver *)(list->data);
 133                         break;
 134                 }
 135
 136                 /* Move to next driver */
 137                 list = g_slist_next(list);
 138         }
 139
 140         return driver;
 141 }
 142
 143 void zblib_plugin_link_driver(ZigBeePlugin *plugin, ZigBeeDriver *driver)
 144 {
 145         zblib_check_null_ret("plugin", plugin);
 146         zblib_check_null_ret("driver", driver);
 147
 148         plugin->driver_list = g_slist_append(plugin->driver_list, driver);
 149         Z_LOGD("Driver appended into plugin [%s]", plugin->plugin_name);
 150 }
 151
 152 void zblib_plugin_unlink_driver(ZigBeePlugin *plugin, ZblibDriverType_e driver_type)
 153 {
 154         ZblibDriverType_e _driver_type;
 155         GSList *list = NULL;
 156
 157         zblib_check_null_ret("plugin", plugin);
 158
 159         list = plugin->driver_list;
 160         while (list) {
 161                 /* Fetch driver type of driver */
 162                 _driver_type = zblib_driver_ref_driver_type((ZigBeeDriver *)(list->data));
 163                 if (_driver_type == driver_type) {
 164                         /* Driver found */
 165                         Z_LOGD("Driver[%p] removed from plugin", list->data);
 166                         list->data = NULL;
 167                         break;
 168                 }
 169
 170                 /* Move to next driver */
 171                 list = g_slist_next(list);
 172         }
 173 }
 174
 175 gboolean zblib_plugin_dispatch_request(ZigBeePlugin *plugin,
 176         guint request_id)
 177 {
 178         ZigBeeService *service = NULL;
 179         ZigBeeDriver *driver = NULL;
 180         ZblibDriverType_e driver_type;
 181         guint request_type;
 182
 183         zblib_check_null_ret_error("plugin", plugin, FALSE);
 184
 185         /* Fetch service */
 186         service = plugin->service;
 187         zblib_check_null_ret_error("service", service, FALSE);
 188
 189         /* Fetch driver type */
 190         request_type = zblib_request_ref_request_type_by_request_id(service, request_id);
 191         driver_type = zblib_request_get_driver_type(request_type);
 192
 193         /* Fetch driver */
 194         driver = zblib_plugin_ref_driver(plugin, driver_type);
 195         zblib_check_null_ret_error("driver", driver, FALSE);
 196
 197         /* Dispatch request to driver */
 198         return zblib_driver_dispatch_request(driver, request_id);
 199 }
 200
 201 void zblib_plugin_send_response(ZigBeePlugin *plugin,
 202         guint request_id, gpointer resp_data, guint resp_data_len)
 203 {
 204         ZigBeeService *service = NULL;
 205
 206         zblib_check_null_ret("plugin", plugin);
 207
 208         service = plugin->service;
 209         zblib_check_null_ret("service", service);
 210
 211         /* Send response to service */
 212         zblib_service_send_response(service,
 213                 request_id, resp_data, resp_data_len);
 214 }
 215
 216 void zblib_plugin_send_notification(ZigBeePlugin *plugin,
 217         guint noti_id, gpointer noti_data, guint noti_data_len)
 218 {
 219         ZigBeeService *service = NULL;
 220
 221         zblib_check_null_ret("plugin", plugin);
 222
 223         service = plugin->service;
 224         zblib_check_null_ret("service", service);
 225
 226         /* Send notification to service */
 227         zblib_service_send_notification(service,
 228                 noti_id, noti_data, noti_data_len);
 229 }