stm32-data/data/registers/rtc_v2f4.yaml

---
block/RTC:
  description: Real-time clock
  items:
    - name: TR
      description: Time register
      byte_offset: 0
      fieldset: TR
    - name: DR
      description: Date register
      byte_offset: 4
      fieldset: DR
    - name: CR
      description: Control register
      byte_offset: 8
      fieldset: CR
    - name: ISR
      description: Initialization and status register
      byte_offset: 12
      fieldset: ISR
    - name: PRER
      description: Prescaler register
      byte_offset: 16
      fieldset: PRER
    - name: WUTR
      description: Wakeup timer register
      byte_offset: 20
      fieldset: WUTR
    - name: CALIBR
      description: Calibration register
      byte_offset: 24
      fieldset: CALIBR
    - name: ALRMR
      description: Alarm register
      array:
        len: 2
        stride: 4
      byte_offset: 28
      fieldset: ALRMR
    - name: WPR
      description: Write protection register
      byte_offset: 36
      access: Write
      fieldset: WPR
    - name: SSR
      description: Sub second register
      byte_offset: 40
      access: Read
      fieldset: SSR
    - name: SHIFTR
      description: Shift control register
      byte_offset: 44
      access: Write
      fieldset: SHIFTR
    - name: TSTR
      description: Timestamp time register
      byte_offset: 48
      access: Read
      fieldset: TSTR
    - name: TSDR
      description: Timestamp date register
      byte_offset: 52
      access: Read
      fieldset: TSDR
    - name: TSSSR
      description: Timestamp sub second register
      byte_offset: 56
      access: Read
      fieldset: TSSSR
    - name: CALR
      description: Calibration register
      byte_offset: 60
      fieldset: CALR
    - name: TAFCR
      description: Tamper and alternate function configuration register
      byte_offset: 64
      fieldset: TAFCR
    - name: ALRMSSR
      description: Alarm sub second register
      array:
        len: 2
        stride: 4
      byte_offset: 68
      fieldset: ALRMSSR
    - name: BKPR
      description: Backup register
      array:
        len: 20
        stride: 4
      byte_offset: 80
      fieldset: BKPR
fieldset/ALRMR:
  description: Alarm register
  fields:
    - name: SU
      description: Second units in BCD format
      bit_offset: 0
      bit_size: 4
    - name: ST
      description: Second tens in BCD format
      bit_offset: 4
      bit_size: 3
    - name: MSK1
      description: Alarm seconds mask
      bit_offset: 7
      bit_size: 1
      enum: ALRMR_MSK
    - name: MNU
      description: Minute units in BCD format
      bit_offset: 8
      bit_size: 4
    - name: MNT
      description: Minute tens in BCD format
      bit_offset: 12
      bit_size: 3
    - name: MSK2
      description: Alarm minutes mask
      bit_offset: 15
      bit_size: 1
      enum: ALRMR_MSK
    - name: HU
      description: Hour units in BCD format
      bit_offset: 16
      bit_size: 4
    - name: HT
      description: Hour tens in BCD format
      bit_offset: 20
      bit_size: 2
    - name: PM
      description: AM/PM notation
      bit_offset: 22
      bit_size: 1
      enum: ALRMR_PM
    - name: MSK3
      description: Alarm hours mask
      bit_offset: 23
      bit_size: 1
      enum: ALRMR_MSK
    - name: DU
      description: Date units or day in BCD format
      bit_offset: 24
      bit_size: 4
    - name: DT
      description: Date tens in BCD format
      bit_offset: 28
      bit_size: 2
    - name: WDSEL
      description: Week day selection
      bit_offset: 30
      bit_size: 1
      enum: ALRMR_WDSEL
    - name: MSK4
      description: Alarm date mask
      bit_offset: 31
      bit_size: 1
      enum: ALRMR_MSK
fieldset/ALRMSSR:
  description: Alarm sub second register
  fields:
    - name: SS
      description: Sub seconds value
      bit_offset: 0
      bit_size: 15
    - name: MASKSS
      description: Mask the most-significant bits starting at this bit
      bit_offset: 24
      bit_size: 4
fieldset/BKPR:
  description: Backup register
  fields:
    - name: BKP
      description: BKP
      bit_offset: 0
      bit_size: 32
fieldset/CALIBR:
  description: Calibration register
  fields:
    - name: DC
      description: Digital calibration
      bit_offset: 0
      bit_size: 5
    - name: DCS
      description: Digital calibration sign
      bit_offset: 7
      bit_size: 1
