[linux-2.6-block.git] / drivers / ata / libata-zpodd.c

// SPDX-License-Identifier: GPL-2.0
#include <linux/libata.h>
#include <linux/cdrom.h>
#include <linux/pm_runtime.h>
#include <linux/module.h>
#include <linux/pm_qos.h>
#include <scsi/scsi_device.h>

#include "libata.h"

static int zpodd_poweroff_delay = 30; /* 30 seconds for power off delay */
module_param(zpodd_poweroff_delay, int, 0644);
MODULE_PARM_DESC(zpodd_poweroff_delay, "Poweroff delay for ZPODD in seconds");

enum odd_mech_type {
	ODD_MECH_TYPE_SLOT,
	ODD_MECH_TYPE_DRAWER,
	ODD_MECH_TYPE_UNSUPPORTED,
};

struct zpodd {
	enum odd_mech_type	mech_type; /* init during probe, RO afterwards */
	struct ata_device	*dev;

	/* The following fields are synchronized by PM core. */
	bool			from_notify; /* resumed as a result of
					      * acpi wake notification */
	bool			zp_ready; /* ZP ready state */
	unsigned long		last_ready; /* last ZP ready timestamp */
	bool			zp_sampled; /* ZP ready state sampled */
	bool			powered_off; /* ODD is powered off
					      *	during suspend */
};

static int eject_tray(struct ata_device *dev)
{
	struct ata_taskfile tf;
	static const char cdb[ATAPI_CDB_LEN] = {  GPCMD_START_STOP_UNIT,
		0, 0, 0,
		0x02,     /* LoEj */
		0, 0, 0, 0, 0, 0, 0,
	};

	ata_tf_init(dev, &tf);
	tf.flags = ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
	tf.command = ATA_CMD_PACKET;
	tf.protocol = ATAPI_PROT_NODATA;

	return ata_exec_internal(dev, &tf, cdb, DMA_NONE, NULL, 0, 0);
}

/* Per the spec, only slot type and drawer type ODD can be supported */
static enum odd_mech_type zpodd_get_mech_type(struct ata_device *dev)
{
	char buf[16];
	unsigned int ret;
	struct rm_feature_desc *desc = (void *)(buf + 8);
	struct ata_taskfile tf;
	static const char cdb[] = {  GPCMD_GET_CONFIGURATION,
			2,      /* only 1 feature descriptor requested */
			0, 3,   /* 3, removable medium feature */
			0, 0, 0,/* reserved */
			0, sizeof(buf),
			0, 0, 0,
	};

	ata_tf_init(dev, &tf);
	tf.flags = ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
	tf.command = ATA_CMD_PACKET;
	tf.protocol = ATAPI_PROT_PIO;
	tf.lbam = sizeof(buf);

	ret = ata_exec_internal(dev, &tf, cdb, DMA_FROM_DEVICE,
				buf, sizeof(buf), 0);
	if (ret)
		return ODD_MECH_TYPE_UNSUPPORTED;

	if (be16_to_cpu(desc->feature_code) != 3)
		return ODD_MECH_TYPE_UNSUPPORTED;

	if (desc->mech_type == 0 && desc->load == 0 && desc->eject == 1)
		return ODD_MECH_TYPE_SLOT;
	else if (desc->mech_type == 1 && desc->load == 0 && desc->eject == 1)
		return ODD_MECH_TYPE_DRAWER;
	else
		return ODD_MECH_TYPE_UNSUPPORTED;
}

/* Test if ODD is zero power ready by sense code */
static bool zpready(struct ata_device *dev)
{
	u8 sense_key, *sense_buf;
	unsigned int ret, asc, ascq, add_len;
	struct zpodd *zpodd = dev->zpodd;

	ret = atapi_eh_tur(dev, &sense_key);

	if (!ret || sense_key != NOT_READY)
		return false;

	sense_buf = dev->link->ap->sector_buf;
	ret = atapi_eh_request_sense(dev, sense_buf, sense_key);
	if (ret)
		return false;

	/* sense valid */
	if ((sense_buf[0] & 0x7f) != 0x70)
		return false;

	add_len = sense_buf[7];
	/* has asc and ascq */
	if (add_len < 6)
		return false;

	asc = sense_buf[12];
	ascq = sense_buf[13];

	if (zpodd->mech_type == ODD_MECH_TYPE_SLOT)
		/* no media inside */
		return asc == 0x3a;
	else
		/* no media inside and door closed */
		return asc == 0x3a && ascq == 0x01;
}

