arch/x86/include/asm/mrccache.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (C) 2014 Google, Inc
   4  * Copyright (C) 2015 Bin Meng <bmeng.cn@gmail.com>
   5  */
   6
   7 #ifndef _ASM_MRCCACHE_H
   8 #define _ASM_MRCCACHE_H
   9
  10 #define MRC_DATA_ALIGN          0x100
  11 #define MRC_DATA_SIGNATURE      (('M' << 0) | ('R' << 8) | \
  12                                  ('C' << 16) | ('D'<<24))
  13
  14 #define MRC_DATA_HEADER_SIZE    32
  15
  16 struct __packed mrc_data_container {
  17         u32     signature;      /* "MRCD" */
  18         u32     data_size;      /* Size of the 'data' field */
  19         u32     checksum;       /* IP style checksum */
  20         u32     reserved;       /* For header alignment */
  21         u8      data[0];        /* Variable size, platform/run time dependent */
  22 };
  23
  24 struct mrc_region {
  25         u32     base;
  26         u32     offset;
  27         u32     length;
  28 };
  29
  30 /* Types of MRC data */
  31 enum mrc_type_t {
  32         MRC_TYPE_NORMAL,
  33         MRC_TYPE_VAR,
  34
  35         MRC_TYPE_COUNT,
  36 };
  37
  38 struct udevice;
  39
  40 /**
  41  * mrccache_find_current() - find the latest MRC cache record
  42  *
  43  * This searches the MRC cache region looking for the latest record to use
  44  * for setting up SDRAM
  45  *
  46  * @entry:      Position and size of MRC cache in SPI flash
  47  * @return pointer to latest record, or NULL if none
  48  */
  49 struct mrc_data_container *mrccache_find_current(struct mrc_region *entry);
  50
  51 /**
  52  * mrccache_reserve() - reserve MRC data on the stack
  53  *
  54  * This copies MRC data pointed by gd->arch.mrc_output to a new place on the
  55  * stack with length gd->arch.mrc_output_len, and updates gd->arch.mrc_output
  56  * to point to the new place once the migration is done.
  57  *
  58  * This routine should be called by reserve_arch() before U-Boot is relocated
  59  * when MRC cache is enabled.
  60  *
  61  * @return 0 always
  62  */
  63 int mrccache_reserve(void);
  64
  65 /**
  66  * mrccache_get_region() - get MRC region on the SPI flash
  67  *
  68  * This gets MRC region whose offset and size are described in the device tree
  69  * as a subnode to the SPI flash. If a non-NULL device pointer is supplied,
  70  * this also probes the SPI flash device and returns its device pointer for
  71  * the caller to use later.
  72  *
  73  * Be careful when calling this routine with a non-NULL device pointer:
  74  * - driver model initialization must be complete
  75  * - calling in the pre-relocation phase may bring some side effects during
  76  *   the SPI flash device probe (eg: for SPI controllers on a PCI bus, it
  77  *   triggers PCI bus enumeration during which insufficient memory issue
  78  *   might be exposed and it causes subsequent SPI flash probe fails).
  79  *
  80  * @type:       Type of MRC data to use
  81  * @devp:       Returns pointer to the SPI flash device
  82  * @entry:      Position and size of MRC cache in SPI flash
  83  * @return 0 if success, -ENOENT if SPI flash node does not exist in the
  84  * device tree, -EPERM if MRC region subnode does not exist in the device
  85  * tree, -EINVAL if MRC region properties format is incorrect, other error
  86  * if SPI flash probe failed.
  87  */
  88 int mrccache_get_region(enum mrc_type_t type, struct udevice **devp,
  89                         struct mrc_region *entry);
  90
  91 /**
  92  * mrccache_save() - save MRC data to the SPI flash
  93  *
  94  * This saves MRC data stored previously by gd->arch.mrc_output to a proper
  95  * place within the MRC region on the SPI flash.
  96  *
  97  * @return 0 if saved to SPI flash successfully, other error if failed
  98  */
  99 int mrccache_save(void);
 100
 101 /**
 102  * mrccache_spl_save() - Save to the MRC region from SPL
 103  *
 104  * When SPL is used to set up the memory controller we want to save the MRC
 105  * data in SPL to avoid needing to pass it up to U-Boot proper to save. This
 106  * function handles that.
 107  *
 108  * @return 0 if saved to SPI flash successfully, other error if failed
 109  */
 110 int mrccache_spl_save(void);
 111
 112 #endif /* _ASM_MRCCACHE_H */