target_firmware/magpie_fw_dev/target/inc/adf_os_io.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_io.h
  38  * This file abstracts I/O operations.
  39  */
  40
  41 #ifndef _ADF_OS_IO_H
  42 #define _ADF_OS_IO_H
  43
  44 #include <adf_os_io_pvt.h>
  45
  46 /**
  47  * @brief Read a 32-bit register value
  48  *
  49  * @param[in] addr    register addr
  50  *
  51  * @return A 32-bit register value.
  52  */
  53 static inline a_uint32_t ioread32(a_uint32_t addr)
  54 {
  55         return *(const volatile a_uint32_t *) addr;
  56 }
  57
  58 #define ioread32_mac(addr)      ioread32(WLAN_BASE_ADDRESS + (addr))
  59
  60 /**
  61  * @brief Write a 32-bit value into register
  62  *
  63  * @param[in] osdev   platform device object
  64  * @param[in] addr    register addr
  65  * @param[in] l       the 32-bit value to be written
  66  */
  67 #define adf_os_reg_write32(osdev, addr, l)    __adf_os_reg_write32(osdev, addr, l)
  68
  69 /**
  70  * @brief Convert a 16-bit value from network byte order to host byte order
  71  */
  72 #define adf_os_ntohs(x)                         __adf_os_ntohs(x)
  73
  74 /**
  75  * @brief Convert a 32-bit value from network byte order to host byte order
  76  */
  77 #define adf_os_ntohl(x)                         __adf_os_ntohl(x)
  78
  79 /**
  80  * @brief Convert a 16-bit value from host byte order to network byte order
  81  */
  82 #define adf_os_htons(x)                         __adf_os_htons(x)
  83
  84 /**
  85  * @brief Convert a 32-bit value from host byte order to network byte order
  86  */
  87 #define adf_os_htonl(x)                         __adf_os_htonl(x)
  88
  89 /**
  90  * @brief Convert a 16-bit value from CPU byte order to little-endian byte order
  91  */
  92 #define adf_os_cpu_to_le16(x)                   __adf_os_cpu_to_le16(x)
  93
  94 #endif