blob: 3466b3ad434acd88d6ce764f85e924737f6e2167 [file] [log] [blame]
Kevin O'Connorf076a3e2008-02-25 22:25:15 -05001// Basic type definitions for X86 cpus.
2//
Kevin O'Connord1b4f962010-09-15 21:38:16 -04003// Copyright (C) 2008-2010 Kevin O'Connor <kevin@koconnor.net>
Kevin O'Connorf076a3e2008-02-25 22:25:15 -05004//
Kevin O'Connorb1b7c2a2009-01-15 20:52:58 -05005// This file may be distributed under the terms of the GNU LGPLv3 license.
Kevin O'Connorf076a3e2008-02-25 22:25:15 -05006#ifndef __TYPES_H
7#define __TYPES_H
8
9typedef unsigned char u8;
10typedef signed char s8;
11typedef unsigned short u16;
12typedef signed short s16;
13typedef unsigned int u32;
14typedef signed int s32;
Kevin O'Connore51313d2008-03-12 21:19:34 -040015typedef unsigned long long u64;
Kevin O'Connor595fb462008-04-05 10:47:13 -040016typedef signed long long s64;
17typedef u32 size_t;
Kevin O'Connorf076a3e2008-02-25 22:25:15 -050018
Kevin O'Connor1bb3b5c2008-05-14 00:43:13 -040019union u64_u32_u {
Kevin O'Connor30e6af02012-09-15 12:17:37 -040020 struct { u32 lo, hi; };
Kevin O'Connor1bb3b5c2008-05-14 00:43:13 -040021 u64 val;
22};
23
Kevin O'Connorb4f4d332013-09-14 22:03:57 -040024// Definition for common 16bit segment/offset pointers.
25struct segoff_s {
26 union {
27 struct {
28 u16 offset;
29 u16 seg;
30 };
31 u32 segoff;
32 };
33};
34
Kevin O'Connor942d4952009-06-10 22:44:06 -040035#ifdef MANUAL_NO_JUMP_TABLE
36# define default case 775324556: asm(""); default
37#endif
38
39#ifdef WHOLE_PROGRAM
40# define __VISIBLE __attribute__((externally_visible))
41#else
42# define __VISIBLE
43#endif
Kevin O'Connor4a754b32008-12-28 21:37:27 -050044
Kevin O'Connorc0693942009-06-10 21:56:01 -040045#define UNIQSEC __FILE__ "." __stringify(__LINE__)
46
Kevin O'Connordad41d92010-01-01 03:04:19 -050047#define __noreturn __attribute__((noreturn))
Kevin O'Connor1ca05b02010-01-03 17:43:37 -050048extern void __force_link_error__only_in_32bit_flat(void) __noreturn;
49extern void __force_link_error__only_in_32bit_segmented(void) __noreturn;
50extern void __force_link_error__only_in_16bit(void) __noreturn;
Kevin O'Connor871e0a02009-12-30 12:14:53 -050051
Kevin O'Connorc0693942009-06-10 21:56:01 -040052#define __ASM(code) asm(".section .text.asm." UNIQSEC "\n\t" code)
53
Kevin O'Connor7ab798f2008-07-13 11:08:36 -040054#if MODE16 == 1
Kevin O'Connor19786762008-03-05 21:09:59 -050055// Notes a function as externally visible in the 16bit code chunk.
Kevin O'Connor4a754b32008-12-28 21:37:27 -050056# define VISIBLE16 __VISIBLE
Kevin O'Connor52a300f2009-12-26 23:32:57 -050057// Notes a function as externally visible in the 32bit flat code chunk.
Kevin O'Connord3e43672012-05-28 11:37:53 -040058# define VISIBLE32FLAT
Kevin O'Connord1b4f962010-09-15 21:38:16 -040059// Notes a 32bit flat function that will only be called during init.
Kevin O'Connord3e43672012-05-28 11:37:53 -040060# define VISIBLE32INIT
Kevin O'Connor871e0a02009-12-30 12:14:53 -050061// Notes a function as externally visible in the 32bit segmented code chunk.
Kevin O'Connord3e43672012-05-28 11:37:53 -040062# define VISIBLE32SEG
Kevin O'Connor92f95b02008-12-29 20:42:40 -050063// Designate a variable as (only) visible to 16bit code.
Kevin O'Connorc0693942009-06-10 21:56:01 -040064# define VAR16 __section(".data16." UNIQSEC)
Kevin O'Connor30853762009-01-17 18:49:20 -050065// Designate a variable at a specific 16bit address
Kevin O'Connorc0693942009-06-10 21:56:01 -040066# define VAR16FIXED(addr) __aligned(1) __VISIBLE __section(".fixedaddr." __stringify(addr))
Kevin O'Connor871e0a02009-12-30 12:14:53 -050067// Designate a variable as (only) visible to 32bit segmented code.
68# define VAR32SEG __section(".discard.var32seg." UNIQSEC)
Kevin O'Connor46b82622012-05-13 12:10:30 -040069// Designate a variable as visible and located in the e-segment.
70# define VARLOW __section(".discard.varlow." UNIQSEC) __VISIBLE __weak
Kevin O'Connor41953492013-02-18 23:09:01 -050071// Designate a variable as visible and located in the f-segment.
72# define VARFSEG __section(".discard.varfseg." UNIQSEC) __VISIBLE __weak
Kevin O'Connor2af52da2013-03-08 19:36:28 -050073// Verify a variable is only accessable via 32bit "init" functions
74# define VARVERIFY32INIT __section(".discard.varinit." UNIQSEC)
Kevin O'Connor4a754b32008-12-28 21:37:27 -050075// Designate top-level assembler as 16bit only.
Kevin O'Connorc0693942009-06-10 21:56:01 -040076# define ASM16(code) __ASM(code)
Kevin O'Connor52a300f2009-12-26 23:32:57 -050077// Designate top-level assembler as 32bit flat only.
78# define ASM32FLAT(code)
79// Compile time check for a given mode.
Kevin O'Connorfdca4182010-01-01 12:46:54 -050080# define ASSERT16() do { } while (0)
81# define ASSERT32SEG() __force_link_error__only_in_32bit_segmented()
82# define ASSERT32FLAT() __force_link_error__only_in_32bit_flat()
Kevin O'Connor871e0a02009-12-30 12:14:53 -050083#elif MODESEGMENT == 1
Kevin O'Connord3e43672012-05-28 11:37:53 -040084# define VISIBLE16
85# define VISIBLE32FLAT
86# define VISIBLE32INIT
Kevin O'Connor871e0a02009-12-30 12:14:53 -050087# define VISIBLE32SEG __VISIBLE
Kevin O'Connorc0693942009-06-10 21:56:01 -040088# define VAR16 __section(".discard.var16." UNIQSEC)
Kevin O'Connor89a2f962013-02-18 23:36:03 -050089# define VAR16FIXED(addr) VAR16 __VISIBLE __weak
Kevin O'Connor871e0a02009-12-30 12:14:53 -050090# define VAR32SEG __section(".data32seg." UNIQSEC)
Kevin O'Connor46b82622012-05-13 12:10:30 -040091# define VARLOW __section(".discard.varlow." UNIQSEC) __VISIBLE __weak
Kevin O'Connor41953492013-02-18 23:09:01 -050092# define VARFSEG __section(".discard.varfseg." UNIQSEC) __VISIBLE __weak
Kevin O'Connor2af52da2013-03-08 19:36:28 -050093# define VARVERIFY32INIT __section(".discard.varinit." UNIQSEC)
Kevin O'Connor871e0a02009-12-30 12:14:53 -050094# define ASM16(code)
95# define ASM32FLAT(code)
Kevin O'Connorfdca4182010-01-01 12:46:54 -050096# define ASSERT16() __force_link_error__only_in_16bit()
97# define ASSERT32SEG() do { } while (0)
98# define ASSERT32FLAT() __force_link_error__only_in_32bit_flat()
Kevin O'Connor871e0a02009-12-30 12:14:53 -050099#else
Kevin O'Connord3e43672012-05-28 11:37:53 -0400100# define VISIBLE16
Kevin O'Connord1b4f962010-09-15 21:38:16 -0400101# define VISIBLE32FLAT __section(".text.runtime." UNIQSEC) __VISIBLE
102# define VISIBLE32INIT __section(".text.init." UNIQSEC) __VISIBLE
Kevin O'Connord3e43672012-05-28 11:37:53 -0400103# define VISIBLE32SEG
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500104# define VAR16 __section(".discard.var16." UNIQSEC)
Kevin O'Connor89a2f962013-02-18 23:36:03 -0500105# define VAR16FIXED(addr) VAR16 __VISIBLE __weak
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500106# define VAR32SEG __section(".discard.var32seg." UNIQSEC)
Kevin O'Connor6afc6f82013-02-19 01:02:50 -0500107# define VARLOW __section(".data.varlow." UNIQSEC) __VISIBLE __weak
Kevin O'Connor41953492013-02-18 23:09:01 -0500108# define VARFSEG __section(".data.varfseg." UNIQSEC) __VISIBLE
Kevin O'Connor2af52da2013-03-08 19:36:28 -0500109# define VARVERIFY32INIT __section(".data.varinit." UNIQSEC)
Kevin O'Connor4a754b32008-12-28 21:37:27 -0500110# define ASM16(code)
Kevin O'Connor52a300f2009-12-26 23:32:57 -0500111# define ASM32FLAT(code) __ASM(code)
Kevin O'Connorfdca4182010-01-01 12:46:54 -0500112# define ASSERT16() __force_link_error__only_in_16bit()
113# define ASSERT32SEG() __force_link_error__only_in_32bit_segmented()
114# define ASSERT32FLAT() do { } while (0)
Kevin O'Connor19786762008-03-05 21:09:59 -0500115#endif
Kevin O'Connorf076a3e2008-02-25 22:25:15 -0500116
117#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
Kevin O'Connor38fcbfe2008-02-25 22:30:47 -0500118#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
Kevin O'Connor28fe1bd2008-03-11 22:14:15 -0400119#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Kevin O'Connor9dd0dd12008-05-18 00:03:32 -0400120#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
Kevin O'Connor6aee52d2009-09-27 20:07:40 -0400121#define DIV_ROUND_CLOSEST(x, divisor)({ \
122 typeof(divisor) __divisor = divisor; \
123 (((x) + ((__divisor) / 2)) / (__divisor)); \
124 })
Kevin O'Connor276d4a92008-06-11 22:47:01 -0400125#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
126#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
Kevin O'Connor415d4292009-08-30 19:19:31 -0400127#define ALIGN_DOWN(x,a) ((x) & ~((typeof(x))(a)-1))
Kevin O'Connor0bf92702009-08-01 11:45:37 -0400128#define container_of(ptr, type, member) ({ \
129 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
130 (type *)( (char *)__mptr - offsetof(type,member) );})
Kevin O'Connore097a752013-06-08 21:49:12 -0400131#define container_of_or_null(ptr, type, member) ({ \
132 const typeof( ((type *)0)->member ) *___mptr = (ptr); \
133 ___mptr ? container_of(___mptr, type, member) : NULL; })
Kevin O'Connor38fcbfe2008-02-25 22:30:47 -0500134
Kevin O'Connord7eb27e2010-03-20 18:17:19 -0400135#define likely(x) __builtin_expect(!!(x), 1)
136#define unlikely(x) __builtin_expect(!!(x), 0)
137
Kevin O'Connor415d4292009-08-30 19:19:31 -0400138#define NULL ((void*)0)
Kevin O'Connorf076a3e2008-02-25 22:25:15 -0500139
Kevin O'Connorc0693942009-06-10 21:56:01 -0400140#define __weak __attribute__((weak))
141#define __section(S) __attribute__((section(S)))
142
Kevin O'Connor6eee8ca2008-03-03 20:14:12 -0500143#define PACKED __attribute__((packed))
Kevin O'Connor18e38b22008-12-10 20:40:13 -0500144#define __aligned(x) __attribute__((aligned(x)))
Kevin O'Connor6eee8ca2008-03-03 20:14:12 -0500145
Kevin O'Connora4d35762008-03-08 15:43:03 -0500146#define barrier() __asm__ __volatile__("": : :"memory")
147
Kevin O'Connoree55c762008-05-13 00:18:20 -0400148#define noinline __attribute__((noinline))
Kevin O'Connor74f9c082008-04-13 16:57:16 -0400149#define __always_inline inline __attribute__((always_inline))
Kevin O'Connorf9a774c2010-04-17 16:58:32 -0400150#define __malloc __attribute__((__malloc__))
Kevin O'Connor871e0a02009-12-30 12:14:53 -0500151#define __attribute_const __attribute__((__const__))
Kevin O'Connorbc28a2b2008-03-11 19:32:38 -0400152
Kevin O'Connora4d35762008-03-08 15:43:03 -0500153#define __stringify_1(x) #x
154#define __stringify(x) __stringify_1(x)
155
Kevin O'Connorf076a3e2008-02-25 22:25:15 -0500156#endif // types.h