RIOT/drivers/max31855/include/max31855_constants.h

/*
 * Copyright (C) 2024 HAW Hamburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @ingroup     drivers_max31855
 * @{
 *
 * @file
 * @brief       Internal addresses, registers and constants
 *
 * @author      Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
 */

#ifndef MAX31855_CONSTANTS_H
#define MAX31855_CONSTANTS_H

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Size of the data read from the MAX31855 in bytes.
 */
#define MAX31855_DATA_SIZE (4)

/**
 * @brief Shift value for the thermocouple sign bit.
 */
#define MAX31855_THERMOCOUPLE_SIGN_SHIFT (31)

/**
   @brief Mask value for the thermocouple sign bit.
 */
#define MAX31855_THERMOCOUPLE_SIGN_MASK (1UL << MAX31855_THERMOCOUPLE_SIGN_SHIFT)

/**
 * @brief Shift value for the thermocouple integer bits.
 */
#define MAX31855_THERMOCOUPLE_INTEGER_SHIFT (20)

/**
 * @brief Mask value for the thermocouple integer bits.
 */
#define MAX31855_THERMOCOUPLE_INTEGER_MASK (0x7FFUL << MAX31855_THERMOCOUPLE_INTEGER_SHIFT)

/**
 * @brief Shift value for the thermocouple fractional half degree bit.
 */
#define MAX31855_THERMOCOUPLE_FRACTIONAL_HALF_SHIFT (19)

/**
 * @brief Mask value for the thermocouple fractional half degree bit.
 */
#define MAX31855_THERMOCOUPLE_FRACTIONAL_HALF_MASK (1UL << MAX31855_THERMOCOUPLE_FRACTIONAL_HALF_SHIFT)

/**
 * @brief Shift value for the thermocouple fractional quarter degree bit.
 */
#define MAX31855_THERMOCOUPLE_FRACTIONAL_QUARTER_SHIFT (18)

/**
 * @brief Mask value for the thermocouple fractional quarter degree bit.
 */
#define MAX31855_THERMOCOUPLE_FRACTIONAL_QUARTER_MASK (1UL << MAX31855_THERMOCOUPLE_FRACTIONAL_QUARTER_SHIFT)

/**
 * @brief Shift value for the internal sign bit.
 */
#define MAX31855_INTERNAL_SIGN_SHIFT (15)

/**
   @brief Mask value for the internal sign bit.
 */
#define MAX31855_INTERNAL_SIGN_MASK (1UL << MAX31855_INTERNAL_SIGN_SHIFT)

/**
 * @brief Shift value for the internal integer bits.
 */
#define MAX31855_INTERNAL_INTEGER_SHIFT (8)

/**
 * @brief Mask value for the internal integer bits.
 */
#define MAX31855_INTERNAL_INTEGER_MASK (0x7FUL << MAX31855_INTERNAL_INTEGER_SHIFT)

/**
 * @brief Shift value for the internal fractional half degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_HALF_SHIFT (7)

/**
 * @brief Mask value for the internal fractional half degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_HALF_MASK (1UL << MAX31855_INTERNAL_FRACTIONAL_HALF_SHIFT)

/**
 * @brief Shift value for the internal fractional quarter degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_QUARTER_SHIFT (6)

/**
 * @brief Mask value for the internal fractional quarter degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_QUARTER_MASK (1UL << MAX31855_INTERNAL_FRACTIONAL_QUARTER_SHIFT)

/**
 * @brief Shift value for the internal fractional eighth degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_EIGHTH_SHIFT (5)

/**
 * @brief Shift value for the internal fractional eighth degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_EIGHTH_MASK (1UL << MAX31855_INTERNAL_FRACTIONAL_EIGHTH_SHIFT)

/**
 * @brief Shift value for the internal fractional sixteenth degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_SIXTEENTH_SHIFT (4)

/**
 * @brief Shift value for the internal fractional sixteenth degree bit.
 */
#define MAX31855_INTERNAL_FRACTIONAL_SIXTEENTH_MASK (1UL << MAX31855_INTERNAL_FRACTIONAL_SIXTEENTH_SHIFT)

/**
 * @brief Shift value for the fault bit indicating a VCC short.
 */
#define MAX31855_FAULT_VCC_SHORT_SHIFT (2)

/**
 * @brief Mask value for the fault bit indicating a VCC short.
 */
#define MAX31855_FAULT_VCC_SHORT_MASK (1UL << MAX31855_FAULT_VCC_SHORT_SHIFT)

/**
 * @brief Shift value for the fault bit indicating a GND short.
 */
#define MAX31855_FAULT_GND_SHORT_SHIFT (1)

/**
 * @brief Mask value for the fault bit indicating a GND short.
 */
#define MAX31855_FAULT_GND_SHORT_MASK (1UL << MAX31855_FAULT_GND_SHORT_SHIFT)

/**
 * @brief Shift value for the fault bit indicating an open circuit.
 */
#define MAX31855_FAULT_OPEN_CIRCUIT_SHIFT (0)

/**
 * @brief Mask value for the fault bit indicating an open circuit.
 */
#define MAX31855_FAULT_OPEN_CIRCUIT_MASK (1UL << MAX31855_FAULT_OPEN_CIRCUIT_SHIFT)

/**
 * @brief Mask value for the fault bits.
 */
#define MAX31855_FAULT_MASK (MAX31855_FAULT_VCC_SHORT_MASK | \
                             MAX31855_FAULT_GND_SHORT_MASK | \
                             MAX31855_FAULT_OPEN_CIRCUIT_MASK)

#ifdef __cplusplus
}
#endif

#endif /* MAX31855_CONSTANTS_H */
/** @} */