usr/src/man/man9f/ddi_fm_service_impact.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_SERVICE_IMPACT 9F "Mar 13, 2016"
   7 .SH NAME
   8 ddi_fm_service_impact \- report the impact of an error
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddifm.h>
  13
  14 \fBvoid\fR \fBddi_fm_service_impact\fR(\fBdev_info_t\fR *\fIdip\fR, \fBint\fR \fIimpact\fR);
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .LP
  19 Solaris DDI specific (Solaris DDI)
  20 .SH PARAMETERS
  21 .ne 2
  22 .na
  23 \fB\fIdip\fR\fR
  24 .ad
  25 .RS 10n
  26 Pointer to the \fBdev_info\fR structure
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIimpact\fR\fR
  33 .ad
  34 .RS 10n
  35 Impact of error
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .LP
  40 The following service impact values are accepted by
  41 \fBddi_fm_service_impact()\fR:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBDDI_SERVICE_LOST\fR\fR
  46 .ad
  47 .RS 26n
  48 The service provided by the device is unavailable due to an error. The
  49 operational state of the device will transition to \fBDEVI_DEVICE_DOWN\fR.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBDDI_SERVICE_DEGRADED\fR\fR
  56 .ad
  57 .RS 26n
  58 The driver is unable to provide normal service, but it can provide a partial or
  59 degraded level of service. The driver might have to make repeated attempts to
  60 perform an operation before it succeeds, or it may be running at less than its
  61 configured speed. A driver may use this value to indicate that an alternative
  62 device should be used if available, but that it can continue operation if no
  63 alternative exists. The operational state of the device will transition to
  64 \fBDEVI_DEVICE_DEGRADED\fR.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBDDI_SERVICE_RESTORED\fR\fR
  71 .ad
  72 .RS 26n
  73 The service provided by the device has been restored. The operational state of
  74 the device will transition to its pre-error condition state and
  75 \fBDEVI_DEVICE_DOWN\fR or \fBDEVI_DEVICE_DEGRADED\fR is removed.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBDDI_SERVICE_UNAFFECTED\fR\fR
  82 .ad
  83 .RS 26n
  84 The service provided by the device was unaffected by the error.
  85 .RE
  86
  87 .SH CONTEXT
  88 .LP
  89 The \fBddi_fm_service_impact()\fR function can be called from user, kernel, or
  90 high-level interrupt context.
  91 .SH ATTRIBUTES
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     Committed
 104 .TE
 105
 106 .SH SEE ALSO
 107 .LP
 108 \fBfmd\fR(1M), \fBattributes\fR(5), \fBddi_fm_ereport_post\fR(9F),
 109 \fBpci_ereport_post\fR(9F)