flashrom 

flashrom Svn Source Tree

Root/trunk/hwaccess.h

1/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2009 Carl-Daniel Hailfinger
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20/*
21 * Header file for hardware access and OS abstraction. Included from flash.h.
22 */
23
24#ifndef __HWACCESS_H__
25#define __HWACCESS_H__ 1
26
27#include "platform.h"
28
29#if NEED_PCI == 1
30/*
31 * libpci headers use the variable name "index" which triggers shadowing
32 * warnings on systems which have the index() function in a default #include
33 * or as builtin.
34 */
35#define index shadow_workaround_index
36
37#if !defined (__NetBSD__)
38#include <pci/pci.h>
39#else
40#include <pciutils/pci.h>
41#endif
42
43#undef index
44#endif /* NEED_PCI == 1 */
45
46
47/* The next big hunk tries to guess endianess from various preprocessor macros */
48/* First some error checking in case some weird header has defined both.
49 * NB: OpenBSD always defines _BIG_ENDIAN and _LITTLE_ENDIAN. */
50#if defined (__LITTLE_ENDIAN__) && defined (__BIG_ENDIAN__)
51#error Conflicting endianness #define
52#endif
53
54#if IS_X86
55
56/* All x86 is little-endian. */
57#define __FLASHROM_LITTLE_ENDIAN__ 1
58
59#elif IS_MIPS
60
61/* MIPS can be either endian. */
62#if defined (__MIPSEL) || defined (__MIPSEL__) || defined (_MIPSEL) || defined (MIPSEL)
63#define __FLASHROM_LITTLE_ENDIAN__ 1
64#elif defined (__MIPSEB) || defined (__MIPSEB__) || defined (_MIPSEB) || defined (MIPSEB)
65#define __FLASHROM_BIG_ENDIAN__ 1
66#endif
67
68#elif IS_PPC
69
70/* PowerPC can be either endian. */
71#if defined (_BIG_ENDIAN) || defined (__BIG_ENDIAN__)
72#define __FLASHROM_BIG_ENDIAN__ 1
73#elif defined (_LITTLE_ENDIAN) || defined (__LITTLE_ENDIAN__)
74#define __FLASHROM_LITTLE_ENDIAN__ 1
75#endif
76
77#elif IS_ARM
78
79/* ARM can be either endian. */
80#if defined (__ARMEB__)
81#define __FLASHROM_BIG_ENDIAN__ 1
82#elif defined (__ARMEL__)
83#define __FLASHROM_LITTLE_ENDIAN__ 1
84#endif
85
86#elif IS_SPARC
87/* SPARC is big endian in general (but allows to access data in little endian too). */
88#define __FLASHROM_BIG_ENDIAN__ 1
89
90#endif /* IS_? */
91
92#if !defined (__FLASHROM_BIG_ENDIAN__) && !defined (__FLASHROM_LITTLE_ENDIAN__)
93
94/* If architecture-specific approaches fail try generic variants. First: BSD (works about everywhere). */
95#if !IS_WINDOWS
96#include <sys/param.h>
97
98#if defined (__BYTE_ORDER)
99#if __BYTE_ORDER == __LITTLE_ENDIAN
100#define __FLASHROM_LITTLE_ENDIAN__
101#elif __BYTE_ORDER == __BIG_ENDIAN
102#define __FLASHROM_BIG_ENDIAN__
103#else
104#error Unknown byte order!
105#endif
106#endif /* defined __BYTE_ORDER */
107#endif /* !IS_WINDOWS */
108
109#if !defined (__FLASHROM_BIG_ENDIAN__) && !defined (__FLASHROM_LITTLE_ENDIAN__)
110
111/* Nonstandard libc-specific macros for determining endianness. */
112/* musl provides an endian.h as well... but it can not be detected from within C. */
113#if defined(__GLIBC__)
114#include <endian.h>
115#if BYTE_ORDER == LITTLE_ENDIAN
116#define __FLASHROM_LITTLE_ENDIAN__ 1
117#elif BYTE_ORDER == BIG_ENDIAN
118#define __FLASHROM_BIG_ENDIAN__ 1
119#endif
120#endif
121#endif
122
123#endif
124
125#if !defined (__FLASHROM_BIG_ENDIAN__) && !defined (__FLASHROM_LITTLE_ENDIAN__)
126#error Unable to determine endianness.
127#endif
128
129#define ___constant_swab8(x) ((uint8_t) (\
130(((uint8_t)(x) & (uint8_t)0xffU))))
131
132#define ___constant_swab16(x) ((uint16_t) (\
133(((uint16_t)(x) & (uint16_t)0x00ffU) << 8) |\
134(((uint16_t)(x) & (uint16_t)0xff00U) >> 8)))
135
136#define ___constant_swab32(x) ((uint32_t) (\
137(((uint32_t)(x) & (uint32_t)0x000000ffUL) << 24) |\
138(((uint32_t)(x) & (uint32_t)0x0000ff00UL) << 8) |\
139(((uint32_t)(x) & (uint32_t)0x00ff0000UL) >> 8) |\
140(((uint32_t)(x) & (uint32_t)0xff000000UL) >> 24)))
141
142#define ___constant_swab64(x) ((uint64_t) (\
143(((uint64_t)(x) & (uint64_t)0x00000000000000ffULL) << 56) |\
144(((uint64_t)(x) & (uint64_t)0x000000000000ff00ULL) << 40) |\
145(((uint64_t)(x) & (uint64_t)0x0000000000ff0000ULL) << 24) |\
146(((uint64_t)(x) & (uint64_t)0x00000000ff000000ULL) << 8) |\
147(((uint64_t)(x) & (uint64_t)0x000000ff00000000ULL) >> 8) |\
148(((uint64_t)(x) & (uint64_t)0x0000ff0000000000ULL) >> 24) |\
149(((uint64_t)(x) & (uint64_t)0x00ff000000000000ULL) >> 40) |\
150(((uint64_t)(x) & (uint64_t)0xff00000000000000ULL) >> 56)))
151
152#if defined (__FLASHROM_BIG_ENDIAN__)
153
154#define cpu_to_le(bits)\
155static inline uint##bits##_t cpu_to_le##bits(uint##bits##_t val)\
156{\
157return ___constant_swab##bits(val);\
158}
159
160cpu_to_le(8)
161cpu_to_le(16)
162cpu_to_le(32)
163cpu_to_le(64)
164
165#define cpu_to_be8
166#define cpu_to_be16
167#define cpu_to_be32
168#define cpu_to_be64
169
170#elif defined (__FLASHROM_LITTLE_ENDIAN__)
171
172#define cpu_to_be(bits)\
173static inline uint##bits##_t cpu_to_be##bits(uint##bits##_t val)\
174{\
175return ___constant_swab##bits(val);\
176}
177
178cpu_to_be(8)
179cpu_to_be(16)
180cpu_to_be(32)
181cpu_to_be(64)
182
183#define cpu_to_le8
184#define cpu_to_le16
185#define cpu_to_le32
186#define cpu_to_le64
187
188#endif /* __FLASHROM_BIG_ENDIAN__ / __FLASHROM_LITTLE_ENDIAN__ */
189
190#define be_to_cpu8 cpu_to_be8
191#define be_to_cpu16 cpu_to_be16
192#define be_to_cpu32 cpu_to_be32
193#define be_to_cpu64 cpu_to_be64
194#define le_to_cpu8 cpu_to_le8
195#define le_to_cpu16 cpu_to_le16
196#define le_to_cpu32 cpu_to_le32
197#define le_to_cpu64 cpu_to_le64
198
199#if NEED_RAW_ACCESS == 1
200#if IS_X86
201
202/* sys/io.h provides iopl(2) and x86 I/O port access functions (inb, outb etc).
203 * It is included in glibc (thus available also on debian/kFreeBSD) but also in other libcs that mimic glibc,
204 * e.g. musl and uclibc. Because we cannot detect the libc or existence of the header or of the instructions
205 * themselves safely in here we use some heuristic below:
206 * On Android we don't have the header file and no way for I/O port access at all. However, sys/glibc-syscalls.h
207 * refers to an iopl implementation and we therefore include at least that one for now. On non-Android we assume
208 * that a Linux system's libc has a suitable sys/io.h or (on non-Linux) we depend on glibc to offer it. */
209#if defined(__ANDROID__)
210#include <sys/glibc-syscalls.h>
211#elif defined(__linux__) || defined(__GLIBC__)
212#include <sys/io.h>
213#endif
214
215#define __FLASHROM_HAVE_OUTB__ 1
216
217/* for iopl and outb under Solaris */
218#if defined (__sun)
219#include <sys/sysi86.h>
220#include <sys/psw.h>
221#include <asm/sunddi.h>
222#endif
223
224/* Clarification about OUTB/OUTW/OUTL argument order:
225 * OUT[BWL](val, port)
226 */
227
228#if defined(__FreeBSD__) || defined(__DragonFly__)
229 /* Note that Debian/kFreeBSD (FreeBSD kernel with glibc) has conflicting
230 * out[bwl] definitions in machine/cpufunc.h and sys/io.h at least in some
231 * versions. Use machine/cpufunc.h only for plain FreeBSD/DragonFlyBSD.
232 */
233 #include <sys/types.h>
234 #include <machine/cpufunc.h>
235 #define OUTB(x, y) do { u_int outb_tmp = (y); outb(outb_tmp, (x)); } while (0)
236 #define OUTW(x, y) do { u_int outw_tmp = (y); outw(outw_tmp, (x)); } while (0)
237 #define OUTL(x, y) do { u_int outl_tmp = (y); outl(outl_tmp, (x)); } while (0)
238 #define INB(x) __extension__ ({ u_int inb_tmp = (x); inb(inb_tmp); })
239 #define INW(x) __extension__ ({ u_int inw_tmp = (x); inw(inw_tmp); })
240 #define INL(x) __extension__ ({ u_int inl_tmp = (x); inl(inl_tmp); })
241#else
242
243#if defined (__sun)
244 /* Note different order for outb */
245 #define OUTB(x,y) outb(y, x)
246 #define OUTW(x,y) outw(y, x)
247 #define OUTL(x,y) outl(y, x)
248 #define INB inb
249 #define INW inw
250 #define INL inl
251#else
252
253#ifdef __DJGPP__
254
255#include <pc.h>
256
257 #define OUTB(x,y) outportb(y, x)
258 #define OUTW(x,y) outportw(y, x)
259 #define OUTL(x,y) outportl(y, x)
260
261 #define INB inportb
262 #define INW inportw
263 #define INL inportl
264
265#else
266
267#if defined(__MACH__) && defined(__APPLE__)
268 /* Header is part of the DirectHW library. */
269 #include <DirectHW/DirectHW.h>
270#endif
271
272 /* This is the usual glibc interface. */
273 #define OUTB outb
274 #define OUTW outw
275 #define OUTL outl
276 #define INB inb
277 #define INW inw
278 #define INL inl
279#endif
280#endif
281#endif
282
283#if defined(__NetBSD__) || defined (__OpenBSD__)
284 #if defined(__i386__) || defined(__x86_64__)
285 #include <sys/types.h>
286 #include <machine/sysarch.h>
287 #if defined(__NetBSD__)
288 #if defined(__i386__)
289 #define iopl i386_iopl
290 #elif defined(__x86_64__)
291 #define iopl x86_64_iopl
292 #endif
293 #elif defined (__OpenBSD__)
294 #if defined(__i386__)
295 #define iopl i386_iopl
296 #elif defined(__amd64__)
297 #define iopl amd64_iopl
298 #endif
299 #endif
300
301static inline void outb(uint8_t value, uint16_t port)
302{
303__asm__ volatile ("outb %b0,%w1": :"a" (value), "Nd" (port));
304}
305
306static inline uint8_t inb(uint16_t port)
307{
308uint8_t value;
309__asm__ volatile ("inb %w1,%0":"=a" (value):"Nd" (port));
310return value;
311}
312
313static inline void outw(uint16_t value, uint16_t port)
314{
315__asm__ volatile ("outw %w0,%w1": :"a" (value), "Nd" (port));
316}
317
318static inline uint16_t inw(uint16_t port)
319{
320uint16_t value;
321__asm__ volatile ("inw %w1,%0":"=a" (value):"Nd" (port));
322return value;
323}
324
325static inline void outl(uint32_t value, uint16_t port)
326{
327__asm__ volatile ("outl %0,%w1": :"a" (value), "Nd" (port));
328}
329
330static inline uint32_t inl(uint16_t port)
331{
332uint32_t value;
333__asm__ volatile ("inl %1,%0":"=a" (value):"Nd" (port));
334return value;
335}
336 #endif
337#endif
338
339#if !(defined(__MACH__) && defined(__APPLE__)) && !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__) && !defined(__DragonFly__) && !defined(__LIBPAYLOAD__)
340typedef struct { uint32_t hi, lo; } msr_t;
341msr_t rdmsr(int addr);
342int wrmsr(int addr, msr_t msr);
343#endif
344#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
345/* FreeBSD already has conflicting definitions for wrmsr/rdmsr. */
346#undef rdmsr
347#undef wrmsr
348#define rdmsr freebsd_rdmsr
349#define wrmsr freebsd_wrmsr
350typedef struct { uint32_t hi, lo; } msr_t;
351msr_t freebsd_rdmsr(int addr);
352int freebsd_wrmsr(int addr, msr_t msr);
353#endif
354#if defined(__LIBPAYLOAD__)
355#include <arch/io.h>
356#include <arch/msr.h>
357typedef struct { uint32_t hi, lo; } msr_t;
358msr_t libpayload_rdmsr(int addr);
359int libpayload_wrmsr(int addr, msr_t msr);
360#undef rdmsr
361#define rdmsr libpayload_rdmsr
362#define wrmsr libpayload_wrmsr
363#endif
364
365#elif IS_PPC
366
367/* PCI port I/O is not yet implemented on PowerPC. */
368
369#elif IS_MIPS
370
371/* PCI port I/O is not yet implemented on MIPS. */
372
373#elif IS_SPARC
374
375/* PCI port I/O is not yet implemented on SPARC. */
376
377#elif IS_ARM
378
379/* Non memory mapped I/O is not supported on ARM. */
380
381#else
382
383#error Unknown architecture, please check if it supports PCI port IO.
384
385#endif /* IS_* */
386#endif /* NEED_RAW_ACCESS == 1 */
387
388#endif /* !__HWACCESS_H__ */

Archive Download this file

Revision: HEAD