[SCSI] libsas: poll for ata device readiness after reset
[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 struct sas_phy_data {
42         /* let reset be performed in sas_queue_work() context */
43         struct sas_phy *phy;
44         struct mutex event_lock;
45         int hard_reset;
46         int reset_result;
47         struct work_struct reset_work;
48         int enable;
49         int enable_result;
50         struct work_struct enable_work;
51 };
52
53 void sas_scsi_recover_host(struct Scsi_Host *shost);
54
55 int sas_show_class(enum sas_class class, char *buf);
56 int sas_show_proto(enum sas_protocol proto, char *buf);
57 int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
58 int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
59
60 int  sas_register_phys(struct sas_ha_struct *sas_ha);
61 void sas_unregister_phys(struct sas_ha_struct *sas_ha);
62
63 int  sas_register_ports(struct sas_ha_struct *sas_ha);
64 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
65
66 enum blk_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *);
67
68 int  sas_init_queue(struct sas_ha_struct *sas_ha);
69 int  sas_init_events(struct sas_ha_struct *sas_ha);
70 void sas_shutdown_queue(struct sas_ha_struct *sas_ha);
71 void sas_disable_revalidation(struct sas_ha_struct *ha);
72 void sas_enable_revalidation(struct sas_ha_struct *ha);
73
74 void sas_deform_port(struct asd_sas_phy *phy, int gone);
75
76 void sas_porte_bytes_dmaed(struct work_struct *work);
77 void sas_porte_broadcast_rcvd(struct work_struct *work);
78 void sas_porte_link_reset_err(struct work_struct *work);
79 void sas_porte_timer_event(struct work_struct *work);
80 void sas_porte_hard_reset(struct work_struct *work);
81 void sas_queue_work(struct sas_ha_struct *ha, struct work_struct *work);
82
83 int sas_notify_lldd_dev_found(struct domain_device *);
84 void sas_notify_lldd_dev_gone(struct domain_device *);
85
86 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
87                         enum phy_func phy_func, struct sas_phy_linkrates *);
88 int sas_smp_get_phy_events(struct sas_phy *phy);
89
90 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
91 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
92 int sas_get_phy_attached_sas_addr(struct domain_device *dev, int phy_id,
93                                   u8 *attached_sas_addr);
94 void sas_hae_reset(struct work_struct *work);
95
96 void sas_free_device(struct kref *kref);
97
98 #ifdef CONFIG_SCSI_SAS_HOST_SMP
99 extern int sas_smp_host_handler(struct Scsi_Host *shost, struct request *req,
100                                 struct request *rsp);
101 #else
102 static inline int sas_smp_host_handler(struct Scsi_Host *shost,
103                                        struct request *req,
104                                        struct request *rsp)
105 {
106         shost_printk(KERN_ERR, shost,
107                 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
108         return -EINVAL;
109 }
110 #endif
111
112 static 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                 /* FIXME: need sata device type */
121         case SAS_END_DEV:
122                 rphy->identify.device_type = SAS_END_DEVICE;
123                 break;
124         case EDGE_DEV:
125                 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
126                 break;
127         case FANOUT_DEV:
128                 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
129                 break;
130         default:
131                 rphy->identify.device_type = SAS_PHY_UNUSED;
132                 break;
133         }
134 }
135
136 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
137 {
138         struct expander_device *ex = &dev->ex_dev;
139         struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
140
141         if (!ex->parent_port) {
142                 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
143                 /* FIXME: error handling */
144                 BUG_ON(!ex->parent_port);
145                 BUG_ON(sas_port_add(ex->parent_port));
146                 sas_port_mark_backlink(ex->parent_port);
147         }
148         sas_port_add_phy(ex->parent_port, ex_phy->phy);
149 }
150
151 static inline struct domain_device *sas_alloc_device(void)
152 {
153         struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
154
155         if (dev) {
156                 INIT_LIST_HEAD(&dev->siblings);
157                 INIT_LIST_HEAD(&dev->dev_list_node);
158                 INIT_LIST_HEAD(&dev->disco_list_node);
159                 kref_init(&dev->kref);
160                 spin_lock_init(&dev->done_lock);
161         }
162         return dev;
163 }
164
165 static inline void sas_put_device(struct domain_device *dev)
166 {
167         kref_put(&dev->kref, sas_free_device);
168 }
169
170 #endif /* _SAS_INTERNAL_H_ */