1/* 2 * Copyright (c) 2010 Cisco Systems, Inc. 3 * 4 * This program is free software; you can redistribute it and/or modify it 5 * under the terms and conditions of the GNU General Public License, 6 * version 2, as published by the Free Software Foundation. 7 * 8 * This program is distributed in the hope it will be useful, but WITHOUT 9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 11 * more details. 12 * 13 * You should have received a copy of the GNU General Public License along with 14 * this program; if not, write to the Free Software Foundation, Inc., 15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 16 */ 17#ifndef __TCM_FC_H__ 18#define __TCM_FC_H__ 19 20#define FT_VERSION "0.4" 21 22#define FT_NAMELEN 32 /* length of ASCII WWPNs including pad */ 23#define FT_TPG_NAMELEN 32 /* max length of TPG name */ 24#define FT_LUN_NAMELEN 32 /* max length of LUN name */ 25#define TCM_FC_DEFAULT_TAGS 512 /* tags used for per-session preallocation */ 26 27struct ft_transport_id { 28 __u8 format; 29 __u8 __resvd1[7]; 30 __u8 wwpn[8]; 31 __u8 __resvd2[8]; 32} __attribute__((__packed__)); 33 34/* 35 * Session (remote port). 36 */ 37struct ft_sess { 38 u32 port_id; /* for hash lookup use only */ 39 u32 params; 40 u16 max_frame; /* maximum frame size */ 41 u64 port_name; /* port name for transport ID */ 42 struct ft_tport *tport; 43 struct se_session *se_sess; 44 struct hlist_node hash; /* linkage in ft_sess_hash table */ 45 struct rcu_head rcu; 46 struct kref kref; /* ref for hash and outstanding I/Os */ 47}; 48 49/* 50 * Hash table of sessions per local port. 51 * Hash lookup by remote port FC_ID. 52 */ 53#define FT_SESS_HASH_BITS 6 54#define FT_SESS_HASH_SIZE (1 << FT_SESS_HASH_BITS) 55 56/* 57 * Per local port data. 58 * This is created only after a TPG exists that allows target function 59 * for the local port. If the TPG exists, this is allocated when 60 * we're notified that the local port has been created, or when 61 * the first PRLI provider callback is received. 62 */ 63struct ft_tport { 64 struct fc_lport *lport; 65 struct ft_tpg *tpg; /* NULL if TPG deleted before tport */ 66 u32 sess_count; /* number of sessions in hash */ 67 struct rcu_head rcu; 68 struct hlist_head hash[FT_SESS_HASH_SIZE]; /* list of sessions */ 69}; 70 71/* 72 * Node ID and authentication. 73 */ 74struct ft_node_auth { 75 u64 port_name; 76 u64 node_name; 77}; 78 79/* 80 * Node ACL for FC remote port session. 81 */ 82struct ft_node_acl { 83 struct ft_node_auth node_auth; 84 struct se_node_acl se_node_acl; 85}; 86 87struct ft_lun { 88 u32 index; 89 char name[FT_LUN_NAMELEN]; 90}; 91 92/* 93 * Target portal group (local port). 94 */ 95struct ft_tpg { 96 u32 index; 97 struct ft_lport_wwn *lport_wwn; 98 struct ft_tport *tport; /* active tport or NULL */ 99 struct list_head lun_list; /* head of LUNs */ 100 struct se_portal_group se_tpg; 101 struct workqueue_struct *workqueue; 102}; 103 104struct ft_lport_wwn { 105 u64 wwpn; 106 char name[FT_NAMELEN]; 107 struct list_head ft_wwn_node; 108 struct ft_tpg *tpg; 109 struct se_wwn se_wwn; 110}; 111 112/* 113 * Commands 114 */ 115struct ft_cmd { 116 struct ft_sess *sess; /* session held for cmd */ 117 struct fc_seq *seq; /* sequence in exchange mgr */ 118 struct se_cmd se_cmd; /* Local TCM I/O descriptor */ 119 struct fc_frame *req_frame; 120 u32 write_data_len; /* data received on writes */ 121 struct work_struct work; 122 /* Local sense buffer */ 123 unsigned char ft_sense_buffer[TRANSPORT_SENSE_BUFFER]; 124 u32 was_ddp_setup:1; /* Set only if ddp is setup */ 125 u32 aborted:1; /* Set if aborted by reset or timeout */ 126 struct scatterlist *sg; /* Set only if DDP is setup */ 127 u32 sg_cnt; /* No. of item in scatterlist */ 128}; 129 130extern struct mutex ft_lport_lock; 131extern struct fc4_prov ft_prov; 132extern unsigned int ft_debug_logging; 133 134/* 135 * Fabric methods. 136 */ 137 138/* 139 * Session ops. 140 */ 141void ft_sess_put(struct ft_sess *); 142int ft_sess_shutdown(struct se_session *); 143void ft_sess_close(struct se_session *); 144u32 ft_sess_get_index(struct se_session *); 145u32 ft_sess_get_port_name(struct se_session *, unsigned char *, u32); 146 147void ft_lport_add(struct fc_lport *, void *); 148void ft_lport_del(struct fc_lport *, void *); 149int ft_lport_notify(struct notifier_block *, unsigned long, void *); 150 151/* 152 * IO methods. 153 */ 154int ft_check_stop_free(struct se_cmd *); 155void ft_release_cmd(struct se_cmd *); 156int ft_queue_status(struct se_cmd *); 157int ft_queue_data_in(struct se_cmd *); 158int ft_write_pending(struct se_cmd *); 159int ft_write_pending_status(struct se_cmd *); 160u32 ft_get_task_tag(struct se_cmd *); 161int ft_get_cmd_state(struct se_cmd *); 162void ft_queue_tm_resp(struct se_cmd *); 163void ft_aborted_task(struct se_cmd *); 164 165/* 166 * other internal functions. 167 */ 168void ft_recv_req(struct ft_sess *, struct fc_frame *); 169struct ft_tpg *ft_lport_find_tpg(struct fc_lport *); 170struct ft_node_acl *ft_acl_get(struct ft_tpg *, struct fc_rport_priv *); 171 172void ft_recv_write_data(struct ft_cmd *, struct fc_frame *); 173void ft_dump_cmd(struct ft_cmd *, const char *caller); 174 175ssize_t ft_format_wwn(char *, size_t, u64); 176 177/* 178 * Underlying HW specific helper function 179 */ 180void ft_invl_hw_context(struct ft_cmd *); 181 182#endif /* __TCM_FC_H__ */ 183