xref: /illumos-gate/usr/src/lib/libdladm/common/libdllink.h (revision 8b80e8cb6855118d46f605e91b5ed4ce83417395)
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 /*
30  * This file includes structures, macros and routines used by general
31  * link administration (i.e. not limited to one specific type of link).
32  */
33 
34 #include <sys/types.h>
35 #include <sys/param.h>
36 #include <libdladm.h>
37 #include <kstat.h>
38 
39 #ifdef	__cplusplus
40 extern "C" {
41 #endif
42 
43 typedef struct dladm_attr {
44 	uint_t		da_max_sdu;
45 } dladm_attr_t;
46 
47 typedef struct dladm_phys_attr {
48 	char		dp_dev[MAXLINKNAMELEN];
49 	/*
50 	 * Whether this physical link supports vanity naming (links with media
51 	 * types not supported by GLDv3 don't have vanity naming support).
52 	 */
53 	boolean_t	dp_novanity;
54 } dladm_phys_attr_t;
55 
56 typedef enum {
57 	DLADM_PROP_VAL_CURRENT = 1,
58 	DLADM_PROP_VAL_DEFAULT,
59 	DLADM_PROP_VAL_MODIFIABLE,
60 	DLADM_PROP_VAL_PERSISTENT
61 } dladm_prop_type_t;
62 
63 /*
64  * Maximum size of secobj value. Note that it should not be greater than
65  * DLD_SECOBJ_VAL_MAX.
66  */
67 #define	DLADM_SECOBJ_VAL_MAX	256
68 
69 /*
70  * Maximum size of secobj name. Note that it should not be greater than
71  * DLD_SECOBJ_NAME_MAX.
72  */
73 #define	DLADM_SECOBJ_NAME_MAX	32
74 
75 #define	DLADM_MAX_PROP_VALCNT	32
76 /*
77  * Size of prop_val buffer passed to pd_get function must be at
78  * least DLADM_PROP_VAL_MAX
79  */
80 #define	DLADM_PROP_VAL_MAX	128
81 
82 #define		DLADM_SECOBJ_CLASS_WEP	0
83 #define		DLADM_SECOBJ_CLASS_WPA	1
84 typedef int	dladm_secobj_class_t;
85 
86 typedef int (dladm_walkcb_t)(const char *, void *);
87 
88 extern dladm_status_t	dladm_walk(dladm_walkcb_t *, void *, datalink_class_t,
89 			    datalink_media_t, uint32_t);
90 extern dladm_status_t	dladm_mac_walk(dladm_walkcb_t *, void *);
91 extern dladm_status_t	dladm_info(datalink_id_t, dladm_attr_t *);
92 extern dladm_status_t	dladm_setzid(const char *, char *);
93 
94 extern dladm_status_t	dladm_rename_link(const char *, const char *);
95 
96 extern dladm_status_t	dladm_set_linkprop(datalink_id_t, const char *,
97 			    char **, uint_t, uint_t);
98 extern dladm_status_t	dladm_get_linkprop(datalink_id_t, dladm_prop_type_t,
99 			    const char *, char **, uint_t *);
100 extern dladm_status_t	dladm_walk_linkprop(datalink_id_t, void *,
101 			    int (*)(datalink_id_t, const char *, void *));
102 
103 extern dladm_status_t	dladm_set_secobj(const char *, dladm_secobj_class_t,
104 			    uint8_t *, uint_t, uint_t);
105 extern dladm_status_t	dladm_get_secobj(const char *, dladm_secobj_class_t *,
106 			    uint8_t *, uint_t *, uint_t);
107 extern dladm_status_t	dladm_unset_secobj(const char *, uint_t);
108 extern dladm_status_t	dladm_walk_secobj(void *,
109 			    boolean_t (*)(void *, const char *), uint_t);
110 
111 extern const char	*dladm_linkstate2str(link_state_t, char *);
112 extern const char	*dladm_linkduplex2str(link_duplex_t, char *);
113 extern const char	*dladm_secobjclass2str(dladm_secobj_class_t, char *);
114 extern dladm_status_t	dladm_str2secobjclass(const char *,
115 			    dladm_secobj_class_t *);
116 
117 extern dladm_status_t	dladm_init_linkprop(datalink_id_t, boolean_t);
118 extern dladm_status_t	dladm_init_secobj(void);
119 
120 extern dladm_status_t	dladm_create_datalink_id(const char *, datalink_class_t,
121 			    uint_t, uint32_t, datalink_id_t *);
122 extern dladm_status_t	dladm_destroy_datalink_id(datalink_id_t, uint32_t);
123 extern dladm_status_t	dladm_remap_datalink_id(datalink_id_t, const char *);
124 extern dladm_status_t	dladm_up_datalink_id(datalink_id_t);
125 extern dladm_status_t	dladm_name2info(const char *, datalink_id_t *,
126 			    uint32_t *, datalink_class_t *, uint32_t *);
127 extern dladm_status_t	dladm_datalink_id2info(datalink_id_t, uint32_t *,
128 			    datalink_class_t *, uint32_t *, char *, size_t);
129 extern dladm_status_t	dladm_walk_datalink_id(int (*)(datalink_id_t, void *),
130 			    void *, datalink_class_t, datalink_media_t,
131 			    uint32_t);
132 extern dladm_status_t	dladm_create_conf(const char *, datalink_id_t,
133 			    datalink_class_t, uint32_t, dladm_conf_t *);
134 extern dladm_status_t	dladm_read_conf(datalink_id_t, dladm_conf_t *);
135 extern dladm_status_t	dladm_write_conf(dladm_conf_t);
136 extern dladm_status_t	dladm_remove_conf(datalink_id_t);
137 extern void		dladm_destroy_conf(dladm_conf_t);
138 extern dladm_status_t	dladm_get_conf_field(dladm_conf_t, const char *,
139 			    void *, size_t);
140 extern dladm_status_t	dladm_set_conf_field(dladm_conf_t, const char *,
141 			    dladm_datatype_t, const void *);
142 extern dladm_status_t	dladm_unset_conf_field(dladm_conf_t, const char *);
143 
144 extern dladm_status_t	dladm_dev2linkid(const char *, datalink_id_t *);
145 extern dladm_status_t	dladm_linkid2legacyname(datalink_id_t, char *, size_t);
146 extern dladm_status_t	dladm_phys_delete(datalink_id_t);
147 
148 extern dladm_status_t	dladm_phys_info(datalink_id_t, dladm_phys_attr_t *,
149 			    uint32_t);
150 extern dladm_status_t	dladm_get_single_mac_stat(datalink_id_t, const char *,
151     uint8_t, void *);
152 extern int		dladm_kstat_value(kstat_t *, const char *, uint8_t,
153     void *);
154 extern dladm_status_t	dladm_parselink(const char *, char *, uint_t *);
155 
156 #ifdef	__cplusplus
157 }
158 #endif
159 
160 #endif	/* _LIBDLLINK_H */
161