sol-gatt.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2016 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <sol-bluetooth.h>

#ifdef __cplusplus
extern "C" {
#endif

enum sol_gatt_attr_type {
    SOL_GATT_ATTR_TYPE_INVALID,
    SOL_GATT_ATTR_TYPE_SERVICE,
    SOL_GATT_ATTR_TYPE_CHARACTERISTIC,
    SOL_GATT_ATTR_TYPE_DESCRIPTOR,
};

enum sol_gatt_chr_flags {
    SOL_GATT_CHR_FLAGS_BROADCAST = (1 << 0),
    SOL_GATT_CHR_FLAGS_READ = (1 << 1),
    SOL_GATT_CHR_FLAGS_WRITE_WITHOUT_RESPONSE = (1 << 2),
    SOL_GATT_CHR_FLAGS_WRITE = (1 << 3),
    SOL_GATT_CHR_FLAGS_NOTIFY = (1 << 4),
    SOL_GATT_CHR_FLAGS_INDICATE = (1 << 5),
    SOL_GATT_CHR_FLAGS_AUTHENTICATED_SIGNED_WRITES = (1 << 6),
    SOL_GATT_CHR_FLAGS_RELIABLE_WRITE = (1 << 7),
    SOL_GATT_CHR_FLAGS_WRITABLE_AUXILIARIES = (1 << 8),
    SOL_GATT_CHR_FLAGS_ENCRYPT_READ = (1 << 9),
    SOL_GATT_CHR_FLAGS_ENCRYPT_WRITE = (1 << 10),
    SOL_GATT_CHR_FLAGS_ENCRYPT_AUTHENTICATED_READ = (1 << 11),
    SOL_GATT_CHR_FLAGS_ENCRYPT_AUTHENTICATED_WRITE = (1 << 12),
};

enum sol_gatt_desc_flags {
    SOL_GATT_DESC_FLAGS_READ = (1 << 0),
    SOL_GATT_DESC_FLAGS_WRITE = (1 << 1),
    SOL_GATT_DESC_FLAGS_ENCRYPT_READ = (1 << 2),
    SOL_GATT_DESC_FLAGS_ENCRYPT_WRITE = (1 << 3),
    SOL_GATT_DESC_FLAGS_ENCRYPT_AUTHENTICATED_READ = (1 << 4),
    SOL_GATT_DESC_FLAGS_ENCRYPT_AUTHENTICATED_WRITE = (1 << 5),
};

struct sol_gatt_pending;
typedef struct sol_gatt_pending sol_gatt_pending;

const struct sol_gatt_attr *sol_gatt_pending_get_attr(
    const struct sol_gatt_pending *op);

typedef struct sol_gatt_attr {
    struct sol_bt_uuid uuid;
    enum sol_gatt_attr_type type;
    uint16_t flags;
    int (*read)(struct sol_gatt_pending *op,
        uint16_t offset);
    int (*write)(struct sol_gatt_pending *op,
        struct sol_buffer *buf,
        uint16_t offset);

    void *user_data;

    void *_priv;
} sol_gatt_attr;

int sol_gatt_pending_reply(struct sol_gatt_pending *pending,
    int error,
    struct sol_buffer *buf);

#define SOL_GATT_SERVICE_UUID_16(service_uuid) \
    { .type = SOL_GATT_ATTR_TYPE_SERVICE, \
      .uuid = { .type = SOL_BT_UUID_TYPE_16, \
                .val16 = (service_uuid) } }

#define SOL_GATT_CHARACTERISTIC_UUID_16(_uuid, _flags, ...) \
    { .type = SOL_GATT_ATTR_TYPE_CHARACTERISTIC, \
      .uuid = { .type = SOL_BT_UUID_TYPE_16, \
                .val16 = (_uuid) }, \
      .flags = (_flags), \
      __VA_ARGS__ }

#define SOL_GATT_DESCRIPTOR_UUID_16(_uuid, _flags, ...) \
    { .type = SOL_GATT_ATTR_TYPE_DESCRIPTOR, \
      .uuid = { .type = SOL_BT_UUID_TYPE_16, \
                .val16 = (_uuid) }, \
      .flags = (_flags), \
      __VA_ARGS__ }

#define SOL_GATT_ATTR_INVALID { .type = SOL_GATT_ATTR_TYPE_INVALID }

int sol_gatt_register_attributes(struct sol_gatt_attr *attrs);

int sol_gatt_unregister_attributes(struct sol_gatt_attr *attrs);

int sol_gatt_read_attr(struct sol_bt_conn *conn, struct sol_gatt_attr *attr,
    void (*cb)(void *user_data, bool success,
    const struct sol_gatt_attr *attr,
    const struct sol_buffer *buf),
    const void *user_data);

int sol_gatt_write_attr(struct sol_bt_conn *conn, struct sol_gatt_attr *attr,
    struct sol_buffer *buf,
    void (*cb)(void *user_data, bool success,
    const struct sol_gatt_attr *attr),
    const void *user_data);

int sol_gatt_discover(struct sol_bt_conn *conn, enum sol_gatt_attr_type type,
    const struct sol_gatt_attr *parent,
    const struct sol_bt_uuid *uuid,
    bool (*cb)(void *user_data, struct sol_bt_conn *conn,
    const struct sol_gatt_attr *attr),
    const void *user_data);

int sol_gatt_subscribe(struct sol_bt_conn *conn, const struct sol_gatt_attr *attr,
    bool (*cb)(void *user_data, const struct sol_gatt_attr *attr,
    const struct sol_buffer *buffer),
    const void *user_data);

int sol_gatt_unsubscribe(bool (*cb)(void *user_data, const struct sol_gatt_attr *attr,
    const struct sol_buffer *buffer),
    const void *user_data);

int sol_gatt_indicate(struct sol_bt_conn *conn, const struct sol_gatt_attr *attr);

int sol_gatt_notify(struct sol_bt_conn *conn, const struct sol_gatt_attr *attr);

#ifdef __cplusplus
}
#endif