mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-08 23:02:46 +00:00
ac74d8b652
Replace the existing Apache 2.0 boilerplate header with an SPDX tag throughout the zephyr code tree. This patch was generated via a script run over the master branch. Also updated doc/porting/application.rst that had a dependency on line numbers in a literal include. Manually updated subsys/logging/sys_log.c that had a malformed header in the original file. Also cleanup several cases that already had a SPDX tag and we either got a duplicate or missed updating. Jira: ZEP-1457 Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
127 lines
2.9 KiB
C
127 lines
2.9 KiB
C
/** @file
|
|
* @brief Trickle timer library
|
|
*
|
|
* This implements Trickle timer as specified in RFC 6206
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2016 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __TRICKLE_H
|
|
#define __TRICKLE_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#include <kernel.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct net_trickle;
|
|
|
|
typedef void (*net_trickle_cb_t)(struct net_trickle *trickle,
|
|
bool do_suppress, void *user_data);
|
|
|
|
/*
|
|
* The variable names are taken directly from RFC when applicable.
|
|
* Note that the struct members should not be accessed directly but
|
|
* only via the Trickle API.
|
|
*/
|
|
struct net_trickle {
|
|
uint32_t Imin; /* Min interval size in ms */
|
|
uint8_t Imax; /* Max number of doublings */
|
|
uint8_t k; /* Redundancy constant */
|
|
|
|
uint32_t I; /* Current interval size */
|
|
uint32_t Istart; /* Start of the interval in ms */
|
|
uint8_t c; /* Consistency counter */
|
|
|
|
uint32_t Imax_abs; /* Max interval size in ms (not doublings)
|
|
*/
|
|
|
|
struct k_delayed_work timer;
|
|
net_trickle_cb_t cb; /* Callback to be called when timer expires */
|
|
void *user_data;
|
|
};
|
|
|
|
#define NET_TRICKLE_INFINITE_REDUNDANCY 0
|
|
|
|
/**
|
|
* @brief Create a Trickle timer.
|
|
*
|
|
* @param trickle Pointer to Trickle struct.
|
|
* @param Imin Imin configuration parameter in ms.
|
|
* @param Imax Max number of doublings.
|
|
* @param k Redundancy constant parameter. See RFC 6206 for details.
|
|
*
|
|
* @return Return 0 if ok and <0 if error.
|
|
*/
|
|
int net_trickle_create(struct net_trickle *trickle,
|
|
uint32_t Imin,
|
|
uint8_t Imax,
|
|
uint8_t k);
|
|
|
|
/**
|
|
* @brief Start a Trickle timer.
|
|
*
|
|
* @param trickle Pointer to Trickle struct.
|
|
* @param cb User callback to call at time T within the current trickle
|
|
* interval
|
|
* @param user_data User pointer that is passed to callback.
|
|
*
|
|
* @return Return 0 if ok and <0 if error.
|
|
*/
|
|
int net_trickle_start(struct net_trickle *trickle,
|
|
net_trickle_cb_t cb,
|
|
void *user_data);
|
|
|
|
/**
|
|
* @brief Stop a Trickle timer.
|
|
*
|
|
* @param trickle Pointer to Trickle struct.
|
|
*
|
|
* @return Return 0 if ok and <0 if error.
|
|
*/
|
|
int net_trickle_stop(struct net_trickle *trickle);
|
|
|
|
/**
|
|
* @brief To be called by the protocol handler when it hears a consistent
|
|
* network transmission.
|
|
*
|
|
* @param trickle Pointer to Trickle struct.
|
|
*/
|
|
void net_trickle_consistency(struct net_trickle *trickle);
|
|
|
|
/**
|
|
* @brief To be called by the protocol handler when it hears an inconsistent
|
|
* network transmission.
|
|
*
|
|
* @param trickle Pointer to Trickle struct.
|
|
*/
|
|
void net_trickle_inconsistency(struct net_trickle *trickle);
|
|
|
|
/**
|
|
* @brief Check if the Trickle timer is running or not.
|
|
*
|
|
* @param trickle Pointer to Trickle struct.
|
|
*
|
|
* @return Return True if timer is running and False if not.
|
|
*/
|
|
static inline bool net_trickle_is_running(struct net_trickle *trickle)
|
|
{
|
|
NET_ASSERT(trickle);
|
|
|
|
return trickle->I != 0;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __TRICKLE_H */
|