fieldset/CALR:
  description: Calibration register
  fields:
    - name: CALM
      description: Calibration minus
      bit_offset: 0
      bit_size: 9
    - name: CALW16
      description: Use a 16-second calibration cycle period
      bit_offset: 13
      bit_size: 1
      enum: CALW16
    - name: CALW8
      description: Use an 8-second calibration cycle period
      bit_offset: 14
      bit_size: 1
      enum: CALW8
    - name: CALP
      description: Increase frequency of RTC by 488.5 ppm
      bit_offset: 15
      bit_size: 1
      enum: CALP
fieldset/CR:
  description: Control register
  fields:
    - name: WUCKSEL
      description: Wakeup clock selection
      bit_offset: 0
      bit_size: 3
      enum: WUCKSEL
    - name: TSEDGE
      description: Timestamp event active edge
      bit_offset: 3
      bit_size: 1
      enum: TSEDGE
    - name: REFCKON
      description: Reference clock detection enable (50 or 60 Hz)
      bit_offset: 4
      bit_size: 1
      enum: REFCKON
    - name: BYPSHAD
      description: Bypass the shadow registers
      bit_offset: 5
      bit_size: 1
    - name: FMT
      description: Hour format
      bit_offset: 6
      bit_size: 1
      enum: FMT
    - name: DCE
      description: Coarse digital calibration enable
      bit_offset: 7
      bit_size: 1
    - name: ALRE
      description: Alarm enable
      bit_offset: 8
      bit_size: 1
      array:
        len: 2
        stride: 1
    - name: WUTE
      description: Wakeup timer enable
      bit_offset: 10
      bit_size: 1
    - name: TSE
      description: Timestamp enable
      bit_offset: 11
      bit_size: 1
    - name: ALRIE
      description: Alarm interrupt enable
      bit_offset: 12
      bit_size: 1
      array:
        len: 2
        stride: 1
    - name: WUTIE
      description: Wakeup timer interrupt enable
      bit_offset: 14
      bit_size: 1
    - name: TSIE
      description: Timestamp interrupt enable
      bit_offset: 15
      bit_size: 1
    - name: ADD1H
      description: Add 1 hour (summer time change)
      bit_offset: 16
      bit_size: 1
    - name: SUB1H
      description: Subtract 1 hour (winter time change)
      bit_offset: 17
      bit_size: 1
    - name: BKP
      description: Backup
      bit_offset: 18
      bit_size: 1
    - name: COSEL
      description: Calibration output selection
      bit_offset: 19
      bit_size: 1
      enum: COSEL
    - name: POL
      description: Output polarity
      bit_offset: 20
      bit_size: 1
      enum: POL
    - name: OSEL
      description: Output selection
      bit_offset: 21
      bit_size: 2
      enum: OSEL
    - name: COE
      description: Calibration output enable
      bit_offset: 23
      bit_size: 1
fieldset/DR:
  description: Date register
  fields:
    - name: DU
      description: Date units in BCD format
      bit_offset: 0
      bit_size: 4
    - name: DT
      description: Date tens in BCD format
      bit_offset: 4
      bit_size: 2
    - name: MU
      description: Month units in BCD format
      bit_offset: 8
      bit_size: 4
    - name: MT
      description: Month tens in BCD format
      bit_offset: 12
      bit_size: 1
    - name: WDU
      description: Week day units
      bit_offset: 13
      bit_size: 3
    - name: YU
      description: Year units in BCD format
      bit_offset: 16
      bit_size: 4
    - name: YT
      description: Year tens in BCD format
      bit_offset: 20
      bit_size: 4
fieldset/ISR:
  description: Initialization and status register
  fields:
    - name: ALRWF
      description: Alarm write flag
      bit_offset: 0
      bit_size: 1
      array:
        len: 2
        stride: 1
      enum: ALRWF
    - name: WUTWF
      description: Wakeup timer write flag
      bit_offset: 2
      bit_size: 1
      enum: WUTWF
    - name: SHPF
      description: Shift operation pending
      bit_offset: 3
      bit_size: 1
    - name: INITS
      description: Initialization status flag
      bit_offset: 4
      bit_size: 1
      enum: INITS
    - name: RSF
      description: Registers synchronization flag
      bit_offset: 5
      bit_size: 1
    - name: INITF
      description: Initialization flag
      bit_offset: 6
      bit_size: 1
      enum: INITF
    - name: INIT
      description: Initialization mode
      bit_offset: 7
      bit_size: 1
      enum: INIT
    - name: ALRF
      description: Alarm flag
      bit_offset: 8
      bit_size: 1
      array:
        len: 2
        stride: 1
    - name: WUTF
      description: Wakeup timer flag
      bit_offset: 10
      bit_size: 1
    - name: TSF
      description: Timestamp flag
      bit_offset: 11
      bit_size: 1
    - name: TSOVF
      description: Timestamp overflow flag
      bit_offset: 12
      bit_size: 1
    - name: TAMPF
      description: Tamper detection flag
      bit_offset: 13
      bit_size: 1
      array:
        len: 3
        stride: 1
    - name: RECALPF
      description: Recalibration pending flag
      bit_offset: 16
      bit_size: 1
      enum: RECALPF
