xref: /linux/drivers/scsi/bfa/bfad_im.h (revision d39d0ed196aa1685bb24771e92f78633c66ac9cb)
1 /*
2  * Copyright (c) 2005-2009 Brocade Communications Systems, Inc.
3  * All rights reserved
4  * www.brocade.com
5  *
6  * Linux driver for Brocade Fibre Channel Host Bus Adapter.
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License (GPL) Version 2 as
10  * published by the Free Software Foundation
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  */
17 
18 #ifndef __BFAD_IM_H__
19 #define __BFAD_IM_H__
20 
21 #include "fcs/bfa_fcs_fcpim.h"
22 #include "bfad_im_compat.h"
23 
24 #define FCPI_NAME " fcpim"
25 
26 bfa_status_t bfad_im_module_init(void);
27 void bfad_im_module_exit(void);
28 bfa_status_t bfad_im_probe(struct bfad_s *bfad);
29 void bfad_im_probe_undo(struct bfad_s *bfad);
30 void bfad_im_probe_post(struct bfad_im_s *im);
31 bfa_status_t bfad_im_port_new(struct bfad_s *bfad, struct bfad_port_s *port);
32 void bfad_im_port_delete(struct bfad_s *bfad, struct bfad_port_s *port);
33 void bfad_im_port_online(struct bfad_s *bfad, struct bfad_port_s *port);
34 void bfad_im_port_offline(struct bfad_s *bfad, struct bfad_port_s *port);
35 void bfad_im_port_clean(struct bfad_im_port_s *im_port);
36 int  bfad_im_scsi_host_alloc(struct bfad_s *bfad,
37 		struct bfad_im_port_s *im_port, struct device *dev);
38 void bfad_im_scsi_host_free(struct bfad_s *bfad,
39 				struct bfad_im_port_s *im_port);
40 
41 #define MAX_FCP_TARGET 1024
42 #define MAX_FCP_LUN 16384
43 #define BFAD_TARGET_RESET_TMO 60
44 #define BFAD_LUN_RESET_TMO 60
45 #define ScsiResult(host_code, scsi_code) (((host_code) << 16) | scsi_code)
46 #define BFA_QUEUE_FULL_RAMP_UP_TIME 120
47 #define BFAD_KOBJ_NAME_LEN 20
48 
49 /*
50  * itnim flags
51  */
52 #define ITNIM_MAPPED		0x00000001
53 
54 #define SCSI_TASK_MGMT		0x00000001
55 #define IO_DONE_BIT			0
56 
57 struct bfad_itnim_data_s {
58 	struct bfad_itnim_s *itnim;
59 };
60 
61 struct bfad_im_port_s {
62 	struct bfad_s         *bfad;
63 	struct bfad_port_s    *port;
64 	struct work_struct port_delete_work;
65 	int             idr_id;
66 	u16        cur_scsi_id;
67 	u16	   flags;
68 	struct list_head binding_list;
69 	struct Scsi_Host *shost;
70 	struct list_head itnim_mapped_list;
71 	struct fc_vport *fc_vport;
72 };
73 
74 enum bfad_itnim_state {
75 	ITNIM_STATE_NONE,
76 	ITNIM_STATE_ONLINE,
77 	ITNIM_STATE_OFFLINE_PENDING,
78 	ITNIM_STATE_OFFLINE,
79 	ITNIM_STATE_TIMEOUT,
80 	ITNIM_STATE_FREE,
81 };
82 
83 /*
84  * Per itnim data structure
85  */
86 struct bfad_itnim_s {
87 	struct list_head list_entry;
88 	struct bfa_fcs_itnim_s fcs_itnim;
89 	struct work_struct itnim_work;
90 	u32        flags;
91 	enum bfad_itnim_state state;
92 	struct bfad_im_s *im;
93 	struct bfad_im_port_s *im_port;
94 	struct bfad_rport_s *drv_rport;
95 	struct fc_rport *fc_rport;
96 	struct bfa_itnim_s *bfa_itnim;
97 	u16        scsi_tgt_id;
98 	u16        queue_work;
99 	unsigned long	last_ramp_up_time;
100 	unsigned long	last_queue_full_time;
101 };
102 
103 enum bfad_binding_type {
104 	FCP_PWWN_BINDING = 0x1,
105 	FCP_NWWN_BINDING = 0x2,
106 	FCP_FCID_BINDING = 0x3,
107 };
108 
109 struct bfad_fcp_binding {
110 	struct list_head list_entry;
111 	enum bfad_binding_type binding_type;
112 	u16        scsi_target_id;
113 	u32        fc_id;
114 	wwn_t           nwwn;
115 	wwn_t           pwwn;
116 };
117 
118 struct bfad_im_s {
119 	struct bfad_s         *bfad;
120 	struct workqueue_struct *drv_workq;
121 	char   drv_workq_name[BFAD_KOBJ_NAME_LEN];
122 };
123 
124 struct Scsi_Host *bfad_os_scsi_host_alloc(struct bfad_im_port_s *im_port,
125 				struct bfad_s *);
126 bfa_status_t bfad_os_thread_workq(struct bfad_s *bfad);
127 void bfad_os_destroy_workq(struct bfad_im_s *im);
128 void bfad_os_itnim_process(struct bfad_itnim_s *itnim_drv);
129 void bfad_os_fc_host_init(struct bfad_im_port_s *im_port);
130 void bfad_os_scsi_host_free(struct bfad_s *bfad,
131 				 struct bfad_im_port_s *im_port);
132 void bfad_os_ramp_up_qdepth(struct bfad_itnim_s *itnim,
133 				 struct scsi_device *sdev);
134 void bfad_os_handle_qfull(struct bfad_itnim_s *itnim, struct scsi_device *sdev);
135 struct bfad_itnim_s *bfad_os_get_itnim(struct bfad_im_port_s *im_port, int id);
136 int bfad_os_scsi_add_host(struct Scsi_Host *shost,
137 		struct bfad_im_port_s *im_port, struct bfad_s *bfad);
138 
139 void bfad_im_itnim_unmap(struct bfad_im_port_s  *im_port,
140 			 struct bfad_itnim_s *itnim);
141 
142 extern struct scsi_host_template bfad_im_scsi_host_template;
143 extern struct scsi_host_template bfad_im_vport_template;
144 extern struct fc_function_template bfad_im_fc_function_template;
145 extern struct fc_function_template bfad_im_vport_fc_function_template;
146 extern struct scsi_transport_template *bfad_im_scsi_transport_template;
147 extern struct scsi_transport_template *bfad_im_scsi_vport_transport_template;
148 
149 #endif
150