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 .\"
  27 .Dd July 27, 1998
  28 .Os
  29 .Dt I386_VM86 2
  30 .Sh NAME
  31 .Nm i386_vm86
  32 .Nd control vm86-related functions
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In sys/types.h
  37 .In machine/sysarch.h
  38 .In machine/vm86.h
  39 .Ft int
  40 .Fn i386_vm86 "int function" "void *data"
  41 .Sh DESCRIPTION
  42 .Fn i386_vm86
  43 is used to call various vm86 related functions.
  44 .Fa function
  45 can be one of the following values:
  46 .Bl -tag -offset indent -width VM86_SET_VME
  47 .It Dv VM86_INIT
  48 This will initialize the kernel's vm86 parameter area for the
  49 process, and permit the process to make vm86 calls.
  50 .Fa data
  51 points to the following structure:
  52 .Bd -literal
  53 struct vm86_init_args {
  54         int     debug;
  55         int     cpu_type;
  56         u_char  int_map[32];
  57 };
  58 .Ed
  59 .Pp
  60 .Fa debug
  61 is used to turn on debugging code.
  62 .Fa cpu_type
  63 controls the type of CPU being emulated, and is currently unimplemented.
  64 .Fa int_map
  65 is a bitmap which determines whether vm86 interrupts should be handled
  66 in vm86 mode, or reflected back to the process.  If the
  67 .Em Nth
  68 bit is set, the interrupt will be reflected to the process, otherwise
  69 it will be dispatched by the vm86 interrupt table.
  70 .\" .It Dv VM86_SET_VME
  71 .\" .It Dv VM86_GET_VME
  72 .\" .It Dv VM86_INTCALL
  73 .El
  74 .Pp
  75 vm86 mode is entered by calling
  76 .Xr sigreturn 2
  77 with the correct machine context for vm86, and with the
  78 .Em PSL_VM
  79 bit set.  Control returns to the process upon delivery of a signal.
  80 .Sh RETURN VALUES
  81 .Rv -std i386_vm86
  82 .Sh ERRORS
  83 .Fn i386_vm86
  84 will fail if:
  85 .Bl -tag -width Er
  86 .It Bq Er EINVAL
  87 The kernel does not have vm86 support, or an invalid function was specified.
  88 .It Bq Er ENOMEM
  89 There is not enough memory to initialize the kernel data structures.
  90 .El
  91 .Sh AUTHORS
  92 This man page was written by
  93 .An Jonathan Lemon .