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

   1 '\" te
   2 .\"  Copyright (c) 1996, 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 CSX_GET8 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_Get8, csx_Get16, csx_Get32, csx_Get64 \- read data from device address
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBuint8_t\fR \fBcsx_Get8\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint32_t\fR \fIoffset\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBuint16_t\fR \fBcsx_Get16\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint32_t\fR \fIoffset\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBuint32_t\fR \fBcsx_Get32\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint32_t\fR \fIoffset\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBuint64_t\fR \fBcsx_Get64\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint64_t\fR \fIoffset\fR);
  32 .fi
  33
  34 .SH INTERFACE LEVEL
  35 .sp
  36 .LP
  37 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  38 .SH PARAMETERS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIhandle\fR \fR
  43 .ad
  44 .RS 11n
  45 The access handle returned from \fBcsx_RequestIO\fR(9F),
  46 \fBcsx_RequestWindow\fR(9F), or \fBcsx_DupHandle\fR(9F).
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fIoffset\fR \fR
  53 .ad
  54 .RS 11n
  55 The offset in bytes from the base of the mapped resource.
  56 .RE
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 These functions generate a read of various sizes from the mapped memory or
  62 device register.
  63 .sp
  64 .LP
  65 The \fBcsx_Get8()\fR, \fBcsx_Get16()\fR, \fBcsx_Get32()\fR, and
  66 \fBcsx_Get64()\fR functions read 8 bits, 16 bits, 32 bits, and 64 bits of data,
  67 respectively, from the device address represented by the handle, \fIhandle\fR,
  68 at an offset in bytes represented by the offset, \fIoffset\fR.
  69 .sp
  70 .LP
  71 Data that consists of more than one byte will automatically be translated to
  72 maintain a consistent view between the host and the device based on the encoded
  73 information in the data access handle. The translation may involve byte
  74 swapping if the host and the device have incompatible endian characteristics.
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 These functions return the value read from the mapped address.
  79 .SH CONTEXT
  80 .sp
  81 .LP
  82 These functions may be called from user, kernel, or interrupt context.
  83 .SH SEE ALSO
  84 .sp
  85 .LP
  86 \fBcsx_DupHandle\fR(9F), \fBcsx_GetMappedAddr\fR(9F), \fBcsx_Put8\fR(9F),
  87 \fBcsx_RepGet8\fR(9F), \fBcsx_RepPut8\fR(9F), \fBcsx_RequestIO\fR(9F),
  88 \fBcsx_RequestWindow\fR(9F)
  89 .sp
  90 .LP
  91 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA