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