diff options
Diffstat (limited to 'drivers/ram/k3-j721e/lpddr4_obj_if.h')
| -rw-r--r-- | drivers/ram/k3-j721e/lpddr4_obj_if.h | 383 |
1 files changed, 383 insertions, 0 deletions
diff --git a/drivers/ram/k3-j721e/lpddr4_obj_if.h b/drivers/ram/k3-j721e/lpddr4_obj_if.h new file mode 100644 index 0000000000..33dae6f7ed --- /dev/null +++ b/drivers/ram/k3-j721e/lpddr4_obj_if.h @@ -0,0 +1,383 @@ +/* SPDX-License-Identifier: BSD-3-Clause */ +/********************************************************************** + * Copyright (C) 2012-2019 Cadence Design Systems, Inc. + ********************************************************************** + * WARNING: This file is auto-generated using api-generator utility. + * api-generator: 12.02.13bb8d5 + * Do not edit it manually. + ********************************************************************** + * Cadence Core Driver for LPDDR4. + ********************************************************************** + */ +#ifndef LPDDR4_OBJ_IF_H +#define LPDDR4_OBJ_IF_H + +#include "lpddr4_if.h" + +/** @defgroup DriverObject Driver API Object + * API listing for the driver. The API is contained in the object as + * function pointers in the object structure. As the actual functions + * resides in the Driver Object, the client software must first use the + * global GetInstance function to obtain the Driver Object Pointer. + * The actual APIs then can be invoked using obj->(api_name)() syntax. + * These functions are defined in the header file of the core driver + * and utilized by the API. + * @{ + */ + +/********************************************************************** +* API methods +**********************************************************************/ +typedef struct lpddr4_obj_s +{ + /** + * Checks configuration object. + * @param[in] config Driver/hardware configuration required. + * @param[out] configSize Size of memory allocations required. + * @return CDN_EOK on success (requirements structure filled). + * @return ENOTSUP if configuration cannot be supported due to driver/hardware constraints. + */ + uint32_t (*probe)(const lpddr4_config* config, uint16_t* configsize); + + /** + * Init function to be called after LPDDR4_probe() to set up the + * driver configuration. Memory should be allocated for drv_data + * (using the size determined using LPDDR4_probe) before calling + * this API. init_settings should be initialised with base addresses + * for PHY Indepenent Module, Controller and PHY before calling this + * function. If callbacks are required for interrupt handling, these + * should also be configured in init_settings. + * @param[in] pD Driver state info specific to this instance. + * @param[in] cfg Specifies driver/hardware configuration. + * @return CDN_EOK on success + * @return EINVAL if illegal/inconsistent values in cfg. + * @return ENOTSUP if hardware has an inconsistent configuration or doesn't support feature(s) required by 'config' parameters. + */ + uint32_t (*init)(lpddr4_privatedata* pd, const lpddr4_config* cfg); + + /** + * Start the driver. + * @param[in] pD Driver state info specific to this instance. + */ + uint32_t (*start)(const lpddr4_privatedata* pd); + + /** + * Read a register from the controller, PHY or PHY Independent Module + * @param[in] pD Driver state info specific to this instance. + * @param[in] cpp Indicates whether controller, PHY or PHY Independent Module register + * @param[in] regOffset Register offset + * @param[out] regValue Register value read + * @return CDN_EOK on success. + * @return EINVAL if regOffset if out of range or regValue is NULL + */ + uint32_t (*readreg)(const lpddr4_privatedata* pd, lpddr4_regblock cpp, uint32_t regoffset, uint32_t* regvalue); + + /** + * Write a register in the controller, PHY or PHY Independent Module + * @param[in] pD Driver state info specific to this instance. + * @param[in] cpp Indicates whether controller, PHY or PHY Independent Module register + * @param[in] regOffset Register offset + * @param[in] regValue Register value to be written + * @return CDN_EOK on success. + * @return EINVAL if regOffset is out of range or regValue is NULL + */ + uint32_t (*writereg)(const lpddr4_privatedata* pd, lpddr4_regblock cpp, uint32_t regoffset, uint32_t regvalue); + + /** + * Read a memory mode register from DRAM + * @param[in] pD Driver state info specific to this instance. + * @param[in] readModeRegVal Value to set in 'read_modereg' parameter. + * @param[out] mmrValue Value which is read from memory mode register(mmr) for all devices. + * @param[out] mmrStatus Status of mode register read(mrr) instruction. + * @return CDN_EOK on success. + * @return EINVAL if regNumber is out of range or regValue is NULL + */ + uint32_t (*getmmrregister)(const lpddr4_privatedata* pd, uint32_t readmoderegval, uint64_t* mmrvalue, uint8_t* mmrstatus); + + /** + * Write a memory mode register in DRAM + * @param[in] pD Driver state info specific to this instance. + * @param[in] writeModeRegVal Value to set in 'write_modereg' parameter. + * @param[out] mrwStatus Status of mode register write(mrw) instruction. + * @return CDN_EOK on success. + * @return EINVAL if regNumber is out of range or regValue is NULL + */ + uint32_t (*setmmrregister)(const lpddr4_privatedata* pd, uint32_t writemoderegval, uint8_t* mrwstatus); + + /** + * Write a set of initialisation values to the controller registers + * @param[in] pD Driver state info specific to this instance. + * @param[in] regValues Register values to be written + * @return CDN_EOK on success. + * @return EINVAL if regValues is NULL + */ + uint32_t (*writectlconfig)(const lpddr4_privatedata* pd, const lpddr4_reginitdata* regvalues); + + /** + * Write a set of initialisation values to the PHY registers + * @param[in] pD Driver state info specific to this instance. + * @param[in] regValues Register values to be written + * @return CDN_EOK on success. + * @return EINVAL if regValues is NULL + */ + uint32_t (*writephyconfig)(const lpddr4_privatedata* pd, const lpddr4_reginitdata* regvalues); + + /** + * Write a set of initialisation values to the PHY Independent Module + * registers + * @param[in] pD Driver state info specific to this instance. + * @param[in] regValues Register values to be written + * @return CDN_EOK on success. + * @return EINVAL if regValues is NULL + */ + uint32_t (*writephyindepconfig)(const lpddr4_privatedata* pd, const lpddr4_reginitdata* regvalues); + + /** + * Read values of the controller registers in bulk (Set + * 'updateCtlReg' to read) and store in memory. + * @param[in] pD Driver state info specific to this instance. + * @param[out] regValues Register values which are read + * @return CDN_EOK on success. + * @return EINVAL if regValues is NULL + */ + uint32_t (*readctlconfig)(const lpddr4_privatedata* pd, lpddr4_reginitdata* regvalues); + + /** + * Read the values of the PHY module registers in bulk (Set + * 'updatePhyReg' to read) and store in memory. + * @param[in] pD Driver state info specific to this instance. + * @param[out] regValues Register values which are read + * @return CDN_EOK on success. + * @return EINVAL if regValues is NULL + */ + uint32_t (*readphyconfig)(const lpddr4_privatedata* pd, lpddr4_reginitdata* regvalues); + + /** + * Read the values of the PHY Independent module registers in + * bulk(Set 'updatePhyIndepReg' to read) and store in memory. + * @param[in] pD Driver state info specific to this instance. + * @param[out] regValues Register values which are read + * @return CDN_EOK on success. + * @return EINVAL if regValues is NULL + */ + uint32_t (*readphyindepconfig)(const lpddr4_privatedata* pd, lpddr4_reginitdata* regvalues); + + /** + * Read the current interrupt mask for the controller + * @param[in] pD Driver state info specific to this instance. + * @param[out] mask Value of interrupt mask + * @return CDN_EOK on success. + * @return EINVAL if mask pointer is NULL + */ + uint32_t (*getctlinterruptmask)(const lpddr4_privatedata* pd, uint64_t* mask); + + /** + * Sets the interrupt mask for the controller + * @param[in] pD Driver state info specific to this instance. + * @param[in] mask Value of interrupt mask to be written + * @return CDN_EOK on success. + * @return EINVAL if mask pointer is NULL + */ + uint32_t (*setctlinterruptmask)(const lpddr4_privatedata* pd, const uint64_t* mask); + + /** + * Check whether a specific controller interrupt is active + * @param[in] pD Driver state info specific to this instance. + * @param[in] intr Interrupt to be checked + * @param[out] irqStatus Status of the interrupt, TRUE if active + * @return CDN_EOK on success. + * @return EINVAL if intr is not valid + */ + uint32_t (*checkctlinterrupt)(const lpddr4_privatedata* pd, lpddr4_ctlinterrupt intr, bool* irqstatus); + + /** + * Acknowledge a specific controller interrupt + * @param[in] pD Driver state info specific to this instance. + * @param[in] intr Interrupt to be acknowledged + * @return CDN_EOK on success. + * @return EINVAL if intr is not valid + */ + uint32_t (*ackctlinterrupt)(const lpddr4_privatedata* pd, lpddr4_ctlinterrupt intr); + + /** + * Read the current interrupt mask for the PHY Independent Module + * @param[in] pD Driver state info specific to this instance. + * @param[out] mask Value of interrupt mask + * @return CDN_EOK on success. + * @return EINVAL if mask pointer is NULL + */ + uint32_t (*getphyindepinterruptmask)(const lpddr4_privatedata* pd, uint32_t* mask); + + /** + * Sets the interrupt mask for the PHY Independent Module + * @param[in] pD Driver state info specific to this instance. + * @param[in] mask Value of interrupt mask to be written + * @return CDN_EOK on success. + * @return EINVAL if mask pointer is NULL + */ + uint32_t (*setphyindepinterruptmask)(const lpddr4_privatedata* pd, const uint32_t* mask); + + /** + * Check whether a specific PHY Independent Module interrupt is + * active + * @param[in] pD Driver state info specific to this instance. + * @param[in] intr Interrupt to be checked + * @param[out] irqStatus Status of the interrupt, TRUE if active + * @return CDN_EOK on success. + * @return EINVAL if intr is not valid + */ + uint32_t (*checkphyindepinterrupt)(const lpddr4_privatedata* pd, lpddr4_phyindepinterrupt intr, bool* irqstatus); + + /** + * Acknowledge a specific PHY Independent Module interrupt + * @param[in] pD Driver state info specific to this instance. + * @param[in] intr Interrupt to be acknowledged + * @return CDN_EOK on success. + * @return EINVAL if intr is not valid + */ + uint32_t (*ackphyindepinterrupt)(const lpddr4_privatedata* pd, lpddr4_phyindepinterrupt intr); + + /** + * Retrieve status information after a failed init. The + * DebugStructInfo will be filled in with error codes which can be + * referenced against the driver documentation for further details. + * @param[in] pD Driver state info specific to this instance. + * @param[out] debugInfo status + * @return CDN_EOK on success. + * @return EINVAL if debugInfo is NULL + */ + uint32_t (*getdebuginitinfo)(const lpddr4_privatedata* pd, lpddr4_debuginfo* debuginfo); + + /** + * Get the current value of Low power Interface wake up time. + * @param[in] pD Driver state info specific to this instance. + * @param[in] lpiWakeUpParam LPI timing parameter + * @param[in] fspNum Frequency copy + * @param[out] cycles Timing value(in cycles) + * @return CDN_EOK on success. + * @return EINVAL if powerMode is NULL + */ + uint32_t (*getlpiwakeuptime)(const lpddr4_privatedata* pd, const lpddr4_lpiwakeupparam* lpiwakeupparam, const lpddr4_ctlfspnum* fspnum, uint32_t* cycles); + + /** + * Set the current value of Low power Interface wake up time. + * @param[in] pD Driver state info specific to this instance. + * @param[in] lpiWakeUpParam LPI timing parameter + * @param[in] fspNum Frequency copy + * @param[in] cycles Timing value(in cycles) + * @return CDN_EOK on success. + * @return EINVAL if powerMode is NULL + */ + uint32_t (*setlpiwakeuptime)(const lpddr4_privatedata* pd, const lpddr4_lpiwakeupparam* lpiwakeupparam, const lpddr4_ctlfspnum* fspnum, const uint32_t* cycles); + + /** + * Get the current value for ECC auto correction + * @param[in] pD Driver state info specific to this instance. + * @param[out] eccParam ECC parameter setting + * @return CDN_EOK on success. + * @return EINVAL if on_off is NULL + */ + uint32_t (*geteccenable)(const lpddr4_privatedata* pd, lpddr4_eccenable* eccparam); + + /** + * Set the value for ECC auto correction. This API must be called + * before startup of memory. + * @param[in] pD Driver state info specific to this instance. + * @param[in] eccParam ECC control parameter setting + * @return CDN_EOK on success. + * @return EINVAL if on_off is NULL + */ + uint32_t (*seteccenable)(const lpddr4_privatedata* pd, const lpddr4_eccenable* eccparam); + + /** + * Get the current value for the Half Datapath option + * @param[in] pD Driver state info specific to this instance. + * @param[out] mode Half Datapath setting + * @return CDN_EOK on success. + * @return EINVAL if mode is NULL + */ + uint32_t (*getreducmode)(const lpddr4_privatedata* pd, lpddr4_reducmode* mode); + + /** + * Set the value for the Half Datapath option. This API must be + * called before startup of memory. + * @param[in] pD Driver state info specific to this instance. + * @param[in] mode Half Datapath setting + * @return CDN_EOK on success. + * @return EINVAL if mode is NULL + */ + uint32_t (*setreducmode)(const lpddr4_privatedata* pd, const lpddr4_reducmode* mode); + + /** + * Get the current value for Data Bus Inversion setting. This will + * be compared with the current DRAM setting using the MR3 + * register. + * @param[in] pD Driver state info specific to this instance. + * @param[out] on_off DBI read value + * @return CDN_EOK on success. + * @return EINVAL if on_off is NULL + */ + uint32_t (*getdbireadmode)(const lpddr4_privatedata* pd, bool* on_off); + + /** + * Get the current value for Data Bus Inversion setting. This will + * be compared with the current DRAM setting using the MR3 + * register. + * @param[in] pD Driver state info specific to this instance. + * @param[out] on_off DBI write value + * @return CDN_EOK on success. + * @return EINVAL if on_off is NULL + */ + uint32_t (*getdbiwritemode)(const lpddr4_privatedata* pd, bool* on_off); + + /** + * Set the mode for Data Bus Inversion. This will also be set in DRAM + * using the MR3 controller register. This API must be called + * before startup of memory. + * @param[in] pD Driver state info specific to this instance. + * @param[in] mode status + * @return CDN_EOK on success. + * @return EINVAL if mode is NULL + */ + uint32_t (*setdbimode)(const lpddr4_privatedata* pd, const lpddr4_dbimode* mode); + + /** + * Get the current value for the refresh rate (reading Refresh per + * command timing). + * @param[in] pD Driver state info specific to this instance. + * @param[in] fspNum Frequency set number + * @param[out] cycles Refresh rate (in cycles) + * @return CDN_EOK on success. + * @return EINVAL if rate is NULL + */ + uint32_t (*getrefreshrate)(const lpddr4_privatedata* pd, const lpddr4_ctlfspnum* fspnum, uint32_t* cycles); + + /** + * Set the refresh rate (writing Refresh per command timing). + * @param[in] pD Driver state info specific to this instance. + * @param[in] fspNum Frequency set number + * @param[in] cycles Refresh rate (in cycles) + * @return CDN_EOK on success. + * @return EINVAL if rate is NULL + */ + uint32_t (*setrefreshrate)(const lpddr4_privatedata* pd, const lpddr4_ctlfspnum* fspnum, const uint32_t* cycles); + + /** + * Handle Refreshing per chip select + * @param[in] pD Driver state info specific to this instance. + * @param[in] trefInterval status + * @return CDN_EOK on success. + * @return EINVAL if chipSelect is invalid + */ + uint32_t (*refreshperchipselect)(const lpddr4_privatedata* pd, const uint32_t trefinterval); + +} LPDDR4_OBJ; + +/** + * In order to access the LPDDR4 APIs, the upper layer software must call + * this global function to obtain the pointer to the driver object. + * @return LPDDR4_OBJ* Driver Object Pointer + */ +extern LPDDR4_OBJ *lpddr4_getinstance(void); + +#endif /* LPDDR4_OBJ_IF_H */ |