xref: /titanic_41/usr/src/uts/common/sys/ddifm.h (revision 15d9d0b528387242011cdcc6190c9e598cfe3a07)
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 2006 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 
37 extern int ddi_system_fmcap;
38 
39 /* Fault Management error handling */
40 
41 /* Error handling return status */
42 #define	DDI_FM_OK		0
43 #define	DDI_FM_FATAL	-1
44 #define	DDI_FM_NONFATAL	-2
45 #define	DDI_FM_UNKNOWN	-3
46 
47 /* Driver fault management capabilities */
48 #define	DDI_FM_NOT_CAPABLE	0x00000000
49 #define	DDI_FM_EREPORT_CAPABLE	0x00000001
50 #define	DDI_FM_ACCCHK_CAPABLE	0x00000002
51 #define	DDI_FM_DMACHK_CAPABLE	0x00000004
52 #define	DDI_FM_ERRCB_CAPABLE	0x00000008
53 
54 #define	DDI_FM_DEFAULT_CAP(cap)	(cap == DDI_FM_NOT_CAPABLE)
55 #define	DDI_FM_EREPORT_CAP(cap)	(cap & DDI_FM_EREPORT_CAPABLE)
56 #define	DDI_FM_ACC_ERR_CAP(cap)	(cap & DDI_FM_ACCCHK_CAPABLE)
57 #define	DDI_FM_DMA_ERR_CAP(cap)	(cap & DDI_FM_DMACHK_CAPABLE)
58 #define	DDI_FM_ERRCB_CAP(cap)	(cap & DDI_FM_ERRCB_CAPABLE)
59 
60 /* error expectation values */
61 #define	DDI_FM_ERR_UNEXPECTED	0
62 #define	DDI_FM_ERR_EXPECTED	1
63 #define	DDI_FM_ERR_POKE		2
64 #define	DDI_FM_ERR_PEEK		3
65 
66 #ifdef _KERNEL
67 
68 typedef struct ddi_fm_error {
69 	int fme_version;			/* version of this structure */
70 	int fme_status;				/* status for this error */
71 	int fme_flag;				/* error expectation flag */
72 	uint64_t fme_ena;			/* ENA for this error */
73 	ddi_acc_handle_t fme_acc_handle;	/* optional acc handle */
74 	ddi_dma_handle_t fme_dma_handle;	/* optional dma handle */
75 	void *fme_bus_specific;			/* optional bus specific err */
76 	int fme_bus_type;			/* optional bus type */
77 } ddi_fm_error_t;
78 
79 #define	DDI_FME_VER0	0
80 #define	DDI_FME_VER1	1
81 #define	DDI_FME_VERSION	DDI_FME_VER1
82 
83 #define	DDI_FME_BUS_TYPE_DFLT	0		/* bus type = default */
84 #define	DDI_FME_BUS_TYPE_PCI	1		/* bus type = pci/pcix/pcie */
85 
86 typedef int (*ddi_err_func_t)(dev_info_t *, ddi_fm_error_t *, const void *);
87 
88 /*
89  * DDI for error handling and ereport generation
90  */
91 
92 /* ereporting and service changes */
93 extern void ddi_fm_ereport_post(dev_info_t *, const char *, uint64_t, int, ...);
94 
95 /*
96  * After a hardened driver raises an ereport (or after pci_ereport_post() has
97  * raised an ereport for an event which implecated one of a driver's access or
98  * dma handles), the driver should always determine the service impact and
99  * report it.
100  */
101 extern void ddi_fm_service_impact(dev_info_t *, int);
102 
103 /* error handling */
104 extern void ddi_fm_handler_register(dev_info_t *, ddi_err_func_t, void *);
105 extern void ddi_fm_handler_unregister(dev_info_t *);
106 
107 /* fault management initialization and clean-up */
108 extern void ddi_fm_init(dev_info_t *, int *, ddi_iblock_cookie_t *);
109 extern void ddi_fm_fini(dev_info_t *);
110 extern int ddi_fm_capable(dev_info_t *dip);
111 
112 /* access and dma handle error protection */
113 extern void ddi_fm_dma_err_get(ddi_dma_handle_t, ddi_fm_error_t *, int);
114 extern void ddi_fm_acc_err_get(ddi_acc_handle_t, ddi_fm_error_t *, int);
115 extern void ddi_fm_dma_err_clear(ddi_dma_handle_t, int);
116 extern void ddi_fm_acc_err_clear(ddi_acc_handle_t, int);
117 
118 #endif /* _KERNEL */
119 
120 #ifdef	__cplusplus
121 }
122 #endif
123 
124 #endif	/* _DDIFM_H */
125