1 // THIS HEADER FILE IS AUTOMATICALLY GENERATED -- DO NOT EDIT
2 
3 /**
4  * Copyright (c) 2024 Raspberry Pi Ltd.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  */
8 #ifndef _HARDWARE_STRUCTS_SYSTICK_H
9 #define _HARDWARE_STRUCTS_SYSTICK_H
10 
11 /**
12  * \file rp2040/systick.h
13  */
14 
15 #include "hardware/address_mapped.h"
16 #include "hardware/regs/m0plus.h"
17 
18 // Reference to datasheet: https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf#tab-registerlist_m0plus
19 //
20 // The _REG_ macro is intended to help make the register navigable in your IDE (for example, using the "Go to Definition" feature)
21 // _REG_(x) will link to the corresponding register in hardware/regs/m0plus.h.
22 //
23 // Bit-field descriptions are of the form:
24 // BITMASK [BITRANGE] FIELDNAME (RESETVALUE) DESCRIPTION
25 
26 typedef struct {
27     _REG_(M0PLUS_SYST_CSR_OFFSET) // M0PLUS_SYST_CSR
28     // SysTick Control and Status Register
29     // 0x00010000 [16]    COUNTFLAG    (0) Returns 1 if timer counted to 0 since last time this was read
30     // 0x00000004 [2]     CLKSOURCE    (0) SysTick clock source
31     // 0x00000002 [1]     TICKINT      (0) Enables SysTick exception request: +
32     // 0x00000001 [0]     ENABLE       (0) Enable SysTick counter: +
33     io_rw_32 csr;
34 
35     _REG_(M0PLUS_SYST_RVR_OFFSET) // M0PLUS_SYST_RVR
36     // SysTick Reload Value Register
37     // 0x00ffffff [23:0]  RELOAD       (0x000000) Value to load into the SysTick Current Value Register...
38     io_rw_32 rvr;
39 
40     _REG_(M0PLUS_SYST_CVR_OFFSET) // M0PLUS_SYST_CVR
41     // SysTick Current Value Register
42     // 0x00ffffff [23:0]  CURRENT      (0x000000) Reads return the current value of the SysTick counter
43     io_rw_32 cvr;
44 
45     _REG_(M0PLUS_SYST_CALIB_OFFSET) // M0PLUS_SYST_CALIB
46     // SysTick Calibration Value Register
47     // 0x80000000 [31]    NOREF        (0) If reads as 1, the Reference clock is not provided - the...
48     // 0x40000000 [30]    SKEW         (0) If reads as 1, the calibration value for 10ms is inexact...
49     // 0x00ffffff [23:0]  TENMS        (0x000000) An optional Reload value to be used for 10ms (100Hz)...
50     io_ro_32 calib;
51 } systick_hw_t;
52 
53 #define systick_hw ((systick_hw_t *)(PPB_BASE + M0PLUS_SYST_CSR_OFFSET))
54 static_assert(sizeof (systick_hw_t) == 0x0010, "");
55 
56 #endif // _HARDWARE_STRUCTS_SYSTICK_H
57 
58