ble/util/timing_mapper.h header reference
[Bluetooth Low Energy library module]

The source code of this header can be browsed online.

Description [link]

this header contains all declarations for the Timing Mapper utility object.

Members [link]

Type [link]

struct ble_timing_mapper_s

Functions [link]

void ble_timing_mapper_cleanup(struct ble_timing_mapper_s *tm)
void ble_timing_mapper_event_set(struct ble_timing_mapper_s *tm, uint16_t event, dev_timer_value_t anchor)
error_t ble_timing_mapper_master_init(struct ble_timing_mapper_s *tm, struct device_timer_s *timer, const struct ble_adv_connect_s *connect, dev_timer_value_t reference)
error_t ble_timing_mapper_slave_init(struct ble_timing_mapper_s *tm, struct device_timer_s *timer, const struct ble_adv_connect_s *connect, dev_timer_value_t reference)
error_t ble_timing_mapper_update_push(struct ble_timing_mapper_s *tm, const struct ble_conn_params_update *update)
void ble_timing_mapper_window_master_get(struct ble_timing_mapper_s *tm, uint16_t event, dev_timer_value_t *begin, dev_timer_value_t *end, dev_timer_delay_t *max_duration)
void ble_timing_mapper_window_slave_get(struct ble_timing_mapper_s *tm, uint16_t event, dev_timer_value_t *begin, dev_timer_value_t *end, dev_timer_delay_t *max_duration)

Members detail [link]

#define BLE_UTIL_TIMING_H_ [link]

This macro is declared in ble/util/timing_mapper.h source file, line 21.

void ble_timing_mapper_cleanup(struct ble_timing_mapper_s *tm) [link]

This function is declared in ble/util/timing_mapper.h source file, line 98.

this function releases all data associated to a Timing Mapper.

void ble_timing_mapper_event_set(struct ble_timing_mapper_s *tm, uint16_t event, dev_timer_value_t anchor) [link]

This function is declared in ble/util/timing_mapper.h source file, line 107.

this function sets a connection event number event as last successful at time anchor. This updates the internal timing reference and resets window widening.

error_t ble_timing_mapper_master_init(struct ble_timing_mapper_s tm, struct device_timer_s timer, const struct ble_adv_connect_s *connect, dev_timer_value_t reference) [link]

This function is declared in ble/util/timing_mapper.h source file, line 92.

this function initiailzes a Timing Mapper with a timing reference and a connection request parameter set for the master side of a connection.

struct ble_timing_mapper_s [link]

This struct is declared in ble/util/timing_mapper.h source file, line 52.

This utility object tracks timing of a running data connection. It does not take any action about optimal timing policy, but simply keeps track of what time frame a given connection event takes place in.

This can be used either by master of slave side of a connection.

When used from the slave side, this utility takes window widening in consideration and updates timing reference to match master's.

Field	Description
struct device_timer_s timer;
struct ble_conn_timing_param_s current;
struct ble_conn_timing_param_s pending;
dev_timer_value_t drops_at;
dev_timer_value_t last_anchor;
dev_timer_delay_t imprecision_tk;
dev_timer_delay_t timeout_tk;
dev_timer_delay_t pending_timeout_tk;
dev_timer_delay_t min_conn_event_tk;
uint16_t last_event;
uint16_t update_instant;
uint16_t pending_win_offset;
uint16_t pending_win_size;
uint8_t master_sca;
bool_t update_pending:1;

error_t ble_timing_mapper_slave_init(struct ble_timing_mapper_s tm, struct device_timer_s timer, const struct ble_adv_connect_s *connect, dev_timer_value_t reference) [link]

This function is declared in ble/util/timing_mapper.h source file, line 82.

this function initiailzes a Timing Mapper with a timing reference and a connection request parameter set for the slave side of a connection.

error_t ble_timing_mapper_update_push(struct ble_timing_mapper_s tm, const struct ble_conn_params_update update) [link]

This function is declared in ble/util/timing_mapper.h source file, line 145.

this function pushes a connection parameters update as pending until a given instant. If instant passed already, this function may return an error.

void ble_timing_mapper_window_master_get(struct ble_timing_mapper_s tm, uint16_t event, dev_timer_value_t begin, dev_timer_value_t end, dev_timer_delay_t max_duration) [link]

This function is declared in ble/util/timing_mapper.h source file, line 120.

this function retrieves the connection event window for the master side of a connection.

Parameter list:

begin: Time the first packet must be sent on
max_duration: Maximum time the connection event may last

void ble_timing_mapper_window_slave_get(struct ble_timing_mapper_s tm, uint16_t event, dev_timer_value_t begin, dev_timer_value_t end, dev_timer_delay_t max_duration) [link]

This function is declared in ble/util/timing_mapper.h source file, line 137.

this function retrieves the connection event window for the slave side of a connection. After end, slave may stop listening, no packet should be received after this deadline. max_duration is the time the connection event may last at most between the first packet and the last packet.