[linux-2.6-block.git] / drivers / ide / ide-pm.c

// SPDX-License-Identifier: GPL-2.0
#include <linux/kernel.h>
#include <linux/gfp.h>
#include <linux/ide.h>

int generic_ide_suspend(struct device *dev, pm_message_t mesg)
{
	ide_drive_t *drive = to_ide_device(dev);
	ide_drive_t *pair = ide_get_pair_dev(drive);
	ide_hwif_t *hwif = drive->hwif;
	struct request *rq;
	struct ide_pm_state rqpm;
	int ret;

	if (ide_port_acpi(hwif)) {
		/* call ACPI _GTM only once */
		if ((drive->dn & 1) == 0 || pair == NULL)
			ide_acpi_get_timing(hwif);
	}

	memset(&rqpm, 0, sizeof(rqpm));
	rq = blk_get_request(drive->queue, REQ_OP_DRV_IN, 0);
	ide_req(rq)->type = ATA_PRIV_PM_SUSPEND;
	rq->special = &rqpm;
	rqpm.pm_step = IDE_PM_START_SUSPEND;
	if (mesg.event == PM_EVENT_PRETHAW)
		mesg.event = PM_EVENT_FREEZE;
	rqpm.pm_state = mesg.event;

	blk_execute_rq(drive->queue, NULL, rq, 0);
	ret = scsi_req(rq)->result ? -EIO : 0;
	blk_put_request(rq);

	if (ret == 0 && ide_port_acpi(hwif)) {
		/* call ACPI _PS3 only after both devices are suspended */
		if ((drive->dn & 1) || pair == NULL)
			ide_acpi_set_state(hwif, 0);
	}

	return ret;
}

static void ide_end_sync_rq(struct request *rq, blk_status_t error)
{
	complete(rq->end_io_data);
}

static int ide_pm_execute_rq(struct request *rq)
{
	struct request_queue *q = rq->q;
	DECLARE_COMPLETION_ONSTACK(wait);

	rq->end_io_data = &wait;
	rq->end_io = ide_end_sync_rq;

	spin_lock_irq(q->queue_lock);
	if (unlikely(blk_queue_dying(q))) {
		rq->rq_flags |= RQF_QUIET;
		scsi_req(rq)->result = -ENXIO;
		__blk_end_request_all(rq, BLK_STS_OK);
		spin_unlock_irq(q->queue_lock);
		return -ENXIO;
	}
	__elv_add_request(q, rq, ELEVATOR_INSERT_FRONT);
	__blk_run_queue_uncond(q);
	spin_unlock_irq(q->queue_lock);

	wait_for_completion_io(&wait);

	return scsi_req(rq)->result ? -EIO : 0;
}

int generic_ide_resume(struct device *dev)
{
	ide_drive_t *drive = to_ide_device(dev);
	ide_drive_t *pair = ide_get_pair_dev(drive);
	ide_hwif_t *hwif = drive->hwif;
	struct request *rq;
	struct ide_pm_state rqpm;
	int err;

	if (ide_port_acpi(hwif)) {
		/* call ACPI _PS0 / _STM only once */
		if ((drive->dn & 1) == 0 || pair == NULL) {
			ide_acpi_set_state(hwif, 1);
			ide_acpi_push_timing(hwif);
		}

		ide_acpi_exec_tfs(drive);
	}

	memset(&rqpm, 0, sizeof(rqpm));
	rq = blk_get_request(drive->queue, REQ_OP_DRV_IN, BLK_MQ_REQ_PREEMPT);
	ide_req(rq)->type = ATA_PRIV_PM_RESUME;
	rq->special = &rqpm;
	rqpm.pm_step = IDE_PM_START_RESUME;
	rqpm.pm_state = PM_EVENT_ON;

	err = ide_pm_execute_rq(rq);
	blk_put_request(rq);

	if (err == 0 && dev->driver) {
		struct ide_driver *drv = to_ide_driver(dev->driver);

		if (drv->resume)
			drv->resume(drive);
	}

	return err;
}

