Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright(c) 2007 Intel Corporation. All rights reserved. |
| 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 | * Maintained at www.Open-FCoE.org |
| 18 | */ |
| 19 | |
| 20 | #ifndef _LIBFC_H_ |
| 21 | #define _LIBFC_H_ |
| 22 | |
| 23 | #include <linux/timer.h> |
| 24 | #include <linux/if.h> |
Robert Love | 582b45b | 2009-03-31 15:51:50 -0700 | [diff] [blame] | 25 | #include <linux/percpu.h> |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 26 | |
| 27 | #include <scsi/scsi_transport.h> |
| 28 | #include <scsi/scsi_transport_fc.h> |
| 29 | |
| 30 | #include <scsi/fc/fc_fcp.h> |
| 31 | #include <scsi/fc/fc_ns.h> |
| 32 | #include <scsi/fc/fc_els.h> |
| 33 | #include <scsi/fc/fc_gs.h> |
| 34 | |
| 35 | #include <scsi/fc_frame.h> |
| 36 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 37 | /* |
| 38 | * libfc error codes |
| 39 | */ |
| 40 | #define FC_NO_ERR 0 /* no error */ |
| 41 | #define FC_EX_TIMEOUT 1 /* Exchange timeout */ |
| 42 | #define FC_EX_CLOSED 2 /* Exchange closed */ |
| 43 | |
| 44 | /* some helpful macros */ |
| 45 | |
| 46 | #define ntohll(x) be64_to_cpu(x) |
| 47 | #define htonll(x) cpu_to_be64(x) |
| 48 | |
| 49 | #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) |
| 50 | |
| 51 | #define hton24(p, v) do { \ |
| 52 | p[0] = (((v) >> 16) & 0xFF); \ |
| 53 | p[1] = (((v) >> 8) & 0xFF); \ |
| 54 | p[2] = ((v) & 0xFF); \ |
| 55 | } while (0) |
| 56 | |
| 57 | /* |
| 58 | * FC HBA status |
| 59 | */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 60 | enum fc_lport_state { |
Joe Eykholt | b1d9fd5 | 2009-07-29 17:04:22 -0700 | [diff] [blame] | 61 | LPORT_ST_DISABLED = 0, |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 62 | LPORT_ST_FLOGI, |
| 63 | LPORT_ST_DNS, |
Chris Leech | c9c7bd7 | 2009-11-03 11:46:51 -0800 | [diff] [blame] | 64 | LPORT_ST_RNN_ID, |
Chris Leech | 5baa17c | 2009-11-03 11:46:56 -0800 | [diff] [blame] | 65 | LPORT_ST_RSNN_NN, |
Chris Leech | c9866a5 | 2009-11-03 11:47:01 -0800 | [diff] [blame^] | 66 | LPORT_ST_RSPN_ID, |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 67 | LPORT_ST_RFT_ID, |
| 68 | LPORT_ST_SCR, |
| 69 | LPORT_ST_READY, |
| 70 | LPORT_ST_LOGO, |
| 71 | LPORT_ST_RESET |
| 72 | }; |
| 73 | |
| 74 | enum fc_disc_event { |
| 75 | DISC_EV_NONE = 0, |
| 76 | DISC_EV_SUCCESS, |
| 77 | DISC_EV_FAILED |
| 78 | }; |
| 79 | |
| 80 | enum fc_rport_state { |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 81 | RPORT_ST_INIT, /* initialized */ |
| 82 | RPORT_ST_PLOGI, /* waiting for PLOGI completion */ |
| 83 | RPORT_ST_PRLI, /* waiting for PRLI completion */ |
| 84 | RPORT_ST_RTV, /* waiting for RTV completion */ |
| 85 | RPORT_ST_READY, /* ready for use */ |
| 86 | RPORT_ST_LOGO, /* port logout sent */ |
Joe Eykholt | 370c3bd | 2009-08-25 14:03:47 -0700 | [diff] [blame] | 87 | RPORT_ST_ADISC, /* Discover Address sent */ |
Joe Eykholt | 1419405 | 2009-07-29 17:04:43 -0700 | [diff] [blame] | 88 | RPORT_ST_DELETE, /* port being deleted */ |
Joe Eykholt | b4a9c7e | 2009-10-21 16:28:30 -0700 | [diff] [blame] | 89 | RPORT_ST_RESTART, /* remote port being deleted and will restart */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 90 | }; |
| 91 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 92 | /** |
| 93 | * struct fc_disc_port - temporary discovery port to hold rport identifiers |
Robert Love | 9737e6a | 2009-08-25 14:02:59 -0700 | [diff] [blame] | 94 | * @lp: Fibre Channel host port instance |
| 95 | * @peers: Node for list management during discovery and RSCN processing |
| 96 | * @rport_work: Work struct for starting the rport state machine |
| 97 | * @port_id: Port ID of the discovered port |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 98 | */ |
| 99 | struct fc_disc_port { |
| 100 | struct fc_lport *lp; |
| 101 | struct list_head peers; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 102 | struct work_struct rport_work; |
Robert Love | 9737e6a | 2009-08-25 14:02:59 -0700 | [diff] [blame] | 103 | u32 port_id; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 104 | }; |
| 105 | |
| 106 | enum fc_rport_event { |
| 107 | RPORT_EV_NONE = 0, |
Joe Eykholt | 4c0f62b | 2009-08-25 14:01:12 -0700 | [diff] [blame] | 108 | RPORT_EV_READY, |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 109 | RPORT_EV_FAILED, |
| 110 | RPORT_EV_STOP, |
| 111 | RPORT_EV_LOGO |
| 112 | }; |
| 113 | |
Joe Eykholt | 9fb9d32 | 2009-08-25 14:00:50 -0700 | [diff] [blame] | 114 | struct fc_rport_priv; |
| 115 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 116 | struct fc_rport_operations { |
Joe Eykholt | 9fb9d32 | 2009-08-25 14:00:50 -0700 | [diff] [blame] | 117 | void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 118 | enum fc_rport_event); |
| 119 | }; |
| 120 | |
| 121 | /** |
| 122 | * struct fc_rport_libfc_priv - libfc internal information about a remote port |
| 123 | * @local_port: Fibre Channel host port instance |
Joe Eykholt | 9e9d045 | 2009-08-25 14:01:18 -0700 | [diff] [blame] | 124 | * @rp_state: indicates READY for I/O or DELETE when blocked. |
| 125 | * @flags: REC and RETRY supported flags |
| 126 | * @e_d_tov: error detect timeout value (in msec) |
| 127 | * @r_a_tov: resource allocation timeout value (in msec) |
| 128 | */ |
| 129 | struct fc_rport_libfc_priv { |
| 130 | struct fc_lport *local_port; |
| 131 | enum fc_rport_state rp_state; |
| 132 | u16 flags; |
| 133 | #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) |
| 134 | #define FC_RP_FLAGS_RETRY (1 << 1) |
| 135 | unsigned int e_d_tov; |
| 136 | unsigned int r_a_tov; |
| 137 | }; |
| 138 | |
| 139 | /** |
| 140 | * struct fc_rport_priv - libfc rport and discovery info about a remote port |
| 141 | * @local_port: Fibre Channel host port instance |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 142 | * @rport: transport remote port |
| 143 | * @kref: reference counter |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 144 | * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 145 | * @ids: remote port identifiers and roles |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 146 | * @flags: REC and RETRY supported flags |
| 147 | * @max_seq: maximum number of concurrent sequences |
Joe Eykholt | 0f6c614 | 2009-08-25 14:02:11 -0700 | [diff] [blame] | 148 | * @disc_id: discovery identifier |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 149 | * @maxframe_size: maximum frame size |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 150 | * @retries: retry count in current state |
| 151 | * @e_d_tov: error detect timeout value (in msec) |
| 152 | * @r_a_tov: resource allocation timeout value (in msec) |
| 153 | * @rp_mutex: mutex protects rport |
| 154 | * @retry_work: |
| 155 | * @event_callback: Callback for rport READY, FAILED or LOGO |
| 156 | */ |
Joe Eykholt | 9e9d045 | 2009-08-25 14:01:18 -0700 | [diff] [blame] | 157 | struct fc_rport_priv { |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 158 | struct fc_lport *local_port; |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 159 | struct fc_rport *rport; |
| 160 | struct kref kref; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 161 | enum fc_rport_state rp_state; |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 162 | struct fc_rport_identifiers ids; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 163 | u16 flags; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 164 | u16 max_seq; |
Joe Eykholt | 0f6c614 | 2009-08-25 14:02:11 -0700 | [diff] [blame] | 165 | u16 disc_id; |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 166 | u16 maxframe_size; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 167 | unsigned int retries; |
| 168 | unsigned int e_d_tov; |
| 169 | unsigned int r_a_tov; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 170 | struct mutex rp_mutex; |
| 171 | struct delayed_work retry_work; |
| 172 | enum fc_rport_event event; |
| 173 | struct fc_rport_operations *ops; |
| 174 | struct list_head peers; |
| 175 | struct work_struct event_work; |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 176 | u32 supported_classes; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 177 | }; |
| 178 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 179 | /* |
| 180 | * fcoe stats structure |
| 181 | */ |
| 182 | struct fcoe_dev_stats { |
| 183 | u64 SecondsSinceLastReset; |
| 184 | u64 TxFrames; |
| 185 | u64 TxWords; |
| 186 | u64 RxFrames; |
| 187 | u64 RxWords; |
| 188 | u64 ErrorFrames; |
| 189 | u64 DumpedFrames; |
| 190 | u64 LinkFailureCount; |
| 191 | u64 LossOfSignalCount; |
| 192 | u64 InvalidTxWordCount; |
| 193 | u64 InvalidCRCCount; |
| 194 | u64 InputRequests; |
| 195 | u64 OutputRequests; |
| 196 | u64 ControlRequests; |
| 197 | u64 InputMegabytes; |
| 198 | u64 OutputMegabytes; |
| 199 | }; |
| 200 | |
| 201 | /* |
| 202 | * els data is used for passing ELS respone specific |
| 203 | * data to send ELS response mainly using infomation |
| 204 | * in exchange and sequence in EM layer. |
| 205 | */ |
| 206 | struct fc_seq_els_data { |
| 207 | struct fc_frame *fp; |
| 208 | enum fc_els_rjt_reason reason; |
| 209 | enum fc_els_rjt_explan explan; |
| 210 | }; |
| 211 | |
| 212 | /* |
| 213 | * FCP request structure, one for each scsi cmd request |
| 214 | */ |
| 215 | struct fc_fcp_pkt { |
| 216 | /* |
| 217 | * housekeeping stuff |
| 218 | */ |
| 219 | struct fc_lport *lp; /* handle to hba struct */ |
| 220 | u16 state; /* scsi_pkt state state */ |
| 221 | u16 tgt_flags; /* target flags */ |
| 222 | atomic_t ref_cnt; /* fcp pkt ref count */ |
| 223 | spinlock_t scsi_pkt_lock; /* Must be taken before the host lock |
| 224 | * if both are held at the same time */ |
| 225 | /* |
| 226 | * SCSI I/O related stuff |
| 227 | */ |
| 228 | struct scsi_cmnd *cmd; /* scsi command pointer. set/clear |
| 229 | * under host lock */ |
| 230 | struct list_head list; /* tracks queued commands. access under |
| 231 | * host lock */ |
| 232 | /* |
| 233 | * timeout related stuff |
| 234 | */ |
| 235 | struct timer_list timer; /* command timer */ |
| 236 | struct completion tm_done; |
| 237 | int wait_for_comp; |
| 238 | unsigned long start_time; /* start jiffie */ |
| 239 | unsigned long end_time; /* end jiffie */ |
| 240 | unsigned long last_pkt_time; /* jiffies of last frame received */ |
| 241 | |
| 242 | /* |
| 243 | * scsi cmd and data transfer information |
| 244 | */ |
| 245 | u32 data_len; |
| 246 | /* |
| 247 | * transport related veriables |
| 248 | */ |
| 249 | struct fcp_cmnd cdb_cmd; |
| 250 | size_t xfer_len; |
Yi Zou | b277d2a | 2009-02-27 14:07:21 -0800 | [diff] [blame] | 251 | u16 xfer_ddp; /* this xfer is ddped */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 252 | u32 xfer_contig_end; /* offset of end of contiguous xfer */ |
| 253 | u16 max_payload; /* max payload size in bytes */ |
| 254 | |
| 255 | /* |
| 256 | * scsi/fcp return status |
| 257 | */ |
| 258 | u32 io_status; /* SCSI result upper 24 bits */ |
| 259 | u8 cdb_status; |
| 260 | u8 status_code; /* FCP I/O status */ |
| 261 | /* bit 3 Underrun bit 2: overrun */ |
| 262 | u8 scsi_comp_flags; |
| 263 | u32 req_flags; /* bit 0: read bit:1 write */ |
| 264 | u32 scsi_resid; /* residule length */ |
| 265 | |
| 266 | struct fc_rport *rport; /* remote port pointer */ |
| 267 | struct fc_seq *seq_ptr; /* current sequence pointer */ |
| 268 | /* |
| 269 | * Error Processing |
| 270 | */ |
| 271 | u8 recov_retry; /* count of recovery retries */ |
| 272 | struct fc_seq *recov_seq; /* sequence for REC or SRR */ |
| 273 | }; |
Yi Zou | b277d2a | 2009-02-27 14:07:21 -0800 | [diff] [blame] | 274 | /* |
| 275 | * FC_FCP HELPER FUNCTIONS |
| 276 | *****************************/ |
| 277 | static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) |
| 278 | { |
| 279 | if (fsp && fsp->cmd) |
| 280 | return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; |
| 281 | return false; |
| 282 | } |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 283 | |
| 284 | /* |
| 285 | * Structure and function definitions for managing Fibre Channel Exchanges |
| 286 | * and Sequences |
| 287 | * |
| 288 | * fc_exch holds state for one exchange and links to its active sequence. |
| 289 | * |
| 290 | * fc_seq holds the state for an individual sequence. |
| 291 | */ |
| 292 | |
| 293 | struct fc_exch_mgr; |
Vasu Dev | 9631609 | 2009-07-29 17:05:00 -0700 | [diff] [blame] | 294 | struct fc_exch_mgr_anchor; |
Vasu Dev | e4bc50b | 2009-08-25 13:58:47 -0700 | [diff] [blame] | 295 | extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 296 | |
| 297 | /* |
| 298 | * Sequence. |
| 299 | */ |
| 300 | struct fc_seq { |
| 301 | u8 id; /* seq ID */ |
| 302 | u16 ssb_stat; /* status flags for sequence status block */ |
| 303 | u16 cnt; /* frames sent so far on sequence */ |
| 304 | u32 rec_data; /* FC-4 value for REC */ |
| 305 | }; |
| 306 | |
| 307 | #define FC_EX_DONE (1 << 0) /* ep is completed */ |
| 308 | #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ |
| 309 | |
| 310 | /* |
| 311 | * Exchange. |
| 312 | * |
| 313 | * Locking notes: The ex_lock protects following items: |
| 314 | * state, esb_stat, f_ctl, seq.ssb_stat |
| 315 | * seq_id |
| 316 | * sequence allocation |
| 317 | */ |
| 318 | struct fc_exch { |
| 319 | struct fc_exch_mgr *em; /* exchange manager */ |
Vasu Dev | b2f0091 | 2009-08-25 13:58:53 -0700 | [diff] [blame] | 320 | struct fc_exch_pool *pool; /* per cpu exches pool */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 321 | u32 state; /* internal driver state */ |
| 322 | u16 xid; /* our exchange ID */ |
| 323 | struct list_head ex_list; /* free or busy list linkage */ |
| 324 | spinlock_t ex_lock; /* lock covering exchange state */ |
| 325 | atomic_t ex_refcnt; /* reference counter */ |
| 326 | struct delayed_work timeout_work; /* timer for upper level protocols */ |
| 327 | struct fc_lport *lp; /* fc device instance */ |
| 328 | u16 oxid; /* originator's exchange ID */ |
| 329 | u16 rxid; /* responder's exchange ID */ |
| 330 | u32 oid; /* originator's FCID */ |
| 331 | u32 sid; /* source FCID */ |
| 332 | u32 did; /* destination FCID */ |
| 333 | u32 esb_stat; /* exchange status for ESB */ |
| 334 | u32 r_a_tov; /* r_a_tov from rport (msec) */ |
| 335 | u8 seq_id; /* next sequence ID to use */ |
| 336 | u32 f_ctl; /* F_CTL flags for sequences */ |
| 337 | u8 fh_type; /* frame type */ |
| 338 | enum fc_class class; /* class of service */ |
| 339 | struct fc_seq seq; /* single sequence */ |
| 340 | /* |
| 341 | * Handler for responses to this current exchange. |
| 342 | */ |
| 343 | void (*resp)(struct fc_seq *, struct fc_frame *, void *); |
| 344 | void (*destructor)(struct fc_seq *, void *); |
| 345 | /* |
| 346 | * arg is passed as void pointer to exchange |
| 347 | * resp and destructor handlers |
| 348 | */ |
| 349 | void *arg; |
| 350 | }; |
| 351 | #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) |
| 352 | |
| 353 | struct libfc_function_template { |
| 354 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 355 | /* |
| 356 | * Interface to send a FC frame |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 357 | * |
| 358 | * STATUS: REQUIRED |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 359 | */ |
| 360 | int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp); |
| 361 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 362 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 363 | * Interface to send ELS/CT frames |
| 364 | * |
| 365 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 366 | */ |
| 367 | struct fc_seq *(*elsct_send)(struct fc_lport *lport, |
Joe Eykholt | a46f327 | 2009-08-25 14:00:55 -0700 | [diff] [blame] | 368 | u32 did, |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 369 | struct fc_frame *fp, |
| 370 | unsigned int op, |
| 371 | void (*resp)(struct fc_seq *, |
| 372 | struct fc_frame *fp, |
| 373 | void *arg), |
| 374 | void *arg, u32 timer_msec); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 375 | |
| 376 | /* |
| 377 | * Send the FC frame payload using a new exchange and sequence. |
| 378 | * |
| 379 | * The frame pointer with some of the header's fields must be |
| 380 | * filled before calling exch_seq_send(), those fields are, |
| 381 | * |
| 382 | * - routing control |
| 383 | * - FC port did |
| 384 | * - FC port sid |
| 385 | * - FC header type |
| 386 | * - frame control |
| 387 | * - parameter or relative offset |
| 388 | * |
| 389 | * The exchange response handler is set in this routine to resp() |
| 390 | * function pointer. It can be called in two scenarios: if a timeout |
| 391 | * occurs or if a response frame is received for the exchange. The |
| 392 | * fc_frame pointer in response handler will also indicate timeout |
| 393 | * as error using IS_ERR related macros. |
| 394 | * |
| 395 | * The exchange destructor handler is also set in this routine. |
| 396 | * The destructor handler is invoked by EM layer when exchange |
| 397 | * is about to free, this can be used by caller to free its |
| 398 | * resources along with exchange free. |
| 399 | * |
| 400 | * The arg is passed back to resp and destructor handler. |
| 401 | * |
| 402 | * The timeout value (in msec) for an exchange is set if non zero |
| 403 | * timer_msec argument is specified. The timer is canceled when |
| 404 | * it fires or when the exchange is done. The exchange timeout handler |
| 405 | * is registered by EM layer. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 406 | * |
| 407 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 408 | */ |
| 409 | struct fc_seq *(*exch_seq_send)(struct fc_lport *lp, |
| 410 | struct fc_frame *fp, |
| 411 | void (*resp)(struct fc_seq *sp, |
| 412 | struct fc_frame *fp, |
| 413 | void *arg), |
| 414 | void (*destructor)(struct fc_seq *sp, |
| 415 | void *arg), |
| 416 | void *arg, unsigned int timer_msec); |
| 417 | |
| 418 | /* |
Yi Zou | b277d2a | 2009-02-27 14:07:21 -0800 | [diff] [blame] | 419 | * Sets up the DDP context for a given exchange id on the given |
| 420 | * scatterlist if LLD supports DDP for large receive. |
| 421 | * |
| 422 | * STATUS: OPTIONAL |
| 423 | */ |
| 424 | int (*ddp_setup)(struct fc_lport *lp, u16 xid, |
| 425 | struct scatterlist *sgl, unsigned int sgc); |
| 426 | /* |
| 427 | * Completes the DDP transfer and returns the length of data DDPed |
| 428 | * for the given exchange id. |
| 429 | * |
| 430 | * STATUS: OPTIONAL |
| 431 | */ |
| 432 | int (*ddp_done)(struct fc_lport *lp, u16 xid); |
| 433 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 434 | * Send a frame using an existing sequence and exchange. |
| 435 | * |
| 436 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 437 | */ |
| 438 | int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp, |
| 439 | struct fc_frame *fp); |
| 440 | |
| 441 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 442 | * Send an ELS response using infomation from a previous |
| 443 | * exchange and sequence. |
| 444 | * |
| 445 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 446 | */ |
| 447 | void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd, |
| 448 | struct fc_seq_els_data *els_data); |
| 449 | |
| 450 | /* |
| 451 | * Abort an exchange and sequence. Generally called because of a |
| 452 | * exchange timeout or an abort from the upper layer. |
| 453 | * |
| 454 | * A timer_msec can be specified for abort timeout, if non-zero |
| 455 | * timer_msec value is specified then exchange resp handler |
| 456 | * will be called with timeout error if no response to abort. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 457 | * |
| 458 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 459 | */ |
| 460 | int (*seq_exch_abort)(const struct fc_seq *req_sp, |
| 461 | unsigned int timer_msec); |
| 462 | |
| 463 | /* |
| 464 | * Indicate that an exchange/sequence tuple is complete and the memory |
| 465 | * allocated for the related objects may be freed. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 466 | * |
| 467 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 468 | */ |
| 469 | void (*exch_done)(struct fc_seq *sp); |
| 470 | |
| 471 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 472 | * Start a new sequence on the same exchange/sequence tuple. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 473 | * |
| 474 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 475 | */ |
| 476 | struct fc_seq *(*seq_start_next)(struct fc_seq *sp); |
| 477 | |
| 478 | /* |
| 479 | * Reset an exchange manager, completing all sequences and exchanges. |
| 480 | * If s_id is non-zero, reset only exchanges originating from that FID. |
| 481 | * If d_id is non-zero, reset only exchanges sending to that FID. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 482 | * |
| 483 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 484 | */ |
Abhijeet Joglekar | 1f6ff36 | 2009-02-27 10:54:35 -0800 | [diff] [blame] | 485 | void (*exch_mgr_reset)(struct fc_lport *, |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 486 | u32 s_id, u32 d_id); |
| 487 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 488 | /* |
| 489 | * Flush the rport work queue. Generally used before shutdown. |
| 490 | * |
| 491 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 492 | */ |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 493 | void (*rport_flush_queue)(void); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 494 | |
| 495 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 496 | * Receive a frame for a local port. |
| 497 | * |
| 498 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 499 | */ |
| 500 | void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp, |
| 501 | struct fc_frame *fp); |
| 502 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 503 | /* |
| 504 | * Reset the local port. |
| 505 | * |
| 506 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 507 | */ |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 508 | int (*lport_reset)(struct fc_lport *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 509 | |
| 510 | /* |
Robert Love | 9737e6a | 2009-08-25 14:02:59 -0700 | [diff] [blame] | 511 | * Create a remote port with a given port ID |
| 512 | * |
| 513 | * STATUS: OPTIONAL |
Robert Love | 5101ff9 | 2009-02-27 10:55:18 -0800 | [diff] [blame] | 514 | */ |
Robert Love | 9737e6a | 2009-08-25 14:02:59 -0700 | [diff] [blame] | 515 | struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); |
Robert Love | 5101ff9 | 2009-02-27 10:55:18 -0800 | [diff] [blame] | 516 | |
| 517 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 518 | * Initiates the RP state machine. It is called from the LP module. |
| 519 | * This function will issue the following commands to the N_Port |
| 520 | * identified by the FC ID provided. |
| 521 | * |
| 522 | * - PLOGI |
| 523 | * - PRLI |
| 524 | * - RTV |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 525 | * |
| 526 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 527 | */ |
Joe Eykholt | 9fb9d32 | 2009-08-25 14:00:50 -0700 | [diff] [blame] | 528 | int (*rport_login)(struct fc_rport_priv *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 529 | |
| 530 | /* |
| 531 | * Logoff, and remove the rport from the transport if |
| 532 | * it had been added. This will send a LOGO to the target. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 533 | * |
| 534 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 535 | */ |
Joe Eykholt | 9fb9d32 | 2009-08-25 14:00:50 -0700 | [diff] [blame] | 536 | int (*rport_logoff)(struct fc_rport_priv *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 537 | |
| 538 | /* |
| 539 | * Recieve a request from a remote port. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 540 | * |
| 541 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 542 | */ |
| 543 | void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, |
Joe Eykholt | 131203a | 2009-08-25 14:03:10 -0700 | [diff] [blame] | 544 | struct fc_lport *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 545 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 546 | /* |
| 547 | * lookup an rport by it's port ID. |
| 548 | * |
| 549 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 550 | */ |
Joe Eykholt | 9fb9d32 | 2009-08-25 14:00:50 -0700 | [diff] [blame] | 551 | struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 552 | |
| 553 | /* |
Joe Eykholt | f211fa5 | 2009-08-25 14:01:01 -0700 | [diff] [blame] | 554 | * Destroy an rport after final kref_put(). |
| 555 | * The argument is a pointer to the kref inside the fc_rport_priv. |
| 556 | */ |
| 557 | void (*rport_destroy)(struct kref *); |
| 558 | |
| 559 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 560 | * Send a fcp cmd from fsp pkt. |
| 561 | * Called with the SCSI host lock unlocked and irqs disabled. |
| 562 | * |
| 563 | * The resp handler is called when FCP_RSP received. |
| 564 | * |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 565 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 566 | */ |
| 567 | int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp, |
| 568 | void (*resp)(struct fc_seq *, struct fc_frame *fp, |
| 569 | void *arg)); |
| 570 | |
| 571 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 572 | * Cleanup the FCP layer, used durring link down and reset |
| 573 | * |
| 574 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 575 | */ |
| 576 | void (*fcp_cleanup)(struct fc_lport *lp); |
| 577 | |
| 578 | /* |
| 579 | * Abort all I/O on a local port |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 580 | * |
| 581 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 582 | */ |
| 583 | void (*fcp_abort_io)(struct fc_lport *lp); |
| 584 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 585 | /* |
| 586 | * Receive a request for the discovery layer. |
| 587 | * |
| 588 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 589 | */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 590 | void (*disc_recv_req)(struct fc_seq *, |
| 591 | struct fc_frame *, struct fc_lport *); |
| 592 | |
| 593 | /* |
| 594 | * Start discovery for a local port. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 595 | * |
| 596 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 597 | */ |
| 598 | void (*disc_start)(void (*disc_callback)(struct fc_lport *, |
| 599 | enum fc_disc_event), |
| 600 | struct fc_lport *); |
| 601 | |
| 602 | /* |
| 603 | * Stop discovery for a given lport. This will remove |
| 604 | * all discovered rports |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 605 | * |
| 606 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 607 | */ |
| 608 | void (*disc_stop) (struct fc_lport *); |
| 609 | |
| 610 | /* |
| 611 | * Stop discovery for a given lport. This will block |
| 612 | * until all discovered rports are deleted from the |
| 613 | * FC transport class |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 614 | * |
| 615 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 616 | */ |
| 617 | void (*disc_stop_final) (struct fc_lport *); |
| 618 | }; |
| 619 | |
| 620 | /* information used by the discovery layer */ |
| 621 | struct fc_disc { |
| 622 | unsigned char retry_count; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 623 | unsigned char pending; |
| 624 | unsigned char requested; |
| 625 | unsigned short seq_count; |
| 626 | unsigned char buf_len; |
Joe Eykholt | 0f6c614 | 2009-08-25 14:02:11 -0700 | [diff] [blame] | 627 | u16 disc_id; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 628 | |
| 629 | void (*disc_callback)(struct fc_lport *, |
| 630 | enum fc_disc_event); |
| 631 | |
| 632 | struct list_head rports; |
| 633 | struct fc_lport *lport; |
| 634 | struct mutex disc_mutex; |
| 635 | struct fc_gpn_ft_resp partial_buf; /* partial name buffer */ |
| 636 | struct delayed_work disc_work; |
| 637 | }; |
| 638 | |
| 639 | struct fc_lport { |
| 640 | struct list_head list; |
| 641 | |
| 642 | /* Associations */ |
| 643 | struct Scsi_Host *host; |
Vasu Dev | 9631609 | 2009-07-29 17:05:00 -0700 | [diff] [blame] | 644 | struct list_head ema_list; |
Chris Leech | 174e1eb | 2009-11-03 11:46:14 -0800 | [diff] [blame] | 645 | struct list_head vports; /* child vports if N_Port */ |
| 646 | struct fc_vport *vport; /* parent vport if VN_Port */ |
Joe Eykholt | 9fb9d32 | 2009-08-25 14:00:50 -0700 | [diff] [blame] | 647 | struct fc_rport_priv *dns_rp; |
| 648 | struct fc_rport_priv *ptp_rp; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 649 | void *scsi_priv; |
| 650 | struct fc_disc disc; |
| 651 | |
| 652 | /* Operational Information */ |
| 653 | struct libfc_function_template tt; |
Vasu Dev | bc0e17f | 2009-02-27 10:54:57 -0800 | [diff] [blame] | 654 | u8 link_up; |
| 655 | u8 qfull; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 656 | enum fc_lport_state state; |
| 657 | unsigned long boot_time; |
| 658 | |
| 659 | struct fc_host_statistics host_stats; |
Robert Love | 582b45b | 2009-03-31 15:51:50 -0700 | [diff] [blame] | 660 | struct fcoe_dev_stats *dev_stats; |
| 661 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 662 | u64 wwpn; |
| 663 | u64 wwnn; |
| 664 | u8 retry_count; |
| 665 | |
| 666 | /* Capabilities */ |
| 667 | u32 sg_supp:1; /* scatter gather supported */ |
| 668 | u32 seq_offload:1; /* seq offload supported */ |
| 669 | u32 crc_offload:1; /* crc offload supported */ |
| 670 | u32 lro_enabled:1; /* large receive offload */ |
Chris Leech | 174e1eb | 2009-11-03 11:46:14 -0800 | [diff] [blame] | 671 | u32 does_npiv:1; /* supports multiple vports */ |
| 672 | u32 npiv_enabled:1; /* switch/fabric allows NPIV */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 673 | u32 mfs; /* max FC payload size */ |
| 674 | unsigned int service_params; |
| 675 | unsigned int e_d_tov; |
| 676 | unsigned int r_a_tov; |
| 677 | u8 max_retry_count; |
Abhijeet Joglekar | a366695 | 2009-05-01 10:01:26 -0700 | [diff] [blame] | 678 | u8 max_rport_retry_count; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 679 | u16 link_speed; |
| 680 | u16 link_supported_speeds; |
| 681 | u16 lro_xid; /* max xid for fcoe lro */ |
Yi Zou | ea1e9a9 | 2009-02-27 14:07:04 -0800 | [diff] [blame] | 682 | unsigned int lso_max; /* max large send size */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 683 | struct fc_ns_fts fcts; /* FC-4 type masks */ |
| 684 | struct fc_els_rnid_gen rnid_gen; /* RNID information */ |
| 685 | |
| 686 | /* Semaphores */ |
| 687 | struct mutex lp_mutex; |
| 688 | |
| 689 | /* Miscellaneous */ |
| 690 | struct delayed_work retry_work; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 691 | }; |
| 692 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 693 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 694 | * FC_LPORT HELPER FUNCTIONS |
| 695 | *****************************/ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 696 | static inline int fc_lport_test_ready(struct fc_lport *lp) |
| 697 | { |
| 698 | return lp->state == LPORT_ST_READY; |
| 699 | } |
| 700 | |
| 701 | static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn) |
| 702 | { |
| 703 | lp->wwnn = wwnn; |
| 704 | } |
| 705 | |
| 706 | static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn) |
| 707 | { |
| 708 | lp->wwpn = wwnn; |
| 709 | } |
| 710 | |
| 711 | static inline void fc_lport_state_enter(struct fc_lport *lp, |
| 712 | enum fc_lport_state state) |
| 713 | { |
| 714 | if (state != lp->state) |
| 715 | lp->retry_count = 0; |
| 716 | lp->state = state; |
| 717 | } |
| 718 | |
Robert Love | 582b45b | 2009-03-31 15:51:50 -0700 | [diff] [blame] | 719 | static inline int fc_lport_init_stats(struct fc_lport *lp) |
| 720 | { |
| 721 | /* allocate per cpu stats block */ |
| 722 | lp->dev_stats = alloc_percpu(struct fcoe_dev_stats); |
| 723 | if (!lp->dev_stats) |
| 724 | return -ENOMEM; |
| 725 | return 0; |
| 726 | } |
| 727 | |
| 728 | static inline void fc_lport_free_stats(struct fc_lport *lp) |
| 729 | { |
| 730 | free_percpu(lp->dev_stats); |
| 731 | } |
| 732 | |
| 733 | static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp) |
| 734 | { |
| 735 | return per_cpu_ptr(lp->dev_stats, smp_processor_id()); |
| 736 | } |
| 737 | |
Vasu Dev | a0a25da | 2009-03-17 11:42:29 -0700 | [diff] [blame] | 738 | static inline void *lport_priv(const struct fc_lport *lp) |
| 739 | { |
| 740 | return (void *)(lp + 1); |
| 741 | } |
| 742 | |
| 743 | /** |
| 744 | * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport |
| 745 | * @sht: ptr to the scsi host templ |
| 746 | * @priv_size: size of private data after fc_lport |
| 747 | * |
Chris Leech | 8622196 | 2009-11-03 11:46:08 -0800 | [diff] [blame] | 748 | * Returns: libfc lport |
Vasu Dev | a0a25da | 2009-03-17 11:42:29 -0700 | [diff] [blame] | 749 | */ |
Chris Leech | 8622196 | 2009-11-03 11:46:08 -0800 | [diff] [blame] | 750 | static inline struct fc_lport * |
Vasu Dev | a0a25da | 2009-03-17 11:42:29 -0700 | [diff] [blame] | 751 | libfc_host_alloc(struct scsi_host_template *sht, int priv_size) |
| 752 | { |
Chris Leech | 8622196 | 2009-11-03 11:46:08 -0800 | [diff] [blame] | 753 | struct fc_lport *lport; |
| 754 | struct Scsi_Host *shost; |
| 755 | |
| 756 | shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); |
| 757 | if (!shost) |
| 758 | return NULL; |
| 759 | lport = shost_priv(shost); |
| 760 | lport->host = shost; |
| 761 | INIT_LIST_HEAD(&lport->ema_list); |
Chris Leech | 174e1eb | 2009-11-03 11:46:14 -0800 | [diff] [blame] | 762 | INIT_LIST_HEAD(&lport->vports); |
Chris Leech | 8622196 | 2009-11-03 11:46:08 -0800 | [diff] [blame] | 763 | return lport; |
Vasu Dev | a0a25da | 2009-03-17 11:42:29 -0700 | [diff] [blame] | 764 | } |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 765 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 766 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 767 | * LOCAL PORT LAYER |
| 768 | *****************************/ |
| 769 | int fc_lport_init(struct fc_lport *lp); |
| 770 | |
| 771 | /* |
| 772 | * Destroy the specified local port by finding and freeing all |
| 773 | * fc_rports associated with it and then by freeing the fc_lport |
| 774 | * itself. |
| 775 | */ |
| 776 | int fc_lport_destroy(struct fc_lport *lp); |
| 777 | |
| 778 | /* |
| 779 | * Logout the specified local port from the fabric |
| 780 | */ |
| 781 | int fc_fabric_logoff(struct fc_lport *lp); |
| 782 | |
| 783 | /* |
| 784 | * Initiate the LP state machine. This handler will use fc_host_attr |
| 785 | * to store the FLOGI service parameters, so fc_host_attr must be |
| 786 | * initialized before calling this handler. |
| 787 | */ |
| 788 | int fc_fabric_login(struct fc_lport *lp); |
| 789 | |
| 790 | /* |
| 791 | * The link is up for the given local port. |
| 792 | */ |
Chris Leech | 8faecdd | 2009-11-03 11:46:19 -0800 | [diff] [blame] | 793 | void __fc_linkup(struct fc_lport *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 794 | void fc_linkup(struct fc_lport *); |
| 795 | |
| 796 | /* |
| 797 | * Link is down for the given local port. |
| 798 | */ |
Chris Leech | 8faecdd | 2009-11-03 11:46:19 -0800 | [diff] [blame] | 799 | void __fc_linkdown(struct fc_lport *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 800 | void fc_linkdown(struct fc_lport *); |
| 801 | |
| 802 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 803 | * Configure the local port. |
| 804 | */ |
| 805 | int fc_lport_config(struct fc_lport *); |
| 806 | |
| 807 | /* |
| 808 | * Reset the local port. |
| 809 | */ |
| 810 | int fc_lport_reset(struct fc_lport *); |
| 811 | |
| 812 | /* |
| 813 | * Set the mfs or reset |
| 814 | */ |
| 815 | int fc_set_mfs(struct fc_lport *lp, u32 mfs); |
| 816 | |
Chris Leech | 174e1eb | 2009-11-03 11:46:14 -0800 | [diff] [blame] | 817 | /* |
| 818 | * Allocate a new lport struct for an NPIV VN_Port |
| 819 | */ |
| 820 | struct fc_lport *libfc_vport_create(struct fc_vport *vport, int privsize); |
| 821 | |
| 822 | /* |
| 823 | * Find an NPIV VN_Port by port ID |
| 824 | */ |
| 825 | struct fc_lport *fc_vport_id_lookup(struct fc_lport *n_port, u32 port_id); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 826 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 827 | /* |
Chris Leech | 8faecdd | 2009-11-03 11:46:19 -0800 | [diff] [blame] | 828 | * NPIV VN_Port link state management |
| 829 | */ |
| 830 | void fc_vport_setlink(struct fc_lport *vn_port); |
| 831 | void fc_vports_linkchange(struct fc_lport *n_port); |
| 832 | |
| 833 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 834 | * REMOTE PORT LAYER |
| 835 | *****************************/ |
| 836 | int fc_rport_init(struct fc_lport *lp); |
| 837 | void fc_rport_terminate_io(struct fc_rport *rp); |
| 838 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 839 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 840 | * DISCOVERY LAYER |
| 841 | *****************************/ |
| 842 | int fc_disc_init(struct fc_lport *lp); |
| 843 | |
| 844 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 845 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 846 | * SCSI LAYER |
| 847 | *****************************/ |
| 848 | /* |
| 849 | * Initialize the SCSI block of libfc |
| 850 | */ |
| 851 | int fc_fcp_init(struct fc_lport *); |
| 852 | |
| 853 | /* |
| 854 | * This section provides an API which allows direct interaction |
| 855 | * with the SCSI-ml. Each of these functions satisfies a function |
| 856 | * pointer defined in Scsi_Host and therefore is always called |
| 857 | * directly from the SCSI-ml. |
| 858 | */ |
| 859 | int fc_queuecommand(struct scsi_cmnd *sc_cmd, |
| 860 | void (*done)(struct scsi_cmnd *)); |
| 861 | |
| 862 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 863 | * Send an ABTS frame to the target device. The sc_cmd argument |
| 864 | * is a pointer to the SCSI command to be aborted. |
| 865 | */ |
| 866 | int fc_eh_abort(struct scsi_cmnd *sc_cmd); |
| 867 | |
| 868 | /* |
| 869 | * Reset a LUN by sending send the tm cmd to the target. |
| 870 | */ |
| 871 | int fc_eh_device_reset(struct scsi_cmnd *sc_cmd); |
| 872 | |
| 873 | /* |
| 874 | * Reset the host adapter. |
| 875 | */ |
| 876 | int fc_eh_host_reset(struct scsi_cmnd *sc_cmd); |
| 877 | |
| 878 | /* |
| 879 | * Check rport status. |
| 880 | */ |
| 881 | int fc_slave_alloc(struct scsi_device *sdev); |
| 882 | |
| 883 | /* |
| 884 | * Adjust the queue depth. |
| 885 | */ |
Mike Christie | e881a17 | 2009-10-15 17:46:39 -0700 | [diff] [blame] | 886 | int fc_change_queue_depth(struct scsi_device *sdev, int qdepth, int reason); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 887 | |
| 888 | /* |
| 889 | * Change the tag type. |
| 890 | */ |
| 891 | int fc_change_queue_type(struct scsi_device *sdev, int tag_type); |
| 892 | |
| 893 | /* |
| 894 | * Free memory pools used by the FCP layer. |
| 895 | */ |
| 896 | void fc_fcp_destroy(struct fc_lport *); |
| 897 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 898 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 899 | * ELS/CT interface |
| 900 | *****************************/ |
| 901 | /* |
| 902 | * Initializes ELS/CT interface |
| 903 | */ |
| 904 | int fc_elsct_init(struct fc_lport *lp); |
Chris Leech | 11b5618 | 2009-11-03 11:46:29 -0800 | [diff] [blame] | 905 | struct fc_seq *fc_elsct_send(struct fc_lport *lport, |
| 906 | u32 did, |
| 907 | struct fc_frame *fp, |
| 908 | unsigned int op, |
| 909 | void (*resp)(struct fc_seq *, |
| 910 | struct fc_frame *fp, |
| 911 | void *arg), |
| 912 | void *arg, u32 timer_msec); |
| 913 | void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); |
| 914 | void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 915 | |
| 916 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 917 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 918 | * EXCHANGE MANAGER LAYER |
| 919 | *****************************/ |
| 920 | /* |
| 921 | * Initializes Exchange Manager related |
| 922 | * function pointers in struct libfc_function_template. |
| 923 | */ |
| 924 | int fc_exch_init(struct fc_lport *lp); |
| 925 | |
| 926 | /* |
Vasu Dev | 9631609 | 2009-07-29 17:05:00 -0700 | [diff] [blame] | 927 | * Adds Exchange Manager (EM) mp to lport. |
| 928 | * |
| 929 | * Adds specified mp to lport using struct fc_exch_mgr_anchor, |
| 930 | * the struct fc_exch_mgr_anchor allows same EM sharing by |
| 931 | * more than one lport with their specified match function, |
| 932 | * the match function is used in allocating exchange from |
| 933 | * added mp. |
| 934 | */ |
| 935 | struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport, |
| 936 | struct fc_exch_mgr *mp, |
| 937 | bool (*match)(struct fc_frame *)); |
| 938 | |
| 939 | /* |
| 940 | * Deletes Exchange Manager (EM) from lport by removing |
| 941 | * its anchor ema from lport. |
| 942 | * |
| 943 | * If removed anchor ema was the last user of its associated EM |
| 944 | * then also destroys associated EM. |
| 945 | */ |
| 946 | void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema); |
| 947 | |
| 948 | /* |
Chris Leech | 174e1eb | 2009-11-03 11:46:14 -0800 | [diff] [blame] | 949 | * Clone an exchange manager list, getting reference holds for each EM. |
| 950 | * This is for use with NPIV and sharing the X_ID space between VN_Ports. |
| 951 | */ |
| 952 | int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); |
| 953 | |
| 954 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 955 | * Allocates an Exchange Manager (EM). |
| 956 | * |
| 957 | * The EM manages exchanges for their allocation and |
| 958 | * free, also allows exchange lookup for received |
| 959 | * frame. |
| 960 | * |
| 961 | * The class is used for initializing FC class of |
| 962 | * allocated exchange from EM. |
| 963 | * |
| 964 | * The min_xid and max_xid will limit new |
| 965 | * exchange ID (XID) within this range for |
| 966 | * a new exchange. |
| 967 | * The LLD may choose to have multiple EMs, |
| 968 | * e.g. one EM instance per CPU receive thread in LLD. |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 969 | * |
Vasu Dev | 52ff878 | 2009-07-29 17:05:10 -0700 | [diff] [blame] | 970 | * Specified match function is used in allocating exchanges |
| 971 | * from newly allocated EM. |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 972 | */ |
| 973 | struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp, |
| 974 | enum fc_class class, |
| 975 | u16 min_xid, |
Vasu Dev | 52ff878 | 2009-07-29 17:05:10 -0700 | [diff] [blame] | 976 | u16 max_xid, |
| 977 | bool (*match)(struct fc_frame *)); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 978 | |
| 979 | /* |
Vasu Dev | 52ff878 | 2009-07-29 17:05:10 -0700 | [diff] [blame] | 980 | * Free all exchange managers of a lport. |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 981 | */ |
Vasu Dev | 52ff878 | 2009-07-29 17:05:10 -0700 | [diff] [blame] | 982 | void fc_exch_mgr_free(struct fc_lport *lport); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 983 | |
| 984 | /* |
| 985 | * Receive a frame on specified local port and exchange manager. |
| 986 | */ |
Vasu Dev | 52ff878 | 2009-07-29 17:05:10 -0700 | [diff] [blame] | 987 | void fc_exch_recv(struct fc_lport *lp, struct fc_frame *fp); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 988 | |
| 989 | /* |
Vasu Dev | b2f0091 | 2009-08-25 13:58:53 -0700 | [diff] [blame] | 990 | * Reset all EMs of a lport, releasing its all sequences and |
| 991 | * exchanges. If sid is non-zero, then reset only exchanges |
| 992 | * we sourced from that FID. If did is non-zero, reset only |
| 993 | * exchanges destined to that FID. |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 994 | */ |
Abhijeet Joglekar | 1f6ff36 | 2009-02-27 10:54:35 -0800 | [diff] [blame] | 995 | void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 996 | |
| 997 | /* |
| 998 | * Functions for fc_functions_template |
| 999 | */ |
| 1000 | void fc_get_host_speed(struct Scsi_Host *shost); |
| 1001 | void fc_get_host_port_type(struct Scsi_Host *shost); |
| 1002 | void fc_get_host_port_state(struct Scsi_Host *shost); |
| 1003 | void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout); |
| 1004 | struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); |
| 1005 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 1006 | #endif /* _LIBFC_H_ */ |