blob: ea9ca8c8360af76bc7b9daa1d0821e10a7161c39 [file] [log] [blame]
/*
* Copyright 2022 NXP
*
* SPDX-License-Identifier: Apache-2.0
*/
/*
* Based on memc_mcux_flexspi_s27ks0641, which is: Copyright 2021 Basalte bv
*/
#define DT_DRV_COMPAT nxp_imx_flexspi_aps6408l
#include <zephyr/kernel.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/util.h>
#include "memc_mcux_flexspi.h"
/*
* NOTE: If CONFIG_FLASH_MCUX_FLEXSPI_XIP is selected, Any external functions
* called while interacting with the flexspi MUST be relocated to SRAM or ITCM
* at runtime, so that the chip does not access the flexspi to read program
* instructions while it is being written to
*/
#if defined(CONFIG_FLASH_MCUX_FLEXSPI_XIP) && (CONFIG_MEMC_LOG_LEVEL > 0)
#warning "Enabling memc driver logging and XIP mode simultaneously can cause \
read-while-write hazards. This configuration is not recommended."
#endif
LOG_MODULE_REGISTER(memc_flexspi_aps6408l, CONFIG_MEMC_LOG_LEVEL);
#define APM_VENDOR_ID 0xD
/* APS6408L Configuration registers */
#define APS_6408L_MR_0 0x0
#define APS_6408L_MR_1 0x1
#define APS_6408L_MR_2 0x2
#define APS_6408L_MR_3 0x3
#define APS_6408L_MR_4 0x4
#define APS_6408L_MR_6 0x6
#define APS_6408L_MR_8 0x8
/* Read Latency code (MR0[4:2]) */
#define APS_6408L_RLC_MASK 0x1C
#define APS_6408L_RLC_200 0x10 /* 200MHz input clock read latency */
/* Read Latency type (MR0[5]) */
#define APS_6408L_RLT_MASK 0x30
#define APS_6408L_RLT_VARIABLE 0x0 /* Variable latency */
/* Burst type/burst length mask (MR8[0:2]) */
#define APS_6408L_BURST_TYPE_MASK 0x7
#define APS_6408L_BURST_1K 0x7 /* 1K Hybrid wrap */
/* Row boundary cross enable mask (MR8[3]) */
#define APS_6408L_ROW_CROSS_MASK 0x8
#define APS_6408L_ROW_CROSS_EN 0x8 /* Enable linear burst reads to cross rows */
/* Write latency (MR4[7:5]) */
#define APS_6408L_WLC_MASK 0xE0
#define APS_6408L_WLC_200 0x20 /* 200MHz input clock write latency */
enum {
READ_DATA = 0,
WRITE_DATA,
READ_REG,
WRITE_REG,
RESET,
};
struct memc_flexspi_aps6408l_config {
flexspi_port_t port;
flexspi_device_config_t config;
};
/* Device variables used in critical sections should be in this structure */
struct memc_flexspi_aps6408l_data {
const struct device *controller;
};
static const uint32_t memc_flexspi_aps6408l_lut[][4] = {
/* Read Data (Sync read, linear burst) */
[READ_DATA] = {
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_8PAD, 0x20,
kFLEXSPI_Command_RADDR_DDR, kFLEXSPI_8PAD, 0x20),
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_DUMMY_RWDS_DDR, kFLEXSPI_8PAD,
0x07, kFLEXSPI_Command_READ_DDR, kFLEXSPI_8PAD, 0x04),
},
/* Write Data (Sync write, linear burst) */
[WRITE_DATA] = {
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_8PAD, 0xA0,
kFLEXSPI_Command_RADDR_DDR, kFLEXSPI_8PAD, 0x20),
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_DUMMY_RWDS_DDR, kFLEXSPI_8PAD,
0x07, kFLEXSPI_Command_WRITE_DDR, kFLEXSPI_8PAD, 0x04),
},
/* Read Register (Mode register read) */
[READ_REG] = {
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_8PAD, 0x40,
kFLEXSPI_Command_RADDR_DDR, kFLEXSPI_8PAD, 0x20),
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_DUMMY_RWDS_DDR, kFLEXSPI_8PAD,
0x07, kFLEXSPI_Command_READ_DDR, kFLEXSPI_8PAD, 0x04),
},
/* Write Register (Mode register write) */
[WRITE_REG] = {
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_8PAD, 0xC0,
kFLEXSPI_Command_RADDR_DDR, kFLEXSPI_8PAD, 0x20),
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_WRITE_DDR, kFLEXSPI_8PAD, 0x08,
kFLEXSPI_Command_STOP, kFLEXSPI_1PAD, 0x00),
},
/* Reset (Global reset) */
[RESET] = {
FLEXSPI_LUT_SEQ(kFLEXSPI_Command_SDR, kFLEXSPI_8PAD, 0xFF,
kFLEXSPI_Command_DUMMY_SDR, kFLEXSPI_8PAD, 0x03),
}
};
static int memc_flexspi_aps6408l_get_vendor_id(const struct device *dev,
uint8_t *vendor_id)
{
const struct memc_flexspi_aps6408l_config *config = dev->config;
struct memc_flexspi_aps6408l_data *data = dev->data;
uint32_t buffer = 0;
int ret;
flexspi_transfer_t transfer = {
.deviceAddress = APS_6408L_MR_1,
.port = config->port,
.cmdType = kFLEXSPI_Read,
.SeqNumber = 1,
.seqIndex = READ_REG,
.data = &buffer,
.dataSize = 1,
};
ret = memc_flexspi_transfer(data->controller, &transfer);
*vendor_id = buffer & 0x1f;
return ret;
}
static int memc_flexspi_aps6408l_update_reg(const struct device *dev,
uint8_t reg, uint8_t mask, uint8_t set_val)
{
const struct memc_flexspi_aps6408l_config *config = dev->config;
struct memc_flexspi_aps6408l_data *data = dev->data;
uint32_t buffer = 0;
int ret;
flexspi_transfer_t transfer = {
.deviceAddress = reg,
.port = config->port,
.cmdType = kFLEXSPI_Read,
.SeqNumber = 1,
.seqIndex = READ_REG,
.data = &buffer,
.dataSize = 1,
};
ret = memc_flexspi_transfer(data->controller, &transfer);
if (ret < 0) {
return ret;
}
buffer &= (~mask & 0xFF);
buffer |= set_val;
LOG_DBG("Setting reg 0x%0x to 0x%0x", reg, buffer);
transfer.cmdType = kFLEXSPI_Write,
transfer.seqIndex = WRITE_REG;
ret = memc_flexspi_transfer(data->controller, &transfer);
return ret;
}
static int memc_flexspi_aps6408l_reset(const struct device *dev)
{
const struct memc_flexspi_aps6408l_config *config = dev->config;
struct memc_flexspi_aps6408l_data *data = dev->data;
int ret;
flexspi_transfer_t transfer = {
.deviceAddress = 0x0,
.port = config->port,
.cmdType = kFLEXSPI_Command,
.SeqNumber = 1,
.seqIndex = RESET,
.data = NULL,
.dataSize = 0,
};
LOG_DBG("Resetting ram");
ret = memc_flexspi_transfer(data->controller, &transfer);
if (ret < 0) {
return ret;
}
/* We need to delay 5 ms to allow APS6408L pSRAM to reinitialize */
k_msleep(5);
return ret;
}
static int memc_flexspi_aps6408l_init(const struct device *dev)
{
const struct memc_flexspi_aps6408l_config *config = dev->config;
struct memc_flexspi_aps6408l_data *data = dev->data;
uint8_t vendor_id;
if (!device_is_ready(data->controller)) {
LOG_ERR("Controller device not ready");
return -ENODEV;
}
if (memc_flexspi_set_device_config(data->controller, &config->config,
config->port)) {
LOG_ERR("Could not set device configuration");
return -EINVAL;
}
if (memc_flexspi_update_lut(data->controller, 0,
(const uint32_t *) memc_flexspi_aps6408l_lut,
sizeof(memc_flexspi_aps6408l_lut) / 4)) {
LOG_ERR("Could not update lut");
return -EINVAL;
}
memc_flexspi_reset(data->controller);
if (memc_flexspi_aps6408l_reset(dev)) {
LOG_ERR("Could not reset pSRAM");
return -EIO;
}
if (memc_flexspi_aps6408l_get_vendor_id(dev, &vendor_id)) {
LOG_ERR("Could not read vendor id");
return -EIO;
}
LOG_DBG("Vendor id: 0x%0x", vendor_id);
if (vendor_id != APM_VENDOR_ID) {
LOG_WRN("Vendor ID does not match expected value of 0x%0x",
APM_VENDOR_ID);
}
/* Enable RBX, burst length set to 1K byte wrap.
* this will also enable boundary crossing for burst reads
*/
if (memc_flexspi_aps6408l_update_reg(dev, APS_6408L_MR_8,
(APS_6408L_ROW_CROSS_MASK | APS_6408L_BURST_TYPE_MASK),
(APS_6408L_ROW_CROSS_EN | APS_6408L_BURST_1K))) {
LOG_ERR("Could not enable RBX 1K burst length");
return -EIO;
}
/* Set read latency code and type for 200MHz flash clock operation */
if (memc_flexspi_aps6408l_update_reg(dev, APS_6408L_MR_0,
(APS_6408L_RLC_MASK | APS_6408L_RLT_MASK),
(APS_6408L_RLC_200 | APS_6408L_RLT_VARIABLE))) {
LOG_ERR("Could not set 200MHz read latency code");
return -EIO;
}
/* Set write latency code and type for 200MHz flash clock operation */
if (memc_flexspi_aps6408l_update_reg(dev, APS_6408L_MR_4,
APS_6408L_WLC_MASK, APS_6408L_WLC_200)) {
LOG_ERR("Could not set 200MHz write latency code");
return -EIO;
}
return 0;
}
#define CONCAT3(x, y, z) x ## y ## z
#define CS_INTERVAL_UNIT(unit) \
CONCAT3(kFLEXSPI_CsIntervalUnit, unit, SckCycle)
#define AHB_WRITE_WAIT_UNIT(unit) \
CONCAT3(kFLEXSPI_AhbWriteWaitUnit, unit, AhbCycle)
#define MEMC_FLEXSPI_DEVICE_CONFIG(n) \
{ \
.flexspiRootClk = DT_INST_PROP(n, spi_max_frequency), \
.isSck2Enabled = false, \
.flashSize = DT_INST_PROP(n, size) / 8 / KB(1), \
.CSIntervalUnit = \
CS_INTERVAL_UNIT( \
DT_INST_PROP(n, cs_interval_unit)), \
.CSInterval = DT_INST_PROP(n, cs_interval), \
.CSHoldTime = DT_INST_PROP(n, cs_hold_time), \
.CSSetupTime = DT_INST_PROP(n, cs_setup_time), \
.dataValidTime = DT_INST_PROP(n, data_valid_time), \
.columnspace = DT_INST_PROP(n, column_space), \
.enableWordAddress = DT_INST_PROP(n, word_addressable), \
.AWRSeqIndex = WRITE_DATA, \
.AWRSeqNumber = 1, \
.ARDSeqIndex = READ_DATA, \
.ARDSeqNumber = 1, \
.AHBWriteWaitUnit = \
AHB_WRITE_WAIT_UNIT( \
DT_INST_PROP(n, ahb_write_wait_unit)), \
.AHBWriteWaitInterval = \
DT_INST_PROP(n, ahb_write_wait_interval), \
.enableWriteMask = true, \
} \
#define MEMC_FLEXSPI_APS6408L(n) \
static const struct memc_flexspi_aps6408l_config \
memc_flexspi_aps6408l_config_##n = { \
.port = DT_INST_REG_ADDR(n), \
.config = MEMC_FLEXSPI_DEVICE_CONFIG(n), \
}; \
\
static struct memc_flexspi_aps6408l_data \
memc_flexspi_aps6408l_data_##n = { \
.controller = DEVICE_DT_GET(DT_INST_BUS(n)), \
}; \
\
DEVICE_DT_INST_DEFINE(n, \
memc_flexspi_aps6408l_init, \
NULL, \
&memc_flexspi_aps6408l_data_##n, \
&memc_flexspi_aps6408l_config_##n, \
POST_KERNEL, \
CONFIG_KERNEL_INIT_PRIORITY_DEVICE, \
NULL);
DT_INST_FOREACH_STATUS_OKAY(MEMC_FLEXSPI_APS6408L)