/*
 * Update the zpodd->zp_ready field. This field will only be set
 * if the ODD has stayed in ZP ready state for zpodd_poweroff_delay
 * time, and will be used to decide if power off is allowed. If it
 * is set, it will be cleared during resume from powered off state.
 */
void zpodd_on_suspend(struct ata_device *dev)
{
	struct zpodd *zpodd = dev->zpodd;
	unsigned long expires;

	if (!zpready(dev)) {
		zpodd->zp_sampled = false;
		zpodd->zp_ready = false;
		return;
	}

	if (!zpodd->zp_sampled) {
		zpodd->zp_sampled = true;
		zpodd->last_ready = jiffies;
		return;
	}

	expires = zpodd->last_ready +
		  msecs_to_jiffies(zpodd_poweroff_delay * 1000);
	if (time_before(jiffies, expires))
		return;

	zpodd->zp_ready = true;
}

bool zpodd_zpready(struct ata_device *dev)
{
	struct zpodd *zpodd = dev->zpodd;
	return zpodd->zp_ready;
}

/*
 * Enable runtime wake capability through ACPI and set the powered_off flag,
 * this flag will be used during resume to decide what operations are needed
 * to take.
 *
 * Also, media poll needs to be silenced, so that it doesn't bring the ODD
 * back to full power state every few seconds.
 */
void zpodd_enable_run_wake(struct ata_device *dev)
{
	struct zpodd *zpodd = dev->zpodd;

	sdev_disable_disk_events(dev->sdev);

	zpodd->powered_off = true;
	acpi_pm_set_device_wakeup(&dev->tdev, true);
}

/* Disable runtime wake capability if it is enabled */
void zpodd_disable_run_wake(struct ata_device *dev)
{
	struct zpodd *zpodd = dev->zpodd;

	if (zpodd->powered_off)
		acpi_pm_set_device_wakeup(&dev->tdev, false);
}

/*
 * Post power on processing after the ODD has been recovered. If the
 * ODD wasn't powered off during suspend, it doesn't do anything.
 *
 * For drawer type ODD, if it is powered on due to user pressed the
 * eject button, the tray needs to be ejected. This can only be done
 * after the ODD has been recovered, i.e. link is initialized and
 * device is able to process NON_DATA PIO command, as eject needs to
 * send command for the ODD to process.
 *
 * The from_notify flag set in wake notification handler function
 * zpodd_wake_dev represents if power on is due to user's action.
 *
 * For both types of ODD, several fields need to be reset.
 */
void zpodd_post_poweron(struct ata_device *dev)
{
	struct zpodd *zpodd = dev->zpodd;

	if (!zpodd->powered_off)
		return;

	zpodd->powered_off = false;

	if (zpodd->from_notify) {
		zpodd->from_notify = false;
		if (zpodd->mech_type == ODD_MECH_TYPE_DRAWER)
			eject_tray(dev);
	}

	zpodd->zp_sampled = false;
	zpodd->zp_ready = false;

	sdev_enable_disk_events(dev->sdev);
}

static void zpodd_wake_dev(acpi_handle handle, u32 event, void *context)
{
	struct ata_device *ata_dev = context;
	struct zpodd *zpodd = ata_dev->zpodd;
	struct device *dev = &ata_dev->sdev->sdev_gendev;

	if (event == ACPI_NOTIFY_DEVICE_WAKE && pm_runtime_suspended(dev)) {
		zpodd->from_notify = true;
		pm_runtime_resume(dev);
	}
}

static void ata_acpi_add_pm_notifier(struct ata_device *dev)
{
	acpi_handle handle = ata_dev_acpi_handle(dev);
	acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
				    zpodd_wake_dev, dev);
}

static void ata_acpi_remove_pm_notifier(struct ata_device *dev)
{
	acpi_handle handle = ata_dev_acpi_handle(dev);
	acpi_remove_notify_handler(handle, ACPI_SYSTEM_NOTIFY, zpodd_wake_dev);
}

