usr/src/man/man9f/bzero.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 BZERO 9F "Jan 16, 2006"
   8 .SH NAME
   9 bzero \- clear memory for a given number of bytes
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/types.h>
  14 #include <sys/ddi.h>
  15
  16
  17
  18 \fBvoid\fR \fBbzero\fR(\fBvoid *\fR\fIaddr\fR, \fBsize_t\fR \fIbytes\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Architecture independent level 1 (DDI/DKI).
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIaddr\fR\fR
  30 .ad
  31 .RS 9n
  32 Starting virtual address of memory to be cleared.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIbytes\fR\fR
  39 .ad
  40 .RS 9n
  41 The number of bytes to clear starting at \fIaddr\fR.
  42 .RE
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 The \fBbzero()\fR function clears a contiguous portion of memory by filling it
  48 with zeros.
  49 .SH CONTEXT
  50 .sp
  51 .LP
  52 The \fBbzero()\fR function can be called from user, interrupt, or kernel
  53 context.
  54 .SH SEE ALSO
  55 .sp
  56 .LP
  57 \fBbcopy\fR(9F), \fBclrbuf\fR(9F), \fBkmem_zalloc\fR(9F)
  58 .sp
  59 .LP
  60 \fIWriting Device Drivers\fR
  61 .SH WARNINGS
  62 .sp
  63 .LP
  64 The address range specified must be within the kernel space. No range checking
  65 is done.  If an address outside of the kernel space is selected, the driver may
  66 corrupt the system in an unpredictable way.