[script] Remove arbitrary limit on script line lengths
[people/mdeck/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 __data16 ( rm_cs );
64 #define rm_cs __use_data16 ( rm_cs )
65 extern uint16_t __text16 ( rm_ds );
66 #define rm_ds __use_text16 ( rm_ds )
67
68 /* Functions that librm expects to be able to link to.  Included here
69  * so that the compiler will catch prototype mismatches.
70  */
71 extern void gateA20_set ( void );
72
73 /*
74  * librm_mgmt: functions for manipulating base memory and executing
75  * real-mode code.
76  *
77  * Full API documentation for these functions is in realmode.h.
78  *
79  */
80
81 /* Macro for obtaining a physical address from a segment:offset pair. */
82 #define VIRTUAL(x,y) ( phys_to_virt ( ( ( x ) << 4 ) + ( y ) ) )
83
84 /* Copy to/from base memory */
85 static inline __attribute__ (( always_inline )) void
86 copy_to_real_librm ( unsigned int dest_seg, unsigned int dest_off,
87                      void *src, size_t n ) {
88         memcpy ( VIRTUAL ( dest_seg, dest_off ), src, n );
89 }
90 static inline __attribute__ (( always_inline )) void
91 copy_from_real_librm ( void *dest, unsigned int src_seg,
92                        unsigned int src_off, size_t n ) {
93         memcpy ( dest, VIRTUAL ( src_seg, src_off ), n );
94 }
95 #define put_real_librm( var, dest_seg, dest_off )                             \
96         do {                                                                  \
97                 * ( ( typeof(var) * ) VIRTUAL ( dest_seg, dest_off ) ) = var; \
98         } while ( 0 )
99 #define get_real_librm( var, src_seg, src_off )                               \
100         do {                                                                  \
101                 var = * ( ( typeof(var) * ) VIRTUAL ( src_seg, src_off ) ); \
102         } while ( 0 )
103 #define copy_to_real copy_to_real_librm
104 #define copy_from_real copy_from_real_librm
105 #define put_real put_real_librm
106 #define get_real get_real_librm
107
108 /**
109  * A pointer to a user buffer
110  *
111  * Even though we could just use a void *, we use an intptr_t so that
112  * attempts to use normal pointers show up as compiler warnings.  Such
113  * code is actually valid for librm, but not for libkir (i.e. under
114  * KEEP_IT_REAL), so it's good to have the warnings even under librm.
115  */
116 typedef intptr_t userptr_t;
117
118 /**
119  * Add offset to user pointer
120  *
121  * @v ptr               User pointer
122  * @v offset            Offset
123  * @ret new_ptr         New pointer value
124  */
125 static inline __attribute__ (( always_inline )) userptr_t
126 userptr_add ( userptr_t ptr, off_t offset ) {
127         return ( ptr + offset );
128 }
129
130 /**
131  * Copy data to user buffer
132  *
133  * @v buffer            User buffer
134  * @v offset            Offset within user buffer
135  * @v src               Source
136  * @v len               Length
137  */
138 static inline __attribute__ (( always_inline )) void
139 copy_to_user ( userptr_t buffer, off_t offset, const void *src, size_t len ) {
140         memcpy ( ( ( void * ) buffer + offset ), src, len );
141 }
142
143 /**
144  * Copy data from user buffer
145  *
146  * @v dest              Destination
147  * @v buffer            User buffer
148  * @v offset            Offset within user buffer
149  * @v len               Length
150  */
151 static inline __attribute__ (( always_inline )) void
152 copy_from_user ( void *dest, userptr_t buffer, off_t offset, size_t len ) {
153         memcpy ( dest, ( ( void * ) buffer + offset ), len );
154 }
155
156 /**
157  * Copy data between user buffers
158  *
159  * @v dest              Destination user buffer
160  * @v dest_off          Offset within destination buffer
161  * @v src               Source user buffer
162  * @v src_off           Offset within source buffer
163  * @v len               Length
164  */
165 static inline __attribute__ (( always_inline )) void
166 memcpy_user ( userptr_t dest, off_t dest_off, userptr_t src, off_t src_off,
167               size_t len ) {
168         memcpy ( ( ( void * ) dest + dest_off ), ( ( void * ) src + src_off ),
169                  len );
170 }
171
172 /**
173  * Copy data between user buffers, allowing for overlap
174  *
175  * @v dest              Destination user buffer
176  * @v dest_off          Offset within destination buffer
177  * @v src               Source user buffer
178  * @v src_off           Offset within source buffer
179  * @v len               Length
180  */
181 static inline __attribute__ (( always_inline )) void
182 memmove_user ( userptr_t dest, off_t dest_off, userptr_t src, off_t src_off,
183                size_t len ) {
184         memmove ( ( ( void * ) dest + dest_off ), ( ( void * ) src + src_off ),
185                   len );
186 }
187
188 /**
189  * Fill user buffer with a constant byte
190  *
191  * @v buffer            User buffer
192  * @v offset            Offset within buffer
193  * @v c                 Constant byte with which to fill
194  * @v len               Length
195  */
196 static inline __attribute__ (( always_inline )) void
197 memset_user ( userptr_t buffer, off_t offset, int c, size_t len ) {
198         memset ( ( ( void * ) buffer + offset ), c, len );
199 }
200
201 /**
202  * Find length of NUL-terminated string in user buffer
203  *
204  * @v buffer            User buffer
205  * @v offset            Offset within buffer
206  * @ret len             Length of string (excluding NUL)
207  */
208 static inline __attribute__ (( always_inline )) size_t
209 strlen_user ( userptr_t buffer, off_t offset ) {
210         return strlen ( ( void * ) buffer + offset );
211 }
212
213 /**
214  * Find character in user buffer
215  *
216  * @v buffer            User buffer
217  * @v offset            Starting offset within buffer
218  * @v c                 Character to search for
219  * @v len               Length of user buffer
220  * @ret offset          Offset of character, or <0 if not found
221  */
222 static inline __attribute__ (( always_inline )) off_t
223 memchr_user ( userptr_t buffer, off_t offset, int c, size_t len ) {
224         void *found;
225
226         found = memchr ( ( ( void * ) buffer + offset ), c, len );
227         return ( found ? ( found - ( void * ) buffer ) : -1 );
228 }
229
230 /**
231  * Convert virtual address to user buffer
232  *
233  * @v virtual           Virtual address
234  * @ret buffer          User buffer
235  *
236  * This constructs a user buffer from an ordinary pointer.  Use it
237  * when you need to pass a pointer to an internal buffer to a function
238  * that expects a @c userptr_t.
239  */
240 static inline __attribute__ (( always_inline )) userptr_t
241 virt_to_user ( void * virtual ) {
242         return ( ( intptr_t ) virtual );
243 }
244
245 /**
246  * Convert segment:offset address to user buffer
247  *
248  * @v segment           Real-mode segment
249  * @v offset            Real-mode offset
250  * @ret buffer          User buffer
251  */
252 static inline __attribute__ (( always_inline )) userptr_t
253 real_to_user ( unsigned int segment, unsigned int offset ) {
254         return virt_to_user ( VIRTUAL ( segment, offset ) );
255 }
256
257 /**
258  * Convert physical address to user buffer
259  *
260  * @v physical          Physical address
261  * @ret buffer          User buffer
262  */
263 static inline __attribute__ (( always_inline )) userptr_t
264 phys_to_user ( physaddr_t physical ) {
265         return virt_to_user ( phys_to_virt ( physical ) );
266 }
267
268 /**
269  * Convert user buffer to physical address
270  *
271  * @v buffer            User buffer
272  * @v offset            Offset within user buffer
273  * @ret physical        Physical address
274  */
275 static inline __attribute__ (( always_inline )) physaddr_t
276 user_to_phys ( userptr_t buffer, off_t offset ) {
277         return virt_to_phys ( ( void * ) buffer + offset );
278 }
279
280 /* TEXT16_CODE: declare a fragment of code that resides in .text16 */
281 #define TEXT16_CODE( asm_code_str )                     \
282         ".section \".text16\", \"ax\", @progbits\n\t"   \
283         ".code16\n\t"                                   \
284         asm_code_str "\n\t"                             \
285         ".code32\n\t"                                   \
286         ".previous\n\t"
287
288 /* REAL_CODE: declare a fragment of code that executes in real mode */
289 #define REAL_CODE( asm_code_str )                       \
290         "pushl $1f\n\t"                                 \
291         "call real_call\n\t"                            \
292         "addl $4, %%esp\n\t"                            \
293         TEXT16_CODE ( "\n1:\n\t"                        \
294                       asm_code_str                      \
295                       "\n\t"                            \
296                       "ret\n\t" )
297
298 /* PHYS_CODE: declare a fragment of code that executes in flat physical mode */
299 #define PHYS_CODE( asm_code_str )                       \
300         "call _virt_to_phys\n\t"                        \
301         asm_code_str                                    \
302         "call _phys_to_virt\n\t"
303
304 #endif /* ASSEMBLY */
305
306 #endif /* LIBRM_H */