18866a5d9SRobert Love /* 28866a5d9SRobert Love * Copyright(c) 2009 Intel Corporation. All rights reserved. 38866a5d9SRobert Love * 48866a5d9SRobert Love * This program is free software; you can redistribute it and/or modify it 58866a5d9SRobert Love * under the terms and conditions of the GNU General Public License, 68866a5d9SRobert Love * version 2, as published by the Free Software Foundation. 78866a5d9SRobert Love * 88866a5d9SRobert Love * This program is distributed in the hope it will be useful, but WITHOUT 98866a5d9SRobert Love * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 108866a5d9SRobert Love * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 118866a5d9SRobert Love * more details. 128866a5d9SRobert Love * 138866a5d9SRobert Love * You should have received a copy of the GNU General Public License along with 148866a5d9SRobert Love * this program; if not, write to the Free Software Foundation, Inc., 158866a5d9SRobert Love * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 168866a5d9SRobert Love * 178866a5d9SRobert Love * Maintained at www.Open-FCoE.org 188866a5d9SRobert Love */ 198866a5d9SRobert Love 208866a5d9SRobert Love #include <linux/kernel.h> 218866a5d9SRobert Love #include <linux/types.h> 228866a5d9SRobert Love #include <linux/scatterlist.h> 238866a5d9SRobert Love #include <linux/crc32.h> 24acf3368fSPaul Gortmaker #include <linux/module.h> 258866a5d9SRobert Love 268866a5d9SRobert Love #include <scsi/libfc.h> 2724f089e2SJoe Eykholt #include <scsi/fc_encode.h> 288866a5d9SRobert Love 298866a5d9SRobert Love #include "fc_libfc.h" 308866a5d9SRobert Love 318866a5d9SRobert Love MODULE_AUTHOR("Open-FCoE.org"); 328866a5d9SRobert Love MODULE_DESCRIPTION("libfc"); 338866a5d9SRobert Love MODULE_LICENSE("GPL v2"); 348866a5d9SRobert Love 358866a5d9SRobert Love unsigned int fc_debug_logging; 368866a5d9SRobert Love module_param_named(debug_logging, fc_debug_logging, int, S_IRUGO|S_IWUSR); 378866a5d9SRobert Love MODULE_PARM_DESC(debug_logging, "a bit mask of logging levels"); 3893e6d5abSRobert Love 3996ad8464SJoe Eykholt DEFINE_MUTEX(fc_prov_mutex); 4070d53b04SJoe Eykholt static LIST_HEAD(fc_local_ports); 4170d53b04SJoe Eykholt struct blocking_notifier_head fc_lport_notifier_head = 4270d53b04SJoe Eykholt BLOCKING_NOTIFIER_INIT(fc_lport_notifier_head); 4370d53b04SJoe Eykholt EXPORT_SYMBOL(fc_lport_notifier_head); 4496ad8464SJoe Eykholt 4596ad8464SJoe Eykholt /* 4696ad8464SJoe Eykholt * Providers which primarily send requests and PRLIs. 4796ad8464SJoe Eykholt */ 4896ad8464SJoe Eykholt struct fc4_prov *fc_active_prov[FC_FC4_PROV_SIZE] = { 4996ad8464SJoe Eykholt [0] = &fc_rport_t0_prov, 5096ad8464SJoe Eykholt [FC_TYPE_FCP] = &fc_rport_fcp_init, 5196ad8464SJoe Eykholt }; 5296ad8464SJoe Eykholt 5396ad8464SJoe Eykholt /* 5496ad8464SJoe Eykholt * Providers which receive requests. 5596ad8464SJoe Eykholt */ 5696ad8464SJoe Eykholt struct fc4_prov *fc_passive_prov[FC_FC4_PROV_SIZE] = { 5796ad8464SJoe Eykholt [FC_TYPE_ELS] = &fc_lport_els_prov, 5896ad8464SJoe Eykholt }; 5996ad8464SJoe Eykholt 6093e6d5abSRobert Love /** 6193e6d5abSRobert Love * libfc_init() - Initialize libfc.ko 6293e6d5abSRobert Love */ 6393e6d5abSRobert Love static int __init libfc_init(void) 6493e6d5abSRobert Love { 6593e6d5abSRobert Love int rc = 0; 6693e6d5abSRobert Love 6793e6d5abSRobert Love rc = fc_setup_fcp(); 6893e6d5abSRobert Love if (rc) 6993e6d5abSRobert Love return rc; 7093e6d5abSRobert Love 7193e6d5abSRobert Love rc = fc_setup_exch_mgr(); 7293e6d5abSRobert Love if (rc) 7393e6d5abSRobert Love goto destroy_pkt_cache; 7493e6d5abSRobert Love 7593e6d5abSRobert Love rc = fc_setup_rport(); 7693e6d5abSRobert Love if (rc) 7793e6d5abSRobert Love goto destroy_em; 7893e6d5abSRobert Love 7993e6d5abSRobert Love return rc; 8093e6d5abSRobert Love destroy_em: 8193e6d5abSRobert Love fc_destroy_exch_mgr(); 8293e6d5abSRobert Love destroy_pkt_cache: 8393e6d5abSRobert Love fc_destroy_fcp(); 8493e6d5abSRobert Love return rc; 8593e6d5abSRobert Love } 8693e6d5abSRobert Love module_init(libfc_init); 8793e6d5abSRobert Love 8893e6d5abSRobert Love /** 8993e6d5abSRobert Love * libfc_exit() - Tear down libfc.ko 9093e6d5abSRobert Love */ 9193e6d5abSRobert Love static void __exit libfc_exit(void) 9293e6d5abSRobert Love { 9393e6d5abSRobert Love fc_destroy_fcp(); 9493e6d5abSRobert Love fc_destroy_exch_mgr(); 9593e6d5abSRobert Love fc_destroy_rport(); 9693e6d5abSRobert Love } 9793e6d5abSRobert Love module_exit(libfc_exit); 9858682874SRobert Love 9958682874SRobert Love /** 10058682874SRobert Love * fc_copy_buffer_to_sglist() - This routine copies the data of a buffer 10158682874SRobert Love * into a scatter-gather list (SG list). 10258682874SRobert Love * 10358682874SRobert Love * @buf: pointer to the data buffer. 10458682874SRobert Love * @len: the byte-length of the data buffer. 10558682874SRobert Love * @sg: pointer to the pointer of the SG list. 10658682874SRobert Love * @nents: pointer to the remaining number of entries in the SG list. 10758682874SRobert Love * @offset: pointer to the current offset in the SG list. 10858682874SRobert Love * @crc: pointer to the 32-bit crc value. 10958682874SRobert Love * If crc is NULL, CRC is not calculated. 11058682874SRobert Love */ 11158682874SRobert Love u32 fc_copy_buffer_to_sglist(void *buf, size_t len, 11258682874SRobert Love struct scatterlist *sg, 11358682874SRobert Love u32 *nents, size_t *offset, 11477dfce07SCong Wang u32 *crc) 11558682874SRobert Love { 11658682874SRobert Love size_t remaining = len; 11758682874SRobert Love u32 copy_len = 0; 11858682874SRobert Love 11958682874SRobert Love while (remaining > 0 && sg) { 12058682874SRobert Love size_t off, sg_bytes; 12158682874SRobert Love void *page_addr; 12258682874SRobert Love 12358682874SRobert Love if (*offset >= sg->length) { 12458682874SRobert Love /* 12558682874SRobert Love * Check for end and drop resources 12658682874SRobert Love * from the last iteration. 12758682874SRobert Love */ 12858682874SRobert Love if (!(*nents)) 12958682874SRobert Love break; 13058682874SRobert Love --(*nents); 13158682874SRobert Love *offset -= sg->length; 13258682874SRobert Love sg = sg_next(sg); 13358682874SRobert Love continue; 13458682874SRobert Love } 13558682874SRobert Love sg_bytes = min(remaining, sg->length - *offset); 13658682874SRobert Love 13758682874SRobert Love /* 13858682874SRobert Love * The scatterlist item may be bigger than PAGE_SIZE, 13958682874SRobert Love * but we are limited to mapping PAGE_SIZE at a time. 14058682874SRobert Love */ 14158682874SRobert Love off = *offset + sg->offset; 14258682874SRobert Love sg_bytes = min(sg_bytes, 14358682874SRobert Love (size_t)(PAGE_SIZE - (off & ~PAGE_MASK))); 14477dfce07SCong Wang page_addr = kmap_atomic(sg_page(sg) + (off >> PAGE_SHIFT)); 14558682874SRobert Love if (crc) 14658682874SRobert Love *crc = crc32(*crc, buf, sg_bytes); 14758682874SRobert Love memcpy((char *)page_addr + (off & ~PAGE_MASK), buf, sg_bytes); 14877dfce07SCong Wang kunmap_atomic(page_addr); 14958682874SRobert Love buf += sg_bytes; 15058682874SRobert Love *offset += sg_bytes; 15158682874SRobert Love remaining -= sg_bytes; 15258682874SRobert Love copy_len += sg_bytes; 15358682874SRobert Love } 15458682874SRobert Love return copy_len; 15558682874SRobert Love } 15624f089e2SJoe Eykholt 15724f089e2SJoe Eykholt /** 15824f089e2SJoe Eykholt * fc_fill_hdr() - fill FC header fields based on request 15924f089e2SJoe Eykholt * @fp: reply frame containing header to be filled in 16024f089e2SJoe Eykholt * @in_fp: request frame containing header to use in filling in reply 16124f089e2SJoe Eykholt * @r_ctl: R_CTL value for header 16224f089e2SJoe Eykholt * @f_ctl: F_CTL value for header, with 0 pad 16324f089e2SJoe Eykholt * @seq_cnt: sequence count for the header, ignored if frame has a sequence 16424f089e2SJoe Eykholt * @parm_offset: parameter / offset value 16524f089e2SJoe Eykholt */ 16624f089e2SJoe Eykholt void fc_fill_hdr(struct fc_frame *fp, const struct fc_frame *in_fp, 16724f089e2SJoe Eykholt enum fc_rctl r_ctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset) 16824f089e2SJoe Eykholt { 16924f089e2SJoe Eykholt struct fc_frame_header *fh; 17024f089e2SJoe Eykholt struct fc_frame_header *in_fh; 17124f089e2SJoe Eykholt struct fc_seq *sp; 17224f089e2SJoe Eykholt u32 fill; 17324f089e2SJoe Eykholt 17424f089e2SJoe Eykholt fh = __fc_frame_header_get(fp); 17524f089e2SJoe Eykholt in_fh = __fc_frame_header_get(in_fp); 17624f089e2SJoe Eykholt 17724f089e2SJoe Eykholt if (f_ctl & FC_FC_END_SEQ) { 17824f089e2SJoe Eykholt fill = -fr_len(fp) & 3; 17924f089e2SJoe Eykholt if (fill) { 18024f089e2SJoe Eykholt /* TODO, this may be a problem with fragmented skb */ 181b080db58SJohannes Berg skb_put_zero(fp_skb(fp), fill); 18224f089e2SJoe Eykholt f_ctl |= fill; 18324f089e2SJoe Eykholt } 18424f089e2SJoe Eykholt fr_eof(fp) = FC_EOF_T; 18524f089e2SJoe Eykholt } else { 18624f089e2SJoe Eykholt WARN_ON(fr_len(fp) % 4 != 0); /* no pad to non last frame */ 18724f089e2SJoe Eykholt fr_eof(fp) = FC_EOF_N; 18824f089e2SJoe Eykholt } 18924f089e2SJoe Eykholt 19024f089e2SJoe Eykholt fh->fh_r_ctl = r_ctl; 19124f089e2SJoe Eykholt memcpy(fh->fh_d_id, in_fh->fh_s_id, sizeof(fh->fh_d_id)); 19224f089e2SJoe Eykholt memcpy(fh->fh_s_id, in_fh->fh_d_id, sizeof(fh->fh_s_id)); 19324f089e2SJoe Eykholt fh->fh_type = in_fh->fh_type; 19424f089e2SJoe Eykholt hton24(fh->fh_f_ctl, f_ctl); 19524f089e2SJoe Eykholt fh->fh_ox_id = in_fh->fh_ox_id; 19624f089e2SJoe Eykholt fh->fh_rx_id = in_fh->fh_rx_id; 19724f089e2SJoe Eykholt fh->fh_cs_ctl = 0; 19824f089e2SJoe Eykholt fh->fh_df_ctl = 0; 19924f089e2SJoe Eykholt fh->fh_parm_offset = htonl(parm_offset); 20024f089e2SJoe Eykholt 20124f089e2SJoe Eykholt sp = fr_seq(in_fp); 20224f089e2SJoe Eykholt if (sp) { 20324f089e2SJoe Eykholt fr_seq(fp) = sp; 20424f089e2SJoe Eykholt fh->fh_seq_id = sp->id; 20524f089e2SJoe Eykholt seq_cnt = sp->cnt; 20624f089e2SJoe Eykholt } else { 20724f089e2SJoe Eykholt fh->fh_seq_id = 0; 20824f089e2SJoe Eykholt } 20924f089e2SJoe Eykholt fh->fh_seq_cnt = ntohs(seq_cnt); 21024f089e2SJoe Eykholt fr_sof(fp) = seq_cnt ? FC_SOF_N3 : FC_SOF_I3; 21124f089e2SJoe Eykholt fr_encaps(fp) = fr_encaps(in_fp); 21224f089e2SJoe Eykholt } 21324f089e2SJoe Eykholt EXPORT_SYMBOL(fc_fill_hdr); 21424f089e2SJoe Eykholt 21524f089e2SJoe Eykholt /** 21624f089e2SJoe Eykholt * fc_fill_reply_hdr() - fill FC reply header fields based on request 21724f089e2SJoe Eykholt * @fp: reply frame containing header to be filled in 21824f089e2SJoe Eykholt * @in_fp: request frame containing header to use in filling in reply 21924f089e2SJoe Eykholt * @r_ctl: R_CTL value for reply 22024f089e2SJoe Eykholt * @parm_offset: parameter / offset value 22124f089e2SJoe Eykholt */ 22224f089e2SJoe Eykholt void fc_fill_reply_hdr(struct fc_frame *fp, const struct fc_frame *in_fp, 22324f089e2SJoe Eykholt enum fc_rctl r_ctl, u32 parm_offset) 22424f089e2SJoe Eykholt { 22524f089e2SJoe Eykholt struct fc_seq *sp; 22624f089e2SJoe Eykholt 22724f089e2SJoe Eykholt sp = fr_seq(in_fp); 22824f089e2SJoe Eykholt if (sp) 229c6865b30SHannes Reinecke fr_seq(fp) = fc_seq_start_next(sp); 23024f089e2SJoe Eykholt fc_fill_hdr(fp, in_fp, r_ctl, FC_FCTL_RESP, 0, parm_offset); 23124f089e2SJoe Eykholt } 23224f089e2SJoe Eykholt EXPORT_SYMBOL(fc_fill_reply_hdr); 23396ad8464SJoe Eykholt 234acc1a921SKiran Patil /** 235acc1a921SKiran Patil * fc_fc4_conf_lport_params() - Modify "service_params" of specified lport 236acc1a921SKiran Patil * if there is service provider (target provider) registered with libfc 237acc1a921SKiran Patil * for specified "fc_ft_type" 238acc1a921SKiran Patil * @lport: Local port which service_params needs to be modified 239acc1a921SKiran Patil * @type: FC-4 type, such as FC_TYPE_FCP 240acc1a921SKiran Patil */ 241acc1a921SKiran Patil void fc_fc4_conf_lport_params(struct fc_lport *lport, enum fc_fh_type type) 242acc1a921SKiran Patil { 243acc1a921SKiran Patil struct fc4_prov *prov_entry; 244acc1a921SKiran Patil BUG_ON(type >= FC_FC4_PROV_SIZE); 245acc1a921SKiran Patil BUG_ON(!lport); 246acc1a921SKiran Patil prov_entry = fc_passive_prov[type]; 247acc1a921SKiran Patil if (type == FC_TYPE_FCP) { 248acc1a921SKiran Patil if (prov_entry && prov_entry->recv) 249acc1a921SKiran Patil lport->service_params |= FCP_SPPF_TARG_FCN; 250acc1a921SKiran Patil } 251acc1a921SKiran Patil } 252acc1a921SKiran Patil 25370d53b04SJoe Eykholt void fc_lport_iterate(void (*notify)(struct fc_lport *, void *), void *arg) 25470d53b04SJoe Eykholt { 25570d53b04SJoe Eykholt struct fc_lport *lport; 25670d53b04SJoe Eykholt 25770d53b04SJoe Eykholt mutex_lock(&fc_prov_mutex); 25870d53b04SJoe Eykholt list_for_each_entry(lport, &fc_local_ports, lport_list) 25970d53b04SJoe Eykholt notify(lport, arg); 26070d53b04SJoe Eykholt mutex_unlock(&fc_prov_mutex); 26170d53b04SJoe Eykholt } 26270d53b04SJoe Eykholt EXPORT_SYMBOL(fc_lport_iterate); 26370d53b04SJoe Eykholt 26496ad8464SJoe Eykholt /** 26596ad8464SJoe Eykholt * fc_fc4_register_provider() - register FC-4 upper-level provider. 26696ad8464SJoe Eykholt * @type: FC-4 type, such as FC_TYPE_FCP 26796ad8464SJoe Eykholt * @prov: structure describing provider including ops vector. 26896ad8464SJoe Eykholt * 26996ad8464SJoe Eykholt * Returns 0 on success, negative error otherwise. 27096ad8464SJoe Eykholt */ 27196ad8464SJoe Eykholt int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *prov) 27296ad8464SJoe Eykholt { 27396ad8464SJoe Eykholt struct fc4_prov **prov_entry; 27496ad8464SJoe Eykholt int ret = 0; 27596ad8464SJoe Eykholt 27696ad8464SJoe Eykholt if (type >= FC_FC4_PROV_SIZE) 27796ad8464SJoe Eykholt return -EINVAL; 27896ad8464SJoe Eykholt mutex_lock(&fc_prov_mutex); 27996ad8464SJoe Eykholt prov_entry = (prov->recv ? fc_passive_prov : fc_active_prov) + type; 28096ad8464SJoe Eykholt if (*prov_entry) 28196ad8464SJoe Eykholt ret = -EBUSY; 28296ad8464SJoe Eykholt else 28396ad8464SJoe Eykholt *prov_entry = prov; 28496ad8464SJoe Eykholt mutex_unlock(&fc_prov_mutex); 28596ad8464SJoe Eykholt return ret; 28696ad8464SJoe Eykholt } 28796ad8464SJoe Eykholt EXPORT_SYMBOL(fc_fc4_register_provider); 28896ad8464SJoe Eykholt 28996ad8464SJoe Eykholt /** 29096ad8464SJoe Eykholt * fc_fc4_deregister_provider() - deregister FC-4 upper-level provider. 29196ad8464SJoe Eykholt * @type: FC-4 type, such as FC_TYPE_FCP 29296ad8464SJoe Eykholt * @prov: structure describing provider including ops vector. 29396ad8464SJoe Eykholt */ 29496ad8464SJoe Eykholt void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *prov) 29596ad8464SJoe Eykholt { 29696ad8464SJoe Eykholt BUG_ON(type >= FC_FC4_PROV_SIZE); 29796ad8464SJoe Eykholt mutex_lock(&fc_prov_mutex); 29896ad8464SJoe Eykholt if (prov->recv) 299f4303d8fSAndreea-Cristina Bernat RCU_INIT_POINTER(fc_passive_prov[type], NULL); 30096ad8464SJoe Eykholt else 301f4303d8fSAndreea-Cristina Bernat RCU_INIT_POINTER(fc_active_prov[type], NULL); 30296ad8464SJoe Eykholt mutex_unlock(&fc_prov_mutex); 30396ad8464SJoe Eykholt synchronize_rcu(); 30496ad8464SJoe Eykholt } 30596ad8464SJoe Eykholt EXPORT_SYMBOL(fc_fc4_deregister_provider); 30670d53b04SJoe Eykholt 30770d53b04SJoe Eykholt /** 30870d53b04SJoe Eykholt * fc_fc4_add_lport() - add new local port to list and run notifiers. 30970d53b04SJoe Eykholt * @lport: The new local port. 31070d53b04SJoe Eykholt */ 31170d53b04SJoe Eykholt void fc_fc4_add_lport(struct fc_lport *lport) 31270d53b04SJoe Eykholt { 31370d53b04SJoe Eykholt mutex_lock(&fc_prov_mutex); 31470d53b04SJoe Eykholt list_add_tail(&lport->lport_list, &fc_local_ports); 31570d53b04SJoe Eykholt blocking_notifier_call_chain(&fc_lport_notifier_head, 31670d53b04SJoe Eykholt FC_LPORT_EV_ADD, lport); 31770d53b04SJoe Eykholt mutex_unlock(&fc_prov_mutex); 31870d53b04SJoe Eykholt } 31970d53b04SJoe Eykholt 32070d53b04SJoe Eykholt /** 32170d53b04SJoe Eykholt * fc_fc4_del_lport() - remove local port from list and run notifiers. 32270d53b04SJoe Eykholt * @lport: The new local port. 32370d53b04SJoe Eykholt */ 32470d53b04SJoe Eykholt void fc_fc4_del_lport(struct fc_lport *lport) 32570d53b04SJoe Eykholt { 32670d53b04SJoe Eykholt mutex_lock(&fc_prov_mutex); 32770d53b04SJoe Eykholt list_del(&lport->lport_list); 32870d53b04SJoe Eykholt blocking_notifier_call_chain(&fc_lport_notifier_head, 32970d53b04SJoe Eykholt FC_LPORT_EV_DEL, lport); 33070d53b04SJoe Eykholt mutex_unlock(&fc_prov_mutex); 33170d53b04SJoe Eykholt } 332