1 #include <linux/libata.h>
2 #include <linux/cdrom.h>
3 #include <linux/pm_runtime.h>
4 #include <linux/module.h>
5 #include <scsi/scsi_device.h>
9 static int zpodd_poweroff_delay = 30; /* 30 seconds for power off delay */
10 module_param(zpodd_poweroff_delay, int, 0644);
11 MODULE_PARM_DESC(zpodd_poweroff_delay, "Poweroff delay for ZPODD in seconds");
16 ODD_MECH_TYPE_UNSUPPORTED,
20 enum odd_mech_type mech_type; /* init during probe, RO afterwards */
21 struct ata_device *dev;
23 /* The following fields are synchronized by PM core. */
24 bool from_notify; /* resumed as a result of
25 * acpi wake notification */
26 bool zp_ready; /* ZP ready state */
27 unsigned long last_ready; /* last ZP ready timestamp */
28 bool zp_sampled; /* ZP ready state sampled */
29 bool powered_off; /* ODD is powered off
33 static int eject_tray(struct ata_device *dev)
35 struct ata_taskfile tf = {};
36 const char cdb[] = { GPCMD_START_STOP_UNIT,
42 tf.flags = ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
43 tf.command = ATA_CMD_PACKET;
44 tf.protocol = ATAPI_PROT_NODATA;
46 return ata_exec_internal(dev, &tf, cdb, DMA_NONE, NULL, 0, 0);
49 /* Per the spec, only slot type and drawer type ODD can be supported */
50 static enum odd_mech_type zpodd_get_mech_type(struct ata_device *dev)
54 struct rm_feature_desc *desc = (void *)(buf + 8);
55 struct ata_taskfile tf = {};
57 char cdb[] = { GPCMD_GET_CONFIGURATION,
58 2, /* only 1 feature descriptor requested */
59 0, 3, /* 3, removable medium feature */
60 0, 0, 0,/* reserved */
65 tf.flags = ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
66 tf.command = ATA_CMD_PACKET;
67 tf.protocol = ATAPI_PROT_PIO;
68 tf.lbam = sizeof(buf);
70 ret = ata_exec_internal(dev, &tf, cdb, DMA_FROM_DEVICE,
73 return ODD_MECH_TYPE_UNSUPPORTED;
75 if (be16_to_cpu(desc->feature_code) != 3)
76 return ODD_MECH_TYPE_UNSUPPORTED;
78 if (desc->mech_type == 0 && desc->load == 0 && desc->eject == 1)
79 return ODD_MECH_TYPE_SLOT;
80 else if (desc->mech_type == 1 && desc->load == 0 && desc->eject == 1)
81 return ODD_MECH_TYPE_DRAWER;
83 return ODD_MECH_TYPE_UNSUPPORTED;
86 static bool odd_can_poweroff(struct ata_device *ata_dev)
90 struct acpi_device *acpi_dev;
92 handle = ata_dev_acpi_handle(ata_dev);
96 status = acpi_bus_get_device(handle, &acpi_dev);
97 if (ACPI_FAILURE(status))
100 return acpi_device_can_poweroff(acpi_dev);
103 /* Test if ODD is zero power ready by sense code */
104 static bool zpready(struct ata_device *dev)
106 u8 sense_key, *sense_buf;
107 unsigned int ret, asc, ascq, add_len;
108 struct zpodd *zpodd = dev->zpodd;
110 ret = atapi_eh_tur(dev, &sense_key);
112 if (!ret || sense_key != NOT_READY)
115 sense_buf = dev->link->ap->sector_buf;
116 ret = atapi_eh_request_sense(dev, sense_buf, sense_key);
121 if ((sense_buf[0] & 0x7f) != 0x70)
124 add_len = sense_buf[7];
125 /* has asc and ascq */
130 ascq = sense_buf[13];
132 if (zpodd->mech_type == ODD_MECH_TYPE_SLOT)
133 /* no media inside */
136 /* no media inside and door closed */
137 return asc == 0x3a && ascq == 0x01;
141 * Update the zpodd->zp_ready field. This field will only be set
142 * if the ODD has stayed in ZP ready state for zpodd_poweroff_delay
143 * time, and will be used to decide if power off is allowed. If it
144 * is set, it will be cleared during resume from powered off state.
146 void zpodd_on_suspend(struct ata_device *dev)
148 struct zpodd *zpodd = dev->zpodd;
149 unsigned long expires;
152 zpodd->zp_sampled = false;
156 if (!zpodd->zp_sampled) {
157 zpodd->zp_sampled = true;
158 zpodd->last_ready = jiffies;
162 expires = zpodd->last_ready +
163 msecs_to_jiffies(zpodd_poweroff_delay * 1000);
164 if (time_before(jiffies, expires))
167 zpodd->zp_ready = true;
170 bool zpodd_zpready(struct ata_device *dev)
172 struct zpodd *zpodd = dev->zpodd;
173 return zpodd->zp_ready;
177 * Enable runtime wake capability through ACPI and set the powered_off flag,
178 * this flag will be used during resume to decide what operations are needed
181 void zpodd_enable_run_wake(struct ata_device *dev)
183 struct zpodd *zpodd = dev->zpodd;
185 zpodd->powered_off = true;
186 device_set_run_wake(&dev->sdev->sdev_gendev, true);
187 acpi_pm_device_run_wake(&dev->sdev->sdev_gendev, true);
190 /* Disable runtime wake capability if it is enabled */
191 void zpodd_disable_run_wake(struct ata_device *dev)
193 struct zpodd *zpodd = dev->zpodd;
195 if (zpodd->powered_off) {
196 acpi_pm_device_run_wake(&dev->sdev->sdev_gendev, false);
197 device_set_run_wake(&dev->sdev->sdev_gendev, false);
202 * Post power on processing after the ODD has been recovered. If the
203 * ODD wasn't powered off during suspend, it doesn't do anything.
205 * For drawer type ODD, if it is powered on due to user pressed the
206 * eject button, the tray needs to be ejected. This can only be done
207 * after the ODD has been recovered, i.e. link is initialized and
208 * device is able to process NON_DATA PIO command, as eject needs to
209 * send command for the ODD to process.
211 * The from_notify flag set in wake notification handler function
212 * zpodd_wake_dev represents if power on is due to user's action.
214 * For both types of ODD, several fields need to be reset.
216 void zpodd_post_poweron(struct ata_device *dev)
218 struct zpodd *zpodd = dev->zpodd;
220 if (!zpodd->powered_off)
223 zpodd->powered_off = false;
225 if (zpodd->from_notify) {
226 zpodd->from_notify = false;
227 if (zpodd->mech_type == ODD_MECH_TYPE_DRAWER)
231 zpodd->zp_sampled = false;
232 zpodd->zp_ready = false;
235 static void zpodd_wake_dev(acpi_handle handle, u32 event, void *context)
237 struct ata_device *ata_dev = context;
238 struct zpodd *zpodd = ata_dev->zpodd;
239 struct device *dev = &ata_dev->sdev->sdev_gendev;
241 if (event == ACPI_NOTIFY_DEVICE_WAKE && ata_dev &&
242 pm_runtime_suspended(dev)) {
243 zpodd->from_notify = true;
244 pm_runtime_resume(dev);
248 static void ata_acpi_add_pm_notifier(struct ata_device *dev)
250 acpi_handle handle = ata_dev_acpi_handle(dev);
251 acpi_install_notify_handler(handle, ACPI_SYSTEM_NOTIFY,
252 zpodd_wake_dev, dev);
255 static void ata_acpi_remove_pm_notifier(struct ata_device *dev)
257 acpi_handle handle = DEVICE_ACPI_HANDLE(&dev->sdev->sdev_gendev);
258 acpi_remove_notify_handler(handle, ACPI_SYSTEM_NOTIFY, zpodd_wake_dev);
261 void zpodd_init(struct ata_device *dev)
263 enum odd_mech_type mech_type;
269 if (!odd_can_poweroff(dev))
272 mech_type = zpodd_get_mech_type(dev);
273 if (mech_type == ODD_MECH_TYPE_UNSUPPORTED)
276 zpodd = kzalloc(sizeof(struct zpodd), GFP_KERNEL);
280 zpodd->mech_type = mech_type;
282 ata_acpi_add_pm_notifier(dev);
287 void zpodd_exit(struct ata_device *dev)
289 ata_acpi_remove_pm_notifier(dev);