0d43408196f95352bf5bdad947ed028ec35936a8
[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
60 void sas_deform_port(struct asd_sas_phy *phy, int gone);
61
62 void sas_porte_bytes_dmaed(struct work_struct *work);
63 void sas_porte_broadcast_rcvd(struct work_struct *work);
64 void sas_porte_link_reset_err(struct work_struct *work);
65 void sas_porte_timer_event(struct work_struct *work);
66 void sas_porte_hard_reset(struct work_struct *work);
67
68 int sas_notify_lldd_dev_found(struct domain_device *);
69 void sas_notify_lldd_dev_gone(struct domain_device *);
70
71 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
72                         enum phy_func phy_func, struct sas_phy_linkrates *);
73 int sas_smp_get_phy_events(struct sas_phy *phy);
74
75 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
76
77 void sas_hae_reset(struct work_struct *work);
78
79 void sas_free_device(struct kref *kref);
80
81 #ifdef CONFIG_SCSI_SAS_HOST_SMP
82 extern int sas_smp_host_handler(struct Scsi_Host *shost, struct request *req,
83                                 struct request *rsp);
84 #else
85 static inline int sas_smp_host_handler(struct Scsi_Host *shost,
86                                        struct request *req,
87                                        struct request *rsp)
88 {
89         shost_printk(KERN_ERR, shost,
90                 "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
91         return -EINVAL;
92 }
93 #endif
94
95 static inline void sas_queue_event(int event, spinlock_t *lock,
96                                    unsigned long *pending,
97                                    struct work_struct *work,
98                                    struct sas_ha_struct *sas_ha)
99 {
100         unsigned long flags;
101
102         spin_lock_irqsave(lock, flags);
103         if (test_bit(event, pending)) {
104                 spin_unlock_irqrestore(lock, flags);
105                 return;
106         }
107         __set_bit(event, pending);
108         spin_unlock_irqrestore(lock, flags);
109
110         spin_lock_irqsave(&sas_ha->state_lock, flags);
111         if (sas_ha->state != SAS_HA_UNREGISTERED) {
112                 scsi_queue_work(sas_ha->core.shost, work);
113         }
114         spin_unlock_irqrestore(&sas_ha->state_lock, flags);
115 }
116
117 static inline void sas_begin_event(int event, spinlock_t *lock,
118                                    unsigned long *pending)
119 {
120         unsigned long flags;
121
122         spin_lock_irqsave(lock, flags);
123         __clear_bit(event, pending);
124         spin_unlock_irqrestore(lock, flags);
125 }
126
127 static inline void sas_fill_in_rphy(struct domain_device *dev,
128                                     struct sas_rphy *rphy)
129 {
130         rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
131         rphy->identify.initiator_port_protocols = dev->iproto;
132         rphy->identify.target_port_protocols = dev->tproto;
133         switch (dev->dev_type) {
134         case SATA_DEV:
135                 /* FIXME: need sata device type */
136         case SAS_END_DEV:
137                 rphy->identify.device_type = SAS_END_DEVICE;
138                 break;
139         case EDGE_DEV:
140                 rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
141                 break;
142         case FANOUT_DEV:
143                 rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
144                 break;
145         default:
146                 rphy->identify.device_type = SAS_PHY_UNUSED;
147                 break;
148         }
149 }
150
151 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
152 {
153         struct expander_device *ex = &dev->ex_dev;
154         struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
155
156         if (!ex->parent_port) {
157                 ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
158                 /* FIXME: error handling */
159                 BUG_ON(!ex->parent_port);
160                 BUG_ON(sas_port_add(ex->parent_port));
161                 sas_port_mark_backlink(ex->parent_port);
162         }
163         sas_port_add_phy(ex->parent_port, ex_phy->phy);
164 }
165
166 static inline struct domain_device *sas_alloc_device(void)
167 {
168         struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
169
170         if (dev) {
171                 INIT_LIST_HEAD(&dev->siblings);
172                 INIT_LIST_HEAD(&dev->dev_list_node);
173                 kref_init(&dev->kref);
174         }
175         return dev;
176 }
177
178 static inline void sas_put_device(struct domain_device *dev)
179 {
180         kref_put(&dev->kref, sas_free_device);
181 }
182
183 #endif /* _SAS_INTERNAL_H_ */