man/man9f/ddi_btop.9f

         te
 Copyright (c) 2006, Sun Microsystems, Inc.
 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.
 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.
 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]
 DDI_BTOP 9F "Jan 16, 2006"
 NAME
ddi_btop, ddi_btopr, ddi_ptob - page size conversions
 SYNOPSIS

#include <sys/ddi.h>
#include <sys/sunddi.h>


unsigned long ddi_btop(dev_info_t *dip, unsigned long bytes);


unsigned long ddi_btopr(dev_info_t *dip, unsigned long bytes);


unsigned long ddi_ptob(dev_info_t *dip, unsigned long pages);


 INTERFACE LEVEL

Solaris DDI specific (Solaris DDI).
 DESCRIPTION

This set of routines use the parent nexus driver to perform conversions in page
size units.

The ddi_btop() function converts the given number of bytes to the number
of memory pages that it corresponds to, rounding down in the case that the byte
count is not a page multiple.

The ddi_btopr() function converts the given number of bytes to the number
of memory pages that it corresponds to, rounding up in the case that the byte
count is not a page multiple.

The ddi_ptob() function converts the given number of pages to the number
of bytes that it corresponds to.

Because bus nexus may possess their own hardware address translation
facilities, these routines should be used in preference to the corresponding
DDI/DKI routines btop(9F), btopr(9F), and ptob(9F), which
only deal in terms of the pagesize of the main system MMU.
 RETURN VALUES

The ddi_btop() and ddi_btopr() functions return the number of
corresponding pages. ddi_ptob() returns the corresponding number of
bytes. There are no error return values.
 CONTEXT

This function can be called from user, interrupt, or kernel context.
 EXAMPLES

Example 1 Find the size (in bytes) of one page
pagesize = ddi_ptob(dip, 1L);


 SEE ALSO

btop(9F), btopr(9F), ptob(9F)

Writing Device Drivers