/* cavHelper.h - Cavium helper functions data types and macros */

/*
 * Copyright (c) 2015 Wind River Systems, Inc.
 *
 * The right to copy, distribute, modify or otherwise make use
 * of this software may be licensed only pursuant to the terms
 * of an applicable Wind River license agreement.
 */

/*
modification history
--------------------
01a,12aug15,a_j  written
*/

#ifndef __INCcavHelperh
#define __INCcavHelperh

#include <arch/mips/private/cavSdkDrvInclude.h>
#define CAV_INCLUDE_TYPEDEFS_ONLY
#include CAV_SDK_DRV_INCLUDE(cvmx-abi.h)
#include CAV_SDK_DRV_INCLUDE(cvmx-helper.h)

#ifdef	__cplusplus
extern "C" {
#endif

/* defines */

/* typedefs */

typedef cvmx_helper_interface_mode_t CAV_HELPER_INTERFACE_MODE_T;

/* functions */

IMPORT int cavHelperUserStaticConfig(void);

IMPORT STATUS cavHelperBgxSgmiiLinkSet
    (
    int     ipdPort,            /* IPD port to configure */
    cvmx_helper_link_info_t linkInfo
    );

IMPORT STATUS cavHelperBgxXauiLinkSet
    (
    int     ipdPort,            /* IPD port to configure */
    cvmx_helper_link_info_t linkInfo
    );

IMPORT CAV_HELPER_INTERFACE_MODE_T cavHelperInterfaceGetMode
    (
    int xiface
    );

IMPORT int cavHelperInterfaceProbe
    (
    int xiface
    );

IMPORT const char *cavHelperInterfaceMode2String
    (
    CAV_HELPER_INTERFACE_MODE_T mode
    );

int cavHelperInitializePacketIoGlobal(void);

int cavHelperInitializePacketIoLocal(void);

int cavHelperGetIpdPort
    (
    int xiface, 
    int index
    );

int cavHelperPortsOnInterface
    (
    int interface
    );

int cavHelperInitPortValid(void);

IMPORT void cavHelperQpgReset
    (
    int offset,
    int grpOk,
    int grpBad
    );

#ifdef	__cplusplus
}
#endif
  
#endif /* __INCcavHelperh */