target/linux/mediatek/files-5.10/drivers/net/phy/rtk/rtl8367c/include/eee.h

   1 /*
   2  * Copyright (C) 2013 Realtek Semiconductor Corp.
   3  * All Rights Reserved.
   4  *
   5  * Unless you and Realtek execute a separate written software license
   6  * agreement governing use of this software, this software is licensed
   7  * to you under the terms of the GNU General Public License version 2,
   8  * available at https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
   9  *
  10  * Purpose : RTL8367/RTL8367C switch high-level API
  11  *
  12  * Feature : The file includes EEE module high-layer API defination
  13  *
  14  */
  15
  16 #ifndef __RTK_API_EEE_H__
  17 #define __RTK_API_EEE_H__
  18
  19 /* Function Name:
  20  *      rtk_eee_init
  21  * Description:
  22  *      EEE function initialization.
  23  * Input:
  24  *      None
  25  * Output:
  26  *      None
  27  * Return:
  28  *      RT_ERR_OK              - OK
  29  *      RT_ERR_FAILED          - Failed
  30  *      RT_ERR_SMI             - SMI access error
  31  * Note:
  32  *      This API is used to initialize EEE status.
  33  */
  34 extern rtk_api_ret_t rtk_eee_init(void);
  35
  36 /* Function Name:
  37  *      rtk_eee_portEnable_set
  38  * Description:
  39  *      Set enable status of EEE function.
  40  * Input:
  41  *      port - port id.
  42  *      enable - enable EEE status.
  43  * Output:
  44  *      None
  45  * Return:
  46  *      RT_ERR_OK              - OK
  47  *      RT_ERR_FAILED          - Failed
  48  *      RT_ERR_SMI             - SMI access error
  49  *      RT_ERR_PORT_ID - Invalid port number.
  50  *      RT_ERR_ENABLE - Invalid enable input.
  51  * Note:
  52  *      This API can set EEE function to the specific port.
  53  *      The configuration of the port is as following:
  54  *      - DISABLE
  55  *      - ENABLE
  56  */
  57 extern rtk_api_ret_t rtk_eee_portEnable_set(rtk_port_t port, rtk_enable_t enable);
  58
  59 /* Function Name:
  60  *      rtk_eee_portEnable_get
  61  * Description:
  62  *      Get port admin configuration of the specific port.
  63  * Input:
  64  *      port - Port id.
  65  * Output:
  66  *      pEnable - Back pressure status.
  67  * Return:
  68  *      RT_ERR_OK              - OK
  69  *      RT_ERR_FAILED          - Failed
  70  *      RT_ERR_SMI             - SMI access error
  71  *      RT_ERR_PORT_ID - Invalid port number.
  72  * Note:
  73  *      This API can set EEE function to the specific port.
  74  *      The configuration of the port is as following:
  75  *      - DISABLE
  76  *      - ENABLE
  77  */
  78 extern rtk_api_ret_t rtk_eee_portEnable_get(rtk_port_t port, rtk_enable_t *pEnable);
  79
  80
  81 #endif /* __RTK_API_EEE_H__ */
  82