xref: /illumos-gate/usr/src/man/man9f/swab.9f (revision cd61ae21816e53b94bc1673f3f1aa651fc3115e8)
te
Copyright (c) 2006, Sun Microsystems, Inc.
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.
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.
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]
SWAB 9F "Jan 16, 2006"
NAME
swab - swap bytes in 16-bit halfwords
SYNOPSIS

#include <sys/sunddi.h>



void swab(void *src, void *dst, size_t nbytes);
INTERFACE LEVEL

Architecture independent level 1 (DDI/DKI).

PARAMETERS
src

A pointer to the buffer containing the bytes to be swapped.

dst

A pointer to the destination buffer where the swapped bytes will be written. If dst is the same as src the buffer will be swapped in place.

nbytes

Number of bytes to be swapped, rounded down to the nearest half-word.

DESCRIPTION

The swab() function copies the bytes in the buffer pointed to by src to the buffer pointer to by dst, swapping the order of adjacent bytes in half-word pairs as the copy proceeds. A total of nbytes bytes are copied, rounded down to the nearest half-word.

CONTEXT

The swab() function can be called from user, interrupt, or kernel context.

SEE ALSO

Writing Device Drivers

NOTES

Since swab() operates byte-by-byte, it can be used on non-aligned buffers.