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);
123 *pphys_addr = mem_dma_handle;
124 phys_align = (*pphys_addr + align_offset) & ~align_offset;
125 *virt_addr = (void *)mem_virt_alloc + phys_align - *pphys_addr;
126 *pphys_addr_hi = upper_32_bits(phys_align);
127 *pphys_addr_lo = lower_32_bits(phys_align);
132 * pm8001_find_ha_by_dev - from domain device which come from sas layer to
133 * find out our hba struct.
134 * @dev: the domain device which from sas layer.
137 struct pm8001_hba_info *pm8001_find_ha_by_dev(struct domain_device *dev)
139 struct sas_ha_struct *sha = dev->port->ha;
140 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
145 * pm8001_phy_control - this function should be registered to
146 * sas_domain_function_template to provide libsas used, note: this is just
147 * control the HBA phy rather than other expander phy if you want control
148 * other phy, you should use SMP command.
149 * @sas_phy: which phy in HBA phys.
150 * @func: the operation.
151 * @funcdata: always NULL.
153 int pm8001_phy_control(struct asd_sas_phy *sas_phy, enum phy_func func,
156 int rc = 0, phy_id = sas_phy->id;
157 struct pm8001_hba_info *pm8001_ha = NULL;
158 struct sas_phy_linkrates *rates;
159 struct pm8001_phy *phy;
160 DECLARE_COMPLETION_ONSTACK(completion);
162 pm8001_ha = sas_phy->ha->lldd_ha;
163 phy = &pm8001_ha->phy[phy_id];
164 pm8001_ha->phy[phy_id].enable_completion = &completion;
166 case PHY_FUNC_SET_LINK_RATE:
168 if (rates->minimum_linkrate) {
169 pm8001_ha->phy[phy_id].minimum_linkrate =
170 rates->minimum_linkrate;
172 if (rates->maximum_linkrate) {
173 pm8001_ha->phy[phy_id].maximum_linkrate =
174 rates->maximum_linkrate;
176 if (pm8001_ha->phy[phy_id].phy_state == PHY_LINK_DISABLE) {
177 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, phy_id);
178 wait_for_completion(&completion);
180 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
183 case PHY_FUNC_HARD_RESET:
184 if (pm8001_ha->phy[phy_id].phy_state == PHY_LINK_DISABLE) {
185 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, phy_id);
186 wait_for_completion(&completion);
188 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
191 case PHY_FUNC_LINK_RESET:
192 if (pm8001_ha->phy[phy_id].phy_state == PHY_LINK_DISABLE) {
193 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, phy_id);
194 wait_for_completion(&completion);
196 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
199 case PHY_FUNC_RELEASE_SPINUP_HOLD:
200 PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
203 case PHY_FUNC_DISABLE:
204 if (pm8001_ha->chip_id != chip_8001) {
205 if (pm8001_ha->phy[phy_id].phy_state ==
206 PHY_STATE_LINK_UP_SPCV) {
207 sas_phy_disconnected(&phy->sas_phy);
208 sas_notify_phy_event(&phy->sas_phy,
209 PHYE_LOSS_OF_SIGNAL, GFP_KERNEL);
210 phy->phy_attached = 0;
213 if (pm8001_ha->phy[phy_id].phy_state ==
214 PHY_STATE_LINK_UP_SPC) {
215 sas_phy_disconnected(&phy->sas_phy);
216 sas_notify_phy_event(&phy->sas_phy,
217 PHYE_LOSS_OF_SIGNAL, GFP_KERNEL);
218 phy->phy_attached = 0;
221 PM8001_CHIP_DISP->phy_stop_req(pm8001_ha, phy_id);
223 case PHY_FUNC_GET_EVENTS:
224 spin_lock_irqsave(&pm8001_ha->lock, flags);
225 if (pm8001_ha->chip_id == chip_8001) {
226 if (-1 == pm8001_bar4_shift(pm8001_ha,
227 (phy_id < 4) ? 0x30000 : 0x40000)) {
228 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
233 struct sas_phy *phy = sas_phy->phy;
234 uint32_t *qp = (uint32_t *)(((char *)
235 pm8001_ha->io_mem[2].memvirtaddr)
236 + 0x1034 + (0x4000 * (phy_id & 3)));
238 phy->invalid_dword_count = qp[0];
239 phy->running_disparity_error_count = qp[1];
240 phy->loss_of_dword_sync_count = qp[3];
241 phy->phy_reset_problem_count = qp[4];
243 if (pm8001_ha->chip_id == chip_8001)
244 pm8001_bar4_shift(pm8001_ha, 0);
245 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
248 pm8001_dbg(pm8001_ha, DEVIO, "func 0x%x\n", func);
256 * pm8001_scan_start - we should enable all HBA phys by sending the phy_start
258 * @shost: the scsi host data.
260 void pm8001_scan_start(struct Scsi_Host *shost)
263 struct pm8001_hba_info *pm8001_ha;
264 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
265 DECLARE_COMPLETION_ONSTACK(completion);
266 pm8001_ha = sha->lldd_ha;
267 /* SAS_RE_INITIALIZATION not available in SPCv/ve */
268 if (pm8001_ha->chip_id == chip_8001)
269 PM8001_CHIP_DISP->sas_re_init_req(pm8001_ha);
270 for (i = 0; i < pm8001_ha->chip->n_phy; ++i) {
271 pm8001_ha->phy[i].enable_completion = &completion;
272 PM8001_CHIP_DISP->phy_start_req(pm8001_ha, i);
273 wait_for_completion(&completion);
278 int pm8001_scan_finished(struct Scsi_Host *shost, unsigned long time)
280 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
282 /* give the phy enabling interrupt event time to come in (1s
283 * is empirically about all it takes) */
286 /* Wait for discovery to finish */
292 * pm8001_task_prep_smp - the dispatcher function, prepare data for smp task
293 * @pm8001_ha: our hba card information
294 * @ccb: the ccb which attached to smp task
296 static int pm8001_task_prep_smp(struct pm8001_hba_info *pm8001_ha,
297 struct pm8001_ccb_info *ccb)
299 return PM8001_CHIP_DISP->smp_req(pm8001_ha, ccb);
302 u32 pm8001_get_ncq_tag(struct sas_task *task, u32 *tag)
304 struct ata_queued_cmd *qc = task->uldd_task;
306 if (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
307 qc->tf.command == ATA_CMD_FPDMA_READ ||
308 qc->tf.command == ATA_CMD_FPDMA_RECV ||
309 qc->tf.command == ATA_CMD_FPDMA_SEND ||
310 qc->tf.command == ATA_CMD_NCQ_NON_DATA) {
319 * pm8001_task_prep_ata - the dispatcher function, prepare data for sata task
320 * @pm8001_ha: our hba card information
321 * @ccb: the ccb which attached to sata task
323 static int pm8001_task_prep_ata(struct pm8001_hba_info *pm8001_ha,
324 struct pm8001_ccb_info *ccb)
326 return PM8001_CHIP_DISP->sata_req(pm8001_ha, ccb);
330 * pm8001_task_prep_ssp_tm - the dispatcher function, prepare task management data
331 * @pm8001_ha: our hba card information
332 * @ccb: the ccb which attached to TM
333 * @tmf: the task management IU
335 static int pm8001_task_prep_ssp_tm(struct pm8001_hba_info *pm8001_ha,
336 struct pm8001_ccb_info *ccb, struct pm8001_tmf_task *tmf)
338 return PM8001_CHIP_DISP->ssp_tm_req(pm8001_ha, ccb, tmf);
342 * pm8001_task_prep_ssp - the dispatcher function,prepare ssp data for ssp task
343 * @pm8001_ha: our hba card information
344 * @ccb: the ccb which attached to ssp task
346 static int pm8001_task_prep_ssp(struct pm8001_hba_info *pm8001_ha,
347 struct pm8001_ccb_info *ccb)
349 return PM8001_CHIP_DISP->ssp_io_req(pm8001_ha, ccb);
352 /* Find the local port id that's attached to this device */
353 static int sas_find_local_port_id(struct domain_device *dev)
355 struct domain_device *pdev = dev->parent;
357 /* Directly attached device */
359 return dev->port->id;
361 struct domain_device *pdev_p = pdev->parent;
363 return pdev->port->id;
369 #define DEV_IS_GONE(pm8001_dev) \
370 ((!pm8001_dev || (pm8001_dev->dev_type == SAS_PHY_UNUSED)))
372 * pm8001_task_exec - queue the task(ssp, smp && ata) to the hardware.
373 * @task: the task to be execute.
374 * @gfp_flags: gfp_flags.
375 * @is_tmf: if it is task management task.
376 * @tmf: the task management IU
378 static int pm8001_task_exec(struct sas_task *task,
379 gfp_t gfp_flags, int is_tmf, struct pm8001_tmf_task *tmf)
381 struct domain_device *dev = task->dev;
382 struct pm8001_hba_info *pm8001_ha;
383 struct pm8001_device *pm8001_dev;
384 struct pm8001_port *port = NULL;
385 struct sas_task *t = task;
386 struct pm8001_ccb_info *ccb;
387 u32 tag = 0xdeadbeef, rc = 0, n_elem = 0;
388 unsigned long flags = 0;
389 enum sas_protocol task_proto = t->task_proto;
392 struct task_status_struct *tsm = &t->task_status;
393 tsm->resp = SAS_TASK_UNDELIVERED;
394 tsm->stat = SAS_PHY_DOWN;
395 if (dev->dev_type != SAS_SATA_DEV)
399 pm8001_ha = pm8001_find_ha_by_dev(task->dev);
400 if (pm8001_ha->controller_fatal_error) {
401 struct task_status_struct *ts = &t->task_status;
403 ts->resp = SAS_TASK_UNDELIVERED;
407 pm8001_dbg(pm8001_ha, IO, "pm8001_task_exec device\n");
408 spin_lock_irqsave(&pm8001_ha->lock, flags);
411 pm8001_dev = dev->lldd_dev;
412 port = &pm8001_ha->port[sas_find_local_port_id(dev)];
413 if (DEV_IS_GONE(pm8001_dev) || !port->port_attached) {
414 if (sas_protocol_ata(task_proto)) {
415 struct task_status_struct *ts = &t->task_status;
416 ts->resp = SAS_TASK_UNDELIVERED;
417 ts->stat = SAS_PHY_DOWN;
419 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
421 spin_lock_irqsave(&pm8001_ha->lock, flags);
424 struct task_status_struct *ts = &t->task_status;
425 ts->resp = SAS_TASK_UNDELIVERED;
426 ts->stat = SAS_PHY_DOWN;
431 rc = pm8001_tag_alloc(pm8001_ha, &tag);
434 ccb = &pm8001_ha->ccb_info[tag];
436 if (!sas_protocol_ata(task_proto)) {
437 if (t->num_scatter) {
438 n_elem = dma_map_sg(pm8001_ha->dev,
448 n_elem = t->num_scatter;
452 ccb->n_elem = n_elem;
455 ccb->device = pm8001_dev;
456 switch (task_proto) {
457 case SAS_PROTOCOL_SMP:
458 atomic_inc(&pm8001_dev->running_req);
459 rc = pm8001_task_prep_smp(pm8001_ha, ccb);
461 case SAS_PROTOCOL_SSP:
462 atomic_inc(&pm8001_dev->running_req);
464 rc = pm8001_task_prep_ssp_tm(pm8001_ha,
467 rc = pm8001_task_prep_ssp(pm8001_ha, ccb);
469 case SAS_PROTOCOL_SATA:
470 case SAS_PROTOCOL_STP:
471 atomic_inc(&pm8001_dev->running_req);
472 rc = pm8001_task_prep_ata(pm8001_ha, ccb);
475 dev_printk(KERN_ERR, pm8001_ha->dev,
476 "unknown sas_task proto: 0x%x\n", task_proto);
482 pm8001_dbg(pm8001_ha, IO, "rc is %x\n", rc);
483 atomic_dec(&pm8001_dev->running_req);
486 /* TODO: select normal or high priority */
487 spin_lock(&t->task_state_lock);
488 t->task_state_flags |= SAS_TASK_AT_INITIATOR;
489 spin_unlock(&t->task_state_lock);
495 pm8001_tag_free(pm8001_ha, tag);
497 dev_printk(KERN_ERR, pm8001_ha->dev, "pm8001 exec failed[%d]!\n", rc);
498 if (!sas_protocol_ata(task_proto))
500 dma_unmap_sg(pm8001_ha->dev, t->scatter, t->num_scatter,
503 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
508 * pm8001_queue_command - register for upper layer used, all IO commands sent
509 * to HBA are from this interface.
510 * @task: the task to be execute.
511 * @gfp_flags: gfp_flags
513 int pm8001_queue_command(struct sas_task *task, gfp_t gfp_flags)
515 return pm8001_task_exec(task, gfp_flags, 0, NULL);
519 * pm8001_ccb_task_free - free the sg for ssp and smp command, free the ccb.
520 * @pm8001_ha: our hba card information
521 * @ccb: the ccb which attached to ssp task
522 * @task: the task to be free.
523 * @ccb_idx: ccb index.
525 void pm8001_ccb_task_free(struct pm8001_hba_info *pm8001_ha,
526 struct sas_task *task, struct pm8001_ccb_info *ccb, u32 ccb_idx)
530 if (!sas_protocol_ata(task->task_proto))
532 dma_unmap_sg(pm8001_ha->dev, task->scatter,
533 task->num_scatter, task->data_dir);
535 switch (task->task_proto) {
536 case SAS_PROTOCOL_SMP:
537 dma_unmap_sg(pm8001_ha->dev, &task->smp_task.smp_resp, 1,
539 dma_unmap_sg(pm8001_ha->dev, &task->smp_task.smp_req, 1,
543 case SAS_PROTOCOL_SATA:
544 case SAS_PROTOCOL_STP:
545 case SAS_PROTOCOL_SSP:
550 task->lldd_task = NULL;
552 ccb->ccb_tag = 0xFFFFFFFF;
554 pm8001_tag_free(pm8001_ha, ccb_idx);
558 * pm8001_alloc_dev - find a empty pm8001_device
559 * @pm8001_ha: our hba card information
561 static struct pm8001_device *pm8001_alloc_dev(struct pm8001_hba_info *pm8001_ha)
564 for (dev = 0; dev < PM8001_MAX_DEVICES; dev++) {
565 if (pm8001_ha->devices[dev].dev_type == SAS_PHY_UNUSED) {
566 pm8001_ha->devices[dev].id = dev;
567 return &pm8001_ha->devices[dev];
570 if (dev == PM8001_MAX_DEVICES) {
571 pm8001_dbg(pm8001_ha, FAIL,
572 "max support %d devices, ignore ..\n",
578 * pm8001_find_dev - find a matching pm8001_device
579 * @pm8001_ha: our hba card information
580 * @device_id: device ID to match against
582 struct pm8001_device *pm8001_find_dev(struct pm8001_hba_info *pm8001_ha,
586 for (dev = 0; dev < PM8001_MAX_DEVICES; dev++) {
587 if (pm8001_ha->devices[dev].device_id == device_id)
588 return &pm8001_ha->devices[dev];
590 if (dev == PM8001_MAX_DEVICES) {
591 pm8001_dbg(pm8001_ha, FAIL, "NO MATCHING DEVICE FOUND !!!\n");
596 void pm8001_free_dev(struct pm8001_device *pm8001_dev)
598 u32 id = pm8001_dev->id;
599 memset(pm8001_dev, 0, sizeof(*pm8001_dev));
601 pm8001_dev->dev_type = SAS_PHY_UNUSED;
602 pm8001_dev->device_id = PM8001_MAX_DEVICES;
603 pm8001_dev->sas_device = NULL;
607 * pm8001_dev_found_notify - libsas notify a device is found.
608 * @dev: the device structure which sas layer used.
610 * when libsas find a sas domain device, it should tell the LLDD that
611 * device is found, and then LLDD register this device to HBA firmware
612 * by the command "OPC_INB_REG_DEV", after that the HBA will assign a
613 * device ID(according to device's sas address) and returned it to LLDD. From
614 * now on, we communicate with HBA FW with the device ID which HBA assigned
615 * rather than sas address. it is the necessary step for our HBA but it is
616 * the optional for other HBA driver.
618 static int pm8001_dev_found_notify(struct domain_device *dev)
620 unsigned long flags = 0;
622 struct pm8001_hba_info *pm8001_ha = NULL;
623 struct domain_device *parent_dev = dev->parent;
624 struct pm8001_device *pm8001_device;
625 DECLARE_COMPLETION_ONSTACK(completion);
627 pm8001_ha = pm8001_find_ha_by_dev(dev);
628 spin_lock_irqsave(&pm8001_ha->lock, flags);
630 pm8001_device = pm8001_alloc_dev(pm8001_ha);
631 if (!pm8001_device) {
635 pm8001_device->sas_device = dev;
636 dev->lldd_dev = pm8001_device;
637 pm8001_device->dev_type = dev->dev_type;
638 pm8001_device->dcompletion = &completion;
639 if (parent_dev && dev_is_expander(parent_dev->dev_type)) {
642 for (phy_id = 0; phy_id < parent_dev->ex_dev.num_phys;
644 phy = &parent_dev->ex_dev.ex_phy[phy_id];
645 if (SAS_ADDR(phy->attached_sas_addr)
646 == SAS_ADDR(dev->sas_addr)) {
647 pm8001_device->attached_phy = phy_id;
651 if (phy_id == parent_dev->ex_dev.num_phys) {
652 pm8001_dbg(pm8001_ha, FAIL,
653 "Error: no attached dev:%016llx at ex:%016llx.\n",
654 SAS_ADDR(dev->sas_addr),
655 SAS_ADDR(parent_dev->sas_addr));
659 if (dev->dev_type == SAS_SATA_DEV) {
660 pm8001_device->attached_phy =
661 dev->rphy->identify.phy_identifier;
662 flag = 1; /* directly sata */
664 } /*register this device to HBA*/
665 pm8001_dbg(pm8001_ha, DISC, "Found device\n");
666 PM8001_CHIP_DISP->reg_dev_req(pm8001_ha, pm8001_device, flag);
667 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
668 wait_for_completion(&completion);
669 if (dev->dev_type == SAS_END_DEVICE)
671 pm8001_ha->flags = PM8001F_RUN_TIME;
674 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
678 int pm8001_dev_found(struct domain_device *dev)
680 return pm8001_dev_found_notify(dev);
683 void pm8001_task_done(struct sas_task *task)
685 if (!del_timer(&task->slow_task->timer))
687 complete(&task->slow_task->completion);
690 static void pm8001_tmf_timedout(struct timer_list *t)
692 struct sas_task_slow *slow = from_timer(slow, t, timer);
693 struct sas_task *task = slow->task;
695 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
696 complete(&task->slow_task->completion);
699 #define PM8001_TASK_TIMEOUT 20
701 * pm8001_exec_internal_tmf_task - execute some task management commands.
702 * @dev: the wanted device.
703 * @tmf: which task management wanted to be take.
704 * @para_len: para_len.
705 * @parameter: ssp task parameter.
707 * when errors or exception happened, we may want to do something, for example
708 * abort the issued task which result in this execption, it is done by calling
709 * this function, note it is also with the task execute interface.
711 static int pm8001_exec_internal_tmf_task(struct domain_device *dev,
712 void *parameter, u32 para_len, struct pm8001_tmf_task *tmf)
715 struct sas_task *task = NULL;
716 struct pm8001_hba_info *pm8001_ha = pm8001_find_ha_by_dev(dev);
717 struct pm8001_device *pm8001_dev = dev->lldd_dev;
718 DECLARE_COMPLETION_ONSTACK(completion_setstate);
720 for (retry = 0; retry < 3; retry++) {
721 task = sas_alloc_slow_task(GFP_KERNEL);
726 task->task_proto = dev->tproto;
727 memcpy(&task->ssp_task, parameter, para_len);
728 task->task_done = pm8001_task_done;
729 task->slow_task->timer.function = pm8001_tmf_timedout;
730 task->slow_task->timer.expires = jiffies + PM8001_TASK_TIMEOUT*HZ;
731 add_timer(&task->slow_task->timer);
733 res = pm8001_task_exec(task, GFP_KERNEL, 1, tmf);
736 del_timer(&task->slow_task->timer);
737 pm8001_dbg(pm8001_ha, FAIL, "Executing internal task failed\n");
740 wait_for_completion(&task->slow_task->completion);
741 if (pm8001_ha->chip_id != chip_8001) {
742 pm8001_dev->setds_completion = &completion_setstate;
743 PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
744 pm8001_dev, DS_OPERATIONAL);
745 wait_for_completion(&completion_setstate);
747 res = -TMF_RESP_FUNC_FAILED;
748 /* Even TMF timed out, return direct. */
749 if ((task->task_state_flags & SAS_TASK_STATE_ABORTED)) {
750 if (!(task->task_state_flags & SAS_TASK_STATE_DONE)) {
751 pm8001_dbg(pm8001_ha, FAIL,
752 "TMF task[%x]timeout.\n",
758 if (task->task_status.resp == SAS_TASK_COMPLETE &&
759 task->task_status.stat == SAS_SAM_STAT_GOOD) {
760 res = TMF_RESP_FUNC_COMPLETE;
764 if (task->task_status.resp == SAS_TASK_COMPLETE &&
765 task->task_status.stat == SAS_DATA_UNDERRUN) {
766 /* no error, but return the number of bytes of
768 res = task->task_status.residual;
772 if (task->task_status.resp == SAS_TASK_COMPLETE &&
773 task->task_status.stat == SAS_DATA_OVERRUN) {
774 pm8001_dbg(pm8001_ha, FAIL, "Blocked task error.\n");
778 pm8001_dbg(pm8001_ha, EH,
779 " Task to dev %016llx response:0x%x status 0x%x\n",
780 SAS_ADDR(dev->sas_addr),
781 task->task_status.resp,
782 task->task_status.stat);
788 BUG_ON(retry == 3 && task != NULL);
794 pm8001_exec_internal_task_abort(struct pm8001_hba_info *pm8001_ha,
795 struct pm8001_device *pm8001_dev, struct domain_device *dev, u32 flag,
800 struct pm8001_ccb_info *ccb;
801 struct sas_task *task = NULL;
803 for (retry = 0; retry < 3; retry++) {
804 task = sas_alloc_slow_task(GFP_KERNEL);
809 task->task_proto = dev->tproto;
810 task->task_done = pm8001_task_done;
811 task->slow_task->timer.function = pm8001_tmf_timedout;
812 task->slow_task->timer.expires = jiffies + PM8001_TASK_TIMEOUT * HZ;
813 add_timer(&task->slow_task->timer);
815 res = pm8001_tag_alloc(pm8001_ha, &ccb_tag);
818 ccb = &pm8001_ha->ccb_info[ccb_tag];
819 ccb->device = pm8001_dev;
820 ccb->ccb_tag = ccb_tag;
824 res = PM8001_CHIP_DISP->task_abort(pm8001_ha,
825 pm8001_dev, flag, task_tag, ccb_tag);
828 del_timer(&task->slow_task->timer);
829 pm8001_dbg(pm8001_ha, FAIL, "Executing internal task failed\n");
832 wait_for_completion(&task->slow_task->completion);
833 res = TMF_RESP_FUNC_FAILED;
834 /* Even TMF timed out, return direct. */
835 if ((task->task_state_flags & SAS_TASK_STATE_ABORTED)) {
836 if (!(task->task_state_flags & SAS_TASK_STATE_DONE)) {
837 pm8001_dbg(pm8001_ha, FAIL,
838 "TMF task timeout.\n");
843 if (task->task_status.resp == SAS_TASK_COMPLETE &&
844 task->task_status.stat == SAS_SAM_STAT_GOOD) {
845 res = TMF_RESP_FUNC_COMPLETE;
849 pm8001_dbg(pm8001_ha, EH,
850 " Task to dev %016llx response: 0x%x status 0x%x\n",
851 SAS_ADDR(dev->sas_addr),
852 task->task_status.resp,
853 task->task_status.stat);
859 BUG_ON(retry == 3 && task != NULL);
865 * pm8001_dev_gone_notify - see the comments for "pm8001_dev_found_notify"
866 * @dev: the device structure which sas layer used.
868 static void pm8001_dev_gone_notify(struct domain_device *dev)
870 unsigned long flags = 0;
871 struct pm8001_hba_info *pm8001_ha;
872 struct pm8001_device *pm8001_dev = dev->lldd_dev;
874 pm8001_ha = pm8001_find_ha_by_dev(dev);
875 spin_lock_irqsave(&pm8001_ha->lock, flags);
877 u32 device_id = pm8001_dev->device_id;
879 pm8001_dbg(pm8001_ha, DISC, "found dev[%d:%x] is gone.\n",
880 pm8001_dev->device_id, pm8001_dev->dev_type);
881 if (atomic_read(&pm8001_dev->running_req)) {
882 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
883 pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
885 while (atomic_read(&pm8001_dev->running_req))
887 spin_lock_irqsave(&pm8001_ha->lock, flags);
889 PM8001_CHIP_DISP->dereg_dev_req(pm8001_ha, device_id);
890 pm8001_free_dev(pm8001_dev);
892 pm8001_dbg(pm8001_ha, DISC, "Found dev has gone.\n");
894 dev->lldd_dev = NULL;
895 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
898 void pm8001_dev_gone(struct domain_device *dev)
900 pm8001_dev_gone_notify(dev);
903 static int pm8001_issue_ssp_tmf(struct domain_device *dev,
904 u8 *lun, struct pm8001_tmf_task *tmf)
906 struct sas_ssp_task ssp_task;
907 if (!(dev->tproto & SAS_PROTOCOL_SSP))
908 return TMF_RESP_FUNC_ESUPP;
910 memcpy((u8 *)&ssp_task.LUN, lun, 8);
911 return pm8001_exec_internal_tmf_task(dev, &ssp_task, sizeof(ssp_task),
915 /* retry commands by ha, by task and/or by device */
916 void pm8001_open_reject_retry(
917 struct pm8001_hba_info *pm8001_ha,
918 struct sas_task *task_to_close,
919 struct pm8001_device *device_to_close)
924 if (pm8001_ha == NULL)
927 spin_lock_irqsave(&pm8001_ha->lock, flags);
929 for (i = 0; i < PM8001_MAX_CCB; i++) {
930 struct sas_task *task;
931 struct task_status_struct *ts;
932 struct pm8001_device *pm8001_dev;
933 unsigned long flags1;
935 struct pm8001_ccb_info *ccb = &pm8001_ha->ccb_info[i];
937 pm8001_dev = ccb->device;
938 if (!pm8001_dev || (pm8001_dev->dev_type == SAS_PHY_UNUSED))
940 if (!device_to_close) {
941 uintptr_t d = (uintptr_t)pm8001_dev
942 - (uintptr_t)&pm8001_ha->devices;
943 if (((d % sizeof(*pm8001_dev)) != 0)
944 || ((d / sizeof(*pm8001_dev)) >= PM8001_MAX_DEVICES))
946 } else if (pm8001_dev != device_to_close)
949 if (!tag || (tag == 0xFFFFFFFF))
952 if (!task || !task->task_done)
954 if (task_to_close && (task != task_to_close))
956 ts = &task->task_status;
957 ts->resp = SAS_TASK_COMPLETE;
958 /* Force the midlayer to retry */
959 ts->stat = SAS_OPEN_REJECT;
960 ts->open_rej_reason = SAS_OREJ_RSVD_RETRY;
962 atomic_dec(&pm8001_dev->running_req);
963 spin_lock_irqsave(&task->task_state_lock, flags1);
964 task->task_state_flags &= ~SAS_TASK_STATE_PENDING;
965 task->task_state_flags &= ~SAS_TASK_AT_INITIATOR;
966 task->task_state_flags |= SAS_TASK_STATE_DONE;
967 if (unlikely((task->task_state_flags
968 & SAS_TASK_STATE_ABORTED))) {
969 spin_unlock_irqrestore(&task->task_state_lock,
971 pm8001_ccb_task_free(pm8001_ha, task, ccb, tag);
973 spin_unlock_irqrestore(&task->task_state_lock,
975 pm8001_ccb_task_free(pm8001_ha, task, ccb, tag);
976 mb();/* in order to force CPU ordering */
977 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
978 task->task_done(task);
979 spin_lock_irqsave(&pm8001_ha->lock, flags);
983 spin_unlock_irqrestore(&pm8001_ha->lock, flags);
987 * pm8001_I_T_nexus_reset()
988 * Standard mandates link reset for ATA (type 0) and hard reset for
989 * SSP (type 1) , only for RECOVERY
990 * @dev: the device structure for the device to reset.
992 int pm8001_I_T_nexus_reset(struct domain_device *dev)
994 int rc = TMF_RESP_FUNC_FAILED;
995 struct pm8001_device *pm8001_dev;
996 struct pm8001_hba_info *pm8001_ha;
999 if (!dev || !dev->lldd_dev)
1002 pm8001_dev = dev->lldd_dev;
1003 pm8001_ha = pm8001_find_ha_by_dev(dev);
1004 phy = sas_get_local_phy(dev);
1006 if (dev_is_sata(dev)) {
1007 if (scsi_is_sas_phy_local(phy)) {
1011 rc = sas_phy_reset(phy, 1);
1013 pm8001_dbg(pm8001_ha, EH,
1014 "phy reset failed for device %x\n"
1015 "with rc %d\n", pm8001_dev->device_id, rc);
1016 rc = TMF_RESP_FUNC_FAILED;
1020 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1023 pm8001_dbg(pm8001_ha, EH, "task abort failed %x\n"
1024 "with rc %d\n", pm8001_dev->device_id, rc);
1025 rc = TMF_RESP_FUNC_FAILED;
1028 rc = sas_phy_reset(phy, 1);
1031 pm8001_dbg(pm8001_ha, EH, " for device[%x]:rc=%d\n",
1032 pm8001_dev->device_id, rc);
1034 sas_put_local_phy(phy);
1039 * This function handle the IT_NEXUS_XXX event or completion
1040 * status code for SSP/SATA/SMP I/O request.
1042 int pm8001_I_T_nexus_event_handler(struct domain_device *dev)
1044 int rc = TMF_RESP_FUNC_FAILED;
1045 struct pm8001_device *pm8001_dev;
1046 struct pm8001_hba_info *pm8001_ha;
1047 struct sas_phy *phy;
1049 if (!dev || !dev->lldd_dev)
1052 pm8001_dev = dev->lldd_dev;
1053 pm8001_ha = pm8001_find_ha_by_dev(dev);
1055 pm8001_dbg(pm8001_ha, EH, "I_T_Nexus handler invoked !!\n");
1057 phy = sas_get_local_phy(dev);
1059 if (dev_is_sata(dev)) {
1060 DECLARE_COMPLETION_ONSTACK(completion_setstate);
1061 if (scsi_is_sas_phy_local(phy)) {
1065 /* send internal ssp/sata/smp abort command to FW */
1066 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1070 /* deregister the target device */
1071 pm8001_dev_gone_notify(dev);
1074 /*send phy reset to hard reset target */
1075 rc = sas_phy_reset(phy, 1);
1077 pm8001_dev->setds_completion = &completion_setstate;
1079 wait_for_completion(&completion_setstate);
1081 /* send internal ssp/sata/smp abort command to FW */
1082 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1086 /* deregister the target device */
1087 pm8001_dev_gone_notify(dev);
1090 /*send phy reset to hard reset target */
1091 rc = sas_phy_reset(phy, 1);
1094 pm8001_dbg(pm8001_ha, EH, " for device[%x]:rc=%d\n",
1095 pm8001_dev->device_id, rc);
1097 sas_put_local_phy(phy);
1101 /* mandatory SAM-3, the task reset the specified LUN*/
1102 int pm8001_lu_reset(struct domain_device *dev, u8 *lun)
1104 int rc = TMF_RESP_FUNC_FAILED;
1105 struct pm8001_tmf_task tmf_task;
1106 struct pm8001_device *pm8001_dev = dev->lldd_dev;
1107 struct pm8001_hba_info *pm8001_ha = pm8001_find_ha_by_dev(dev);
1108 DECLARE_COMPLETION_ONSTACK(completion_setstate);
1109 if (dev_is_sata(dev)) {
1110 struct sas_phy *phy = sas_get_local_phy(dev);
1111 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1113 rc = sas_phy_reset(phy, 1);
1114 sas_put_local_phy(phy);
1115 pm8001_dev->setds_completion = &completion_setstate;
1116 rc = PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
1117 pm8001_dev, DS_OPERATIONAL);
1118 wait_for_completion(&completion_setstate);
1120 tmf_task.tmf = TMF_LU_RESET;
1121 rc = pm8001_issue_ssp_tmf(dev, lun, &tmf_task);
1123 /* If failed, fall-through I_T_Nexus reset */
1124 pm8001_dbg(pm8001_ha, EH, "for device[%x]:rc=%d\n",
1125 pm8001_dev->device_id, rc);
1129 /* optional SAM-3 */
1130 int pm8001_query_task(struct sas_task *task)
1132 u32 tag = 0xdeadbeef;
1133 struct scsi_lun lun;
1134 struct pm8001_tmf_task tmf_task;
1135 int rc = TMF_RESP_FUNC_FAILED;
1136 if (unlikely(!task || !task->lldd_task || !task->dev))
1139 if (task->task_proto & SAS_PROTOCOL_SSP) {
1140 struct scsi_cmnd *cmnd = task->uldd_task;
1141 struct domain_device *dev = task->dev;
1142 struct pm8001_hba_info *pm8001_ha =
1143 pm8001_find_ha_by_dev(dev);
1145 int_to_scsilun(cmnd->device->lun, &lun);
1146 rc = pm8001_find_tag(task, &tag);
1148 rc = TMF_RESP_FUNC_FAILED;
1151 pm8001_dbg(pm8001_ha, EH, "Query:[%16ph]\n", cmnd->cmnd);
1152 tmf_task.tmf = TMF_QUERY_TASK;
1153 tmf_task.tag_of_task_to_be_managed = tag;
1155 rc = pm8001_issue_ssp_tmf(dev, lun.scsi_lun, &tmf_task);
1157 /* The task is still in Lun, release it then */
1158 case TMF_RESP_FUNC_SUCC:
1159 pm8001_dbg(pm8001_ha, EH,
1160 "The task is still in Lun\n");
1162 /* The task is not in Lun or failed, reset the phy */
1163 case TMF_RESP_FUNC_FAILED:
1164 case TMF_RESP_FUNC_COMPLETE:
1165 pm8001_dbg(pm8001_ha, EH,
1166 "The task is not in Lun or failed, reset the phy\n");
1170 pr_err("pm80xx: rc= %d\n", rc);
1174 /* mandatory SAM-3, still need free task/ccb info, abort the specified task */
1175 int pm8001_abort_task(struct sas_task *task)
1177 unsigned long flags;
1179 struct domain_device *dev ;
1180 struct pm8001_hba_info *pm8001_ha;
1181 struct scsi_lun lun;
1182 struct pm8001_device *pm8001_dev;
1183 struct pm8001_tmf_task tmf_task;
1184 int rc = TMF_RESP_FUNC_FAILED, ret;
1186 struct sas_task_slow slow_task;
1188 if (unlikely(!task || !task->lldd_task || !task->dev))
1189 return TMF_RESP_FUNC_FAILED;
1192 pm8001_dev = dev->lldd_dev;
1193 pm8001_ha = pm8001_find_ha_by_dev(dev);
1194 phy_id = pm8001_dev->attached_phy;
1196 if (PM8001_CHIP_DISP->fatal_errors(pm8001_ha)) {
1197 // If the controller is seeing fatal errors
1198 // abort task will not get a response from the controller
1199 return TMF_RESP_FUNC_FAILED;
1202 ret = pm8001_find_tag(task, &tag);
1204 pm8001_info(pm8001_ha, "no tag for task:%p\n", task);
1205 return TMF_RESP_FUNC_FAILED;
1207 spin_lock_irqsave(&task->task_state_lock, flags);
1208 if (task->task_state_flags & SAS_TASK_STATE_DONE) {
1209 spin_unlock_irqrestore(&task->task_state_lock, flags);
1210 return TMF_RESP_FUNC_COMPLETE;
1212 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
1213 if (task->slow_task == NULL) {
1214 init_completion(&slow_task.completion);
1215 task->slow_task = &slow_task;
1217 spin_unlock_irqrestore(&task->task_state_lock, flags);
1218 if (task->task_proto & SAS_PROTOCOL_SSP) {
1219 struct scsi_cmnd *cmnd = task->uldd_task;
1220 int_to_scsilun(cmnd->device->lun, &lun);
1221 tmf_task.tmf = TMF_ABORT_TASK;
1222 tmf_task.tag_of_task_to_be_managed = tag;
1223 rc = pm8001_issue_ssp_tmf(dev, lun.scsi_lun, &tmf_task);
1224 pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1225 pm8001_dev->sas_device, 0, tag);
1226 } else if (task->task_proto & SAS_PROTOCOL_SATA ||
1227 task->task_proto & SAS_PROTOCOL_STP) {
1228 if (pm8001_ha->chip_id == chip_8006) {
1229 DECLARE_COMPLETION_ONSTACK(completion_reset);
1230 DECLARE_COMPLETION_ONSTACK(completion);
1231 struct pm8001_phy *phy = pm8001_ha->phy + phy_id;
1233 /* 1. Set Device state as Recovery */
1234 pm8001_dev->setds_completion = &completion;
1235 PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
1236 pm8001_dev, DS_IN_RECOVERY);
1237 wait_for_completion(&completion);
1239 /* 2. Send Phy Control Hard Reset */
1240 reinit_completion(&completion);
1241 phy->port_reset_status = PORT_RESET_TMO;
1242 phy->reset_success = false;
1243 phy->enable_completion = &completion;
1244 phy->reset_completion = &completion_reset;
1245 ret = PM8001_CHIP_DISP->phy_ctl_req(pm8001_ha, phy_id,
1248 phy->enable_completion = NULL;
1249 phy->reset_completion = NULL;
1253 /* In the case of the reset timeout/fail we still
1254 * abort the command at the firmware. The assumption
1255 * here is that the drive is off doing something so
1256 * that it's not processing requests, and we want to
1257 * avoid getting a completion for this and either
1258 * leaking the task in libsas or losing the race and
1259 * getting a double free.
1261 pm8001_dbg(pm8001_ha, MSG,
1262 "Waiting for local phy ctl\n");
1263 ret = wait_for_completion_timeout(&completion,
1264 PM8001_TASK_TIMEOUT * HZ);
1265 if (!ret || !phy->reset_success) {
1266 phy->enable_completion = NULL;
1267 phy->reset_completion = NULL;
1269 /* 3. Wait for Port Reset complete or
1272 pm8001_dbg(pm8001_ha, MSG,
1273 "Waiting for Port reset\n");
1274 ret = wait_for_completion_timeout(
1276 PM8001_TASK_TIMEOUT * HZ);
1278 phy->reset_completion = NULL;
1279 WARN_ON(phy->port_reset_status ==
1281 if (phy->port_reset_status == PORT_RESET_TMO) {
1282 pm8001_dev_gone_notify(dev);
1289 * we wait for the task to be aborted so that the task
1290 * is removed from the ccb. on success the caller is
1291 * going to free the task.
1293 ret = pm8001_exec_internal_task_abort(pm8001_ha,
1294 pm8001_dev, pm8001_dev->sas_device, 1, tag);
1297 ret = wait_for_completion_timeout(
1298 &task->slow_task->completion,
1299 PM8001_TASK_TIMEOUT * HZ);
1303 /* 5. Set Device State as Operational */
1304 reinit_completion(&completion);
1305 pm8001_dev->setds_completion = &completion;
1306 PM8001_CHIP_DISP->set_dev_state_req(pm8001_ha,
1307 pm8001_dev, DS_OPERATIONAL);
1308 wait_for_completion(&completion);
1310 rc = pm8001_exec_internal_task_abort(pm8001_ha,
1311 pm8001_dev, pm8001_dev->sas_device, 0, tag);
1313 rc = TMF_RESP_FUNC_COMPLETE;
1314 } else if (task->task_proto & SAS_PROTOCOL_SMP) {
1316 rc = pm8001_exec_internal_task_abort(pm8001_ha, pm8001_dev,
1317 pm8001_dev->sas_device, 0, tag);
1321 spin_lock_irqsave(&task->task_state_lock, flags);
1322 if (task->slow_task == &slow_task)
1323 task->slow_task = NULL;
1324 spin_unlock_irqrestore(&task->task_state_lock, flags);
1325 if (rc != TMF_RESP_FUNC_COMPLETE)
1326 pm8001_info(pm8001_ha, "rc= %d\n", rc);
1330 int pm8001_abort_task_set(struct domain_device *dev, u8 *lun)
1332 struct pm8001_tmf_task tmf_task;
1334 tmf_task.tmf = TMF_ABORT_TASK_SET;
1335 return pm8001_issue_ssp_tmf(dev, lun, &tmf_task);
1338 int pm8001_clear_aca(struct domain_device *dev, u8 *lun)
1340 struct pm8001_tmf_task tmf_task;
1342 tmf_task.tmf = TMF_CLEAR_ACA;
1343 return pm8001_issue_ssp_tmf(dev, lun, &tmf_task);
1346 int pm8001_clear_task_set(struct domain_device *dev, u8 *lun)
1348 struct pm8001_tmf_task tmf_task;
1349 struct pm8001_device *pm8001_dev = dev->lldd_dev;
1350 struct pm8001_hba_info *pm8001_ha = pm8001_find_ha_by_dev(dev);
1352 pm8001_dbg(pm8001_ha, EH, "I_T_L_Q clear task set[%x]\n",
1353 pm8001_dev->device_id);
1354 tmf_task.tmf = TMF_CLEAR_TASK_SET;
1355 return pm8001_issue_ssp_tmf(dev, lun, &tmf_task);