share/man/man9f/ldi_dump.9f

   1 '\" te
   2 .\"  Copyright (c) 2003, 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 LDI_DUMP 9F "Jun 3, 2003"
   7 .SH NAME
   8 ldi_dump \- Issue a dump request to a device
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/sunldi.h>
  13
  14 \fBint\fR \fBldi_dump\fR(\fBldi_handle_t\fR \fIlh\fR, \fBcaddr_t addr, daddr_t\fR\fI blkno\fR, \fB int\fR \fInblk\fR);
  15 .fi
  16
  17 .SH PARAMETERS
  18 .sp
  19 .ne 2
  20 .na
  21 \fB\fIlh\fR \fR
  22 .ad
  23 .RS 10n
  24 Layered handle.
  25 .RE
  26
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIaddr\fR \fR
  31 .ad
  32 .RS 10n
  33 Area dump address.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIblkno\fR \fR
  40 .ad
  41 .RS 10n
  42 Block offset to dump memory.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fInblk\fR \fR
  49 .ad
  50 .RS 10n
  51 Number of blocks to dump.
  52 .RE
  53
  54 .SH DESCRIPTION
  55 .sp
  56 .LP
  57 The \fBldi_dump()\fR function passes a dump request to the device entry point
  58 specified by the layered handle. This operation is supported for block devices.
  59 .SH RETURN VALUES
  60 .sp
  61 .LP
  62 The \fBldi_dump()\fR function returns \fB0\fR upon success. If a failure occurs
  63 before the request is passed on to the device, the possible return values are
  64 shown below. Otherwise any other error number may be returned by the device.
  65 .sp
  66 .ne 2
  67 .na
  68 \fBEINVAL\fR
  69 .ad
  70 .RS 11n
  71 Invalid input parameters.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fBENOTSUP\fR
  78 .ad
  79 .RS 11n
  80 Operation is not supported for this device.
  81 .RE
  82
  83 .SH CONTEXT
  84 .sp
  85 .LP
  86 These functions may be called from user or kernel context.