xref: /illumos-gate/usr/src/lib/fm/topo/modules/common/disk/disk.h (revision dd51520e127b452179a2ce4ea3bd8dee949f9afe)
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 (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  */
25 
26 #ifndef _DISK_H
27 #define	_DISK_H
28 
29 #include <fm/topo_mod.h>
30 #include <libdevinfo.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /* Topo plugin version */
37 #define	DISK_VERSION			TOPO_VERSION
38 
39 /* Max. number of devices for thumper */
40 #define	DEVID_MAX		48
41 
42 /* Properties added to the "storage" pgroup: */
43 #define	TOPO_PGROUP_STORAGE		"storage"
44 #define	TOPO_STORAGE_LOGICAL_DISK_NAME	"logical-disk"
45 #define	TOPO_STORAGE_MODEL		"model"
46 #define	TOPO_STORAGE_MANUFACTURER	"manufacturer"
47 #define	TOPO_STORAGE_SERIAL_NUM		"serial-number"
48 #define	TOPO_STORAGE_FIRMWARE_REV	"firmware-revision"
49 #define	TOPO_STORAGE_CAPACITY		"capacity-in-bytes"
50 
51 /*
52  * Properties for binding group: The binding group required in platform
53  * specific xml that describes 'bay' nodes containing internal disks.
54  */
55 #define	TOPO_PGROUP_BINDING		"binding"
56 #define	TOPO_BINDING_OCCUPANT		"occupant-path"
57 
58 /*
59  * device node information.
60  */
61 typedef struct dev_di_node {
62 	topo_list_t	ddn_list;	/* list of devices */
63 
64 	/* the following two fields are always defined */
65 	char		*ddn_devid;	/* devid of device */
66 	char		*ddn_dpath;	/* path to devinfo (may be vhci) */
67 	char		**ddn_ppath;	/* physical path to device (phci) */
68 	/*
69 	 * the ppath count also indicates number of target port and
70 	 * possible number of attached port and bridge port.
71 	 */
72 	int		ddn_ppath_count;
73 
74 	char		*ddn_lpath;	/* logical path (public /dev name) */
75 
76 	char		*ddn_mfg;	/* misc information about device */
77 	char		*ddn_model;
78 	char		*ddn_serial;
79 	char		*ddn_firm;
80 	char		*ddn_cap;
81 	uchar_t		ddn_dtype;	/* scsi inquiry device type. */
82 
83 	char		**ddn_target_port;  /* target-port devinfo prop */
84 	char		**ddn_attached_port; /* attached-port devinfo prop */
85 	char		**ddn_bridge_port;  /* bridge-port devinfo prop */
86 } dev_di_node_t;
87 
88 struct topo_list;
89 
90 /* Methods shared with the ses module (disk_common.c) */
91 extern int dev_list_gather(topo_mod_t *, struct topo_list *);
92 extern void dev_list_free(topo_mod_t *, struct topo_list *);
93 extern int disk_declare_non_enumerated(topo_mod_t *, tnode_t *, tnode_t **);
94 extern int disk_declare_path(topo_mod_t *, tnode_t *,
95     struct topo_list *, const char *);
96 extern int disk_declare_addr(topo_mod_t *, tnode_t *,
97     struct topo_list *, const char *, tnode_t **);
98 extern char *disk_auth_clean(topo_mod_t *, const char *);
99 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 #endif /* _DISK_H */
105