2 * PMC-Sierra PM8001/8081/8088/8089 SAS/SATA based host adapters driver
4 * Copyright (c) 2008-2009 USI Co., Ltd.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14 * substantially similar to the "NO WARRANTY" disclaimer below
15 * ("Disclaimer") and any redistribution must be conditioned upon
16 * including a substantially similar Disclaimer requirement for further
17 * binary redistribution.
18 * 3. Neither the names of the above-listed copyright holders nor the names
19 * of any contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * Alternatively, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") version 2 as published by the Free
24 * Software Foundation.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
35 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
36 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGES.
41 #include <linux/slab.h>
42 #include "pm8001_sas.h"
45 * pm8001_find_tag - from sas task to find out tag that belongs to this task
46 * @task: the task sent to the LLDD
47 * @tag: the found tag associated with the task
49 static int pm8001_find_tag(struct sas_task *task, u32 *tag)
51 if (task->lldd_task) {
52 struct pm8001_ccb_info *ccb;
53 ccb = task->lldd_task;
61 * pm8001_tag_free - free the no more needed tag
62 * @pm8001_ha: our hba struct
63 * @tag: the found tag associated with the task
65 void pm8001_tag_free(struct pm8001_hba_info *pm8001_ha, u32 tag)
67 void *bitmap = pm8001_ha->tags;
68 clear_bit(tag, bitmap);
72 * pm8001_tag_alloc - allocate a empty tag for task used.
73 * @pm8001_ha: our hba struct
74 * @tag_out: the found empty tag .
76 inline int pm8001_tag_alloc(struct pm8001_hba_info *pm8001_ha, u32 *tag_out)
79 void *bitmap = pm8001_ha->tags;
82 spin_lock_irqsave(&pm8001_ha->bitmap_lock, flags);
83 tag = find_first_zero_bit(bitmap, pm8001_ha->tags_num);
84 if (tag >= pm8001_ha->tags_num) {
85 spin_unlock_irqrestore(&pm8001_ha->bitmap_lock, flags);
86 return -SAS_QUEUE_FULL;
89 spin_unlock_irqrestore(&pm8001_ha->bitmap_lock, flags);
94 void pm8001_tag_init(struct pm8001_hba_info *pm8001_ha)
97 for (i = 0; i < pm8001_ha->tags_num; ++i)
98 pm8001_tag_free(pm8001_ha, i);
102 * pm8001_mem_alloc - allocate memory for pm8001.
104 * @virt_addr: the allocated virtual address
105 * @pphys_addr_hi: the physical address high byte address.
106 * @pphys_addr_lo: the physical address low byte address.
107 * @mem_size: memory size.
109 int pm8001_mem_alloc(struct pci_dev *pdev, void **virt_addr,
110 dma_addr_t *pphys_addr, u32 *pphys_addr_hi,
111 u32 *pphys_addr_lo, u32 mem_size, u32 align)
113 caddr_t mem_virt_alloc;
114 dma_addr_t mem_dma_handle;
116 u64 align_offset = 0;
118 align_offset = (dma_addr_t)align - 1;
119 mem_virt_alloc = dma_alloc_coherent(&pdev->dev, mem_size + align,
120 &mem_dma_handle, GFP_KERNEL);
121 if (!mem_virt_alloc) {
122 pr_err("pm80xx: memory allocation error\n");
125 *pphys_addr = mem_dma_handle;
126 phys_align = (*pphys_addr + align_offset) & ~align_offset;
127 *virt_addr = (void *)mem_virt_alloc + phys_align - *pphys_addr;
128 *pphys_addr_hi = upper_32_bits(phys_align);
129 *pphys_addr_lo = lower_32_bits(phys_align);
134 * pm8001_find_ha_by_dev - from domain device which come from sas layer to
135 * find out our hba struct.
136 * @dev: the domain device which from sas layer.
139 struct pm8001_hba_info *pm8001_find_ha_by_dev(struct domain_device *dev)
141 struct sas_ha_struct *sha = dev->port->ha;
142 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
147 * pm8001_phy_control - this function should be registered to
148 * sas_domain_function_template to provide libsas used, note: this is just
149 * control the HBA phy rather than other expander phy if you want control
150 * other phy, you should use SMP command.
151 * @sas_phy: which phy in HBA phys.
152 * @func: the operation.
153 * @funcdata: always NULL.
155 int pm8001_phy_control(struct asd_sas_phy *sas_phy, enum phy_func func,
158 int rc = 0, phy_id = sas_phy->id;
159 struct pm8001_hba_info *pm8001_ha = NULL;
160 struct sas_phy_linkrates *rates;
161 struct pm8001_phy *phy;
162 DECLARE_COMPLETION_ONSTACK(completion);
164 pm8001_ha = sas_phy->ha->lldd_ha;
165 phy = &pm8001_ha->phy[phy_id];
166 pm8001_ha->phy[phy_id].enable_completion = &completion;
168 case PHY_FUNC_SET_LINK_RATE:
170 if (rates->minimum_linkrate) {
171 pm8001_ha->phy[phy_id].minimum_linkrate =
172 rates->minimum_linkrate;
174 if (rates->maximum_linkrate) {
175 pm8001_ha->phy[phy_id].maximum_linkrate =
176 rates->maximum_linkrate;
178 if (pm8001_ha->phy[phy_id].phy_state == PHY_LINK_DISABLE) {
179 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, phy_id);
180 wait_for_completion(&completion);
182 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
185 case PHY_FUNC_HARD_RESET:
186 if (pm8001_ha->phy[phy_id].phy_state == PHY_LINK_DISABLE) {
187 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, phy_id);
188 wait_for_completion(&completion);
190 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
193 case PHY_FUNC_LINK_RESET:
194 if (pm8001_ha->phy[phy_id].phy_state == PHY_LINK_DISABLE) {
195 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, phy_id);
196 wait_for_completion(&completion);
198 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
201 case PHY_FUNC_RELEASE_SPINUP_HOLD:
202 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
205 case PHY_FUNC_DISABLE:
206 if (pm8001_ha->chip_id != chip_8001) {
207 if (pm8001_ha->phy[phy_id].phy_state ==
208 PHY_STATE_LINK_UP_SPCV) {
209 sas_phy_disconnected(&phy->sas_phy);
210 sas_notify_phy_event(&phy->sas_phy,
211 PHYE_LOSS_OF_SIGNAL, GFP_KERNEL);
212 phy->phy_attached = 0;
215 if (pm8001_ha->phy[phy_id].phy_state ==
216 PHY_STATE_LINK_UP_SPC) {
217 sas_phy_disconnected(&phy->sas_phy);
218 sas_notify_phy_event(&phy->sas_phy,
219 PHYE_LOSS_OF_SIGNAL, GFP_KERNEL);
220 phy->phy_attached = 0;
223 PM8001_CHIP_DISP->phy_stop_req(pm8001_ha, phy_id);
225 case PHY_FUNC_GET_EVENTS:
226 spin_lock_irqsave(&pm8001_ha->lock, flags);
227 if (pm8001_ha->chip_id == chip_8001) {
228 if (-1 == pm8001_bar4_shift(pm8001_ha,
229 (phy_id < 4) ? 0x30000 : 0x40000)) {
230 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
235 struct sas_phy *phy = sas_phy->phy;
236 uint32_t *qp = (uint32_t *)(((char *)
237 pm8001_ha->io_mem[2].memvirtaddr)
238 + 0x1034 + (0x4000 * (phy_id & 3)));
240 phy->invalid_dword_count = qp[0];
241 phy->running_disparity_error_count = qp[1];
242 phy->loss_of_dword_sync_count = qp[3];
243 phy->phy_reset_problem_count = qp[4];
245 if (pm8001_ha->chip_id == chip_8001)
246 pm8001_bar4_shift(pm8001_ha, 0);
247 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
250 pm8001_dbg(pm8001_ha, DEVIO, "func 0x%x\n", func);
258 * pm8001_scan_start - we should enable all HBA phys by sending the phy_start
260 * @shost: the scsi host data.
262 void pm8001_scan_start(struct Scsi_Host *shost)
265 struct pm8001_hba_info *pm8001_ha;
266 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
267 DECLARE_COMPLETION_ONSTACK(completion);
268 pm8001_ha = sha->lldd_ha;
269 /* SAS_RE_INITIALIZATION not available in SPCv/ve */
270 if (pm8001_ha->chip_id == chip_8001)
271 PM8001_CHIP_DISP->sas_re_init_req(pm8001_ha);
272 for (i = 0; i < pm8001_ha->chip->n_phy; ++i) {
273 pm8001_ha->phy[i].enable_completion = &completion;
274 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, i);
275 wait_for_completion(&completion);
280 int pm8001_scan_finished(struct Scsi_Host *shost, unsigned long time)
282 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
284 /* give the phy enabling interrupt event time to come in (1s
285 * is empirically about all it takes) */
288 /* Wait for discovery to finish */
294 * pm8001_task_prep_smp - the dispatcher function, prepare data for smp task
295 * @pm8001_ha: our hba card information
296 * @ccb: the ccb which attached to smp task
298 static int pm8001_task_prep_smp(struct pm8001_hba_info *pm8001_ha,
299 struct pm8001_ccb_info *ccb)
301 return PM8001_CHIP_DISP->smp_req(pm8001_ha, ccb);
304 u32 pm8001_get_ncq_tag(struct sas_task *task, u32 *tag)
306 struct ata_queued_cmd *qc = task->uldd_task;
308 if (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
309 qc->tf.command == ATA_CMD_FPDMA_READ ||
310 qc->tf.command == ATA_CMD_FPDMA_RECV ||
311 qc->tf.command == ATA_CMD_FPDMA_SEND ||
312 qc->tf.command == ATA_CMD_NCQ_NON_DATA) {
321 * pm8001_task_prep_ata - the dispatcher function, prepare data for sata task
322 * @pm8001_ha: our hba card information
323 * @ccb: the ccb which attached to sata task
325 static int pm8001_task_prep_ata(struct pm8001_hba_info *pm8001_ha,
326 struct pm8001_ccb_info *ccb)
328 return PM8001_CHIP_DISP->sata_req(pm8001_ha, ccb);
332 * pm8001_task_prep_ssp_tm - the dispatcher function, prepare task management data
333 * @pm8001_ha: our hba card information
334 * @ccb: the ccb which attached to TM
335 * @tmf: the task management IU
337 static int pm8001_task_prep_ssp_tm(struct pm8001_hba_info *pm8001_ha,
338 struct pm8001_ccb_info *ccb, struct pm8001_tmf_task *tmf)
340 return PM8001_CHIP_DISP->ssp_tm_req(pm8001_ha, ccb, tmf);
344 * pm8001_task_prep_ssp - the dispatcher function,prepare ssp data for ssp task
345 * @pm8001_ha: our hba card information
346 * @ccb: the ccb which attached to ssp task
348 static int pm8001_task_prep_ssp(struct pm8001_hba_info *pm8001_ha,
349 struct pm8001_ccb_info *ccb)
351 return PM8001_CHIP_DISP->ssp_io_req(pm8001_ha, ccb);
354 /* Find the local port id that's attached to this device */
355 static int sas_find_local_port_id(struct domain_device *dev)
357 struct domain_device *pdev = dev->parent;
359 /* Directly attached device */
361 return dev->port->id;
363 struct domain_device *pdev_p = pdev->parent;
365 return pdev->port->id;
371 #define DEV_IS_GONE(pm8001_dev) \
372 ((!pm8001_dev || (pm8001_dev->dev_type == SAS_PHY_UNUSED)))
374 * pm8001_task_exec - queue the task(ssp, smp && ata) to the hardware.
375 * @task: the task to be execute.
376 * @gfp_flags: gfp_flags.
377 * @is_tmf: if it is task management task.
378 * @tmf: the task management IU
380 static int pm8001_task_exec(struct sas_task *task,
381 gfp_t gfp_flags, int is_tmf, struct pm8001_tmf_task *tmf)
383 struct domain_device *dev = task->dev;
384 struct pm8001_hba_info *pm8001_ha;
385 struct pm8001_device *pm8001_dev;
386 struct pm8001_port *port = NULL;
387 struct sas_task *t = task;
388 struct pm8001_ccb_info *ccb;
389 u32 tag = 0xdeadbeef, rc = 0, n_elem = 0;
390 unsigned long flags = 0;
391 enum sas_protocol task_proto = t->task_proto;
394 struct task_status_struct *tsm = &t->task_status;
395 tsm->resp = SAS_TASK_UNDELIVERED;
396 tsm->stat = SAS_PHY_DOWN;
397 if (dev->dev_type != SAS_SATA_DEV)
401 pm8001_ha = pm8001_find_ha_by_dev(task->dev);
402 if (pm8001_ha->controller_fatal_error) {
403 struct task_status_struct *ts = &t->task_status;
405 ts->resp = SAS_TASK_UNDELIVERED;
409 pm8001_dbg(pm8001_ha, IO, "pm8001_task_exec device\n");
410 spin_lock_irqsave(&pm8001_ha->lock, flags);
413 pm8001_dev = dev->lldd_dev;
414 port = &pm8001_ha->port[sas_find_local_port_id(dev)];
415 if (DEV_IS_GONE(pm8001_dev) || !port->port_attached) {
416 if (sas_protocol_ata(task_proto)) {
417 struct task_status_struct *ts = &t->task_status;
418 ts->resp = SAS_TASK_UNDELIVERED;
419 ts->stat = SAS_PHY_DOWN;
421 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
423 spin_lock_irqsave(&pm8001_ha->lock, flags);
426 struct task_status_struct *ts = &t->task_status;
427 ts->resp = SAS_TASK_UNDELIVERED;
428 ts->stat = SAS_PHY_DOWN;
433 rc = pm8001_tag_alloc(pm8001_ha, &tag);
436 ccb = &pm8001_ha->ccb_info[tag];
438 if (!sas_protocol_ata(task_proto)) {
439 if (t->num_scatter) {
440 n_elem = dma_map_sg(pm8001_ha->dev,
450 n_elem = t->num_scatter;
454 ccb->n_elem = n_elem;
457 ccb->device = pm8001_dev;
458 switch (task_proto) {
459 case SAS_PROTOCOL_SMP:
460 atomic_inc(&pm8001_dev->running_req);
461 rc = pm8001_task_prep_smp(pm8001_ha, ccb);
463 case SAS_PROTOCOL_SSP:
464 atomic_inc(&pm8001_dev->running_req);
466 rc = pm8001_task_prep_ssp_tm(pm8001_ha,
469 rc = pm8001_task_prep_ssp(pm8001_ha, ccb);
471 case SAS_PROTOCOL_SATA:
472 case SAS_PROTOCOL_STP:
473 atomic_inc(&pm8001_dev->running_req);
474 rc = pm8001_task_prep_ata(pm8001_ha, ccb);
477 dev_printk(KERN_ERR, pm8001_ha->dev,
478 "unknown sas_task proto: 0x%x\n", task_proto);
484 pm8001_dbg(pm8001_ha, IO, "rc is %x\n", rc);
485 atomic_dec(&pm8001_dev->running_req);
488 /* TODO: select normal or high priority */
489 spin_lock(&t->task_state_lock);
490 t->task_state_flags |= SAS_TASK_AT_INITIATOR;
491 spin_unlock(&t->task_state_lock);
497 pm8001_tag_free(pm8001_ha, tag);
499 dev_printk(KERN_ERR, pm8001_ha->dev, "pm8001 exec failed[%d]!\n", rc);
500 if (!sas_protocol_ata(task_proto))
502 dma_unmap_sg(pm8001_ha->dev, t->scatter, t->num_scatter,
505 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
510 * pm8001_queue_command - register for upper layer used, all IO commands sent
511 * to HBA are from this interface.
512 * @task: the task to be execute.
513 * @gfp_flags: gfp_flags
515 int pm8001_queue_command(struct sas_task *task, gfp_t gfp_flags)
517 return pm8001_task_exec(task, gfp_flags, 0, NULL);
521 * pm8001_ccb_task_free - free the sg for ssp and smp command, free the ccb.
522 * @pm8001_ha: our hba card information
523 * @ccb: the ccb which attached to ssp task
524 * @task: the task to be free.
525 * @ccb_idx: ccb index.
527 void pm8001_ccb_task_free(struct pm8001_hba_info *pm8001_ha,
528 struct sas_task *task, struct pm8001_ccb_info *ccb, u32 ccb_idx)
532 if (!sas_protocol_ata(task->task_proto))
534 dma_unmap_sg(pm8001_ha->dev, task->scatter,
535 task->num_scatter, task->data_dir);
537 switch (task->task_proto) {
538 case SAS_PROTOCOL_SMP:
539 dma_unmap_sg(pm8001_ha->dev, &task->smp_task.smp_resp, 1,
541 dma_unmap_sg(pm8001_ha->dev, &task->smp_task.smp_req, 1,
545 case SAS_PROTOCOL_SATA:
546 case SAS_PROTOCOL_STP:
547 case SAS_PROTOCOL_SSP:
552 task->lldd_task = NULL;
554 ccb->ccb_tag = 0xFFFFFFFF;
556 pm8001_tag_free(pm8001_ha, ccb_idx);
560 * pm8001_alloc_dev - find a empty pm8001_device
561 * @pm8001_ha: our hba card information
563 static struct pm8001_device *pm8001_alloc_dev(struct pm8001_hba_info *pm8001_ha)
566 for (dev = 0; dev < PM8001_MAX_DEVICES; dev++) {
567 if (pm8001_ha->devices[dev].dev_type == SAS_PHY_UNUSED) {
568 pm8001_ha->devices[dev].id = dev;
569 return &pm8001_ha->devices[dev];
572 if (dev == PM8001_MAX_DEVICES) {
573 pm8001_dbg(pm8001_ha, FAIL,
574 "max support %d devices, ignore ..\n",
580 * pm8001_find_dev - find a matching pm8001_device
581 * @pm8001_ha: our hba card information
582 * @device_id: device ID to match against
584 struct pm8001_device *pm8001_find_dev(struct pm8001_hba_info *pm8001_ha,
588 for (dev = 0; dev < PM8001_MAX_DEVICES; dev++) {
589 if (pm8001_ha->devices[dev].device_id == device_id)
590 return &pm8001_ha->devices[dev];
592 if (dev == PM8001_MAX_DEVICES) {
593 pm8001_dbg(pm8001_ha, FAIL, "NO MATCHING DEVICE FOUND !!!\n");
598 void pm8001_free_dev(struct pm8001_device *pm8001_dev)
600 u32 id = pm8001_dev->id;
601 memset(pm8001_dev, 0, sizeof(*pm8001_dev));
603 pm8001_dev->dev_type = SAS_PHY_UNUSED;
604 pm8001_dev->device_id = PM8001_MAX_DEVICES;
605 pm8001_dev->sas_device = NULL;
609 * pm8001_dev_found_notify - libsas notify a device is found.
610 * @dev: the device structure which sas layer used.
612 * when libsas find a sas domain device, it should tell the LLDD that
613 * device is found, and then LLDD register this device to HBA firmware
614 * by the command "OPC_INB_REG_DEV", after that the HBA will assign a
615 * device ID(according to device's sas address) and returned it to LLDD. From
616 * now on, we communicate with HBA FW with the device ID which HBA assigned
617 * rather than sas address. it is the necessary step for our HBA but it is
618 * the optional for other HBA driver.
620 static int pm8001_dev_found_notify(struct domain_device *dev)
622 unsigned long flags = 0;
624 struct pm8001_hba_info *pm8001_ha = NULL;
625 struct domain_device *parent_dev = dev->parent;
626 struct pm8001_device *pm8001_device;
627 DECLARE_COMPLETION_ONSTACK(completion);
629 pm8001_ha = pm8001_find_ha_by_dev(dev);
630 spin_lock_irqsave(&pm8001_ha->lock, flags);
632 pm8001_device = pm8001_alloc_dev(pm8001_ha);
633 if (!pm8001_device) {
637 pm8001_device->sas_device = dev;
638 dev->lldd_dev = pm8001_device;
639 pm8001_device->dev_type = dev->dev_type;
640 pm8001_device->dcompletion = &completion;
641 if (parent_dev && dev_is_expander(parent_dev->dev_type)) {
644 for (phy_id = 0; phy_id < parent_dev->ex_dev.num_phys;
646 phy = &parent_dev->ex_dev.ex_phy[phy_id];
647 if (SAS_ADDR(phy->attached_sas_addr)
648 == SAS_ADDR(dev->sas_addr)) {
649 pm8001_device->attached_phy = phy_id;
653 if (phy_id == parent_dev->ex_dev.num_phys) {
654 pm8001_dbg(pm8001_ha, FAIL,
655 "Error: no attached dev:%016llx at ex:%016llx.\n",
656 SAS_ADDR(dev->sas_addr),
657 SAS_ADDR(parent_dev->sas_addr));
661 if (dev->dev_type == SAS_SATA_DEV) {
662 pm8001_device->attached_phy =
663 dev->rphy->identify.phy_identifier;
664 flag = 1; /* directly sata */
666 } /*register this device to HBA*/
667 pm8001_dbg(pm8001_ha, DISC, "Found device\n");
668 PM8001_CHIP_DISP->reg_dev_req(pm8001_ha, pm8001_device, flag);
669 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
670 wait_for_completion(&completion);
671 if (dev->dev_type == SAS_END_DEVICE)
673 pm8001_ha->flags = PM8001F_RUN_TIME;
676 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
680 int pm8001_dev_found(struct domain_device *dev)
682 return pm8001_dev_found_notify(dev);
685 void pm8001_task_done(struct sas_task *task)
687 if (!del_timer(&task->slow_task->timer))
689 complete(&task->slow_task->completion);
692 static void pm8001_tmf_timedout(struct timer_list *t)
694 struct sas_task_slow *slow = from_timer(slow, t, timer);
695 struct sas_task *task = slow->task;
697 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
698 complete(&task->slow_task->completion);
701 #define PM8001_TASK_TIMEOUT 20
703 * pm8001_exec_internal_tmf_task - execute some task management commands.
704 * @dev: the wanted device.
705 * @tmf: which task management wanted to be take.
706 * @para_len: para_len.
707 * @parameter: ssp task parameter.
709 * when errors or exception happened, we may want to do something, for example
710 * abort the issued task which result in this execption, it is done by calling
711 * this function, note it is also with the task execute interface.
713 static int pm8001_exec_internal_tmf_task(struct domain_device *dev,
714 void *parameter, u32 para_len, struct pm8001_tmf_task *tmf)
717 struct sas_task *task = NULL;
718 struct pm8001_hba_info *pm8001_ha = pm8001_find_ha_by_dev(dev);
719 struct pm8001_device *pm8001_dev = dev->lldd_dev;
720 DECLARE_COMPLETION_ONSTACK(completion_setstate);
722 for (retry = 0; retry < 3; retry++) {
723 task = sas_alloc_slow_task(GFP_KERNEL);
728 task->task_proto = dev->tproto;
729 memcpy(&task->ssp_task, parameter, para_len);
730 task->task_done = pm8001_task_done;
731 task->slow_task->timer.function = pm8001_tmf_timedout;
732 task->slow_task->timer.expires = jiffies + PM8001_TASK_TIMEOUT*HZ;
733 add_timer(&task->slow_task->timer);
735 res = pm8001_task_exec(task, GFP_KERNEL, 1, tmf);
738 del_timer(&task->slow_task->timer);
739 pm8001_dbg(pm8001_ha, FAIL, "Executing internal task failed\n");
742 wait_for_completion(&task->slow_task->completion);
743 if (pm8001_ha->chip_id != chip_8001) {
744 pm8001_dev->setds_completion = &completion_setstate;
745 PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
746 pm8001_dev, DS_OPERATIONAL);
747 wait_for_completion(&completion_setstate);
749 res = -TMF_RESP_FUNC_FAILED;
750 /* Even TMF timed out, return direct. */
751 if ((task->task_state_flags & SAS_TASK_STATE_ABORTED)) {
752 if (!(task->task_state_flags & SAS_TASK_STATE_DONE)) {
753 pm8001_dbg(pm8001_ha, FAIL,
754 "TMF task[%x]timeout.\n",
760 if (task->task_status.resp == SAS_TASK_COMPLETE &&
761 task->task_status.stat == SAM_STAT_GOOD) {
762 res = TMF_RESP_FUNC_COMPLETE;
766 if (task->task_status.resp == SAS_TASK_COMPLETE &&
767 task->task_status.stat == SAS_DATA_UNDERRUN) {
768 /* no error, but return the number of bytes of
770 res = task->task_status.residual;
774 if (task->task_status.resp == SAS_TASK_COMPLETE &&
775 task->task_status.stat == SAS_DATA_OVERRUN) {
776 pm8001_dbg(pm8001_ha, FAIL, "Blocked task error.\n");
780 pm8001_dbg(pm8001_ha, EH,
781 " Task to dev %016llx response:0x%x status 0x%x\n",
782 SAS_ADDR(dev->sas_addr),
783 task->task_status.resp,
784 task->task_status.stat);
790 BUG_ON(retry == 3 && task != NULL);
796 pm8001_exec_internal_task_abort(struct pm8001_hba_info *pm8001_ha,
797 struct pm8001_device *pm8001_dev, struct domain_device *dev, u32 flag,
802 struct pm8001_ccb_info *ccb;
803 struct sas_task *task = NULL;
805 for (retry = 0; retry < 3; retry++) {
806 task = sas_alloc_slow_task(GFP_KERNEL);
811 task->task_proto = dev->tproto;
812 task->task_done = pm8001_task_done;
813 task->slow_task->timer.function = pm8001_tmf_timedout;
814 task->slow_task->timer.expires = jiffies + PM8001_TASK_TIMEOUT * HZ;
815 add_timer(&task->slow_task->timer);
817 res = pm8001_tag_alloc(pm8001_ha, &ccb_tag);
820 ccb = &pm8001_ha->ccb_info[ccb_tag];
821 ccb->device = pm8001_dev;
822 ccb->ccb_tag = ccb_tag;
826 res = PM8001_CHIP_DISP->task_abort(pm8001_ha,
827 pm8001_dev, flag, task_tag, ccb_tag);
830 del_timer(&task->slow_task->timer);
831 pm8001_dbg(pm8001_ha, FAIL, "Executing internal task failed\n");
834 wait_for_completion(&task->slow_task->completion);
835 res = TMF_RESP_FUNC_FAILED;
836 /* Even TMF timed out, return direct. */
837 if ((task->task_state_flags & SAS_TASK_STATE_ABORTED)) {
838 if (!(task->task_state_flags & SAS_TASK_STATE_DONE)) {
839 pm8001_dbg(pm8001_ha, FAIL,
840 "TMF task timeout.\n");
845 if (task->task_status.resp == SAS_TASK_COMPLETE &&
846 task->task_status.stat == SAM_STAT_GOOD) {
847 res = TMF_RESP_FUNC_COMPLETE;
851 pm8001_dbg(pm8001_ha, EH,
852 " Task to dev %016llx response: 0x%x status 0x%x\n",
853 SAS_ADDR(dev->sas_addr),
854 task->task_status.resp,
855 task->task_status.stat);
861 BUG_ON(retry == 3 && task != NULL);
867 * pm8001_dev_gone_notify - see the comments for "pm8001_dev_found_notify"
868 * @dev: the device structure which sas layer used.
870 static void pm8001_dev_gone_notify(struct domain_device *dev)
872 unsigned long flags = 0;
873 struct pm8001_hba_info *pm8001_ha;
874 struct pm8001_device *pm8001_dev = dev->lldd_dev;
876 pm8001_ha = pm8001_find_ha_by_dev(dev);
877 spin_lock_irqsave(&pm8001_ha->lock, flags);
879 u32 device_id = pm8001_dev->device_id;
881 pm8001_dbg(pm8001_ha, DISC, "found dev[%d:%x] is gone.\n",
882 pm8001_dev->device_id, pm8001_dev->dev_type);
883 if (atomic_read(&pm8001_dev->running_req)) {
884 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
885 pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
887 while (atomic_read(&pm8001_dev->running_req))
889 spin_lock_irqsave(&pm8001_ha->lock, flags);
891 PM8001_CHIP_DISP->dereg_dev_req(pm8001_ha, device_id);
892 pm8001_free_dev(pm8001_dev);
894 pm8001_dbg(pm8001_ha, DISC, "Found dev has gone.\n");
896 dev->lldd_dev = NULL;
897 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
900 void pm8001_dev_gone(struct domain_device *dev)
902 pm8001_dev_gone_notify(dev);
905 static int pm8001_issue_ssp_tmf(struct domain_device *dev,
906 u8 *lun, struct pm8001_tmf_task *tmf)
908 struct sas_ssp_task ssp_task;
909 if (!(dev->tproto & SAS_PROTOCOL_SSP))
910 return TMF_RESP_FUNC_ESUPP;
912 memcpy((u8 *)&ssp_task.LUN, lun, 8);
913 return pm8001_exec_internal_tmf_task(dev, &ssp_task, sizeof(ssp_task),
917 /* retry commands by ha, by task and/or by device */
918 void pm8001_open_reject_retry(
919 struct pm8001_hba_info *pm8001_ha,
920 struct sas_task *task_to_close,
921 struct pm8001_device *device_to_close)
926 if (pm8001_ha == NULL)
929 spin_lock_irqsave(&pm8001_ha->lock, flags);
931 for (i = 0; i < PM8001_MAX_CCB; i++) {
932 struct sas_task *task;
933 struct task_status_struct *ts;
934 struct pm8001_device *pm8001_dev;
935 unsigned long flags1;
937 struct pm8001_ccb_info *ccb = &pm8001_ha->ccb_info[i];
939 pm8001_dev = ccb->device;
940 if (!pm8001_dev || (pm8001_dev->dev_type == SAS_PHY_UNUSED))
942 if (!device_to_close) {
943 uintptr_t d = (uintptr_t)pm8001_dev
944 - (uintptr_t)&pm8001_ha->devices;
945 if (((d % sizeof(*pm8001_dev)) != 0)
946 || ((d / sizeof(*pm8001_dev)) >= PM8001_MAX_DEVICES))
948 } else if (pm8001_dev != device_to_close)
951 if (!tag || (tag == 0xFFFFFFFF))
954 if (!task || !task->task_done)
956 if (task_to_close && (task != task_to_close))
958 ts = &task->task_status;
959 ts->resp = SAS_TASK_COMPLETE;
960 /* Force the midlayer to retry */
961 ts->stat = SAS_OPEN_REJECT;
962 ts->open_rej_reason = SAS_OREJ_RSVD_RETRY;
964 atomic_dec(&pm8001_dev->running_req);
965 spin_lock_irqsave(&task->task_state_lock, flags1);
966 task->task_state_flags &= ~SAS_TASK_STATE_PENDING;
967 task->task_state_flags &= ~SAS_TASK_AT_INITIATOR;
968 task->task_state_flags |= SAS_TASK_STATE_DONE;
969 if (unlikely((task->task_state_flags
970 & SAS_TASK_STATE_ABORTED))) {
971 spin_unlock_irqrestore(&task->task_state_lock,
973 pm8001_ccb_task_free(pm8001_ha, task, ccb, tag);
975 spin_unlock_irqrestore(&task->task_state_lock,
977 pm8001_ccb_task_free(pm8001_ha, task, ccb, tag);
978 mb();/* in order to force CPU ordering */
979 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
980 task->task_done(task);
981 spin_lock_irqsave(&pm8001_ha->lock, flags);
985 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
989 * pm8001_I_T_nexus_reset()
990 * Standard mandates link reset for ATA (type 0) and hard reset for
991 * SSP (type 1) , only for RECOVERY
992 * @dev: the device structure for the device to reset.
994 int pm8001_I_T_nexus_reset(struct domain_device *dev)
996 int rc = TMF_RESP_FUNC_FAILED;
997 struct pm8001_device *pm8001_dev;
998 struct pm8001_hba_info *pm8001_ha;
1001 if (!dev || !dev->lldd_dev)
1004 pm8001_dev = dev->lldd_dev;
1005 pm8001_ha = pm8001_find_ha_by_dev(dev);
1006 phy = sas_get_local_phy(dev);
1008 if (dev_is_sata(dev)) {
1009 if (scsi_is_sas_phy_local(phy)) {
1013 rc = sas_phy_reset(phy, 1);
1015 pm8001_dbg(pm8001_ha, EH,
1016 "phy reset failed for device %x\n"
1017 "with rc %d\n", pm8001_dev->device_id, rc);
1018 rc = TMF_RESP_FUNC_FAILED;
1022 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1025 pm8001_dbg(pm8001_ha, EH, "task abort failed %x\n"
1026 "with rc %d\n", pm8001_dev->device_id, rc);
1027 rc = TMF_RESP_FUNC_FAILED;
1030 rc = sas_phy_reset(phy, 1);
1033 pm8001_dbg(pm8001_ha, EH, " for device[%x]:rc=%d\n",
1034 pm8001_dev->device_id, rc);
1036 sas_put_local_phy(phy);
1041 * This function handle the IT_NEXUS_XXX event or completion
1042 * status code for SSP/SATA/SMP I/O request.
1044 int pm8001_I_T_nexus_event_handler(struct domain_device *dev)
1046 int rc = TMF_RESP_FUNC_FAILED;
1047 struct pm8001_device *pm8001_dev;
1048 struct pm8001_hba_info *pm8001_ha;
1049 struct sas_phy *phy;
1051 if (!dev || !dev->lldd_dev)
1054 pm8001_dev = dev->lldd_dev;
1055 pm8001_ha = pm8001_find_ha_by_dev(dev);
1057 pm8001_dbg(pm8001_ha, EH, "I_T_Nexus handler invoked !!\n");
1059 phy = sas_get_local_phy(dev);
1061 if (dev_is_sata(dev)) {
1062 DECLARE_COMPLETION_ONSTACK(completion_setstate);
1063 if (scsi_is_sas_phy_local(phy)) {
1067 /* send internal ssp/sata/smp abort command to FW */
1068 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1072 /* deregister the target device */
1073 pm8001_dev_gone_notify(dev);
1076 /*send phy reset to hard reset target */
1077 rc = sas_phy_reset(phy, 1);
1079 pm8001_dev->setds_completion = &completion_setstate;
1081 wait_for_completion(&completion_setstate);
1083 /* send internal ssp/sata/smp abort command to FW */
1084 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1088 /* deregister the target device */
1089 pm8001_dev_gone_notify(dev);
1092 /*send phy reset to hard reset target */
1093 rc = sas_phy_reset(phy, 1);
1096 pm8001_dbg(pm8001_ha, EH, " for device[%x]:rc=%d\n",
1097 pm8001_dev->device_id, rc);
1099 sas_put_local_phy(phy);
1103 /* mandatory SAM-3, the task reset the specified LUN*/
1104 int pm8001_lu_reset(struct domain_device *dev, u8 *lun)
1106 int rc = TMF_RESP_FUNC_FAILED;
1107 struct pm8001_tmf_task tmf_task;
1108 struct pm8001_device *pm8001_dev = dev->lldd_dev;
1109 struct pm8001_hba_info *pm8001_ha = pm8001_find_ha_by_dev(dev);
1110 DECLARE_COMPLETION_ONSTACK(completion_setstate);
1111 if (dev_is_sata(dev)) {
1112 struct sas_phy *phy = sas_get_local_phy(dev);
1113 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1115 rc = sas_phy_reset(phy, 1);
1116 sas_put_local_phy(phy);
1117 pm8001_dev->setds_completion = &completion_setstate;
1118 rc = PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
1119 pm8001_dev, DS_OPERATIONAL);
1120 wait_for_completion(&completion_setstate);
1122 tmf_task.tmf = TMF_LU_RESET;
1123 rc = pm8001_issue_ssp_tmf(dev, lun, &tmf_task);
1125 /* If failed, fall-through I_T_Nexus reset */
1126 pm8001_dbg(pm8001_ha, EH, "for device[%x]:rc=%d\n",
1127 pm8001_dev->device_id, rc);
1131 /* optional SAM-3 */
1132 int pm8001_query_task(struct sas_task *task)
1134 u32 tag = 0xdeadbeef;
1135 struct scsi_lun lun;
1136 struct pm8001_tmf_task tmf_task;
1137 int rc = TMF_RESP_FUNC_FAILED;
1138 if (unlikely(!task || !task->lldd_task || !task->dev))
1141 if (task->task_proto & SAS_PROTOCOL_SSP) {
1142 struct scsi_cmnd *cmnd = task->uldd_task;
1143 struct domain_device *dev = task->dev;
1144 struct pm8001_hba_info *pm8001_ha =
1145 pm8001_find_ha_by_dev(dev);
1147 int_to_scsilun(cmnd->device->lun, &lun);
1148 rc = pm8001_find_tag(task, &tag);
1150 rc = TMF_RESP_FUNC_FAILED;
1153 pm8001_dbg(pm8001_ha, EH, "Query:[%16ph]\n", cmnd->cmnd);
1154 tmf_task.tmf = TMF_QUERY_TASK;
1155 tmf_task.tag_of_task_to_be_managed = tag;
1157 rc = pm8001_issue_ssp_tmf(dev, lun.scsi_lun, &tmf_task);
1159 /* The task is still in Lun, release it then */
1160 case TMF_RESP_FUNC_SUCC:
1161 pm8001_dbg(pm8001_ha, EH,
1162 "The task is still in Lun\n");
1164 /* The task is not in Lun or failed, reset the phy */
1165 case TMF_RESP_FUNC_FAILED:
1166 case TMF_RESP_FUNC_COMPLETE:
1167 pm8001_dbg(pm8001_ha, EH,
1168 "The task is not in Lun or failed, reset the phy\n");
1172 pr_err("pm80xx: rc= %d\n", rc);
1176 /* mandatory SAM-3, still need free task/ccb info, abort the specified task */
1177 int pm8001_abort_task(struct sas_task *task)
1179 unsigned long flags;
1181 struct domain_device *dev ;
1182 struct pm8001_hba_info *pm8001_ha;
1183 struct scsi_lun lun;
1184 struct pm8001_device *pm8001_dev;
1185 struct pm8001_tmf_task tmf_task;
1186 int rc = TMF_RESP_FUNC_FAILED, ret;
1188 struct sas_task_slow slow_task;
1190 if (unlikely(!task || !task->lldd_task || !task->dev))
1191 return TMF_RESP_FUNC_FAILED;
1194 pm8001_dev = dev->lldd_dev;
1195 pm8001_ha = pm8001_find_ha_by_dev(dev);
1196 phy_id = pm8001_dev->attached_phy;
1198 if (PM8001_CHIP_DISP->fatal_errors(pm8001_ha)) {
1199 // If the controller is seeing fatal errors
1200 // abort task will not get a response from the controller
1201 return TMF_RESP_FUNC_FAILED;
1204 ret = pm8001_find_tag(task, &tag);
1206 pm8001_info(pm8001_ha, "no tag for task:%p\n", task);
1207 return TMF_RESP_FUNC_FAILED;
1209 spin_lock_irqsave(&task->task_state_lock, flags);
1210 if (task->task_state_flags & SAS_TASK_STATE_DONE) {
1211 spin_unlock_irqrestore(&task->task_state_lock, flags);
1212 return TMF_RESP_FUNC_COMPLETE;
1214 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
1215 if (task->slow_task == NULL) {
1216 init_completion(&slow_task.completion);
1217 task->slow_task = &slow_task;
1219 spin_unlock_irqrestore(&task->task_state_lock, flags);
1220 if (task->task_proto & SAS_PROTOCOL_SSP) {
1221 struct scsi_cmnd *cmnd = task->uldd_task;
1222 int_to_scsilun(cmnd->device->lun, &lun);
1223 tmf_task.tmf = TMF_ABORT_TASK;
1224 tmf_task.tag_of_task_to_be_managed = tag;
1225 rc = pm8001_issue_ssp_tmf(dev, lun.scsi_lun, &tmf_task);
1226 pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1227 pm8001_dev->sas_device, 0, tag);
1228 } else if (task->task_proto & SAS_PROTOCOL_SATA ||
1229 task->task_proto & SAS_PROTOCOL_STP) {
1230 if (pm8001_ha->chip_id == chip_8006) {
1231 DECLARE_COMPLETION_ONSTACK(completion_reset);
1232 DECLARE_COMPLETION_ONSTACK(completion);
1233 struct pm8001_phy *phy = pm8001_ha->phy + phy_id;
1235 /* 1. Set Device state as Recovery */
1236 pm8001_dev->setds_completion = &completion;
1237 PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
1238 pm8001_dev, DS_IN_RECOVERY);
1239 wait_for_completion(&completion);
1241 /* 2. Send Phy Control Hard Reset */
1242 reinit_completion(&completion);
1243 phy->port_reset_status = PORT_RESET_TMO;
1244 phy->reset_success = false;
1245 phy->enable_completion = &completion;
1246 phy->reset_completion = &completion_reset;
1247 ret = PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
1250 phy->enable_completion = NULL;
1251 phy->reset_completion = NULL;
1255 /* In the case of the reset timeout/fail we still
1256 * abort the command at the firmware. The assumption
1257 * here is that the drive is off doing something so
1258 * that it's not processing requests, and we want to
1259 * avoid getting a completion for this and either
1260 * leaking the task in libsas or losing the race and
1261 * getting a double free.
1263 pm8001_dbg(pm8001_ha, MSG,
1264 "Waiting for local phy ctl\n");
1265 ret = wait_for_completion_timeout(&completion,
1266 PM8001_TASK_TIMEOUT * HZ);
1267 if (!ret || !phy->reset_success) {
1268 phy->enable_completion = NULL;
1269 phy->reset_completion = NULL;
1271 /* 3. Wait for Port Reset complete or
1274 pm8001_dbg(pm8001_ha, MSG,
1275 "Waiting for Port reset\n");
1276 ret = wait_for_completion_timeout(
1278 PM8001_TASK_TIMEOUT * HZ);
1280 phy->reset_completion = NULL;
1281 WARN_ON(phy->port_reset_status ==
1283 if (phy->port_reset_status == PORT_RESET_TMO) {
1284 pm8001_dev_gone_notify(dev);
1291 * we wait for the task to be aborted so that the task
1292 * is removed from the ccb. on success the caller is
1293 * going to free the task.
1295 ret = pm8001_exec_internal_task_abort(pm8001_ha,
1296 pm8001_dev, pm8001_dev->sas_device, 1, tag);
1299 ret = wait_for_completion_timeout(
1300 &task->slow_task->completion,
1301 PM8001_TASK_TIMEOUT * HZ);
1305 /* 5. Set Device State as Operational */
1306 reinit_completion(&completion);
1307 pm8001_dev->setds_completion = &completion;
1308 PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
1309 pm8001_dev, DS_OPERATIONAL);
1310 wait_for_completion(&completion);
1312 rc = pm8001_exec_internal_task_abort(pm8001_ha,
1313 pm8001_dev, pm8001_dev->sas_device, 0, tag);
1315 rc = TMF_RESP_FUNC_COMPLETE;
1316 } else if (task->task_proto & SAS_PROTOCOL_SMP) {
1318 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1319 pm8001_dev->sas_device, 0, tag);
1323 spin_lock_irqsave(&task->task_state_lock, flags);
1324 if (task->slow_task == &slow_task)
1325 task->slow_task = NULL;
1326 spin_unlock_irqrestore(&task->task_state_lock, flags);
1327 if (rc != TMF_RESP_FUNC_COMPLETE)
1328 pm8001_info(pm8001_ha, "rc= %d\n", rc);
1332 int pm8001_abort_task_set(struct domain_device *dev, u8 *lun)
1334 struct pm8001_tmf_task tmf_task;
1336 tmf_task.tmf = TMF_ABORT_TASK_SET;
1337 return pm8001_issue_ssp_tmf(dev, lun, &tmf_task);
1340 int pm8001_clear_aca(struct domain_device *dev, u8 *lun)
1342 struct pm8001_tmf_task tmf_task;
1344 tmf_task.tmf = TMF_CLEAR_ACA;
1345 return pm8001_issue_ssp_tmf(dev, lun, &tmf_task);
1348 int pm8001_clear_task_set(struct domain_device *dev, u8 *lun)
1350 struct pm8001_tmf_task tmf_task;
1351 struct pm8001_device *pm8001_dev = dev->lldd_dev;
1352 struct pm8001_hba_info *pm8001_ha = pm8001_find_ha_by_dev(dev);
1354 pm8001_dbg(pm8001_ha, EH, "I_T_L_Q clear task set[%x]\n",
1355 pm8001_dev->device_id);
1356 tmf_task.tmf = TMF_CLEAR_TASK_SET;
1357 return pm8001_issue_ssp_tmf(dev, lun, &tmf_task);