void ide_complete_power_step(ide_drive_t *drive, struct request *rq)
{
	struct ide_pm_state *pm = rq->special;

#ifdef DEBUG_PM
	printk(KERN_INFO "%s: complete_power_step(step: %d)\n",
		drive->name, pm->pm_step);
#endif
	if (drive->media != ide_disk)
		return;

	switch (pm->pm_step) {
	case IDE_PM_FLUSH_CACHE:	/* Suspend step 1 (flush cache) */
		if (pm->pm_state == PM_EVENT_FREEZE)
			pm->pm_step = IDE_PM_COMPLETED;
		else
			pm->pm_step = IDE_PM_STANDBY;
		break;
	case IDE_PM_STANDBY:		/* Suspend step 2 (standby) */
		pm->pm_step = IDE_PM_COMPLETED;
		break;
	case IDE_PM_RESTORE_PIO:	/* Resume step 1 (restore PIO) */
		pm->pm_step = IDE_PM_IDLE;
		break;
	case IDE_PM_IDLE:		/* Resume step 2 (idle)*/
		pm->pm_step = IDE_PM_RESTORE_DMA;
		break;
	}
}

ide_startstop_t ide_start_power_step(ide_drive_t *drive, struct request *rq)
{
	struct ide_pm_state *pm = rq->special;
	struct ide_cmd cmd = { };

	switch (pm->pm_step) {
	case IDE_PM_FLUSH_CACHE:	/* Suspend step 1 (flush cache) */
		if (drive->media != ide_disk)
			break;
		/* Not supported? Switch to next step now. */
		if (ata_id_flush_enabled(drive->id) == 0 ||
		    (drive->dev_flags & IDE_DFLAG_WCACHE) == 0) {
			ide_complete_power_step(drive, rq);
			return ide_stopped;
		}
		if (ata_id_flush_ext_enabled(drive->id))
			cmd.tf.command = ATA_CMD_FLUSH_EXT;
		else
			cmd.tf.command = ATA_CMD_FLUSH;
		goto out_do_tf;
	case IDE_PM_STANDBY:		/* Suspend step 2 (standby) */
		cmd.tf.command = ATA_CMD_STANDBYNOW1;
		goto out_do_tf;
	case IDE_PM_RESTORE_PIO:	/* Resume step 1 (restore PIO) */
		ide_set_max_pio(drive);
		/*
		 * skip IDE_PM_IDLE for ATAPI devices
		 */
		if (drive->media != ide_disk)
			pm->pm_step = IDE_PM_RESTORE_DMA;
		else
			ide_complete_power_step(drive, rq);
		return ide_stopped;
	case IDE_PM_IDLE:		/* Resume step 2 (idle) */
		cmd.tf.command = ATA_CMD_IDLEIMMEDIATE;
		goto out_do_tf;
	case IDE_PM_RESTORE_DMA:	/* Resume step 3 (restore DMA) */
		/*
		 * Right now, all we do is call ide_set_dma(drive),
		 * we could be smarter and check for current xfer_speed
		 * in struct drive etc...
		 */
		if (drive->hwif->dma_ops == NULL)
			break;
		/*
		 * TODO: respect IDE_DFLAG_USING_DMA
		 */
		ide_set_dma(drive);
		break;
	}

	pm->pm_step = IDE_PM_COMPLETED;

	return ide_stopped;

out_do_tf:
	cmd.valid.out.tf = IDE_VALID_OUT_TF | IDE_VALID_DEVICE;
	cmd.valid.in.tf  = IDE_VALID_IN_TF  | IDE_VALID_DEVICE;
	cmd.protocol = ATA_PROT_NODATA;

	return do_rw_taskfile(drive, &cmd);
}

/**
 *	ide_complete_pm_rq - end the current Power Management request
 *	@drive: target drive
 *	@rq: request
 *
 *	This function cleans up the current PM request and stops the queue
 *	if necessary.
 */
