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
34#define sas_printk(fmt, ...) printk(KERN_NOTICE "sas: " fmt, ## __VA_ARGS__)
35
36#ifdef SAS_DEBUG
37#define SAS_DPRINTK(fmt, ...) printk(KERN_NOTICE "sas: " fmt, ## __VA_ARGS__)
38#else
39#define SAS_DPRINTK(fmt, ...)
40#endif
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_proto 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
52int  sas_register_ports(struct sas_ha_struct *sas_ha);
53void sas_unregister_ports(struct sas_ha_struct *sas_ha);
54
55enum scsi_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *);
56
57int  sas_init_queue(struct sas_ha_struct *sas_ha);
58int  sas_init_events(struct sas_ha_struct *sas_ha);
59void sas_shutdown_queue(struct sas_ha_struct *sas_ha);
60
61void sas_deform_port(struct asd_sas_phy *phy);
62
63void sas_porte_bytes_dmaed(struct work_struct *work);
64void sas_porte_broadcast_rcvd(struct work_struct *work);
65void sas_porte_link_reset_err(struct work_struct *work);
66void sas_porte_timer_event(struct work_struct *work);
67void sas_porte_hard_reset(struct work_struct *work);
68
69int sas_notify_lldd_dev_found(struct domain_device *);
70void sas_notify_lldd_dev_gone(struct domain_device *);
71
72int sas_smp_phy_control(struct domain_device *dev, int phy_id,
73			enum phy_func phy_func, struct sas_phy_linkrates *);
74int sas_smp_get_phy_events(struct sas_phy *phy);
75
76struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
77
78void sas_hae_reset(struct work_struct *work);
79
80static inline void sas_queue_event(int event, spinlock_t *lock,
81				   unsigned long *pending,
82				   struct work_struct *work,
83				   struct sas_ha_struct *sas_ha)
84{
85	unsigned long flags;
86
87	spin_lock_irqsave(lock, flags);
88	if (test_bit(event, pending)) {
89		spin_unlock_irqrestore(lock, flags);
90		return;
91	}
92	__set_bit(event, pending);
93	spin_unlock_irqrestore(lock, flags);
94
95	spin_lock_irqsave(&sas_ha->state_lock, flags);
96	if (sas_ha->state != SAS_HA_UNREGISTERED) {
97		scsi_queue_work(sas_ha->core.shost, work);
98	}
99	spin_unlock_irqrestore(&sas_ha->state_lock, flags);
100}
101
102static inline void sas_begin_event(int event, spinlock_t *lock,
103				   unsigned long *pending)
104{
105	unsigned long flags;
106
107	spin_lock_irqsave(lock, flags);
108	__clear_bit(event, pending);
109	spin_unlock_irqrestore(lock, flags);
110}
111
112static inline void sas_fill_in_rphy(struct domain_device *dev,
113				    struct sas_rphy *rphy)
114{
115	rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
116	rphy->identify.initiator_port_protocols = dev->iproto;
117	rphy->identify.target_port_protocols = dev->tproto;
118	switch (dev->dev_type) {
119	case SATA_DEV:
120	case SAS_END_DEV:
121		rphy->identify.device_type = SAS_END_DEVICE;
122		break;
123	case EDGE_DEV:
124		rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
125		break;
126	case FANOUT_DEV:
127		rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
128		break;
129	default:
130		rphy->identify.device_type = SAS_PHY_UNUSED;
131		break;
132	}
133}
134
135static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
136{
137	struct expander_device *ex = &dev->ex_dev;
138	struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
139
140	if (!ex->parent_port) {
141		ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
142		BUG_ON(!ex->parent_port);
143		BUG_ON(sas_port_add(ex->parent_port));
144		sas_port_mark_backlink(ex->parent_port);
145	}
146	sas_port_add_phy(ex->parent_port, ex_phy->phy);
147}
148
149#endif /* _SAS_INTERNAL_H_ */
150