xref: /qemu/hw/nvram/spapr_nvram.c (revision 763952d08b9c89726151a72f90bca90d0828302d)
1 /*
2  * QEMU sPAPR NVRAM emulation
3  *
4  * Copyright (C) 2012 David Gibson, IBM Corporation.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #include <libfdt.h>
26 
27 #include "sysemu/block-backend.h"
28 #include "sysemu/device_tree.h"
29 #include "hw/sysbus.h"
30 #include "hw/ppc/spapr.h"
31 #include "hw/ppc/spapr_vio.h"
32 
33 typedef struct sPAPRNVRAM {
34     VIOsPAPRDevice sdev;
35     uint32_t size;
36     uint8_t *buf;
37     BlockBackend *blk;
38 } sPAPRNVRAM;
39 
40 #define TYPE_VIO_SPAPR_NVRAM "spapr-nvram"
41 #define VIO_SPAPR_NVRAM(obj) \
42      OBJECT_CHECK(sPAPRNVRAM, (obj), TYPE_VIO_SPAPR_NVRAM)
43 
44 #define MIN_NVRAM_SIZE 8192
45 #define DEFAULT_NVRAM_SIZE 65536
46 #define MAX_NVRAM_SIZE 1048576
47 
48 static void rtas_nvram_fetch(PowerPCCPU *cpu, sPAPREnvironment *spapr,
49                              uint32_t token, uint32_t nargs,
50                              target_ulong args,
51                              uint32_t nret, target_ulong rets)
52 {
53     sPAPRNVRAM *nvram = spapr->nvram;
54     hwaddr offset, buffer, len;
55     int alen;
56     void *membuf;
57 
58     if ((nargs != 3) || (nret != 2)) {
59         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
60         return;
61     }
62 
63     if (!nvram) {
64         rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
65         rtas_st(rets, 1, 0);
66         return;
67     }
68 
69     offset = rtas_ld(args, 0);
70     buffer = rtas_ld(args, 1);
71     len = rtas_ld(args, 2);
72 
73     if (((offset + len) < offset)
74         || ((offset + len) > nvram->size)) {
75         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
76         rtas_st(rets, 1, 0);
77         return;
78     }
79 
80     membuf = cpu_physical_memory_map(buffer, &len, 1);
81     if (nvram->blk) {
82         alen = blk_pread(nvram->blk, offset, membuf, len);
83     } else {
84         assert(nvram->buf);
85 
86         memcpy(membuf, nvram->buf + offset, len);
87         alen = len;
88     }
89     cpu_physical_memory_unmap(membuf, len, 1, len);
90 
91     rtas_st(rets, 0, (alen < len) ? RTAS_OUT_HW_ERROR : RTAS_OUT_SUCCESS);
92     rtas_st(rets, 1, (alen < 0) ? 0 : alen);
93 }
94 
95 static void rtas_nvram_store(PowerPCCPU *cpu, sPAPREnvironment *spapr,
96                              uint32_t token, uint32_t nargs,
97                              target_ulong args,
98                              uint32_t nret, target_ulong rets)
99 {
100     sPAPRNVRAM *nvram = spapr->nvram;
101     hwaddr offset, buffer, len;
102     int alen;
103     void *membuf;
104 
105     if ((nargs != 3) || (nret != 2)) {
106         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
107         return;
108     }
109 
110     if (!nvram) {
111         rtas_st(rets, 0, RTAS_OUT_HW_ERROR);
112         return;
113     }
114 
115     offset = rtas_ld(args, 0);
116     buffer = rtas_ld(args, 1);
117     len = rtas_ld(args, 2);
118 
119     if (((offset + len) < offset)
120         || ((offset + len) > nvram->size)) {
121         rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
122         return;
123     }
124 
125     membuf = cpu_physical_memory_map(buffer, &len, 0);
126     if (nvram->blk) {
127         alen = blk_pwrite(nvram->blk, offset, membuf, len);
128     } else {
129         assert(nvram->buf);
130 
131         memcpy(nvram->buf + offset, membuf, len);
132         alen = len;
133     }
134     cpu_physical_memory_unmap(membuf, len, 0, len);
135 
136     rtas_st(rets, 0, (alen < len) ? RTAS_OUT_HW_ERROR : RTAS_OUT_SUCCESS);
137     rtas_st(rets, 1, (alen < 0) ? 0 : alen);
138 }
139 
140 static int spapr_nvram_init(VIOsPAPRDevice *dev)
141 {
142     sPAPRNVRAM *nvram = VIO_SPAPR_NVRAM(dev);
143 
144     if (nvram->blk) {
145         nvram->size = blk_getlength(nvram->blk);
146     } else {
147         nvram->size = DEFAULT_NVRAM_SIZE;
148         nvram->buf = g_malloc0(nvram->size);
149     }
150 
151     if ((nvram->size < MIN_NVRAM_SIZE) || (nvram->size > MAX_NVRAM_SIZE)) {
152         fprintf(stderr, "spapr-nvram must be between %d and %d bytes in size\n",
153                 MIN_NVRAM_SIZE, MAX_NVRAM_SIZE);
154         return -1;
155     }
156 
157     spapr_rtas_register(RTAS_NVRAM_FETCH, "nvram-fetch", rtas_nvram_fetch);
158     spapr_rtas_register(RTAS_NVRAM_STORE, "nvram-store", rtas_nvram_store);
159 
160     return 0;
161 }
162 
163 static int spapr_nvram_devnode(VIOsPAPRDevice *dev, void *fdt, int node_off)
164 {
165     sPAPRNVRAM *nvram = VIO_SPAPR_NVRAM(dev);
166 
167     return fdt_setprop_cell(fdt, node_off, "#bytes", nvram->size);
168 }
169 
170 static Property spapr_nvram_properties[] = {
171     DEFINE_SPAPR_PROPERTIES(sPAPRNVRAM, sdev),
172     DEFINE_PROP_DRIVE("drive", sPAPRNVRAM, blk),
173     DEFINE_PROP_END_OF_LIST(),
174 };
175 
176 static void spapr_nvram_class_init(ObjectClass *klass, void *data)
177 {
178     DeviceClass *dc = DEVICE_CLASS(klass);
179     VIOsPAPRDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
180 
181     k->init = spapr_nvram_init;
182     k->devnode = spapr_nvram_devnode;
183     k->dt_name = "nvram";
184     k->dt_type = "nvram";
185     k->dt_compatible = "qemu,spapr-nvram";
186     set_bit(DEVICE_CATEGORY_MISC, dc->categories);
187     dc->props = spapr_nvram_properties;
188 }
189 
190 static const TypeInfo spapr_nvram_type_info = {
191     .name          = TYPE_VIO_SPAPR_NVRAM,
192     .parent        = TYPE_VIO_SPAPR_DEVICE,
193     .instance_size = sizeof(sPAPRNVRAM),
194     .class_init    = spapr_nvram_class_init,
195 };
196 
197 static void spapr_nvram_register_types(void)
198 {
199     type_register_static(&spapr_nvram_type_info);
200 }
201 
202 type_init(spapr_nvram_register_types)
203