man/man9f/mcopyin.9f

         te
 Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
 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.
 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.
 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]
 mcopyin 9F "9 June 2004" "SunOS 5.11" "Kernel Functions for Drivers"
 NAME
mcopyin - Convert an M_IOCTL or M_IOCDATA message to an M_COPYIN
 SYNOPSIS

#include <sys/stream.h>
#include <sys/strsun.h>


void mcopyin(mblk_t *mp, void *private, size_t size,
 void * useraddr);


 INTERFACE LEVEL

Solaris DDI specific (Solaris DDI).
 PARAMETERS

mp

M_IOCTL or M_IOCDATA message.


private

Value to which the cq_private field of copyreq(9S) is set.


size

Value to which the cq_size field of copyreq(9S) is set.


useraddr

Optionally, the value to which the cq_addr field of copyreq(9S) is
set.


 DESCRIPTION

The mcopyin() function converts an M_IOCTL or M_IOCDATA message into an
M_COPYIN message using the supplied arguments.

To convert the message, mcopyin() changes the message type to M_COPYIN,
and its payload from a iocblk(9S) to a copyreq(9S). Since the
iocblk(9S) and copyreq(9S) are designed to overlay one another, the
only fields which must be updated are cq_private, cq_size, and
cq_addr, which are set to the supplied values. If useraddr is
passed as NULL, mp must be a transparent M_IOCTL, and cq_addr is
assigned the pointer-sized quantity found at mp->b_cont->b_rptr.

Any trailing message blocks associated with mp are freed.
 RETURN VALUES

None.
 CONTEXT

This function can be called from user, kernel or interrupt context.
 SEE ALSO

mcopyout(9F), copyreq(9S)

STREAMS Programming Guide