/****************************************************************************
 *
 * Copyright (c) 2012 - 2018 Samsung Electronics Co., Ltd. All rights reserved
 *
 ****************************************************************************/

#ifndef __TRAFFIC_MONITOR_H__
#define __TRAFFIC_MONITOR_H__

#define SLSI_TRAFFIC_MON_TIMER_PERIOD		100		/* in ms */
#define SLSI_TRAFFIC_MON_HYSTERESIS_HIGH	2		/* in number of timer period */
#define SLSI_TRAFFIC_MON_HYSTERESIS_LOW		10		/* in number of timer period */

enum {
	TRAFFIC_MON_CLIENT_MODE_NONE,
	TRAFFIC_MON_CLIENT_MODE_PERIODIC,
	TRAFFIC_MON_CLIENT_MODE_EVENTS
};

enum {
	TRAFFIC_MON_CLIENT_STATE_NONE,
	TRAFFIC_MON_CLIENT_STATE_LOW,
	TRAFFIC_MON_CLIENT_STATE_MID,
	TRAFFIC_MON_CLIENT_STATE_HIGH
};

struct slsi_traffic_mon_clients {
	/* client list lock */
	spinlock_t       lock;

	struct timer_list timer;
	struct list_head client_list;
};

void slsi_traffic_mon_event_rx(struct slsi_dev *sdev, struct net_device *dev, struct sk_buff *skb);
void slsi_traffic_mon_event_tx(struct slsi_dev *sdev, struct net_device *dev, struct sk_buff *skb);

/* Is traffic monitor running?
 *
 * A caller can seek whether the traffic monitor is running or not.
 * If the traffic monitor is running, then the throughput for Rx and
 * Tx is stored in netdev_vif structure and caller can access them.
 *
 * Returns:		1 - traffic monitor is running
 *				0 - traffic monitor is NOT running
 */
u8 slsi_traffic_mon_is_running(struct slsi_dev *sdev);

/* register a client to traffic monitor
 *
 * A client can register to traffic monitor to either get notification
 * per timer period or to get notification when the throughput changes
 * state from one state of LOW/MID/HIGH to another.
 *
 * client_ctx:	client context that is passed back in callback
 *				Also, is an unique ID for the client.
 * mode:		can be periodic or event based
 * mid_tput:	Mid throughput level
 * high_tput:	High throughput level
 * traffic_mon_client_cb: function to callback each period or on events
 *                        This function is called back in Timer interrupt
 *                        context.
 */
int slsi_traffic_mon_client_register(
	struct slsi_dev *sdev,
	void *client_ctx,
	u32 mode,
	u32 mid_tput,
	u32 high_tput,
	/* WARNING: THIS IS CALLED BACK IN TIMER INTERRUPT CONTEXT! */
	void (*traffic_mon_client_cb)(void *client_ctx, u32 state, u32 tput_tx, u32 tput_rx));
void slsi_traffic_mon_client_unregister(struct slsi_dev *sdev, void *client_ctx);

void slsi_traffic_mon_clients_init(struct slsi_dev *sdev);
void slsi_traffic_mon_clients_deinit(struct slsi_dev *sdev);

#endif