share/man/man9f/swab.9f

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc.
   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 SWAB 9F "Jan 16, 2006"
   7 .SH NAME
   8 swab \- swap bytes in 16-bit halfwords
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/sunddi.h>
  13
  14
  15
  16 \fBvoid\fR \fBswab\fR(\fBvoid *\fR\fIsrc\fR, \fBvoid *\fR\fIdst\fR, \fBsize_t\fR \fInbytes\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Architecture independent level 1 (DDI/DKI).
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIsrc\fR\fR
  28 .ad
  29 .RS 10n
  30 A pointer to the buffer containing the bytes to be swapped.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIdst\fR\fR
  37 .ad
  38 .RS 10n
  39 A pointer to the destination buffer where the swapped bytes will be written. If
  40 \fIdst\fR is the same as \fIsrc\fR the buffer will be swapped in place.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fInbytes\fR\fR
  47 .ad
  48 .RS 10n
  49 Number of bytes to be swapped, rounded down to the nearest half-word.
  50 .RE
  51
  52 .SH DESCRIPTION
  53 .sp
  54 .LP
  55 The \fBswab()\fR function copies the bytes in the buffer pointed to by
  56 \fIsrc\fR to the buffer pointer to by \fIdst\fR, swapping the order of adjacent
  57 bytes in half-word pairs as the copy proceeds. A total of \fInbytes\fR bytes
  58 are copied, rounded down to the nearest half-word.
  59 .SH CONTEXT
  60 .sp
  61 .LP
  62 The \fBswab()\fR function can be called from user, interrupt, or kernel
  63 context.
  64 .SH SEE ALSO
  65 .sp
  66 .LP
  67 \fIWriting Device Drivers\fR
  68 .SH NOTES
  69 .sp
  70 .LP
  71 Since \fBswab()\fR operates byte-by-byte, it can be used on non-aligned
  72 buffers.