manual/LDP_man-pages/original/man2/outb.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (c) 1995 Paul Gortmaker
   4 .\" (gpg109@rsphy1.anu.edu.au)
   5 .\" Wed Nov 29 10:58:54 EST 1995
   6 .\"
   7 .\" This is free documentation; you can redistribute it and/or
   8 .\" modify it under the terms of the GNU General Public License as
   9 .\" published by the Free Software Foundation; either version 2 of
  10 .\" the License, or (at your option) any later version.
  11 .\"
  12 .\" The GNU General Public License's references to "object code"
  13 .\" and "executables" are to be interpreted as the output of any
  14 .\" document formatting or typesetting system, including
  15 .\" intermediate and printed output.
  16 .\"
  17 .\" This manual is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, write to the Free
  24 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  25 .\" USA.
  26 .\"
  27 .\"
  28 .TH OUTB 2 1995-11-29 "Linux" "Linux Programmer's Manual"
  29 .SH NAME
  30 outb, outw, outl, outsb, outsw, outsl,
  31 inb, inw, inl, insb, insw, insl,
  32 outb_p, outw_p, outl_p, inb_p, inw_p, inl_p \- port I/O
  33 .SH DESCRIPTION
  34 This family of functions is used to do low-level port input and output.
  35 The out* functions do port output, the in* functions do port input;
  36 the b-suffix functions are byte-width and the w-suffix functions
  37 word-width; the _p-suffix functions pause until the I/O completes.
  38 .LP
  39 They are primarily designed for internal kernel use,
  40 but can be used from user space.
  41 .\" , given the following information
  42 .\" in addition to that given in
  43 .\" .BR outb (9).
  44
  45 You compile with \fB\-O\fP or \fB\-O2\fP or similar.
  46 The functions
  47 are defined as inline macros, and will not be substituted in without
  48 optimization enabled, causing unresolved references at link time.
  49
  50 You use
  51 .BR ioperm (2)
  52 or alternatively
  53 .BR iopl (2)
  54 to tell the kernel to allow the user space application to access the
  55 I/O ports in question.
  56 Failure to do this will cause the application
  57 to receive a segmentation fault.
  58 .SH "CONFORMING TO"
  59 .BR outb ()
  60 and friends are hardware-specific.
  61 The
  62 .I value
  63 argument is passed first and the
  64 .I port
  65 argument is passed second,
  66 which is the opposite order from most DOS implementations.
  67 .SH "SEE ALSO"
  68 .BR ioperm (2),
  69 .BR iopl (2)