Merge branch 'upstream-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/linvil...
[linux-2.6] / drivers / scsi / aic94xx / aic94xx_scb.c
1 /*
2  * Aic94xx SAS/SATA driver SCB management.
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 file is part of the aic94xx driver.
10  *
11  * The aic94xx driver is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License as
13  * published by the Free Software Foundation; version 2 of the
14  * License.
15  *
16  * The aic94xx driver is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with the aic94xx driver; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
24  *
25  */
26
27 #include <linux/pci.h>
28
29 #include "aic94xx.h"
30 #include "aic94xx_reg.h"
31 #include "aic94xx_hwi.h"
32 #include "aic94xx_seq.h"
33
34 #include "aic94xx_dump.h"
35
36 /* ---------- EMPTY SCB ---------- */
37
38 #define DL_PHY_MASK      7
39 #define BYTES_DMAED      0
40 #define PRIMITIVE_RECVD  0x08
41 #define PHY_EVENT        0x10
42 #define LINK_RESET_ERROR 0x18
43 #define TIMER_EVENT      0x20
44 #define REQ_TASK_ABORT   0xF0
45 #define REQ_DEVICE_RESET 0xF1
46 #define SIGNAL_NCQ_ERROR 0xF2
47 #define CLEAR_NCQ_ERROR  0xF3
48
49 #define PHY_EVENTS_STATUS (CURRENT_LOSS_OF_SIGNAL | CURRENT_OOB_DONE   \
50                            | CURRENT_SPINUP_HOLD | CURRENT_GTO_TIMEOUT \
51                            | CURRENT_OOB_ERROR)
52
53 static inline void get_lrate_mode(struct asd_phy *phy, u8 oob_mode)
54 {
55         struct sas_phy *sas_phy = phy->sas_phy.phy;
56
57         switch (oob_mode & 7) {
58         case PHY_SPEED_60:
59                 /* FIXME: sas transport class doesn't have this */
60                 phy->sas_phy.linkrate = SAS_LINK_RATE_6_0_GBPS;
61                 phy->sas_phy.phy->negotiated_linkrate = SAS_LINK_RATE_6_0_GBPS;
62                 break;
63         case PHY_SPEED_30:
64                 phy->sas_phy.linkrate = SAS_LINK_RATE_3_0_GBPS;
65                 phy->sas_phy.phy->negotiated_linkrate = SAS_LINK_RATE_3_0_GBPS;
66                 break;
67         case PHY_SPEED_15:
68                 phy->sas_phy.linkrate = SAS_LINK_RATE_1_5_GBPS;
69                 phy->sas_phy.phy->negotiated_linkrate = SAS_LINK_RATE_1_5_GBPS;
70                 break;
71         }
72         sas_phy->negotiated_linkrate = phy->sas_phy.linkrate;
73         sas_phy->maximum_linkrate_hw = SAS_LINK_RATE_3_0_GBPS;
74         sas_phy->minimum_linkrate_hw = SAS_LINK_RATE_1_5_GBPS;
75         sas_phy->maximum_linkrate = phy->phy_desc->max_sas_lrate;
76         sas_phy->minimum_linkrate = phy->phy_desc->min_sas_lrate;
77
78         if (oob_mode & SAS_MODE)
79                 phy->sas_phy.oob_mode = SAS_OOB_MODE;
80         else if (oob_mode & SATA_MODE)
81                 phy->sas_phy.oob_mode = SATA_OOB_MODE;
82 }
83
84 static inline void asd_phy_event_tasklet(struct asd_ascb *ascb,
85                                          struct done_list_struct *dl)
86 {
87         struct asd_ha_struct *asd_ha = ascb->ha;
88         struct sas_ha_struct *sas_ha = &asd_ha->sas_ha;
89         int phy_id = dl->status_block[0] & DL_PHY_MASK;
90         struct asd_phy *phy = &asd_ha->phys[phy_id];
91
92         u8 oob_status = dl->status_block[1] & PHY_EVENTS_STATUS;
93         u8 oob_mode   = dl->status_block[2];
94
95         switch (oob_status) {
96         case CURRENT_LOSS_OF_SIGNAL:
97                 /* directly attached device was removed */
98                 ASD_DPRINTK("phy%d: device unplugged\n", phy_id);
99                 asd_turn_led(asd_ha, phy_id, 0);
100                 sas_phy_disconnected(&phy->sas_phy);
101                 sas_ha->notify_phy_event(&phy->sas_phy, PHYE_LOSS_OF_SIGNAL);
102                 break;
103         case CURRENT_OOB_DONE:
104                 /* hot plugged device */
105                 asd_turn_led(asd_ha, phy_id, 1);
106                 get_lrate_mode(phy, oob_mode);
107                 ASD_DPRINTK("phy%d device plugged: lrate:0x%x, proto:0x%x\n",
108                             phy_id, phy->sas_phy.linkrate, phy->sas_phy.iproto);
109                 sas_ha->notify_phy_event(&phy->sas_phy, PHYE_OOB_DONE);
110                 break;
111         case CURRENT_SPINUP_HOLD:
112                 /* hot plug SATA, no COMWAKE sent */
113                 asd_turn_led(asd_ha, phy_id, 1);
114                 sas_ha->notify_phy_event(&phy->sas_phy, PHYE_SPINUP_HOLD);
115                 break;
116         case CURRENT_GTO_TIMEOUT:
117         case CURRENT_OOB_ERROR:
118                 ASD_DPRINTK("phy%d error while OOB: oob status:0x%x\n", phy_id,
119                             dl->status_block[1]);
120                 asd_turn_led(asd_ha, phy_id, 0);
121                 sas_phy_disconnected(&phy->sas_phy);
122                 sas_ha->notify_phy_event(&phy->sas_phy, PHYE_OOB_ERROR);
123                 break;
124         }
125 }
126
127 /* If phys are enabled sparsely, this will do the right thing. */
128 static inline unsigned ord_phy(struct asd_ha_struct *asd_ha,
129                                struct asd_phy *phy)
130 {
131         u8 enabled_mask = asd_ha->hw_prof.enabled_phys;
132         int i, k = 0;
133
134         for_each_phy(enabled_mask, enabled_mask, i) {
135                 if (&asd_ha->phys[i] == phy)
136                         return k;
137                 k++;
138         }
139         return 0;
140 }
141
142 /**
143  * asd_get_attached_sas_addr -- extract/generate attached SAS address
144  * phy: pointer to asd_phy
145  * sas_addr: pointer to buffer where the SAS address is to be written
146  *
147  * This function extracts the SAS address from an IDENTIFY frame
148  * received.  If OOB is SATA, then a SAS address is generated from the
149  * HA tables.
150  *
151  * LOCKING: the frame_rcvd_lock needs to be held since this parses the frame
152  * buffer.
153  */
154 static inline void asd_get_attached_sas_addr(struct asd_phy *phy, u8 *sas_addr)
155 {
156         if (phy->sas_phy.frame_rcvd[0] == 0x34
157             && phy->sas_phy.oob_mode == SATA_OOB_MODE) {
158                 struct asd_ha_struct *asd_ha = phy->sas_phy.ha->lldd_ha;
159                 /* FIS device-to-host */
160                 u64 addr = be64_to_cpu(*(__be64 *)phy->phy_desc->sas_addr);
161
162                 addr += asd_ha->hw_prof.sata_name_base + ord_phy(asd_ha, phy);
163                 *(__be64 *)sas_addr = cpu_to_be64(addr);
164         } else {
165                 struct sas_identify_frame *idframe =
166                         (void *) phy->sas_phy.frame_rcvd;
167                 memcpy(sas_addr, idframe->sas_addr, SAS_ADDR_SIZE);
168         }
169 }
170
171 static void asd_form_port(struct asd_ha_struct *asd_ha, struct asd_phy *phy)
172 {
173         int i;
174         struct asd_port *free_port = NULL;
175         struct asd_port *port;
176         struct asd_sas_phy *sas_phy = &phy->sas_phy;
177         unsigned long flags;
178
179         spin_lock_irqsave(&asd_ha->asd_ports_lock, flags);
180         if (!phy->asd_port) {
181                 for (i = 0; i < ASD_MAX_PHYS; i++) {
182                         port = &asd_ha->asd_ports[i];
183
184                         /* Check for wide port */
185                         if (port->num_phys > 0 &&
186                             memcmp(port->sas_addr, sas_phy->sas_addr,
187                                    SAS_ADDR_SIZE) == 0 &&
188                             memcmp(port->attached_sas_addr,
189                                    sas_phy->attached_sas_addr,
190                                    SAS_ADDR_SIZE) == 0) {
191                                 break;
192                         }
193
194                         /* Find a free port */
195                         if (port->num_phys == 0 && free_port == NULL) {
196                                 free_port = port;
197                         }
198                 }
199
200                 /* Use a free port if this doesn't form a wide port */
201                 if (i >= ASD_MAX_PHYS) {
202                         port = free_port;
203                         BUG_ON(!port);
204                         memcpy(port->sas_addr, sas_phy->sas_addr,
205                                SAS_ADDR_SIZE);
206                         memcpy(port->attached_sas_addr,
207                                sas_phy->attached_sas_addr,
208                                SAS_ADDR_SIZE);
209                 }
210                 port->num_phys++;
211                 port->phy_mask |= (1U << sas_phy->id);
212                 phy->asd_port = port;
213         }
214         ASD_DPRINTK("%s: updating phy_mask 0x%x for phy%d\n",
215                     __FUNCTION__, phy->asd_port->phy_mask, sas_phy->id);
216         asd_update_port_links(asd_ha, phy);
217         spin_unlock_irqrestore(&asd_ha->asd_ports_lock, flags);
218 }
219
220 static void asd_deform_port(struct asd_ha_struct *asd_ha, struct asd_phy *phy)
221 {
222         struct asd_port *port = phy->asd_port;
223         struct asd_sas_phy *sas_phy = &phy->sas_phy;
224         unsigned long flags;
225
226         spin_lock_irqsave(&asd_ha->asd_ports_lock, flags);
227         if (port) {
228                 port->num_phys--;
229                 port->phy_mask &= ~(1U << sas_phy->id);
230                 phy->asd_port = NULL;
231         }
232         spin_unlock_irqrestore(&asd_ha->asd_ports_lock, flags);
233 }
234
235 static inline void asd_bytes_dmaed_tasklet(struct asd_ascb *ascb,
236                                            struct done_list_struct *dl,
237                                            int edb_id, int phy_id)
238 {
239         unsigned long flags;
240         int edb_el = edb_id + ascb->edb_index;
241         struct asd_dma_tok *edb = ascb->ha->seq.edb_arr[edb_el];
242         struct asd_phy *phy = &ascb->ha->phys[phy_id];
243         struct sas_ha_struct *sas_ha = phy->sas_phy.ha;
244         u16 size = ((dl->status_block[3] & 7) << 8) | dl->status_block[2];
245
246         size = min(size, (u16) sizeof(phy->frame_rcvd));
247
248         spin_lock_irqsave(&phy->sas_phy.frame_rcvd_lock, flags);
249         memcpy(phy->sas_phy.frame_rcvd, edb->vaddr, size);
250         phy->sas_phy.frame_rcvd_size = size;
251         asd_get_attached_sas_addr(phy, phy->sas_phy.attached_sas_addr);
252         spin_unlock_irqrestore(&phy->sas_phy.frame_rcvd_lock, flags);
253         asd_dump_frame_rcvd(phy, dl);
254         asd_form_port(ascb->ha, phy);
255         sas_ha->notify_port_event(&phy->sas_phy, PORTE_BYTES_DMAED);
256 }
257
258 static inline void asd_link_reset_err_tasklet(struct asd_ascb *ascb,
259                                               struct done_list_struct *dl,
260                                               int phy_id)
261 {
262         struct asd_ha_struct *asd_ha = ascb->ha;
263         struct sas_ha_struct *sas_ha = &asd_ha->sas_ha;
264         struct asd_sas_phy *sas_phy = sas_ha->sas_phy[phy_id];
265         struct asd_phy *phy = &asd_ha->phys[phy_id];
266         u8 lr_error = dl->status_block[1];
267         u8 retries_left = dl->status_block[2];
268
269         switch (lr_error) {
270         case 0:
271                 ASD_DPRINTK("phy%d: Receive ID timer expired\n", phy_id);
272                 break;
273         case 1:
274                 ASD_DPRINTK("phy%d: Loss of signal\n", phy_id);
275                 break;
276         case 2:
277                 ASD_DPRINTK("phy%d: Loss of dword sync\n", phy_id);
278                 break;
279         case 3:
280                 ASD_DPRINTK("phy%d: Receive FIS timeout\n", phy_id);
281                 break;
282         default:
283                 ASD_DPRINTK("phy%d: unknown link reset error code: 0x%x\n",
284                             phy_id, lr_error);
285                 break;
286         }
287
288         asd_turn_led(asd_ha, phy_id, 0);
289         sas_phy_disconnected(sas_phy);
290         asd_deform_port(asd_ha, phy);
291         sas_ha->notify_port_event(sas_phy, PORTE_LINK_RESET_ERR);
292
293         if (retries_left == 0) {
294                 int num = 1;
295                 struct asd_ascb *cp = asd_ascb_alloc_list(ascb->ha, &num,
296                                                           GFP_ATOMIC);
297                 if (!cp) {
298                         asd_printk("%s: out of memory\n", __FUNCTION__);
299                         goto out;
300                 }
301                 ASD_DPRINTK("phy%d: retries:0 performing link reset seq\n",
302                             phy_id);
303                 asd_build_control_phy(cp, phy_id, ENABLE_PHY);
304                 if (asd_post_ascb_list(ascb->ha, cp, 1) != 0)
305                         asd_ascb_free(cp);
306         }
307 out:
308         ;
309 }
310
311 static inline void asd_primitive_rcvd_tasklet(struct asd_ascb *ascb,
312                                               struct done_list_struct *dl,
313                                               int phy_id)
314 {
315         unsigned long flags;
316         struct sas_ha_struct *sas_ha = &ascb->ha->sas_ha;
317         struct asd_sas_phy *sas_phy = sas_ha->sas_phy[phy_id];
318         struct asd_ha_struct *asd_ha = ascb->ha;
319         struct asd_phy *phy = &asd_ha->phys[phy_id];
320         u8  reg  = dl->status_block[1];
321         u32 cont = dl->status_block[2] << ((reg & 3)*8);
322
323         reg &= ~3;
324         switch (reg) {
325         case LmPRMSTAT0BYTE0:
326                 switch (cont) {
327                 case LmBROADCH:
328                 case LmBROADRVCH0:
329                 case LmBROADRVCH1:
330                 case LmBROADSES:
331                         ASD_DPRINTK("phy%d: BROADCAST change received:%d\n",
332                                     phy_id, cont);
333                         spin_lock_irqsave(&sas_phy->sas_prim_lock, flags);
334                         sas_phy->sas_prim = ffs(cont);
335                         spin_unlock_irqrestore(&sas_phy->sas_prim_lock, flags);
336                         sas_ha->notify_port_event(sas_phy,PORTE_BROADCAST_RCVD);
337                         break;
338
339                 case LmUNKNOWNP:
340                         ASD_DPRINTK("phy%d: unknown BREAK\n", phy_id);
341                         break;
342
343                 default:
344                         ASD_DPRINTK("phy%d: primitive reg:0x%x, cont:0x%04x\n",
345                                     phy_id, reg, cont);
346                         break;
347                 }
348                 break;
349         case LmPRMSTAT1BYTE0:
350                 switch (cont) {
351                 case LmHARDRST:
352                         ASD_DPRINTK("phy%d: HARD_RESET primitive rcvd\n",
353                                     phy_id);
354                         /* The sequencer disables all phys on that port.
355                          * We have to re-enable the phys ourselves. */
356                         asd_deform_port(asd_ha, phy);
357                         sas_ha->notify_port_event(sas_phy, PORTE_HARD_RESET);
358                         break;
359
360                 default:
361                         ASD_DPRINTK("phy%d: primitive reg:0x%x, cont:0x%04x\n",
362                                     phy_id, reg, cont);
363                         break;
364                 }
365                 break;
366         default:
367                 ASD_DPRINTK("unknown primitive register:0x%x\n",
368                             dl->status_block[1]);
369                 break;
370         }
371 }
372
373 /**
374  * asd_invalidate_edb -- invalidate an EDB and if necessary post the ESCB
375  * @ascb: pointer to Empty SCB
376  * @edb_id: index [0,6] to the empty data buffer which is to be invalidated
377  *
378  * After an EDB has been invalidated, if all EDBs in this ESCB have been
379  * invalidated, the ESCB is posted back to the sequencer.
380  * Context is tasklet/IRQ.
381  */
382 void asd_invalidate_edb(struct asd_ascb *ascb, int edb_id)
383 {
384         struct asd_seq_data *seq = &ascb->ha->seq;
385         struct empty_scb *escb = &ascb->scb->escb;
386         struct sg_el     *eb   = &escb->eb[edb_id];
387         struct asd_dma_tok *edb = seq->edb_arr[ascb->edb_index + edb_id];
388
389         memset(edb->vaddr, 0, ASD_EDB_SIZE);
390         eb->flags |= ELEMENT_NOT_VALID;
391         escb->num_valid--;
392
393         if (escb->num_valid == 0) {
394                 int i;
395                 /* ASD_DPRINTK("reposting escb: vaddr: 0x%p, "
396                             "dma_handle: 0x%08llx, next: 0x%08llx, "
397                             "index:%d, opcode:0x%02x\n",
398                             ascb->dma_scb.vaddr,
399                             (u64)ascb->dma_scb.dma_handle,
400                             le64_to_cpu(ascb->scb->header.next_scb),
401                             le16_to_cpu(ascb->scb->header.index),
402                             ascb->scb->header.opcode);
403                 */
404                 escb->num_valid = ASD_EDBS_PER_SCB;
405                 for (i = 0; i < ASD_EDBS_PER_SCB; i++)
406                         escb->eb[i].flags = 0;
407                 if (!list_empty(&ascb->list))
408                         list_del_init(&ascb->list);
409                 i = asd_post_escb_list(ascb->ha, ascb, 1);
410                 if (i)
411                         asd_printk("couldn't post escb, err:%d\n", i);
412         }
413 }
414
415 static void escb_tasklet_complete(struct asd_ascb *ascb,
416                                   struct done_list_struct *dl)
417 {
418         struct asd_ha_struct *asd_ha = ascb->ha;
419         struct sas_ha_struct *sas_ha = &asd_ha->sas_ha;
420         int edb = (dl->opcode & DL_PHY_MASK) - 1; /* [0xc1,0xc7] -> [0,6] */
421         u8  sb_opcode = dl->status_block[0];
422         int phy_id = sb_opcode & DL_PHY_MASK;
423         struct asd_sas_phy *sas_phy = sas_ha->sas_phy[phy_id];
424         struct asd_phy *phy = &asd_ha->phys[phy_id];
425
426         if (edb > 6 || edb < 0) {
427                 ASD_DPRINTK("edb is 0x%x! dl->opcode is 0x%x\n",
428                             edb, dl->opcode);
429                 ASD_DPRINTK("sb_opcode : 0x%x, phy_id: 0x%x\n",
430                             sb_opcode, phy_id);
431                 ASD_DPRINTK("escb: vaddr: 0x%p, "
432                             "dma_handle: 0x%llx, next: 0x%llx, "
433                             "index:%d, opcode:0x%02x\n",
434                             ascb->dma_scb.vaddr,
435                             (unsigned long long)ascb->dma_scb.dma_handle,
436                             (unsigned long long)
437                             le64_to_cpu(ascb->scb->header.next_scb),
438                             le16_to_cpu(ascb->scb->header.index),
439                             ascb->scb->header.opcode);
440         }
441
442         sb_opcode &= ~DL_PHY_MASK;
443
444         switch (sb_opcode) {
445         case BYTES_DMAED:
446                 ASD_DPRINTK("%s: phy%d: BYTES_DMAED\n", __FUNCTION__, phy_id);
447                 asd_bytes_dmaed_tasklet(ascb, dl, edb, phy_id);
448                 break;
449         case PRIMITIVE_RECVD:
450                 ASD_DPRINTK("%s: phy%d: PRIMITIVE_RECVD\n", __FUNCTION__,
451                             phy_id);
452                 asd_primitive_rcvd_tasklet(ascb, dl, phy_id);
453                 break;
454         case PHY_EVENT:
455                 ASD_DPRINTK("%s: phy%d: PHY_EVENT\n", __FUNCTION__, phy_id);
456                 asd_phy_event_tasklet(ascb, dl);
457                 break;
458         case LINK_RESET_ERROR:
459                 ASD_DPRINTK("%s: phy%d: LINK_RESET_ERROR\n", __FUNCTION__,
460                             phy_id);
461                 asd_link_reset_err_tasklet(ascb, dl, phy_id);
462                 break;
463         case TIMER_EVENT:
464                 ASD_DPRINTK("%s: phy%d: TIMER_EVENT, lost dw sync\n",
465                             __FUNCTION__, phy_id);
466                 asd_turn_led(asd_ha, phy_id, 0);
467                 /* the device is gone */
468                 sas_phy_disconnected(sas_phy);
469                 asd_deform_port(asd_ha, phy);
470                 sas_ha->notify_port_event(sas_phy, PORTE_TIMER_EVENT);
471                 break;
472         case REQ_TASK_ABORT:
473                 ASD_DPRINTK("%s: phy%d: REQ_TASK_ABORT\n", __FUNCTION__,
474                             phy_id);
475                 break;
476         case REQ_DEVICE_RESET:
477                 ASD_DPRINTK("%s: phy%d: REQ_DEVICE_RESET\n", __FUNCTION__,
478                             phy_id);
479                 break;
480         case SIGNAL_NCQ_ERROR:
481                 ASD_DPRINTK("%s: phy%d: SIGNAL_NCQ_ERROR\n", __FUNCTION__,
482                             phy_id);
483                 break;
484         case CLEAR_NCQ_ERROR:
485                 ASD_DPRINTK("%s: phy%d: CLEAR_NCQ_ERROR\n", __FUNCTION__,
486                             phy_id);
487                 break;
488         default:
489                 ASD_DPRINTK("%s: phy%d: unknown event:0x%x\n", __FUNCTION__,
490                             phy_id, sb_opcode);
491                 ASD_DPRINTK("edb is 0x%x! dl->opcode is 0x%x\n",
492                             edb, dl->opcode);
493                 ASD_DPRINTK("sb_opcode : 0x%x, phy_id: 0x%x\n",
494                             sb_opcode, phy_id);
495                 ASD_DPRINTK("escb: vaddr: 0x%p, "
496                             "dma_handle: 0x%llx, next: 0x%llx, "
497                             "index:%d, opcode:0x%02x\n",
498                             ascb->dma_scb.vaddr,
499                             (unsigned long long)ascb->dma_scb.dma_handle,
500                             (unsigned long long)
501                             le64_to_cpu(ascb->scb->header.next_scb),
502                             le16_to_cpu(ascb->scb->header.index),
503                             ascb->scb->header.opcode);
504
505                 break;
506         }
507
508         asd_invalidate_edb(ascb, edb);
509 }
510
511 int asd_init_post_escbs(struct asd_ha_struct *asd_ha)
512 {
513         struct asd_seq_data *seq = &asd_ha->seq;
514         int i;
515
516         for (i = 0; i < seq->num_escbs; i++)
517                 seq->escb_arr[i]->tasklet_complete = escb_tasklet_complete;
518
519         ASD_DPRINTK("posting %d escbs\n", i);
520         return asd_post_escb_list(asd_ha, seq->escb_arr[0], seq->num_escbs);
521 }
522
523 /* ---------- CONTROL PHY ---------- */
524
525 #define CONTROL_PHY_STATUS (CURRENT_DEVICE_PRESENT | CURRENT_OOB_DONE   \
526                             | CURRENT_SPINUP_HOLD | CURRENT_GTO_TIMEOUT \
527                             | CURRENT_OOB_ERROR)
528
529 /**
530  * control_phy_tasklet_complete -- tasklet complete for CONTROL PHY ascb
531  * @ascb: pointer to an ascb
532  * @dl: pointer to the done list entry
533  *
534  * This function completes a CONTROL PHY scb and frees the ascb.
535  * A note on LEDs:
536  *  - an LED blinks if there is IO though it,
537  *  - if a device is connected to the LED, it is lit,
538  *  - if no device is connected to the LED, is is dimmed (off).
539  */
540 static void control_phy_tasklet_complete(struct asd_ascb *ascb,
541                                          struct done_list_struct *dl)
542 {
543         struct asd_ha_struct *asd_ha = ascb->ha;
544         struct scb *scb = ascb->scb;
545         struct control_phy *control_phy = &scb->control_phy;
546         u8 phy_id = control_phy->phy_id;
547         struct asd_phy *phy = &ascb->ha->phys[phy_id];
548
549         u8 status     = dl->status_block[0];
550         u8 oob_status = dl->status_block[1];
551         u8 oob_mode   = dl->status_block[2];
552         /* u8 oob_signals= dl->status_block[3]; */
553
554         if (status != 0) {
555                 ASD_DPRINTK("%s: phy%d status block opcode:0x%x\n",
556                             __FUNCTION__, phy_id, status);
557                 goto out;
558         }
559
560         switch (control_phy->sub_func) {
561         case DISABLE_PHY:
562                 asd_ha->hw_prof.enabled_phys &= ~(1 << phy_id);
563                 asd_turn_led(asd_ha, phy_id, 0);
564                 asd_control_led(asd_ha, phy_id, 0);
565                 ASD_DPRINTK("%s: disable phy%d\n", __FUNCTION__, phy_id);
566                 break;
567
568         case ENABLE_PHY:
569                 asd_control_led(asd_ha, phy_id, 1);
570                 if (oob_status & CURRENT_OOB_DONE) {
571                         asd_ha->hw_prof.enabled_phys |= (1 << phy_id);
572                         get_lrate_mode(phy, oob_mode);
573                         asd_turn_led(asd_ha, phy_id, 1);
574                         ASD_DPRINTK("%s: phy%d, lrate:0x%x, proto:0x%x\n",
575                                     __FUNCTION__, phy_id,phy->sas_phy.linkrate,
576                                     phy->sas_phy.iproto);
577                 } else if (oob_status & CURRENT_SPINUP_HOLD) {
578                         asd_ha->hw_prof.enabled_phys |= (1 << phy_id);
579                         asd_turn_led(asd_ha, phy_id, 1);
580                         ASD_DPRINTK("%s: phy%d, spinup hold\n", __FUNCTION__,
581                                     phy_id);
582                 } else if (oob_status & CURRENT_ERR_MASK) {
583                         asd_turn_led(asd_ha, phy_id, 0);
584                         ASD_DPRINTK("%s: phy%d: error: oob status:0x%02x\n",
585                                     __FUNCTION__, phy_id, oob_status);
586                 } else if (oob_status & (CURRENT_HOT_PLUG_CNCT
587                                          | CURRENT_DEVICE_PRESENT))  {
588                         asd_ha->hw_prof.enabled_phys |= (1 << phy_id);
589                         asd_turn_led(asd_ha, phy_id, 1);
590                         ASD_DPRINTK("%s: phy%d: hot plug or device present\n",
591                                     __FUNCTION__, phy_id);
592                 } else {
593                         asd_ha->hw_prof.enabled_phys |= (1 << phy_id);
594                         asd_turn_led(asd_ha, phy_id, 0);
595                         ASD_DPRINTK("%s: phy%d: no device present: "
596                                     "oob_status:0x%x\n",
597                                     __FUNCTION__, phy_id, oob_status);
598                 }
599                 break;
600         case RELEASE_SPINUP_HOLD:
601         case PHY_NO_OP:
602         case EXECUTE_HARD_RESET:
603                 ASD_DPRINTK("%s: phy%d: sub_func:0x%x\n", __FUNCTION__,
604                             phy_id, control_phy->sub_func);
605                 /* XXX finish */
606                 break;
607         default:
608                 ASD_DPRINTK("%s: phy%d: sub_func:0x%x?\n", __FUNCTION__,
609                             phy_id, control_phy->sub_func);
610                 break;
611         }
612 out:
613         asd_ascb_free(ascb);
614 }
615
616 static inline void set_speed_mask(u8 *speed_mask, struct asd_phy_desc *pd)
617 {
618         /* disable all speeds, then enable defaults */
619         *speed_mask = SAS_SPEED_60_DIS | SAS_SPEED_30_DIS | SAS_SPEED_15_DIS
620                 | SATA_SPEED_30_DIS | SATA_SPEED_15_DIS;
621
622         switch (pd->max_sas_lrate) {
623         case SAS_LINK_RATE_6_0_GBPS:
624                 *speed_mask &= ~SAS_SPEED_60_DIS;
625         default:
626         case SAS_LINK_RATE_3_0_GBPS:
627                 *speed_mask &= ~SAS_SPEED_30_DIS;
628         case SAS_LINK_RATE_1_5_GBPS:
629                 *speed_mask &= ~SAS_SPEED_15_DIS;
630         }
631
632         switch (pd->min_sas_lrate) {
633         case SAS_LINK_RATE_6_0_GBPS:
634                 *speed_mask |= SAS_SPEED_30_DIS;
635         case SAS_LINK_RATE_3_0_GBPS:
636                 *speed_mask |= SAS_SPEED_15_DIS;
637         default:
638         case SAS_LINK_RATE_1_5_GBPS:
639                 /* nothing to do */
640                 ;
641         }
642
643         switch (pd->max_sata_lrate) {
644         case SAS_LINK_RATE_3_0_GBPS:
645                 *speed_mask &= ~SATA_SPEED_30_DIS;
646         default:
647         case SAS_LINK_RATE_1_5_GBPS:
648                 *speed_mask &= ~SATA_SPEED_15_DIS;
649         }
650
651         switch (pd->min_sata_lrate) {
652         case SAS_LINK_RATE_3_0_GBPS:
653                 *speed_mask |= SATA_SPEED_15_DIS;
654         default:
655         case SAS_LINK_RATE_1_5_GBPS:
656                 /* nothing to do */
657                 ;
658         }
659 }
660
661 /**
662  * asd_build_control_phy -- build a CONTROL PHY SCB
663  * @ascb: pointer to an ascb
664  * @phy_id: phy id to control, integer
665  * @subfunc: subfunction, what to actually to do the phy
666  *
667  * This function builds a CONTROL PHY scb.  No allocation of any kind
668  * is performed. @ascb is allocated with the list function.
669  * The caller can override the ascb->tasklet_complete to point
670  * to its own callback function.  It must call asd_ascb_free()
671  * at its tasklet complete function.
672  * See the default implementation.
673  */
674 void asd_build_control_phy(struct asd_ascb *ascb, int phy_id, u8 subfunc)
675 {
676         struct asd_phy *phy = &ascb->ha->phys[phy_id];
677         struct scb *scb = ascb->scb;
678         struct control_phy *control_phy = &scb->control_phy;
679
680         scb->header.opcode = CONTROL_PHY;
681         control_phy->phy_id = (u8) phy_id;
682         control_phy->sub_func = subfunc;
683
684         switch (subfunc) {
685         case EXECUTE_HARD_RESET:  /* 0x81 */
686         case ENABLE_PHY:          /* 0x01 */
687                 /* decide hot plug delay */
688                 control_phy->hot_plug_delay = HOTPLUG_DELAY_TIMEOUT;
689
690                 /* decide speed mask */
691                 set_speed_mask(&control_phy->speed_mask, phy->phy_desc);
692
693                 /* initiator port settings are in the hi nibble */
694                 if (phy->sas_phy.role == PHY_ROLE_INITIATOR)
695                         control_phy->port_type = SAS_PROTO_ALL << 4;
696                 else if (phy->sas_phy.role == PHY_ROLE_TARGET)
697                         control_phy->port_type = SAS_PROTO_ALL;
698                 else
699                         control_phy->port_type =
700                                 (SAS_PROTO_ALL << 4) | SAS_PROTO_ALL;
701
702                 /* link reset retries, this should be nominal */
703                 control_phy->link_reset_retries = 10;
704
705         case RELEASE_SPINUP_HOLD: /* 0x02 */
706                 /* decide the func_mask */
707                 control_phy->func_mask = FUNCTION_MASK_DEFAULT;
708                 if (phy->phy_desc->flags & ASD_SATA_SPINUP_HOLD)
709                         control_phy->func_mask &= ~SPINUP_HOLD_DIS;
710                 else
711                         control_phy->func_mask |= SPINUP_HOLD_DIS;
712         }
713
714         control_phy->conn_handle = cpu_to_le16(0xFFFF);
715
716         ascb->tasklet_complete = control_phy_tasklet_complete;
717 }
718
719 /* ---------- INITIATE LINK ADM TASK ---------- */
720
721 static void link_adm_tasklet_complete(struct asd_ascb *ascb,
722                                       struct done_list_struct *dl)
723 {
724         u8 opcode = dl->opcode;
725         struct initiate_link_adm *link_adm = &ascb->scb->link_adm;
726         u8 phy_id = link_adm->phy_id;
727
728         if (opcode != TC_NO_ERROR) {
729                 asd_printk("phy%d: link adm task 0x%x completed with error "
730                            "0x%x\n", phy_id, link_adm->sub_func, opcode);
731         }
732         ASD_DPRINTK("phy%d: link adm task 0x%x: 0x%x\n",
733                     phy_id, link_adm->sub_func, opcode);
734
735         asd_ascb_free(ascb);
736 }
737
738 void asd_build_initiate_link_adm_task(struct asd_ascb *ascb, int phy_id,
739                                       u8 subfunc)
740 {
741         struct scb *scb = ascb->scb;
742         struct initiate_link_adm *link_adm = &scb->link_adm;
743
744         scb->header.opcode = INITIATE_LINK_ADM_TASK;
745
746         link_adm->phy_id = phy_id;
747         link_adm->sub_func = subfunc;
748         link_adm->conn_handle = cpu_to_le16(0xFFFF);
749
750         ascb->tasklet_complete = link_adm_tasklet_complete;
751 }
752
753 /* ---------- SCB timer ---------- */
754
755 /**
756  * asd_ascb_timedout -- called when a pending SCB's timer has expired
757  * @data: unsigned long, a pointer to the ascb in question
758  *
759  * This is the default timeout function which does the most necessary.
760  * Upper layers can implement their own timeout function, say to free
761  * resources they have with this SCB, and then call this one at the
762  * end of their timeout function.  To do this, one should initialize
763  * the ascb->timer.{function, data, expires} prior to calling the post
764  * funcion.  The timer is started by the post function.
765  */
766 void asd_ascb_timedout(unsigned long data)
767 {
768         struct asd_ascb *ascb = (void *) data;
769         struct asd_seq_data *seq = &ascb->ha->seq;
770         unsigned long flags;
771
772         ASD_DPRINTK("scb:0x%x timed out\n", ascb->scb->header.opcode);
773
774         spin_lock_irqsave(&seq->pend_q_lock, flags);
775         seq->pending--;
776         list_del_init(&ascb->list);
777         spin_unlock_irqrestore(&seq->pend_q_lock, flags);
778
779         asd_ascb_free(ascb);
780 }
781
782 /* ---------- CONTROL PHY ---------- */
783
784 /* Given the spec value, return a driver value. */
785 static const int phy_func_table[] = {
786         [PHY_FUNC_NOP]        = PHY_NO_OP,
787         [PHY_FUNC_LINK_RESET] = ENABLE_PHY,
788         [PHY_FUNC_HARD_RESET] = EXECUTE_HARD_RESET,
789         [PHY_FUNC_DISABLE]    = DISABLE_PHY,
790         [PHY_FUNC_RELEASE_SPINUP_HOLD] = RELEASE_SPINUP_HOLD,
791 };
792
793 int asd_control_phy(struct asd_sas_phy *phy, enum phy_func func, void *arg)
794 {
795         struct asd_ha_struct *asd_ha = phy->ha->lldd_ha;
796         struct asd_phy_desc *pd = asd_ha->phys[phy->id].phy_desc;
797         struct asd_ascb *ascb;
798         struct sas_phy_linkrates *rates;
799         int res = 1;
800
801         switch (func) {
802         case PHY_FUNC_CLEAR_ERROR_LOG:
803                 return -ENOSYS;
804         case PHY_FUNC_SET_LINK_RATE:
805                 rates = arg;
806                 if (rates->minimum_linkrate) {
807                         pd->min_sas_lrate = rates->minimum_linkrate;
808                         pd->min_sata_lrate = rates->minimum_linkrate;
809                 }
810                 if (rates->maximum_linkrate) {
811                         pd->max_sas_lrate = rates->maximum_linkrate;
812                         pd->max_sata_lrate = rates->maximum_linkrate;
813                 }
814                 func = PHY_FUNC_LINK_RESET;
815                 break;
816         default:
817                 break;
818         }
819
820         ascb = asd_ascb_alloc_list(asd_ha, &res, GFP_KERNEL);
821         if (!ascb)
822                 return -ENOMEM;
823
824         asd_build_control_phy(ascb, phy->id, phy_func_table[func]);
825         res = asd_post_ascb_list(asd_ha, ascb , 1);
826         if (res)
827                 asd_ascb_free(ascb);
828
829         return res;
830 }