[SCSI] libsas: fix timeout vs completion race
[linux-2.6.git] / drivers / scsi / libsas / sas_internal.h
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 #define SAS_DPRINTK(fmt, ...) printk(KERN_DEBUG "sas: " fmt, ## __VA_ARGS__)
37
38 #define TO_SAS_TASK(_scsi_cmd)  ((void *)(_scsi_cmd)->host_scribble)
39 #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
40
41 void sas_scsi_recover_host(struct Scsi_Host *shost);
42
43 int sas_show_class(enum sas_class class, char *buf);
44 int sas_show_proto(enum sas_protocol proto, char *buf);
45 int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
46 int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
47
48 int  sas_register_phys(struct sas_ha_struct *sas_ha);
49 void sas_unregister_phys(struct sas_ha_struct *sas_ha);
50
51 int  sas_register_ports(struct sas_ha_struct *sas_ha);
52 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
53
54 enum blk_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *);
55
56 int  sas_init_queue(struct sas_ha_struct *sas_ha);
57 int  sas_init_events(struct sas_ha_struct *sas_ha);
58 void sas_shutdown_queue(struct sas_ha_struct *sas_ha);
59 void sas_disable_revalidation(struct sas_ha_struct *ha);
60 void sas_enable_revalidation(struct sas_ha_struct *ha);
61
62 void sas_deform_port(struct asd_sas_phy *phy, int gone);
63
64 void sas_porte_bytes_dmaed(struct work_struct *work);
65 void sas_porte_broadcast_rcvd(struct work_struct *work);
66 void sas_porte_link_reset_err(struct work_struct *work);
67 void sas_porte_timer_event(struct work_struct *work);
68 void sas_porte_hard_reset(struct work_struct *work);
69
70 int sas_notify_lldd_dev_found(struct domain_device *);
71 void sas_notify_lldd_dev_gone(struct domain_device *);
72
73 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
74                         enum phy_func phy_func, struct sas_phy_linkrates *);
75 int sas_smp_get_phy_events(struct sas_phy *phy);
76
77 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
78
79 void sas_hae_reset(struct work_struct *work);
80
81 void sas_free_device(struct kref *kref);
82
83 #ifdef CONFIG_SCSI_SAS_HOST_SMP
84 extern int sas_smp_host_handler(struct Scsi_Host *shost, struct request *req,
85                                 struct request *rsp);
86 #else
87 static inline int sas_smp_host_handler(struct Scsi_Host *shost,
88                                        struct request *req,
89                                        struct request *rsp)
90 {
91         shost_printk(KERN_ERR, shost,
92                 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
93         return -EINVAL;
94 }
95 #endif
96
97 static inline void sas_fill_in_rphy(struct domain_device *dev,
98                                     struct sas_rphy *rphy)
99 {
100         rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
101         rphy->identify.initiator_port_protocols = dev->iproto;
102         rphy->identify.target_port_protocols = dev->tproto;
103         switch (dev->dev_type) {
104         case SATA_DEV:
105                 /* FIXME: need sata device type */
106         case SAS_END_DEV:
107                 rphy->identify.device_type = SAS_END_DEVICE;
108                 break;
109         case EDGE_DEV:
110                 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
111                 break;
112         case FANOUT_DEV:
113                 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
114                 break;
115         default:
116                 rphy->identify.device_type = SAS_PHY_UNUSED;
117                 break;
118         }
119 }
120
121 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
122 {
123         struct expander_device *ex = &dev->ex_dev;
124         struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
125
126         if (!ex->parent_port) {
127                 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
128                 /* FIXME: error handling */
129                 BUG_ON(!ex->parent_port);
130                 BUG_ON(sas_port_add(ex->parent_port));
131                 sas_port_mark_backlink(ex->parent_port);
132         }
133         sas_port_add_phy(ex->parent_port, ex_phy->phy);
134 }
135
136 static inline struct domain_device *sas_alloc_device(void)
137 {
138         struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
139
140         if (dev) {
141                 INIT_LIST_HEAD(&dev->siblings);
142                 INIT_LIST_HEAD(&dev->dev_list_node);
143                 INIT_LIST_HEAD(&dev->disco_list_node);
144                 kref_init(&dev->kref);
145                 spin_lock_init(&dev->done_lock);
146         }
147         return dev;
148 }
149
150 static inline void sas_put_device(struct domain_device *dev)
151 {
152         kref_put(&dev->kref, sas_free_device);
153 }
154
155 #endif /* _SAS_INTERNAL_H_ */