timer

Documentation

Overview

Package timer represents the timer part of the RIOT (the T in RIOT).

Index

• Constants
• type Divider
  • func (in Divider) String() string
• type Timer
  • func NewTimer(env *environment.Environment, mem chipbus.Memory) *Timer
  • func (tmr *Timer) PeekField(fld string) any
  • func (tmr *Timer) Plumb(mem chipbus.Memory)
  • func (tmr *Timer) PokeField(fld string, v any)
  • func (tmr *Timer) Reset()
  • func (tmr *Timer) Snapshot() *Timer
  • func (tmr *Timer) Step()
  • func (tmr *Timer) String() string
  • func (tmr *Timer) Update(data chipbus.ChangedRegister) bool

Constants

const MaskTIMINT = 0b11000000

MaskTIMINT defines the bits of TIMINT that are actually used

Types

type Divider

type Divider int

Divider indicates how often (in CPU cycles) the timer value decreases the following rules apply:

• set to 1, 8, 64 or 1024 depending on which address has been written to by the CPU
• is used to reset the cyclesRemaining
• is changed to 1 once value reaches 0
• is reset to its initial value of 1, 8, 64, or 1024 whenever INTIM is read by the CPU

const (
	TIM1T  Divider = 1
	TIM8T  Divider = 8
	TIM64T Divider = 64
	T1024T Divider = 1024
)

List of valid Divider values

func (Divider) String

func (in Divider) String() string

type Timer

type Timer struct {
	// contains filtered or unexported fields
}

Timer implements the timer part of the PIA 6532 (the T in RIOT)

func NewTimer

func NewTimer(env *environment.Environment, mem chipbus.Memory) *Timer

NewTimer is the preferred method of initialisation of the Timer type

func (*Timer) PeekField

func (tmr *Timer) PeekField(fld string) any

PeekINTIM pokes a new value into the INTIM register. Same as peeking the INTIM register on the cpubus - provided here for convenience

Supported fields:

intim (uint8)
timint (uint8)
ticksRemainging (int)
divider (timer.Divider)

func (*Timer) Plumb

func (tmr *Timer) Plumb(mem chipbus.Memory)

Plumb a new ChipBus into the Timer

func (*Timer) PokeField

func (tmr *Timer) PokeField(fld string, v any)

PokeINTIM pokes a new value into the INTIM register. Same as poking the INTIM register on the cpubus - provided here for convenience

Fields as described for PeekField()

func (*Timer) Reset

func (tmr *Timer) Reset()

Reset timer to an initial state

func (*Timer) Snapshot

func (tmr *Timer) Snapshot() *Timer

Snapshot creates a copy of the RIOT Timer in its current state

func (*Timer) Step

func (tmr *Timer) Step()

Step timer forward one cycle

func (*Timer) String

func (tmr *Timer) String() string

func (*Timer) Update

func (tmr *Timer) Update(data chipbus.ChangedRegister) bool

Update checks to see if ChipData applies to the Timer type and updates the internal timer state accordingly

Returns true if ChipData has *not* been serviced