1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Copyright (C) 2014 Google, Inc
* Copyright (C) 2015 Bin Meng <bmeng.cn@gmail.com>
*/
#ifndef _ASM_MRCCACHE_H
#define _ASM_MRCCACHE_H
#define MRC_DATA_ALIGN 0x100
#define MRC_DATA_SIGNATURE (('M' << 0) | ('R' << 8) | \
('C' << 16) | ('D'<<24))
#define MRC_DATA_HEADER_SIZE 32
struct __packed mrc_data_container {
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 */
};
struct mrc_region {
u32 base;
u32 offset;
u32 length;
};
/* Types of MRC data */
enum mrc_type_t {
MRC_TYPE_NORMAL,
MRC_TYPE_VAR,
MRC_TYPE_COUNT,
};
struct udevice;
/**
* 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
*
* @entry: Position and size of MRC cache in SPI flash
* @return pointer to latest record, or NULL if none
*/
struct mrc_data_container *mrccache_find_current(struct mrc_region *entry);
/**
* mrccache_update() - update the MRC cache with a new record
*
* This writes a new record to the end of the MRC cache region. If the new
* record is the same as the latest record then the write is skipped
*
* @sf: SPI flash to write to
* @entry: Position and size of MRC cache in SPI flash
* @cur: Record to write
* @return 0 if updated, -EEXIST if the record is the same as the latest
* record, -EINVAL if the record is not valid, other error if SPI write failed
*/
int mrccache_update(struct udevice *sf, struct mrc_region *entry,
struct mrc_data_container *cur);
/**
* 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.
*
* @return 0 always
*/
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
* as a subnode to the SPI flash. If a non-NULL device pointer is supplied,
* this also probes the SPI flash device and returns its device pointer for
* the caller to use later.
*
* Be careful when calling this routine with a non-NULL device pointer:
* - driver model initialization must be complete
* - calling in the pre-relocation phase may bring some side effects during
* the SPI flash device probe (eg: for SPI controllers on a PCI bus, it
* triggers PCI bus enumeration during which insufficient memory issue
* might be exposed and it causes subsequent SPI flash probe fails).
*
* @type: Type of MRC data to use
* @devp: Returns pointer to the SPI flash device
* @entry: Position and size of MRC cache in SPI flash
* @return 0 if success, -ENOENT if SPI flash node does not exist in the
* 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.
*/
int mrccache_get_region(enum mrc_type_t type, struct udevice **devp,
struct mrc_region *entry);
/**
* 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.
*
* @return 0 if saved to SPI flash successfully, other error if failed
*/
int mrccache_save(void);
/**
* 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.
*
* @return 0 if saved to SPI flash successfully, other error if failed
*/
int mrccache_spl_save(void);
#endif /* _ASM_MRCCACHE_H */
|
