atomic.h

Go to the documentation of this file.

#ifndef EVE_ATOMIC_H_INCLUDED
#define EVE_ATOMIC_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2014-2015, Jetro AS
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * This file is part of the EVE platform.
 */

 /**
 * \file
 * \brief Header file for the EVE atomic primitives set.
 *
 * \author DT, Jetro AS
 */ /******************************************************************/

/**
 * \addtogroup atomic
 * @{
 * EVE atomic primitives set
 */

/**********************************************************************/
/**
 * Atomically sets the value of a variable to value and returns the old value: 32 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to set.
 * \return The old value of the atomic variable.
 */
uint32_t atomic_xchg32(volatile uint32_t *p, uint32_t value);

/**********************************************************************/
/**
 * Atomically sets thevalue of a variable to value and returns the old value: 16 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to set.
 * \return The old value of the atomic variable.
 */
uint16_t atomic_xchg16(volatile uint16_t *p, uint16_t value);

/**********************************************************************/
/**
 * Atomically sets thevalue of a variable to value and returns the old value: 8 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to set.
 * \return The old value of the atomic variable.
 */
uint8_t atomic_xchg8(volatile uint8_t *p, uint8_t value);

/**********************************************************************/
/**
 * Atomically sets thevalue of a variable to value and returns the old value: bool version.
 *
 * \param p The atomic variable.
 * \param value The value to set.
 * \return The old value of the atomic variable.
 */
bool atomic_xchg_bool(volatile bool *p, bool value);

/**********************************************************************/
/**
 * Atomically adds delta to the current value of a variable: 32 bit version.
 *
 * \param p The atomic variable.
 * \param delta The delta to add.
 * \return The new value of the atomic variable.
 */
uint32_t atomic_add32(volatile uint32_t *p, int32_t delta);

/**********************************************************************/
/**
 * Atomically adds delta to the current value of a variable: 16 bit version.
 *
 * \param p The atomic variable.
 * \param delta The delta to add.
 * \return The new value of the atomic variable.
 */
uint16_t atomic_add16(volatile uint16_t *p, int16_t delta);

/**********************************************************************/
/**
 * Atomically adds delta to the current value of a variable: 8 bit version.
 *
 * \param p The atomic variable.
 * \param delta The delta to add.
 * \return The new value of the atomic variable.
 */
uint8_t atomic_add8(volatile uint8_t *p, int8_t delta);

/**********************************************************************/
/**
 * Atomically ORs value with the current value of a variable: 32 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary OR with the variable.
 * \return The updated value of the atomic variable.
 */
uint32_t atomic_or32(volatile uint32_t *p, uint32_t value);

/**********************************************************************/
/**
 * Atomically ORs value with the current value of a variable: 16 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary OR with the variable.
 * \return The updated value of the atomic variable.
 */
uint16_t atomic_or16(volatile uint16_t *p, uint16_t value);

/**********************************************************************/
/**
 * Atomically ORs value with the current value of a variable: 8 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary OR with the variable.
 * \return The updated value of the atomic variable.
 */
uint8_t atomic_or8(volatile uint8_t *p, uint8_t value);

/**********************************************************************/
/**
 * Atomically ANDs value with the current value of a variable: 32 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary AND with the variable.
 * \return The updated value of the atomic variable.
 */
uint32_t atomic_and32(volatile uint32_t *p, uint32_t value);

/**********************************************************************/
/**
 * Atomically ANDs value with the current value of a variable: 16 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary AND with the variable.
 * \return The updated value of the atomic variable.
 */
uint16_t atomic_and16(volatile uint16_t *p, uint16_t value);

/**********************************************************************/
/**
 * Atomically ANDs value with the current value of a variable: 8 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary AND with the variable.
 * \return The updated value of the atomic variable.
 */
uint8_t atomic_and8(volatile uint8_t *p, uint8_t value);

/**********************************************************************/
/**
 * Atomically XORs value with the current value of a variable: 32 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary XOR with the variable.
 * \return The updated value of the atomic variable.
 */
uint32_t atomic_xor32(volatile uint32_t *p, uint32_t value);

/**********************************************************************/
/**
 * Atomically XORs value with the current value of a variable: 16 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary XOR with the variable.
 * \return The updated value of the atomic variable.
 */
uint16_t atomic_xor16(volatile uint16_t *p, uint16_t value);

/**********************************************************************/
/**
 * Atomically XORs value with the current value of a variable: 8 bit version.
 *
 * \param p The atomic variable.
 * \param value The value to binary XOR with the variable.
 * \return The updated value of the atomic variable.
 */
uint8_t atomic_xor8(volatile uint8_t *p, uint8_t value);

/** @} */ /* atomic */

#endif /* EVE_ATOMIC_H_INCLUDED */