aboutsummaryrefslogtreecommitdiffstats
path: root/lib/pico-sdk/rp2040/hardware/structs/xip.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/pico-sdk/rp2040/hardware/structs/xip.h')
-rw-r--r--lib/pico-sdk/rp2040/hardware/structs/xip.h76
1 files changed, 76 insertions, 0 deletions
diff --git a/lib/pico-sdk/rp2040/hardware/structs/xip.h b/lib/pico-sdk/rp2040/hardware/structs/xip.h
new file mode 100644
index 00000000..332e8ccf
--- /dev/null
+++ b/lib/pico-sdk/rp2040/hardware/structs/xip.h
@@ -0,0 +1,76 @@
+// THIS HEADER FILE IS AUTOMATICALLY GENERATED -- DO NOT EDIT
+
+/**
+ * Copyright (c) 2024 Raspberry Pi Ltd.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+#ifndef _HARDWARE_STRUCTS_XIP_H
+#define _HARDWARE_STRUCTS_XIP_H
+
+/**
+ * \file rp2040/xip.h
+ */
+
+#include "hardware/address_mapped.h"
+#include "hardware/regs/xip.h"
+
+// Reference to datasheet: https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf#tab-registerlist_xip
+//
+// The _REG_ macro is intended to help make the register navigable in your IDE (for example, using the "Go to Definition" feature)
+// _REG_(x) will link to the corresponding register in hardware/regs/xip.h.
+//
+// Bit-field descriptions are of the form:
+// BITMASK [BITRANGE] FIELDNAME (RESETVALUE) DESCRIPTION
+
+typedef struct {
+ _REG_(XIP_CTRL_OFFSET) // XIP_CTRL
+ // Cache control
+ // 0x00000008 [3] POWER_DOWN (0) When 1, the cache memories are powered down
+ // 0x00000002 [1] ERR_BADWRITE (1) When 1, writes to any alias other than 0x0 (caching,...
+ // 0x00000001 [0] EN (1) When 1, enable the cache
+ io_rw_32 ctrl;
+
+ _REG_(XIP_FLUSH_OFFSET) // XIP_FLUSH
+ // Cache Flush control
+ // 0x00000001 [0] FLUSH (0) Write 1 to flush the cache
+ io_wo_32 flush;
+
+ _REG_(XIP_STAT_OFFSET) // XIP_STAT
+ // Cache Status
+ // 0x00000004 [2] FIFO_FULL (0) When 1, indicates the XIP streaming FIFO is completely full
+ // 0x00000002 [1] FIFO_EMPTY (1) When 1, indicates the XIP streaming FIFO is completely empty
+ // 0x00000001 [0] FLUSH_READY (0) Reads as 0 while a cache flush is in progress, and 1 otherwise
+ io_ro_32 stat;
+
+ _REG_(XIP_CTR_HIT_OFFSET) // XIP_CTR_HIT
+ // Cache Hit counter
+ // 0xffffffff [31:0] CTR_HIT (0x00000000) A 32 bit saturating counter that increments upon each...
+ io_rw_32 ctr_hit;
+
+ _REG_(XIP_CTR_ACC_OFFSET) // XIP_CTR_ACC
+ // Cache Access counter
+ // 0xffffffff [31:0] CTR_ACC (0x00000000) A 32 bit saturating counter that increments upon each...
+ io_rw_32 ctr_acc;
+
+ _REG_(XIP_STREAM_ADDR_OFFSET) // XIP_STREAM_ADDR
+ // FIFO stream address
+ // 0xfffffffc [31:2] STREAM_ADDR (0x00000000) The address of the next word to be streamed from flash...
+ io_rw_32 stream_addr;
+
+ _REG_(XIP_STREAM_CTR_OFFSET) // XIP_STREAM_CTR
+ // FIFO stream control
+ // 0x003fffff [21:0] STREAM_CTR (0x000000) Write a nonzero value to start a streaming read
+ io_rw_32 stream_ctr;
+
+ _REG_(XIP_STREAM_FIFO_OFFSET) // XIP_STREAM_FIFO
+ // FIFO stream data
+ // 0xffffffff [31:0] STREAM_FIFO (0x00000000) Streamed data is buffered here, for retrieval by the system DMA
+ io_ro_32 stream_fifo;
+} xip_ctrl_hw_t;
+
+#define xip_ctrl_hw ((xip_ctrl_hw_t *)XIP_CTRL_BASE)
+static_assert(sizeof (xip_ctrl_hw_t) == 0x0020, "");
+
+#endif // _HARDWARE_STRUCTS_XIP_H
+