src/rp2350/hardware_structs/include/hardware/structs/xip.h

// 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 rp2350/xip.h
 */

#include "hardware/address_mapped.h"
#include "hardware/regs/xip.h"

// Reference to datasheet: https://datasheets.raspberrypi.com/rp2350/rp2350-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 register
    // 0x00000800 [11]    WRITABLE_M1  (0) If 1, enable writes to XIP memory window 1 (addresses...
    // 0x00000400 [10]    WRITABLE_M0  (0) If 1, enable writes to XIP memory window 0 (addresses...
    // 0x00000200 [9]     SPLIT_WAYS   (0) When 1, route all cached+Secure accesses to way 0 of the...
    // 0x00000100 [8]     MAINT_NONSEC (0) When 0, Non-secure accesses to the cache maintenance...
    // 0x00000080 [7]     NO_UNTRANSLATED_NONSEC (1) When 1, Non-secure accesses to the uncached,...
    // 0x00000040 [6]     NO_UNTRANSLATED_SEC (0) When 1, Secure accesses to the uncached, untranslated...
    // 0x00000020 [5]     NO_UNCACHED_NONSEC (0) When 1, Non-secure accesses to the uncached window...
    // 0x00000010 [4]     NO_UNCACHED_SEC (0) When 1, Secure accesses to the uncached window...
    // 0x00000008 [3]     POWER_DOWN   (0) When 1, the cache memories are powered down
    // 0x00000002 [1]     EN_NONSECURE (1) When 1, enable the cache for Non-secure accesses
    // 0x00000001 [0]     EN_SECURE    (1) When 1, enable the cache for Secure accesses
    io_rw_32 ctrl;
 
    uint32_t _pad0;
 
    _REG_(XIP_STAT_OFFSET) // XIP_STAT
    // 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
    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