ath9k_htc/target_firmware/magpie_fw_dev/target/inc/adf_os_util.h

   1 /*
   2  * Copyright (c) 2013 Qualcomm Atheros, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted (subject to the limitations in the
   7  * disclaimer below) provided that the following conditions are met:
   8  *
   9  *  * Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  *  * Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the
  15  *    distribution.
  16  *
  17  *  * Neither the name of Qualcomm Atheros nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  22  * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
  23  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  33  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 /**
  36  * @ingroup adf_os_public
  37  * @file adf_os_util.h
  38  * This file defines utility functions.
  39  */
  40
  41 #ifndef _ADF_OS_UTIL_H
  42 #define _ADF_OS_UTIL_H
  43
  44 #include <adf_os_util_pvt.h>
  45
  46 /**
  47  * @brief Compiler-dependent macro denoting code likely to execute.
  48  */
  49 #define adf_os_unlikely(_expr)     __adf_os_unlikely(_expr)
  50
  51 /**
  52  * @brief Compiler-dependent macro denoting code unlikely to execute.
  53  */
  54 #define adf_os_likely(_expr)       __adf_os_likely(_expr)
  55
  56 /**
  57  * @brief read memory barrier.
  58  */
  59 #define adf_os_wmb()                __adf_os_wmb()
  60
  61 /**
  62  * @brief write memory barrier.
  63  */
  64 #define adf_os_rmb()                __adf_os_rmb()
  65
  66 /**
  67  * @brief read + write memory barrier.
  68  */
  69 #define adf_os_mb()                 __adf_os_mb()
  70
  71 /**
  72  * @brief return the lesser of a, b
  73  */
  74 #define adf_os_min(_a, _b)          __adf_os_min(_a, _b)
  75
  76 /**
  77  * @brief return the larger of a, b
  78  */
  79 #define adf_os_max(_a, _b)          __adf_os_max(_a, _b)
  80
  81 /**
  82  * @brief assert "expr" evaluates to true.
  83  */
  84 #define adf_os_assert(expr)         __adf_os_assert(expr)
  85
  86 /**
  87  * @brief supply pseudo-random numbers
  88  */
  89 static inline void adf_os_get_rand(adf_os_handle_t  hdl,
  90                                    a_uint8_t       *ptr,
  91                                    a_uint32_t       len)
  92 {
  93     __adf_os_get_rand(hdl, ptr, len);
  94 }
  95
  96 #endif /*_ADF_OS_UTIL_H*/