max313xx_internal.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Technische Universität Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "kernel_defines.h"
 
#if IS_USED(MODULE_MAX31331) && IS_USED(MODULE_MAX31343)
#  error "Only one driver variant can be used at a time!"
#endif

#if IS_USED(MODULE_MAX31331) || IS_USED(MODULE_MAX31343) || DOXYGEN
#  define MAX313XX_I2C_ADDR           (0x68U) 
 
/* Status/Config registers */
#  define MAX313XX_REG_STATUS         (0x00U) 
#  define MAX313XX_REG_INT_EN         (0x01U) 
#  define MAX313XX_REG_RTC_RESET      (0x02U) 
#  define MAX313XX_REG_RTC_CFG1       (0x03U) 
#  define MAX313XX_REG_RTC_CFG2       (0x04U) 
 
#  define MAX313XX_TIME_LEN           (7U)    
 
#  define MAX313XX_MONTH_CENTURY      (1U << 7)   
 
#  define MAX313XX_ALM1_LEN           (6U)    
 
#  define MAX313XX_ALM_MASK_BIT       (1U << 7)   
#  define MAX313XX_ALM_DY_DT          (1U << 6)   
 
#  define MAX313XX_STATUS_A1F         (1U << 0)   
#  define MAX313XX_STATUS_A2F         (1U << 1)   
#  define MAX313XX_STATUS_OSF         (1U << 6)   
 
#  define MAX313XX_INTEN_A1IE         (1U << 0)   
#  define MAX313XX_INTEN_A2IE         (1U << 1)   
#endif
 
#if IS_USED(MODULE_MAX31331)
#  define MAX313XX_REG_TIMER_CFG      (0x06U)
#  define MAX313XX_REG_TIME0          (0x08U)
 
#  define MAX313XX_RTC_CFG1_ENOSC     (1U << 0)
 
#  define MAX313XX_RTC_CFG2_ENCLKO    (1U << 2)
#  define MAX313XX_RTC_CFG2_CLKO_MASK (0x03U)
 
#  define MAX313XX_REG_ALM1_SEC       (0x0FU)
#  define MAX313XX_REG_ALM1_MIN       (0x10U)
#  define MAX313XX_REG_ALM1_HRS       (0x11U)
#  define MAX313XX_REG_ALM1_DAY_DATE  (0x12U)
#  define MAX313XX_REG_ALM1_MON       (0x13U)
#  define MAX313XX_REG_ALM1_YEAR      (0x14U)
 
#  define MAX313XX_REG_TRICKLE        (0x1BU)
 
#  define MAX313XX_TRICKLE_D_MASK     (0x08U)
#  define MAX313XX_TRICKLE_D_DIODE    (1U << 4)
#  define MAX313XX_TRICKLE_D_RES_MASK (0x06U)
 
#elif IS_USED(MODULE_MAX31343)
#  define MAX313XX_REG_TIMER_CFG      (0x05U)
 
#  define MAX313XX_REG_TIME0          (0x06U)
 
#  define MAX313XX_RTC_CFG1_ENOSC     (1U << 1)
 
#  define MAX313XX_RTC_CFG2_ENCLKO    (1U << 7)
#  define MAX313XX_RTC_CFG2_CLKO_MASK (0x78U)
 
#  define MAX313XX_REG_ALM1_SEC       (0x0DU)
#  define MAX313XX_REG_ALM1_MIN       (0x0EU)
#  define MAX313XX_REG_ALM1_HRS       (0x0FU)
#  define MAX313XX_REG_ALM1_DAY_DATE  (0x10U)
#  define MAX313XX_REG_ALM1_MON       (0x11U)
#  define MAX313XX_REG_ALM1_YEAR      (0x12U)
 
#  define MAX313XX_REG_TRICKLE        (0x19U)
 
#  define MAX313XX_TRICKLE_D_MASK     (0x0FU)
#  define MAX313XX_TRICKLE_D_CHARGER_OFF (1U << 3)
#  define MAX313XX_TRICKLE_D_DIODE    (1U << 2)
#  define MAX313XX_TRICKLE_D_RES_MASK (0x03U)
 
#elif DOXYGEN
#  define MAX313XX_REG_TIMER_CFG      
#  define MAX313XX_REG_TIME0
 
#  define MAX313XX_RTC_CFG1_ENOSC     
 
#  define MAX313XX_RTC_CFG2_ENCLKO    
#  define MAX313XX_RTC_CFG2_CLKO_MASK 
 
#  define MAX313XX_REG_ALM1_SEC       
#  define MAX313Xx_REG_ALM1_MIN       
#  define MAX313XX_REG_ALM1_HRS       
#  define MAX313XX_REG_ALM1_DAY_DATE  
#  define MAX313XX_REG_ALM1_MON       
#  define MAX313XX_REG_ALM1_YEAR      
 
#  define MAX313XX_REG_TRICKLE        
 
#  define MAX313XX_TRICKLE_D_MASK     
#  define MAX313XX_TRICKLE_D_DIODE    
#  define MAX313XX_TRICKLE_D_RES_MASK 
#endif
 
/* The device specific registers are defined unconditionally to allow using
 * `IS_USED(MODULE_MAX313..)` in the code instead of preprocessor conditions. */
#define MAX31331_REG_TS_CFG         (0x05U) 
 
#define MAX31331_TRICKLE_ENABLE     (1U << 0)  
#define MAX31331_TRICKLE_RES_SHIFT  (1U << 0)  

#define MAX31343_RTC_CFG2_SQW_HZ_MASK (0x07U) 
 
#define MAX31343_REG_TEMP_MSB       (0x1AU)  
#define MAX31343_REG_TEMP_LSB       (0x1BU)  
#define MAX31343_REG_TS_CONFIG      (0x1CU)  
 
#define MAX31343_TS_AUTOMODE        (1U << 7) 
#define MAX31343_TS_TTSINT_MASK     (0x38U)  
#define MAX31343_TS_TTSINT_SHIFT    (3U)     
 
#define MAX31343_TRICKLE_TCHE_SHIFT (4U)     
#define MAX31343_TRICKLE_TCHE_MASK  (0xF0U)  
#define MAX31343_TRICKLE_TCHE_ENABLE (0x5U)  
 
#ifdef __cplusplus
}
#endif