nsms.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_NSMS_H_
#define BT_NSMS_H_
 
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/uuid.h>
#include <zephyr/bluetooth/gatt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_UUID_NSMS_VAL \
        BT_UUID_128_ENCODE(0x57a70000, 0x9350, 0x11ed, 0xa1eb, 0x0242ac120002)
 
#define BT_UUID_NSMS_STATUS_VAL \
        BT_UUID_128_ENCODE(0x57a70001, 0x9350, 0x11ed, 0xa1eb, 0x0242ac120002)
 
#define BT_UUID_NSMS_SERVICE   BT_UUID_DECLARE_128(BT_UUID_NSMS_VAL)
#define BT_UUID_NSMS_STATUS    BT_UUID_DECLARE_128(BT_UUID_NSMS_STATUS_VAL)
 
 
struct bt_nsms_status_str {
        struct k_mutex *mtx;
        size_t size;
        char *buf;
};
 
struct bt_nsms {
        const struct bt_gatt_attr *status_attr;
};
 
ssize_t bt_nsms_status_read(struct bt_conn *conn,
                            struct bt_gatt_attr const *attr,
                            void *buf, uint16_t len, uint16_t offset);
 
#define BT_NSMS_SECURITY_LEVEL_NONE     0
#define BT_NSMS_SECURITY_LEVEL_ENCRYPT  1
#define BT_NSMS_SECURITY_LEVEL_AUTHEN   2
 
#define _BT_NSMS_CH_READ_PERM(_slevel) ((_slevel == BT_NSMS_SECURITY_LEVEL_AUTHEN) ?  \
                                        (BT_GATT_PERM_READ_AUTHEN) : \
                                        (_slevel == BT_NSMS_SECURITY_LEVEL_ENCRYPT) ? \
                                        (BT_GATT_PERM_READ_ENCRYPT) : \
                                        (BT_GATT_PERM_READ) \
                                        )
 
#define _BT_NSMS_CH_WRITE_PERM(_slevel) ((_slevel == BT_NSMS_SECURITY_LEVEL_AUTHEN) ? \
                                        (BT_GATT_PERM_WRITE_AUTHEN) : \
                                        (_slevel == BT_NSMS_SECURITY_LEVEL_ENCRYPT) ? \
                                        (BT_GATT_PERM_WRITE_ENCRYPT) : \
                                        (BT_GATT_PERM_WRITE) \
                                        )
 
/* @note:
 * The macro is required to provide proper arguments expansion as we are using name concatenation.
 * This allow proper double argument expansion.
 */
#define BT_NSMS_SERVICE_DEF(_name, ...) \
        BT_GATT_SERVICE_DEFINE(_name, __VA_ARGS__)
 
#define BT_NSMS_DEF(_nsms, _name, _slevel, _status_init, _len_max)                      \
        static K_MUTEX_DEFINE(_CONCAT(_nsms, _status_mtx));                             \
        static char _CONCAT(_nsms, _status_buf)[_len_max] = _status_init;               \
        static const struct bt_nsms_status_str _CONCAT(_nsms, _status_str) = {          \
                .mtx = &_CONCAT(_nsms, _status_mtx),                                    \
                .size = (_len_max),                                                     \
                .buf = _CONCAT(_nsms, _status_buf)                                      \
        };                                                                              \
        BT_NSMS_SERVICE_DEF(_CONCAT(_nsms, _svc),                                       \
                BT_GATT_PRIMARY_SERVICE(BT_UUID_NSMS_SERVICE),                          \
                        BT_GATT_CHARACTERISTIC(BT_UUID_NSMS_STATUS,                     \
                                               BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
                                               _BT_NSMS_CH_READ_PERM(_slevel),          \
                                               bt_nsms_status_read,                     \
                                               NULL,                                    \
                                               (void *)&_CONCAT(_nsms, _status_str)),   \
                        BT_GATT_CCC(NULL, _BT_NSMS_CH_READ_PERM(_slevel) |              \
                                          _BT_NSMS_CH_WRITE_PERM(_slevel)),             \
                        BT_GATT_CUD(_name, _BT_NSMS_CH_READ_PERM(_slevel)),             \
        );                                                                              \
        static const struct bt_nsms _nsms = {                                           \
                .status_attr = &_CONCAT(_nsms, _svc).attrs[2],                          \
        }
 
int bt_nsms_set_status(const struct bt_nsms *nsms_obj, const char *status);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* BT_NSMS_H_ */