xref: /titanic_50/usr/src/lib/libdladm/common/libdllink.h (revision 62ee1d25bffb3d6d74798efe1199f7e86a29a14e)
1f595a68aSyz147064 /*
2f595a68aSyz147064  * CDDL HEADER START
3f595a68aSyz147064  *
4f595a68aSyz147064  * The contents of this file are subject to the terms of the
5f595a68aSyz147064  * Common Development and Distribution License (the "License").
6f595a68aSyz147064  * You may not use this file except in compliance with the License.
7f595a68aSyz147064  *
8f595a68aSyz147064  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9f595a68aSyz147064  * or http://www.opensolaris.org/os/licensing.
10f595a68aSyz147064  * See the License for the specific language governing permissions
11f595a68aSyz147064  * and limitations under the License.
12f595a68aSyz147064  *
13f595a68aSyz147064  * When distributing Covered Code, include this CDDL HEADER in each
14f595a68aSyz147064  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15f595a68aSyz147064  * If applicable, add the following below this CDDL HEADER, with the
16f595a68aSyz147064  * fields enclosed by brackets "[]" replaced with your own identifying
17f595a68aSyz147064  * information: Portions Copyright [yyyy] [name of copyright owner]
18f595a68aSyz147064  *
19f595a68aSyz147064  * CDDL HEADER END
20f595a68aSyz147064  */
21f595a68aSyz147064 /*
22d62bc4baSyz147064  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23f595a68aSyz147064  * Use is subject to license terms.
24f595a68aSyz147064  */
25f595a68aSyz147064 
26f595a68aSyz147064 #ifndef _LIBDLLINK_H
27f595a68aSyz147064 #define	_LIBDLLINK_H
28f595a68aSyz147064 
29f595a68aSyz147064 /*
30d62bc4baSyz147064  * This file includes structures, macros and routines used by general
31d62bc4baSyz147064  * link administration (i.e. not limited to one specific type of link).
32f595a68aSyz147064  */
33f595a68aSyz147064 
34da14cebeSEric Cheng #include <stdio.h>
35f595a68aSyz147064 #include <sys/types.h>
36f595a68aSyz147064 #include <sys/param.h>
37f595a68aSyz147064 #include <libdladm.h>
38da14cebeSEric Cheng #include <libdladm_impl.h>
39da14cebeSEric Cheng #include <sys/mac_flow.h>
40f595a68aSyz147064 
41f595a68aSyz147064 #ifdef	__cplusplus
42f595a68aSyz147064 extern "C" {
43f595a68aSyz147064 #endif
44f595a68aSyz147064 
45f595a68aSyz147064 typedef struct dladm_attr {
46f595a68aSyz147064 	uint_t			da_max_sdu;
47f595a68aSyz147064 } dladm_attr_t;
48f595a68aSyz147064 
49d62bc4baSyz147064 typedef struct dladm_phys_attr {
50d62bc4baSyz147064 	char		dp_dev[MAXLINKNAMELEN];
51d62bc4baSyz147064 	/*
52d62bc4baSyz147064 	 * Whether this physical link supports vanity naming (links with media
53d62bc4baSyz147064 	 * types not supported by GLDv3 don't have vanity naming support).
54d62bc4baSyz147064 	 */
55d62bc4baSyz147064 	boolean_t	dp_novanity;
56d62bc4baSyz147064 } dladm_phys_attr_t;
57d62bc4baSyz147064 
58d62bc4baSyz147064 typedef enum {
59d62bc4baSyz147064 	DLADM_PROP_VAL_CURRENT = 1,
60d62bc4baSyz147064 	DLADM_PROP_VAL_DEFAULT,
61afdda45fSVasumathi Sundaram - Sun Microsystems 	DLADM_PROP_VAL_PERM,
62d62bc4baSyz147064 	DLADM_PROP_VAL_MODIFIABLE,
63d62bc4baSyz147064 	DLADM_PROP_VAL_PERSISTENT
64d62bc4baSyz147064 } dladm_prop_type_t;
65d62bc4baSyz147064 
66f595a68aSyz147064 /*
67f595a68aSyz147064  * Maximum size of secobj value. Note that it should not be greater than
68f595a68aSyz147064  * DLD_SECOBJ_VAL_MAX.
69f595a68aSyz147064  */
70f595a68aSyz147064 #define	DLADM_SECOBJ_VAL_MAX	256
71f595a68aSyz147064 
72f595a68aSyz147064 /*
73f595a68aSyz147064  * Maximum size of secobj name. Note that it should not be greater than
74f595a68aSyz147064  * DLD_SECOBJ_NAME_MAX.
75f595a68aSyz147064  */
76f595a68aSyz147064 #define	DLADM_SECOBJ_NAME_MAX	32
77f595a68aSyz147064 
78d62bc4baSyz147064 #define	DLADM_MAX_PROP_VALCNT	32
79e7801d59Ssowmini /*
80e7801d59Ssowmini  * Size of prop_val buffer passed to pd_get function must be at
81e7801d59Ssowmini  * least DLADM_PROP_VAL_MAX
82e7801d59Ssowmini  */
83d62bc4baSyz147064 #define	DLADM_PROP_VAL_MAX	128
84f595a68aSyz147064 
85f595a68aSyz147064 #define		DLADM_SECOBJ_CLASS_WEP	0
86a399b765Szf162725 #define		DLADM_SECOBJ_CLASS_WPA	1
87f595a68aSyz147064 typedef int	dladm_secobj_class_t;
88f595a68aSyz147064 
89d62bc4baSyz147064 typedef int (dladm_walkcb_t)(const char *, void *);
90f595a68aSyz147064 
91da14cebeSEric Cheng /* possible flags for ma_flags below */
92da14cebeSEric Cheng #define	DLADM_MACADDR_USED	0x1
93da14cebeSEric Cheng 
94da14cebeSEric Cheng typedef enum {
95da14cebeSEric Cheng 	DLADM_HWGRP_TYPE_RX = 0x1,
96da14cebeSEric Cheng 	DLADM_HWGRP_TYPE_TX
97da14cebeSEric Cheng } dladm_hwgrp_type_t;
98da14cebeSEric Cheng 
99da14cebeSEric Cheng typedef struct dladm_hwgrp_attr {
100da14cebeSEric Cheng 	char		hg_link_name[MAXLINKNAMELEN];
101da14cebeSEric Cheng 	uint_t		hg_grp_num;
102da14cebeSEric Cheng 	dladm_hwgrp_type_t	hg_grp_type;
103da14cebeSEric Cheng 	uint_t		hg_n_rings;
104da14cebeSEric Cheng 	uint_t		hg_n_clnts;
105da14cebeSEric Cheng 	char		hg_client_names[MAXCLIENTNAMELEN];
106da14cebeSEric Cheng } dladm_hwgrp_attr_t;
107da14cebeSEric Cheng 
108da14cebeSEric Cheng typedef struct dladm_macaddr_attr {
109da14cebeSEric Cheng 	uint_t		ma_slot;
110da14cebeSEric Cheng 	uint_t		ma_flags;
111da14cebeSEric Cheng 	uchar_t		ma_addr[MAXMACADDRLEN];
112da14cebeSEric Cheng 	uint_t		ma_addrlen;
113da14cebeSEric Cheng 	char		ma_client_name[MAXNAMELEN];
114da14cebeSEric Cheng 	datalink_id_t	ma_client_linkid;
115da14cebeSEric Cheng } dladm_macaddr_attr_t;
116da14cebeSEric Cheng 
1174ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_walk(dladm_walkcb_t *, dladm_handle_t, void *,
1184ac67f02SAnurag S. Maskey 			    datalink_class_t, datalink_media_t, uint32_t);
119d62bc4baSyz147064 extern dladm_status_t	dladm_mac_walk(dladm_walkcb_t *, void *);
1204ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_info(dladm_handle_t, datalink_id_t,
1214ac67f02SAnurag S. Maskey 			    dladm_attr_t *);
1224ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_setzid(dladm_handle_t, const char *, char *);
123f595a68aSyz147064 
1244ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_rename_link(dladm_handle_t, const char *,
1254ac67f02SAnurag S. Maskey 			    const char *);
126d62bc4baSyz147064 
1274ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_set_linkprop(dladm_handle_t, datalink_id_t,
1284ac67f02SAnurag S. Maskey 			    const char *, char **, uint_t, uint_t);
1294ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_get_linkprop(dladm_handle_t, datalink_id_t,
1304ac67f02SAnurag S. Maskey 			    dladm_prop_type_t, const char *, char **, uint_t *);
1314ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_walk_linkprop(dladm_handle_t, datalink_id_t,
1324ac67f02SAnurag S. Maskey 			    void *, int (*)(dladm_handle_t, datalink_id_t,
1334ac67f02SAnurag S. Maskey 			    const char *, void *));
134*62ee1d25SArtem Kachitchkine extern boolean_t	dladm_attr_is_linkprop(const char *name);
135d62bc4baSyz147064 
1364ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_set_secobj(dladm_handle_t, const char *,
1374ac67f02SAnurag S. Maskey 			    dladm_secobj_class_t, uint8_t *, uint_t, uint_t);
1384ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_get_secobj(dladm_handle_t, const char *,
1394ac67f02SAnurag S. Maskey 			    dladm_secobj_class_t *, uint8_t *, uint_t *,
1404ac67f02SAnurag S. Maskey 			    uint_t);
1414ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_unset_secobj(dladm_handle_t, const char *,
1424ac67f02SAnurag S. Maskey 			    uint_t);
1434ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_walk_secobj(dladm_handle_t, void *,
1444ac67f02SAnurag S. Maskey 			    boolean_t (*)(dladm_handle_t, void *, const char *),
1454ac67f02SAnurag S. Maskey 			    uint_t);
146f595a68aSyz147064 
147f595a68aSyz147064 extern const char	*dladm_linkstate2str(link_state_t, char *);
148f595a68aSyz147064 extern const char	*dladm_linkduplex2str(link_duplex_t, char *);
149f595a68aSyz147064 extern const char	*dladm_secobjclass2str(dladm_secobj_class_t, char *);
150f595a68aSyz147064 extern dladm_status_t	dladm_str2secobjclass(const char *,
151f595a68aSyz147064 			    dladm_secobj_class_t *);
152f595a68aSyz147064 
1534ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_init_linkprop(dladm_handle_t, datalink_id_t,
1544ac67f02SAnurag S. Maskey 			    boolean_t);
1554ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_init_secobj(dladm_handle_t);
156a9489f61SAnurag S. Maskey extern boolean_t	dladm_valid_secobj_name(const char *);
157f595a68aSyz147064 
1584ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_create_datalink_id(dladm_handle_t, const char *,
1594ac67f02SAnurag S. Maskey 			    datalink_class_t, uint_t, uint32_t,
1604ac67f02SAnurag S. Maskey 			    datalink_id_t *);
1614ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_destroy_datalink_id(dladm_handle_t, datalink_id_t,
162d62bc4baSyz147064 			    uint32_t);
1634ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_remap_datalink_id(dladm_handle_t, datalink_id_t,
1644ac67f02SAnurag S. Maskey 			    const char *);
1654ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_up_datalink_id(dladm_handle_t, datalink_id_t);
1664ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_name2info(dladm_handle_t, const char *,
1674ac67f02SAnurag S. Maskey 			    datalink_id_t *, uint32_t *, datalink_class_t *,
1684ac67f02SAnurag S. Maskey 			    uint32_t *);
1694ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_datalink_id2info(dladm_handle_t, datalink_id_t,
1704ac67f02SAnurag S. Maskey 			    uint32_t *, datalink_class_t *, uint32_t *, char *,
1714ac67f02SAnurag S. Maskey 			    size_t);
1724ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_walk_datalink_id(int (*)(dladm_handle_t,
1734ac67f02SAnurag S. Maskey 			    datalink_id_t, void *), dladm_handle_t, void *,
1744ac67f02SAnurag S. Maskey 			    datalink_class_t, datalink_media_t, uint32_t);
1754ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_create_conf(dladm_handle_t, const char *,
1764ac67f02SAnurag S. Maskey 			    datalink_id_t, datalink_class_t, uint32_t,
1774ac67f02SAnurag S. Maskey 			    dladm_conf_t *);
1784ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_read_conf(dladm_handle_t, datalink_id_t,
1794ac67f02SAnurag S. Maskey 			    dladm_conf_t *);
1804ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_write_conf(dladm_handle_t, dladm_conf_t);
1814ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_remove_conf(dladm_handle_t, datalink_id_t);
1824ac67f02SAnurag S. Maskey extern void		dladm_destroy_conf(dladm_handle_t, dladm_conf_t);
1834ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_get_conf_field(dladm_handle_t, dladm_conf_t,
1844ac67f02SAnurag S. Maskey 			    const char *, void *, size_t);
185*62ee1d25SArtem Kachitchkine extern dladm_status_t	dladm_getnext_conf_linkprop(dladm_handle_t,
186*62ee1d25SArtem Kachitchkine 			    dladm_conf_t, const char *, char *, void *,
187*62ee1d25SArtem Kachitchkine 			    size_t, size_t *);
1884ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_set_conf_field(dladm_handle_t, dladm_conf_t,
1894ac67f02SAnurag S. Maskey 			    const char *, dladm_datatype_t, const void *);
1904ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_unset_conf_field(dladm_handle_t, dladm_conf_t,
1914ac67f02SAnurag S. Maskey 			    const char *);
192d62bc4baSyz147064 
1934ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_dev2linkid(dladm_handle_t, const char *,
1944ac67f02SAnurag S. Maskey 			    datalink_id_t *);
1954ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_linkid2legacyname(dladm_handle_t, datalink_id_t,
1964ac67f02SAnurag S. Maskey 			    char *, size_t);
1974ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_phys_delete(dladm_handle_t, datalink_id_t);
198d62bc4baSyz147064 
1994ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_phys_info(dladm_handle_t, datalink_id_t,
2004ac67f02SAnurag S. Maskey 			    dladm_phys_attr_t *, uint32_t);
201e7801d59Ssowmini extern dladm_status_t	dladm_parselink(const char *, char *, uint_t *);
202d62bc4baSyz147064 
2034ac67f02SAnurag S. Maskey extern int		dladm_walk_macaddr(dladm_handle_t, datalink_id_t,
2044ac67f02SAnurag S. Maskey 			    void *,
205da14cebeSEric Cheng 			    boolean_t (*)(void *, dladm_macaddr_attr_t *));
2064ac67f02SAnurag S. Maskey extern int		dladm_walk_hwgrp(dladm_handle_t, datalink_id_t, void *,
207da14cebeSEric Cheng 			    boolean_t (*)(void *, dladm_hwgrp_attr_t *));
208da14cebeSEric Cheng 
2094ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_link_get_proplist(dladm_handle_t, datalink_id_t,
210da14cebeSEric Cheng 			    dladm_arg_list_t **);
211da14cebeSEric Cheng 
212da14cebeSEric Cheng extern dladm_status_t	i_dladm_set_link_proplist_db(char *,
213da14cebeSEric Cheng 			    dladm_arg_list_t *);
214da14cebeSEric Cheng 
215f595a68aSyz147064 #ifdef	__cplusplus
216f595a68aSyz147064 }
217f595a68aSyz147064 #endif
218f595a68aSyz147064 
219f595a68aSyz147064 #endif	/* _LIBDLLINK_H */
220