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 /**
  48  * @brief Read an 8-bit register value
  49  *
  50  * @param[in] osdev   platform device object
  51  * @param[in] addr    register addr
  52  *
  53  * @return An 8-bit register value.
  54  */
  55 #define adf_os_reg_read8(osdev, addr)         __adf_os_reg_read8(osdev, addr)
  56
  57 /**
  58  * @brief Read a 16-bit register value
  59  *
  60  * @param[in] osdev   platform device object
  61  * @param[in] addr    register addr
  62  *
  63  * @return A 16-bit register value.
  64  */
  65 #define adf_os_reg_read16(osdev, addr)        __adf_os_reg_read16(osdev, addr)
  66
  67 /**
  68  * @brief Read a 32-bit register value
  69  *
  70  * @param[in] addr    register addr
  71  *
  72  * @return A 32-bit register value.
  73  */
  74 static inline a_uint32_t ioread32(a_uint32_t addr)
  75 {
  76         return *(const volatile a_uint32_t *) addr;
  77 }
  78
  79 #define ioread32_mac(addr)      ioread32(WLAN_BASE_ADDRESS + (addr))
  80
  81 /**
  82  * @brief Read a 64-bit register value
  83  *
  84  * @param[in] osdev   platform device object
  85  * @param[in] addr    register addr
  86  *
  87  * @return A 64-bit register value.
  88  */
  89 #define adf_os_reg_read64(osdev, addr)        __adf_os_reg_read64(osdev, addr)
  90
  91 /**
  92  * @brief Write an 8-bit value into register
  93  *
  94  * @param[in] osdev   platform device object
  95  * @param[in] addr    register addr
  96  * @param[in] b       the 8-bit value to be written
  97  */
  98 #define adf_os_reg_write8(osdev, addr, b)     __adf_os_reg_write8(osdev, addr, b)
  99
 100 /**
 101  * @brief Write a 16-bit value into register
 102  *
 103  * @param[in] osdev   platform device object
 104  * @param[in] addr    register addr
 105  * @param[in] w       the 16-bit value to be written
 106  */
 107 #define adf_os_reg_write16(osdev, addr, w)    __adf_os_reg_write16(osdev, addr, w)
 108
 109 /**
 110  * @brief Write a 32-bit value into register
 111  *
 112  * @param[in] osdev   platform device object
 113  * @param[in] addr    register addr
 114  * @param[in] l       the 32-bit value to be written
 115  */
 116 #define adf_os_reg_write32(osdev, addr, l)    __adf_os_reg_write32(osdev, addr, l)
 117
 118 /**
 119  * @brief Write a 64-bit value into register
 120  *
 121  * @param[in] osdev   platform device object
 122  * @param[in] addr    register addr
 123  * @param[in] q       the 64-bit value to be written
 124  */
 125 #define adf_os_reg_write64(osdev, addr, q)    __adf_os_reg_write64(osdev, addr, q)
 126
 127 /**
 128  * @brief Convert a 16-bit value from network byte order to host byte order
 129  */
 130 #define adf_os_ntohs(x)                         __adf_os_ntohs(x)
 131
 132 /**
 133  * @brief Convert a 32-bit value from network byte order to host byte order
 134  */
 135 #define adf_os_ntohl(x)                         __adf_os_ntohl(x)
 136
 137 /**
 138  * @brief Convert a 16-bit value from host byte order to network byte order
 139  */
 140 #define adf_os_htons(x)                         __adf_os_htons(x)
 141
 142 /**
 143  * @brief Convert a 32-bit value from host byte order to network byte order
 144  */
 145 #define adf_os_htonl(x)                         __adf_os_htonl(x)
 146
 147 /**
 148  * @brief Convert a 16-bit value from CPU byte order to big-endian byte order
 149  */
 150 #define adf_os_cpu_to_be16(x)                   __adf_os_cpu_to_be16(x)
 151
 152 /**
 153  * @brief Convert a 32-bit value from CPU byte order to big-endian byte order
 154  */
 155 #define adf_os_cpu_to_be32(x)                   __adf_os_cpu_to_be32(x)
 156
 157 /**
 158  * @brief Convert a 64-bit value from CPU byte order to big-endian byte order
 159  */
 160 #define adf_os_cpu_to_be64(x)                   __adf_os_cpu_to_be64(x)
 161
 162 /**
 163  * @brief Convert a 16-bit value from CPU byte order to little-endian byte order
 164  */
 165 #define adf_os_cpu_to_le16(x)                   __adf_os_cpu_to_le16(x)
 166
 167 /**
 168  * @brief Convert a 32-bit value from CPU byte order to little-endian byte order
 169  */
 170 #define adf_os_cpu_to_le32(x)                   __adf_os_cpu_to_le32(x)
 171
 172 /**
 173  * @brief Convert a 64-bit value from CPU byte order to little-endian byte order
 174  */
 175 #define adf_os_cpu_to_le64(x)                   __adf_os_cpu_to_le64(x)
 176
 177 /**
 178  * @brief Convert a 16-bit value from big-endian byte order to CPU byte order
 179  */
 180 #define adf_os_be16_to_cpu(x)                   __adf_os_be16_to_cpu(x)
 181
 182 /**
 183  * @brief Convert a 32-bit value from big-endian byte order to CPU byte order
 184  */
 185 #define adf_os_be32_to_cpu(x)                   __adf_os_be32_to_cpu(x)
 186
 187 /**
 188  * @brief Convert a 64-bit value from big-endian byte order to CPU byte order
 189  */
 190 #define adf_os_be64_to_cpu(x)                   __adf_os_be64_to_cpu(x)
 191
 192 /**
 193  * @brief Convert a 16-bit value from little-endian byte order to CPU byte order
 194  */
 195 #define adf_os_le16_to_cpu(x)                   __adf_os_le16_to_cpu(x)
 196
 197 /**
 198  * @brief Convert a 32-bit value from little-endian byte order to CPU byte order
 199  */
 200 #define adf_os_le32_to_cpu(x)                   __adf_os_le32_to_cpu(x)
 201
 202 /**
 203  * @brief Convert a 64-bit value from little-endian byte order to CPU byte order
 204  */
 205 #define adf_os_le64_to_cpu(x)                   __adf_os_le64_to_cpu(x)
 206
 207 #endif