From b0026937c1c49699d1b2e6482024732efd8d4647 Mon Sep 17 00:00:00 2001 From: Florent Kermarrec Date: Tue, 20 Aug 2024 14:58:51 +0200 Subject: [PATCH] soc/software/libbase: Move HyperRAM init code to libbase/hyperram.c. --- litex/soc/software/bios/main.c | 85 ++----------------------- litex/soc/software/libbase/Makefile | 3 +- litex/soc/software/libbase/hyperram.c | 89 +++++++++++++++++++++++++++ litex/soc/software/libbase/hyperram.h | 17 +++++ 4 files changed, 112 insertions(+), 82 deletions(-) create mode 100644 litex/soc/software/libbase/hyperram.c create mode 100644 litex/soc/software/libbase/hyperram.h diff --git a/litex/soc/software/bios/main.c b/litex/soc/software/bios/main.c index e576b6878..3a86cca36 100644 --- a/litex/soc/software/bios/main.c +++ b/litex/soc/software/bios/main.c @@ -38,6 +38,7 @@ #include #include #include +#include #include #include @@ -173,88 +174,10 @@ __attribute__((__used__)) int main(int i, char **c) printf("\n"); #endif - sdr_ok = 1; + sdr_ok = 1; -#ifdef CSR_HYPERRAM_BASE /* FIXME: Move to libbase/hyperram.h/c? */ - /* Helper Functions */ - - printf("HyperRAM init...\n"); - void hyperram_write_reg(uint16_t reg_addr, uint16_t data) { - /* Write data to the register */ - hyperram_reg_wdata_write(data); - hyperram_reg_control_write( - 1 << CSR_HYPERRAM_REG_CONTROL_WRITE_OFFSET | - 0 << CSR_HYPERRAM_REG_CONTROL_READ_OFFSET | - reg_addr << CSR_HYPERRAM_REG_CONTROL_ADDR_OFFSET - ); - /* Wait for write to complete */ - while ((hyperram_reg_status_read() & (1 << CSR_HYPERRAM_REG_STATUS_WRITE_DONE_OFFSET)) == 0); - } - - uint16_t hyperram_read_reg(uint16_t reg_addr) { - /* Read data from the register */ - hyperram_reg_control_write( - 0 << CSR_HYPERRAM_REG_CONTROL_WRITE_OFFSET | - 1 << CSR_HYPERRAM_REG_CONTROL_READ_OFFSET | - reg_addr << CSR_HYPERRAM_REG_CONTROL_ADDR_OFFSET - ); - /* Wait for read to complete */ - while ((hyperram_reg_status_read() & (1 << CSR_HYPERRAM_REG_STATUS_READ_DONE_OFFSET)) == 0); - return hyperram_reg_rdata_read(); - } - - /* Configuration and Utility Functions */ - - uint16_t hyperram_get_core_latency_setting(uint32_t clk_freq) { - /* Raw clock latency settings for the HyperRAM core */ - if (clk_freq <= 85000000) return 3; /* 3 Clock Latency */ - if (clk_freq <= 104000000) return 4; /* 4 Clock Latency */ - if (clk_freq <= 133000000) return 5; /* 5 Clock Latency */ - if (clk_freq <= 166000000) return 6; /* 6 Clock Latency */ - if (clk_freq <= 250000000) return 7; /* 7 Clock Latency */ - return 7; /* Default to highest latency for safety */ - } - - uint16_t hyperram_get_chip_latency_setting(uint32_t clk_freq) { - /* LUT/Translated settings for the HyperRAM chip */ - if (clk_freq <= 85000000) return 0b1110; /* 3 Clock Latency */ - if (clk_freq <= 104000000) return 0b1111; /* 4 Clock Latency */ - if (clk_freq <= 133000000) return 0b0000; /* 5 Clock Latency */ - if (clk_freq <= 166000000) return 0b0001; /* 6 Clock Latency */ - if (clk_freq <= 250000000) return 0b0010; /* 7 Clock Latency */ - return 0b0010; /* Default to highest latency for safety */ - } - - void hyperram_configure_latency(void) { - uint16_t config_reg_0 = 0x8f2f; - uint16_t core_latency_setting; - uint16_t chip_latency_setting; - - /* Compute Latency settings */ - core_latency_setting = hyperram_get_core_latency_setting(CONFIG_CLOCK_FREQUENCY/4); - chip_latency_setting = hyperram_get_chip_latency_setting(CONFIG_CLOCK_FREQUENCY/4); - - /* Write Latency to HyperRAM Core */ - printf("HyperRAM Core Latency: %d CK (X1).\n", core_latency_setting); - hyperram_config_write(core_latency_setting << CSR_HYPERRAM_CONFIG_LATENCY_OFFSET); - - /* Enable Variable Latency on HyperRAM Chip */ - if (hyperram_status_read() & 0x1) - config_reg_0 &= ~(0b1 << 3); /* Enable Variable Latency */ - - /* Update Latency on HyperRAM Chip */ - config_reg_0 &= ~(0b1111 << 4); - config_reg_0 |= chip_latency_setting << 4; - - /* Write Configuration Register 0 to HyperRAM Chip */ - hyperram_write_reg(2, config_reg_0); - - /* Read current configuration */ - config_reg_0 = hyperram_read_reg(2); - printf("HyperRAM Configuration Register 0: %08x\n", config_reg_0); - } - hyperram_configure_latency(); - printf("\n"); +#ifdef CSR_HYPERRAM_BASE + hyperram_init(); #endif #if defined(CSR_ETHMAC_BASE) || defined(MAIN_RAM_BASE) || defined(CSR_SPIFLASH_CORE_BASE) diff --git a/litex/soc/software/libbase/Makefile b/litex/soc/software/libbase/Makefile index 6b8736b17..fab41e466 100755 --- a/litex/soc/software/libbase/Makefile +++ b/litex/soc/software/libbase/Makefile @@ -11,7 +11,8 @@ OBJECTS = \ uart.o \ spiflash.o \ i2c.o \ - isr.o + isr.o \ + hyperram.o all: libbase.a diff --git a/litex/soc/software/libbase/hyperram.c b/litex/soc/software/libbase/hyperram.c new file mode 100644 index 000000000..da0cd5242 --- /dev/null +++ b/litex/soc/software/libbase/hyperram.c @@ -0,0 +1,89 @@ +// This file is Copyright (c) 2024 Florent Kermarrec +// License: BSD + +#include + +#include + +#include + +static void hyperram_write_reg(uint16_t reg_addr, uint16_t data) { + /* Write data to the register */ + hyperram_reg_wdata_write(data); + hyperram_reg_control_write( + 1 << CSR_HYPERRAM_REG_CONTROL_WRITE_OFFSET | + 0 << CSR_HYPERRAM_REG_CONTROL_READ_OFFSET | + reg_addr << CSR_HYPERRAM_REG_CONTROL_ADDR_OFFSET + ); + /* Wait for write to complete */ + while ((hyperram_reg_status_read() & (1 << CSR_HYPERRAM_REG_STATUS_WRITE_DONE_OFFSET)) == 0); + } + +static uint16_t hyperram_read_reg(uint16_t reg_addr) { + /* Read data from the register */ + hyperram_reg_control_write( + 0 << CSR_HYPERRAM_REG_CONTROL_WRITE_OFFSET | + 1 << CSR_HYPERRAM_REG_CONTROL_READ_OFFSET | + reg_addr << CSR_HYPERRAM_REG_CONTROL_ADDR_OFFSET + ); + /* Wait for read to complete */ + while ((hyperram_reg_status_read() & (1 << CSR_HYPERRAM_REG_STATUS_READ_DONE_OFFSET)) == 0); + return hyperram_reg_rdata_read(); +} + +/* Configuration and Utility Functions */ + +static uint16_t hyperram_get_core_latency_setting(uint32_t clk_freq) { + /* Raw clock latency settings for the HyperRAM core */ + if (clk_freq <= 85000000) return 3; /* 3 Clock Latency */ + if (clk_freq <= 104000000) return 4; /* 4 Clock Latency */ + if (clk_freq <= 133000000) return 5; /* 5 Clock Latency */ + if (clk_freq <= 166000000) return 6; /* 6 Clock Latency */ + if (clk_freq <= 250000000) return 7; /* 7 Clock Latency */ + return 7; /* Default to highest latency for safety */ +} + +static uint16_t hyperram_get_chip_latency_setting(uint32_t clk_freq) { + /* LUT/Translated settings for the HyperRAM chip */ + if (clk_freq <= 85000000) return 0b1110; /* 3 Clock Latency */ + if (clk_freq <= 104000000) return 0b1111; /* 4 Clock Latency */ + if (clk_freq <= 133000000) return 0b0000; /* 5 Clock Latency */ + if (clk_freq <= 166000000) return 0b0001; /* 6 Clock Latency */ + if (clk_freq <= 250000000) return 0b0010; /* 7 Clock Latency */ + return 0b0010; /* Default to highest latency for safety */ +} + +static void hyperram_configure_latency(void) { + uint16_t config_reg_0 = 0x8f2f; + uint16_t core_latency_setting; + uint16_t chip_latency_setting; + + /* Compute Latency settings */ + core_latency_setting = hyperram_get_core_latency_setting(CONFIG_CLOCK_FREQUENCY/4); + chip_latency_setting = hyperram_get_chip_latency_setting(CONFIG_CLOCK_FREQUENCY/4); + + /* Write Latency to HyperRAM Core */ + printf("HyperRAM Core Latency: %d CK (X1).\n", core_latency_setting); + hyperram_config_write(core_latency_setting << CSR_HYPERRAM_CONFIG_LATENCY_OFFSET); + + /* Enable Variable Latency on HyperRAM Chip */ + if (hyperram_status_read() & 0x1) + config_reg_0 &= ~(0b1 << 3); /* Enable Variable Latency */ + + /* Update Latency on HyperRAM Chip */ + config_reg_0 &= ~(0b1111 << 4); + config_reg_0 |= chip_latency_setting << 4; + + /* Write Configuration Register 0 to HyperRAM Chip */ + hyperram_write_reg(2, config_reg_0); + + /* Read current configuration */ + config_reg_0 = hyperram_read_reg(2); + printf("HyperRAM Configuration Register 0: %08x\n", config_reg_0); +} + +void hyperram_init(void) { + printf("HyperRAM init...\n"); + hyperram_configure_latency(); + printf("\n"); +} diff --git a/litex/soc/software/libbase/hyperram.h b/litex/soc/software/libbase/hyperram.h new file mode 100644 index 000000000..1c8a7d1e7 --- /dev/null +++ b/litex/soc/software/libbase/hyperram.h @@ -0,0 +1,17 @@ +// This file is Copyright (c) 2024 Florent Kermarrec +// License: BSD + +#ifndef __HYPERRAM_H +#define __HYPERRAM_H + +#ifdef __cplusplus +extern "C" { +#endif + +void hyperram_init(void); + +#ifdef __cplusplus +} +#endif + +#endif /* __HYPERRAM_H */