a54c343a507a8aef53ac6c095138d90145e2ef3c
[people/xl0/gpxe.git] / src / arch / i386 / include / libkir.h
1 #ifndef LIBKIR_H
2 #define LIBKIR_H
3
4 #include "realmode.h"
5
6 #ifndef ASSEMBLY
7
8 /*
9  * Full API documentation for these functions is in realmode.h.
10  *
11  */
12
13 /* Access to variables in .data16 and .text16 in a way compatible with librm */
14 #define __data16( variable ) variable
15 #define __data16_array( variable, array ) variable array
16 #define __text16( variable ) variable
17 #define __text16_array( variable,array ) variable array
18 #define __use_data16( variable ) variable
19 #define __use_text16( variable ) variable
20 #define __from_data16( variable ) variable
21 #define __from_text16( variable ) variable
22
23 /* Real-mode data and code segments */
24 static inline __attribute__ (( always_inline )) unsigned int _rm_cs ( void ) {
25         uint16_t cs;
26         __asm__ __volatile__ ( "movw %%cs, %w0" : "=r" ( cs ) );
27         return cs;
28 }
29
30 static inline __attribute__ (( always_inline )) unsigned int _rm_ds ( void ) {
31         uint16_t ds;
32         __asm__ __volatile__ ( "movw %%ds, %w0" : "=r" ( ds ) );
33         return ds;
34 }
35
36 #define rm_cs ( _rm_cs() )
37 #define rm_ds ( _rm_ds() )
38
39 /* Copy to/from base memory */
40
41 static inline void copy_to_real_libkir ( uint16_t dest_seg, uint16_t dest_off,
42                                          const void *src, size_t n ) {
43         __asm__ __volatile__ ( "movw %4, %%es\n\t"
44                                "cld\n\t"
45                                "rep movsb\n\t"
46                                "pushw %%ds\n\t" /* restore %es */
47                                "popw %%es\n\t"
48                                : "=S" ( src ), "=D" ( dest_off ),
49                                  "=c" ( n ) /* clobbered */
50                                : "S" ( src ), "r" ( dest_seg ),
51                                  "D" ( dest_off ), "c" ( n )
52                                : "memory" );
53 }
54
55 static inline void copy_from_real_libkir ( void *dest,
56                                            uint16_t src_seg, uint16_t src_off,
57                                            size_t n ) {
58         __asm__ __volatile__ ( "movw %%ax, %%ds\n\t"
59                                "cld\n\t"
60                                "rep movsb\n\t"
61                                "pushw %%es\n\t" /* restore %ds */
62                                "popw %%ds\n\t"
63                                : "=S" ( src_off ), "=D" ( dest ),
64                                  "=c" ( n ) /* clobbered */
65                                : "a" ( src_seg ), "S" ( src_off ),
66                                  "D" ( dest ), "c" ( n )
67                                : "memory" );
68 }
69 #define copy_to_real copy_to_real_libkir
70 #define copy_from_real copy_from_real_libkir
71
72 /*
73  * Transfer individual values to/from base memory.  There may well be
74  * a neater way to do this.  We have two versions: one for constant
75  * offsets (where the mov instruction must be of the form "mov
76  * %es:123, %xx") and one for non-constant offsets (where the mov
77  * instruction must be of the form "mov %es:(%xx), %yx".  If it's
78  * possible to incorporate both forms into one __asm__ instruction, I
79  * don't know how to do it.
80  *
81  * Ideally, the mov instruction should be "mov%z0"; the "%z0" is meant
82  * to expand to either "b", "w" or "l" depending on the size of
83  * operand 0.  This would remove the (minor) ambiguity in the mov
84  * instruction.  However, gcc on at least my system barfs with an
85  * "internal compiler error" when confronted with %z0.
86  *
87  */
88
89 #define put_real_kir_const_off( var, seg, off )                              \
90         __asm__ ( "movw %w1, %%es\n\t"                                       \
91                   "mov %0, %%es:%c2\n\t"                                     \
92                   "pushw %%ds\n\t" /* restore %es */                         \
93                   "popw %%es\n\t"                                            \
94                   :                                                          \
95                   : "r,r" ( var ), "rm,rm" ( seg ), "i,!r" ( off )           \
96                   )
97
98 #define put_real_kir_nonconst_off( var, seg, off )                           \
99         __asm__ ( "movw %w1, %%es\n\t"                                       \
100                   "mov %0, %%es:(%2)\n\t"                                    \
101                   "pushw %%ds\n\t" /* restore %es */                         \
102                   "popw %%es\n\t"                                            \
103                   :                                                          \
104                   : "r" ( var ), "rm" ( seg ), "r" ( off )                   \
105                   )
106
107 #define put_real_kir( var, seg, off )                                        \
108         do {                                                                 \
109           if ( __builtin_constant_p ( off ) )                                \
110                   put_real_kir_const_off ( var, seg, off );                  \
111           else                                                               \
112                   put_real_kir_nonconst_off ( var, seg, off );               \
113         } while ( 0 )
114
115 #define get_real_kir_const_off( var, seg, off )                              \
116         __asm__ ( "movw %w1, %%es\n\t"                                       \
117                   "mov %%es:%c2, %0\n\t"                                     \
118                   "pushw %%ds\n\t" /* restore %es */                         \
119                   "popw %%es\n\t"                                            \
120                   : "=r,r" ( var )                                           \
121                   : "rm,rm" ( seg ), "i,!r" ( off )                          \
122                   )
123
124 #define get_real_kir_nonconst_off( var, seg, off )                           \
125         __asm__ ( "movw %w1, %%es\n\t"                                       \
126                   "mov %%es:(%2), %0\n\t"                                    \
127                   "pushw %%ds\n\t" /* restore %es */                         \
128                   "popw %%es\n\t"                                            \
129                   : "=r" ( var )                                             \
130                   : "rm" ( seg ), "r" ( off )                                \
131                   )
132
133 #define get_real_kir( var, seg, off )                                        \
134         do {                                                                 \
135           if ( __builtin_constant_p ( off ) )                                \
136                   get_real_kir_const_off ( var, seg, off );                  \
137           else                                                               \
138                   get_real_kir_nonconst_off ( var, seg, off );               \
139         } while ( 0 )
140
141 #define put_real put_real_kir
142 #define get_real get_real_kir
143
144 /**
145  * A pointer to a user buffer
146  *
147  * This is actually a struct segoff, but encoded as a uint32_t to
148  * ensure that gcc passes it around efficiently.
149  */
150 typedef uint32_t userptr_t;
151
152 /**
153  * Copy data to user buffer
154  *
155  * @v buffer    User buffer
156  * @v offset    Offset within user buffer
157  * @v src       Source
158  * @v len       Length
159  */
160 static inline __attribute__ (( always_inline )) void
161 copy_to_user ( userptr_t buffer, off_t offset, const void *src, size_t len ) {
162         copy_to_real ( ( buffer >> 16 ), ( ( buffer & 0xffff ) + offset ),
163                        src, len );
164 }
165
166 /**
167  * Copy data from user buffer
168  *
169  * @v dest      Destination
170  * @v buffer    User buffer
171  * @v offset    Offset within user buffer
172  * @v len       Length
173  */
174 static inline __attribute__ (( always_inline )) void
175 copy_from_user ( void *dest, userptr_t buffer, off_t offset, size_t len ) {
176         copy_from_real ( dest, ( buffer >> 16 ),
177                          ( ( buffer & 0xffff ) + offset ), len );
178 }
179
180 /**
181  * Convert segment:offset address to user buffer
182  *
183  * @v segment   Real-mode segment
184  * @v offset    Real-mode offset
185  * @ret buffer  User buffer
186  */
187 static inline __attribute__ (( always_inline )) userptr_t
188 real_to_user ( unsigned int segment, unsigned int offset ) {
189         return ( ( segment << 16 ) | offset );
190 }
191
192 /**
193  * Convert virtual address to user buffer
194  *
195  * @v virtual   Virtual address
196  * @ret buffer  User buffer
197  *
198  * This constructs a user buffer from an ordinary pointer.  Use it
199  * when you need to pass a pointer to an internal buffer to a function
200  * that expects a @c userptr_t.
201  */
202 static inline __attribute__ (( always_inline )) userptr_t
203 virt_to_user ( void * virtual ) {
204         return real_to_user ( rm_ds, ( intptr_t ) virtual );
205 }
206
207 /* Place/remove parameter on real-mode stack in a way that's
208  * compatible with libkir
209  */
210 #define BASEMEM_PARAMETER_INIT_LIBKIR( param ) \
211         ( ( uint16_t ) ( ( uint32_t ) & ( param ) ) )
212 #define BASEMEM_PARAMETER_DONE_LIBKIR( param )
213 #define BASEMEM_PARAMETER_INIT BASEMEM_PARAMETER_INIT_LIBKIR
214 #define BASEMEM_PARAMETER_DONE BASEMEM_PARAMETER_DONE_LIBKIR
215
216 /* TEXT16_CODE: declare a fragment of code that resides in .text16 */
217 #define TEXT16_CODE( asm_code_str )                     \
218         ".section \".text16\", \"ax\", @progbits\n\t"   \
219         ".code16\n\t"                                   \
220         ".arch i386\n\t"                                \
221         asm_code_str "\n\t"                             \
222         ".code16gcc\n\t"                                \
223         ".previous\n\t"
224
225 /* REAL_CODE: declare a fragment of code that executes in real mode */
226 #define REAL_CODE( asm_code_str )       \
227         ".code16\n\t"                   \
228         asm_code_str "\n\t"             \
229         ".code16gcc\n\t"
230
231 #endif /* ASSEMBLY */
232
233 #endif /* LIBKIR_H */