xref: /titanic_41/usr/src/uts/common/sys/ddifm.h (revision 602ca9ea8f9ce0933f0944601cc5d230e91a950d)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_DDIFM_H
27 #define	_DDIFM_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef	__cplusplus
32 extern "C" {
33 #endif
34 
35 #include <sys/dditypes.h>
36 #include <sys/va_list.h>
37 
38 extern int ddi_system_fmcap;
39 
40 /* Fault Management error handling */
41 
42 /* Error handling return status */
43 #define	DDI_FM_OK		0
44 #define	DDI_FM_FATAL	-1
45 #define	DDI_FM_NONFATAL	-2
46 #define	DDI_FM_UNKNOWN	-3
47 
48 /* Driver fault management capabilities */
49 #define	DDI_FM_NOT_CAPABLE	0x00000000
50 #define	DDI_FM_EREPORT_CAPABLE	0x00000001
51 #define	DDI_FM_ACCCHK_CAPABLE	0x00000002
52 #define	DDI_FM_DMACHK_CAPABLE	0x00000004
53 #define	DDI_FM_ERRCB_CAPABLE	0x00000008
54 
55 #define	DDI_FM_DEFAULT_CAP(cap)	(cap == DDI_FM_NOT_CAPABLE)
56 #define	DDI_FM_EREPORT_CAP(cap)	(cap & DDI_FM_EREPORT_CAPABLE)
57 #define	DDI_FM_ACC_ERR_CAP(cap)	(cap & DDI_FM_ACCCHK_CAPABLE)
58 #define	DDI_FM_DMA_ERR_CAP(cap)	(cap & DDI_FM_DMACHK_CAPABLE)
59 #define	DDI_FM_ERRCB_CAP(cap)	(cap & DDI_FM_ERRCB_CAPABLE)
60 
61 /* error expectation values */
62 #define	DDI_FM_ERR_UNEXPECTED	0
63 #define	DDI_FM_ERR_EXPECTED	1
64 #define	DDI_FM_ERR_POKE		2
65 #define	DDI_FM_ERR_PEEK		3
66 
67 #ifdef _KERNEL
68 
69 typedef struct ddi_fm_error {
70 	int fme_version;			/* version of this structure */
71 	int fme_status;				/* status for this error */
72 	int fme_flag;				/* error expectation flag */
73 	uint64_t fme_ena;			/* ENA for this error */
74 	ddi_acc_handle_t fme_acc_handle;	/* optional acc handle */
75 	ddi_dma_handle_t fme_dma_handle;	/* optional dma handle */
76 	void *fme_bus_specific;			/* optional bus specific err */
77 	int fme_bus_type;			/* optional bus type */
78 } ddi_fm_error_t;
79 
80 #define	DDI_FME_VER0	0
81 #define	DDI_FME_VER1	1
82 #define	DDI_FME_VERSION	DDI_FME_VER1
83 
84 #define	DDI_FME_BUS_TYPE_DFLT	0		/* bus type = default */
85 #define	DDI_FME_BUS_TYPE_PCI	1		/* bus type = pci/pcix/pcie */
86 
87 typedef int (*ddi_err_func_t)(dev_info_t *, ddi_fm_error_t *, const void *);
88 
89 /*
90  * DDI for error handling and ereport generation
91  */
92 
93 /*
94  * ereport generation: [ddi|ndi]_fm_ereport_post
95  */
96 extern void ddi_fm_ereport_post(dev_info_t *, const char *, uint64_t, int, ...);
97 extern void ndi_fm_ereport_post(dev_info_t *, const char *, uint64_t, int, ...);
98 
99 /*
100  * service changes:
101  *
102  * After a hardened driver raises an ereport (or after pci_ereport_post() has
103  * raised an ereport for an event which implecated one of a driver's access or
104  * dma handles), the driver should always determine the service impact and
105  * report it.
106  */
107 extern void ddi_fm_service_impact(dev_info_t *, int);
108 
109 /* error handling */
110 extern void ddi_fm_handler_register(dev_info_t *, ddi_err_func_t, void *);
111 extern void ddi_fm_handler_unregister(dev_info_t *);
112 
113 /* fault management initialization and clean-up */
114 extern void ddi_fm_init(dev_info_t *, int *, ddi_iblock_cookie_t *);
115 extern void ddi_fm_fini(dev_info_t *);
116 extern int ddi_fm_capable(dev_info_t *dip);
117 
118 /* access and dma handle error protection */
119 extern void ddi_fm_dma_err_get(ddi_dma_handle_t, ddi_fm_error_t *, int);
120 extern void ddi_fm_acc_err_get(ddi_acc_handle_t, ddi_fm_error_t *, int);
121 extern void ddi_fm_dma_err_clear(ddi_dma_handle_t, int);
122 extern void ddi_fm_acc_err_clear(ddi_acc_handle_t, int);
123 
124 #endif /* _KERNEL */
125 
126 #ifdef	__cplusplus
127 }
128 #endif
129 
130 #endif	/* _DDIFM_H */
131