greybus: interface: use an enum for interface type
[cascardo/linux.git] / drivers / staging / greybus / interface.c
index c19a09c..e21491b 100644 (file)
@@ -7,12 +7,20 @@
  * Released under the GPLv2 only.
  */
 
-#include "greybus.h"
+#include <linux/delay.h>
 
+#include "greybus.h"
 #include "greybus_trace.h"
 
+#define GB_INTERFACE_MODE_SWITCH_TIMEOUT       2000
+
 #define GB_INTERFACE_DEVICE_ID_BAD     0xff
 
+#define GB_INTERFACE_AUTOSUSPEND_MS                    3000
+
+/* Time required for interface to enter standby before disabling REFCLK */
+#define GB_INTERFACE_SUSPEND_HIBERNATE_DELAY_MS                        20
+
 /* Don't-care selector index */
 #define DME_SELECTOR_INDEX_NULL                0
 
@@ -35,6 +43,8 @@
 #define TOSHIBA_ES3_APBRIDGE_DPID      0x1001
 #define TOSHIBA_ES3_GBPHY_DPID 0x1002
 
+static int gb_interface_hibernate_link(struct gb_interface *intf);
+static int gb_interface_refclk_set(struct gb_interface *intf, bool enable);
 
 static int gb_interface_dme_attr_get(struct gb_interface *intf,
                                                        u16 attr, u32 *val)
@@ -163,6 +173,174 @@ static void gb_interface_route_destroy(struct gb_interface *intf)
        intf->device_id = GB_INTERFACE_DEVICE_ID_BAD;
 }
 
