usr/src/man/man9f/ptob.9f

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\"  Copyright (c) 2006, Sun Microsystems, Inc.,  All Rights Reserved
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH PTOB 9F "Jan 16, 2006"
   8 .SH NAME
   9 ptob \- convert size in pages to size in bytes
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/ddi.h>
  14
  15
  16
  17 \fBunsigned long\fR \fBptob\fR(\fBunsigned long\fR \fInumpages\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Architecture independent level 1 (DDI/DKI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fInumpages\fR\fR
  29 .ad
  30 .RS 12n
  31 Size in number of pages to convert to size in bytes.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 This function returns the number of bytes that are contained in the specified
  38 number of pages. For example, if the page size is 2048, then \fBptob(2)\fR
  39 returns \fB4096\fR. \fBptob(0)\fR returns \fB0\fR.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 The return value is always the number of bytes in the specified number of
  44 pages. There are no invalid input values, and no checking will be performed for
  45 overflow in the case of a page count whose corresponding byte count cannot be
  46 represented by an \fBunsigned long\fR. Rather, the higher order bits will be
  47 ignored.
  48 .SH CONTEXT
  49 .sp
  50 .LP
  51 The \fBptob()\fR function can be called from user, interrupt, or kernel
  52 context.
  53 .SH SEE ALSO
  54 .sp
  55 .LP
  56 \fBbtop\fR(9F), \fBbtopr\fR(9F), \fBddi_ptob\fR(9F)
  57 .sp
  58 .LP
  59 \fIWriting Device Drivers\fR