xref: /openbmc/qemu/include/hw/mem/nvdimm.h (revision c734cd40) 
1 /*
2  * Non-Volatile Dual In-line Memory Module Virtualization Implementation
3  *
4  * Copyright(C) 2015 Intel Corporation.
5  *
6  * Author:
7  *  Xiao Guangrong <guangrong.xiao@linux.intel.com>
8  *
9  * NVDIMM specifications and some documents can be found at:
10  * NVDIMM ACPI device and NFIT are introduced in ACPI 6:
11  *      http://www.uefi.org/sites/default/files/resources/ACPI_6.0.pdf
12  * NVDIMM Namespace specification:
13  *      http://pmem.io/documents/NVDIMM_Namespace_Spec.pdf
14  * DSM Interface Example:
15  *      http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf
16  * Driver Writer's Guide:
17  *      http://pmem.io/documents/NVDIMM_Driver_Writers_Guide.pdf
18  *
19  * This work is licensed under the terms of the GNU GPL, version 2 or later.
20  * See the COPYING file in the top-level directory.
21  */
22 
23 #ifndef QEMU_NVDIMM_H
24 #define QEMU_NVDIMM_H
25 
26 #include "hw/mem/pc-dimm.h"
27 #include "hw/acpi/bios-linker-loader.h"
28 #include "qemu/uuid.h"
29 #include "hw/acpi/aml-build.h"
30 #include "qom/object.h"
31 
32 #define NVDIMM_DEBUG 0
33 #define nvdimm_debug(fmt, ...)                                \
34     do {                                                      \
35         if (NVDIMM_DEBUG) {                                   \
36             fprintf(stderr, "nvdimm: " fmt, ## __VA_ARGS__);  \
37         }                                                     \
38     } while (0)
39 
40 /*
41  * The minimum label data size is required by NVDIMM Namespace
42  * specification, see the chapter 2 Namespaces:
43  *   "NVDIMMs following the NVDIMM Block Mode Specification use an area
44  *    at least 128KB in size, which holds around 1000 labels."
45  */
46 #define MIN_NAMESPACE_LABEL_SIZE      (128UL << 10)
47 
48 #define TYPE_NVDIMM      "nvdimm"
49 typedef struct NVDIMMClass NVDIMMClass;
50 typedef struct NVDIMMDevice NVDIMMDevice;
51 DECLARE_OBJ_CHECKERS(NVDIMMDevice, NVDIMMClass,
52                      NVDIMM, TYPE_NVDIMM)
53 
54 #define NVDIMM_LABEL_SIZE_PROP "label-size"
55 #define NVDIMM_UUID_PROP       "uuid"
56 #define NVDIMM_UNARMED_PROP    "unarmed"
57 
58 struct NVDIMMDevice {
59     /* private */
60     PCDIMMDevice parent_obj;
61 
62     /* public */
63 
64     /*
65      * the size of label data in NVDIMM device which is presented to
66      * guest via __DSM "Get Namespace Label Size" function.
67      */
68     uint64_t label_size;
69 
70     /*
71      * the address of label data which is read by __DSM "Get Namespace
72      * Label Data" function and written by __DSM "Set Namespace Label
73      * Data" function.
74      */
75     void *label_data;
76 
77     /*
78      * it's the PMEM region in NVDIMM device, which is presented to
79      * guest via ACPI NFIT and _FIT method if NVDIMM hotplug is supported.
80      */
81     MemoryRegion *nvdimm_mr;
82 
83     /*
84      * The 'on' value results in the unarmed flag set in ACPI NFIT,
85      * which can be used to notify guest implicitly that the host
86      * backend (e.g., files on HDD, /dev/pmemX, etc.) cannot guarantee
87      * the guest write persistence.
88      */
89     bool unarmed;
90 
91     /*
92      * The PPC64 - spapr requires each nvdimm device have a uuid.
93      */
94     QemuUUID uuid;
95 };
96 
97 struct NVDIMMClass {
98     /* private */
99     PCDIMMDeviceClass parent_class;
100 
101     /* public */
102 
103     /* read @size bytes from NVDIMM label data at @offset into @buf. */
104     void (*read_label_data)(NVDIMMDevice *nvdimm, void *buf,
105                             uint64_t size, uint64_t offset);
106     /* write @size bytes from @buf to NVDIMM label data at @offset. */
107     void (*write_label_data)(NVDIMMDevice *nvdimm, const void *buf,
108                              uint64_t size, uint64_t offset);
109 };
110 
111 #define NVDIMM_DSM_MEM_FILE     "etc/acpi/nvdimm-mem"
112 
113 /*
114  * 32 bits IO port starting from 0x0a18 in guest is reserved for
115  * NVDIMM ACPI emulation.
116  */
117 #define NVDIMM_ACPI_IO_BASE     0x0a18
118 #define NVDIMM_ACPI_IO_LEN      4
119 
120 /*
121  * NvdimmFitBuffer:
122  * @fit: FIT structures for present NVDIMMs. It is updated when
123  *   the NVDIMM device is plugged or unplugged.
124  * @dirty: It allows OSPM to detect change and restart read in
125  *   progress if there is any.
126  */
127 struct NvdimmFitBuffer {
128     GArray *fit;
129     bool dirty;
130 };
131 typedef struct NvdimmFitBuffer NvdimmFitBuffer;
132 
133 struct NVDIMMState {
134     /* detect if NVDIMM support is enabled. */
135     bool is_enabled;
136 
137     /* the data of the fw_cfg file NVDIMM_DSM_MEM_FILE. */
138     GArray *dsm_mem;
139 
140     NvdimmFitBuffer fit_buf;
141 
142     /* the IO region used by OSPM to transfer control to QEMU. */
143     MemoryRegion io_mr;
144 
145     /*
146      * Platform capabilities, section 5.2.25.9 of ACPI 6.2 Errata A
147      */
148     int32_t persistence;
149     char    *persistence_string;
150     struct AcpiGenericAddress dsm_io;
151 };
152 typedef struct NVDIMMState NVDIMMState;
153 
154 void nvdimm_init_acpi_state(NVDIMMState *state, MemoryRegion *io,
155                             struct AcpiGenericAddress dsm_io,
156                             FWCfgState *fw_cfg, Object *owner);
157 void nvdimm_build_srat(GArray *table_data);
158 void nvdimm_build_acpi(GArray *table_offsets, GArray *table_data,
159                        BIOSLinker *linker, NVDIMMState *state,
160                        uint32_t ram_slots);
161 void nvdimm_plug(NVDIMMState *state);
162 void nvdimm_acpi_plug_cb(HotplugHandler *hotplug_dev, DeviceState *dev);
163 #endif
164