usr/src/man/man9f/mioc2ack.9f

   1 '\" te
   2 .\" Copyright (c) 2004, 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 MIOC2ACK 9F "Jun 9, 2004"
   7 .SH NAME
   8 mioc2ack \- Convert an M_IOCTL message to an M_IOCACK message
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/stream.h>
  13 #include <sys/strsun.h>
  14
  15
  16
  17 \fBvoid\fR \fBmioc2ack\fR(\fBmblk_t *\fR\fImp\fR, \fBmblk_t *\fR\fIdp\fR, \fBsize_t\fR \fIcount\fR, \fBint\fR \fIrval\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fImp\fR\fR
  29 .ad
  30 .RS 9n
  31 M_IOCTL message.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIdp\fR\fR
  38 .ad
  39 .RS 9n
  40 Payload to associate with M_IOCACK message.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIcount\fR\fR
  47 .ad
  48 .RS 9n
  49 Value to set the ioc_count of the \fBiocblk\fR(9S) to.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIrval\fR\fR
  56 .ad
  57 .RS 9n
  58 Value to set the ioc_rval of the  \fBiocblk\fR(9S) to.
  59 .RE
  60
  61 .SH DESCRIPTION
  62 .sp
  63 .LP
  64 The \fBmioc2ack()\fR function converts an M_IOCTL message into an M_IOCACK
  65 message using the supplied arguments.
  66 .sp
  67 .LP
  68 To convert the message, \fBmioc2ack()\fR changes the message type to M_IOCACK,
  69 sets the \fBioc_count\fR and \fBioc_rval\fR members of the \fBiocblk\fR(9S)
  70 associated with \fImp\fR to the passed-in values, and clears the
  71 \fBioc_error\fR field. Further, it frees any message blocks chained off of
  72 \fBmp->b_cont\fR and resets \fBmp->b_cont\fR to \fIdp\fR. Finally, if \fIdp\fR
  73 is not NULL, \fBmioc2ack()\fR resets \fBdp->b_wptr\fR to be \fBdp->b_rptr +
  74 count\fR (that is, it sets \fIdp\fR to be exactly \fIcount\fR bytes in length).
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 None.
  79 .SH CONTEXT
  80 .sp
  81 .LP
  82 This function can be called from user, kernel or interrupt context.
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBmiocack\fR(9F), \fBmiocnak\fR(9F), \fBiocblk\fR(9S)
  87 .sp
  88 .LP
  89 \fISTREAMS Programming Guide\fR