lib/libarch/i386/i386_vm86.2

   1 .\"     $NetBSD: i386_vm86.2,v 1.12 2003/09/11 19:19:31 christos Exp $
   2 .\"
   3 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by John Kohl.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\"     from: @(#)fork.2        6.5 (Berkeley) 3/10/91
  31 .\"
  32 .Dd February 20, 1996
  33 .Dt I386_VM86 2 i386
  34 .Os
  35 .Sh NAME
  36 .Nm i386_vm86
  37 .Nd set virtual 8086 processor registers and mode
  38 .Sh LIBRARY
  39 .Lb libi386
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In signal.h
  43 .In machine/mcontext.h
  44 .In machine/segments.h
  45 .In machine/sysarch.h
  46 .In machine/vm86.h
  47 .Ft int
  48 .Fn i386_vm86 "struct vm86_struct *vmcp"
  49 .Sh DESCRIPTION
  50 .Fn i386_vm86
  51 will set the process into virtual 8086 mode using the registers and
  52 selectors specified by the context pointed to by
  53 .Ar vmcp .
  54 The processor registers are set from
  55 .Ar vmcp-\*[Gt]substr.regs ,
  56 and the emulated processor type from
  57 .Ar vmcp-\*[Gt]substr.ss_cpu_type .
  58 .Pp
  59 The kernel keeps a pointer to the context, and uses the tables stored at
  60 .Ar vmcp-\*[Gt]int_byuser
  61 and
  62 .Ar vmcp-\*[Gt]int21_byuser
  63 for fast virtual interrupt handling.
  64 If the
  65 .Ar n th
  66 bit is clear in the first of these arrays,
  67 then the kernel may directly emulate the real-mode x86 INT
  68 .Ar n
  69 instruction handling.
  70 If the
  71 .Ar n
  72 th bit is set, then the process is
  73 delivered a signal when an INT instruction is executed.
  74 .Pp
  75 Since MS-DOS puts many DOS functions onto interrupt 21, it is handled
  76 specially:  the
  77 .Ar k
  78 th bit in the
  79 .Ar vmcp-\*[Gt]int21_byuser
  80 array is checked when INT
  81 .Ar 21
  82 is requested and the
  83 .Ar ah
  84 register is
  85 .Ar k .
  86 .Sh RETURN VALUES
  87 This routine does not normally return: 32-bit mode will be restored by
  88 the delivery of a signal to the process.
  89 In case of an error in setting
  90 the VM86 mode, a value of \-1 is returned and the global variable
  91 .Va errno
  92 is set to indicate the error.
  93 .Sh ERRORS
  94 .Fn i386_vm86
  95 will fail if:
  96 .Bl -tag -width [EINVAL]
  97 .It Bq Er EFAULT
  98 The state at
  99 .Ar vmcp
 100 was not readable to the user process.
 101 .El
 102 .Sh REFERENCES
 103 i386 Microprocessor Programmer's Reference Manual, Intel