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
64int  sas_register_ports(struct sas_ha_struct *sas_ha);
65void sas_unregister_ports(struct sas_ha_struct *sas_ha);
66
67enum blk_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *);
68
69int  sas_init_events(struct sas_ha_struct *sas_ha);
70void sas_disable_revalidation(struct sas_ha_struct *ha);
71void sas_enable_revalidation(struct sas_ha_struct *ha);
72void __sas_drain_work(struct sas_ha_struct *ha);
73
74void sas_deform_port(struct asd_sas_phy *phy, int gone);
75
76void sas_porte_bytes_dmaed(struct work_struct *work);
77void sas_porte_broadcast_rcvd(struct work_struct *work);
78void sas_porte_link_reset_err(struct work_struct *work);
79void sas_porte_timer_event(struct work_struct *work);
80void sas_porte_hard_reset(struct work_struct *work);
81void sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
82
83int sas_notify_lldd_dev_found(struct domain_device *);
84void sas_notify_lldd_dev_gone(struct domain_device *);
85
86int sas_smp_phy_control(struct domain_device *dev, int phy_id,
87			enum phy_func phy_func, struct sas_phy_linkrates *);
88int sas_smp_get_phy_events(struct sas_phy *phy);
89
90void sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event);
91void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
92struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
93struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
94int sas_ex_phy_discover(struct domain_device *dev, int single);
95int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
96			    struct smp_resp *rps_resp);
97int sas_try_ata_reset(struct asd_sas_phy *phy);
98void sas_hae_reset(struct work_struct *work);
99
100void sas_free_device(struct kref *kref);
101
102#ifdef CONFIG_SCSI_SAS_HOST_SMP
103extern int sas_smp_host_handler(struct Scsi_Host *shost, struct request *req,
104				struct request *rsp);
105#else
106static inline int sas_smp_host_handler(struct Scsi_Host *shost,
107				       struct request *req,
108				       struct request *rsp)
109{
110	shost_printk(KERN_ERR, shost,
111		"Cannot send SMP to a sas host (not enabled in CONFIG)\n");
112	return -EINVAL;
113}
114#endif
115
116static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
117{
118	SAS_DPRINTK("%s: for %s device %16llx returned %d\n",
119		    func, dev->parent ? "exp-attached" :
120					    "direct-attached",
121		    SAS_ADDR(dev->sas_addr), err);
122	sas_unregister_dev(dev->port, dev);
123}
124
125static inline void sas_fill_in_rphy(struct domain_device *dev,
126				    struct sas_rphy *rphy)
127{
128	rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
129	rphy->identify.initiator_port_protocols = dev->iproto;
130	rphy->identify.target_port_protocols = dev->tproto;
131	switch (dev->dev_type) {
132	case SAS_SATA_DEV:
133		/* FIXME: need sata device type */
134	case SAS_END_DEVICE:
135	case SAS_SATA_PENDING:
136		rphy->identify.device_type = SAS_END_DEVICE;
137		break;
138	case SAS_EDGE_EXPANDER_DEVICE:
139		rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
140		break;
141	case SAS_FANOUT_EXPANDER_DEVICE:
142		rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
143		break;
144	default:
145		rphy->identify.device_type = SAS_PHY_UNUSED;
146		break;
147	}
148}
149
150static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
151{
152	struct sas_phy *phy = p->phy;
153
154	if (dev) {
155		if (dev_is_sata(dev))
156			phy->identify.device_type = SAS_END_DEVICE;
157		else
158			phy->identify.device_type = dev->dev_type;
159		phy->identify.target_port_protocols = dev->tproto;
160	} else {
161		phy->identify.device_type = SAS_PHY_UNUSED;
162		phy->identify.target_port_protocols = 0;
163	}
164}
165
166static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
167{
168	struct expander_device *ex = &dev->ex_dev;
169	struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
170
171	if (!ex->parent_port) {
172		ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
173		/* FIXME: error handling */
174		BUG_ON(!ex->parent_port);
175		BUG_ON(sas_port_add(ex->parent_port));
176		sas_port_mark_backlink(ex->parent_port);
177	}
178	sas_port_add_phy(ex->parent_port, ex_phy->phy);
179}
180
181static inline struct domain_device *sas_alloc_device(void)
182{
183	struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
184
185	if (dev) {
186		INIT_LIST_HEAD(&dev->siblings);
187		INIT_LIST_HEAD(&dev->dev_list_node);
188		INIT_LIST_HEAD(&dev->disco_list_node);
189		kref_init(&dev->kref);
190		spin_lock_init(&dev->done_lock);
191	}
192	return dev;
193}
194
195static inline void sas_put_device(struct domain_device *dev)
196{
197	kref_put(&dev->kref, sas_free_device);
198}
199
200#endif /* _SAS_INTERNAL_H_ */
201