a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#ifndef LIBRM_H
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define LIBRM_H
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncFILE_LICENCE ( GPL2_OR_LATER );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/* Segment selectors as used in our protected-mode GDTs.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Don't change these unless you really know what you're doing.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define VIRTUAL_CS 0x08
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define VIRTUAL_DS 0x10
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define PHYSICAL_CS 0x18
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define PHYSICAL_DS 0x20
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define REAL_CS 0x28
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define REAL_DS 0x30
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#if 0
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define LONG_CS 0x38
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define LONG_DS 0x40
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#endif
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#ifndef ASSEMBLY
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#ifdef UACCESS_LIBRM
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UACCESS_PREFIX_librm
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#else
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define UACCESS_PREFIX_librm __librm_
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#endif
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/* Variables in librm.S */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern unsigned long virt_offset;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Convert physical address to user pointer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v phys_addr Physical address
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret userptr User pointer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline userptr_t
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, phys_to_user ) ( unsigned long phys_addr ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return ( phys_addr - virt_offset );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Convert user buffer to physical address
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v userptr User pointer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v offset Offset from user pointer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret phys_addr Physical address
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline unsigned long
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, user_to_phys ) ( userptr_t userptr, off_t offset ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return ( userptr + offset + virt_offset );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline userptr_t
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, virt_to_user ) ( volatile const void *addr ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return trivial_virt_to_user ( addr );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline void *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, user_to_virt ) ( userptr_t userptr, off_t offset ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return trivial_user_to_virt ( userptr, offset );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline userptr_t
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, userptr_add ) ( userptr_t userptr, off_t offset ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return trivial_userptr_add ( userptr, offset );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, memcpy_user ) ( userptr_t dest, off_t dest_off,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync userptr_t src, off_t src_off,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync size_t len ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync trivial_memcpy_user ( dest, dest_off, src, src_off, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, memmove_user ) ( userptr_t dest, off_t dest_off,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync userptr_t src, off_t src_off,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync size_t len ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync trivial_memmove_user ( dest, dest_off, src, src_off, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline void
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, memset_user ) ( userptr_t buffer, off_t offset,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync int c, size_t len ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync trivial_memset_user ( buffer, offset, c, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline size_t
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, strlen_user ) ( userptr_t buffer, off_t offset ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return trivial_strlen_user ( buffer, offset );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline off_t
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncUACCESS_INLINE ( librm, memchr_user ) ( userptr_t buffer, off_t offset,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync int c, size_t len ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return trivial_memchr_user ( buffer, offset, c, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/******************************************************************************
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Access to variables in .data16 and .text16
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern char *data16;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern char *text16;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __data16( variable ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __attribute__ (( section ( ".data16" ) )) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync _data16_ ## variable __asm__ ( #variable )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __data16_array( variable, array ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __attribute__ (( section ( ".data16" ) )) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync _data16_ ## variable array __asm__ ( #variable )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __bss16( variable ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __attribute__ (( section ( ".bss16" ) )) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync _data16_ ## variable __asm__ ( #variable )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __bss16_array( variable, array ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __attribute__ (( section ( ".bss16" ) )) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync _data16_ ## variable array __asm__ ( #variable )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __text16( variable ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __attribute__ (( section ( ".text16.data" ) )) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync _text16_ ## variable __asm__ ( #variable )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __text16_array( variable, array ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __attribute__ (( section ( ".text16.data" ) )) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync _text16_ ## variable array __asm__ ( #variable )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __use_data16( variable ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( * ( ( typeof ( _data16_ ## variable ) * ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync & ( data16 [ ( size_t ) & ( _data16_ ## variable ) ] ) ) )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __use_text16( variable ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( * ( ( typeof ( _text16_ ## variable ) * ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync & ( text16 [ ( size_t ) & ( _text16_ ## variable ) ] ) ) )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __from_data16( pointer ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( ( unsigned int ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( ( ( void * ) (pointer) ) - ( ( void * ) data16 ) ) )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define __from_text16( pointer ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( ( unsigned int ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( ( ( void * ) (pointer) ) - ( ( void * ) text16 ) ) )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/* Variables in librm.S, present in the normal data segment */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern uint16_t rm_sp;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern uint16_t rm_ss;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern uint16_t __data16 ( rm_cs );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define rm_cs __use_data16 ( rm_cs )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern uint16_t __text16 ( rm_ds );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define rm_ds __use_text16 ( rm_ds )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/**
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Convert segment:offset address to user buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync *
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v segment Real-mode segment
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v offset Real-mode offset
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret buffer User buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline __always_inline userptr_t
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncreal_to_user ( unsigned int segment, unsigned int offset ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return ( phys_to_user ( ( segment << 4 ) + offset ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync}
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern uint16_t copy_user_to_rm_stack ( userptr_t data, size_t size );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncextern void remove_user_from_rm_stack ( userptr_t data, size_t size );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/* TEXT16_CODE: declare a fragment of code that resides in .text16 */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define TEXT16_CODE( asm_code_str ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ".section \".text16\", \"ax\", @progbits\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ".code16\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync asm_code_str "\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ".code32\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ".previous\n\t"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/* REAL_CODE: declare a fragment of code that executes in real mode */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define REAL_CODE( asm_code_str ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "pushl $1f\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "call real_call\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "addl $4, %%esp\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync TEXT16_CODE ( "\n1:\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync asm_code_str \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "ret\n\t" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/* PHYS_CODE: declare a fragment of code that executes in flat physical mode */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#define PHYS_CODE( asm_code_str ) \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "call _virt_to_phys\n\t" \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync asm_code_str \
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "call _phys_to_virt\n\t"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#endif /* ASSEMBLY */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync#endif /* LIBRM_H */