Documentation update by Clement Ladish

This commit is contained in:
Jaroslav Kysela 2002-07-23 19:51:16 +00:00
parent 2db6b18b39
commit 63d708a344
15 changed files with 965 additions and 714 deletions

View file

@ -7,8 +7,8 @@
* \date 1998-2001
*
* Application interface library for the ALSA driver
*
*
*/
/*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
@ -30,25 +30,25 @@
/**
* \defgroup BConv Binary Value Conversion
* Binary Value Conversion
* Helper macros to convert binary values to/from a specific byte order.
* \{
*/
/** convert 16-bit value from host to Little Endian byte order */
/** Converts a 16-bit value from host to little endian byte order. */
#define snd_host_to_LE_16(val) __cpu_to_le16(val)
/** convert 16-bit value from Little Endian to host byte order */
/** Converts a 16-bit value from little endian to host byte order. */
#define snd_LE_to_host_16(val) __le16_to_cpu(val)
/** convert 32-bit value from host to Little Endian byte order */
/** Converts a 32-bit value from host to little endian byte order. */
#define snd_host_to_LE_32(val) __cpu_to_le32(val)
/** convert 32-bit value from Little Endian to host byte order */
/** Converts a 32-bit value from little endian to host byte order. */
#define snd_LE_to_host_32(val) __le32_to_cpu(val)
/** convert 16-bit value from host to Big Endian byte order */
/** Converts a 16-bit value from host to big endian byte order. */
#define snd_host_to_BE_16(val) __cpu_to_be16(val)
/** convert 16-bit value from Big Endian to host byte order */
/** Converts a 16-bit value from big endian to host byte order. */
#define snd_BE_to_host_16(val) __be16_to_cpu(val)
/** convert 32-bit value from host to Big Endian byte order */
/** Converts a 32-bit value from host to big endian byte order. */
#define snd_host_to_BE_32(val) __cpu_to_be32(val)
/** convert 32-bit value from Big Endian to host byte order */
/** Converts a 32-bit value from big endian to host byte order. */
#define snd_BE_to_host_32(val) __be32_to_cpu(val)
/** \} */