Loading...
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
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;
48 struct sas_work reset_work;
49 int enable;
50 int enable_result;
51 struct sas_work enable_work;
52};
53
54void sas_scsi_recover_host(struct Scsi_Host *shost);
55
56int sas_show_class(enum sas_class class, char *buf);
57int sas_show_proto(enum sas_protocol proto, char *buf);
58int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
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
64struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy);
65void sas_free_event(struct asd_sas_event *event);
66
67int sas_register_ports(struct sas_ha_struct *sas_ha);
68void sas_unregister_ports(struct sas_ha_struct *sas_ha);
69
70int sas_init_events(struct sas_ha_struct *sas_ha);
71void sas_disable_revalidation(struct sas_ha_struct *ha);
72void sas_enable_revalidation(struct sas_ha_struct *ha);
73void __sas_drain_work(struct sas_ha_struct *ha);
74
75void sas_deform_port(struct asd_sas_phy *phy, int gone);
76
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);
82int sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
83
84int sas_notify_lldd_dev_found(struct domain_device *);
85void sas_notify_lldd_dev_gone(struct domain_device *);
86
87void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
88 struct sas_rphy *rphy);
89int sas_smp_phy_control(struct domain_device *dev, int phy_id,
90 enum phy_func phy_func, struct sas_phy_linkrates *);
91int sas_smp_get_phy_events(struct sas_phy *phy);
92
93int sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event);
94void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
95struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
96struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
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);
100int sas_try_ata_reset(struct asd_sas_phy *phy);
101void sas_hae_reset(struct work_struct *work);
102
103void sas_free_device(struct kref *kref);
104void sas_destruct_devices(struct asd_sas_port *port);
105
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
109#ifdef CONFIG_SCSI_SAS_HOST_SMP
110extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
111#else
112static inline void sas_smp_host_handler(struct bsg_job *job,
113 struct Scsi_Host *shost)
114{
115 shost_printk(KERN_ERR, shost,
116 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
117 bsg_job_done(job, -EINVAL, 0);
118}
119#endif
120
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
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) {
137 case SAS_SATA_DEV:
138 /* FIXME: need sata device type */
139 case SAS_END_DEVICE:
140 case SAS_SATA_PENDING:
141 rphy->identify.device_type = SAS_END_DEVICE;
142 break;
143 case SAS_EDGE_EXPANDER_DEVICE:
144 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
145 break;
146 case SAS_FANOUT_EXPANDER_DEVICE:
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
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
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
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);
193 INIT_LIST_HEAD(&dev->disco_list_node);
194 kref_init(&dev->kref);
195 spin_lock_init(&dev->done_lock);
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
205#endif /* _SAS_INTERNAL_H_ */
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Serial Attached SCSI (SAS) class internal header file
4 *
5 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
6 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
7 */
8
9#ifndef _SAS_INTERNAL_H_
10#define _SAS_INTERNAL_H_
11
12#include <scsi/scsi.h>
13#include <scsi/scsi_host.h>
14#include <scsi/scsi_transport_sas.h>
15#include <scsi/libsas.h>
16#include <scsi/sas_ata.h>
17#include <linux/pm_runtime.h>
18
19#ifdef pr_fmt
20#undef pr_fmt
21#endif
22
23#define SAS_FMT "sas: "
24
25#define pr_fmt(fmt) SAS_FMT fmt
26
27#define TO_SAS_TASK(_scsi_cmd) ((void *)(_scsi_cmd)->host_scribble)
28#define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
29
30struct sas_phy_data {
31 /* let reset be performed in sas_queue_work() context */
32 struct sas_phy *phy;
33 struct mutex event_lock;
34 int hard_reset;
35 int reset_result;
36 struct sas_work reset_work;
37 int enable;
38 int enable_result;
39 struct sas_work enable_work;
40};
41
42void sas_scsi_recover_host(struct Scsi_Host *shost);
43
44int sas_show_class(enum sas_class class, char *buf);
45int sas_show_proto(enum sas_protocol proto, char *buf);
46int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
47int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
48
49int sas_register_phys(struct sas_ha_struct *sas_ha);
50void sas_unregister_phys(struct sas_ha_struct *sas_ha);
51
52struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy, gfp_t gfp_flags);
53void sas_free_event(struct asd_sas_event *event);
54
55struct sas_task *sas_alloc_task(gfp_t flags);
56struct sas_task *sas_alloc_slow_task(gfp_t flags);
57void sas_free_task(struct sas_task *task);
58
59int sas_register_ports(struct sas_ha_struct *sas_ha);
60void sas_unregister_ports(struct sas_ha_struct *sas_ha);
61
62void sas_disable_revalidation(struct sas_ha_struct *ha);
63void sas_enable_revalidation(struct sas_ha_struct *ha);
64void sas_queue_deferred_work(struct sas_ha_struct *ha);
65void __sas_drain_work(struct sas_ha_struct *ha);
66
67void sas_deform_port(struct asd_sas_phy *phy, int gone);
68
69void sas_porte_bytes_dmaed(struct work_struct *work);
70void sas_porte_broadcast_rcvd(struct work_struct *work);
71void sas_porte_link_reset_err(struct work_struct *work);
72void sas_porte_timer_event(struct work_struct *work);
73void sas_porte_hard_reset(struct work_struct *work);
74bool sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
75
76int sas_notify_lldd_dev_found(struct domain_device *);
77void sas_notify_lldd_dev_gone(struct domain_device *);
78
79void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
80 struct sas_rphy *rphy);
81int sas_smp_phy_control(struct domain_device *dev, int phy_id,
82 enum phy_func phy_func, struct sas_phy_linkrates *);
83int sas_smp_get_phy_events(struct sas_phy *phy);
84
85void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
86struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
87struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
88int sas_ex_phy_discover(struct domain_device *dev, int single);
89int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
90 struct smp_rps_resp *rps_resp);
91int sas_get_phy_attached_dev(struct domain_device *dev, int phy_id,
92 u8 *sas_addr, enum sas_device_type *type);
93int sas_try_ata_reset(struct asd_sas_phy *phy);
94void sas_hae_reset(struct work_struct *work);
95
96void sas_free_device(struct kref *kref);
97void sas_destruct_devices(struct asd_sas_port *port);
98
99extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS];
100extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS];
101
102void sas_task_internal_done(struct sas_task *task);
103void sas_task_internal_timedout(struct timer_list *t);
104int sas_execute_tmf(struct domain_device *device, void *parameter,
105 int para_len, int force_phy_id,
106 struct sas_tmf_task *tmf);
107
108#ifdef CONFIG_SCSI_SAS_HOST_SMP
109extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
110#else
111static inline void sas_smp_host_handler(struct bsg_job *job,
112 struct Scsi_Host *shost)
113{
114 shost_printk(KERN_ERR, shost,
115 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
116 bsg_job_done(job, -EINVAL, 0);
117}
118#endif
119
120static inline bool sas_phy_match_dev_addr(struct domain_device *dev,
121 struct ex_phy *phy)
122{
123 return SAS_ADDR(dev->sas_addr) == SAS_ADDR(phy->attached_sas_addr);
124}
125
126static inline bool sas_phy_match_port_addr(struct asd_sas_port *port,
127 struct ex_phy *phy)
128{
129 return SAS_ADDR(port->sas_addr) == SAS_ADDR(phy->attached_sas_addr);
130}
131
132static inline bool sas_phy_addr_match(struct ex_phy *p1, struct ex_phy *p2)
133{
134 return SAS_ADDR(p1->attached_sas_addr) == SAS_ADDR(p2->attached_sas_addr);
135}
136
137static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
138{
139 pr_warn("%s: for %s device %016llx returned %d\n",
140 func, dev->parent ? "exp-attached" :
141 "direct-attached",
142 SAS_ADDR(dev->sas_addr), err);
143 sas_unregister_dev(dev->port, dev);
144}
145
146static inline void sas_fill_in_rphy(struct domain_device *dev,
147 struct sas_rphy *rphy)
148{
149 rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
150 rphy->identify.initiator_port_protocols = dev->iproto;
151 rphy->identify.target_port_protocols = dev->tproto;
152 switch (dev->dev_type) {
153 case SAS_SATA_DEV:
154 /* FIXME: need sata device type */
155 case SAS_END_DEVICE:
156 case SAS_SATA_PENDING:
157 rphy->identify.device_type = SAS_END_DEVICE;
158 break;
159 case SAS_EDGE_EXPANDER_DEVICE:
160 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
161 break;
162 case SAS_FANOUT_EXPANDER_DEVICE:
163 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
164 break;
165 default:
166 rphy->identify.device_type = SAS_PHY_UNUSED;
167 break;
168 }
169}
170
171static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
172{
173 struct sas_phy *phy = p->phy;
174
175 if (dev) {
176 if (dev_is_sata(dev))
177 phy->identify.device_type = SAS_END_DEVICE;
178 else
179 phy->identify.device_type = dev->dev_type;
180 phy->identify.target_port_protocols = dev->tproto;
181 } else {
182 phy->identify.device_type = SAS_PHY_UNUSED;
183 phy->identify.target_port_protocols = 0;
184 }
185}
186
187static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
188{
189 struct expander_device *ex = &dev->ex_dev;
190 struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
191
192 if (!ex->parent_port) {
193 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
194 /* FIXME: error handling */
195 BUG_ON(!ex->parent_port);
196 BUG_ON(sas_port_add(ex->parent_port));
197 sas_port_mark_backlink(ex->parent_port);
198 }
199 sas_port_add_phy(ex->parent_port, ex_phy->phy);
200}
201
202static inline struct domain_device *sas_alloc_device(void)
203{
204 struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
205
206 if (dev) {
207 INIT_LIST_HEAD(&dev->siblings);
208 INIT_LIST_HEAD(&dev->dev_list_node);
209 INIT_LIST_HEAD(&dev->disco_list_node);
210 kref_init(&dev->kref);
211 spin_lock_init(&dev->done_lock);
212 }
213 return dev;
214}
215
216static inline void sas_put_device(struct domain_device *dev)
217{
218 kref_put(&dev->kref, sas_free_device);
219}
220
221#endif /* _SAS_INTERNAL_H_ */