void ide_complete_pm_rq(ide_drive_t *drive, struct request *rq)
{
	struct request_queue *q = drive->queue;
	struct ide_pm_state *pm = rq->special;
	unsigned long flags;

	ide_complete_power_step(drive, rq);
	if (pm->pm_step != IDE_PM_COMPLETED)
		return;

#ifdef DEBUG_PM
	printk("%s: completing PM request, %s\n", drive->name,
	       (ide_req(rq)->type == ATA_PRIV_PM_SUSPEND) ? "suspend" : "resume");
#endif
	spin_lock_irqsave(q->queue_lock, flags);
	if (ide_req(rq)->type == ATA_PRIV_PM_SUSPEND)
		blk_stop_queue(q);
	else
		drive->dev_flags &= ~IDE_DFLAG_BLOCKED;
	spin_unlock_irqrestore(q->queue_lock, flags);

	drive->hwif->rq = NULL;

	if (blk_end_request(rq, BLK_STS_OK, 0))
		BUG();
}

void ide_check_pm_state(ide_drive_t *drive, struct request *rq)
{
	struct ide_pm_state *pm = rq->special;

	if (blk_rq_is_private(rq) &&
	    ide_req(rq)->type == ATA_PRIV_PM_SUSPEND &&
	    pm->pm_step == IDE_PM_START_SUSPEND)
		/* Mark drive blocked when starting the suspend sequence. */
		drive->dev_flags |= IDE_DFLAG_BLOCKED;
	else if (blk_rq_is_private(rq) &&
	         ide_req(rq)->type == ATA_PRIV_PM_RESUME &&
		 pm->pm_step == IDE_PM_START_RESUME) {
		/*
		 * The first thing we do on wakeup is to wait for BSY bit to
		 * go away (with a looong timeout) as a drive on this hwif may
		 * just be POSTing itself.
		 * We do that before even selecting as the "other" device on
		 * the bus may be broken enough to walk on our toes at this
		 * point.
		 */
		ide_hwif_t *hwif = drive->hwif;
		const struct ide_tp_ops *tp_ops = hwif->tp_ops;
		struct request_queue *q = drive->queue;
		unsigned long flags;
		int rc;
#ifdef DEBUG_PM
		printk("%s: Wakeup request inited, waiting for !BSY...\n", drive->name);
#endif
		rc = ide_wait_not_busy(hwif, 35000);
		if (rc)
			printk(KERN_WARNING "%s: bus not ready on wakeup\n", drive->name);
		tp_ops->dev_select(drive);
		tp_ops->write_devctl(hwif, ATA_DEVCTL_OBS);
		rc = ide_wait_not_busy(hwif, 100000);
		if (rc)
			printk(KERN_WARNING "%s: drive not ready on wakeup\n", drive->name);

		spin_lock_irqsave(q->queue_lock, flags);
		blk_start_queue(q);
		spin_unlock_irqrestore(q->queue_lock, flags);
	}
}
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
e2984c62	2	#include <linux/kernel.h>
5a0e3ad6	3	#include <linux/gfp.h>
e2984c62	4	#include <linux/ide.h>
e2984c62 BZ	5
	6	int generic_ide_suspend(struct device *dev, pm_message_t mesg)
	7	{
9974e43d	8	ide_drive_t *drive = to_ide_device(dev);
fcb52077	9	ide_drive_t *pair = ide_get_pair_dev(drive);
898ec223	10	ide_hwif_t *hwif = drive->hwif;
e2984c62	11	struct request *rq;
a7928c15	12	struct ide_pm_state rqpm;
e2984c62 BZ	13	int ret;
e2984c62 BZ	14
2bf427b2 BZ	15	if (ide_port_acpi(hwif)) {
	16	/* call ACPI _GTM only once */
	17	if ((drive->dn & 1) == 0 \|\| pair == NULL)
	18	ide_acpi_get_timing(hwif);
	19	}
e2984c62 BZ	20
e2984c62 BZ	21	memset(&rqpm, 0, sizeof(rqpm));
ff005a06	22	rq = blk_get_request(drive->queue, REQ_OP_DRV_IN, 0);
2f5a8e80	23	ide_req(rq)->type = ATA_PRIV_PM_SUSPEND;
fc38b521	24	rq->special = &rqpm;
e2984c62 BZ	25	rqpm.pm_step = IDE_PM_START_SUSPEND;
	26	if (mesg.event == PM_EVENT_PRETHAW)
	27	mesg.event = PM_EVENT_FREEZE;
	28	rqpm.pm_state = mesg.event;
	29
b7819b92	30	blk_execute_rq(drive->queue, NULL, rq, 0);
17d5363b	31	ret = scsi_req(rq)->result ? -EIO : 0;
e2984c62 BZ	32	blk_put_request(rq);
e2984c62 BZ	33
2bf427b2 BZ	34	if (ret == 0 && ide_port_acpi(hwif)) {
	35	/* call ACPI _PS3 only after both devices are suspended */
	36	if ((drive->dn & 1) \|\| pair == NULL)
	37	ide_acpi_set_state(hwif, 0);
	38	}
e2984c62 BZ	39
	40	return ret;
	41	}
	42
