usr/src/man/man3dlpi/dlpi_promiscon.3dlpi

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DLPI_PROMISCON 3DLPI "Aug 22, 2007"
   7 .SH NAME
   8 dlpi_promiscon, dlpi_promiscoff \- enable or disable DLPI promiscuous mode
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldlpi\fR [ \fIlibrary\fR... ]
  13 #include <libdlpi.h>
  14
  15 \fBint\fR \fBdlpi_promiscon\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBuint_t\fR \fIlevel\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBdlpi_promiscoff\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBuint_t\fR \fIlevel\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBdlpi_promiscon()\fR function enables promiscuous mode on a \fBDLPI\fR
  27 link instance associated with \fBDLPI\fR handle \fIdh\fR, at the specified
  28 \fIlevel\fR. After enabling promiscuous mode, the caller will be able to
  29 receive all messages destined for the \fBDLPI\fR link instance at the specified
  30 \fIlevel\fR. This operation can be performed in any \fBDLPI\fR state of a
  31 handle.
  32 .sp
  33 .LP
  34 The \fBdlpi_promiscoff()\fR function disables promiscuous mode on a \fBDLPI\fR
  35 link instance associated with \fBDLPI\fR handle \fIdh\fR, at the specified
  36 level. This operation can be performed in any \fBDLPI\fR state of a handle in
  37 which promiscuous mode is enabled at the specified \fIlevel\fR.
  38 .sp
  39 .LP
  40 The \fIlevel\fR modes are:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBDL_PROMISC_PHYS\fR\fR
  45 .ad
  46 .RS 20n
  47 Promiscuous mode at the physical level
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBDL_PROMISC_SAP\fR\fR
  54 .ad
  55 .RS 20n
  56 Promiscuous mode at the \fBSAP\fR level
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBDL_PROMISC_MULTI\fR\fR
  63 .ad
  64 .RS 20n
  65 Promiscuous mode for all multicast addresses
  66 .RE
  67
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 Upon success, \fBDLPI_SUCCESS\fR is  returned. If \fBDL_SYSERR\fR is returned,
  72 \fBerrno\fR contains the specific UNIX system error value. Otherwise, a
  73 \fBDLPI\fR error value defined in \fB<sys/dlpi.h>\fR or an error value listed
  74 in the following section is returned.
  75 .SH ERRORS
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBDLPI_EBADMSG\fR\fR
  80 .ad
  81 .RS 18n
  82 Bad DLPI message
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBDLPI_EINHANDLE\fR\fR
  89 .ad
  90 .RS 18n
  91 Invalid \fBDLPI\fR handle
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBDLPI_EINVAL\fR\fR
  98 .ad
  99 .RS 18n
 100 Invalid argument
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBDLPI_ETIMEDOUT\fR\fR
 107 .ad
 108 .RS 18n
 109 \fBDLPI\fR operation timed out
 110 .RE
 111
 112 .SH ATTRIBUTES
 113 .sp
 114 .LP
 115 See \fBattributes\fR(5) for description of the following attributes:
 116 .sp
 117
 118 .sp
 119 .TS
 120 box;
 121 c | c
 122 l | l .
 123 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 124 _
 125 Interface Stability     Committed
 126 _
 127 MT-Level        Safe
 128 .TE
 129
 130 .SH SEE ALSO
 131 .sp
 132 .LP
 133 \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)