190926Snectar/*-
290926Snectar * Copyright (c) 2003 Silicon Graphics International Corp.
390926Snectar * All rights reserved.
490926Snectar *
590926Snectar * Redistribution and use in source and binary forms, with or without
690926Snectar * modification, are permitted provided that the following conditions
790926Snectar * are met:
890926Snectar * 1. Redistributions of source code must retain the above copyright
990926Snectar *    notice, this list of conditions, and the following disclaimer,
1090926Snectar *    without modification.
1190926Snectar * 2. Redistributions in binary form must reproduce at minimum a disclaimer
1290926Snectar *    substantially similar to the "NO WARRANTY" disclaimer below
1390926Snectar *    ("Disclaimer") and any redistribution must be conditioned upon
1490926Snectar *    including a substantially similar Disclaimer requirement for further
1590926Snectar *    binary redistribution.
1690926Snectar *
1790926Snectar * NO WARRANTY
1890926Snectar * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1990926Snectar * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
2090926Snectar * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
2190926Snectar * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2290926Snectar * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2390926Snectar * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2490926Snectar * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2590926Snectar * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
2690926Snectar * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
2790926Snectar * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2890926Snectar * POSSIBILITY OF SUCH DAMAGES.
2990926Snectar *
3090926Snectar * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl.h#5 $
3190926Snectar * $FreeBSD: releng/10.3/sys/cam/ctl/ctl.h 290776 2015-11-13 19:24:44Z mav $
3290926Snectar */
3390926Snectar/*
3490926Snectar * Function definitions used both within CTL and potentially in various CTL
3590926Snectar * clients.
3690926Snectar *
3790926Snectar * Author: Ken Merry <ken@FreeBSD.org>
3890926Snectar */
3990926Snectar
4090926Snectar#ifndef	_CTL_H_
4190926Snectar#define	_CTL_H_
4290926Snectar
4390926Snectar#define	CTL_RETVAL_COMPLETE	0
4490926Snectar#define	CTL_RETVAL_QUEUED	1
4590926Snectar#define	CTL_RETVAL_ALLOCATED	2
4690926Snectar#define	CTL_RETVAL_ERROR	3
4790926Snectar
4890926Snectartypedef enum {
4990926Snectar	CTL_PORT_NONE		= 0x00,
5090926Snectar	CTL_PORT_FC		= 0x01,
5190926Snectar	CTL_PORT_SCSI		= 0x02,
5290926Snectar	CTL_PORT_IOCTL		= 0x04,
5390926Snectar	CTL_PORT_INTERNAL	= 0x08,
5490926Snectar	CTL_PORT_ISCSI		= 0x10,
5590926Snectar	CTL_PORT_SAS		= 0x20,
5690926Snectar	CTL_PORT_ALL		= 0xff,
5790926Snectar	CTL_PORT_ISC		= 0x100 // FC port for inter-shelf communication
5890926Snectar} ctl_port_type;
5990926Snectar
6090926Snectarstruct ctl_port_entry {
6190926Snectar	ctl_port_type		port_type;
6290926Snectar	char			port_name[64];
6390926Snectar	int32_t			targ_port;
6490926Snectar	int			physical_port;
6590926Snectar	int			virtual_port;
6690926Snectar	u_int			flags;
6790926Snectar#define	CTL_PORT_WWNN_VALID	0x01
6890926Snectar#define	CTL_PORT_WWPN_VALID	0x02
6990926Snectar	uint64_t		wwnn;
7090926Snectar	uint64_t		wwpn;
7190926Snectar	int			online;
7290926Snectar};
7390926Snectar
7490926Snectarstruct ctl_modepage_header {
7590926Snectar	uint8_t page_code;
7690926Snectar	uint8_t subpage;
7790926Snectar	int32_t len_used;
7890926Snectar	int32_t len_left;
7990926Snectar};
8090926Snectar
8190926Snectarstruct ctl_modepage_aps {
8290926Snectar	struct ctl_modepage_header header;
8390926Snectar	uint8_t lock_active;
8490926Snectar};
8590926Snectar
8690926Snectarunion ctl_modepage_info {
8790926Snectar	struct ctl_modepage_header header;
8890926Snectar	struct ctl_modepage_aps aps;
8990926Snectar};
9090926Snectar
9190926Snectar/*
9290926Snectar * Serial number length, for VPD page 0x80.
9390926Snectar */
9490926Snectar#define	CTL_SN_LEN	16
9590926Snectar
9690926Snectar/*
9790926Snectar * Device ID length, for VPD page 0x83.
9890926Snectar */
9990926Snectar#define	CTL_DEVID_LEN	64
10090926Snectar#define	CTL_DEVID_MIN_LEN	16
10190926Snectar/*
10290926Snectar * WWPN length, for VPD page 0x83.
10390926Snectar */
10490926Snectar#define CTL_WWPN_LEN   8
10590926Snectar
10690926Snectar#define	CTL_DRIVER_NAME_LEN	32
10790926Snectar
10890926Snectar/*
10990926Snectar * Unit attention types. ASC/ASCQ values for these should be placed in
11090926Snectar * ctl_build_ua.  These are also listed in order of reporting priority.
11190926Snectar * i.e. a poweron UA is reported first, bus reset second, etc.
11290926Snectar */
11390926Snectartypedef enum {
11490926Snectar	CTL_UA_NONE		= 0x0000,
11590926Snectar	CTL_UA_POWERON		= 0x0001,
11690926Snectar	CTL_UA_BUS_RESET	= 0x0002,
11790926Snectar	CTL_UA_TARG_RESET	= 0x0004,
11890926Snectar	CTL_UA_I_T_NEXUS_LOSS	= 0x0008,
11990926Snectar	CTL_UA_LUN_RESET	= 0x0010,
12090926Snectar	CTL_UA_LUN_CHANGE	= 0x0020,
12190926Snectar	CTL_UA_MODE_CHANGE	= 0x0040,
12290926Snectar	CTL_UA_LOG_CHANGE	= 0x0080,
12390926Snectar	CTL_UA_INQ_CHANGE	= 0x0100,
12490926Snectar	CTL_UA_RES_PREEMPT	= 0x0400,
12590926Snectar	CTL_UA_RES_RELEASE	= 0x0800,
12690926Snectar	CTL_UA_REG_PREEMPT	= 0x1000,
12790926Snectar	CTL_UA_ASYM_ACC_CHANGE	= 0x2000,
12890926Snectar	CTL_UA_CAPACITY_CHANGE	= 0x4000,
12990926Snectar	CTL_UA_THIN_PROV_THRES	= 0x8000,
13090926Snectar	CTL_UA_MEDIUM_CHANGE	= 0x10000
13190926Snectar} ctl_ua_type;
13290926Snectar
13390926Snectar#ifdef	_KERNEL
134
135MALLOC_DECLARE(M_CTL);
136
137struct ctl_page_index;
138
139#ifdef SYSCTL_DECL	/* from sysctl.h */
140SYSCTL_DECL(_kern_cam_ctl);
141#endif
142
143struct ctl_lun;
144struct ctl_port;
145struct ctl_softc;
146
147/*
148 * Put a string into an sbuf, escaping characters that are illegal or not
149 * recommended in XML.  Note this doesn't escape everything, just > < and &.
150 */
151int ctl_sbuf_printf_esc(struct sbuf *sb, char *str, int size);
152
153int ctl_ffz(uint32_t *mask, uint32_t first, uint32_t last);
154int ctl_set_mask(uint32_t *mask, uint32_t bit);
155int ctl_clear_mask(uint32_t *mask, uint32_t bit);
156int ctl_is_set(uint32_t *mask, uint32_t bit);
157int ctl_caching_sp_handler(struct ctl_scsiio *ctsio,
158			 struct ctl_page_index *page_index, uint8_t *page_ptr);
159int ctl_control_page_handler(struct ctl_scsiio *ctsio,
160			     struct ctl_page_index *page_index,
161			     uint8_t *page_ptr);
162int ctl_debugconf_sp_sense_handler(struct ctl_scsiio *ctsio,
163				   struct ctl_page_index *page_index,
164				   int pc);
165int ctl_debugconf_sp_select_handler(struct ctl_scsiio *ctsio,
166				    struct ctl_page_index *page_index,
167				    uint8_t *page_ptr);
168int ctl_lbp_log_sense_handler(struct ctl_scsiio *ctsio,
169				   struct ctl_page_index *page_index,
170				   int pc);
171int ctl_sap_log_sense_handler(struct ctl_scsiio *ctsio,
172				   struct ctl_page_index *page_index,
173				   int pc);
174int ctl_config_move_done(union ctl_io *io);
175void ctl_datamove(union ctl_io *io);
176void ctl_serseq_done(union ctl_io *io);
177void ctl_done(union ctl_io *io);
178void ctl_data_submit_done(union ctl_io *io);
179void ctl_config_read_done(union ctl_io *io);
180void ctl_config_write_done(union ctl_io *io);
181void ctl_portDB_changed(int portnum);
182int ctl_ioctl_io(struct cdev *dev, u_long cmd, caddr_t addr, int flag,
183		 struct thread *td);
184
185void ctl_est_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua);
186void ctl_est_ua_port(struct ctl_lun *lun, int port, uint32_t except,
187    ctl_ua_type ua);
188void ctl_est_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua);
189void ctl_clr_ua(struct ctl_lun *lun, uint32_t initidx, ctl_ua_type ua);
190void ctl_clr_ua_all(struct ctl_lun *lun, uint32_t except, ctl_ua_type ua);
191void ctl_clr_ua_allluns(struct ctl_softc *ctl_softc, uint32_t initidx,
192    ctl_ua_type ua_type);
193
194uint32_t ctl_decode_lun(uint64_t encoded);
195uint64_t ctl_encode_lun(uint32_t decoded);
196
197void ctl_isc_announce_lun(struct ctl_lun *lun);
198void ctl_isc_announce_port(struct ctl_port *port);
199void ctl_isc_announce_iid(struct ctl_port *port, int iid);
200void ctl_isc_announce_mode(struct ctl_lun *lun, uint32_t initidx,
201    uint8_t page, uint8_t subpage);
202
203/*
204 * KPI to manipulate LUN/port options
205 */
206
207struct ctl_option {
208	STAILQ_ENTRY(ctl_option)	links;
209	char			*name;
210	char			*value;
211};
212typedef STAILQ_HEAD(ctl_options, ctl_option) ctl_options_t;
213
214struct ctl_be_arg;
215void ctl_init_opts(ctl_options_t *opts, int num_args, struct ctl_be_arg *args);
216void ctl_update_opts(ctl_options_t *opts, int num_args,
217    struct ctl_be_arg *args);
218void ctl_free_opts(ctl_options_t *opts);
219char * ctl_get_opt(ctl_options_t *opts, const char *name);
220int ctl_expand_number(const char *buf, uint64_t *num);
221
222#endif	/* _KERNEL */
223
224#endif	/* _CTL_H_ */
225
226/*
227 * vim: ts=8
228 */
229