'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\" 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]
.TH ddi_fm_init 9F "14 May 2007" "SunOS 5.11" "Kernel Functions for Drivers"
.SH NAME
ddi_fm_init, ddi_fm_fini, ddi_fm_capable \- initialize and get the FM
capabilities for a device instance
.SH SYNOPSIS
.LP
.nf
#include <sys/ddifm.h>

\fBvoid\fR \fBddi_fm_init\fR(\fBdev_info_t\fR *\fIdip\fR, \fBint\fR *\fIfm_capability\fR,
     \fBddi_iblock_cookie_t\fR *\fIibcp\fR);
.fi

.LP
.nf
\fBvoid\fR \fBddi_fm_fini\fR(\fBdev_info_t\fR *\fIdip\fR);
.fi

.LP
.nf
\fBint\fR \fBddi_fm_capable\fR(\fBdev_info_t\fR *\fIdip\fR, \fBint\fR *\fIfm_capability\fR);
.fi

.SH INTERFACE LEVEL
.sp
.LP
Solaris DDI specific (Solaris DDI)
.SH PARAMETERS
.sp
.LP
\fBddi_fm_init()\fR
.sp
.ne 2
.mk
.na
\fB\fIdip\fR\fR
.ad
.RS 17n
.rt  
Pointer to the \fBdev_info\fR structure
.RE

.sp
.ne 2
.mk
.na
\fB\fIfm_capability\fR\fR
.ad
.RS 17n
.rt  
Fault Management capability bit mask
.RE

.sp
.ne 2
.mk
.na
\fB\fIibcp\fR\fR
.ad
.RS 17n
.rt  
Pointer to where the interrupt block cookie should be returned.
.RE

.SH DESCRIPTION
.sp
.LP
A device driver can declare its fault management capabilities to the \fBI/O\fR
Fault Management framework by calling \fBddi_fm_init()\fR. The
\fBddi_fm_init()\fR function allocates and initializes resources according to
the bitwise-inclusive-OR of the fault management capabilities, described in the
following and supported by the driver's immediate nexus parent.
.sp
.ne 2
.mk
.na
\fB\fBDDI_FM_NOT_CAPABLE\fR\fR
.ad
.RS 26n
.rt  
The driver does not support any \fBFMA\fR features. This is the default value
assigned to device drivers.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDDI_FM_EREPORT_CAPABLE\fR\fR
.ad
.RS 26n
.rt  
The driver generates \fBFMA\fR protocol error events (\fBereports\fR) upon the
detection of an error condition.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDDI_FM_ACCCHK_CAPABLE\fR\fR
.ad
.RS 26n
.rt  
The driver checks for errors upon the completion of one or more access
\fBI/O\fR transactions.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDDI_FM_DMACHK_CAPABLE\fR\fR
.ad
.RS 26n
.rt  
The driver checks for errors upon the completion of one or more \fBDMA\fR
\fBI/O\fR transactions.
.RE

.sp
.ne 2
.mk
.na
\fB\fBDDI_FM_ERRCB_CAPABLE\fR\fR
.ad
.RS 26n
.rt  
The driver is capable of error handler callback registration.
.RE

.sp
.LP
If the parent nexus is not capable of supporting any one of the requested
capabilities, the associated bit will not be set and returned as such to the
driver. Before returning from \fBddi_fm_init()\fR, the \fBI/O\fR Fault
Management framework creates a set of fault management capability properties:
\fBfm-ereport-capable\fR, \fBfm-errcb-capable\fR, \fBfm-accchk-capable\fR, and
\fBfm-dmachk-capable\fR. The current supported fault management capability
levels are observable via \fBprtconf\fR(1M).
.sp
.LP
A driver can support the administrative selection of fault management
capabilities by exporting and setting a fault management capability level
property in its \fBdriver.conf\fR(4) file to the values described above. The
\fBfm_capable\fR properties must be set and read prior to calling
\fBddi_fm_init()\fR with the desired capability list.
.sp
.ne 2
.mk
.na
\fB\fBddi_fm_fini()\fR\fR
.ad
.RS 17n
.rt  
This function cleans up resources allocated to support fault management for the
\fIdip\fR structure.
.RE

.sp
.ne 2
.mk
.na
\fB\fBddi_fm_capable()\fR\fR
.ad
.RS 20n
.rt  
This function returns the capability bit mask currently set for the \fIdip\fR
structure.
.RE

.SH CONTEXT
.sp
.LP
These functions can be called from kernel context in a driver \fBattach\fR(9E)
or \fBdetach\fR(9E) operation.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
.TE

.SH SEE ALSO
.sp
.LP
\fBprtconf\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5), \fBattach\fR(9E),
\fBdetach\fR(9E)
.sp
.LP
\fIWriting Device Drivers\fR