NAME

ddi_copyout − copy data from a driver

SYNOPSIS

#include <sys/types.h>
#include <sys/ddi.h>
#include <sys/sunddi.h>

int ddi_copyout(caddr_t driverbuf, caddr_t buf, size_t cn, int flags);

ARGUMENTS

driverbuf Source address in the driver from which the data is transferred. 

buf Destination address to which the data is transferred. 

cn Number of bytes moved. 

flags Set of flag bits that provide address space information about buf.

INTERFACE LEVEL

Solaris architecture specific (SunDDI). 

DESCRIPTION

This routine is designed for use in driver ioctl(9E) routines for drivers that support layered ioctls.  ddi_copyout() copies data from driver buffers to a destination address, buf.

The flags argument is used to determine the address space information about buf. If the FKIOCTL flag is set, this indicates that buf is a kernel address, and ddi_copyout() behaves like bcopy(9F).  Otherwise buf is interpreted as a user buffer address, and ddi_copyout() behaves like copyout(9F). 

Addresses that are word-aligned are moved most efficiently.  However, the driver developer is not obliged to ensure alignment.  This function automatically finds the most efficient move algorithm according to address alignment. 

RETURN VALUES

ddi_copyout() returns 0 to indicate a successful copy.  Otherwise, it returns −1, indicating that the specified address range is not valid. 

If a −1 is returned to the caller, driver entry point routines should return EFAULT. 

CONTEXT

ddi_copyout() can be called from user context only.

EXAMPLES

A driver ioctl(9E) routine (line 9) can be used to get or set device attributes or registers.  In the XX_GETREGS condition (line 17), the driver copies the current device register values to another data area (line 18).  If the specified argument contains an invalid address, an error code is returned. 

 1  struct  device  {      /∗ layout of physical device registers  ∗/
 2          int      control;     /∗ physical device control word  ∗/
 3          int      status;      /∗ physical device status word   ∗/
 4          short    recv_char;   /∗ receive character from device ∗/
 5          short    xmit_char;   /∗ transmit character to device  ∗/
 6  }; /∗ end device ∗/
 7
 8  extern struct device xx_addr[]; /∗ phys. device regs. location ∗/
      . . .
 9  xx_ioctl(dev, cmd, arg, mode, cred_p, rval_p)
10          dev_t   dev;
11          int     cmd, arg;
12               ...
13  {
14      register struct device ∗rp = &xx_addr[getminor(dev) >> 4];
15      switch (cmd)  {
16
17      case XX_GETREGS:     /∗ copy device regs. to caller ∗/
18            if (ddi_copyout((caddr_t)rp, (caddr_t)arg,
19                sizeof (struct device), mode) != 0) {
20                    return (EFAULT);
21                    /∗ endif ∗/
22            }
23            break;

SEE ALSO

bcopy(9F), copyin(9F), copyout(9F), ddi_copyin(9F), uiomove(9F)

SunOS 5.1 Writing Device Drivers

NOTES

The value of the flags argument to ddi_copyout() should be passed through directly from the mode argument of ioctl() untranslated.

SunOS 5.1  —  Last change: 31 May 1993