blob: 796860ce2309f1cc2dfb6d7fa923aac5ccb8f37a [file] [log] [blame]
Peter Stuge33fefca2009-01-26 01:33:02 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2009 Peter Stuge <peter@stuge.se>
Stefan Reinauer8fa64812009-08-12 09:27:45 +00005 * Copyright (C) 2009 coresystems GmbH
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +00006 * Copyright (C) 2010 Carl-Daniel Hailfinger
Rudolf Marek03ae5c12010-03-16 23:59:19 +00007 * Copyright (C) 2010 Rudolf Marek <r.marek@assembler.cz>
Peter Stuge33fefca2009-01-26 01:33:02 +00008 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; version 2 of the License.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
Peter Stuge33fefca2009-01-26 01:33:02 +000017 */
Uwe Hermann7b2969b2009-04-15 10:52:49 +000018
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000019#include <unistd.h>
Stefan Tauner7fb5aa02013-08-14 15:48:44 +000020#include <stdbool.h>
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +000021#include <stdio.h>
Stefan Reinauer0593f212009-01-26 01:10:48 +000022#include <stdlib.h>
Stefan Reinauer8fa64812009-08-12 09:27:45 +000023#include <string.h>
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +000024#include <errno.h>
Stefan Reinauer0593f212009-01-26 01:10:48 +000025#include "flash.h"
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +000026#include "programmer.h"
Patrick Georgi32508eb2012-07-20 20:35:14 +000027#include "hwaccess.h"
Stefan Reinauer0593f212009-01-26 01:10:48 +000028
Patrick Georgia9095a92010-09-30 17:03:32 +000029#if !defined(__DJGPP__) && !defined(__LIBPAYLOAD__)
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +000030/* No file access needed/possible to get mmap access permissions or access MSR. */
Carl-Daniel Hailfingerdcef67e2010-06-21 23:20:15 +000031#include <sys/stat.h>
32#include <fcntl.h>
Carl-Daniel Hailfingerdcef67e2010-06-21 23:20:15 +000033#endif
34
Rudolf Marek03ae5c12010-03-16 23:59:19 +000035#ifdef __DJGPP__
36#include <dpmi.h>
Rudolf Marek25fde402017-12-29 16:30:49 +010037#include <malloc.h>
Rudolf Marek837d8102010-04-25 22:47:50 +000038#include <sys/nearptr.h>
Rudolf Marek03ae5c12010-03-16 23:59:19 +000039
Rudolf Marek25fde402017-12-29 16:30:49 +010040#define ONE_MEGABYTE (1024 * 1024)
Rudolf Marek03ae5c12010-03-16 23:59:19 +000041#define MEM_DEV "dpmi"
42
Rudolf Marek25fde402017-12-29 16:30:49 +010043static void *realmem_map_aligned;
Rudolf Marek837d8102010-04-25 22:47:50 +000044
Stefan Tauner305e0b92013-07-17 23:46:44 +000045static void *map_first_meg(uintptr_t phys_addr, size_t len)
Rudolf Marek837d8102010-04-25 22:47:50 +000046{
Rudolf Marek25fde402017-12-29 16:30:49 +010047 void *realmem_map;
48 size_t pagesize;
Rudolf Marek837d8102010-04-25 22:47:50 +000049
Rudolf Marek25fde402017-12-29 16:30:49 +010050 if (realmem_map_aligned)
51 return realmem_map_aligned + phys_addr;
52
53 /* valloc() from DJGPP 2.05 does not work properly */
54 pagesize = getpagesize();
55
56 realmem_map = malloc(ONE_MEGABYTE + pagesize);
Rudolf Marek837d8102010-04-25 22:47:50 +000057
Uwe Hermann91f4afa2011-07-28 08:13:25 +000058 if (!realmem_map)
Patrick Georgied7a9642010-09-25 22:53:44 +000059 return ERROR_PTR;
Rudolf Marek837d8102010-04-25 22:47:50 +000060
Rudolf Marek25fde402017-12-29 16:30:49 +010061 realmem_map_aligned = (void *)(((size_t) realmem_map +
62 (pagesize - 1)) & ~(pagesize - 1));
63
64 if (__djgpp_map_physical_memory(realmem_map_aligned, ONE_MEGABYTE, 0)) {
Carl-Daniel Hailfinger602de982010-10-05 23:21:51 +000065 free(realmem_map);
Rudolf Marek25fde402017-12-29 16:30:49 +010066 realmem_map_aligned = NULL;
Patrick Georgied7a9642010-09-25 22:53:44 +000067 return ERROR_PTR;
Rudolf Marek837d8102010-04-25 22:47:50 +000068 }
69
Rudolf Marek25fde402017-12-29 16:30:49 +010070 return realmem_map_aligned + phys_addr;
Rudolf Marek837d8102010-04-25 22:47:50 +000071}
Rudolf Marek03ae5c12010-03-16 23:59:19 +000072
Stefan Tauner305e0b92013-07-17 23:46:44 +000073static void *sys_physmap(uintptr_t phys_addr, size_t len)
Rudolf Marek03ae5c12010-03-16 23:59:19 +000074{
75 int ret;
76 __dpmi_meminfo mi;
77
Uwe Hermann91f4afa2011-07-28 08:13:25 +000078 /* Enable 4GB limit on DS descriptor. */
79 if (!__djgpp_nearptr_enable())
Patrick Georgied7a9642010-09-25 22:53:44 +000080 return ERROR_PTR;
Rudolf Marek837d8102010-04-25 22:47:50 +000081
Rudolf Marek25fde402017-12-29 16:30:49 +010082 if ((phys_addr + len - 1) < ONE_MEGABYTE) {
Uwe Hermann91f4afa2011-07-28 08:13:25 +000083 /* We need to use another method to map first 1MB. */
Rudolf Marek837d8102010-04-25 22:47:50 +000084 return map_first_meg(phys_addr, len);
Rudolf Marek03ae5c12010-03-16 23:59:19 +000085 }
86
87 mi.address = phys_addr;
88 mi.size = len;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +000089 ret = __dpmi_physical_address_mapping(&mi);
Rudolf Marek03ae5c12010-03-16 23:59:19 +000090
Uwe Hermann91f4afa2011-07-28 08:13:25 +000091 if (ret != 0)
Patrick Georgied7a9642010-09-25 22:53:44 +000092 return ERROR_PTR;
Rudolf Marek03ae5c12010-03-16 23:59:19 +000093
Rudolf Marek837d8102010-04-25 22:47:50 +000094 return (void *) mi.address + __djgpp_conventional_base;
Rudolf Marek03ae5c12010-03-16 23:59:19 +000095}
96
97#define sys_physmap_rw_uncached sys_physmap
Rudolf Marek837d8102010-04-25 22:47:50 +000098#define sys_physmap_ro_cached sys_physmap
Rudolf Marek03ae5c12010-03-16 23:59:19 +000099
Jacob Garberbeeb8bc2019-06-21 15:24:17 -0600100static void sys_physunmap_unaligned(void *virt_addr, size_t len)
Rudolf Marek03ae5c12010-03-16 23:59:19 +0000101{
102 __dpmi_meminfo mi;
103
Carl-Daniel Hailfinger602de982010-10-05 23:21:51 +0000104 /* There is no known way to unmap the first 1 MB. The DPMI server will
105 * do this for us on exit.
106 */
Rudolf Marek25fde402017-12-29 16:30:49 +0100107 if ((virt_addr >= realmem_map_aligned) &&
108 ((virt_addr + len) <= (realmem_map_aligned + ONE_MEGABYTE))) {
Rudolf Marek03ae5c12010-03-16 23:59:19 +0000109 return;
110 }
111
112 mi.address = (unsigned long) virt_addr;
113 __dpmi_free_physical_address_mapping(&mi);
114}
115
Patrick Georgia9095a92010-09-30 17:03:32 +0000116#elif defined(__LIBPAYLOAD__)
117#include <arch/virtual.h>
118
119#define MEM_DEV ""
120
Stefan Tauner305e0b92013-07-17 23:46:44 +0000121void *sys_physmap(uintptr_t phys_addr, size_t len)
Patrick Georgia9095a92010-09-30 17:03:32 +0000122{
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000123 return (void *)phys_to_virt(phys_addr);
Patrick Georgia9095a92010-09-30 17:03:32 +0000124}
125
126#define sys_physmap_rw_uncached sys_physmap
127#define sys_physmap_ro_cached sys_physmap
128
Jacob Garberbeeb8bc2019-06-21 15:24:17 -0600129static void sys_physunmap_unaligned(void *virt_addr, size_t len)
Patrick Georgia9095a92010-09-30 17:03:32 +0000130{
131}
Carl-Daniel Hailfinger60d9bd22012-08-09 23:34:41 +0000132#elif defined(__MACH__) && defined(__APPLE__)
Rudolf Marek03ae5c12010-03-16 23:59:19 +0000133
Stefan Reinauer83704c52011-03-18 22:00:15 +0000134#define MEM_DEV "DirectHW"
Stefan Reinauerf79edb92009-01-26 01:23:31 +0000135
Stefan Tauner305e0b92013-07-17 23:46:44 +0000136static void *sys_physmap(uintptr_t phys_addr, size_t len)
Stefan Reinauerf79edb92009-01-26 01:23:31 +0000137{
Patrick Georgied7a9642010-09-25 22:53:44 +0000138 /* The short form of ?: is a GNU extension.
139 * FIXME: map_physical returns NULL both for errors and for success
140 * if the region is mapped at virtual address zero. If in doubt, report
141 * an error until a better interface exists.
142 */
143 return map_physical(phys_addr, len) ? : ERROR_PTR;
Stefan Reinauerf79edb92009-01-26 01:23:31 +0000144}
145
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000146/* The OS X driver does not differentiate between mapping types. */
147#define sys_physmap_rw_uncached sys_physmap
148#define sys_physmap_ro_cached sys_physmap
149
Jacob Garberbeeb8bc2019-06-21 15:24:17 -0600150static void sys_physunmap_unaligned(void *virt_addr, size_t len)
Stefan Reinauerf79edb92009-01-26 01:23:31 +0000151{
152 unmap_physical(virt_addr, len);
153}
154
155#else
156#include <sys/mman.h>
157
Stefan Reinauer0593f212009-01-26 01:10:48 +0000158#if defined (__sun) && (defined(__i386) || defined(__amd64))
159# define MEM_DEV "/dev/xsvc"
160#else
161# define MEM_DEV "/dev/mem"
162#endif
163
164static int fd_mem = -1;
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000165static int fd_mem_cached = -1;
Stefan Reinauer0593f212009-01-26 01:10:48 +0000166
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000167/* For MMIO access. Must be uncached, doesn't make sense to restrict to ro. */
Stefan Tauner305e0b92013-07-17 23:46:44 +0000168static void *sys_physmap_rw_uncached(uintptr_t phys_addr, size_t len)
Stefan Reinauer0593f212009-01-26 01:10:48 +0000169{
170 void *virt_addr;
171
172 if (-1 == fd_mem) {
173 /* Open the memory device UNCACHED. Important for MMIO. */
Uwe Hermann7b2969b2009-04-15 10:52:49 +0000174 if (-1 == (fd_mem = open(MEM_DEV, O_RDWR | O_SYNC))) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000175 msg_perr("Critical error: open(" MEM_DEV "): %s\n", strerror(errno));
Niklas Söderlund2d8b7ef2013-09-13 19:19:25 +0000176 return ERROR_PTR;
Stefan Reinauer0593f212009-01-26 01:10:48 +0000177 }
178 }
179
Niklas Söderlund2d8b7ef2013-09-13 19:19:25 +0000180 virt_addr = mmap(NULL, len, PROT_WRITE | PROT_READ, MAP_SHARED, fd_mem, (off_t)phys_addr);
Patrick Georgied7a9642010-09-25 22:53:44 +0000181 return MAP_FAILED == virt_addr ? ERROR_PTR : virt_addr;
Stefan Reinauer0593f212009-01-26 01:10:48 +0000182}
183
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000184/* For reading DMI/coreboot/whatever tables. We should never write, and we
185 * do not care about caching.
186 */
Stefan Tauner305e0b92013-07-17 23:46:44 +0000187static void *sys_physmap_ro_cached(uintptr_t phys_addr, size_t len)
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000188{
189 void *virt_addr;
190
191 if (-1 == fd_mem_cached) {
192 /* Open the memory device CACHED. */
193 if (-1 == (fd_mem_cached = open(MEM_DEV, O_RDWR))) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000194 msg_perr("Critical error: open(" MEM_DEV "): %s\n", strerror(errno));
Niklas Söderlund2d8b7ef2013-09-13 19:19:25 +0000195 return ERROR_PTR;
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000196 }
197 }
198
Niklas Söderlund2d8b7ef2013-09-13 19:19:25 +0000199 virt_addr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd_mem_cached, (off_t)phys_addr);
Patrick Georgied7a9642010-09-25 22:53:44 +0000200 return MAP_FAILED == virt_addr ? ERROR_PTR : virt_addr;
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000201}
202
Jacob Garberbeeb8bc2019-06-21 15:24:17 -0600203static void sys_physunmap_unaligned(void *virt_addr, size_t len)
Stefan Reinauer0593f212009-01-26 01:10:48 +0000204{
205 munmap(virt_addr, len);
206}
Stefan Reinauerf79edb92009-01-26 01:23:31 +0000207#endif
Stefan Reinauer0593f212009-01-26 01:10:48 +0000208
Stefan Tauner3285d7f2013-08-14 16:28:19 +0000209#define PHYSM_RW 0
210#define PHYSM_RO 1
211#define PHYSM_NOCLEANUP 0
212#define PHYSM_CLEANUP 1
213#define PHYSM_EXACT 0
214#define PHYSM_ROUND 1
215
216/* Round start to nearest page boundary below and set len so that the resulting address range ends at the lowest
217 * possible page boundary where the original address range is still entirely contained. It returns the
218 * difference between the rounded start address and the original start address. */
219static uintptr_t round_to_page_boundaries(uintptr_t *start, size_t *len)
220{
221 uintptr_t page_size = getpagesize();
222 uintptr_t page_mask = ~(page_size-1);
223 uintptr_t end = *start + *len;
224 uintptr_t old_start = *start;
225 msg_gspew("page_size=%" PRIxPTR "\n", page_size);
226 msg_gspew("pre-rounding: start=0x%0*" PRIxPTR ", len=0x%zx, end=0x%0*" PRIxPTR "\n",
227 PRIxPTR_WIDTH, *start, *len, PRIxPTR_WIDTH, end);
228 *start = *start & page_mask;
229 end = (end + page_size - 1) & page_mask;
230 *len = end - *start;
231 msg_gspew("post-rounding: start=0x%0*" PRIxPTR ", len=0x%zx, end=0x%0*" PRIxPTR "\n",
232 PRIxPTR_WIDTH, *start, *len, PRIxPTR_WIDTH, *start + *len);
233 return old_start - *start;
234}
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000235
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000236struct undo_physmap_data {
237 void *virt_addr;
238 size_t len;
239};
240
241static int undo_physmap(void *data)
242{
243 if (data == NULL) {
244 msg_perr("%s: tried to physunmap without valid data!\n", __func__);
245 return 1;
246 }
247 struct undo_physmap_data *d = data;
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000248 physunmap_unaligned(d->virt_addr, d->len);
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000249 free(data);
250 return 0;
251}
252
Niklas Söderlund5d307202013-09-14 09:02:27 +0000253static void *physmap_common(const char *descr, uintptr_t phys_addr, size_t len, bool readonly, bool autocleanup,
254 bool round)
Stefan Reinauer0593f212009-01-26 01:10:48 +0000255{
Stephan Guilloux6d08a3e2009-06-23 10:44:36 +0000256 void *virt_addr;
Stefan Tauner3285d7f2013-08-14 16:28:19 +0000257 uintptr_t offset = 0;
Stephan Guilloux6d08a3e2009-06-23 10:44:36 +0000258
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +0000259 if (len == 0) {
Stefan Tauner305e0b92013-07-17 23:46:44 +0000260 msg_pspew("Not mapping %s, zero size at 0x%0*" PRIxPTR ".\n", descr, PRIxPTR_WIDTH, phys_addr);
Patrick Georgied7a9642010-09-25 22:53:44 +0000261 return ERROR_PTR;
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +0000262 }
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000263
Stefan Tauner3285d7f2013-08-14 16:28:19 +0000264 if (round)
265 offset = round_to_page_boundaries(&phys_addr, &len);
Carl-Daniel Hailfinger1455b2b2009-05-11 14:13:25 +0000266
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000267 if (readonly)
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000268 virt_addr = sys_physmap_ro_cached(phys_addr, len);
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000269 else
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000270 virt_addr = sys_physmap_rw_uncached(phys_addr, len);
Stefan Reinauer0593f212009-01-26 01:10:48 +0000271
Patrick Georgied7a9642010-09-25 22:53:44 +0000272 if (ERROR_PTR == virt_addr) {
Stefan Reinauer0593f212009-01-26 01:10:48 +0000273 if (NULL == descr)
274 descr = "memory";
Stefan Tauner0554ca52013-07-25 22:54:25 +0000275 msg_perr("Error accessing %s, 0x%zx bytes at 0x%0*" PRIxPTR "\n",
276 descr, len, PRIxPTR_WIDTH, phys_addr);
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000277 msg_perr(MEM_DEV " mmap failed: %s\n", strerror(errno));
Sean Nelson316a29f2010-05-07 20:09:04 +0000278#ifdef __linux__
Stefan Reinauer0593f212009-01-26 01:10:48 +0000279 if (EINVAL == errno) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000280 msg_perr("In Linux this error can be caused by the CONFIG_NONPROMISC_DEVMEM (<2.6.27),\n");
281 msg_perr("CONFIG_STRICT_DEVMEM (>=2.6.27) and CONFIG_X86_PAT kernel options.\n");
282 msg_perr("Please check if either is enabled in your kernel before reporting a failure.\n");
283 msg_perr("You can override CONFIG_X86_PAT at boot with the nopat kernel parameter but\n");
284 msg_perr("disabling the other option unfortunately requires a kernel recompile. Sorry!\n");
Stefan Reinauer0593f212009-01-26 01:10:48 +0000285 }
Carl-Daniel Hailfingerb63b0672010-07-02 17:12:50 +0000286#elif defined (__OpenBSD__)
287 msg_perr("Please set securelevel=-1 in /etc/rc.securelevel "
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000288 "and reboot, or reboot into\n"
289 "single user mode.\n");
Sean Nelson316a29f2010-05-07 20:09:04 +0000290#endif
Niklas Söderlund5d307202013-09-14 09:02:27 +0000291 return ERROR_PTR;
Stefan Reinauer0593f212009-01-26 01:10:48 +0000292 }
293
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000294 if (autocleanup) {
Angel Pons3bd47522021-06-07 12:33:53 +0200295 struct undo_physmap_data *d = malloc(sizeof(*d));
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000296 if (d == NULL) {
297 msg_perr("%s: Out of memory!\n", __func__);
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000298 physunmap_unaligned(virt_addr, len);
Niklas Söderlund5d307202013-09-14 09:02:27 +0000299 return ERROR_PTR;
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000300 }
301
302 d->virt_addr = virt_addr;
303 d->len = len;
304 if (register_shutdown(undo_physmap, d) != 0) {
305 msg_perr("%s: Could not register shutdown function!\n", __func__);
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000306 physunmap_unaligned(virt_addr, len);
Niklas Söderlund5d307202013-09-14 09:02:27 +0000307 return ERROR_PTR;
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000308 }
309 }
310
Stefan Tauner3285d7f2013-08-14 16:28:19 +0000311 return virt_addr + offset;
Stefan Reinauer0593f212009-01-26 01:10:48 +0000312}
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000313
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000314void physunmap_unaligned(void *virt_addr, size_t len)
315{
316 /* No need to check for zero size, such mappings would have yielded ERROR_PTR. */
317 if (virt_addr == ERROR_PTR) {
318 msg_perr("Trying to unmap a nonexisting mapping!\n"
319 "Please report a bug at flashrom@flashrom.org\n");
320 return;
321 }
322
323 sys_physunmap_unaligned(virt_addr, len);
324}
325
326void physunmap(void *virt_addr, size_t len)
327{
328 uintptr_t tmp;
329
330 /* No need to check for zero size, such mappings would have yielded ERROR_PTR. */
331 if (virt_addr == ERROR_PTR) {
332 msg_perr("Trying to unmap a nonexisting mapping!\n"
333 "Please report a bug at flashrom@flashrom.org\n");
334 return;
335 }
336 tmp = (uintptr_t)virt_addr;
337 /* We assume that the virtual address of a page-aligned physical address is page-aligned as well. By
338 * extension, rounding a virtual unaligned address as returned by physmap should yield the same offset
339 * between rounded and original virtual address as between rounded and original physical address.
340 */
341 round_to_page_boundaries(&tmp, &len);
342 virt_addr = (void *)tmp;
343 physunmap_unaligned(virt_addr, len);
344}
345
Stefan Tauner305e0b92013-07-17 23:46:44 +0000346void *physmap(const char *descr, uintptr_t phys_addr, size_t len)
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000347{
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000348 return physmap_common(descr, phys_addr, len, PHYSM_RW, PHYSM_NOCLEANUP, PHYSM_ROUND);
Stefan Tauner7fb5aa02013-08-14 15:48:44 +0000349}
350
351void *rphysmap(const char *descr, uintptr_t phys_addr, size_t len)
352{
Niklas Söderlund5d307202013-09-14 09:02:27 +0000353 return physmap_common(descr, phys_addr, len, PHYSM_RW, PHYSM_CLEANUP, PHYSM_ROUND);
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000354}
355
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000356void *physmap_ro(const char *descr, uintptr_t phys_addr, size_t len)
Sean Nelson4c6d3a42013-09-11 23:35:03 +0000357{
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000358 return physmap_common(descr, phys_addr, len, PHYSM_RO, PHYSM_NOCLEANUP, PHYSM_ROUND);
Sean Nelson4c6d3a42013-09-11 23:35:03 +0000359}
360
Carl-Daniel Hailfinger43eac032014-03-05 00:16:16 +0000361void *physmap_ro_unaligned(const char *descr, uintptr_t phys_addr, size_t len)
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000362{
Niklas Söderlund5d307202013-09-14 09:02:27 +0000363 return physmap_common(descr, phys_addr, len, PHYSM_RO, PHYSM_NOCLEANUP, PHYSM_EXACT);
Carl-Daniel Hailfingerbaaffe02010-02-02 11:09:03 +0000364}
365
Jonathan Liu7f15de12019-10-06 16:22:04 +1100366#if CONFIG_INTERNAL == 1
Stefan Tauner6bf5fe72013-07-13 21:18:32 +0000367/* MSR abstraction implementations for Linux, OpenBSD, FreeBSD/Dragonfly, OSX, libpayload
Elyes HAOUASe2c90c42018-08-18 09:04:41 +0200368 * and a non-working default implementation on the bottom. See also hwaccess.h for some (re)declarations. */
Carl-Daniel Hailfingercceafa22010-05-26 01:45:41 +0000369#if defined(__i386__) || defined(__x86_64__)
370
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000371#ifdef __linux__
372/*
373 * Reading and writing to MSRs, however requires instructions rdmsr/wrmsr,
374 * which are ring0 privileged instructions so only the kernel can do the
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000375 * read/write. This function, therefore, requires that the msr kernel module
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000376 * be loaded to access these instructions from user space using device
377 * /dev/cpu/0/msr.
378 */
379
380static int fd_msr = -1;
381
382msr_t rdmsr(int addr)
383{
Stefan Reinauer95e892b2009-09-04 13:57:07 +0000384 uint32_t buf[2];
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000385 msr_t msr = { 0xffffffff, 0xffffffff };
386
387 if (lseek(fd_msr, (off_t) addr, SEEK_SET) == -1) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000388 msg_perr("Could not lseek() MSR: %s\n", strerror(errno));
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000389 close(fd_msr);
390 exit(1);
391 }
392
393 if (read(fd_msr, buf, 8) == 8) {
Stefan Reinauer95e892b2009-09-04 13:57:07 +0000394 msr.lo = buf[0];
395 msr.hi = buf[1];
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000396 return msr;
397 }
398
399 if (errno != EIO) {
400 // A severe error.
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000401 msg_perr("Could not read() MSR: %s\n", strerror(errno));
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000402 close(fd_msr);
403 exit(1);
404 }
405
406 return msr;
407}
408
409int wrmsr(int addr, msr_t msr)
410{
Anti Sullinbe24d812010-05-17 23:19:22 +0000411 uint32_t buf[2];
412 buf[0] = msr.lo;
413 buf[1] = msr.hi;
414
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000415 if (lseek(fd_msr, (off_t) addr, SEEK_SET) == -1) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000416 msg_perr("Could not lseek() MSR: %s\n", strerror(errno));
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000417 close(fd_msr);
418 exit(1);
419 }
420
Anti Sullinbe24d812010-05-17 23:19:22 +0000421 if (write(fd_msr, buf, 8) != 8 && errno != EIO) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000422 msg_perr("Could not write() MSR: %s\n", strerror(errno));
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000423 close(fd_msr);
424 exit(1);
425 }
426
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000427 /* Some MSRs must not be written. */
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000428 if (errno == EIO)
429 return -1;
430
431 return 0;
432}
433
434int setup_cpu_msr(int cpu)
435{
Angel Ponsf41d2482021-06-07 13:29:13 +0200436 char msrfilename[64] = { 0 };
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +0000437 snprintf(msrfilename, sizeof(msrfilename), "/dev/cpu/%d/msr", cpu);
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000438
439 if (fd_msr != -1) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000440 msg_pinfo("MSR was already initialized\n");
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000441 return -1;
442 }
443
444 fd_msr = open(msrfilename, O_RDWR);
445
446 if (fd_msr < 0) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000447 msg_perr("Error while opening %s: %s\n", msrfilename, strerror(errno));
Sean Nelson316a29f2010-05-07 20:09:04 +0000448 msg_pinfo("Did you run 'modprobe msr'?\n");
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000449 return -1;
450 }
451
452 return 0;
453}
454
455void cleanup_cpu_msr(void)
456{
457 if (fd_msr == -1) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000458 msg_pinfo("No MSR initialized.\n");
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000459 return;
460 }
461
462 close(fd_msr);
463
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000464 /* Clear MSR file descriptor. */
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000465 fd_msr = -1;
466}
Stefan Taunere5dcc152016-02-07 03:35:04 +0000467#elif defined(__OpenBSD__) && defined (__i386__) /* This does only work for certain AMD Geode LX systems see amdmsr(4). */
Stefan Tauner6bf5fe72013-07-13 21:18:32 +0000468#include <sys/ioctl.h>
469#include <machine/amdmsr.h>
470
471static int fd_msr = -1;
472
473msr_t rdmsr(int addr)
474{
475 struct amdmsr_req args;
476
477 msr_t msr = { 0xffffffff, 0xffffffff };
478
479 args.addr = (uint32_t)addr;
480
481 if (ioctl(fd_msr, RDMSR, &args) < 0) {
482 msg_perr("Error while executing RDMSR ioctl: %s\n", strerror(errno));
483 close(fd_msr);
484 exit(1);
485 }
486
487 msr.lo = args.val & 0xffffffff;
488 msr.hi = args.val >> 32;
489
490 return msr;
491}
492
493int wrmsr(int addr, msr_t msr)
494{
495 struct amdmsr_req args;
496
497 args.addr = addr;
498 args.val = (((uint64_t)msr.hi) << 32) | msr.lo;
499
500 if (ioctl(fd_msr, WRMSR, &args) < 0) {
501 msg_perr("Error while executing WRMSR ioctl: %s\n", strerror(errno));
502 close(fd_msr);
503 exit(1);
504 }
505
506 return 0;
507}
508
509int setup_cpu_msr(int cpu)
510{
Angel Ponsf41d2482021-06-07 13:29:13 +0200511 char msrfilename[64] = { 0 };
Stefan Tauner6bf5fe72013-07-13 21:18:32 +0000512 snprintf(msrfilename, sizeof(msrfilename), "/dev/amdmsr");
513
514 if (fd_msr != -1) {
515 msg_pinfo("MSR was already initialized\n");
516 return -1;
517 }
518
519 fd_msr = open(msrfilename, O_RDWR);
520
521 if (fd_msr < 0) {
522 msg_perr("Error while opening %s: %s\n", msrfilename, strerror(errno));
523 return -1;
524 }
525
526 return 0;
527}
528
529void cleanup_cpu_msr(void)
530{
531 if (fd_msr == -1) {
532 msg_pinfo("No MSR initialized.\n");
533 return;
534 }
535
536 close(fd_msr);
537
538 /* Clear MSR file descriptor. */
539 fd_msr = -1;
540}
541
542#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000543#include <sys/ioctl.h>
544
545typedef struct {
546 int msr;
547 uint64_t data;
548} cpu_msr_args_t;
549#define CPU_RDMSR _IOWR('c', 1, cpu_msr_args_t)
550#define CPU_WRMSR _IOWR('c', 2, cpu_msr_args_t)
551
552static int fd_msr = -1;
553
554msr_t rdmsr(int addr)
555{
556 cpu_msr_args_t args;
557
558 msr_t msr = { 0xffffffff, 0xffffffff };
559
560 args.msr = addr;
561
562 if (ioctl(fd_msr, CPU_RDMSR, &args) < 0) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000563 msg_perr("Error while executing CPU_RDMSR ioctl: %s\n", strerror(errno));
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000564 close(fd_msr);
565 exit(1);
566 }
567
568 msr.lo = args.data & 0xffffffff;
569 msr.hi = args.data >> 32;
570
571 return msr;
572}
573
574int wrmsr(int addr, msr_t msr)
575{
576 cpu_msr_args_t args;
577
578 args.msr = addr;
579 args.data = (((uint64_t)msr.hi) << 32) | msr.lo;
580
581 if (ioctl(fd_msr, CPU_WRMSR, &args) < 0) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000582 msg_perr("Error while executing CPU_WRMSR ioctl: %s\n", strerror(errno));
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000583 close(fd_msr);
584 exit(1);
585 }
586
587 return 0;
588}
589
590int setup_cpu_msr(int cpu)
591{
Angel Ponsf41d2482021-06-07 13:29:13 +0200592 char msrfilename[64] = { 0 };
Carl-Daniel Hailfinger831e8f42010-05-30 22:24:40 +0000593 snprintf(msrfilename, sizeof(msrfilename), "/dev/cpu%d", cpu);
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000594
595 if (fd_msr != -1) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000596 msg_pinfo("MSR was already initialized\n");
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000597 return -1;
598 }
599
600 fd_msr = open(msrfilename, O_RDWR);
601
602 if (fd_msr < 0) {
Stefan Tauner363fd7e2013-04-07 13:08:30 +0000603 msg_perr("Error while opening %s: %s\n", msrfilename, strerror(errno));
Sean Nelson316a29f2010-05-07 20:09:04 +0000604 msg_pinfo("Did you install ports/sysutils/devcpu?\n");
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000605 return -1;
606 }
607
608 return 0;
609}
610
611void cleanup_cpu_msr(void)
612{
613 if (fd_msr == -1) {
Sean Nelson316a29f2010-05-07 20:09:04 +0000614 msg_pinfo("No MSR initialized.\n");
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000615 return;
616 }
617
618 close(fd_msr);
619
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000620 /* Clear MSR file descriptor. */
Stefan Reinauer173e3ea2009-08-19 10:46:23 +0000621 fd_msr = -1;
622}
623
Stefan Tauner6bf5fe72013-07-13 21:18:32 +0000624#elif defined(__MACH__) && defined(__APPLE__)
625/* rdmsr() and wrmsr() are provided by DirectHW which needs neither setup nor cleanup. */
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000626int setup_cpu_msr(int cpu)
627{
628 // Always succeed for now
629 return 0;
630}
631
632void cleanup_cpu_msr(void)
633{
634 // Nothing, yet.
635}
Patrick Georgia9095a92010-09-30 17:03:32 +0000636#elif defined(__LIBPAYLOAD__)
637msr_t libpayload_rdmsr(int addr)
638{
639 msr_t msr;
640 unsigned long long val = _rdmsr(addr);
641 msr.lo = val & 0xffffffff;
642 msr.hi = val >> 32;
643 return msr;
644}
645
646int libpayload_wrmsr(int addr, msr_t msr)
647{
648 _wrmsr(addr, msr.lo | ((unsigned long long)msr.hi << 32));
Patrick Georgi97bc95c2011-03-08 07:17:44 +0000649 return 0;
Patrick Georgia9095a92010-09-30 17:03:32 +0000650}
Carl-Daniel Hailfinger11990da2013-07-13 23:21:05 +0000651
652int setup_cpu_msr(int cpu)
653{
654 return 0;
655}
656
657void cleanup_cpu_msr(void)
658{
659}
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000660#else
Stefan Tauner6bf5fe72013-07-13 21:18:32 +0000661/* default MSR implementation */
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000662msr_t rdmsr(int addr)
663{
664 msr_t ret = { 0xffffffff, 0xffffffff };
665
666 return ret;
667}
668
669int wrmsr(int addr, msr_t msr)
670{
671 return -1;
672}
673
674int setup_cpu_msr(int cpu)
675{
Sean Nelson316a29f2010-05-07 20:09:04 +0000676 msg_pinfo("No MSR support for your OS yet.\n");
Stefan Reinauer8fa64812009-08-12 09:27:45 +0000677 return -1;
678}
679
680void cleanup_cpu_msr(void)
681{
682 // Nothing, yet.
683}
Stefan Tauner6bf5fe72013-07-13 21:18:32 +0000684#endif // OS switches for MSR code
685#else // x86
Carl-Daniel Hailfingercceafa22010-05-26 01:45:41 +0000686/* Does MSR exist on non-x86 architectures? */
Stefan Tauner6bf5fe72013-07-13 21:18:32 +0000687#endif // arch switches for MSR code
Jonathan Liu7f15de12019-10-06 16:22:04 +1100688#endif // CONFIG_INTERNAL == 1