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 2010 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 #ifndef _LPIF_H 26 #define _LPIF_H 27 28 /* 29 * Definitions for stmf LUs and lu providers. 30 */ 31 32 #include <sys/stmf_defines.h> 33 #include <sys/stmf.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #define LPIF_REV_1 0x00010000 40 #define LPIF_REV_2 0x00020000 41 42 typedef struct stmf_lu { 43 void *lu_stmf_private; 44 void *lu_provider_private; 45 46 struct scsi_devid_desc *lu_id; 47 char *lu_alias; /* optional */ 48 struct stmf_lu_provider *lu_lp; 49 uint32_t lu_abort_timeout; /* In seconds */ 50 51 /* SAM Device Server Class */ 52 stmf_status_t (*lu_task_alloc)(struct scsi_task *task); 53 void (*lu_new_task)(struct scsi_task *task, 54 struct stmf_data_buf *initial_dbuf); 55 void (*lu_dbuf_xfer_done)(struct scsi_task *task, 56 struct stmf_data_buf *dbuf); 57 /* 58 * If completion confirmation is not requested, status xfer done 59 * is called after the transport has confirmed that status has been 60 * sent. If completion confirmation is requested then the HBA will 61 * request a completion confirmation from the host and upon receiving 62 * the same, this entry point will be called. 63 */ 64 void (*lu_send_status_done)(struct scsi_task *task); 65 void (*lu_task_free)(struct scsi_task *task); 66 stmf_status_t (*lu_abort)(struct stmf_lu *lu, 67 int abort_cmd, void *arg, uint32_t flags); 68 void (*lu_task_poll)(struct scsi_task *task); 69 void (*lu_ctl)(struct stmf_lu *lu, int cmd, 70 void *arg); 71 stmf_status_t (*lu_info)(uint32_t cmd, struct stmf_lu *lu, 72 void *arg, uint8_t *buf, uint32_t *bufsizep); 73 void (*lu_event_handler)(struct stmf_lu *lu, 74 int eventid, void *arg, uint32_t flags); 75 void *lu_proxy_reg_arg; 76 uint32_t lu_proxy_reg_arg_len; 77 } stmf_lu_t; 78 79 /* 80 * Abort cmd 81 */ 82 #define STMF_LU_ABORT_TASK 1 83 #define STMF_LU_RESET_STATE 2 84 #define STMF_LU_ITL_HANDLE_REMOVED 3 85 86 /* 87 * Asymmetric access state 88 */ 89 #define STMF_LU_ACTIVE 0 90 #define STMF_LU_STANDBY 1 91 92 /* 93 * proxy register msg types 94 */ 95 #define STMF_MSG_LU_REGISTER 0 96 #define STMF_MSG_LU_ACTIVE 1 97 #define STMF_MSG_LU_DEREGISTER 2 98 99 100 #define STMF_PROXY_READ 1 101 #define STMF_PROXY_WRITE 2 102 103 /* 104 * Reasons for itl handle removal. Passed in flags. 105 */ 106 #define STMF_ITL_REASON_MASK 0x0f 107 #define STMF_ITL_REASON_UNKNOWN 0x0 108 #define STMF_ITL_REASON_DEREG_REQUEST 0x1 109 #define STMF_ITL_REASON_USER_REQUEST 0x2 110 #define STMF_ITL_REASON_IT_NEXUS_LOSS 0x3 111 112 typedef struct stmf_lu_provider { 113 void *lp_stmf_private; 114 void *lp_private; 115 116 uint32_t lp_lpif_rev; /* Currently LPIF_REV_2 */ 117 int lp_instance; 118 char *lp_name; 119 void (*lp_cb)(struct stmf_lu_provider *lp, 120 int cmd, void *arg, uint32_t flags); 121 uint8_t lp_alua_support; 122 stmf_status_t (*lp_proxy_msg)(uint8_t *luid, 123 void *proxy_reg_arg, uint32_t proxy_reg_arg_len, uint32_t type); 124 } stmf_lu_provider_t; 125 126 stmf_status_t stmf_deregister_lu_provider(stmf_lu_provider_t *lp); 127 stmf_status_t stmf_register_lu_provider(stmf_lu_provider_t *lp); 128 stmf_status_t stmf_register_lu(stmf_lu_t *lup); 129 stmf_status_t stmf_deregister_lu(stmf_lu_t *lup); 130 stmf_status_t stmf_set_lu_access(stmf_lu_t *lup, uint8_t access_state); 131 stmf_status_t stmf_proxy_scsi_cmd(scsi_task_t *, stmf_data_buf_t *dbuf); 132 int stmf_is_standby_port(scsi_task_t *); 133 void stmf_lu_xfer_start(struct scsi_task *task); 134 void stmf_lu_xfer_done(struct scsi_task *task, boolean_t read, 135 uint64_t xfer_bytes, hrtime_t elapsed_time); 136 137 #ifdef __cplusplus 138 } 139 #endif 140 141 #endif /* _LPIF_H */ 142