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

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\"  Copyright (c) 1997, Sun Microsystems, Inc.  All Rights Reserved
   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 READ 9E "Nov 19, 1997"
   8 .SH NAME
   9 read \- read data from a device
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/errno.h>
  15 #include <sys/open.h>
  16 #include <sys/uio.h>
  17 #include <sys/cred.h>
  18 #include <sys/ddi.h>
  19 #include <sys/sunddi.h>
  20
  21
  22
  23 \fBint prefix\fR\fBread\fR(\fBdev_t\fR \fIdev\fR, \fBstruct uio *\fR\fIuio_p\fR, \fBcred_t *\fR\fIcred_p\fR);
  24 .fi
  25
  26 .SH INTERFACE LEVEL
  27 .sp
  28 .LP
  29 Architecture independent level 1 (DDI/DKI). This entry point is \fIoptional\fR.
  30 .SH PARAMETERS
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIdev\fR \fR
  35 .ad
  36 .RS 11n
  37 Device number.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIuio_p\fR \fR
  44 .ad
  45 .RS 11n
  46 Pointer to the  \fBuio\fR(9S) structure that describes where the data is to be
  47 stored in user space.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIcred_p\fR \fR
  54 .ad
  55 .RS 11n
  56 Pointer to the  user credential structure for the \fBI/O \fRtransaction.
  57 .RE
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The driver  \fBread()\fR routine is called indirectly through \fBcb_ops\fR(9S)
  63 by the  \fBread\fR(2) system call. The  \fBread()\fR routine should check the
  64 validity of the minor number component of \fIdev\fR and the user credential
  65 structure pointed to by  \fIcred_p\fR (if pertinent). The  \fBread()\fR routine
  66 should supervise the data transfer into the user space described by the
  67 \fBuio\fR(9S) structure.
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 The  \fBread()\fR routine should return  \fB0\fR for success, or the
  72 appropriate error number.
  73 .SH EXAMPLES
  74 .LP
  75 \fBExample 1 \fR\fBread()\fR routine using \fBphysio()\fR
  76 .sp
  77 .LP
  78 The following is an example of a \fBread()\fR routine using \fBphysio\fR(9F) to
  79 perform reads from a non-seekable device:
  80
  81 .sp
  82 .in +2
  83 .nf
  84       static int
  85       xxread(dev_t dev, struct uio *uiop, cred_t *credp)
  86       {
  87                int                 rval;
  88                offset_t            off;
  89                int                 instance;
  90                xx_t                xx;
  91
  92                instance = getminor(dev);
  93                xx = ddi_get_soft_state(xxstate, instance);
  94                if (xx == NULL)
  95                          return (ENXIO);
  96                off = uiop->uio_loffset;
  97                rval = physio(xxstrategy, NULL, dev, B_READ,
  98                          xxmin, uiop);
  99                uiop->uio_loffset = off;
 100                return (rval);
 101       }
 102 .fi
 103 .in -2
 104
 105 .SH SEE ALSO
 106 .sp
 107 .LP
 108 \fBread\fR(2), \fBwrite\fR(9E), \fBphysio\fR(9F), \fBcb_ops\fR(9S),
 109 \fBuio\fR(9S)
 110 .sp
 111 .LP
 112 \fIWriting Device Drivers\fR