Merge tag 'sh-for-4.17' of git://git.libc.org/linux-sh
[linux-2.6-block.git] / drivers / scsi / libsas / sas_internal.h
CommitLineData
2908d778
JB
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>
899fcf40 33#include <scsi/sas_ata.h>
2908d778
JB
34
35#define sas_printk(fmt, ...) printk(KERN_NOTICE "sas: " fmt, ## __VA_ARGS__)
36
96db6fa9 37#define SAS_DPRINTK(fmt, ...) printk(KERN_DEBUG "sas: " fmt, ## __VA_ARGS__)
2908d778 38
3a2755af
DW
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
0b3e09da
DW
42struct 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;
22b9153f 48 struct sas_work reset_work;
2a559f4b
DW
49 int enable;
50 int enable_result;
22b9153f 51 struct sas_work enable_work;
0b3e09da
DW
52};
53
2908d778
JB
54void sas_scsi_recover_host(struct Scsi_Host *shost);
55
56int sas_show_class(enum sas_class class, char *buf);
5929faf3 57int sas_show_proto(enum sas_protocol proto, char *buf);
88edf746 58int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
2908d778
JB
59int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
60
61int sas_register_phys(struct sas_ha_struct *sas_ha);
62void sas_unregister_phys(struct sas_ha_struct *sas_ha);
63
1c393b97
JY
64struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy);
65void sas_free_event(struct asd_sas_event *event);
66
2908d778
JB
67int sas_register_ports(struct sas_ha_struct *sas_ha);
68void sas_unregister_ports(struct sas_ha_struct *sas_ha);
69
2908d778 70int sas_init_events(struct sas_ha_struct *sas_ha);
87c8331f
DW
71void sas_disable_revalidation(struct sas_ha_struct *ha);
72void sas_enable_revalidation(struct sas_ha_struct *ha);
5d7f6d10 73void __sas_drain_work(struct sas_ha_struct *ha);
2908d778 74
90f1e10d 75void sas_deform_port(struct asd_sas_phy *phy, int gone);
2908d778 76
c4028958
DH
77void sas_porte_bytes_dmaed(struct work_struct *work);
78void sas_porte_broadcast_rcvd(struct work_struct *work);
79void sas_porte_link_reset_err(struct work_struct *work);
80void sas_porte_timer_event(struct work_struct *work);
81void sas_porte_hard_reset(struct work_struct *work);
6d311fa7 82int sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
2908d778
JB
83
84int sas_notify_lldd_dev_found(struct domain_device *);
85void sas_notify_lldd_dev_gone(struct domain_device *);
86
651a0136
CH
87void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
88 struct sas_rphy *rphy);
2908d778 89int sas_smp_phy_control(struct domain_device *dev, int phy_id,
a01e70e5 90 enum phy_func phy_func, struct sas_phy_linkrates *);
2908d778
JB
91int sas_smp_get_phy_events(struct sas_phy *phy);
92
6d311fa7 93int sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event);
f41a0c44 94void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
2908d778 95struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
81c757bc 96struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
354cf829
DW
97int sas_ex_phy_discover(struct domain_device *dev, int single);
98int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
99 struct smp_resp *rps_resp);
ab526633 100int sas_try_ata_reset(struct asd_sas_phy *phy);
c4028958 101void sas_hae_reset(struct work_struct *work);
2908d778 102
735f7d2f 103void sas_free_device(struct kref *kref);
0558f33c 104void sas_destruct_devices(struct asd_sas_port *port);
735f7d2f 105
1c393b97
JY
106extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS];
107extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS];
108
b98e66fa 109#ifdef CONFIG_SCSI_SAS_HOST_SMP
651a0136 110extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
b98e66fa 111#else
651a0136
CH
112static inline void sas_smp_host_handler(struct bsg_job *job,
113 struct Scsi_Host *shost)
b98e66fa
JB
114{
115 shost_printk(KERN_ERR, shost,
116 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
651a0136 117 bsg_job_done(job, -EINVAL, 0);
b98e66fa
JB
118}
119#endif
120
9508a66f
DW
121static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
122{
123 SAS_DPRINTK("%s: for %s device %16llx returned %d\n",
124 func, dev->parent ? "exp-attached" :
125 "direct-attached",
126 SAS_ADDR(dev->sas_addr), err);
127 sas_unregister_dev(dev->port, dev);
128}
129
2908d778
JB
130static inline void sas_fill_in_rphy(struct domain_device *dev,
131 struct sas_rphy *rphy)
132{
133 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
134 rphy->identify.initiator_port_protocols = dev->iproto;
135 rphy->identify.target_port_protocols = dev->tproto;
136 switch (dev->dev_type) {
aa9f8328 137 case SAS_SATA_DEV:
2908d778 138 /* FIXME: need sata device type */
aa9f8328
JB
139 case SAS_END_DEVICE:
140 case SAS_SATA_PENDING:
2908d778
JB
141 rphy->identify.device_type = SAS_END_DEVICE;
142 break;
aa9f8328 143 case SAS_EDGE_EXPANDER_DEVICE:
2908d778
JB
144 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
145 break;
aa9f8328 146 case SAS_FANOUT_EXPANDER_DEVICE:
2908d778
JB
147 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
148 break;
149 default:
150 rphy->identify.device_type = SAS_PHY_UNUSED;
151 break;
152 }
153}
154
899fcf40
DW
155static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
156{
157 struct sas_phy *phy = p->phy;
158
159 if (dev) {
160 if (dev_is_sata(dev))
161 phy->identify.device_type = SAS_END_DEVICE;
162 else
163 phy->identify.device_type = dev->dev_type;
164 phy->identify.target_port_protocols = dev->tproto;
165 } else {
166 phy->identify.device_type = SAS_PHY_UNUSED;
167 phy->identify.target_port_protocols = 0;
168 }
169}
170
2908d778
JB
171static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
172{
173 struct expander_device *ex = &dev->ex_dev;
174 struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
175
176 if (!ex->parent_port) {
177 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
178 /* FIXME: error handling */
179 BUG_ON(!ex->parent_port);
180 BUG_ON(sas_port_add(ex->parent_port));
181 sas_port_mark_backlink(ex->parent_port);
182 }
183 sas_port_add_phy(ex->parent_port, ex_phy->phy);
184}
185
735f7d2f
DW
186static inline struct domain_device *sas_alloc_device(void)
187{
188 struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
189
190 if (dev) {
191 INIT_LIST_HEAD(&dev->siblings);
192 INIT_LIST_HEAD(&dev->dev_list_node);
87c8331f 193 INIT_LIST_HEAD(&dev->disco_list_node);
735f7d2f 194 kref_init(&dev->kref);
9095a64a 195 spin_lock_init(&dev->done_lock);
735f7d2f
DW
196 }
197 return dev;
198}
199
200static inline void sas_put_device(struct domain_device *dev)
201{
202 kref_put(&dev->kref, sas_free_device);
203}
204
2908d778 205#endif /* _SAS_INTERNAL_H_ */