psram.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _HARDWARE_PSRAM_H
#define _HARDWARE_PSRAM_H
 
#include "pico.h"
#include "hardware/clocks.h"
#include "hardware/flash.h"

 
// PICO_CONFIG: PARAM_ASSERTIONS_ENABLED_HARDWARE_PSRAM, Enable/disable assertions in the hardware_psram module, type=bool, default=0, group=hardware_psram
#ifndef PARAM_ASSERTIONS_ENABLED_HARDWARE_PSRAM
#define PARAM_ASSERTIONS_ENABLED_HARDWARE_PSRAM 0
#endif
 
// PICO_CONFIG: PICO_PSRAM_SIZE_BYTES, size of psram in bytes, type=int, default=Usually provided via board header if psram is present, group=hardware_psram
// PICO_CONFIG: PICO_PSRAM_CS_PIN, chip select pin for psram, type=int, default=Usually provided via board header if psram is present, group=hardware_psram
 
// PICO_CONFIG: PICO_AUTO_DETECT_PSRAM, automatically detect if psram is present, type=bool, default=0, group=hardware_psram
#ifndef PICO_AUTO_DETECT_PSRAM
#define PICO_AUTO_DETECT_PSRAM 0
#endif
 
// PICO_CONFIG: PICO_AUTO_DETECT_PSRAM_SIZE, automatically detect psram size, type=bool, default=PICO_AUTO_DETECT_PSRAM, group=hardware_psram
#ifndef PICO_AUTO_DETECT_PSRAM_SIZE
#define PICO_AUTO_DETECT_PSRAM_SIZE PICO_AUTO_DETECT_PSRAM
#endif
 
// PICO_CONFIG: PICO_AUTO_DETECT_PSRAM_CS, automatically detect psram chip select pin, type=bool, default=PICO_AUTO_DETECT_PSRAM, group=hardware_psram
#ifndef PICO_AUTO_DETECT_PSRAM_CS
#define PICO_AUTO_DETECT_PSRAM_CS PICO_AUTO_DETECT_PSRAM
#elif PICO_AUTO_DETECT_PSRAM_CS && !PICO_AUTO_DETECT_PSRAM_SIZE
#error "PICO_AUTO_DETECT_PSRAM_SIZE must be set to use PICO_AUTO_DETECT_PSRAM_CS"
#endif
 
// PICO_CONFIG: PICO_AUTO_DETECT_PSRAM_CS_SKIP_DEFAULTS, skip any _DEFAULT_ GPIOs defined in the board header when auto-detecting psram chip select pin, type=bool, default=PICO_AUTO_DETECT_PSRAM_CS, group=hardware_psram
// PICO_CONFIG: PICO_AUTO_DETECT_PSRAM_CS_SKIP_PINS, comma separated list of extra pins to not check when auto-detecting psram chip select pin, type=list, group=hardware_psram
#ifndef PICO_AUTO_DETECT_PSRAM_CS_SKIP_DEFAULTS
#define PICO_AUTO_DETECT_PSRAM_CS_SKIP_DEFAULTS PICO_AUTO_DETECT_PSRAM_CS
#endif
 
// PICO_CONFIG: PICO_DEFAULT_PSRAM_ID, Default ID of psram used for auto-detection, type=int, default=0x5D, group=hardware_psram
#ifndef PICO_DEFAULT_PSRAM_ID
#define PICO_DEFAULT_PSRAM_ID 0x5D
#endif
 
// PICO_CONFIG: PICO_DEFAULT_PSRAM_MAX_FREQ, Default max frequency of psram, type=int, default=133 * MHZ, group=hardware_psram
#ifndef PICO_DEFAULT_PSRAM_MAX_FREQ
#define PICO_DEFAULT_PSRAM_MAX_FREQ (133 * MHZ)
#endif
 
// PICO_CONFIG: PICO_DEFAULT_PSRAM_MAX_SELECT, Default max select time of psram in ns, type=int, default=8000, group=hardware_psram
#ifndef PICO_DEFAULT_PSRAM_MAX_SELECT
#define PICO_DEFAULT_PSRAM_MAX_SELECT 8000
#endif
 
// PICO_CONFIG: PICO_DEFAULT_PSRAM_MIN_DESELECT, Default min deselect time of psram in ns, type=int, default=18, group=hardware_psram
#ifndef PICO_DEFAULT_PSRAM_MIN_DESELECT
#define PICO_DEFAULT_PSRAM_MIN_DESELECT 18
#endif
 
 
// PICO_CONFIG: PICO_RUNTIME_SKIP_INIT_PSRAM, Skip calling of `runtime_init_setup_psram` function during runtime init, type=bool, default=0, group=pico_runtime_init
// PICO_CONFIG: PICO_RUNTIME_NO_INIT_PSRAM, Do not include SDK implementation of `runtime_init_setup_psram` function, type=bool, default=0, group=pico_runtime_init
 
#ifndef PICO_RUNTIME_INIT_PSRAM
#define PICO_RUNTIME_INIT_PSRAM                 "11080"
#endif
 
#ifndef PICO_RUNTIME_SKIP_INIT_PSRAM
#define PICO_RUNTIME_SKIP_INIT_PSRAM 0
#endif
 
#ifndef PICO_RUNTIME_NO_INIT_PSRAM
#define PICO_RUNTIME_NO_INIT_PSRAM 0
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

bool psram_is_available(void);

size_t psram_get_size(void);

bool psram_check_address(void* addr);

size_t psram_detect_size(void);

size_t psram_detect_cs_and_size(uint8_t *cs_gpios, size_t num);

int psram_configure_params(uint32_t max_psram_freq, uint32_t max_select_ns, uint32_t min_deselect_ns);

int psram_set_params(uint32_t divisor, uint32_t rxdelay, uint32_t max_select, uint32_t min_deselect);

int psram_reinitialize(void);

size_t psram_eid_to_size(uint8_t kgd, uint8_t eid);

#define psram_or_malloc(group, type, var, size) \
    static type __uninitialized_psram(group) var##_psram[size]; static type* var; \
    if (!var) { \
        if (psram_check_address(var##_psram + (size))) { \
           var = (type*)var##_psram; \
        } else { \
            var = (type*)malloc((size) * sizeof(type)); \
        } \
    }

#define psram_or_free(var) if (!psram_check_address(var##_psram)) { free(var); }
 
#ifdef __cplusplus
}
#endif
 
#endif // _HARDWARE_PSRAM_H