usr/src/man/man9e/aread.9e

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH AREAD 9E "Mar 28, 1997"
   8 .SH NAME
   9 aread \- asynchronous read from a device
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/uio.h>
  14 #include <sys/aio_req.h>
  15 #include <sys/cred.h>
  16 #include <sys/ddi.h>
  17 #include <sys/sunddi.h>
  18 int\fIprefix\fR
  19
  20 \fB\fR\fBaread\fR(\fBdev_t\fR \fIdev\fR, \fBstruct aio_req *\fR\fIaio_reqp\fR, \fBcred_t *\fR\fIcred_p\fR);
  21 .fi
  22
  23 .SH INTERFACE LEVEL
  24 .sp
  25 .LP
  26 Solaris \fBDDI \fRspecific (Solaris DDI). This entry point is \fIoptional\fR.
  27 Drivers that do not support an \fBaread()\fR entry point should use
  28 \fBnodev\fR(9F)
  29 .SH PARAMETERS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIdev\fR \fR
  34 .ad
  35 .RS 13n
  36 Device number.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIaio_reqp\fR \fR
  43 .ad
  44 .RS 13n
  45 Pointer to the \fBaio_req\fR(9S) structure that describes where the data is to
  46 be stored.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fIcred_p\fR \fR
  53 .ad
  54 .RS 13n
  55 Pointer to the credential structure.
  56 .RE
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The driver's \fBaread()\fR routine is called to perform an asynchronous read.
  62 \fBgetminor\fR(9F) can be used to access the minor number component of the
  63 \fIdev\fR argument. \fBaread()\fR may use the credential structure pointed to
  64 by \fIcred_p\fR to check for superuser access by calling \fBdrv_priv\fR(9F).
  65 The \fBaread()\fR routine may also examine the \fBuio\fR(9S) structure through
  66 the \fBaio_req\fR structure pointer, \fIaio_reqp\fR. \fBaread()\fR must call
  67 \fBaphysio\fR(9F) with the \fBaio_req\fR pointer and a pointer to the driver's
  68 \fBstrategy\fR(9E) routine.
  69 .sp
  70 .LP
  71 No fields of the \fBuio\fR(9S) structure pointed to by \fBaio_req\fR, other
  72 than \fBuio_offset\fR or \fBuio_loffset\fR, may be modified for non-seekable
  73 devices.
  74 .SH RETURN VALUES
  75 .sp
  76 .LP
  77 The \fBaread()\fR routine should return \fB0\fR for success, or the appropriate
  78 error number.
  79 .SH CONTEXT
  80 .sp
  81 .LP
  82 This function is called from user context only.
  83 .SH EXAMPLES
  84 .LP
  85 \fBExample 1 \fRThe following is an example of an \fBaread()\fR routine:
  86 .sp
  87 .in +2
  88 .nf
  89 static int
  90 xxaread(dev_t dev, struct aio_req *aio, cred_t *cred_p)
  91 {
  92         int instance;
  93         struct xxstate *xsp;
  94         instance = getminor(dev);
  95         xsp = ddi_get_soft_state(statep, instance);
  96         /*Verify soft state structure has been allocated */
  97         if (xsp == NULL)
  98                 return (ENXIO);
  99         return (aphysio(xxstrategy, anocancel,
 100                                         dev, B_READ, xxminphys, aio));
 101 }
 102 .fi
 103 .in -2
 104
 105 .SH SEE ALSO
 106 .sp
 107 .LP
 108 \fBread\fR(2), \fBaioread\fR(3C), \fBawrite\fR(9E), \fBread\fR(9E),
 109 \fBstrategy\fR(9E), \fBwrite\fR(9E), \fBanocancel\fR(9F), \fBaphysio\fR(9F),
 110 \fBddi_get_soft_state\fR(9F), \fBdrv_priv\fR(9F), \fBgetminor\fR(9F),
 111 \fBminphys\fR(9F), \fBnodev\fR(9F), \fBaio_req\fR(9S), \fBcb_ops\fR(9S),
 112 \fBuio\fR(9S)
 113 .sp
 114 .LP
 115 \fIWriting Device Drivers\fR
 116 .SH BUGS
 117 .sp
 118 .LP
 119 There is no way other than calling \fBaphysio\fR(9F) to accomplish an
 120 asynchronous read.