/*
 * Copyright (c) 2012, The Linux Foundation. All rights reserved.
 * 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.
 */


/**
 * @defgroup shiva_rate SHIVA_RATE
 * @{
 */
#ifndef _SHIVA_RATE_H_
#define _SHIVA_RATE_H_

#ifdef __cplusplus
extern "C" {
#endif                          /* __cplusplus */

#include "fal/fal_rate.h"

    sw_error_t shiva_rate_init(a_uint32_t dev_id);

#ifdef IN_RATE
#define SHIVA_RATE_INIT(rv, dev_id) \
    { \
        rv = shiva_rate_init(dev_id); \
        SW_RTN_ON_ERROR(rv); \
    }
#else
#define SHIVA_RATE_INIT(rv, dev_id)
#endif

#ifdef HSL_STANDALONG


    HSL_LOCAL sw_error_t
    shiva_rate_queue_egrl_set(a_uint32_t dev_id, fal_port_t port_id,
                              fal_queue_t queue_id, a_uint32_t * speed,
                              a_bool_t enable);


    HSL_LOCAL sw_error_t
    shiva_rate_queue_egrl_get(a_uint32_t dev_id, fal_port_t port_id,
                              fal_queue_t queue_id, a_uint32_t * speed,
                              a_bool_t * enable);


    HSL_LOCAL sw_error_t
    shiva_rate_port_egrl_set(a_uint32_t dev_id, fal_port_t port_id,
                             a_uint32_t * speed, a_bool_t enable);


    HSL_LOCAL sw_error_t
    shiva_rate_port_egrl_get(a_uint32_t dev_id, fal_port_t port_id,
                             a_uint32_t * speed, a_bool_t * enable);


    HSL_LOCAL sw_error_t
    shiva_rate_port_inrl_set(a_uint32_t dev_id, fal_port_t port_id,
                             a_uint32_t * speed, a_bool_t enable);


    HSL_LOCAL sw_error_t
    shiva_rate_port_inrl_get(a_uint32_t dev_id, fal_port_t port_id,
                             a_uint32_t * speed, a_bool_t * enable);


    HSL_LOCAL sw_error_t
    shiva_storm_ctrl_frame_set(a_uint32_t dev_id, fal_port_t port_id,
                               fal_storm_type_t storm_type, a_bool_t enable);


    HSL_LOCAL sw_error_t
    shiva_storm_ctrl_frame_get(a_uint32_t dev_id, fal_port_t port_id,
                               fal_storm_type_t storm_type, a_bool_t * enable);


    HSL_LOCAL sw_error_t
    shiva_storm_ctrl_rate_set(a_uint32_t dev_id, fal_port_t port_id,
                              a_uint32_t * rate_in_pps);


    HSL_LOCAL sw_error_t
    shiva_storm_ctrl_rate_get(a_uint32_t dev_id, fal_port_t port_id,
                              a_uint32_t * rate_in_pps);
#endif

#ifdef __cplusplus
}
#endif                          /* __cplusplus */
#endif                          /* _SHIVA_RATE_H_ */
/**
 * @}
 */