fieldset/PRER:
  description: Prescaler register
  fields:
    - name: PREDIV_S
      description: Synchronous prescaler factor
      bit_offset: 0
      bit_size: 15
    - name: PREDIV_A
      description: Asynchronous prescaler factor
      bit_offset: 16
      bit_size: 7
fieldset/SHIFTR:
  description: Shift control register
  fields:
    - name: SUBFS
      description: Subtract a fraction of a second
      bit_offset: 0
      bit_size: 15
    - name: ADD1S
      description: Add one second
      bit_offset: 31
      bit_size: 1
fieldset/SSR:
  description: Sub second register
  fields:
    - name: SS
      description: Sub second value
      bit_offset: 0
      bit_size: 16
fieldset/TAFCR:
  description: Tamper and alternate function configuration register
  fields:
    - name: TAMPE
      description: Tamper detection enable
      bit_offset: 0
      bit_size: 1
      array:
        offsets:
          - 0
          - 3
    - name: TAMPTRG
      description: Active level for tamper
      bit_offset: 1
      bit_size: 1
      array:
        offsets:
          - 0
          - 3
      enum: TAMPTRG
    - name: TAMPIE
      description: Tamper interrupt enable
      bit_offset: 2
      bit_size: 1
    - name: TAMPTS
      description: Activate timestamp on tamper detection event
      bit_offset: 7
      bit_size: 1
    - name: TAMPFREQ
      description: Tamper sampling frequency
      bit_offset: 8
      bit_size: 3
      enum: TAMPFREQ
    - name: TAMPFLT
      description: Tamper filter count
      bit_offset: 11
      bit_size: 2
      enum: TAMPFLT
    - name: TAMPPRCH
      description: Tamper precharge duration
      bit_offset: 13
      bit_size: 2
      enum: TAMPPRCH
    - name: TAMPPUDIS
      description: Tamper pull-up disable
      bit_offset: 15
      bit_size: 1
      enum: TAMPPUDIS
    - name: TAMP1INSEL
      description: Tamper 1 mapping
      bit_offset: 16
      bit_size: 1
    - name: TSINSEL
      description: Timestamp mapping
      bit_offset: 17
      bit_size: 1
    - name: ALARMOUTTYPE
      description: AFO_ALARM output type
      bit_offset: 18
      bit_size: 1
fieldset/TR:
  description: Time register
  fields:
    - name: SU
      description: Second units in BCD format
      bit_offset: 0
      bit_size: 4
    - name: ST
      description: Second tens in BCD format
      bit_offset: 4
      bit_size: 3
    - name: MNU
      description: Minute units in BCD format
      bit_offset: 8
      bit_size: 4
    - name: MNT
      description: Minute tens in BCD format
      bit_offset: 12
      bit_size: 3
    - name: HU
      description: Hour units in BCD format
      bit_offset: 16
      bit_size: 4
    - name: HT
      description: Hour tens in BCD format
      bit_offset: 20
      bit_size: 2
    - name: PM
      description: AM/PM notation
      bit_offset: 22
      bit_size: 1
      enum: AMPM
fieldset/TSDR:
  description: Timestamp date register
  fields:
    - name: DU
      description: Date units in BCD format
      bit_offset: 0
      bit_size: 4
    - name: DT
      description: Date tens in BCD format
      bit_offset: 4
      bit_size: 2
    - name: MU
      description: Month units in BCD format
      bit_offset: 8
      bit_size: 4
    - name: MT
      description: Month tens in BCD format
      bit_offset: 12
      bit_size: 1
    - name: WDU
      description: Week day units
      bit_offset: 13
      bit_size: 3
fieldset/TSSSR:
  description: Timestamp sub second register
  fields:
    - name: SS
      description: Sub second value
      bit_offset: 0
      bit_size: 16
