timer.rst

.. index::
    single: Timer

Timer

Registers

.. type:: struct timer_register_map

    This struct maps the registers of the timer.
    The names of the struct members correspond to the registers
    from the Datasheet_::

        struct i2c_register_map {
            uint32_t CS;
            uint32_t CLO;
            uint32_t CHI;
            uint32_t C0;
            uint32_t C1;
            uint32_t C2;
            uint32_t C3;
        };

.. var:: extern volatile struct timer_register_map *TMR

    ::

        TMR = (volatile struct timer_register_map *)timer_base_ptr;

    By using this variable, the registers of the timer can be accessed like this
    :code:`TMR->CLO`.

Functions

.. function:: int timer_map(void)

    This function maps the timer registers. It calls :func:`peripheral_map` with
    the values :code:`TIMER_OFFSET` and :macro:`TIMER_SIZE`. On error
    :code:`-1` is returned.

.. function:: void timer_unmap(void)

    This function unmaps the timer registers.

.. function:: void timer_read(uint64_t *counter);

    This function reads the value of the timer into the 64-bit varbiale
    pointed to by :code:`counter`.