// Copyright(c) 2019-2020, Intel Corporation

//

// Redistribution  and  use  in source  and  binary  forms,  with  or  without

// modification, are permitted provided that the following conditions are met:

//

// * Redistributions of  source code  must retain the  above copyright notice,

//   this list of conditions and the following disclaimer.

// * Redistributions in binary form must reproduce the above copyright notice,

//   this list of conditions and the following disclaimer in the documentation

//   and/or other materials provided with the distribution.

// * Neither the name  of Intel Corporation  nor the names of its contributors

//   may be used to  endorse or promote  products derived  from this  software

//   without specific prior written permission.

//

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,  BUT NOT LIMITED TO,  THE

// IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

// ARE DISCLAIMED.  IN NO EVENT  SHALL THE COPYRIGHT OWNER  OR CONTRIBUTORS BE

// LIABLE  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR

// CONSEQUENTIAL  DAMAGES  (INCLUDING,  BUT  NOT LIMITED  TO,  PROCUREMENT  OF

// SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE,  DATA, OR PROFITS;  OR BUSINESS

// INTERRUPTION)  HOWEVER CAUSED  AND ON ANY THEORY  OF LIABILITY,  WHETHER IN

// CONTRACT,  STRICT LIABILITY,  OR TORT  (INCLUDING NEGLIGENCE  OR OTHERWISE)

// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,  EVEN IF ADVISED OF THE

// POSSIBILITY OF SUCH DAMAGE.

#ifndef __FPGA_BOARD_VC_H__

#define __FPGA_BOARD_VC_H__

#include <opae/types.h>

#ifdef __cplusplus

extern "C" {

#endif /* __cplusplus */

#define CDEV_ID_SIZE           8

#define MAX_PORTS              8

#define SYSFS_MAX_SIZE         256

#define MAC_BYTE_SIZE          4

#define VER_BUF_SIZE           16

#define FPGA_VAR_BUF_LEN       256

#define FPGA_PHYGROUP_SIZE     256

#define MAC_BUF_SIZE           8

typedef struct _fpga_pkvl_info {

	uint32_t polling_mode;

	uint32_t status;

} fpga_pkvl_info;

typedef struct _fpga_phy_group_info {

	unsigned int    argsz;

	unsigned int    flags;

	unsigned char  speed;

	unsigned char  phy_num;

	unsigned char  mac_num;

	unsigned char  group_id;

} fpga_phy_group_info;

typedef union _pkvl_mac {

	unsigned int dword;

	unsigned char byte[MAC_BYTE_SIZE];

} pkvl_mac;

/**

* Prints BMC, MAX10 and NIOS version.

*

* @param[in] token            fpga_token object for device (FPGA_DEVICE type)

* @returns FPGA_OK on success. FPGA_NOT_FOUND if MAX10 or NIOS sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result print_board_info(fpga_token token);

/**

* Prints phy group informantion.

*

* @param[in] token            fpga_token object for device (FPGA_DEVICE type)

* @returns FPGA_OK on success. FPGA_NOT_FOUND if phy group sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result print_phy_info(fpga_token token);

/**

* Prints mac informantion.

*

* @param[in] token            fpga_token object for device (FPGA_DEVICE type)

* @returns FPGA_OK on success. FPGA_NOT_FOUND if mac sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result print_mac_info(fpga_token token);

/**

* Get MAC information.

*

* @param[in] token           fpga_token object for device (FPGA_DEVICE type)

* @param[inout] mac_info     pointer to mac info struct or char string

*                            user allocates memory and free mac info

* @param[in] len             length of char mac_info string

* @returns FPGA_OK on success. FPGA_NOT_FOUND if mac sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result read_mac_info(fpga_token token, unsigned char *mac_info, size_t len);

/**

* Get PHY group information.

*

* @param[in] token           fpga_token object for device (FPGA_DEVICE type)

* @param[inout] group_info   pointer to struct fpga_phy_group_info

*                            user allocates memory and free phy group info

* @param[inout] group_num    pointer to group num

* @returns FPGA_OK on success. FPGA_NOT_FOUND if phy group sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result read_phy_group_info(fpga_token token,

				fpga_phy_group_info *group_info,

				uint32_t *group_num);

/**

* Get PKVL information.

*

* @param[in] token           fpga_token object for device (FPGA_DEVICE type)

* @param[inout] pkvl_info    pointer to struct fpga_pkvl_info

*                            user allocates memory and free pkvl info

* @param[inout] fpga_mode    pointer to fpga mode

* @returns FPGA_OK on success. FPGA_NOT_FOUND if pkvl sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result read_pkvl_info(fpga_token token,

				fpga_pkvl_info *pkvl_info,

				int *fpga_mode);

/**

* Get PCB information.

*

* @param[in] token           fpga_token object for device (FPGA_DEVICE type)

* @param[inout] pcb_info     pointer to char pcb_info string

*                            user allocates memory and free input string

* @param[in] len             length of char pcb_info string

* @returns FPGA_OK on success. FPGA_NOT_FOUND if pcb sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result read_pcb_info(fpga_token token, char *pcb_info, size_t len);

/**

* Get Max10 firmware version.

*

* @param[in] token           fpga_token object for device (FPGA_DEVICE type)

* @param[inout] max10fw_var  pointer to char pcb_info string

*                            user allocates memory and free input string

* @param[in] len             length of char max10fw_var string

* @returns FPGA_OK on success. FPGA_NOT_FOUND if MAX10  sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result read_max10fw_version(fpga_token token, char *max10fw_var, size_t len);

/**

* Get BMC/NIOS firmware version.

*

* @param[in] token           fpga_token object for device (FPGA_DEVICE type)

* @param[inout] bmcfw_var    pointer to char bmcfw_var string

*                            user allocates memory and free input string

* @param[in] len             length of char bmcfw_var string

* @returns FPGA_OK on success. FPGA_NOT_FOUND if NIOS sysfs not found.

* FPGA_INVALID_PARAM if invalid parameters were provide

*

*/

fpga_result read_bmcfw_version(fpga_token token, char *bmcfw_var, size_t len);

/**

* Parse bmc/max10 version.

*

* @param[in] buf             pointer to firmware version

* @param[inout] fw_ver       pointer to char firmware string

* @param[in] len             length of char fw var string

* @returns FPGA_OK on success. FPGA_EXCEPTION if FW version is invlaid.

*

*/

fpga_result parse_fw_ver(char *buf, char *fw_ver, size_t len);

/**

* get phy group info from driver.

*

* @param[in] dev_path        pointer to device path

* @param[inout] fw_ver       pointer to fpga_phy_group_info

* @returns FPGA_OK on success. FPGA_EXCEPTION if FW version is invlaid.

*

*/

fpga_result get_phy_info(char *dev_path, fpga_phy_group_info *info);

/**

* Prints pkvl information

*

* @param[in] token            fpga_token object for device (FPGA_DEVICE type)

* @returns FPGA_OK on success. FPGA_EXCEPTION if token is invalid.

*

*/

fpga_result print_pkvl_version(fpga_token token);

#ifdef __cplusplus

}

#endif /* __cplusplus */

#endif /* __FPGA_BOARD_VC_H__ */