xref: /openbmc/linux/drivers/scsi/bfa/bfad_im.h (revision a09d2831)
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 void bfad_flags_set(struct bfad_s *bfad, u32 flags);
27 bfa_status_t bfad_im_module_init(void);
28 void bfad_im_module_exit(void);
29 bfa_status_t bfad_im_probe(struct bfad_s *bfad);
30 void bfad_im_probe_undo(struct bfad_s *bfad);
31 void bfad_im_probe_post(struct bfad_im_s *im);
32 bfa_status_t bfad_im_port_new(struct bfad_s *bfad, struct bfad_port_s *port);
33 void bfad_im_port_delete(struct bfad_s *bfad, struct bfad_port_s *port);
34 void bfad_im_port_online(struct bfad_s *bfad, struct bfad_port_s *port);
35 void bfad_im_port_offline(struct bfad_s *bfad, struct bfad_port_s *port);
36 void bfad_im_port_clean(struct bfad_im_port_s *im_port);
37 int  bfad_im_scsi_host_alloc(struct bfad_s *bfad,
38 				struct bfad_im_port_s *im_port);
39 void bfad_im_scsi_host_free(struct bfad_s *bfad,
40 				struct bfad_im_port_s *im_port);
41 
42 #define MAX_FCP_TARGET 1024
43 #define MAX_FCP_LUN 16384
44 #define BFAD_TARGET_RESET_TMO 60
45 #define BFAD_LUN_RESET_TMO 60
46 #define ScsiResult(host_code, scsi_code) (((host_code) << 16) | scsi_code)
47 #define BFA_QUEUE_FULL_RAMP_UP_TIME 120
48 #define BFAD_KOBJ_NAME_LEN 20
49 
50 /*
51  * itnim flags
52  */
53 #define ITNIM_MAPPED		0x00000001
54 
55 #define SCSI_TASK_MGMT		0x00000001
56 #define IO_DONE_BIT			0
57 
58 struct bfad_itnim_data_s {
59 	struct bfad_itnim_s *itnim;
60 };
61 
62 struct bfad_im_port_s {
63 	struct bfad_s         *bfad;
64 	struct bfad_port_s    *port;
65 	struct work_struct port_delete_work;
66 	int             idr_id;
67 	u16        cur_scsi_id;
68 	struct list_head binding_list;
69 	struct Scsi_Host *shost;
70 	struct list_head itnim_mapped_list;
71 };
72 
73 enum bfad_itnim_state {
74 	ITNIM_STATE_NONE,
75 	ITNIM_STATE_ONLINE,
76 	ITNIM_STATE_OFFLINE_PENDING,
77 	ITNIM_STATE_OFFLINE,
78 	ITNIM_STATE_TIMEOUT,
79 	ITNIM_STATE_FREE,
80 };
81 
82 /*
83  * Per itnim data structure
84  */
85 struct bfad_itnim_s {
86 	struct list_head list_entry;
87 	struct bfa_fcs_itnim_s fcs_itnim;
88 	struct work_struct itnim_work;
89 	u32        flags;
90 	enum bfad_itnim_state state;
91 	struct bfad_im_s *im;
92 	struct bfad_im_port_s *im_port;
93 	struct bfad_rport_s *drv_rport;
94 	struct fc_rport *fc_rport;
95 	struct bfa_itnim_s *bfa_itnim;
96 	u16        scsi_tgt_id;
97 	u16        queue_work;
98 	unsigned long	last_ramp_up_time;
99 	unsigned long	last_queue_full_time;
100 };
101 
102 enum bfad_binding_type {
103 	FCP_PWWN_BINDING = 0x1,
104 	FCP_NWWN_BINDING = 0x2,
105 	FCP_FCID_BINDING = 0x3,
106 };
107 
108 struct bfad_fcp_binding {
109 	struct list_head list_entry;
110 	enum bfad_binding_type binding_type;
111 	u16        scsi_target_id;
112 	u32        fc_id;
113 	wwn_t           nwwn;
114 	wwn_t           pwwn;
115 };
116 
117 struct bfad_im_s {
118 	struct bfad_s         *bfad;
119 	struct workqueue_struct *drv_workq;
120 	char   drv_workq_name[BFAD_KOBJ_NAME_LEN];
121 };
122 
123 struct Scsi_Host *bfad_os_scsi_host_alloc(struct bfad_im_port_s *im_port,
124 				struct bfad_s *);
125 bfa_status_t bfad_os_thread_workq(struct bfad_s *bfad);
126 void bfad_os_destroy_workq(struct bfad_im_s *im);
127 void bfad_os_itnim_process(struct bfad_itnim_s *itnim_drv);
128 void bfad_os_fc_host_init(struct bfad_im_port_s *im_port);
129 void bfad_os_init_work(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 /*
140  * scsi_host_template entries
141  */
142 void bfad_im_itnim_unmap(struct bfad_im_port_s  *im_port,
143 			 struct bfad_itnim_s *itnim);
144 
145 extern struct scsi_host_template bfad_im_scsi_host_template;
146 extern struct scsi_host_template bfad_im_vport_template;
147 extern struct fc_function_template bfad_im_fc_function_template;
148 extern struct scsi_transport_template *bfad_im_scsi_transport_template;
149 
150 #endif
151