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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/* $Id: FlashCore.h $ */
/** @file
* A simple Flash device
*
* A simple non-volatile byte-wide (x8) memory device modeled after Intel 28F008
* FlashFile. See 28F008SA datasheet, Intel order number 290429-007.
*
* Implemented as an MMIO device attached directly to the CPU, not behind any
* bus. Typically mapped as part of the firmware image.
*/
/*
* Copyright (C) 2018-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef VBOX_INCLUDED_SRC_EFI_FlashCore_h
#define VBOX_INCLUDED_SRC_EFI_FlashCore_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include <VBox/vmm/pdmdev.h>
#include <VBox/vmm/pdmifs.h>
#include <VBox/log.h>
#include <VBox/err.h>
#include <iprt/assert.h>
#include <iprt/string.h>
#include <iprt/file.h>
#include "VBoxDD.h"
RT_C_DECLS_BEGIN
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
/** The current version of the saved state. */
#define FLASH_SAVED_STATE_VERSION 1
#if 0
/** Enables the ring-0/raw-mode read cache optimization, giving the size in
* uint64_t units. */
#define FLASH_WITH_RZ_READ_CACHE_SIZE 32
#endif
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* The flash device core structure.
*/
typedef struct FLASHCORE
{
/** The current command. */
uint8_t bCmd;
/** The status register. */
uint8_t bStatus;
/** Current bus cycle. */
uint8_t cBusCycle;
/** @name The following state does not change at runtime
* @{ */
/** When set, indicates the state was saved. */
bool fStateSaved;
/** Manufacturer (high byte) and device (low byte) ID. */
uint16_t u16FlashId;
/** The configured block size of the device. */
uint16_t cbBlockSize;
/** The actual flash memory data. */
R3PTRTYPE(uint8_t *) pbFlash;
/** The flash memory region size. */
uint32_t cbFlashSize;
/** @} */
#ifdef FLASH_WITH_RZ_READ_CACHE_SIZE
/** @name Read cache for non-ring-3 code.
* @{ */
/** The cache offset, UINT32_MAX if invalid. */
uint32_t offCache;
# if ARCH_BITS == 32
uint32_t uPadding;
# endif
/** The cache data. */
union
{
uint64_t au64[FLASH_WITH_RZ_READ_CACHE_SIZE];
uint8_t ab[FLASH_WITH_RZ_READ_CACHE_SIZE * 8];
} CacheData;
/** @} */
#endif
} FLASHCORE;
/** Pointer to the Flash device state. */
typedef FLASHCORE *PFLASHCORE;
#ifndef VBOX_DEVICE_STRUCT_TESTCASE
DECLHIDDEN(VBOXSTRICTRC) flashWrite(PFLASHCORE pThis, uint32_t off, const void *pv, size_t cb);
DECLHIDDEN(VBOXSTRICTRC) flashRead(PFLASHCORE pThis, uint32_t off, void *pv, size_t cb);
# ifdef IN_RING3
DECLHIDDEN(int) flashR3Init(PFLASHCORE pThis, PPDMDEVINS pDevIns, uint16_t idFlashDev, uint32_t cbFlash, uint16_t cbBlock);
DECLHIDDEN(void) flashR3Destruct(PFLASHCORE pThis, PPDMDEVINS pDevIns);
DECLHIDDEN(int) flashR3LoadFromFile(PFLASHCORE pThis, PPDMDEVINS pDevIns, const char *pszFilename);
DECLHIDDEN(int) flashR3LoadFromBuf(PFLASHCORE pThis, void const *pvBuf, size_t cbBuf);
DECLHIDDEN(int) flashR3LoadFromVfs(PFLASHCORE pThis, PPDMDEVINS pDevIns, PPDMIVFSCONNECTOR pDrvVfs,
const char *pszNamespace, const char *pszPath);
DECLHIDDEN(int) flashR3SaveToFile(PFLASHCORE pThis, PPDMDEVINS pDevIns, const char *pszFilename);
DECLHIDDEN(int) flashR3SaveToBuf(PFLASHCORE pThis, void *pvBuf, size_t cbBuf);
DECLHIDDEN(int) flashR3SaveToVfs(PFLASHCORE pThis, PPDMDEVINS pDevIns, PPDMIVFSCONNECTOR pDrvVfs,
const char *pszNamespace, const char *pszPath);
DECLHIDDEN(void) flashR3Reset(PFLASHCORE pThis);
DECLHIDDEN(int) flashR3SaveExec(PFLASHCORE pThis, PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
DECLHIDDEN(int) flashR3LoadExec(PFLASHCORE pThis, PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
# endif /* IN_RING3 */
#endif /* VBOX_DEVICE_STRUCT_TESTCASE */
RT_C_DECLS_END
#endif /* !VBOX_INCLUDED_SRC_EFI_FlashCore_h */
|
