xref: /illumos-gate/usr/src/lib/scsi/plugins/ses/libses/common/libses.h (revision 3d393ee6c37fa10ac512ed6d36109ad616dc7c1a)
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 /*
23  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_FRAMEWORK_LIBSES_H
28 #define	_FRAMEWORK_LIBSES_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 /*
37  * These are properties attached to the root target node of the enclosure, and
38  * represent the SCSI inquiry data.
39  */
40 #define	SCSI_PROP_VENDOR		"scsi-inquiry-vendor"
41 #define	SCSI_PROP_PRODUCT		"scsi-inquiry-product"
42 #define	SCSI_PROP_REVISION		"scsi-inquiry-revision"
43 
44 /*
45  * This property provides a human-readable name for the element type.  This is
46  * constant, and not derived from the enclosure data.
47  */
48 #define	LIBSES_PROP_ELEMENT_TYPE_NAME	"libses-element-type-name"
49 
50 /*
51  * The following properties can be added to any node.  There is no provision in
52  * the specification for these properties, but they can be derived from vendor
53  * specific data for some enclosures.
54  */
55 #define	LIBSES_PROP_PART		"libses-part-number"
56 #define	LIBSES_PROP_SERIAL		"libses-serial-number"
57 
58 /*
59  * The chassis serial number is a pseudo property that doesn't exist in SES
60  * spec.  A single physical chassis may present several logically different SES
61  * targets that are connected to the same or different elements.  These targets
62  * can extract the chassis serial number in a vendor-specific way so that
63  * consumers know these SES targets refer to the same device.  This defaults to
64  * to the logical-id, and is always present.
65  */
66 #define	LIBSES_EN_PROP_CSN		"libses-chassis-serial"
67 
68 /*
69  * This boolean property identifies a chassis as internal, where the connected
70  * elements are part of a single system chassis and not an external enclosure.
71  * This is used on platforms with a disk backplane that exports a SES target.
72  */
73 #define	LIBSES_EN_PROP_INTERNAL		"libses-internal"
74 
75 #ifdef	__cplusplus
76 }
77 #endif
78 
79 #endif	/* _FRAMEWORK_LIBSES_H */
80