2018-05-06 17:58:06 -04:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0+ */
|
2015-01-19 22:16:14 -07:00
|
|
|
/*
|
2015-10-11 21:37:38 -07:00
|
|
|
* Copyright (C) 2014 Google, Inc
|
2015-10-11 21:37:39 -07:00
|
|
|
* Copyright (C) 2015 Bin Meng <bmeng.cn@gmail.com>
|
2015-01-19 22:16:14 -07:00
|
|
|
*/
|
|
|
|
|
2015-10-11 21:37:38 -07:00
|
|
|
#ifndef _ASM_MRCCACHE_H
|
|
|
|
#define _ASM_MRCCACHE_H
|
2015-01-19 22:16:14 -07:00
|
|
|
|
2020-10-30 21:38:53 -06:00
|
|
|
#include <compiler.h>
|
|
|
|
|
2019-12-06 21:42:01 -07:00
|
|
|
#define MRC_DATA_ALIGN 0x100
|
2015-10-11 21:37:38 -07:00
|
|
|
#define MRC_DATA_SIGNATURE (('M' << 0) | ('R' << 8) | \
|
|
|
|
('C' << 16) | ('D'<<24))
|
2015-01-19 22:16:14 -07:00
|
|
|
|
2015-10-11 21:37:39 -07:00
|
|
|
#define MRC_DATA_HEADER_SIZE 32
|
|
|
|
|
2015-10-11 21:37:38 -07:00
|
|
|
struct __packed mrc_data_container {
|
2015-01-19 22:16:14 -07:00
|
|
|
u32 signature; /* "MRCD" */
|
|
|
|
u32 data_size; /* Size of the 'data' field */
|
|
|
|
u32 checksum; /* IP style checksum */
|
|
|
|
u32 reserved; /* For header alignment */
|
|
|
|
u8 data[0]; /* Variable size, platform/run time dependent */
|
|
|
|
};
|
|
|
|
|
2015-10-11 21:37:41 -07:00
|
|
|
struct mrc_region {
|
|
|
|
u32 base;
|
|
|
|
u32 offset;
|
|
|
|
u32 length;
|
|
|
|
};
|
|
|
|
|
2019-12-06 21:42:07 -07:00
|
|
|
/* Types of MRC data */
|
|
|
|
enum mrc_type_t {
|
|
|
|
MRC_TYPE_NORMAL,
|
2019-12-06 21:42:08 -07:00
|
|
|
MRC_TYPE_VAR,
|
2019-12-06 21:42:07 -07:00
|
|
|
|
|
|
|
MRC_TYPE_COUNT,
|
|
|
|
};
|
|
|
|
|
2015-03-26 09:29:26 -06:00
|
|
|
struct udevice;
|
2015-01-19 22:16:14 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* mrccache_find_current() - find the latest MRC cache record
|
|
|
|
*
|
|
|
|
* This searches the MRC cache region looking for the latest record to use
|
|
|
|
* for setting up SDRAM
|
|
|
|
*
|
2015-10-11 21:37:38 -07:00
|
|
|
* @entry: Position and size of MRC cache in SPI flash
|
2022-01-19 18:05:50 +01:00
|
|
|
* Return: pointer to latest record, or NULL if none
|
2015-01-19 22:16:14 -07:00
|
|
|
*/
|
2015-10-11 21:37:41 -07:00
|
|
|
struct mrc_data_container *mrccache_find_current(struct mrc_region *entry);
|
2015-01-19 22:16:14 -07:00
|
|
|
|
2015-10-11 21:37:39 -07:00
|
|
|
/**
|
|
|
|
* mrccache_reserve() - reserve MRC data on the stack
|
|
|
|
*
|
|
|
|
* This copies MRC data pointed by gd->arch.mrc_output to a new place on the
|
|
|
|
* stack with length gd->arch.mrc_output_len, and updates gd->arch.mrc_output
|
|
|
|
* to point to the new place once the migration is done.
|
|
|
|
*
|
|
|
|
* This routine should be called by reserve_arch() before U-Boot is relocated
|
|
|
|
* when MRC cache is enabled.
|
|
|
|
*
|
2022-01-19 18:05:50 +01:00
|
|
|
* Return: 0 always
|
2015-10-11 21:37:39 -07:00
|
|
|
*/
|
|
|
|
int mrccache_reserve(void);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* mrccache_get_region() - get MRC region on the SPI flash
|
|
|
|
*
|
|
|
|
* This gets MRC region whose offset and size are described in the device tree
|
2020-05-27 06:58:49 -06:00
|
|
|
* as a subnode to the SPI flash. This tries to find the SPI flash device
|
|
|
|
* (without probing it), falling back to looking for the devicetree node if
|
|
|
|
* driver model is not inited or the SPI flash is not found.
|
2015-10-11 21:37:39 -07:00
|
|
|
*
|
2019-12-06 21:42:07 -07:00
|
|
|
* @type: Type of MRC data to use
|
2020-05-27 06:58:49 -06:00
|
|
|
* @devp: Returns pointer to the SPI flash device, if found
|
2015-10-11 21:37:39 -07:00
|
|
|
* @entry: Position and size of MRC cache in SPI flash
|
2022-01-19 18:05:50 +01:00
|
|
|
* Return: 0 if success, -ENOENT if SPI flash node does not exist in the
|
2015-10-11 21:37:39 -07:00
|
|
|
* device tree, -EPERM if MRC region subnode does not exist in the device
|
|
|
|
* tree, -EINVAL if MRC region properties format is incorrect, other error
|
|
|
|
* if SPI flash probe failed.
|
|
|
|
*/
|
2019-12-06 21:42:07 -07:00
|
|
|
int mrccache_get_region(enum mrc_type_t type, struct udevice **devp,
|
|
|
|
struct mrc_region *entry);
|
2015-10-11 21:37:39 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* mrccache_save() - save MRC data to the SPI flash
|
|
|
|
*
|
|
|
|
* This saves MRC data stored previously by gd->arch.mrc_output to a proper
|
|
|
|
* place within the MRC region on the SPI flash.
|
|
|
|
*
|
2022-01-19 18:05:50 +01:00
|
|
|
* Return: 0 if saved to SPI flash successfully, other error if failed
|
2015-10-11 21:37:39 -07:00
|
|
|
*/
|
|
|
|
int mrccache_save(void);
|
|
|
|
|
2019-04-25 21:58:57 -06:00
|
|
|
/**
|
|
|
|
* mrccache_spl_save() - Save to the MRC region from SPL
|
|
|
|
*
|
|
|
|
* When SPL is used to set up the memory controller we want to save the MRC
|
|
|
|
* data in SPL to avoid needing to pass it up to U-Boot proper to save. This
|
|
|
|
* function handles that.
|
|
|
|
*
|
2022-01-19 18:05:50 +01:00
|
|
|
* Return: 0 if saved to SPI flash successfully, other error if failed
|
2019-04-25 21:58:57 -06:00
|
|
|
*/
|
|
|
|
int mrccache_spl_save(void);
|
|
|
|
|
2015-10-11 21:37:38 -07:00
|
|
|
#endif /* _ASM_MRCCACHE_H */
|