xref: /btstack/src/ble/gatt-service/scan_parameters_service_server.c (revision 67b65e8f108eb716cb65c6192e677b0f719b3e70)

/*
 * Copyright (C) 2018 BlueKitchen GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 * 4. Any redistribution, use, or modification is done solely for
 *    personal benefit and not for any commercial purpose or for
 *    monetary gain.
 *
 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Please inquire about commercial licensing options at
 * [email protected]
 *
 */

#define BTSTACK_FILE__ "scan_parameters_service_server.c"

/**
 * Implementation of the Nordic SPP-like profile
 *
 * To use with your application, add `#import <scan_parameters_service.gatt>` to your .gatt file
 * and call all functions below. All strings and blobs need to stay valid after calling the functions.
 */

#include <stdint.h>
#include <string.h>

#ifdef ENABLE_TESTING_SUPPORT
#include <stdio.h>
#endif

#include "btstack_defines.h"
#include "ble/att_db.h"
#include "ble/att_server.h"
#include "btstack_util.h"
#include "bluetooth_gatt.h"
#include "btstack_debug.h"

#include "ble/gatt-service/scan_parameters_service_server.h"

static btstack_packet_handler_t                 scan_parameters_packet_handler;
static btstack_context_callback_registration_t  scan_parameters_callback;
static att_service_handler_t                    scan_parameters_service;

static uint16_t scan_interval_window_value_handle;
static uint16_t scan_interval_window_value_handle_client_configuration;


static uint16_t scan_refresh_value_client_configuration;
static hci_con_handle_t scan_refresh_value_client_configuration_connection;

static uint16_t scan_refresh_value_handle;
static uint16_t scan_refresh_value_handle_client_configuration;

static void scan_parameters_service_emit_state(hci_con_handle_t con_handle, uint16_t max_scan_interval, uint16_t min_scan_window){
    if (scan_parameters_packet_handler == NULL) return;

    uint8_t  event[9];
    uint16_t pos = 0;
    event[pos++] = HCI_EVENT_GATTSERVICE_META;
    event[pos++] = sizeof(event) - 2;
    event[pos++] = GATTSERVICE_SUBEVENT_SCAN_PARAMETERS_SERVICE_SCAN_INTERVAL_UPDATE;
    little_endian_store_16(event, pos, (uint16_t) con_handle);
    pos += 2;
    little_endian_store_16(event, pos, max_scan_interval);
    pos += 2;
    little_endian_store_16(event, pos, min_scan_window);
    pos += 2;

    (*scan_parameters_packet_handler)(HCI_EVENT_GATTSERVICE_META, 0, event, pos);
}

static uint16_t scan_parameters_service_read_callback(hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t offset, uint8_t * buffer, uint16_t buffer_size){
    UNUSED(con_handle);
    UNUSED(attribute_handle);
    UNUSED(offset);
    UNUSED(buffer);
    UNUSED(buffer_size);
    if (attribute_handle == scan_refresh_value_handle_client_configuration){
        if (buffer != NULL){
            little_endian_store_16(buffer, 0, scan_refresh_value_client_configuration);
        }
        return 2;
    }
    return 0;
}

static int scan_parameters_service_write_callback(hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t transaction_mode, uint16_t offset, uint8_t *buffer, uint16_t buffer_size){
    UNUSED(offset);
    UNUSED(buffer_size);

    if (transaction_mode != ATT_TRANSACTION_MODE_NONE){
        return 0;
    }

    if (attribute_handle == scan_interval_window_value_handle){
        if (buffer_size == 4){
            uint16_t max_scan_interval = little_endian_read_16(buffer, 0);
            uint16_t min_scan_window   = little_endian_read_16(buffer, 2);
            scan_parameters_service_emit_state(con_handle, max_scan_interval, min_scan_window);
            return ATT_ERROR_SUCCESS;
        } else {
            return ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH;
        }
    }

    if (attribute_handle == scan_refresh_value_handle_client_configuration){
        if (buffer_size == 2){
            scan_refresh_value_client_configuration = little_endian_read_16(buffer, 0);
            scan_refresh_value_client_configuration_connection = con_handle;
            return ATT_ERROR_SUCCESS;
        } else {
            return ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LENGTH;
        }
    }

    return ATT_ERROR_UNLIKELY_ERROR;
}

static void scan_parameters_service_refresh_can_send_now(void * context){
    UNUSED(context);
    const uint8_t value = 0;
    att_server_notify(scan_refresh_value_client_configuration_connection, scan_refresh_value_handle, &value, 1);
}

/**
 * @brief Init Nordic SPP Service Server with ATT DB
 * @param callback for tx data from peer
 */
void scan_parameters_service_server_init(btstack_packet_handler_t packet_handler){
    scan_parameters_packet_handler = packet_handler;

    // get service handle range
    uint16_t start_handle = 0;
    uint16_t end_handle   = 0xffff;
    int service_found = gatt_server_get_handle_range_for_service_with_uuid16(ORG_BLUETOOTH_SERVICE_SCAN_PARAMETERS, &start_handle, &end_handle);
    btstack_assert(service_found != 0);
    UNUSED(service_found);

    // get characteristic value handle and client configuration handle
    scan_interval_window_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_SCAN_INTERVAL_WINDOW);
    scan_interval_window_value_handle_client_configuration = gatt_server_get_client_configuration_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_SCAN_INTERVAL_WINDOW);

    scan_refresh_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_SCAN_REFRESH);
    scan_refresh_value_handle_client_configuration = gatt_server_get_client_configuration_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_SCAN_REFRESH);

    // register service with ATT Server
    scan_parameters_service.start_handle   = start_handle;
    scan_parameters_service.end_handle     = end_handle;
    scan_parameters_service.read_callback  = &scan_parameters_service_read_callback;
    scan_parameters_service.write_callback = &scan_parameters_service_write_callback;
    att_server_register_service_handler(&scan_parameters_service);
}


void scan_parameters_service_server_request_scan_parameters(void){
    if (scan_refresh_value_client_configuration != 0){
        scan_parameters_callback.callback = &scan_parameters_service_refresh_can_send_now;
        scan_parameters_callback.context  = NULL;
        att_server_register_can_send_now_callback(&scan_parameters_callback, scan_refresh_value_client_configuration_connection);
    }
}