fieldset/TSTR:
  description: Timestamp time register
  fields:
    - name: SU
      description: Second units in BCD format
      bit_offset: 0
      bit_size: 4
    - name: ST
      description: Second tens in BCD format
      bit_offset: 4
      bit_size: 3
    - name: MNU
      description: Minute units in BCD format
      bit_offset: 8
      bit_size: 4
    - name: MNT
      description: Minute tens in BCD format
      bit_offset: 12
      bit_size: 3
    - name: HU
      description: Hour units in BCD format
      bit_offset: 16
      bit_size: 4
    - name: HT
      description: Hour tens in BCD format
      bit_offset: 20
      bit_size: 2
    - name: PM
      description: AM/PM notation
      bit_offset: 22
      bit_size: 1
      enum: AMPM
fieldset/WPR:
  description: Write protection register
  fields:
    - name: KEY
      description: Write protection key
      bit_offset: 0
      bit_size: 8
fieldset/WUTR:
  description: Wakeup timer register
  fields:
    - name: WUT
      description: Wakeup auto-reload value bits
      bit_offset: 0
      bit_size: 16
enum/ALRMR_MSK:
  bit_size: 1
  variants:
    - name: Mask
      description: Alarm set if the date/day match
      value: 0
    - name: NotMask
      description: Date/day don’t care in Alarm comparison
      value: 1
enum/ALRMR_PM:
  bit_size: 1
  variants:
    - name: AM
      description: AM or 24-hour format
      value: 0
    - name: PM
      description: PM
      value: 1
enum/ALRMR_WDSEL:
  bit_size: 1
  variants:
    - name: DateUnits
      description: "DU[3:0] represents the date units"
      value: 0
    - name: WeekDay
      description: "DU[3:0] represents the week day. DT[1:0] is don’t care"
      value: 1
enum/ALRWF:
  bit_size: 1
  variants:
    - name: UpdateNotAllowed
      description: Alarm update not allowed
      value: 0
    - name: UpdateAllowed
      description: Alarm update allowed
      value: 1
enum/AMPM:
  bit_size: 1
  variants:
    - name: AM
      description: AM or 24-hour format
      value: 0
    - name: PM
      description: PM
      value: 1
enum/CALP:
  bit_size: 1
  variants:
    - name: NoChange
      description: No RTCCLK pulses are added
      value: 0
    - name: IncreaseFreq
      description: One RTCCLK pulse is effectively inserted every 2^11 pulses (frequency increased by 488.5 ppm)
      value: 1
enum/CALW16:
  bit_size: 1
  variants:
    - name: Sixteen_Second
      description: "When CALW16 is set to ‘1’, the 16-second calibration cycle period is selected.This bit must not be set to ‘1’ if CALW8=1"
      value: 1
enum/CALW8:
  bit_size: 1
  variants:
    - name: Eight_Second
      description: "When CALW8 is set to ‘1’, the 8-second calibration cycle period is selected"
      value: 1
enum/COSEL:
  bit_size: 1
  variants:
    - name: CalFreq_512Hz
      description: Calibration output is 512 Hz (with default prescaler setting)
      value: 0
    - name: CalFreq_1Hz
      description: Calibration output is 1 Hz (with default prescaler setting)
      value: 1
enum/FMT:
  bit_size: 1
  variants:
    - name: Twenty_Four_Hour
      description: 24 hour/day format
      value: 0
    - name: AM_PM
      description: AM/PM hour format
      value: 1
enum/INIT:
  bit_size: 1
  variants:
    - name: FreeRunningMode
      description: Free running mode
      value: 0
    - name: InitMode
      description: "Initialization mode used to program time and date register (RTC_TR and RTC_DR), and prescaler register (RTC_PRER). Counters are stopped and start counting from the new value when INIT is reset."
      value: 1
enum/INITF:
  bit_size: 1
  variants:
    - name: NotAllowed
      description: Calendar registers update is not allowed
      value: 0
    - name: Allowed
      description: Calendar registers update is allowed
      value: 1
enum/INITS:
  bit_size: 1
  variants:
    - name: NotInitalized
      description: Calendar has not been initialized
      value: 0
    - name: Initalized
      description: Calendar has been initialized
      value: 1
enum/OSEL:
  bit_size: 2
  variants:
    - name: Disabled
      description: Output disabled
      value: 0
    - name: AlarmA
      description: Alarm A output enabled
      value: 1
    - name: AlarmB
      description: Alarm B output enabled
      value: 2
    - name: Wakeup
      description: Wakeup output enabled
      value: 3
enum/POL:
  bit_size: 1
  variants:
    - name: High
      description: "The pin is high when ALRAF/ALRBF/WUTF is asserted (depending on OSEL[1:0])"
      value: 0
    - name: Low
      description: "The pin is low when ALRAF/ALRBF/WUTF is asserted (depending on OSEL[1:0])"
      value: 1