2a842aca	43	static void ide_end_sync_rq(struct request *rq, blk_status_t error)
a7928c15 CH	44	{
	45	complete(rq->end_io_data);
	46	}
	47
	48	static int ide_pm_execute_rq(struct request *rq)
	49	{
	50	struct request_queue *q = rq->q;
	51	DECLARE_COMPLETION_ONSTACK(wait);
	52
	53	rq->end_io_data = &wait;
	54	rq->end_io = ide_end_sync_rq;
	55
	56	spin_lock_irq(q->queue_lock);
	57	if (unlikely(blk_queue_dying(q))) {
e8064021	58	rq->rq_flags \|= RQF_QUIET;
17d5363b	59	scsi_req(rq)->result = -ENXIO;
2a842aca	60	__blk_end_request_all(rq, BLK_STS_OK);
a7928c15 CH	61	spin_unlock_irq(q->queue_lock);
	62	return -ENXIO;
	63	}
	64	__elv_add_request(q, rq, ELEVATOR_INSERT_FRONT);
	65	__blk_run_queue_uncond(q);
	66	spin_unlock_irq(q->queue_lock);
	67
	68	wait_for_completion_io(&wait);
	69
17d5363b	70	return scsi_req(rq)->result ? -EIO : 0;
a7928c15 CH	71	}
a7928c15 CH	72
e2984c62 BZ	73	int generic_ide_resume(struct device *dev)
e2984c62 BZ	74	{
9974e43d	75	ide_drive_t *drive = to_ide_device(dev);
fcb52077	76	ide_drive_t *pair = ide_get_pair_dev(drive);
898ec223	77	ide_hwif_t *hwif = drive->hwif;
e2984c62	78	struct request *rq;
a7928c15	79	struct ide_pm_state rqpm;
e2984c62 BZ	80	int err;
e2984c62 BZ	81
2bf427b2 BZ	82	if (ide_port_acpi(hwif)) {
	83	/* call ACPI _PS0 / _STM only once */
	84	if ((drive->dn & 1) == 0 \|\| pair == NULL) {
	85	ide_acpi_set_state(hwif, 1);
	86	ide_acpi_push_timing(hwif);
	87	}
e2984c62	88
2bf427b2 BZ	89	ide_acpi_exec_tfs(drive);
2bf427b2 BZ	90	}
e2984c62 BZ	91
e2984c62 BZ	92	memset(&rqpm, 0, sizeof(rqpm));
ff005a06	93	rq = blk_get_request(drive->queue, REQ_OP_DRV_IN, BLK_MQ_REQ_PREEMPT);
2f5a8e80	94	ide_req(rq)->type = ATA_PRIV_PM_RESUME;
fc38b521	95	rq->special = &rqpm;
e2984c62 BZ	96	rqpm.pm_step = IDE_PM_START_RESUME;
	97	rqpm.pm_state = PM_EVENT_ON;
	98
a7928c15	99	err = ide_pm_execute_rq(rq);
e2984c62 BZ	100	blk_put_request(rq);
	101
	102	if (err == 0 && dev->driver) {
7f3c868b	103	struct ide_driver *drv = to_ide_driver(dev->driver);
e2984c62 BZ	104
	105	if (drv->resume)
	106	drv->resume(drive);
	107	}
	108
	109	return err;
	110	}
	111
	112	void ide_complete_power_step(ide_drive_t drive, struct request rq)
	113	{
a7928c15	114	struct ide_pm_state *pm = rq->special;
e2984c62 BZ	115
	116	#ifdef DEBUG_PM
	117	printk(KERN_INFO "%s: complete_power_step(step: %d)\n",
	118	drive->name, pm->pm_step);
	119	#endif
	120	if (drive->media != ide_disk)
	121	return;
	122
	123	switch (pm->pm_step) {
	124	case IDE_PM_FLUSH_CACHE: /* Suspend step 1 (flush cache) */
	125	if (pm->pm_state == PM_EVENT_FREEZE)
	126	pm->pm_step = IDE_PM_COMPLETED;
	127	else
	128	pm->pm_step = IDE_PM_STANDBY;
	129	break;
	130	case IDE_PM_STANDBY: /* Suspend step 2 (standby) */
	131	pm->pm_step = IDE_PM_COMPLETED;
	132	break;
	133	case IDE_PM_RESTORE_PIO: /* Resume step 1 (restore PIO) */
	134	pm->pm_step = IDE_PM_IDLE;
	135	break;
	136	case IDE_PM_IDLE: /* Resume step 2 (idle)*/
	137	pm->pm_step = IDE_PM_RESTORE_DMA;
	138	break;
	139	}
	140	}
	141
	142	ide_startstop_t ide_start_power_step(ide_drive_t drive, struct request rq)
	143	{
a7928c15	144	struct ide_pm_state *pm = rq->special;
fc38b521	145	struct ide_cmd cmd = { };
e2984c62 BZ	146
	147	switch (pm->pm_step) {
	148	case IDE_PM_FLUSH_CACHE: /* Suspend step 1 (flush cache) */
	149	if (drive->media != ide_disk)
	150	break;
	151	/* Not supported? Switch to next step now. */
	152	if (ata_id_flush_enabled(drive->id) == 0 \|\|
	153	(drive->dev_flags & IDE_DFLAG_WCACHE) == 0) {
	154	ide_complete_power_step(drive, rq);
	155	return ide_stopped;
	156	}
	157	if (ata_id_flush_ext_enabled(drive->id))
fc38b521	158	cmd.tf.command = ATA_CMD_FLUSH_EXT;
e2984c62	159	else
fc38b521	160	cmd.tf.command = ATA_CMD_FLUSH;
e2984c62 BZ	161	goto out_do_tf;
e2984c62 BZ	162	case IDE_PM_STANDBY: /* Suspend step 2 (standby) */
fc38b521	163	cmd.tf.command = ATA_CMD_STANDBYNOW1;
e2984c62 BZ	164	goto out_do_tf;
	165	case IDE_PM_RESTORE_PIO: /* Resume step 1 (restore PIO) */
	166	ide_set_max_pio(drive);
	167	/*
	168	* skip IDE_PM_IDLE for ATAPI devices
	169	*/
	170	if (drive->media != ide_disk)
	171	pm->pm_step = IDE_PM_RESTORE_DMA;
	172	else
	173	ide_complete_power_step(drive, rq);
	174	return ide_stopped;
	175	case IDE_PM_IDLE: /* Resume step 2 (idle) */
fc38b521	176	cmd.tf.command = ATA_CMD_IDLEIMMEDIATE;
e2984c62 BZ	177	goto out_do_tf;
	178	case IDE_PM_RESTORE_DMA: /* Resume step 3 (restore DMA) */
	179	/*
	180	* Right now, all we do is call ide_set_dma(drive),
	181	* we could be smarter and check for current xfer_speed
	182	* in struct drive etc...
	183	*/
	184	if (drive->hwif->dma_ops == NULL)
	185	break;
	186	/*
	187	* TODO: respect IDE_DFLAG_USING_DMA
	188	*/
	189	ide_set_dma(drive);
	190	break;
	191	}
	192
	193	pm->pm_step = IDE_PM_COMPLETED;
22aa4b32	194
e2984c62 BZ	195	return ide_stopped;
	196
	197	out_do_tf:
fc38b521 TH	198	cmd.valid.out.tf = IDE_VALID_OUT_TF \| IDE_VALID_DEVICE;
	199	cmd.valid.in.tf = IDE_VALID_IN_TF \| IDE_VALID_DEVICE;
	200	cmd.protocol = ATA_PROT_NODATA;
22aa4b32	201
fc38b521	202	return do_rw_taskfile(drive, &cmd);
e2984c62 BZ	203	}
	204
	205	/**
3616b653	206	* ide_complete_pm_rq - end the current Power Management request
e2984c62 BZ	207	* @drive: target drive
	208	* @rq: request
	209	*
	210	* This function cleans up the current PM request and stops the queue
	211	* if necessary.
	212	*/