+/* Locking: Caller holds the interface mutex. */
+static int gb_interface_legacy_mode_switch(struct gb_interface *intf)
+{
+       int ret;
+
+       dev_info(&intf->dev, "legacy mode switch detected\n");
+
+       /* Mark as disconnected to prevent I/O during disable. */
+       intf->disconnected = true;
+       gb_interface_disable(intf);
+       intf->disconnected = false;
+
+       ret = gb_interface_enable(intf);
+       if (ret) {
+               dev_err(&intf->dev, "failed to re-enable interface: %d\n", ret);
+               gb_interface_deactivate(intf);
+       }
+
+       return ret;
+}
+
+void gb_interface_mailbox_event(struct gb_interface *intf, u16 result,
+                                                               u32 mailbox)
+{
+       mutex_lock(&intf->mutex);
+
+       if (result) {
+               dev_warn(&intf->dev,
+                               "mailbox event with UniPro error: 0x%04x\n",
+                               result);
+               goto err_disable;
+       }
+
+       if (mailbox != GB_SVC_INTF_MAILBOX_GREYBUS) {
+               dev_warn(&intf->dev,
+                               "mailbox event with unexpected value: 0x%08x\n",
+                               mailbox);
+               goto err_disable;
+       }
+
+       if (intf->quirks & GB_INTERFACE_QUIRK_LEGACY_MODE_SWITCH) {
+               gb_interface_legacy_mode_switch(intf);
+               goto out_unlock;
+       }
+
+       if (!intf->mode_switch) {
+               dev_warn(&intf->dev, "unexpected mailbox event: 0x%08x\n",
+                               mailbox);
+               goto err_disable;
+       }
+
+       dev_info(&intf->dev, "mode switch detected\n");
+
+       complete(&intf->mode_switch_completion);
+
+out_unlock:
+       mutex_unlock(&intf->mutex);
+
+       return;
+
+err_disable:
+       gb_interface_disable(intf);
+       gb_interface_deactivate(intf);
+       mutex_unlock(&intf->mutex);
+}
+
+static void gb_interface_mode_switch_work(struct work_struct *work)
+{
+       struct gb_interface *intf;
+       struct gb_control *control;
+       unsigned long timeout;
+       int ret;
+
+       intf = container_of(work, struct gb_interface, mode_switch_work);
+
+       mutex_lock(&intf->mutex);
+       /* Make sure interface is still enabled. */
+       if (!intf->enabled) {
+               dev_dbg(&intf->dev, "mode switch aborted\n");
+               intf->mode_switch = false;
+               mutex_unlock(&intf->mutex);
+               goto out_interface_put;
+       }
+
+       /*
+        * Prepare the control device for mode switch and make sure to get an
+        * extra reference before it goes away during interface disable.
+        */
+       control = gb_control_get(intf->control);
+       gb_control_mode_switch_prepare(control);
+       gb_interface_disable(intf);
+       mutex_unlock(&intf->mutex);
+
+       timeout = msecs_to_jiffies(GB_INTERFACE_MODE_SWITCH_TIMEOUT);
+       ret = wait_for_completion_interruptible_timeout(
+                       &intf->mode_switch_completion, timeout);
+
+       /* Finalise control-connection mode switch. */
+       gb_control_mode_switch_complete(control);
+       gb_control_put(control);
+
+       if (ret < 0) {
+               dev_err(&intf->dev, "mode switch interrupted\n");
+               goto err_deactivate;
+       } else if (ret == 0) {
+               dev_err(&intf->dev, "mode switch timed out\n");
+               goto err_deactivate;
+       }
+
+       /* Re-enable (re-enumerate) interface if still active. */
+       mutex_lock(&intf->mutex);
+       intf->mode_switch = false;
+       if (intf->active) {
+               ret = gb_interface_enable(intf);
+               if (ret) {
+                       dev_err(&intf->dev, "failed to re-enable interface: %d\n",
+                                       ret);
+                       gb_interface_deactivate(intf);
+               }
+       }
+       mutex_unlock(&intf->mutex);
+
+out_interface_put:
+       gb_interface_put(intf);
+
+       return;
+
+err_deactivate:
+       mutex_lock(&intf->mutex);
+       intf->mode_switch = false;
+       gb_interface_deactivate(intf);
+       mutex_unlock(&intf->mutex);
+
+       gb_interface_put(intf);
+}
+
+int gb_interface_request_mode_switch(struct gb_interface *intf)
+{
+       int ret = 0;
+
+       mutex_lock(&intf->mutex);
+       if (intf->mode_switch) {
+               ret = -EBUSY;
+               goto out_unlock;
+       }
+
+       intf->mode_switch = true;
+       reinit_completion(&intf->mode_switch_completion);
+
+       /*
+        * Get a reference to the interface device, which will be put once the
+        * mode switch is complete.
+        */
+       get_device(&intf->dev);
+
+       if (!queue_work(system_long_wq, &intf->mode_switch_work)) {
+               put_device(&intf->dev);
+               ret = -EBUSY;
+               goto out_unlock;
+       }
+
+out_unlock:
+       mutex_unlock(&intf->mutex);
+
+       return ret;
+}
+EXPORT_SYMBOL_GPL(gb_interface_request_mode_switch);
+
 /*
  * T_TstSrcIncrement is written by the module on ES2 as a stand-in for the
  * init-status attribute DME_TOSHIBA_INIT_STATUS. The AP needs to read and
@@ -174,6 +352,7 @@ static void gb_interface_route_destroy(struct gb_interface *intf)
 static int gb_interface_read_and_clear_init_status(struct gb_interface *intf)
 {
        struct gb_host_device *hd = intf->hd;
+       unsigned long bootrom_quirks;
        int ret;
        u32 value;
        u16 attr;
@@ -217,16 +396,19 @@ static int gb_interface_read_and_clear_init_status(struct gb_interface *intf)
                init_status = value >> 24;
 
        /*
-        * Check if the interface is executing the quirky ES3 bootrom that
-        * requires E2EFC, CSD and CSV to be disabled.
+        * Check if the interface is executing the quirky ES3 bootrom that,
+        * for example, requires E2EFC, CSD and CSV to be disabled.
         */
+       bootrom_quirks = GB_INTERFACE_QUIRK_NO_CPORT_FEATURES |
+                               GB_INTERFACE_QUIRK_FORCED_DISABLE |
+                               GB_INTERFACE_QUIRK_LEGACY_MODE_SWITCH;
        switch (init_status) {
        case GB_INIT_BOOTROM_UNIPRO_BOOT_STARTED:
        case GB_INIT_BOOTROM_FALLBACK_UNIPRO_BOOT_STARTED:
-               intf->quirks |= GB_INTERFACE_QUIRK_NO_CPORT_FEATURES;
+               intf->quirks |= bootrom_quirks;
                break;
        default:
-               intf->quirks &= ~GB_INTERFACE_QUIRK_NO_CPORT_FEATURES;
+               intf->quirks &= ~bootrom_quirks;
        }
 
        /* Clear the init status. */
@@ -309,19 +491,124 @@ static ssize_t power_now_show(struct device *dev,
 }
 static DEVICE_ATTR_RO(power_now);
 
