Remove some obsolete sections of librm.h and libkir.h.
[people/xl0/gpxe.git] / src / arch / i386 / include / librm.h
1 #ifndef LIBRM_H
2 #define LIBRM_H
3
4 /* Drag in protected-mode segment selector values */
5 #include "virtaddr.h"
6 #include "realmode.h"
7
8 #ifndef ASSEMBLY
9
10 #include "stddef.h"
11 #include "string.h"
12
13 /*
14  * Data structures and type definitions
15  *
16  */
17
18 /* Access to variables in .data16 and .text16 */
19 extern char *data16;
20 extern char *text16;
21
22 #define __data16( variable )                                            \
23         __attribute__ (( section ( ".data16" ) ))                       \
24         _data16_ ## variable __asm__ ( #variable )
25
26 #define __data16_array( variable, array )                               \
27         __attribute__ (( section ( ".data16" ) ))                       \
28         _data16_ ## variable array __asm__ ( #variable )
29
30 #define __bss16( variable )                                             \
31         __attribute__ (( section ( ".bss16" ) ))                        \
32         _data16_ ## variable __asm__ ( #variable )
33
34 #define __bss16_array( variable, array )                                \
35         __attribute__ (( section ( ".bss16" ) ))                        \
36         _data16_ ## variable array __asm__ ( #variable )
37
38 #define __text16( variable )                                            \
39         __attribute__ (( section ( ".text16.data" ) ))                  \
40         _text16_ ## variable __asm__ ( #variable )
41
42 #define __text16_array( variable, array )                               \
43         __attribute__ (( section ( ".text16.data" ) ))                  \
44         _text16_ ## variable array __asm__ ( #variable )
45
46 #define __use_data16( variable )                                        \
47         ( * ( ( typeof ( _data16_ ## variable ) * )                     \
48               & ( data16 [ ( size_t ) & ( _data16_ ## variable ) ] ) ) )
49
50 #define __use_text16( variable )                                        \
51         ( * ( ( typeof ( _text16_ ## variable ) * )                     \
52               & ( text16 [ ( size_t ) & ( _text16_ ## variable ) ] ) ) )
53
54 #define __from_data16( variable )                                       \
55         ( * ( ( typeof ( variable ) * )                                 \
56               ( ( ( void * ) &(variable) ) - ( ( void * ) data16 ) ) ) )
57
58 #define __from_text16( variable )                                       \
59         ( * ( ( typeof ( variable ) * )                                 \
60               ( ( ( void * ) &(variable) ) - ( ( void * ) text16 ) ) ) )
61
62 /* Variables in librm.S, present in the normal data segment */
63 extern uint16_t rm_sp;
64 extern uint16_t rm_ss;
65 extern uint32_t pm_esp;
66 extern uint16_t __data16 ( rm_cs );
67 #define rm_cs __use_data16 ( rm_cs )
68 extern uint16_t __text16 ( rm_ds );
69 #define rm_ds __use_text16 ( rm_ds )
70
71 /* Functions that librm expects to be able to link to.  Included here
72  * so that the compiler will catch prototype mismatches.
73  */
74 extern void gateA20_set ( void );
75
76 /*
77  * librm_mgmt: functions for manipulating base memory and executing
78  * real-mode code.
79  *
80  * Full API documentation for these functions is in realmode.h.
81  *
82  */
83
84 /* Macro for obtaining a physical address from a segment:offset pair. */
85 #define VIRTUAL(x,y) ( phys_to_virt ( ( ( x ) << 4 ) + ( y ) ) )
86
87 /* Copy to/from base memory */
88 static inline __attribute__ (( always_inline )) void
89 copy_to_real_librm ( unsigned int dest_seg, unsigned int dest_off,
90                      void *src, size_t n ) {
91         memcpy ( VIRTUAL ( dest_seg, dest_off ), src, n );
92 }
93 static inline __attribute__ (( always_inline )) void
94 copy_from_real_librm ( void *dest, unsigned int src_seg,
95                        unsigned int src_off, size_t n ) {
96         memcpy ( dest, VIRTUAL ( src_seg, src_off ), n );
97 }
98 #define put_real_librm( var, dest_seg, dest_off )                             \
99         do {                                                                  \
100                 * ( ( typeof(var) * ) VIRTUAL ( dest_seg, dest_off ) ) = var; \
101         } while ( 0 )
102 #define get_real_librm( var, src_seg, src_off )                               \
103         do {                                                                  \
104                 var = * ( ( typeof(var) * ) VIRTUAL ( src_seg, src_off ) ); \
105         } while ( 0 )
106 #define copy_to_real copy_to_real_librm
107 #define copy_from_real copy_from_real_librm
108 #define put_real put_real_librm
109 #define get_real get_real_librm
110
111 /**
112  * A pointer to a user buffer
113  *
114  * Even though we could just use a void *, we use an intptr_t so that
115  * attempts to use normal pointers show up as compiler warnings.  Such
116  * code is actually valid for librm, but not for libkir (i.e. under
117  * KEEP_IT_REAL), so it's good to have the warnings even under librm.
118  */
119 typedef intptr_t userptr_t;
120
121 /**
122  * Add offset to user pointer
123  *
124  * @v ptr               User pointer
125  * @v offset            Offset
126  * @ret new_ptr         New pointer value
127  */
128 static inline __attribute__ (( always_inline )) userptr_t
129 userptr_add ( userptr_t ptr, off_t offset ) {
130         return ( ptr + offset );
131 }
132
133 /**
134  * Copy data to user buffer
135  *
136  * @v buffer            User buffer
137  * @v offset            Offset within user buffer
138  * @v src               Source
139  * @v len               Length
140  */
141 static inline __attribute__ (( always_inline )) void
142 copy_to_user ( userptr_t buffer, off_t offset, const void *src, size_t len ) {
143         memcpy ( ( ( void * ) buffer + offset ), src, len );
144 }
145
146 /**
147  * Copy data from user buffer
148  *
149  * @v dest              Destination
150  * @v buffer            User buffer
151  * @v offset            Offset within user buffer
152  * @v len               Length
153  */
154 static inline __attribute__ (( always_inline )) void
155 copy_from_user ( void *dest, userptr_t buffer, off_t offset, size_t len ) {
156         memcpy ( dest, ( ( void * ) buffer + offset ), len );
157 }
158
159 /**
160  * Copy data between user buffers
161  *
162  * @v dest              Destination user buffer
163  * @v dest_off          Offset within destination buffer
164  * @v src               Source user buffer
165  * @v src_off           Offset within source buffer
166  * @v len               Length
167  */
168 static inline __attribute__ (( always_inline )) void
169 memcpy_user ( userptr_t dest, off_t dest_off, userptr_t src, off_t src_off,
170               size_t len ) {
171         memcpy ( ( ( void * ) dest + dest_off ), ( ( void * ) src + src_off ),
172                  len );
173 }
174
175 /**
176  * Copy data between user buffers, allowing for overlap
177  *
178  * @v dest              Destination user buffer
179  * @v dest_off          Offset within destination buffer
180  * @v src               Source user buffer
181  * @v src_off           Offset within source buffer
182  * @v len               Length
183  */
184 static inline __attribute__ (( always_inline )) void
185 memmove_user ( userptr_t dest, off_t dest_off, userptr_t src, off_t src_off,
186                size_t len ) {
187         memmove ( ( ( void * ) dest + dest_off ), ( ( void * ) src + src_off ),
188                   len );
189 }
190
191 /**
192  * Fill user buffer with a constant byte
193  *
194  * @v buffer            User buffer
195  * @v offset            Offset within buffer
196  * @v c                 Constant byte with which to fill
197  * @v len               Length
198  */
199 static inline __attribute__ (( always_inline )) void
200 memset_user ( userptr_t buffer, off_t offset, int c, size_t len ) {
201         memset ( ( ( void * ) buffer + offset ), c, len );
202 }
203
204 /**
205  * Find length of NUL-terminated string in user buffer
206  *
207  * @v buffer            User buffer
208  * @v offset            Offset within buffer
209  * @ret len             Length of string (excluding NUL)
210  */
211 static inline __attribute__ (( always_inline )) size_t
212 strlen_user ( userptr_t buffer, off_t offset ) {
213         return strlen ( ( void * ) buffer + offset );
214 }
215
216 /**
217  * Convert virtual address to user buffer
218  *
219  * @v virtual           Virtual address
220  * @ret buffer          User buffer
221  *
222  * This constructs a user buffer from an ordinary pointer.  Use it
223  * when you need to pass a pointer to an internal buffer to a function
224  * that expects a @c userptr_t.
225  */
226 static inline __attribute__ (( always_inline )) userptr_t
227 virt_to_user ( void * virtual ) {
228         return ( ( intptr_t ) virtual );
229 }
230
231 /**
232  * Convert segment:offset address to user buffer
233  *
234  * @v segment           Real-mode segment
235  * @v offset            Real-mode offset
236  * @ret buffer          User buffer
237  */
238 static inline __attribute__ (( always_inline )) userptr_t
239 real_to_user ( unsigned int segment, unsigned int offset ) {
240         return virt_to_user ( VIRTUAL ( segment, offset ) );
241 }
242
243 /**
244  * Convert physical address to user buffer
245  *
246  * @v physical          Physical address
247  * @ret buffer          User buffer
248  */
249 static inline __attribute__ (( always_inline )) userptr_t
250 phys_to_user ( physaddr_t physical ) {
251         return virt_to_user ( phys_to_virt ( physical ) );
252 }
253
254 /**
255  * Convert user buffer to physical address
256  *
257  * @v buffer            User buffer
258  * @v offset            Offset within user buffer
259  * @ret physical        Physical address
260  */
261 static inline __attribute__ (( always_inline )) physaddr_t
262 user_to_phys ( userptr_t buffer, off_t offset ) {
263         return virt_to_phys ( ( void * ) buffer + offset );
264 }
265
266 /* TEXT16_CODE: declare a fragment of code that resides in .text16 */
267 #define TEXT16_CODE( asm_code_str )                     \
268         ".section \".text16\", \"ax\", @progbits\n\t"   \
269         ".code16\n\t"                                   \
270         asm_code_str "\n\t"                             \
271         ".code32\n\t"                                   \
272         ".previous\n\t"
273
274 /* REAL_CODE: declare a fragment of code that executes in real mode */
275 #define REAL_CODE( asm_code_str )                       \
276         "pushl $1f\n\t"                                 \
277         "call real_call\n\t"                            \
278         "addl $4, %%esp\n\t"                            \
279         TEXT16_CODE ( "\n1:\n\t"                        \
280                       asm_code_str                      \
281                       "\n\t"                            \
282                       "ret\n\t" )
283
284 /* PHYS_CODE: declare a fragment of code that executes in flat physical mode */
285 #define PHYS_CODE( asm_code_str )                       \
286         "call _virt_to_phys\n\t"                        \
287         asm_code_str                                    \
288         "call _phys_to_virt\n\t"
289
290 #endif /* ASSEMBLY */
291
292 #endif /* LIBRM_H */