void zpodd_init(struct ata_device *dev)
{
	struct acpi_device *adev = ACPI_COMPANION(&dev->tdev);
	enum odd_mech_type mech_type;
	struct zpodd *zpodd;

	if (dev->zpodd || !adev || !acpi_device_can_poweroff(adev))
		return;

	mech_type = zpodd_get_mech_type(dev);
	if (mech_type == ODD_MECH_TYPE_UNSUPPORTED)
		return;

	zpodd = kzalloc(sizeof(struct zpodd), GFP_KERNEL);
	if (!zpodd)
		return;

	zpodd->mech_type = mech_type;

	ata_acpi_add_pm_notifier(dev);
	zpodd->dev = dev;
	dev->zpodd = zpodd;
	dev_pm_qos_expose_flags(&dev->tdev, 0);
}

void zpodd_exit(struct ata_device *dev)
{
	ata_acpi_remove_pm_notifier(dev);
	kfree(dev->zpodd);
	dev->zpodd = NULL;
}
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
afe75951 AL	2	#include <linux/libata.h>
afe75951 AL	3	#include <linux/cdrom.h>
f064a20d	4	#include <linux/pm_runtime.h>
3dc67440	5	#include <linux/module.h>
f1bc1e4c	6	#include <linux/pm_qos.h>
f064a20d	7	#include <scsi/scsi_device.h>
afe75951 AL	8
	9	#include "libata.h"
	10
3dc67440 AL	11	static int zpodd_poweroff_delay = 30; /* 30 seconds for power off delay */
	12	module_param(zpodd_poweroff_delay, int, 0644);
	13	MODULE_PARM_DESC(zpodd_poweroff_delay, "Poweroff delay for ZPODD in seconds");
	14
afe75951 AL	15	enum odd_mech_type {
	16	ODD_MECH_TYPE_SLOT,
	17	ODD_MECH_TYPE_DRAWER,
	18	ODD_MECH_TYPE_UNSUPPORTED,
	19	};
	20
	21	struct zpodd {
	22	enum odd_mech_type mech_type; /* init during probe, RO afterwards */
	23	struct ata_device *dev;
f064a20d AL	24
	25	/* The following fields are synchronized by PM core. */
	26	bool from_notify; /* resumed as a result of
	27	* acpi wake notification */
3dc67440 AL	28	bool zp_ready; /* ZP ready state */
	29	unsigned long last_ready; /* last ZP ready timestamp */
	30	bool zp_sampled; /* ZP ready state sampled */
21334205 AL	31	bool powered_off; /* ODD is powered off
21334205 AL	32	* during suspend */
afe75951 AL	33	};
afe75951 AL	34
21334205 AL	35	static int eject_tray(struct ata_device *dev)
21334205 AL	36	{
d0887c43	37	struct ata_taskfile tf;
18c9a99b	38	static const char cdb[ATAPI_CDB_LEN] = { GPCMD_START_STOP_UNIT,
21334205 AL	39	0, 0, 0,
	40	0x02, /* LoEj */
	41	0, 0, 0, 0, 0, 0, 0,
	42	};
	43
d0887c43	44	ata_tf_init(dev, &tf);
21334205 AL	45	tf.flags = ATA_TFLAG_ISADDR \| ATA_TFLAG_DEVICE;
	46	tf.command = ATA_CMD_PACKET;
	47	tf.protocol = ATAPI_PROT_NODATA;
	48
	49	return ata_exec_internal(dev, &tf, cdb, DMA_NONE, NULL, 0, 0);
	50	}
	51
afe75951 AL	52	/* Per the spec, only slot type and drawer type ODD can be supported */
	53	static enum odd_mech_type zpodd_get_mech_type(struct ata_device *dev)
	54	{
	55	char buf[16];
	56	unsigned int ret;
	57	struct rm_feature_desc desc = (void )(buf + 8);
d0887c43	58	struct ata_taskfile tf;
795ef788	59	static const char cdb[] = { GPCMD_GET_CONFIGURATION,
afe75951 AL	60	2, /* only 1 feature descriptor requested */
	61	0, 3, /* 3, removable medium feature */
	62	0, 0, 0,/* reserved */
	63	0, sizeof(buf),
	64	0, 0, 0,
	65	};
	66
d0887c43	67	ata_tf_init(dev, &tf);
afe75951 AL	68	tf.flags = ATA_TFLAG_ISADDR \| ATA_TFLAG_DEVICE;
	69	tf.command = ATA_CMD_PACKET;
	70	tf.protocol = ATAPI_PROT_PIO;
	71	tf.lbam = sizeof(buf);
	72
	73	ret = ata_exec_internal(dev, &tf, cdb, DMA_FROM_DEVICE,
	74	buf, sizeof(buf), 0);
	75	if (ret)
	76	return ODD_MECH_TYPE_UNSUPPORTED;
	77
	78	if (be16_to_cpu(desc->feature_code) != 3)
	79	return ODD_MECH_TYPE_UNSUPPORTED;
	80
	81	if (desc->mech_type == 0 && desc->load == 0 && desc->eject == 1)
	82	return ODD_MECH_TYPE_SLOT;
	83	else if (desc->mech_type == 1 && desc->load == 0 && desc->eject == 1)
	84	return ODD_MECH_TYPE_DRAWER;
	85	else
	86	return ODD_MECH_TYPE_UNSUPPORTED;
	87	}
	88
