dld_ioc.h revision 8275:7c223a798022 
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	_SYS_DLD_IOC_H
27#define	_SYS_DLD_IOC_H
28
29#include <sys/types.h>
30#include <sys/cred.h>
31
32#ifdef	__cplusplus
33extern "C" {
34#endif
35
36/*
37 * The name of the dld control device.  All GLDv3 control ioctls are
38 * performed on this device.
39 */
40#define	DLD_CONTROL_DEV		"/dev/dld"
41
42/*
43 * GLDv3 ioctl values are structured as follows:
44 *
45 * |    16-bits     |     16-bits    |
46 * +----------------+----------------+
47 * |   module-id    |   command-id   |
48 * +----------------+----------------+
49 */
50#define	DLD_IOC_CMD(modid, cmdid)	(((uint_t)(modid) << 16) | (cmdid))
51#define	DLD_IOC_MODID(cmd)		(((cmd) & 0xffff0000) >> 16)
52/*
53 * GLDv3 module ids to be passed in as the first argument to
54 * dld_ioc_register() and dld_ioc_unregister().
55 */
56#define	DLD_IOC		0x0D1D
57#define	AGGR_IOC	0x0A66
58#define	VNIC_IOC	0x0171
59
60/* GLDv3 modules use these macros to generate unique ioctl commands */
61#define	DLDIOC(cmdid)	DLD_IOC_CMD(DLD_IOC, (cmdid))
62#define	AGGRIOC(cmdid)	DLD_IOC_CMD(AGGR_IOC, (cmdid))
63#define	VNICIOC(cmdid)	DLD_IOC_CMD(VNIC_IOC, (cmdid))
64
65#ifdef _KERNEL
66
67/*
68 * GLDv3 modules register the ioctls they're interested in by passing
69 * in an array of dld_ioc_info_t to dld_ioc_register().  Modules
70 * should call dld_ioc_register() either in _init() or attach().  The
71 * dld module assumes that ddi_hold_devi_by_instance(<module>, 0, 0)
72 * will cause the module to load and call dld_ioc_register().
73 *
74 * The di_cmd field is an ioctl command generated using one of the
75 * macros above.  The di_argsize value is used by dld to copyin or
76 * copyout the correct amount of data depending on whether the
77 * DLDCOPYIN or DLDCOPYOUT flags are set so that every di_func()
78 * callback function does not need to copyin/out its own data.
79 */
80
81/* Maximum number of Privileges */
82#define	DLD_MAX_PRIV	16
83
84typedef int (dld_ioc_func_t)(void *, intptr_t, int, cred_t *, int *);
85typedef struct dld_ioc_info {
86	uint_t		di_cmd;
87	uint_t		di_flags;
88	size_t		di_argsize;
89	dld_ioc_func_t	*di_func;
90	const char	*di_priv[DLD_MAX_PRIV];
91} dld_ioc_info_t;
92
93/* Values for di_flags */
94#define	DLDCOPYIN	0x00000001 /* copyin di_argsize amount of data */
95#define	DLDCOPYOUT	0x00000002 /* copyout di_argsize amount of data */
96#define	DLDCOPYINOUT	(DLDCOPYIN | DLDCOPYOUT)
97
98#define	DLDIOCCNT(l)	(sizeof (l) / sizeof (dld_ioc_info_t))
99int	dld_ioc_register(uint16_t, dld_ioc_info_t *, uint_t);
100void	dld_ioc_unregister(uint16_t);
101
102#endif /* _KERNEL */
103
104#ifdef	__cplusplus
105}
106#endif
107
108#endif	/* _SYS_DLD_IOC_H */
109