android_kernel_samsung_sm8650-modules/dp/inc/cdp_txrx_flow_ctrl_legacy.h

/*
 * Copyright (c) 2016 The Linux Foundation. All rights reserved.
 *
 * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
 *
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * This file was originally distributed by Qualcomm Atheros, Inc.
 * under proprietary terms before Copyright ownership was assigned
 * to the Linux Foundation.
 */
 /**
 * @file cdp_txrx_flow_ctrl_legacy.h
 * @brief Define the host data path legacy flow control API
 * functions
 */
#ifndef _CDP_TXRX_FC_LEG_H_
#define _CDP_TXRX_FC_LEG_H_
#include <cdp_txrx_mob_def.h>

/**
 * cdp_fc_register() - Register flow control callback function pointer
 * @soc - data path soc handle
 * @vdev_id - virtual interface id to register flow control
 * @flowControl - callback function pointer
 * @osif_fc_ctx - client context pointer
 *
 * Register flow control callback function pointer and client context pointer
 *
 * return 0 success
 */
static inline int
cdp_fc_register(ol_txrx_soc_handle soc, uint8_t vdev_id,
		ol_txrx_tx_flow_control_fp flowControl, void *osif_fc_ctx)
{
	if (!soc || !soc->ops || !soc->ops->l_flowctl_ops) {
		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_FATAL,
			"%s invalid instance", __func__);
		return 0;
	}

	if (soc->ops->l_flowctl_ops->register_tx_flow_control)
		return soc->ops->l_flowctl_ops->register_tx_flow_control(
			vdev_id, flowControl, osif_fc_ctx);

	return 0;
}

/**
 * cdp_fc_deregister() - remove flow control instance
 * @soc - data path soc handle
 * @vdev_id - virtual interface id to register flow control
 *
 * remove flow control instance
 *
 * return 0 success
 */
static inline int
cdp_fc_deregister(ol_txrx_soc_handle soc, uint8_t vdev_id)
{
	if (!soc || !soc->ops || !soc->ops->l_flowctl_ops) {
		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_FATAL,
			"%s invalid instance", __func__);
		return 0;
	}

	if (soc->ops->l_flowctl_ops->deregister_tx_flow_control_cb)
		return soc->ops->l_flowctl_ops->deregister_tx_flow_control_cb(
			vdev_id);

	return 0;
}

/**
 * cdp_fc_get_tx_resource() - get data path resource count
 * @soc - data path soc handle
 * @sta_id - local peer id
 * @low_watermark - low resource threshold
 * @high_watermark_offset - high resource threshold
 *
 * get data path resource count
 *
 * return true enough data path resource available
 *        false resource is not avaialbe
 */
static inline bool
cdp_fc_get_tx_resource(ol_txrx_soc_handle soc, uint8_t sta_id,
		unsigned int low_watermark, unsigned int high_watermark_offset)
{
	if (!soc || !soc->ops || !soc->ops->l_flowctl_ops) {
		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_FATAL,
			"%s invalid instance", __func__);
		return false;
	}

	if (soc->ops->l_flowctl_ops->get_tx_resource)
		return soc->ops->l_flowctl_ops->get_tx_resource(sta_id,
			low_watermark, high_watermark_offset);

	return false;
}

/**
 * cdp_fc_ll_set_tx_pause_q_depth() - set pause queue depth
 * @soc - data path soc handle
 * @vdev_id - virtual interface id to register flow control
 * @pause_q_depth - pending tx queue delth
 *
 * set pause queue depth
 *
 * return 0 success
 */
static inline int
cdp_fc_ll_set_tx_pause_q_depth(ol_txrx_soc_handle soc,
		uint8_t vdev_id, int pause_q_depth)
{
	if (!soc || !soc->ops || !soc->ops->l_flowctl_ops) {
		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_FATAL,
			"%s invalid instance", __func__);
		return 0;
	}

	if (soc->ops->l_flowctl_ops->ll_set_tx_pause_q_depth)
		return soc->ops->l_flowctl_ops->ll_set_tx_pause_q_depth(vdev_id,
			pause_q_depth);

	return 0;
}

/**
 * cdp_fc_vdev_flush() - flush tx queue
 * @soc - data path soc handle
 * @vdev - virtual interface context pointer
 *
 * flush tx queue
 *
 * return None
 */
static inline void
cdp_fc_vdev_flush(ol_txrx_soc_handle soc, void *vdev)
{
	if (!soc || !soc->ops || !soc->ops->l_flowctl_ops) {
		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_FATAL,
			"%s invalid instance", __func__);
		return;
	}

	if (soc->ops->l_flowctl_ops->vdev_flush)
		return soc->ops->l_flowctl_ops->vdev_flush(vdev);

	return;
}

/**
 * cdp_fc_vdev_pause() - pause tx scheduler on vdev
 * @soc - data path soc handle
 * @vdev - virtual interface context pointer
 * @reason - pause reason
 *
 * pause tx scheduler on vdev
 *
 * return None
 */
static inline void
cdp_fc_vdev_pause(ol_txrx_soc_handle soc, void *vdev,
		uint32_t reason)
{
	if (!soc || !soc->ops || !soc->ops->l_flowctl_ops) {
		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_FATAL,
			"%s invalid instance", __func__);
		return;
	}

	if (soc->ops->l_flowctl_ops->vdev_pause)
		return soc->ops->l_flowctl_ops->vdev_pause(vdev, reason);

	return;
}

/**
 * cdp_fc_vdev_unpause() - resume tx scheduler on vdev
 * @soc - data path soc handle
 * @vdev - virtual interface context pointer
 * @reason - pause reason
 *
 * resume tx scheduler on vdev
 *
 * return None
 */
static inline void
cdp_fc_vdev_unpause(ol_txrx_soc_handle soc, void *vdev,
		uint32_t reason)
{
	if (!soc || !soc->ops || !soc->ops->l_flowctl_ops) {
		QDF_TRACE(QDF_MODULE_ID_DP, QDF_TRACE_LEVEL_FATAL,
			"%s invalid instance", __func__);
		return;
	}

	if (soc->ops->l_flowctl_ops->vdev_unpause)
		return soc->ops->l_flowctl_ops->vdev_unpause(vdev, reason);

	return;
}
#endif /* _CDP_TXRX_FC_LEG_H_ */