3dc67440 AL	89	/* Test if ODD is zero power ready by sense code */
	90	static bool zpready(struct ata_device *dev)
	91	{
	92	u8 sense_key, *sense_buf;
	93	unsigned int ret, asc, ascq, add_len;
	94	struct zpodd *zpodd = dev->zpodd;
	95
	96	ret = atapi_eh_tur(dev, &sense_key);
	97
	98	if (!ret \|\| sense_key != NOT_READY)
	99	return false;
	100
	101	sense_buf = dev->link->ap->sector_buf;
	102	ret = atapi_eh_request_sense(dev, sense_buf, sense_key);
	103	if (ret)
	104	return false;
	105
	106	/* sense valid */
	107	if ((sense_buf[0] & 0x7f) != 0x70)
	108	return false;
	109
	110	add_len = sense_buf[7];
	111	/* has asc and ascq */
	112	if (add_len < 6)
	113	return false;
	114
	115	asc = sense_buf[12];
	116	ascq = sense_buf[13];
	117
	118	if (zpodd->mech_type == ODD_MECH_TYPE_SLOT)
	119	/* no media inside */
	120	return asc == 0x3a;
	121	else
	122	/* no media inside and door closed */
	123	return asc == 0x3a && ascq == 0x01;
	124	}
	125
	126	/*
	127	* Update the zpodd->zp_ready field. This field will only be set
	128	* if the ODD has stayed in ZP ready state for zpodd_poweroff_delay
	129	* time, and will be used to decide if power off is allowed. If it
	130	* is set, it will be cleared during resume from powered off state.
	131	*/
	132	void zpodd_on_suspend(struct ata_device *dev)
	133	{
	134	struct zpodd *zpodd = dev->zpodd;
	135	unsigned long expires;
	136
	137	if (!zpready(dev)) {
	138	zpodd->zp_sampled = false;
a59b9aae	139	zpodd->zp_ready = false;
3dc67440 AL	140	return;
	141	}
	142
	143	if (!zpodd->zp_sampled) {
	144	zpodd->zp_sampled = true;
	145	zpodd->last_ready = jiffies;
	146	return;
	147	}
	148
	149	expires = zpodd->last_ready +
	150	msecs_to_jiffies(zpodd_poweroff_delay * 1000);
	151	if (time_before(jiffies, expires))
	152	return;
	153
	154	zpodd->zp_ready = true;
	155	}
	156
