xref: /wlan-driver/qca-wifi-host-cmn/qdf/inc/qdf_atomic.h

/*
 * Copyright (c) 2014-2020 The Linux Foundation. All rights reserved.
 * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/**
 * DOC: qdf_atomic.h
 * This file provides OS abstraction for atomic APIs.
 */

#ifndef _QDF_ATOMIC_H
#define _QDF_ATOMIC_H

#include <i_qdf_atomic.h>

/**
 * typedef qdf_atomic_t - atomic type of variable
 *
 * Use this when you want a simple resource counter etc. which is atomic
 * across multiple CPU's. These maybe slower than usual counters on some
 * platforms/OS'es, so use them with caution.
 */
typedef __qdf_atomic_t qdf_atomic_t;

/**
 * qdf_atomic_init() - initialize an atomic type variable
 * @v: A pointer to an opaque atomic variable
 *
 * Return: None
 */
static inline QDF_STATUS qdf_atomic_init(qdf_atomic_t *v)
{
	return __qdf_atomic_init(v);
}

/**
 * qdf_atomic_read() - read the value of an atomic variable
 * @v: A pointer to an opaque atomic variable
 *
 * Return: The current value of the variable
 */
static inline int32_t qdf_atomic_read(qdf_atomic_t *v)
{
	return __qdf_atomic_read(v);
}

/**
 * qdf_atomic_inc() - increment the value of an atomic variable
 * @v: A pointer to an opaque atomic variable
 *
 * Return: None
 */
static inline void qdf_atomic_inc(qdf_atomic_t *v)
{
	__qdf_atomic_inc(v);
}

/**
 * qdf_atomic_dec() - decrement the value of an atomic variable
 * @v: A pointer to an opaque atomic variable
 *
 * Return: None
 */
static inline void qdf_atomic_dec(qdf_atomic_t *v)
{
	__qdf_atomic_dec(v);
}

/**
 * qdf_atomic_add() - add a value to the value of an atomic variable
 * @i: The amount by which to increase the atomic counter
 * @v: A pointer to an opaque atomic variable
 *
 * Return: None
 */
static inline void qdf_atomic_add(int i, qdf_atomic_t *v)
{
	__qdf_atomic_add(i, v);
}

/**
 * qdf_atomic_sub() - Subtract a value from an atomic variable
 * @i: the amount by which to decrease the atomic counter
 * @v: a pointer to an opaque atomic variable
 *
 * Return: none
 */
static inline void qdf_atomic_sub(int i, qdf_atomic_t *v)
{
	__qdf_atomic_sub(i, v);
}

/**
 * qdf_atomic_dec_and_test() - decrement an atomic variable and check if the
 * new value is zero
 * @v: A pointer to an opaque atomic variable
 *
 * Return:
 * true (non-zero) if the new value is zero,
 * false (0) if the new value is non-zero
 */
static inline int32_t qdf_atomic_dec_and_test(qdf_atomic_t *v)
{
	return __qdf_atomic_dec_and_test(v);
}

/**
 * qdf_atomic_set() - set a value to the value of an atomic variable
 * @v: A pointer to an opaque atomic variable
 * @i: required value to set
 *
 * Atomically sets the value of v to i
 * Return: None
 */
static inline void qdf_atomic_set(qdf_atomic_t *v, int i)
{
	__qdf_atomic_set(v, i);
}

/**
 * qdf_atomic_inc_return() - return the incremented value of an atomic variable
 * @v: A pointer to an opaque atomic variable
 *
 * Return: The current value of the variable
 */
static inline int32_t qdf_atomic_inc_return(qdf_atomic_t *v)
{
	return __qdf_atomic_inc_return(v);
}

/**
 * qdf_atomic_dec_return() - return the decremented value of an atomic
 * variable
 * @v: A pointer to an opaque atomic variable
 *
 * Return: The current value of the variable
 */
static inline int32_t qdf_atomic_dec_return(qdf_atomic_t *v)
{
	return __qdf_atomic_dec_return(v);
}

/**
 * qdf_atomic_dec_if_positive() - Decrement an atomic variable if its
 * value is positive
 * @v: A pointer to an opaque atomic variable
 *
 * Return: The old value of the variable minus 1
 */
static inline int32_t qdf_atomic_dec_if_positive(qdf_atomic_t *v)
{
	return __qdf_atomic_dec_if_positive(v);
}

/**
 * qdf_atomic_inc_not_zero() - increment if not zero
 * @v: A pointer to an opaque atomic variable
 *
 * Return: Returns non-zero on successful increment and zero otherwise
 */
static inline int32_t qdf_atomic_inc_not_zero(qdf_atomic_t *v)
{
	return __qdf_atomic_inc_not_zero(v);
}

/**
 * qdf_atomic_set_bit - Atomically set a bit in memory
 * @nr: bit to set
 * @addr: the address to start counting from
 *
 * Return: none
 */
static inline void qdf_atomic_set_bit(int nr, volatile unsigned long *addr)
{
	__qdf_atomic_set_bit(nr, addr);
}

/**
 * qdf_atomic_clear_bit - Atomically clear a bit in memory
 * @nr: bit to clear
 * @addr: the address to start counting from
 *
 * Return: none
 */
static inline void qdf_atomic_clear_bit(int nr, volatile unsigned long *addr)
{
	__qdf_atomic_clear_bit(nr, addr);
}

/**
 * qdf_atomic_change_bit - Atomically toggle a bit in memory
 * from addr
 * @nr: bit to change
 * @addr: the address to start counting from
 *
 * Return: none
 */
static inline void qdf_atomic_change_bit(int nr, volatile unsigned long *addr)
{
	__qdf_atomic_change_bit(nr, addr);
}

/**
 * qdf_atomic_test_and_set_bit - Atomically set a bit and return its old value
 * @nr: Bit to set
 * @addr: the address to start counting from
 *
 * Return: return nr bit old value
 */
static inline int qdf_atomic_test_and_set_bit(int nr,
					      volatile unsigned long *addr)
{
	return __qdf_atomic_test_and_set_bit(nr, addr);
}

/**
 * qdf_atomic_test_and_clear_bit - Atomically clear a bit and return its old
 * value
 * @nr: bit to clear
 * @addr: the address to start counting from
 *
 * Return: return nr bit old value
 */
static inline int qdf_atomic_test_and_clear_bit(int nr,
						volatile unsigned long *addr)
{
	return __qdf_atomic_test_and_clear_bit(nr, addr);
}

/**
 * qdf_atomic_test_and_change_bit - Atomically toggle a bit and return its old
 * value
 * @nr: bit to change
 * @addr: the address to start counting from
 *
 * Return: return nr bit old value
 */
static inline int qdf_atomic_test_and_change_bit(int nr,
						 volatile unsigned long *addr)
{
	return __qdf_atomic_test_and_change_bit(nr, addr);
}

/**
 * qdf_atomic_test_bit - Atomically get the nr-th bit value starting from addr
 * @nr: bit to get
 * @addr: the address to start counting from
 *
 * Return: return nr bit value
 */
static inline int qdf_atomic_test_bit(int nr, volatile unsigned long *addr)
{
	return __qdf_atomic_test_bit(nr, addr);
}

#endif