-static struct attribute *interface_attrs[] = {
+static const char *gb_interface_type_string(struct gb_interface *intf)
+{
+       static const char * const types[] = {
+               [GB_INTERFACE_TYPE_INVALID] = "invalid",
+               [GB_INTERFACE_TYPE_UNKNOWN] = "unknown",
+               [GB_INTERFACE_TYPE_DUMMY] = "dummy",
+               [GB_INTERFACE_TYPE_UNIPRO] = "unipro",
+               [GB_INTERFACE_TYPE_GREYBUS] = "greybus",
+       };
+
+       return types[intf->type];
+}
+
+static ssize_t interface_type_show(struct device *dev,
+                                  struct device_attribute *attr, char *buf)
+{
+       struct gb_interface *intf = to_gb_interface(dev);
+
+       return sprintf(buf, "%s\n", gb_interface_type_string(intf));
+}
+static DEVICE_ATTR_RO(interface_type);
+
+static struct attribute *interface_unipro_attrs[] = {
        &dev_attr_ddbl1_manufacturer_id.attr,
        &dev_attr_ddbl1_product_id.attr,
+       NULL
+};
+
+static struct attribute *interface_greybus_attrs[] = {
        &dev_attr_interface_id.attr,
        &dev_attr_vendor_id.attr,
        &dev_attr_product_id.attr,
        &dev_attr_serial_number.attr,
+       NULL
+};
+
+static struct attribute *interface_power_attrs[] = {
        &dev_attr_voltage_now.attr,
        &dev_attr_current_now.attr,
        &dev_attr_power_now.attr,
-       NULL,
+       NULL
+};
+
+static struct attribute *interface_common_attrs[] = {
+       &dev_attr_interface_type.attr,
+       NULL
+};
+
+static umode_t interface_unipro_is_visible(struct kobject *kobj,
+                                               struct attribute *attr, int n)
+{
+       struct device *dev = container_of(kobj, struct device, kobj);
+       struct gb_interface *intf = to_gb_interface(dev);
+
+       switch (intf->type) {
+       case GB_INTERFACE_TYPE_UNIPRO:
+       case GB_INTERFACE_TYPE_GREYBUS:
+               return attr->mode;
+       default:
+               return 0;
+       }
+}
+
+static umode_t interface_greybus_is_visible(struct kobject *kobj,
+                                               struct attribute *attr, int n)
+{
+       struct device *dev = container_of(kobj, struct device, kobj);
+       struct gb_interface *intf = to_gb_interface(dev);
+
+       switch (intf->type) {
+       case GB_INTERFACE_TYPE_GREYBUS:
+               return attr->mode;
+       default:
+               return 0;
+       }
+}
+
+static umode_t interface_power_is_visible(struct kobject *kobj,
+                                               struct attribute *attr, int n)
+{
+       struct device *dev = container_of(kobj, struct device, kobj);
+       struct gb_interface *intf = to_gb_interface(dev);
+
+       switch (intf->type) {
+       case GB_INTERFACE_TYPE_UNIPRO:
+       case GB_INTERFACE_TYPE_GREYBUS:
+               return attr->mode;
+       default:
+               return 0;
+       }
+}
+
+static const struct attribute_group interface_unipro_group = {
+       .is_visible     = interface_unipro_is_visible,
+       .attrs          = interface_unipro_attrs,
+};
+
+static const struct attribute_group interface_greybus_group = {
+       .is_visible     = interface_greybus_is_visible,
+       .attrs          = interface_greybus_attrs,
+};
+
+static const struct attribute_group interface_power_group = {
+       .is_visible     = interface_power_is_visible,
+       .attrs          = interface_power_attrs,
+};
+
+static const struct attribute_group interface_common_group = {
+       .attrs          = interface_common_attrs,
+};
+
+static const struct attribute_group *interface_groups[] = {
+       &interface_unipro_group,
+       &interface_greybus_group,
+       &interface_power_group,
+       &interface_common_group,
+       NULL
 };
-ATTRIBUTE_GROUPS(interface);
 
 static void gb_interface_release(struct device *dev)
 {
@@ -332,9 +619,98 @@ static void gb_interface_release(struct device *dev)
        kfree(intf);
 }
 
+#ifdef CONFIG_PM_RUNTIME
+static int gb_interface_suspend(struct device *dev)
+{
+       struct gb_interface *intf = to_gb_interface(dev);
+       int ret, timesync_ret;
+
+       ret = gb_control_interface_suspend_prepare(intf->control);
+       if (ret)
+               return ret;
+
+       gb_timesync_interface_remove(intf);
+
+       ret = gb_control_suspend(intf->control);
+       if (ret)
+               goto err_hibernate_abort;
+
+       ret = gb_interface_hibernate_link(intf);
+       if (ret)
+               return ret;
+
+       /* Delay to allow interface to enter standby before disabling refclk */
+       msleep(GB_INTERFACE_SUSPEND_HIBERNATE_DELAY_MS);
+
+       ret = gb_interface_refclk_set(intf, false);
+       if (ret)
+               return ret;
+
+       return 0;
+
+err_hibernate_abort:
+       gb_control_interface_hibernate_abort(intf->control);
+
+       timesync_ret = gb_timesync_interface_add(intf);
+       if (timesync_ret) {
+               dev_err(dev, "failed to add to timesync: %d\n", timesync_ret);
+               return timesync_ret;
+       }
+
+       return ret;
+}
+
+static int gb_interface_resume(struct device *dev)
+{
+       struct gb_interface *intf = to_gb_interface(dev);
+       struct gb_svc *svc = intf->hd->svc;
+       int ret;
+
+       ret = gb_interface_refclk_set(intf, true);
+       if (ret)
+               return ret;
+
+       ret = gb_svc_intf_resume(svc, intf->interface_id);
+       if (ret)
+               return ret;
+
+       ret = gb_control_resume(intf->control);
+       if (ret)
+               return ret;
+
+       ret = gb_timesync_interface_add(intf);
+       if (ret) {
+               dev_err(dev, "failed to add to timesync: %d\n", ret);
+               return ret;
+       }
+
+       ret = gb_timesync_schedule_synchronous(intf);
+       if (ret) {
+               dev_err(dev, "failed to synchronize FrameTime: %d\n", ret);
+               return ret;
+       }
+
+       return 0;
+}
+
+static int gb_interface_runtime_idle(struct device *dev)
+{
+       pm_runtime_mark_last_busy(dev);
+       pm_request_autosuspend(dev);
+
+       return 0;
+}
+#endif
+
+static const struct dev_pm_ops gb_interface_pm_ops = {
+       SET_RUNTIME_PM_OPS(gb_interface_suspend, gb_interface_resume,
+                          gb_interface_runtime_idle)
+};
+
 struct device_type greybus_interface_type = {
        .name =         "greybus_interface",
        .release =      gb_interface_release,
+       .pm =           &gb_interface_pm_ops,
 };
 
 /*
@@ -365,6 +741,8 @@ struct gb_interface *gb_interface_create(struct gb_module *module,
        INIT_LIST_HEAD(&intf->bundles);
        INIT_LIST_HEAD(&intf->manifest_descs);
        mutex_init(&intf->mutex);
+       INIT_WORK(&intf->mode_switch_work, gb_interface_mode_switch_work);
+       init_completion(&intf->mode_switch_completion);
 
        /* Invalid device id to start with */
        intf->device_id = GB_INTERFACE_DEVICE_ID_BAD;
@@ -378,6 +756,9 @@ struct gb_interface *gb_interface_create(struct gb_module *module,
        dev_set_name(&intf->dev, "%s.%u", dev_name(&module->dev),
                        interface_id);
 
+       pm_runtime_set_autosuspend_delay(&intf->dev,
+                                        GB_INTERFACE_AUTOSUSPEND_MS);
+
        trace_gb_interface_create(intf);
 
        return intf;
@@ -447,17 +828,20 @@ static int gb_interface_activate_operation(struct gb_interface *intf)
 
        switch (type) {
        case GB_SVC_INTF_TYPE_DUMMY:
-               dev_info(&intf->dev, "dummy interface detected\n");
+               intf->type = GB_INTERFACE_TYPE_DUMMY;
                /* FIXME: handle as an error for now */
                return -ENODEV;
        case GB_SVC_INTF_TYPE_UNIPRO:
+               intf->type = GB_INTERFACE_TYPE_UNIPRO;
                dev_err(&intf->dev, "interface type UniPro not supported\n");
                /* FIXME: check if this is a Toshiba bridge before retrying? */
                return -EAGAIN;
        case GB_SVC_INTF_TYPE_GREYBUS:
+               intf->type = GB_INTERFACE_TYPE_GREYBUS;
                break;
        default:
                dev_err(&intf->dev, "unknown interface type: %u\n", type);
+               intf->type = GB_INTERFACE_TYPE_UNKNOWN;
                return -ENODEV;
        }
 
@@ -466,11 +850,9 @@ static int gb_interface_activate_operation(struct gb_interface *intf)
 
 static int gb_interface_hibernate_link(struct gb_interface *intf)
 {
-       dev_dbg(&intf->dev, "%s\n", __func__);
-
-       /* FIXME: implement */
+       struct gb_svc *svc = intf->hd->svc;
 
-       return 0;
+       return gb_svc_intf_set_power_mode_hibernate(svc, intf->interface_id);
 }
 
 /*
@@ -539,6 +921,10 @@ void gb_interface_deactivate(struct gb_interface *intf)
 
        trace_gb_interface_deactivate(intf);
 
+       /* Abort any ongoing mode switch. */
+       if (intf->mode_switch)
+               complete(&intf->mode_switch_completion);
+
        gb_interface_route_destroy(intf);
        gb_interface_hibernate_link(intf);
        gb_interface_unipro_set(intf, false);
@@ -626,6 +1012,17 @@ int gb_interface_enable(struct gb_interface *intf)
        if (ret)
                goto err_destroy_bundles;
 
+       ret = gb_timesync_interface_add(intf);
+       if (ret) {
+               dev_err(&intf->dev, "failed to add to timesync: %d\n", ret);
+               goto err_destroy_bundles;
+       }
+
+       pm_runtime_use_autosuspend(&intf->dev);
+       pm_runtime_get_noresume(&intf->dev);
+       pm_runtime_set_active(&intf->dev);
+       pm_runtime_enable(&intf->dev);
+
        list_for_each_entry_safe_reverse(bundle, tmp, &intf->bundles, links) {
                ret = gb_bundle_add(bundle);
                if (ret) {
@@ -638,6 +1035,8 @@ int gb_interface_enable(struct gb_interface *intf)
 
        intf->enabled = true;
 
+       pm_runtime_put(&intf->dev);
+
        trace_gb_interface_enable(intf);
 
        return 0;
@@ -671,22 +1070,53 @@ void gb_interface_disable(struct gb_interface *intf)
 
        trace_gb_interface_disable(intf);
 
-       /*
-        * Disable the control-connection early to avoid operation timeouts
-        * when the interface is already gone.
-        */
-       if (intf->disconnected)
-               gb_control_disable(intf->control);
+       pm_runtime_get_sync(&intf->dev);
+
+       /* Set disconnected flag to avoid I/O during connection tear down. */
+       if (intf->quirks & GB_INTERFACE_QUIRK_FORCED_DISABLE)
+               intf->disconnected = true;
 
        list_for_each_entry_safe(bundle, next, &intf->bundles, links)
                gb_bundle_destroy(bundle);
 
+       if (!intf->mode_switch && !intf->disconnected)
+               gb_control_interface_deactivate_prepare(intf->control);
+
+       gb_timesync_interface_remove(intf);
        gb_control_del(intf->control);
        gb_control_disable(intf->control);
        gb_control_put(intf->control);
        intf->control = NULL;
 
        intf->enabled = false;
+
+       pm_runtime_disable(&intf->dev);
+       pm_runtime_set_suspended(&intf->dev);
+       pm_runtime_dont_use_autosuspend(&intf->dev);
+       pm_runtime_put_noidle(&intf->dev);
+}
+
+/* Enable TimeSync on an Interface control connection. */
+int gb_interface_timesync_enable(struct gb_interface *intf, u8 count,
+                                u64 frame_time, u32 strobe_delay, u32 refclk)
+{
+       return gb_control_timesync_enable(intf->control, count,
+                                         frame_time, strobe_delay,
+                                         refclk);
+}
+
+/* Disable TimeSync on an Interface control connection. */
+int gb_interface_timesync_disable(struct gb_interface *intf)
+{
+       return gb_control_timesync_disable(intf->control);
+}
+
+/* Transmit the Authoritative FrameTime via an Interface control connection. */
+int gb_interface_timesync_authoritative(struct gb_interface *intf,
+                                       u64 *frame_time)
+{
+       return gb_control_timesync_authoritative(intf->control,
+                                               frame_time);
 }
 
 /* Register an interface. */
@@ -702,10 +1132,22 @@ int gb_interface_add(struct gb_interface *intf)
 
        trace_gb_interface_add(intf);
 
-       dev_info(&intf->dev, "Interface added: VID=0x%08x, PID=0x%08x\n",
-                intf->vendor_id, intf->product_id);
-       dev_info(&intf->dev, "DDBL1 Manufacturer=0x%08x, Product=0x%08x\n",
-                intf->ddbl1_manufacturer_id, intf->ddbl1_product_id);
+       dev_info(&intf->dev, "Interface added (%s)\n",
+                       gb_interface_type_string(intf));
+
+       switch (intf->type) {
+       case GB_INTERFACE_TYPE_GREYBUS:
+               dev_info(&intf->dev, "Ara VID=0x%08x, PID=0x%08x\n",
+                               intf->vendor_id, intf->product_id);
+               /* fall-through */
+       case GB_INTERFACE_TYPE_UNIPRO:
+               dev_info(&intf->dev, "DDBL1 Manufacturer=0x%08x, Product=0x%08x\n",
+                               intf->ddbl1_manufacturer_id,
+                               intf->ddbl1_product_id);
+               break;
+       default:
+               break;
+       }
 
        return 0;
 }