21334205 AL	157	bool zpodd_zpready(struct ata_device *dev)
	158	{
	159	struct zpodd *zpodd = dev->zpodd;
	160	return zpodd->zp_ready;
	161	}
	162
	163	/*
	164	* Enable runtime wake capability through ACPI and set the powered_off flag,
	165	* this flag will be used during resume to decide what operations are needed
	166	* to take.
6f4c827e AL	167	*
	168	* Also, media poll needs to be silenced, so that it doesn't bring the ODD
	169	* back to full power state every few seconds.
21334205 AL	170	*/
	171	void zpodd_enable_run_wake(struct ata_device *dev)
	172	{
	173	struct zpodd *zpodd = dev->zpodd;
	174
6f4c827e AL	175	sdev_disable_disk_events(dev->sdev);
6f4c827e AL	176
21334205	177	zpodd->powered_off = true;
4d183d04	178	acpi_pm_set_device_wakeup(&dev->tdev, true);
21334205 AL	179	}
	180
	181	/* Disable runtime wake capability if it is enabled */
	182	void zpodd_disable_run_wake(struct ata_device *dev)
	183	{
	184	struct zpodd *zpodd = dev->zpodd;
	185
4d183d04 RW	186	if (zpodd->powered_off)
4d183d04 RW	187	acpi_pm_set_device_wakeup(&dev->tdev, false);
21334205 AL	188	}
	189
	190	/*
	191	* Post power on processing after the ODD has been recovered. If the
	192	* ODD wasn't powered off during suspend, it doesn't do anything.
	193	*
	194	* For drawer type ODD, if it is powered on due to user pressed the
	195	* eject button, the tray needs to be ejected. This can only be done
	196	* after the ODD has been recovered, i.e. link is initialized and
	197	* device is able to process NON_DATA PIO command, as eject needs to
	198	* send command for the ODD to process.
	199	*
	200	* The from_notify flag set in wake notification handler function
	201	* zpodd_wake_dev represents if power on is due to user's action.
	202	*
	203	* For both types of ODD, several fields need to be reset.
	204	*/
	205	void zpodd_post_poweron(struct ata_device *dev)
	206	{
	207	struct zpodd *zpodd = dev->zpodd;
	208
	209	if (!zpodd->powered_off)
	210	return;
	211
	212	zpodd->powered_off = false;
	213
	214	if (zpodd->from_notify) {
	215	zpodd->from_notify = false;
	216	if (zpodd->mech_type == ODD_MECH_TYPE_DRAWER)
	217	eject_tray(dev);
	218	}
	219
	220	zpodd->zp_sampled = false;
	221	zpodd->zp_ready = false;
6f4c827e AL	222
6f4c827e AL	223	sdev_enable_disk_events(dev->sdev);
21334205 AL	224	}
21334205 AL	225
f064a20d AL	226	static void zpodd_wake_dev(acpi_handle handle, u32 event, void *context)
	227	{
	228	struct ata_device *ata_dev = context;
	229	struct zpodd *zpodd = ata_dev->zpodd;
	230	struct device *dev = &ata_dev->sdev->sdev_gendev;
	231
53637e07	232	if (event == ACPI_NOTIFY_DEVICE_WAKE && pm_runtime_suspended(dev)) {
f064a20d AL	233	zpodd->from_notify = true;
	234	pm_runtime_resume(dev);
	235	}
	236	}
	237
	238	static void ata_acpi_add_pm_notifier(struct ata_device *dev)
	239	{
	240	acpi_handle handle = ata_dev_acpi_handle(dev);
	241	acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
	242	zpodd_wake_dev, dev);
	243	}
	244
	245	static void ata_acpi_remove_pm_notifier(struct ata_device *dev)
	246	{
f1bc1e4c	247	acpi_handle handle = ata_dev_acpi_handle(dev);
f064a20d AL	248	acpi_remove_notify_handler(handle, ACPI_SYSTEM_NOTIFY, zpodd_wake_dev);
	249	}
	250
afe75951 AL	251	void zpodd_init(struct ata_device *dev)
afe75951 AL	252	{
d9202036	253	struct acpi_device *adev = ACPI_COMPANION(&dev->tdev);
afe75951 AL	254	enum odd_mech_type mech_type;
	255	struct zpodd *zpodd;
	256
d9202036	257	if (dev->zpodd \|\| !adev \|\| !acpi_device_can_poweroff(adev))
afe75951 AL	258	return;
	259
	260	mech_type = zpodd_get_mech_type(dev);
	261	if (mech_type == ODD_MECH_TYPE_UNSUPPORTED)
	262	return;
	263
	264	zpodd = kzalloc(sizeof(struct zpodd), GFP_KERNEL);
	265	if (!zpodd)
	266	return;
	267
	268	zpodd->mech_type = mech_type;
	269
f064a20d	270	ata_acpi_add_pm_notifier(dev);
afe75951 AL	271	zpodd->dev = dev;
afe75951 AL	272	dev->zpodd = zpodd;
f1bc1e4c	273	dev_pm_qos_expose_flags(&dev->tdev, 0);
afe75951 AL	274	}
	275
	276	void zpodd_exit(struct ata_device *dev)
	277	{
f064a20d	278	ata_acpi_remove_pm_notifier(dev);
afe75951 AL	279	kfree(dev->zpodd);
	280	dev->zpodd = NULL;
	281	}