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 
42 #define TO_SAS_TASK(_scsi_cmd)  ((void *)(_scsi_cmd)->host_scribble)
43 #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
44 
45 void sas_scsi_recover_host(struct Scsi_Host *shost);
46 
47 int sas_show_class(enum sas_class class, char *buf);
48 int sas_show_proto(enum sas_proto proto, char *buf);
49 int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
50 int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
51 
52 int  sas_register_phys(struct sas_ha_struct *sas_ha);
53 void sas_unregister_phys(struct sas_ha_struct *sas_ha);
54 
55 int  sas_register_ports(struct sas_ha_struct *sas_ha);
56 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
57 
58 enum scsi_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *);
59 
60 int  sas_init_queue(struct sas_ha_struct *sas_ha);
61 int  sas_init_events(struct sas_ha_struct *sas_ha);
62 void sas_shutdown_queue(struct sas_ha_struct *sas_ha);
63 
64 void sas_deform_port(struct asd_sas_phy *phy);
65 
66 void sas_porte_bytes_dmaed(struct work_struct *work);
67 void sas_porte_broadcast_rcvd(struct work_struct *work);
68 void sas_porte_link_reset_err(struct work_struct *work);
69 void sas_porte_timer_event(struct work_struct *work);
70 void sas_porte_hard_reset(struct work_struct *work);
71 
72 int sas_notify_lldd_dev_found(struct domain_device *);
73 void sas_notify_lldd_dev_gone(struct domain_device *);
74 
75 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
76 			enum phy_func phy_func, struct sas_phy_linkrates *);
77 int sas_smp_get_phy_events(struct sas_phy *phy);
78 
79 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
80 
81 void sas_hae_reset(struct work_struct *work);
82 
83 static inline void sas_queue_event(int event, spinlock_t *lock,
84 				   unsigned long *pending,
85 				   struct work_struct *work,
86 				   struct sas_ha_struct *sas_ha)
87 {
88 	unsigned long flags;
89 
90 	spin_lock_irqsave(lock, flags);
91 	if (test_bit(event, pending)) {
92 		spin_unlock_irqrestore(lock, flags);
93 		return;
94 	}
95 	__set_bit(event, pending);
96 	spin_unlock_irqrestore(lock, flags);
97 
98 	spin_lock_irqsave(&sas_ha->state_lock, flags);
99 	if (sas_ha->state != SAS_HA_UNREGISTERED) {
100 		scsi_queue_work(sas_ha->core.shost, work);
101 	}
102 	spin_unlock_irqrestore(&sas_ha->state_lock, flags);
103 }
104 
105 static inline void sas_begin_event(int event, spinlock_t *lock,
106 				   unsigned long *pending)
107 {
108 	unsigned long flags;
109 
110 	spin_lock_irqsave(lock, flags);
111 	__clear_bit(event, pending);
112 	spin_unlock_irqrestore(lock, flags);
113 }
114 
115 static inline void sas_fill_in_rphy(struct domain_device *dev,
116 				    struct sas_rphy *rphy)
117 {
118 	rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
119 	rphy->identify.initiator_port_protocols = dev->iproto;
120 	rphy->identify.target_port_protocols = dev->tproto;
121 	switch (dev->dev_type) {
122 	case SATA_DEV:
123 		/* FIXME: need sata device type */
124 	case SAS_END_DEV:
125 		rphy->identify.device_type = SAS_END_DEVICE;
126 		break;
127 	case EDGE_DEV:
128 		rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
129 		break;
130 	case FANOUT_DEV:
131 		rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
132 		break;
133 	default:
134 		rphy->identify.device_type = SAS_PHY_UNUSED;
135 		break;
136 	}
137 }
138 
139 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
140 {
141 	struct expander_device *ex = &dev->ex_dev;
142 	struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
143 
144 	if (!ex->parent_port) {
145 		ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
146 		/* FIXME: error handling */
147 		BUG_ON(!ex->parent_port);
148 		BUG_ON(sas_port_add(ex->parent_port));
149 		sas_port_mark_backlink(ex->parent_port);
150 	}
151 	sas_port_add_phy(ex->parent_port, ex_phy->phy);
152 }
153 
154 #endif /* _SAS_INTERNAL_H_ */
155