nrf: Move the Service class from ubluepy to the shared bleio module

Author: arturo182

ports/nrf/Makefile

@@ -130,7 +130,6 @@ SRC_C += \
 DRIVERS_SRC_C += $(addprefix modules/,\
 	ubluepy/modubluepy.c \
 	ubluepy/ubluepy_peripheral.c \
-	ubluepy/ubluepy_service.c \
 	)
 
 SRC_COMMON_HAL += \
@@ -165,6 +164,7 @@ SRC_COMMON_HAL += \
 	bleio/Characteristic.c \
 	bleio/Descriptor.c \
 	bleio/Scanner.c \
+	bleio/Service.c \
 	bleio/UUID.c
 endif
 

ports/nrf/common-hal/bleio/Characteristic.c

@@ -36,8 +36,8 @@ void common_hal_bleio_characteristic_read_value(bleio_characteristic_obj_t *self
 }
 
 void common_hal_bleio_characteristic_write_value(bleio_characteristic_obj_t *self, mp_buffer_info_t *bufinfo) {
-    ubluepy_service_obj_t *service = MP_OBJ_TO_PTR(self->service);
-    ubluepy_role_type_t role = service->p_periph->role;
+    ubluepy_peripheral_obj_t *peripheral = MP_OBJ_TO_PTR(self->service->periph);
+    ubluepy_role_type_t role = peripheral->role;
 
     if (role == UBLUEPY_ROLE_PERIPHERAL) {
         // TODO: Add indications

ports/nrf/common-hal/bleio/Service.c

@@ -0,0 +1,38 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Artur Pacholec
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "ble_drv.h"
+#include "shared-module/bleio/Service.h"
+
+void common_hal_bleio_service_construct(bleio_service_obj_t *self) {
+    ble_drv_service_add(self);
+}
+
+void common_hal_bleio_service_add_characteristic(bleio_service_obj_t *self, bleio_characteristic_obj_t *characteristic) {
+    if (ble_drv_characteristic_add(characteristic)) {
+        characteristic->service = self;
+    }
+}

ports/nrf/drivers/bluetooth/ble_drv.c

@@ -267,26 +267,29 @@ bool ble_drv_uuid_add_vs(uint8_t * p_uuid, uint8_t * idx) {
     return true;
 }
 
-bool ble_drv_service_add(ubluepy_service_obj_t * p_service_obj) {
+void ble_drv_service_add(bleio_service_obj_t *service) {
     SD_TEST_OR_ENABLE();
 
-    ble_uuid_t uuid;
-    uuid.type = BLE_UUID_TYPE_BLE;
-    uuid.uuid = p_service_obj->p_uuid->value[0] | (p_service_obj->p_uuid->value[1] << 8);
+    ble_uuid_t uuid = {
+        .type = BLE_UUID_TYPE_BLE,
+        .uuid = service->uuid->value[0] | (service->uuid->value[1] << 8)
+    };
 
-    if (p_service_obj->p_uuid->type == UUID_TYPE_128BIT) {
-        uuid.type  = p_service_obj->p_uuid->uuid_vs_idx;
+    if (service->uuid->type == UUID_TYPE_128BIT) {
+        uuid.type = service->uuid->uuid_vs_idx;
     }
 
-    uint32_t err_code = sd_ble_gatts_service_add(p_service_obj->type,
-                                                 &uuid,
-                                                 &p_service_obj->handle);
-    if (err_code != 0) {
-        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError,
-                  translate("Can not add Service. status: 0x%08lX"), err_code));
+    uint8_t service_type = BLE_GATTS_SRVC_TYPE_PRIMARY;
+    if (service->is_secondary) {
+        service_type = BLE_GATTS_SRVC_TYPE_SECONDARY;
     }
 
-    return true;
+    if (sd_ble_gatts_service_add(service_type,
+                                 &uuid,
+                                 &service->handle) != 0) {
+        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError,
+                  translate("Can not add Service.")));
+    }
 }
 
 bool ble_drv_characteristic_add(bleio_characteristic_obj_t *characteristic) {
@@ -320,7 +323,7 @@ bool ble_drv_characteristic_add(bleio_characteristic_obj_t *characteristic) {
         char_md.p_cccd_md = NULL;
     }
 
-    uuid.type  = BLE_UUID_TYPE_BLE;
+    uuid.type = BLE_UUID_TYPE_BLE;
     if (characteristic->uuid->type == UUID_TYPE_128BIT)
         uuid.type = characteristic->uuid->uuid_vs_idx;
 
@@ -416,12 +419,12 @@ bool ble_drv_advertise_data(ubluepy_advertise_data_t * p_adv_params) {
         bool type_128bit_present = false;
 
         for (uint8_t i = 0; i < p_adv_params->num_of_services; i++) {
-            ubluepy_service_obj_t * p_service = (ubluepy_service_obj_t *)p_adv_params->p_services[i];
-            if (p_service->p_uuid->type == UUID_TYPE_16BIT) {
+            bleio_service_obj_t * p_service = (bleio_service_obj_t *)p_adv_params->p_services[i];
+            if (p_service->uuid->type == UUID_TYPE_16BIT) {
                 type_16bit_present = true;
             }
 
-            if (p_service->p_uuid->type == UUID_TYPE_128BIT) {
+            if (p_service->uuid->type == UUID_TYPE_128BIT) {
                 type_128bit_present = true;
             }
         }
@@ -439,12 +442,12 @@ bool ble_drv_advertise_data(ubluepy_advertise_data_t * p_adv_params) {
             uint8_t encoded_size    = 0;
 
             for (uint8_t i = 0; i < p_adv_params->num_of_services; i++) {
-                ubluepy_service_obj_t * p_service = (ubluepy_service_obj_t *)p_adv_params->p_services[i];
+                bleio_service_obj_t * p_service = (bleio_service_obj_t *)p_adv_params->p_services[i];
 
                 ble_uuid_t uuid;
-                uuid.type  = p_service->p_uuid->type;
-                uuid.uuid  = p_service->p_uuid->value[0];
-                uuid.uuid += p_service->p_uuid->value[1] << 8;
+                uuid.type  = p_service->uuid->type;
+                uuid.uuid  = p_service->uuid->value[0];
+                uuid.uuid += p_service->uuid->value[1] << 8;
                 // calculate total size of uuids
                 if (sd_ble_uuid_encode(&uuid, &encoded_size, NULL) != 0) {
                     nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_OSError,
@@ -488,12 +491,12 @@ bool ble_drv_advertise_data(ubluepy_advertise_data_t * p_adv_params) {
             uint8_t encoded_size    = 0;
 
             for (uint8_t i = 0; i < p_adv_params->num_of_services; i++) {
-                ubluepy_service_obj_t * p_service = (ubluepy_service_obj_t *)p_adv_params->p_services[i];
+                bleio_service_obj_t * p_service = (bleio_service_obj_t *)p_adv_params->p_services[i];
 
                 ble_uuid_t uuid;
-                uuid.type  = p_service->p_uuid->uuid_vs_idx;
-                uuid.uuid  = p_service->p_uuid->value[0];
-                uuid.uuid += p_service->p_uuid->value[1] << 8;
+                uuid.type  = p_service->uuid->uuid_vs_idx;
+                uuid.uuid  = p_service->uuid->value[0];
+                uuid.uuid += p_service->uuid->value[1] << 8;
 
                 // calculate total size of uuids
                 if (sd_ble_uuid_encode(&uuid, &encoded_size, NULL) != 0) {
@@ -640,8 +643,8 @@ void ble_drv_attr_s_read(uint16_t conn_handle, uint16_t handle, uint16_t len, ui
 }
 
 void ble_drv_attr_s_write(bleio_characteristic_obj_t *characteristic, mp_buffer_info_t *bufinfo) {
-    ubluepy_service_obj_t *service = MP_OBJ_TO_PTR(characteristic->service);
-    uint16_t conn_handle = service->p_periph->conn_handle;
+    ubluepy_peripheral_obj_t *peripheral = MP_OBJ_TO_PTR(characteristic->service->periph);
+    uint16_t conn_handle = peripheral->conn_handle;
     ble_gatts_value_t gatts_value;
 
     memset(&gatts_value, 0, sizeof(gatts_value));
@@ -659,8 +662,8 @@ void ble_drv_attr_s_write(bleio_characteristic_obj_t *characteristic, mp_buffer_
 }
 
 void ble_drv_attr_s_notify(bleio_characteristic_obj_t *characteristic, mp_buffer_info_t *bufinfo) {
-    ubluepy_service_obj_t *service = MP_OBJ_TO_PTR(characteristic->service);
-    uint16_t conn_handle = service->p_periph->conn_handle;
+    ubluepy_peripheral_obj_t *peripheral = MP_OBJ_TO_PTR(characteristic->service->periph);
+    uint16_t conn_handle = peripheral->conn_handle;
     ble_gatts_hvx_params_t hvx_params;
     uint16_t hvx_len = bufinfo->len;
 
@@ -706,11 +709,13 @@ void ble_drv_adv_report_handler_set(bleio_scanner_obj_t *self, ble_drv_adv_evt_c
 
 
 void ble_drv_attr_c_read(bleio_characteristic_obj_t *characteristic, ble_drv_gattc_char_data_callback_t cb) {
-    ubluepy_service_obj_t *service = MP_OBJ_TO_PTR(characteristic->service);
+    bleio_service_obj_t *service = characteristic->service;
+    ubluepy_peripheral_obj_t *peripheral = MP_OBJ_TO_PTR(service->periph);
+
     mp_gattc_char_data_observer = characteristic;
     gattc_char_data_handle = cb;
 
-    const uint32_t err_code = sd_ble_gattc_read(service->p_periph->conn_handle,
+    const uint32_t err_code = sd_ble_gattc_read(peripheral->conn_handle,
                                           characteristic->handle,
                                           0);
     if (err_code != 0) {
@@ -724,8 +729,8 @@ void ble_drv_attr_c_read(bleio_characteristic_obj_t *characteristic, ble_drv_gat
 }
 
 void ble_drv_attr_c_write(bleio_characteristic_obj_t *characteristic, mp_buffer_info_t *bufinfo) {
-    ubluepy_service_obj_t *service = MP_OBJ_TO_PTR(characteristic->service);
-    uint16_t conn_handle = service->p_periph->conn_handle;
+    ubluepy_peripheral_obj_t *peripheral = MP_OBJ_TO_PTR(characteristic->service->periph);
+    uint16_t conn_handle = peripheral->conn_handle;
 
     ble_gattc_write_params_t write_params;
     write_params.write_op = BLE_GATT_OP_WRITE_REQ;

ports/nrf/drivers/bluetooth/ble_drv.h

@@ -34,6 +34,7 @@
 
 #include "shared-module/bleio/Characteristic.h"
 #include "shared-module/bleio/Scanner.h"
+#include "shared-module/bleio/Service.h"
 
 #include "modubluepy.h"
 
@@ -92,7 +93,7 @@ void ble_drv_address_get(ble_drv_addr_t * p_addr);
 
 bool ble_drv_uuid_add_vs(uint8_t * p_uuid, uint8_t * idx);
 
-bool ble_drv_service_add(ubluepy_service_obj_t * p_service_obj);
+void ble_drv_service_add(bleio_service_obj_t *service);
 
 bool ble_drv_characteristic_add(bleio_characteristic_obj_t *characteristic);
 

ports/nrf/modules/ubluepy/modubluepy.c

@@ -36,7 +36,6 @@ STATIC const mp_rom_map_elem_t mp_module_ubluepy_globals_table[] = {
 #if MICROPY_PY_UBLUEPY_PERIPHERAL
     { MP_ROM_QSTR(MP_QSTR_Peripheral),      MP_ROM_PTR(&ubluepy_peripheral_type) },
 #endif
-    { MP_ROM_QSTR(MP_QSTR_Service),         MP_ROM_PTR(&ubluepy_service_type) },
 };
 
 STATIC MP_DEFINE_CONST_DICT(mp_module_ubluepy_globals, mp_module_ubluepy_globals_table);

ports/nrf/modules/ubluepy/modubluepy.h

@@ -74,14 +74,8 @@ p.advertise(device_name="micr", services=[s])
 #include "common-hal/bleio/UUID.h"
 #include "py/obj.h"
 
-extern const mp_obj_type_t ubluepy_service_type;
 extern const mp_obj_type_t ubluepy_peripheral_type;
 
-typedef enum {
-    UBLUEPY_SERVICE_PRIMARY = 1,
-    UBLUEPY_SERVICE_SECONDARY = 2
-} ubluepy_service_type_t;
-
 typedef enum {
     UBLUEPY_ADDR_TYPE_PUBLIC = 0,
     UBLUEPY_ADDR_TYPE_RANDOM_STATIC = 1,
@@ -104,17 +98,6 @@ typedef struct _ubluepy_peripheral_obj_t {
     mp_obj_t            service_list;
 } ubluepy_peripheral_obj_t;
 
-typedef struct _ubluepy_service_obj_t {
-    mp_obj_base_t              base;
-    uint16_t                   handle;
-    uint8_t                    type;
-    bleio_uuid_obj_t         * p_uuid;
-    ubluepy_peripheral_obj_t * p_periph;
-    mp_obj_t                   char_list;
-    uint16_t                   start_handle;
-    uint16_t                   end_handle;
-} ubluepy_service_obj_t;
-
 typedef struct _ubluepy_advertise_data_t {
     uint8_t *  p_device_name;
     uint8_t    device_name_len;

ports/nrf/modules/ubluepy/ubluepy_peripheral.c

@@ -35,6 +35,7 @@
 #include "ble_drv.h"
 #include "common-hal/bleio/UUID.h"
 #include "shared-bindings/bleio/Characteristic.h"
+#include "shared-bindings/bleio/Service.h"
 #include "shared-bindings/bleio/UUID.h"
 
 STATIC void ubluepy_peripheral_print(const mp_print_t *print, mp_obj_t o, mp_print_kind_t kind) {
@@ -271,9 +272,9 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(ubluepy_peripheral_disconnect_obj, peripheral_d
 ///
 STATIC mp_obj_t peripheral_add_service(mp_obj_t self_in, mp_obj_t service) {
     ubluepy_peripheral_obj_t * self = MP_OBJ_TO_PTR(self_in);
-    ubluepy_service_obj_t    * p_service = MP_OBJ_TO_PTR(service);
+    bleio_service_obj_t    * p_service = MP_OBJ_TO_PTR(service);
 
-    p_service->p_periph = self;
+    p_service->periph = self_in;
 
     mp_obj_list_append(self->service_list, service);
 
@@ -294,13 +295,13 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(ubluepy_peripheral_get_services_obj, peripheral
 #if MICROPY_PY_UBLUEPY_CENTRAL
 
 void static disc_add_service(mp_obj_t self, ble_drv_service_data_t * p_service_data) {
-    ubluepy_service_obj_t * p_service = m_new_obj(ubluepy_service_obj_t);
-    p_service->base.type = &ubluepy_service_type;
+    bleio_service_obj_t * p_service = m_new_obj(bleio_service_obj_t);
+    p_service->base.type = &bleio_service_type;
 
     bleio_uuid_obj_t * p_uuid = m_new_obj(bleio_uuid_obj_t);
     p_uuid->base.type = &bleio_uuid_type;
 
-    p_service->p_uuid = p_uuid;
+    p_service->uuid = p_uuid;
 
     p_uuid->type = p_service_data->uuid_type;
     p_uuid->value[0] = p_service_data->uuid & 0xFF;
@@ -316,7 +317,7 @@ void static disc_add_service(mp_obj_t self, ble_drv_service_data_t * p_service_d
 }
 
 void static disc_add_char(mp_obj_t service_in, ble_drv_char_data_t * p_desc_data) {
-    ubluepy_service_obj_t        * p_service   = MP_OBJ_TO_PTR(service_in);
+    bleio_service_obj_t        * p_service   = MP_OBJ_TO_PTR(service_in);
     bleio_characteristic_obj_t * p_char = m_new_obj(bleio_characteristic_obj_t);
     p_char->base.type = &bleio_characteristic_type;
 
@@ -410,7 +411,7 @@ STATIC mp_obj_t peripheral_connect(mp_uint_t n_args, const mp_obj_t *pos_args, m
         mp_uint_t  num_services;
         mp_obj_get_array(self->service_list, &num_services, &services);
 
-        ubluepy_service_obj_t * p_service = (ubluepy_service_obj_t *)services[num_services - 1];
+        bleio_service_obj_t * p_service = (bleio_service_obj_t *)services[num_services - 1];
 
         service_disc_retval = ble_drv_discover_services(self,
                                                         self->conn_handle,
@@ -424,7 +425,7 @@ STATIC mp_obj_t peripheral_connect(mp_uint_t n_args, const mp_obj_t *pos_args, m
     mp_obj_get_array(self->service_list, &num_services, &services);
 
     for (uint16_t s = 0; s < num_services; s++) {
-        ubluepy_service_obj_t * p_service = (ubluepy_service_obj_t *)services[s];
+        bleio_service_obj_t * p_service = (bleio_service_obj_t *)services[s];
         bool char_disc_retval = ble_drv_discover_characteristic(p_service,
                                                                 self->conn_handle,
                                                                 p_service->start_handle,