xref: /onnv-gate/usr/src/uts/common/sys/netlb.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 1992-2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_NETLB_H
28*0Sstevel@tonic-gate #define	_NETLB_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * The following ioctls may be implemented by any network driver
38*0Sstevel@tonic-gate  * that provides loopback functionality.
39*0Sstevel@tonic-gate  */
40*0Sstevel@tonic-gate #define	LB_IOC			('U' << 8)
41*0Sstevel@tonic-gate #define	LB_GET_INFO_SIZE	(LB_IOC|0)	/* Get size of loopback info */
42*0Sstevel@tonic-gate #define	LB_GET_INFO		(LB_IOC|1)	/* Get loopback info table   */
43*0Sstevel@tonic-gate #define	LB_GET_MODE		(LB_IOC|2)	/* Get current loopback mode */
44*0Sstevel@tonic-gate #define	LB_SET_MODE		(LB_IOC|3)	/* Set current loopback mode */
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate /*
47*0Sstevel@tonic-gate  * The 'loopback info' is a table (array) of available loopback modes.
48*0Sstevel@tonic-gate  * Each has a generic type (normal/external/internal), a name (e.g. the
49*0Sstevel@tonic-gate  * speed or style of loopback implemented), and a key value, used in the
50*0Sstevel@tonic-gate  * GET_MODE and SET_MODE commands.
51*0Sstevel@tonic-gate  *
52*0Sstevel@tonic-gate  * So, a loopback-test program could:
53*0Sstevel@tonic-gate  *	open the network device
54*0Sstevel@tonic-gate  *	use the LB_GET_INFO_SIZE ioctl (parameter: &size)
55*0Sstevel@tonic-gate  *		to find the size of the info array
56*0Sstevel@tonic-gate  *	allocate some space for the info array
57*0Sstevel@tonic-gate  *	use the LB_GET_INFO ioctl (parameter: infoptr)
58*0Sstevel@tonic-gate  *		to get the whole info array
59*0Sstevel@tonic-gate  *	search the array for a particular type of loopback (e.g. internal),
60*0Sstevel@tonic-gate  *	or display all the available modes for the user to select one
61*0Sstevel@tonic-gate  *	use the LB_GET_MODE ioctl (parameter: &oldmode)
62*0Sstevel@tonic-gate  *		to get the current mode
63*0Sstevel@tonic-gate  *	use the LB_SET_MODE ioctl (parameter: &newmode)
64*0Sstevel@tonic-gate  *		to set the new mode
65*0Sstevel@tonic-gate  *	perform the test(s)
66*0Sstevel@tonic-gate  *	use the LB_SET_MODE ioctl (parameter: &oldmode)
67*0Sstevel@tonic-gate  *		to restore the new mode
68*0Sstevel@tonic-gate  */
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate typedef uint32_t lb_info_sz_t;
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate typedef enum {
73*0Sstevel@tonic-gate 	normal,
74*0Sstevel@tonic-gate 	external,
75*0Sstevel@tonic-gate 	internal
76*0Sstevel@tonic-gate } lb_type_t;
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate typedef struct _lb_property_t {
79*0Sstevel@tonic-gate 	lb_type_t	lb_type;
80*0Sstevel@tonic-gate 	char		key[16];
81*0Sstevel@tonic-gate 	uint32_t	value;
82*0Sstevel@tonic-gate } lb_property_t, *p_lb_property_t;
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate #ifdef	__cplusplus
85*0Sstevel@tonic-gate }
86*0Sstevel@tonic-gate #endif
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate #endif /* _NETLB_H */
89