share/man/man9f/rmallocmap.9f

   1 '\" te
   2 .\"  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH RMALLOCMAP 9F "Nov 20, 1996"
   7 .SH NAME
   8 rmallocmap, rmallocmap_wait, rmfreemap \- allocate and free resource maps
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBstruct map *\fR\fBrmallocmap\fR(\fBsize_t\fR \fImapsize\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBstruct map *\fR\fBrmallocmap_wait\fR(\fBsize_t\fR \fImapsize\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBvoid\fR \fBrmfreemap\fR(\fBstruct map *\fR\fImp\fR);
  28 .fi
  29
  30 .SH INTERFACE LEVEL
  31 .sp
  32 .LP
  33 Architecture independent level 1 (\fBDDI/DKI\fR).
  34 .SH PARAMETERS
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fImapsize\fR \fR
  39 .ad
  40 .RS 12n
  41 Number of entries for the map.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fImp\fR \fR
  48 .ad
  49 .RS 12n
  50 A pointer to the map structure to be deallocated.
  51 .RE
  52
  53 .SH DESCRIPTION
  54 .sp
  55 .LP
  56 \fBrmallocmap()\fR dynamically allocates a resource map structure. The argument
  57 \fImapsize\fR defines the total number of entries in the map.  In  particular,
  58 it is the total number of allocations that can be outstanding at any one time.
  59 .sp
  60 .LP
  61 \fBrmallocmap()\fR initializes the map but does not associate it with the
  62 actual resource. In order to associate  the map with the actual resource, a
  63 call to \fBrmfree\fR(9F) is used to make the entirety of the actual resource
  64 available for allocation, starting from the first index into the resource.
  65 Typically, the call to \fBrmallocmap()\fR is followed by a call to
  66 \fBrmfree\fR(9F), passing the address of the map returned from
  67 \fBrmallocmap()\fR, the total size of the resource, and the first index into
  68 the actual resource.
  69 .sp
  70 .LP
  71 The resource map allocated by \fBrmallocmap()\fR can be used to describe an
  72 arbitrary resource in whatever allocation units are appropriate, such as
  73 blocks, pages, or data structures. This resource can then be managed by the
  74 system by subsequent calls to  \fBrmalloc\fR(9F), \fBrmalloc_wait\fR(9F), and
  75 \fBrmfree\fR(9F).
  76 .sp
  77 .LP
  78 \fBrmallocmap_wait()\fR is similar to  \fBrmallocmap()\fR, with the exception
  79 that it will wait for space to become available if necessary.
  80 .sp
  81 .LP
  82 \fBrmfreemap()\fR deallocates a resource map structure previously allocated by
  83 \fBrmallocmap()\fR or \fBrmallocmap_wait()\fR. The argument \fImp\fR is a
  84 pointer to the map structure to be deallocated.
  85 .SH RETURN VALUES
  86 .sp
  87 .LP
  88 Upon successful completion, \fBrmallocmap()\fR and  \fBrmallocmap_wait()\fR
  89 return a pointer to the newly allocated map structure. Upon failure,
  90 \fBrmallocmap()\fR returns a  \fBNULL\fR pointer.
  91 .SH CONTEXT
  92 .sp
  93 .LP
  94 \fBrmallocmap()\fR and \fBrmfreemap()\fR can be called from user, kernel, or
  95 interrupt context.
  96 .sp
  97 .LP
  98 \fBrmallocmap_wait()\fR can only be called from user or kernel context.
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBrmalloc\fR(9F), \fBrmalloc_wait\fR(9F), \fBrmfree\fR(9F)
 103 .sp
 104 .LP
 105 \fIWriting Device Drivers\fR