ets.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Dipak Shetty
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_ETS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_ETS_H_

 
#include <stdint.h>
#include <stdbool.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif

struct bt_ets_elapsed_time {
        uint8_t flags;
        uint8_t time_value[6];
        uint8_t time_sync_src;
        int8_t tz_dst_offset;
} __packed;


#define BT_ETS_FLAG_TICK_COUNTER BIT(0)

#define BT_ETS_FLAG_UTC BIT(1)

#define BT_ETS_FLAG_RESOLUTION_MASK (BIT(2) | BIT(3))

#define BT_ETS_FLAG_TZ_DST_USED BIT(4)

#define BT_ETS_FLAG_CURRENT_TIMELINE BIT(5)

#define BT_ETS_FLAG_RESERVED_MASK (BIT(6) | BIT(7))


enum bt_ets_time_resolution {
        BT_ETS_RESOLUTION_1_SEC = 0,
        BT_ETS_RESOLUTION_100_MS = 1,
        BT_ETS_RESOLUTION_1_MS = 2,
        BT_ETS_RESOLUTION_100_US = 3,
};


#define BT_ETS_TIME_SOURCE_UNKNOWN          0
#define BT_ETS_TIME_SOURCE_NTP              1
#define BT_ETS_TIME_SOURCE_GPS              2
#define BT_ETS_TIME_SOURCE_RADIO            3
#define BT_ETS_TIME_SOURCE_MANUAL           4
#define BT_ETS_TIME_SOURCE_ATOMIC           5
#define BT_ETS_TIME_SOURCE_CELLULAR         6
#define BT_ETS_TIME_SOURCE_NOT_SYNCHRONIZED 7


enum bt_ets_write_result {
        BT_ETS_WRITE_SUCCESS = 0,
        BT_ETS_WRITE_TIME_SOURCE_TOO_LOW = 1,
        BT_ETS_WRITE_OUT_OF_RANGE = 2,
        BT_ETS_WRITE_INCORRECT_FORMAT = 3,
};

#define BT_ETS_SUPPORTED_FLAGS_MASK                                                                \
        ((IS_ENABLED(CONFIG_BT_ETS_SUPPORT_TICK_COUNTER) ? BT_ETS_FLAG_TICK_COUNTER : 0) |         \
         (IS_ENABLED(CONFIG_BT_ETS_SUPPORT_UTC) ? BT_ETS_FLAG_UTC : 0) |                           \
         (IS_ENABLED(CONFIG_BT_ETS_SUPPORT_TZ_DST) ? BT_ETS_FLAG_TZ_DST_USED : 0) |                \
         (IS_ENABLED(CONFIG_BT_ETS_RESOLUTION_1_SEC)    ? 0                                        \
          : IS_ENABLED(CONFIG_BT_ETS_RESOLUTION_100_MS) ? BIT(2)                                   \
          : IS_ENABLED(CONFIG_BT_ETS_RESOLUTION_1_MS)   ? BIT(3)                                   \
          : IS_ENABLED(CONFIG_BT_ETS_RESOLUTION_100_US) ? (BIT(2) | BIT(3))                        \
                                                        : 0) |                                     \
         BT_ETS_FLAG_CURRENT_TIMELINE)


#define BT_ETS_CLOCK_STATUS_NEEDS_SET BIT(0)
#define BT_ETS_CLOCK_STATUS_RFU_MASK  0xFE



#define BT_ETS_CLOCK_CAP_DST_AUTO BIT(0)
#define BT_ETS_CLOCK_CAP_TZ_AUTO  BIT(1)
#define BT_ETS_CLOCK_CAP_RFU_MASK 0xFC


#define BT_ETS_CLOCK_CAPABILITIES_VALUE                                                            \
        ((IS_ENABLED(CONFIG_BT_ETS_CLOCK_CAP_DST_AUTO) ? BT_ETS_CLOCK_CAP_DST_AUTO : 0) |          \
         (IS_ENABLED(CONFIG_BT_ETS_CLOCK_CAP_TZ_AUTO) ? BT_ETS_CLOCK_CAP_TZ_AUTO : 0))

struct bt_ets_cb {
        int (*read_elapsed_time)(struct bt_ets_elapsed_time *time);

        int (*read_clock_status)(uint8_t *status);

        enum bt_ets_write_result (*write_elapsed_time)(const struct bt_ets_elapsed_time *time);

        void (*indication_changed)(bool enabled);
};

int bt_ets_init(const struct bt_ets_cb *cb);

int bt_ets_indicate(const struct bt_ets_elapsed_time *elapsed_time, uint8_t clock_status);

int bt_ets_time_to_unix_ms(const struct bt_ets_elapsed_time *et_time, int64_t *unix_ms);

int bt_ets_time_from_unix_ms(struct bt_ets_elapsed_time *et_time, int64_t unix_ms, uint8_t time_src,
                             int8_t tz_dst_offset);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_ETS_H_ */