qemu/roms/ipxe/src/arch/i386/include/librm.h

   1 #ifndef LIBRM_H
   2 #define LIBRM_H
   3
   4 FILE_LICENCE ( GPL2_OR_LATER );
   5
   6 /* Segment selectors as used in our protected-mode GDTs.
   7  *
   8  * Don't change these unless you really know what you're doing.
   9  */
  10
  11 #define VIRTUAL_CS 0x08
  12 #define VIRTUAL_DS 0x10
  13 #define PHYSICAL_CS 0x18
  14 #define PHYSICAL_DS 0x20
  15 #define REAL_CS 0x28
  16 #define REAL_DS 0x30
  17 #if 0
  18 #define LONG_CS 0x38
  19 #define LONG_DS 0x40
  20 #endif
  21
  22 #ifndef ASSEMBLY
  23
  24 #ifdef UACCESS_LIBRM
  25 #define UACCESS_PREFIX_librm
  26 #else
  27 #define UACCESS_PREFIX_librm __librm_
  28 #endif
  29
  30 /* Variables in librm.S */
  31 extern unsigned long virt_offset;
  32
  33 /**
  34  * Convert physical address to user pointer
  35  *
  36  * @v phys_addr         Physical address
  37  * @ret userptr         User pointer
  38  */
  39 static inline __always_inline userptr_t
  40 UACCESS_INLINE ( librm, phys_to_user ) ( unsigned long phys_addr ) {
  41         return ( phys_addr - virt_offset );
  42 }
  43
  44 /**
  45  * Convert user buffer to physical address
  46  *
  47  * @v userptr           User pointer
  48  * @v offset            Offset from user pointer
  49  * @ret phys_addr       Physical address
  50  */
  51 static inline __always_inline unsigned long
  52 UACCESS_INLINE ( librm, user_to_phys ) ( userptr_t userptr, off_t offset ) {
  53         return ( userptr + offset + virt_offset );
  54 }
  55
  56 static inline __always_inline userptr_t
  57 UACCESS_INLINE ( librm, virt_to_user ) ( volatile const void *addr ) {
  58         return trivial_virt_to_user ( addr );
  59 }
  60
  61 static inline __always_inline void *
  62 UACCESS_INLINE ( librm, user_to_virt ) ( userptr_t userptr, off_t offset ) {
  63         return trivial_user_to_virt ( userptr, offset );
  64 }
  65
  66 static inline __always_inline userptr_t
  67 UACCESS_INLINE ( librm, userptr_add ) ( userptr_t userptr, off_t offset ) {
  68         return trivial_userptr_add ( userptr, offset );
  69 }
  70
  71 static inline __always_inline off_t
  72 UACCESS_INLINE ( librm, userptr_sub ) ( userptr_t userptr,
  73                                         userptr_t subtrahend ) {
  74         return trivial_userptr_sub ( userptr, subtrahend );
  75 }
  76
  77 static inline __always_inline void
  78 UACCESS_INLINE ( librm, memcpy_user ) ( userptr_t dest, off_t dest_off,
  79                                         userptr_t src, off_t src_off,
  80                                         size_t len ) {
  81         trivial_memcpy_user ( dest, dest_off, src, src_off, len );
  82 }
  83
  84 static inline __always_inline void
  85 UACCESS_INLINE ( librm, memmove_user ) ( userptr_t dest, off_t dest_off,
  86                                          userptr_t src, off_t src_off,
  87                                          size_t len ) {
  88         trivial_memmove_user ( dest, dest_off, src, src_off, len );
  89 }
  90
  91 static inline __always_inline int
  92 UACCESS_INLINE ( librm, memcmp_user ) ( userptr_t first, off_t first_off,
  93                                         userptr_t second, off_t second_off,
  94                                         size_t len ) {
  95         return trivial_memcmp_user ( first, first_off, second, second_off, len);
  96 }
  97
  98 static inline __always_inline void
  99 UACCESS_INLINE ( librm, memset_user ) ( userptr_t buffer, off_t offset,
 100                                         int c, size_t len ) {
 101         trivial_memset_user ( buffer, offset, c, len );
 102 }
 103
 104 static inline __always_inline size_t
 105 UACCESS_INLINE ( librm, strlen_user ) ( userptr_t buffer, off_t offset ) {
 106         return trivial_strlen_user ( buffer, offset );
 107 }
 108
 109 static inline __always_inline off_t
 110 UACCESS_INLINE ( librm, memchr_user ) ( userptr_t buffer, off_t offset,
 111                                         int c, size_t len ) {
 112         return trivial_memchr_user ( buffer, offset, c, len );
 113 }
 114
 115
 116 /******************************************************************************
 117  *
 118  * Access to variables in .data16 and .text16
 119  *
 120  */
 121
 122 extern char *data16;
 123 extern char *text16;
 124
 125 #define __data16( variable )                                            \
 126         __attribute__ (( section ( ".data16" ) ))                       \
 127         _data16_ ## variable __asm__ ( #variable )
 128
 129 #define __data16_array( variable, array )                               \
 130         __attribute__ (( section ( ".data16" ) ))                       \
 131         _data16_ ## variable array __asm__ ( #variable )
 132
 133 #define __bss16( variable )                                             \
 134         __attribute__ (( section ( ".bss16" ) ))                        \
 135         _data16_ ## variable __asm__ ( #variable )
 136
 137 #define __bss16_array( variable, array )                                \
 138         __attribute__ (( section ( ".bss16" ) ))                        \
 139         _data16_ ## variable array __asm__ ( #variable )
 140
 141 #define __text16( variable )                                            \
 142         __attribute__ (( section ( ".text16.data" ) ))                  \
 143         _text16_ ## variable __asm__ ( #variable )
 144
 145 #define __text16_array( variable, array )                               \
 146         __attribute__ (( section ( ".text16.data" ) ))                  \
 147         _text16_ ## variable array __asm__ ( #variable )
 148
 149 #define __use_data16( variable )                                        \
 150         ( * ( ( typeof ( _data16_ ## variable ) * )                     \
 151               & ( data16 [ ( size_t ) & ( _data16_ ## variable ) ] ) ) )
 152
 153 #define __use_text16( variable )                                        \
 154         ( * ( ( typeof ( _text16_ ## variable ) * )                     \
 155               & ( text16 [ ( size_t ) & ( _text16_ ## variable ) ] ) ) )
 156
 157 #define __from_data16( pointer )                                        \
 158         ( ( unsigned int )                                              \
 159           ( ( ( void * ) (pointer) ) - ( ( void * ) data16 ) ) )
 160
 161 #define __from_text16( pointer )                                        \
 162         ( ( unsigned int )                                              \
 163           ( ( ( void * ) (pointer) ) - ( ( void * ) text16 ) ) )
 164
 165 /* Variables in librm.S, present in the normal data segment */
 166 extern uint16_t rm_sp;
 167 extern uint16_t rm_ss;
 168 extern uint16_t __text16 ( rm_cs );
 169 #define rm_cs __use_text16 ( rm_cs )
 170 extern uint16_t __text16 ( rm_ds );
 171 #define rm_ds __use_text16 ( rm_ds )
 172
 173 /**
 174  * Convert segment:offset address to user buffer
 175  *
 176  * @v segment           Real-mode segment
 177  * @v offset            Real-mode offset
 178  * @ret buffer          User buffer
 179  */
 180 static inline __always_inline userptr_t
 181 real_to_user ( unsigned int segment, unsigned int offset ) {
 182         return ( phys_to_user ( ( segment << 4 ) + offset ) );
 183 }
 184
 185 extern uint16_t copy_user_to_rm_stack ( userptr_t data, size_t size );
 186 extern void remove_user_from_rm_stack ( userptr_t data, size_t size );
 187
 188 /* TEXT16_CODE: declare a fragment of code that resides in .text16 */
 189 #define TEXT16_CODE( asm_code_str )                     \
 190         ".section \".text16\", \"ax\", @progbits\n\t"   \
 191         ".code16\n\t"                                   \
 192         asm_code_str "\n\t"                             \
 193         ".code32\n\t"                                   \
 194         ".previous\n\t"
 195
 196 /* REAL_CODE: declare a fragment of code that executes in real mode */
 197 #define REAL_CODE( asm_code_str )                       \
 198         "pushl $1f\n\t"                                 \
 199         "call real_call\n\t"                            \
 200         "addl $4, %%esp\n\t"                            \
 201         TEXT16_CODE ( "\n1:\n\t"                        \
 202                       asm_code_str                      \
 203                       "\n\t"                            \
 204                       "ret\n\t" )
 205
 206 /* PHYS_CODE: declare a fragment of code that executes in flat physical mode */
 207 #define PHYS_CODE( asm_code_str )                       \
 208         "call _virt_to_phys\n\t"                        \
 209         asm_code_str                                    \
 210         "call _phys_to_virt\n\t"
 211
 212 /** Number of interrupts */
 213 #define NUM_INT 256
 214
 215 /** An interrupt descriptor table register */
 216 struct idtr {
 217         /** Limit */
 218         uint16_t limit;
 219         /** Base */
 220         uint32_t base;
 221 } __attribute__ (( packed ));
 222
 223 /** An interrupt descriptor table entry */
 224 struct interrupt_descriptor {
 225         /** Low 16 bits of address */
 226         uint16_t low;
 227         /** Code segment */
 228         uint16_t segment;
 229         /** Unused */
 230         uint8_t unused;
 231         /** Type and attributes */
 232         uint8_t attr;
 233         /** High 16 bits of address */
 234         uint16_t high;
 235 } __attribute__ (( packed ));
 236
 237 /** Interrupt descriptor is present */
 238 #define IDTE_PRESENT 0x80
 239
 240 /** Interrupt descriptor 32-bit interrupt gate type */
 241 #define IDTE_TYPE_IRQ32 0x0e
 242
 243 /** An interrupt vector
 244  *
 245  * Each interrupt vector comprises an eight-byte fragment of code:
 246  *
 247  *   60                 pushal
 248  *   b0 xx              movb $INT, %al
 249  *   e9 xx xx xx xx     jmp interrupt_wrapper
 250  */
 251 struct interrupt_vector {
 252         /** "pushal" instruction */
 253         uint8_t pushal;
 254         /** "movb" instruction */
 255         uint8_t movb;
 256         /** Interrupt number */
 257         uint8_t intr;
 258         /** "jmp" instruction */
 259         uint8_t jmp;
 260         /** Interrupt wrapper address offset */
 261         uint32_t offset;
 262         /** Next instruction after jump */
 263         uint8_t next[0];
 264 } __attribute__ (( packed ));
 265
 266 /** "pushal" instruction */
 267 #define PUSHAL_INSN 0x60
 268
 269 /** "movb" instruction */
 270 #define MOVB_INSN 0xb0
 271
 272 /** "jmp" instruction */
 273 #define JMP_INSN 0xe9
 274
 275 extern void set_interrupt_vector ( unsigned int intr, void *vector );
 276
 277 #endif /* ASSEMBLY */
 278
 279 #endif /* LIBRM_H */