3616b653	213	void ide_complete_pm_rq(ide_drive_t drive, struct request rq)
e2984c62 BZ	214	{
e2984c62 BZ	215	struct request_queue *q = drive->queue;
a7928c15	216	struct ide_pm_state *pm = rq->special;
e2984c62 BZ	217	unsigned long flags;
e2984c62 BZ	218
3616b653 BZ	219	ide_complete_power_step(drive, rq);
	220	if (pm->pm_step != IDE_PM_COMPLETED)
	221	return;
	222
e2984c62 BZ	223	#ifdef DEBUG_PM
e2984c62 BZ	224	printk("%s: completing PM request, %s\n", drive->name,
2f5a8e80	225	(ide_req(rq)->type == ATA_PRIV_PM_SUSPEND) ? "suspend" : "resume");
e2984c62 BZ	226	#endif
e2984c62 BZ	227	spin_lock_irqsave(q->queue_lock, flags);
2f5a8e80	228	if (ide_req(rq)->type == ATA_PRIV_PM_SUSPEND)
e2984c62	229	blk_stop_queue(q);
2ea55210	230	else
e2984c62	231	drive->dev_flags &= ~IDE_DFLAG_BLOCKED;
e2984c62 BZ	232	spin_unlock_irqrestore(q->queue_lock, flags);
e2984c62 BZ	233
b65fac32	234	drive->hwif->rq = NULL;
e2984c62	235
2a842aca	236	if (blk_end_request(rq, BLK_STS_OK, 0))
e2984c62 BZ	237	BUG();
	238	}
	239
	240	void ide_check_pm_state(ide_drive_t drive, struct request rq)
	241	{
a7928c15	242	struct ide_pm_state *pm = rq->special;
e2984c62	243
aebf526b	244	if (blk_rq_is_private(rq) &&
2f5a8e80	245	ide_req(rq)->type == ATA_PRIV_PM_SUSPEND &&
e2984c62 BZ	246	pm->pm_step == IDE_PM_START_SUSPEND)
	247	/* Mark drive blocked when starting the suspend sequence. */
	248	drive->dev_flags \|= IDE_DFLAG_BLOCKED;
aebf526b	249	else if (blk_rq_is_private(rq) &&
2f5a8e80	250	ide_req(rq)->type == ATA_PRIV_PM_RESUME &&
e2984c62 BZ	251	pm->pm_step == IDE_PM_START_RESUME) {
	252	/*
	253	* The first thing we do on wakeup is to wait for BSY bit to
	254	* go away (with a looong timeout) as a drive on this hwif may
	255	* just be POSTing itself.
	256	* We do that before even selecting as the "other" device on
	257	* the bus may be broken enough to walk on our toes at this
	258	* point.
	259	*/
	260	ide_hwif_t *hwif = drive->hwif;
fdd88f0a	261	const struct ide_tp_ops *tp_ops = hwif->tp_ops;
2ea55210 BZ	262	struct request_queue *q = drive->queue;
2ea55210 BZ	263	unsigned long flags;
e2984c62 BZ	264	int rc;
	265	#ifdef DEBUG_PM
	266	printk("%s: Wakeup request inited, waiting for !BSY...\n", drive->name);
	267	#endif
	268	rc = ide_wait_not_busy(hwif, 35000);
	269	if (rc)
	270	printk(KERN_WARNING "%s: bus not ready on wakeup\n", drive->name);
fdd88f0a SS	271	tp_ops->dev_select(drive);
fdd88f0a SS	272	tp_ops->write_devctl(hwif, ATA_DEVCTL_OBS);
e2984c62 BZ	273	rc = ide_wait_not_busy(hwif, 100000);
	274	if (rc)
	275	printk(KERN_WARNING "%s: drive not ready on wakeup\n", drive->name);
2ea55210 BZ	276
	277	spin_lock_irqsave(q->queue_lock, flags);
	278	blk_start_queue(q);
	279	spin_unlock_irqrestore(q->queue_lock, flags);
e2984c62 BZ	280	}
e2984c62 BZ	281	}