enum/RECALPF:
  bit_size: 1
  variants:
    - name: Pending
      description: "The RECALPF status flag is automatically set to 1 when software writes to the RTC_CALR register, indicating that the RTC_CALR register is blocked. When the new calibration settings are taken into account, this bit returns to 0"
      value: 1
enum/REFCKON:
  bit_size: 1
  variants:
    - name: Disabled
      description: RTC_REFIN detection disabled
      value: 0
    - name: Enabled
      description: RTC_REFIN detection enabled
      value: 1
enum/TAMPFLT:
  bit_size: 2
  variants:
    - name: Immediate
      description: Tamper event is activated on edge of RTC_TAMPx input transitions to the active level (no internal pull-up on RTC_TAMPx input)
      value: 0
    - name: Samples2
      description: Tamper event is activated after 2 consecutive samples at the active level
      value: 1
    - name: Samples4
      description: Tamper event is activated after 4 consecutive samples at the active level
      value: 2
    - name: Samples8
      description: Tamper event is activated after 8 consecutive samples at the active level
      value: 3
enum/TAMPFREQ:
  bit_size: 3
  variants:
    - name: Div32768
      description: RTCCLK / 32768 (1 Hz when RTCCLK = 32768 Hz)
      value: 0
    - name: Div16384
      description: RTCCLK / 16384 (2 Hz when RTCCLK = 32768 Hz)
      value: 1
    - name: Div8192
      description: RTCCLK / 8192 (4 Hz when RTCCLK = 32768 Hz)
      value: 2
    - name: Div4096
      description: RTCCLK / 4096 (8 Hz when RTCCLK = 32768 Hz)
      value: 3
    - name: Div2048
      description: RTCCLK / 2048 (16 Hz when RTCCLK = 32768 Hz)
      value: 4
    - name: Div1024
      description: RTCCLK / 1024 (32 Hz when RTCCLK = 32768 Hz)
      value: 5
    - name: Div512
      description: RTCCLK / 512 (64 Hz when RTCCLK = 32768 Hz)
      value: 6
    - name: Div256
      description: RTCCLK / 256 (128 Hz when RTCCLK = 32768 Hz)
      value: 7
enum/TAMPPRCH:
  bit_size: 2
  variants:
    - name: Cycles1
      description: 1 RTCCLK cycle
      value: 0
    - name: Cycles2
      description: 2 RTCCLK cycles
      value: 1
    - name: Cycles4
      description: 4 RTCCLK cycles
      value: 2
    - name: Cycles8
      description: 8 RTCCLK cycles
      value: 3
enum/TAMPPUDIS:
  bit_size: 1
  variants:
    - name: Enabled
      description: Precharge RTC_TAMPx pins before sampling (enable internal pull-up)
      value: 0
    - name: Disabled
      description: Disable precharge of RTC_TAMPx pins
      value: 1
enum/TAMPTRG:
  bit_size: 1
  variants:
    - name: RisingEdge
      description: "If TAMPFLT = 00: RTC_TAMPx input rising edge triggers a tamper detection event. If TAMPFLT ≠ 00: RTC_TAMPx input staying low triggers a tamper detection event."
      value: 0
    - name: FallingEdge
      description: "If TAMPFLT = 00: RTC_TAMPx input staying high triggers a tamper detection event. If TAMPFLT ≠ 00: RTC_TAMPx input falling edge triggers a tamper detection event"
      value: 1
enum/TSEDGE:
  bit_size: 1
  variants:
    - name: RisingEdge
      description: RTC_TS input rising edge generates a time-stamp event
      value: 0
    - name: FallingEdge
      description: RTC_TS input falling edge generates a time-stamp event
      value: 1
enum/WUCKSEL:
  bit_size: 3
  variants:
    - name: Div16
      description: RTC/16 clock is selected
      value: 0
    - name: Div8
      description: RTC/8 clock is selected
      value: 1
    - name: Div4
      description: RTC/4 clock is selected
      value: 2
    - name: Div2
      description: RTC/2 clock is selected
      value: 3
    - name: ClockSpare
      description: ck_spre (usually 1 Hz) clock is selected
      value: 4
    - name: ClockSpareWithOffset
      description: ck_spre (usually 1 Hz) clock is selected and 2^16 is added to the WUT counter value
      value: 6
enum/WUTWF:
  bit_size: 1
  variants:
    - name: UpdateNotAllowed
      description: Wakeup timer configuration update not allowed
      value: 0
    - name: UpdateAllowed
      description: Wakeup timer configuration update allowed
      value: 1