xref: /device/soc/hisilicon/hi3861v100/sdk_liteos/include/hi_atomic.h

/**
 * @file hi_atomic.h
 *
 * Copyright (c) 2020 HiSilicon (Shanghai) Technologies CO., LIMITED.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @defgroup iot_atomic  Atomic Operation
 * @ingroup osa
 */
#ifndef __HI_ATOMIC_H__
#define __HI_ATOMIC_H__
#include <hi_types.h>
#include <los_hwi.h>

#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif
#endif

typedef struct {
    volatile hi_s32 counter;
} hi_atomic;

#define hi_atomic_init(i)            { (i) }
#define hi_atomic_read(v)            ((v)->counter)
#define hi_atomic_set(v, i)          (((v)->counter) = (i))

#define hi_atomic_inc(v)             hi_atomic_add_return(1, v)
#define hi_atomic_dec(v)             hi_atomic_sub_return(1, v)

#define hi_atomic_inc_return(v)      (hi_atomic_add_return(1, v))
#define hi_atomic_dec_return(v)      (hi_atomic_sub_return(1, v))

/**
 * @ingroup  iot_atomic
 * If the atomic operation is performed, the operation result is returned.
CNcomment:原子加操作，返回操作结果CNend
 */
#define hi_atomic_add_return_op(i, v)   (hi_atomic_add_return(i, v))

/**
 * @ingroup  iot_atomic
 * The operation result is returned when the atomic subtraction operation is performed.
CNcomment:原子减操作，返回操作结果CNend
 */
#define hi_atomic_sub_return_op(i, v)   (hi_atomic_sub_return(i, v))

/**
 * @ingroup  iot_atomic
 * The specified bit in the atomic setting variable is 1.
CNcomment:原子设置变量中指定bit位为1CNend
 */
#define hi_atomic_bit_set_op(bit, v)    (hi_atomic_bit_set(bit, v))
/**
 * @ingroup  iot_atomic
 * The specified bit in the atomic setting variable is 0.
CNcomment:原子设置变量中指定bit位为0CNend
 */
#define hi_atomic_bit_clear_op(bit, v)  (hi_atomic_bit_clear(bit, v))

/*
* If the atomic operation is performed, the operation result is returned.
CNcomment:原子加操作，返回操作结果CNend
*
* 描述:
*          If the atomic operation is performed, the operation result is returned.
CNcomment:原子加操作，返回操作结果CNend
*
* param  i     [IN] type #hi_s32， The number of operands added to an atom.CNcomment:与原子相加的操作数CNend
* param  v     [IN] type #hi_atomic*，Pointer to the atomic structure address.CNcomment:原子结构地址指针CNend
*
* retval #hi_s32 Add Operation Result.CNcomment:加操作结果CNend
* par 依赖:
*           hi_atomic.h：Header file where the interface declaration is located.
CNcomment:该接口声明所在的头文件。CNend
*/
__attribute__((always_inline)) static inline hi_s32 hi_atomic_add_return(hi_s32 i, hi_atomic *v)
{
    hi_u32 irq_status;

    irq_status = LOS_IntLock();
    v->counter += i;
    (hi_void)LOS_IntRestore(irq_status);
    return v->counter;
}

/*
* The operation result is returned when the atomic subtraction operation is performed.
CNcomment:原子减操作，返回操作结果CNend
*
* 描述:
*          The operation result is returned when the atomic subtraction operation is performed.
CNcomment:原子减操作，返回操作结果CNend
*
* param  i     [IN] type #hi_s32， The number of operands subtracted from the atom.
CNcomment:被原子相减的操作数CNend
* param  v     [IN] type #hi_atomic*，Pointer to the atomic structure address.CNcomment:原子结构地址指针CNend
*
* retval #hi_s32 Reduce the operation result. CNcomment:减操作结果CNend
* par 依赖:
*           hi_atomic.h：Header file where the interface declaration is located.
CNcomment:该接口声明所在的头文件。CNend
*/
__attribute__((always_inline)) static inline hi_s32 hi_atomic_sub_return(hi_s32 i, hi_atomic *v)
{
    hi_u32 irq_status;

    irq_status = LOS_IntLock();
    v->counter = v->counter - i;
    (hi_void)LOS_IntRestore(irq_status);

    return v->counter;
}

/*
* The specified bit in the atomic setting variable is 1.CNcomment:原子设置变量中指定bit位为1CNend
*
* 描述:
*          The specified bit in the atomic setting variable is 1.CNcomment:原子设置变量中指定bit位为1CNend
*
* param  bit     [IN] type #hi_s32， Position of the bit that is set to 1. The value range is 0-31.
CNcomment:被置1的bit位置，范围0-31.CNend
* param  value   [IN] type #hi_u32*，Address pointer of the set variable.CNcomment:置位变量的地址指针CNend
*
* retval #None
* par 依赖:
*           hi_atomic.h：Header file where the interface declaration is located.
CNcomment:该接口声明所在的头文件。CNend
*/
__attribute__((always_inline)) static inline hi_void hi_atomic_bit_set(hi_s32 bit, volatile hi_u32 *value)
{
    hi_u32 irq_status;
    irq_status = LOS_IntLock();

    *value |= (1 << bit);

    (hi_void)LOS_IntRestore(irq_status);
}

/*
* The specified bit in the atomic setting variable is 0.CNcomment:原子设置变量中指定bit位为0CNend
*
* 描述:
*          The specified bit in the atomic setting variable is 0.CNcomment:原子设置变量中指定bit位为0CNend
*
* param  bit     [IN] type #hi_s32， Position of the bit that is set to 0. The value range is 0-31.
CNcomment:被置0的bit位置，范围0-31.CNend
* param  value   [IN] type #hi_u32*，Address pointer of the set variable.CNcomment:置位变量的地址指针CNend
*
* retval #None
* par 依赖:
*           hi_atomic.h：Header file where the interface declaration is located.
CNcomment:该接口声明所在的头文件。CNend
*/
__attribute__((always_inline)) static inline hi_void hi_atomic_bit_clear(hi_s32 bit, volatile hi_u32 *value)
{
    hi_u32 irq_status;
    hi_u32 mask;

    irq_status = LOS_IntLock();
    mask = 1 << bit;
    *value = (*value) & (~mask);

    (hi_void)LOS_IntRestore(irq_status);
}

#ifdef __cplusplus
#if __cplusplus
}
#endif
#endif

#endif /* end of hi_atomic.h */