Blame view

RIOT/cpu/x86/include/x86_kernel_memory.h 3.16 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
  /*
   * Copyright (C) 2014  René Kijewski  <rene.kijewski@fu-berlin.de>
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
   */
  
  /**
   * Layout of the kernel memory. The symbols are set in the linker.ld.
   *
   * @ingroup x86
   * @{
   * @file
   * @author  René Kijewski <rene.kijewski@fu-berlin.de>
   */
  
  #ifndef X86_KERNEL_MEMORY_H
  #define X86_KERNEL_MEMORY_H
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   First byte inside the elf segments.
   *
   * Expected to be the start of the high memory, i.e. 1MB.
   */
  extern char _kernel_memory_start;
  
  /**
   * @brief   Start of first byte of code inside the .text segment.
   *
   * This symbol does not have to be aligned.
   */
  extern char _section_text_start;
  
  /**
   * @brief   First byte after the code.
   *
   * This symbol does not have to be aligned.
   */
  extern char _section_text_end;
  
  /**
   * @brief   First byte inside the .rodata segment.
   *
   * This symbol is expected to be aligned.
   */
  extern char _section_rodata_start;
  
  /**
   * @brief   First byte after the .rodata segment.
   *
   * This symbol does not have to be aligned.
   */
  extern char _section_rodata_end;
  
  /**
   * @brief   First byte inside the .data segment.
   *
   * This symbol is expected to be aligned.
   */
  extern char _section_data_start;
  
  /**
   * @brief   First byte after the .data segment.
   *
   * This symbol does not have to be aligned, since it shares the same previleges as the .bss segment.
   */
  extern char _section_data_end;
  
  /**
   * @brief   Start of the .bss segment.
   *
   * Probably unaligned.
   * The .bss segment must follow the .data segment with no other segment inbetween.
   * It's likely that `&_section_data_end == &_section_bss_start`.
   */
  extern char _section_bss_start;
  
  /**
   * @brief   First byte after the .bss segment.
   *
   * This symbol should not to be aligned, because RAM cycles would be wasted to clear unused bytes otherwise.
   */
  extern char _section_bss_end;
  
  /**
   * @brief   First byte after the last of the common elf segments.
   *
   * This symbol is expected to be aligned.
   * The "common elf segments" are .text, .rodata, .data and .bss.
   * All the (physical) memory beyond this point will be overwritten at the pleasure of the kernel.
   */
  extern char _kernel_memory_end;
  
  /**
   * @brief   First byte that may be mapped as the heap
   *
   * This symbol is expected to be aligned.
   * Must be bigger than _kernel_memory_end.
   * There should be a space between _kernel_memory_end and _heap_start, but it does not have to.
   */
  extern char _heap_start;
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* X86_KERNEL_MEMORY_H */
  
  /** @} */