xref: /illumos-gate/usr/src/lib/libdladm/common/libdllink.h (revision 00954d7bf18589273e08e0d7fa824c69ce96e70b)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _LIBDLLINK_H
27 #define	_LIBDLLINK_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 /*
32  * This file includes structures, macros and routines used by general
33  * link administration (i.e. not limited to one specific type of link).
34  */
35 
36 #include <sys/types.h>
37 #include <sys/param.h>
38 #include <libdladm.h>
39 
40 #ifdef	__cplusplus
41 extern "C" {
42 #endif
43 
44 typedef struct dladm_attr {
45 	uint_t		da_max_sdu;
46 } dladm_attr_t;
47 
48 typedef struct dladm_phys_attr {
49 	char		dp_dev[MAXLINKNAMELEN];
50 	/*
51 	 * Whether this physical link supports vanity naming (links with media
52 	 * types not supported by GLDv3 don't have vanity naming support).
53 	 */
54 	boolean_t	dp_novanity;
55 } dladm_phys_attr_t;
56 
57 typedef enum {
58 	DLADM_PROP_VAL_CURRENT = 1,
59 	DLADM_PROP_VAL_DEFAULT,
60 	DLADM_PROP_VAL_MODIFIABLE,
61 	DLADM_PROP_VAL_PERSISTENT
62 } dladm_prop_type_t;
63 
64 /*
65  * Maximum size of secobj value. Note that it should not be greater than
66  * DLD_SECOBJ_VAL_MAX.
67  */
68 #define	DLADM_SECOBJ_VAL_MAX	256
69 
70 /*
71  * Maximum size of secobj name. Note that it should not be greater than
72  * DLD_SECOBJ_NAME_MAX.
73  */
74 #define	DLADM_SECOBJ_NAME_MAX	32
75 
76 #define	DLADM_MAX_PROP_VALCNT	32
77 #define	DLADM_PROP_VAL_MAX	128
78 
79 #define		DLADM_SECOBJ_CLASS_WEP	0
80 #define		DLADM_SECOBJ_CLASS_WPA	1
81 typedef int	dladm_secobj_class_t;
82 
83 typedef int (dladm_walkcb_t)(const char *, void *);
84 
85 extern dladm_status_t	dladm_walk(dladm_walkcb_t *, void *, datalink_class_t,
86 			    datalink_media_t, uint32_t);
87 extern dladm_status_t	dladm_mac_walk(dladm_walkcb_t *, void *);
88 extern dladm_status_t	dladm_info(datalink_id_t, dladm_attr_t *);
89 extern dladm_status_t	dladm_setzid(const char *, zoneid_t);
90 extern dladm_status_t	dladm_getzid(datalink_id_t, zoneid_t *);
91 
92 extern dladm_status_t	dladm_rename_link(const char *, const char *);
93 
94 extern dladm_status_t	dladm_set_linkprop(datalink_id_t, const char *,
95 			    char **, uint_t, uint_t);
96 extern dladm_status_t	dladm_get_linkprop(datalink_id_t, dladm_prop_type_t,
97 			    const char *, char **, uint_t *);
98 extern dladm_status_t	dladm_walk_linkprop(datalink_id_t, void *,
99 			    int (*)(datalink_id_t, const char *, void *));
100 
101 extern dladm_status_t	dladm_set_secobj(const char *, dladm_secobj_class_t,
102 			    uint8_t *, uint_t, uint_t);
103 extern dladm_status_t	dladm_get_secobj(const char *, dladm_secobj_class_t *,
104 			    uint8_t *, uint_t *, uint_t);
105 extern dladm_status_t	dladm_unset_secobj(const char *, uint_t);
106 extern dladm_status_t	dladm_walk_secobj(void *,
107 			    boolean_t (*)(void *, const char *), uint_t);
108 
109 extern const char	*dladm_linkstate2str(link_state_t, char *);
110 extern const char	*dladm_linkduplex2str(link_duplex_t, char *);
111 extern const char	*dladm_secobjclass2str(dladm_secobj_class_t, char *);
112 extern dladm_status_t	dladm_str2secobjclass(const char *,
113 			    dladm_secobj_class_t *);
114 
115 extern dladm_status_t	dladm_init_linkprop(datalink_id_t);
116 extern dladm_status_t	dladm_init_secobj(void);
117 
118 extern dladm_status_t	dladm_create_datalink_id(const char *, datalink_class_t,
119 			    uint_t, uint32_t, datalink_id_t *);
120 extern dladm_status_t	dladm_destroy_datalink_id(datalink_id_t, uint32_t);
121 extern dladm_status_t	dladm_remap_datalink_id(datalink_id_t, const char *);
122 extern dladm_status_t	dladm_up_datalink_id(datalink_id_t);
123 extern dladm_status_t	dladm_name2info(const char *, datalink_id_t *,
124 			    uint32_t *, datalink_class_t *, uint32_t *);
125 extern dladm_status_t	dladm_datalink_id2info(datalink_id_t, uint32_t *,
126 			    datalink_class_t *, uint32_t *, char *, size_t);
127 extern dladm_status_t	dladm_walk_datalink_id(int (*)(datalink_id_t, void *),
128 			    void *, datalink_class_t, datalink_media_t,
129 			    uint32_t);
130 extern dladm_status_t	dladm_create_conf(const char *, datalink_id_t,
131 			    datalink_class_t, uint32_t, dladm_conf_t *);
132 extern dladm_status_t	dladm_read_conf(datalink_id_t, dladm_conf_t *);
133 extern dladm_status_t	dladm_write_conf(dladm_conf_t);
134 extern dladm_status_t	dladm_remove_conf(datalink_id_t);
135 extern void		dladm_destroy_conf(dladm_conf_t);
136 extern dladm_status_t	dladm_get_conf_field(dladm_conf_t, const char *,
137 			    void *, size_t);
138 extern dladm_status_t	dladm_set_conf_field(dladm_conf_t, const char *,
139 			    dladm_datatype_t, const void *);
140 extern dladm_status_t	dladm_unset_conf_field(dladm_conf_t, const char *);
141 
142 extern dladm_status_t	dladm_dev2linkid(const char *, datalink_id_t *);
143 extern dladm_status_t	dladm_linkid2legacyname(datalink_id_t, char *, size_t);
144 extern dladm_status_t	dladm_phys_delete(datalink_id_t);
145 
146 extern dladm_status_t	dladm_phys_info(datalink_id_t, dladm_phys_attr_t *,
147 			    uint32_t);
148 
149 #ifdef	__cplusplus
150 }
151 #endif
152 
153 #endif	/* _LIBDLLINK_H */
154