share/man/man9f/ddi_fm_acc_err_clear.9f

   1 '\" te
   2 .\" Copyright (c) 2007, 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 DDI_FM_ACC_ERR_CLEAR 9F "May 10, 2007"
   7 .SH NAME
   8 ddi_fm_acc_err_clear, ddi_fm_dma_err_clear \- clear the error status for an
   9 access or DMA handle
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/ndifma.h>
  14
  15 \fBvoid\fR \fBddi_fm_acc_err_clear\fR(\fBddi_acc_handle_t\fR \fIacc_handle\fR,
  16      \fBint\fR \fIversion\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fBddi_fm_dma_err_clear\fR(\fBddi_dma_handle_t\fR \fIdma_handle\fR,
  22      \fBint\fR \fIversion\fR);
  23 .fi
  24
  25 .SH INTERFACE LEVEL
  26 .sp
  27 .LP
  28 Solaris DDI specific (Solaris DDI)
  29 .SH PARAMETERS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIacc_handle\fR\fR
  34 .ad
  35 .RS 14n
  36 Data access handle obtained from a previous call to
  37 \fBddi_regs_map_setup\fR(9F), \fBddi_dma_mem_alloc\fR(9F), or to a similar
  38 function.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIdma_handle\fR\fR
  45 .ad
  46 .RS 14n
  47 \fBDMA\fR handle obtained from a previous call to \fBddi_dma_mem_alloc\fR(9F)
  48 or one of its derivatives.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIversion\fR\fR
  55 .ad
  56 .RS 14n
  57 Version number of \fBddi_fm_error_t\fR.
  58 .RE
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 The \fBddi_fm_dma_err_clear()\fR and \fBddi_fm_acc_err_clear()\fR functions
  64 clear the error status of a \fBDMA\fR or access handle respectively.
  65 .sp
  66 .LP
  67 Once cleared, the driver is again able to access the mapped registers or memory
  68 using programmed \fBI/O\fR through the handle.
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Committed
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBattributes\fR(5), \fBddi_dma_mem_alloc\fR(9F), \fBddi_fm_acc_err_get\fR(9F),
  89 \fBddi_fm_dma_err_get\fR(9F), \fBddi_regs_map_setup\fR(9F)
  90 .sp
  91 .LP
  92 \fIWriting Device Drivers\fR