lib/libc/i386/sys/i386_vm86.2

   1 .\" Copyright (c) 1998 Jonathan Lemon
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc/i386/sys/i386_vm86.2,v 1.3.2.6 2001/12/14 18:33:54 ru Exp $
  26 .\" $DragonFly: src/lib/libc/i386/sys/i386_vm86.2,v 1.2 2003/06/17 04:26:43 dillon Exp $
  27 .\"
  28 .Dd July 27, 1998
  29 .Os
  30 .Dt I386_VM86 2
  31 .Sh NAME
  32 .Nm i386_vm86
  33 .Nd control vm86-related functions
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In machine/sysarch.h
  39 .In machine/vm86.h
  40 .Ft int
  41 .Fn i386_vm86 "int function" "void *data"
  42 .Sh DESCRIPTION
  43 .Fn i386_vm86
  44 is used to call various vm86 related functions.
  45 .Fa function
  46 can be one of the following values:
  47 .Bl -tag -offset indent -width VM86_SET_VME
  48 .It Dv VM86_INIT
  49 This will initialize the kernel's vm86 parameter area for the
  50 process, and permit the process to make vm86 calls.
  51 .Fa data
  52 points to the following structure:
  53 .Bd -literal
  54 struct vm86_init_args {
  55         int     debug;
  56         int     cpu_type;
  57         u_char  int_map[32];
  58 };
  59 .Ed
  60 .Pp
  61 .Fa debug
  62 is used to turn on debugging code.
  63 .Fa cpu_type
  64 controls the type of CPU being emulated, and is currently unimplemented.
  65 .Fa int_map
  66 is a bitmap which determines whether vm86 interrupts should be handled
  67 in vm86 mode, or reflected back to the process.  If the
  68 .Em Nth
  69 bit is set, the interrupt will be reflected to the process, otherwise
  70 it will be dispatched by the vm86 interrupt table.
  71 .\" .It Dv VM86_SET_VME
  72 .\" .It Dv VM86_GET_VME
  73 .\" .It Dv VM86_INTCALL
  74 .El
  75 .Pp
  76 vm86 mode is entered by calling
  77 .Xr sigreturn 2
  78 with the correct machine context for vm86, and with the
  79 .Em PSL_VM
  80 bit set.  Control returns to the process upon delivery of a signal.
  81 .Sh RETURN VALUES
  82 .Rv -std i386_vm86
  83 .Sh ERRORS
  84 .Fn i386_vm86
  85 will fail if:
  86 .Bl -tag -width Er
  87 .It Bq Er EINVAL
  88 The kernel does not have vm86 support, or an invalid function was specified.
  89 .It Bq Er ENOMEM
  90 There is not enough memory to initialize the kernel data structures.
  91 .El
  92 .Sh AUTHORS
  93 This man page was written by
  94 .An Jonathan Lemon .