cmlb_impl.h revision 8863:94039d51dda4
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 2009 Sun Microsystems, Inc.  All rights reserved.
24 * Use is subject to license terms.
25 */
26
27#ifndef _SYS_CMLB_IMPL_H
28#define	_SYS_CMLB_IMPL_H
29
30#ifdef	__cplusplus
31extern "C" {
32#endif
33
34#include <sys/cmlb.h>
35#include <sys/ddi.h>
36#include <sys/sunddi.h>
37
38#if defined(_SUNOS_VTOC_8)
39#define	NSDMAP			NDKMAP
40#elif defined(_SUNOS_VTOC_16)
41#define	NSDMAP			(NDKMAP + FD_NUMPART + 1)
42#else
43#error "No VTOC format defined."
44#endif
45
46#define	MAXPART			(NSDMAP + 1)
47#define	WD_NODE			7
48
49
50#if defined(__i386) || defined(__amd64)
51
52#define	P0_RAW_DISK		(NDKMAP)
53#define	FDISK_P1		(NDKMAP+1)
54#define	FDISK_P2		(NDKMAP+2)
55#define	FDISK_P3		(NDKMAP+3)
56#define	FDISK_P4		(NDKMAP+4)
57
58#endif  /* __i386 || __amd64 */
59
60/* Driver Logging Levels */
61#define	CMLB_LOGMASK_ERROR	0x00000001
62#define	CMLB_LOGMASK_INFO	0x00000002
63#define	CMLB_LOGMASK_TRACE	0x00000004
64
65#define	CMLB_TRACE		0x00000001
66#define	CMLB_INFO		0x00000002
67#define	CMLB_ERROR		0x00000004
68
69
70#define	CMLB_MUTEX(cl)		(&((cl)->cl_mutex))
71#define	CMLB_DEVINFO(cl)	((cl)->cl_devi)
72#define	CMLB_LABEL(cl)		(DEVI(((cl)->cl_devi))->devi_binding_name)
73
74
75#define	ISREMOVABLE(cl)		(cl->cl_is_removable)
76#define	ISCD(cl)		(cl->cl_device_type == DTYPE_RODIRECT)
77#define	ISHOTPLUGGABLE(cl)	(cl->cl_is_hotpluggable)
78
79#if defined(_SUNOS_VTOC_8)
80
81#define	CMLBUNIT_SHIFT		3
82#define	CMLBPART_MASK		7
83
84#elif defined(_SUNOS_VTOC_16)
85
86#define	CMLBUNIT_SHIFT		6
87#define	CMLBPART_MASK		63
88
89#else
90#error "No VTOC format defined."
91#endif
92
93#define	CMLBUNIT(dev)		(getminor((dev)) >> CMLBUNIT_SHIFT)
94#define	CMLBPART(dev)		(getminor((dev)) &  CMLBPART_MASK)
95
96/*
97 * Return codes of cmlb_uselabel().
98 */
99#define	CMLB_LABEL_IS_VALID	0
100#define	CMLB_LABEL_IS_INVALID	1
101
102#define	CMLB_2TB_BLOCKS		0xffffffff
103#define	CMLB_1TB_BLOCKS		0x7fffffff
104
105#define	CMLB_EXTVTOC_LIMIT	CMLB_2TB_BLOCKS
106#define	CMLB_OLDVTOC_LIMIT	CMLB_1TB_BLOCKS
107
108/*
109 * fdisk partition mapping structure
110 */
111struct fmap {
112	ulong_t fmap_start;	/* starting block number */
113	ulong_t fmap_nblk;	/* number of blocks */
114};
115
116/* for cm_state */
117typedef enum  {
118	CMLB_INITED = 0,
119	CMLB_ATTACHED
120} cmlb_state_t;
121
122typedef enum
123{
124	CMLB_LABEL_UNDEF = 0,
125	CMLB_LABEL_VTOC,
126	CMLB_LABEL_EFI
127} cmlb_label_t;
128
129#define	CMLB_ALLOW_2TB_WARN 0x1
130
131
132typedef struct cmlb_lun {
133	dev_info_t	*cl_devi;		/* pointer to devinfo */
134	struct dk_vtoc	cl_vtoc;	/* disk VTOC */
135	struct dk_geom	cl_g;		/* disk geometry */
136
137	diskaddr_t	cl_blockcount;		/* capacity */
138	uint32_t	cl_tgt_blocksize;	/* blocksize */
139
140	diskaddr_t	cl_solaris_size;	/* size of Solaris partition */
141	uint_t		cl_solaris_offset;	/* offset to Solaris part. */
142
143	struct  dk_map  cl_map[MAXPART];	/* logical partitions */
144						/* cylno is overloaded. used */
145						/* for starting block for EFI */
146
147	diskaddr_t	cl_offset[MAXPART];	/* partition start blocks */
148
149	struct fmap	cl_fmap[FD_NUMPART];	/* fdisk partitions */
150
151	uchar_t		cl_asciilabel[LEN_DKL_ASCII];	/* Disk ASCII label */
152
153	/*
154	 * This is the HBAs current notion of the geometry of the drive,
155	 * for HBAs that support the "geometry" property.
156	 */
157	struct cmlb_geom	cl_lgeom;
158
159	/*
160	 * This is the geometry of the device as reported by the MODE SENSE,
161	 * command, Page 3 (Format Device Page) and Page 4 (Rigid Disk Drive
162	 * Geometry Page), assuming MODE SENSE is supported by the target.
163	 */
164	struct cmlb_geom	cl_pgeom;
165
166	ushort_t	cl_dkg_skew;		/* skew */
167
168	cmlb_label_t	cl_def_labeltype;	/* default label type */
169
170	/* label type based on which minor nodes were created last */
171	cmlb_label_t	cl_last_labeltype;
172
173	cmlb_label_t	cl_cur_labeltype;	/* current label type */
174
175	/* indicates whether vtoc label is read from media */
176	cmlb_label_t		cl_label_from_media;
177
178	cmlb_state_t	cl_state;		/* state of handle */
179
180	boolean_t	cl_f_geometry_is_valid;
181	int		cl_sys_blocksize;
182
183	kmutex_t	cl_mutex;
184
185	/* the following are passed in at attach time */
186	boolean_t	cl_is_removable;	/* is removable */
187	boolean_t	cl_is_hotpluggable;	/* is hotpluggable */
188	int		cl_alter_behavior;
189	char 		*cl_node_type;		/* DDI_NT_... */
190	int		cl_device_type;		/* DTYPE_DIRECT,.. */
191	int		cl_reserved;		/* reserved efi partition # */
192	cmlb_tg_ops_t 	*cmlb_tg_ops;
193	uint8_t		cl_msglog_flag;		/* used to enable/suppress */
194						/* certain log messages */
195} cmlb_lun_t;
196
197_NOTE(SCHEME_PROTECTS_DATA("stable data", cmlb_lun::cmlb_tg_ops))
198_NOTE(SCHEME_PROTECTS_DATA("stable data", cmlb_lun::cl_devi))
199_NOTE(SCHEME_PROTECTS_DATA("stable data", cmlb_lun::cl_is_removable))
200_NOTE(SCHEME_PROTECTS_DATA("stable data", cmlb_lun::cl_is_hotpluggable))
201_NOTE(SCHEME_PROTECTS_DATA("stable data", cmlb_lun::cl_node_type))
202_NOTE(SCHEME_PROTECTS_DATA("stable data", cmlb_lun::cl_sys_blocksize))
203_NOTE(SCHEME_PROTECTS_DATA("stable data", cmlb_lun::cl_alter_behavior))
204_NOTE(SCHEME_PROTECTS_DATA("private data", cmlb_geom))
205_NOTE(SCHEME_PROTECTS_DATA("safe sharing", cmlb_lun::cl_f_geometry_is_valid))
206
207_NOTE(MUTEX_PROTECTS_DATA(cmlb_lun::cl_mutex, cmlb_lun::cl_vtoc))
208
209
210#define	DK_TG_READ(ihdlp, bufaddr, start_block, reqlength, tg_cookie)\
211	(ihdlp->cmlb_tg_ops->tg_rdwr)(CMLB_DEVINFO(ihdlp), TG_READ, \
212	bufaddr, start_block, reqlength, tg_cookie)
213
214#define	DK_TG_WRITE(ihdlp,  bufaddr, start_block, reqlength, tg_cookie)\
215	(ihdlp->cmlb_tg_ops->tg_rdwr)(CMLB_DEVINFO(ihdlp), TG_WRITE,\
216	bufaddr, start_block, reqlength, tg_cookie)
217
218#define	DK_TG_GETPHYGEOM(ihdlp, phygeomp, tg_cookie) \
219	(ihdlp->cmlb_tg_ops->tg_getinfo)(CMLB_DEVINFO(ihdlp), TG_GETPHYGEOM,\
220	    (void *)phygeomp, tg_cookie)
221
222#define	DK_TG_GETVIRTGEOM(ihdlp, virtgeomp, tg_cookie) \
223	(ihdlp->cmlb_tg_ops->tg_getinfo)(CMLB_DEVINFO(ihdlp), TG_GETVIRTGEOM,\
224	    (void *)virtgeomp, tg_cookie)
225
226#define	DK_TG_GETCAP(ihdlp, capp, tg_cookie) \
227	(ihdlp->cmlb_tg_ops->tg_getinfo)(CMLB_DEVINFO(ihdlp), TG_GETCAPACITY,\
228	capp, tg_cookie)
229
230#define	DK_TG_GETBLOCKSIZE(ihdlp, lbap, tg_cookie) \
231	(ihdlp->cmlb_tg_ops->tg_getinfo)(CMLB_DEVINFO(ihdlp),\
232	TG_GETBLOCKSIZE, lbap, tg_cookie)
233
234#define	DK_TG_GETATTRIBUTE(ihdlp, attributep, tg_cookie) \
235	(ihdlp->cmlb_tg_ops->tg_getinfo)(CMLB_DEVINFO(ihdlp), TG_GETATTR,\
236	    attributep, tg_cookie)
237
238#ifdef __cplusplus
239}
240#endif
241
242#endif	/* _SYS_CMLB_IMPL_H */
243