Current File : //usr/include/libfcoe.h

/*
 * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
 */

#ifndef	_LIBFCOE_H
#define	_LIBFCOE_H

#include <time.h>
#include <wchar.h>
#include <sys/param.h>
#include <sys/ethernet.h>
#include <libnvpair.h>

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * FCoE Port Type
 */
#define	FCOE_PORTTYPE_INITIATOR		0
#define	FCOE_PORTTYPE_TARGET		1

#define	FCOE_MAX_MAC_NAME_LEN		32

typedef unsigned char	FCOE_UINT8;
typedef		 char	FCOE_INT8;
typedef unsigned short	FCOE_UINT16;
typedef		 short	FCOE_INT16;
typedef unsigned int	FCOE_UINT32;
typedef		 int	FCOE_INT32;

typedef unsigned int	FCOE_STATUS;
typedef void *		FCOE_PORT_HANDLE;

#define	FCOE_STATUS_OK				0
#define	FCOE_STATUS_ERROR			1
#define	FCOE_STATUS_ERROR_INVAL_ARG		2
#define	FCOE_STATUS_ERROR_BUSY			3
#define	FCOE_STATUS_ERROR_ALREADY		4
#define	FCOE_STATUS_ERROR_PERM			5
#define	FCOE_STATUS_ERROR_OPEN_DEV		6
#define	FCOE_STATUS_ERROR_WWN_SAME		7
#define	FCOE_STATUS_ERROR_MAC_LEN		8
#define	FCOE_STATUS_ERROR_PWWN_CONFLICTED	9
#define	FCOE_STATUS_ERROR_NWWN_CONFLICTED	10
#define	FCOE_STATUS_ERROR_NEED_JUMBO_FRAME	11
#define	FCOE_STATUS_ERROR_CREATE_MAC		12
#define	FCOE_STATUS_ERROR_OPEN_MAC		13
#define	FCOE_STATUS_ERROR_CREATE_PORT		14
#define	FCOE_STATUS_ERROR_MAC_NOT_FOUND		15
#define	FCOE_STATUS_ERROR_OFFLINE_DEV		16
#define	FCOE_STATUS_ERROR_MORE_DATA		17
#define	FCOE_STATUS_ERROR_CLASS_UNSUPPORT	18
#define	FCOE_STATUS_ERROR_GET_LINKINFO		19

/* FCoE resource types */
#define	FCOE_RT_PORT_PROPERTY	0

typedef struct fcoe_port_wwn {
	uchar_t	wwn[8];
} FCOE_PORT_WWN, *PFCOE_PORT_WWN;

typedef struct fcoe_port_attr {
	FCOE_PORT_WWN	port_wwn;
	FCOE_UINT8	mac_link_name[MAXLINKNAMELEN];
	FCOE_UINT8	mac_factory_addr[ETHERADDRL];
	FCOE_UINT8	mac_current_addr[ETHERADDRL];
	FCOE_UINT8	port_type;
	FCOE_UINT32	mtu_size;
	FCOE_UINT8	mac_promisc;
} FCOE_PORT_ATTRIBUTE, *PFCOE_PORT_ATTRIBUTE;

enum {
	FCOE_PP_PWWN = 1,
	FCOE_PP_PORT_MODE,
	FCOE_PP_PORT_FCID,
	FCOE_PP_MAC_VLAN_ID,
	FCOE_PP_MAC_LINK_NAME,
	FCOE_PP_MAC_MTU_SIZE,
	FCOE_PP_MAC_FACTORY_ADDR,
	FCOE_PP_MAC_CURRENT_ADDR,
	FCOE_PP_MAC_PROMISCUOUS,
	FCOE_PP_PORT_STATE,
	FCOE_PP_FIP_MODE,
	FCOE_PP_OFFLOAD_TXCRC,
	FCOE_PP_OFFLOAD_RXCRC,
	FCOE_PP_OFFLOAD_LSO,
	FCOE_PP_OFFLOAD_LRO,
	FCOE_PP_OFFLOAD_LSO_MAX_SIZE,
	FCOE_PP_OFFLOAD_LRO_MAX_SIZE
};

/*
 * FCoE port instance in smf repository
 */
typedef struct fcoe_smf_port_instance {
	FCOE_UINT8	mac_link_name[MAXLINKNAMELEN];
	FCOE_UINT8	port_type;
	FCOE_PORT_WWN	port_pwwn;
	FCOE_PORT_WWN	port_nwwn;
	FCOE_UINT8	mac_promisc;
} FCOE_SMF_PORT_INSTANCE, *PFCOE_SMF_PORT_INSTANCE;

/*
 * FCoE port instance list
 */
typedef struct fcoe_smf_port_list {
	FCOE_UINT32	port_num;
	FCOE_SMF_PORT_INSTANCE	ports[1];
} FCOE_SMF_PORT_LIST, *PFCOE_SMF_PORT_LIST;

/*
 * FCoE port property set
 */
typedef struct fcoe_port_prop {
	FCOE_UINT32	port_pmask;
	FCOE_UINT8	port_priority;
} FCOE_PORT_PROP;

/*
 * macLinkName: mac name with maximum lenth 32
 * portType: 0 (Initiator)/ 1(Target)
 * pwwn: Port WWN
 * nwwn: Nodw WWN
 * promiscous: to enable promisc mode for mac interface
 */
FCOE_STATUS FCOE_CreatePort(
	const FCOE_UINT8	*macLinkName,	/* maximum len: 32 */
	FCOE_UINT8	portType,
	FCOE_PORT_WWN	pwwn,
	FCOE_PORT_WWN	nwwn,
	FCOE_UINT8	promiscusous
);

FCOE_STATUS FCOE_DeletePort(
    const FCOE_UINT8	*macLinkName
);

/*
 * Make sure to free the memory pointed by portlist
 */
FCOE_STATUS FCOE_GetPortList(
    FCOE_UINT32		*port_num,
    FCOE_PORT_ATTRIBUTE	**portlist
);

FCOE_STATUS FCOE_GetPortHandle(
    const FCOE_UINT8    *macLinkName,
    FCOE_UINT8		portResType,
    FCOE_PORT_HANDLE	*phandle
);

FCOE_STATUS FCOE_GetPortProp(
    FCOE_PORT_HANDLE	handle,
    FCOE_UINT32		prop,
    FCOE_INT8		*propVal,
    FCOE_UINT32		*propLen
);

FCOE_STATUS FCOE_FreePortHandle(
    FCOE_PORT_HANDLE handle
);

/*
 * Make sure to free the memory pointed by portlist
 */
FCOE_STATUS FCOE_LoadConfig(
    FCOE_UINT8		portType,
    FCOE_SMF_PORT_LIST **portlist
);

/* Sets the priority property in the structure FCOE_PORT_PROP */
FCOE_STATUS FCOE_Set_Priority(
    FCOE_PORT_PROP	*fpp,
    FCOE_UINT8		priority
);

/* used to set multiple FCOE port properites */
FCOE_STATUS FCOE_SetpropPort(
    const FCOE_UINT8 *macLinkName,
    const FCOE_PORT_PROP *
);

#ifdef	__cplusplus
}
#endif

#endif	/* _LIBFCOE_H */