libfcoe.h revision 2a8164df8a5f42c8a00f10c67d7bc84f80ae9c41
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * CDDL HEADER START
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * The contents of this file are subject to the terms of the
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Common Development and Distribution License (the "License").
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * You may not use this file except in compliance with the License.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * or http://www.opensolaris.org/os/licensing.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * See the License for the specific language governing permissions
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * and limitations under the License.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * When distributing Covered Code, include this CDDL HEADER in each
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * If applicable, add the following below this CDDL HEADER, with the
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * fields enclosed by brackets "[]" replaced with your own identifying
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * information: Portions Copyright [yyyy] [name of copyright owner]
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * CDDL HEADER END
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Use is subject to license terms.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#ifndef _LIBFCOE_H
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define _LIBFCOE_H
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#include <time.h>
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#include <wchar.h>
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#include <sys/param.h>
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include <sys/ethernet.h>
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include <libnvpair.h>
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#ifdef __cplusplus
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedyextern "C" {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#endif
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * FCOE Port Type
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_PORTTYPE_INITIATOR 0
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_PORTTYPE_TARGET 1
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_MAX_MAC_NAME_LEN 32
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedytypedef unsigned char FCOE_UINT8;
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedytypedef char FCOE_INT8;
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedytypedef unsigned short FCOE_UINT16;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedytypedef short FCOE_INT16;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedytypedef unsigned int FCOE_UINT32;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedytypedef int FCOE_INT32;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedytypedef unsigned int FCOE_STATUS;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_OK 0
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR 1
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_INVAL_ARG 2
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_BUSY 3
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#define FCOE_STATUS_ERROR_ALREADY 4
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#define FCOE_STATUS_ERROR_PERM 5
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_OPEN_DEV 6
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_WWN_SAME 7
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_MAC_LEN 8
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#define FCOE_STATUS_ERROR_PWWN_CONFLICTED 9
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_NWWN_CONFLICTED 10
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_NEED_JUMBO_FRAME 11
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_CREATE_MAC 12
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define FCOE_STATUS_ERROR_OPEN_MAC 13
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#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_VNIC_UNSUPPORT 18
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;
/*
* 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
);
#ifdef __cplusplus
}
#endif
#endif /* _LIBFCOE_H */