1 /*
2  * Serial Attached SCSI (SAS) class internal header file
3  *
4  * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
5  * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
6  *
7  * This file is licensed under GPLv2.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; either version 2 of the
12  * License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22  * USA
23  *
24  */
25 
26 #ifndef _SAS_INTERNAL_H_
27 #define _SAS_INTERNAL_H_
28 
29 #include <scsi/scsi.h>
30 #include <scsi/scsi_host.h>
31 #include <scsi/scsi_transport_sas.h>
32 #include <scsi/libsas.h>
33 #include <scsi/sas_ata.h>
34 
35 #define sas_printk(fmt, ...) printk(KERN_NOTICE "sas: " fmt, ## __VA_ARGS__)
36 
37 #define SAS_DPRINTK(fmt, ...) printk(KERN_DEBUG "sas: " fmt, ## __VA_ARGS__)
38 
39 #define TO_SAS_TASK(_scsi_cmd)  ((void *)(_scsi_cmd)->host_scribble)
40 #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
41 
42 struct sas_phy_data {
43 	/* let reset be performed in sas_queue_work() context */
44 	struct sas_phy *phy;
45 	struct mutex event_lock;
46 	int hard_reset;
47 	int reset_result;
48 	struct sas_work reset_work;
49 	int enable;
50 	int enable_result;
51 	struct sas_work enable_work;
52 };
53 
54 void sas_scsi_recover_host(struct Scsi_Host *shost);
55 
56 int sas_show_class(enum sas_class class, char *buf);
57 int sas_show_proto(enum sas_protocol proto, char *buf);
58 int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
59 int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
60 
61 int  sas_register_phys(struct sas_ha_struct *sas_ha);
62 void sas_unregister_phys(struct sas_ha_struct *sas_ha);
63 
64 int  sas_register_ports(struct sas_ha_struct *sas_ha);
65 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
66 
67 int  sas_init_events(struct sas_ha_struct *sas_ha);
68 void sas_disable_revalidation(struct sas_ha_struct *ha);
69 void sas_enable_revalidation(struct sas_ha_struct *ha);
70 void __sas_drain_work(struct sas_ha_struct *ha);
71 
72 void sas_deform_port(struct asd_sas_phy *phy, int gone);
73 
74 void sas_porte_bytes_dmaed(struct work_struct *work);
75 void sas_porte_broadcast_rcvd(struct work_struct *work);
76 void sas_porte_link_reset_err(struct work_struct *work);
77 void sas_porte_timer_event(struct work_struct *work);
78 void sas_porte_hard_reset(struct work_struct *work);
79 int sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
80 
81 int sas_notify_lldd_dev_found(struct domain_device *);
82 void sas_notify_lldd_dev_gone(struct domain_device *);
83 
84 void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
85 		struct sas_rphy *rphy);
86 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
87 			enum phy_func phy_func, struct sas_phy_linkrates *);
88 int sas_smp_get_phy_events(struct sas_phy *phy);
89 
90 int sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event);
91 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
92 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
93 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
94 int sas_ex_phy_discover(struct domain_device *dev, int single);
95 int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
96 			    struct smp_resp *rps_resp);
97 int sas_try_ata_reset(struct asd_sas_phy *phy);
98 void sas_hae_reset(struct work_struct *work);
99 
100 void sas_free_device(struct kref *kref);
101 
102 #ifdef CONFIG_SCSI_SAS_HOST_SMP
103 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
104 #else
105 static inline void sas_smp_host_handler(struct bsg_job *job,
106 		struct Scsi_Host *shost)
107 {
108 	shost_printk(KERN_ERR, shost,
109 		"Cannot send SMP to a sas host (not enabled in CONFIG)\n");
110 	bsg_job_done(job, -EINVAL, 0);
111 }
112 #endif
113 
114 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
115 {
116 	SAS_DPRINTK("%s: for %s device %16llx returned %d\n",
117 		    func, dev->parent ? "exp-attached" :
118 					    "direct-attached",
119 		    SAS_ADDR(dev->sas_addr), err);
120 	sas_unregister_dev(dev->port, dev);
121 }
122 
123 static inline void sas_fill_in_rphy(struct domain_device *dev,
124 				    struct sas_rphy *rphy)
125 {
126 	rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
127 	rphy->identify.initiator_port_protocols = dev->iproto;
128 	rphy->identify.target_port_protocols = dev->tproto;
129 	switch (dev->dev_type) {
130 	case SAS_SATA_DEV:
131 		/* FIXME: need sata device type */
132 	case SAS_END_DEVICE:
133 	case SAS_SATA_PENDING:
134 		rphy->identify.device_type = SAS_END_DEVICE;
135 		break;
136 	case SAS_EDGE_EXPANDER_DEVICE:
137 		rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
138 		break;
139 	case SAS_FANOUT_EXPANDER_DEVICE:
140 		rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
141 		break;
142 	default:
143 		rphy->identify.device_type = SAS_PHY_UNUSED;
144 		break;
145 	}
146 }
147 
148 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
149 {
150 	struct sas_phy *phy = p->phy;
151 
152 	if (dev) {
153 		if (dev_is_sata(dev))
154 			phy->identify.device_type = SAS_END_DEVICE;
155 		else
156 			phy->identify.device_type = dev->dev_type;
157 		phy->identify.target_port_protocols = dev->tproto;
158 	} else {
159 		phy->identify.device_type = SAS_PHY_UNUSED;
160 		phy->identify.target_port_protocols = 0;
161 	}
162 }
163 
164 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
165 {
166 	struct expander_device *ex = &dev->ex_dev;
167 	struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
168 
169 	if (!ex->parent_port) {
170 		ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
171 		/* FIXME: error handling */
172 		BUG_ON(!ex->parent_port);
173 		BUG_ON(sas_port_add(ex->parent_port));
174 		sas_port_mark_backlink(ex->parent_port);
175 	}
176 	sas_port_add_phy(ex->parent_port, ex_phy->phy);
177 }
178 
179 static inline struct domain_device *sas_alloc_device(void)
180 {
181 	struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
182 
183 	if (dev) {
184 		INIT_LIST_HEAD(&dev->siblings);
185 		INIT_LIST_HEAD(&dev->dev_list_node);
186 		INIT_LIST_HEAD(&dev->disco_list_node);
187 		kref_init(&dev->kref);
188 		spin_lock_init(&dev->done_lock);
189 	}
190 	return dev;
191 }
192 
193 static inline void sas_put_device(struct domain_device *dev)
194 {
195 	kref_put(&dev->kref, sas_free_device);
196 }
197 
198 #endif /* _SAS_INTERNAL_H_ */
199