/* * drivers/video/tegra/host/gr3d/pod_scaling.c * * Tegra Graphics Host 3D clock scaling * * Copyright (c) 2012-2016, NVIDIA CORPORATION. All rights reserved. * * This program is free software; you can redistribute it and/or modify it * under the terms and conditions of the GNU General Public License, * version 2, as published by the Free Software Foundation. * * This program is distributed in the hope it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* * Power-on-demand clock scaling for nvhost devices * * devfreq calls nvhost_pod_estimate_freq() for estimating the new * frequency for the device. The clocking is done using the load of the device * is estimated using the busy times from the device profile. This information * indicates if the device frequency should be altered. * */ #include #include #include #include #include #include #include #include #include #define CREATE_TRACE_POINTS #include #include #include #include #define GET_TARGET_FREQ_DONTSCALE 1 /* the number of frames to use in the running average of load estimates. * Choosing 6 frames targets a window of about 100 msec. Large flucutuations * in frame times require a window that's large enough to prevent spiky scaling * behavior, which in turn exacerbates frame rate instability. */ static void podgov_enable(struct devfreq *df, int enable); static void podgov_set_user_ctl(struct devfreq *df, int enable); static struct devfreq_governor nvhost_podgov; /******************************************************************************* * podgov_info_rec - gr3d scaling governor specific parameters ******************************************************************************/ struct podgov_info_rec { int enable; int init; ktime_t last_scale; struct delayed_work idle_timer; unsigned int p_slowdown_delay; unsigned int p_block_window; unsigned int p_hint_lo_limit; unsigned int p_hint_hi_limit; unsigned int p_scaleup_limit; unsigned int p_scaledown_limit; unsigned int p_smooth; int p_damp; int p_load_max; int p_load_target; int p_bias; unsigned int p_user; unsigned int p_freq_request; long idle; int adjustment_type; unsigned long adjustment_frequency; int last_event_type; struct devfreq *power_manager; struct dentry *debugdir; unsigned long *freqlist; int freq_count; unsigned int idle_avg; int freq_avg; unsigned int hint_avg; int block; struct kobj_attribute enable_3d_scaling_attr; struct kobj_attribute user_attr; struct kobj_attribute freq_request_attr; }; /******************************************************************************* * Adjustment type is used to tell the source that requested frequency re- * estimation. Type ADJUSTMENT_LOCAL indicates that the re-estimation was * initiated by the governor itself. This happens when one of the worker * threads want to adjust the frequency. * * ADJUSTMENT_DEVICE_REQ (default value) indicates that the adjustment was * initiated by a device event. ******************************************************************************/ enum podgov_adjustment_type { ADJUSTMENT_LOCAL = 0, ADJUSTMENT_DEVICE_REQ = 1 }; static void stop_podgov_workers(struct podgov_info_rec *podgov) { /* idle_timer can rearm itself */ do { cancel_delayed_work_sync(&podgov->idle_timer); } while (delayed_work_pending(&podgov->idle_timer)); } /******************************************************************************* * scaling_limit(df, freq) * * Limit the given frequency ******************************************************************************/ static void scaling_limit(struct devfreq *df, unsigned long *freq) { if (*freq < df->min_freq) *freq = df->min_freq; else if (*freq > df->max_freq) *freq = df->max_freq; } /******************************************************************************* * nvhost_pod_suspend(dev) * * Prepare the device for suspend ******************************************************************************/ static void nvhost_pod_suspend(struct devfreq *df) { struct podgov_info_rec *podgov; mutex_lock(&df->lock); podgov = df->data; if (!(df->governor == &nvhost_podgov && podgov && podgov->enable)) { mutex_unlock(&df->lock); return; } mutex_unlock(&df->lock); stop_podgov_workers(podgov); } /******************************************************************************* * podgov_enable(dev, enable) * * This function enables (enable=1) or disables (enable=0) the automatic scaling * of the device. If the device is disabled, the device's clock is set to its * maximum. ******************************************************************************/ static void podgov_enable(struct devfreq *df, int enable) { struct device *dev = df->dev.parent; struct podgov_info_rec *podgov; /* make sure the device is alive before doing any scaling */ pm_runtime_get_noresume(dev); mutex_lock(&df->lock); podgov = df->data; trace_podgov_enabled(df->dev.parent, enable); /* bad configuration. quit. */ if (df->min_freq == df->max_freq) goto exit_unlock; /* store the enable information */ podgov->enable = enable; /* skip local adjustment if we are enabling or the device is * suspended */ if (enable || !pm_runtime_active(dev)) goto exit_unlock; /* full speed */ podgov->adjustment_frequency = df->max_freq; podgov->adjustment_type = ADJUSTMENT_LOCAL; update_devfreq(df); mutex_unlock(&df->lock); pm_runtime_put(dev); stop_podgov_workers(podgov); return; exit_unlock: mutex_unlock(&df->lock); pm_runtime_put(dev); } /***************************************************************************** * podgov_set_user_ctl(dev, user) * * This function enables or disables user control of the gpu. If user control * is enabled, setting the freq_request controls the gpu frequency, and other * gpu scaling mechanisms are disabled. ******************************************************************************/ static void podgov_set_user_ctl(struct devfreq *df, int user) { struct device *dev = df->dev.parent; struct podgov_info_rec *podgov; int old_user; /* make sure the device is alive before doing any scaling */ pm_runtime_get_noresume(dev); mutex_lock(&df->lock); podgov = df->data; trace_podgov_set_user_ctl(df->dev.parent, user); /* store the new user value */ old_user = podgov->p_user; podgov->p_user = user; /* skip scaling, if scaling (or the whole device) is turned off * - or the scaling already was in user mode */ if (!pm_runtime_active(dev) || !podgov->enable || !(user && !old_user)) goto exit_unlock; /* write request */ podgov->adjustment_frequency = podgov->p_freq_request; podgov->adjustment_type = ADJUSTMENT_LOCAL; update_devfreq(df); mutex_unlock(&df->lock); pm_runtime_put(dev); stop_podgov_workers(podgov); return; exit_unlock: mutex_unlock(&df->lock); pm_runtime_put(dev); } /***************************************************************************** * podgov_set_freq_request(dev, user) * * Set the current freq request. If scaling is enabled, and podgov user space * control is enabled, this will set the gpu frequency. ******************************************************************************/ static void podgov_set_freq_request(struct devfreq *df, int freq_request) { struct device *dev = df->dev.parent; struct podgov_info_rec *podgov; /* make sure the device is alive before doing any scaling */ pm_runtime_get_noresume(dev); mutex_lock(&df->lock); podgov = df->data; trace_podgov_set_freq_request(df->dev.parent, freq_request); podgov->p_freq_request = freq_request; /* update the request only if podgov is enabled, device is turned on * and the scaling is in user mode */ if (podgov->enable && podgov->p_user && pm_runtime_active(dev)) { podgov->adjustment_frequency = freq_request; podgov->adjustment_type = ADJUSTMENT_LOCAL; update_devfreq(df); } mutex_unlock(&df->lock); pm_runtime_put(dev); } /******************************************************************************* * freq = scaling_state_check(df, time) * * This handler is called to adjust the frequency of the device. The function * returns the desired frequency for the clock. If there is no need to tune the * clock immediately, 0 is returned. ******************************************************************************/ static unsigned long scaling_state_check(struct devfreq *df, ktime_t time) { struct podgov_info_rec *podgov = df->data; unsigned long dt; long max_boost, load, damp, freq, boost, res; dt = (unsigned long) ktime_us_delta(time, podgov->last_scale); if (dt < podgov->p_block_window || df->previous_freq == 0) return 0; /* convert to mhz to avoid overflow */ freq = df->previous_freq / 1000000; max_boost = (df->max_freq/3) / 1000000; /* calculate and trace load */ load = 1000 - podgov->idle_avg; trace_podgov_busy(df->dev.parent, load); damp = podgov->p_damp; if ((1000 - podgov->idle) > podgov->p_load_max) { /* if too busy, scale up max/3, do not damp */ boost = max_boost; damp = 10; } else { /* boost = bias * freq * (load - target)/target */ boost = (load - podgov->p_load_target); boost *= (podgov->p_bias * freq); boost /= (100 * podgov->p_load_target); /* clamp to max boost */ boost = (boost < max_boost) ? boost : max_boost; } /* calculate new request */ res = freq + boost; /* Maintain average request */ podgov->freq_avg = (podgov->freq_avg * podgov->p_smooth) + res; podgov->freq_avg /= (podgov->p_smooth+1); /* Applying damping to frequencies */ res = ((damp * res) + ((10 - damp)*podgov->freq_avg)) / 10; /* Convert to hz, limit, and apply */ res = res * 1000000; scaling_limit(df, &res); trace_podgov_scaling_state_check(df->dev.parent, df->previous_freq, res); return res; } /******************************************************************************* * freqlist_up(podgov, target, steps) * * This function determines the frequency that is "steps" frequency steps * higher compared to the target frequency. ******************************************************************************/ static int freqlist_up(struct podgov_info_rec *podgov, unsigned long target, int steps) { int i, pos; for (i = 0; i < podgov->freq_count; i++) if (podgov->freqlist[i] >= target) break; pos = min(podgov->freq_count - 1, i + steps); return podgov->freqlist[pos]; } /******************************************************************************* * podgov_idle_handler(work) * * This handler is called after the device has been idle long enough. This * handler forms a (positive) feedback loop by notifying idle to the device. ******************************************************************************/ static void podgov_idle_handler(struct work_struct *work) { struct delayed_work *idle_timer = container_of(work, struct delayed_work, work); struct podgov_info_rec *podgov = container_of(idle_timer, struct podgov_info_rec, idle_timer); struct devfreq *df = podgov->power_manager; mutex_lock(&df->lock); if (!podgov->enable) { mutex_unlock(&df->lock); return; } if (!podgov->last_event_type && df->previous_freq > df->min_freq && podgov->p_user == false) update_devfreq(df); mutex_unlock(&df->lock); } /******************************************************************************* * debugfs interface for controlling 3d clock scaling on the fly ******************************************************************************/ #ifdef CONFIG_DEBUG_FS static void nvhost_scale_emc_debug_init(struct devfreq *df) { struct podgov_info_rec *podgov = df->data; struct dentry *f; char dirname[128]; snprintf(dirname, sizeof(dirname), "%s_scaling", to_platform_device(df->dev.parent)->name); if (!podgov) return; podgov->debugdir = debugfs_create_dir(dirname, NULL); if (!podgov->debugdir) { pr_err("podgov: can\'t create debugfs directory\n"); return; } #define CREATE_PODGOV_FILE(fname) \ do {\ f = debugfs_create_u32(#fname, S_IRUGO | S_IWUSR, \ podgov->debugdir, &podgov->p_##fname); \ if (NULL == f) { \ pr_err("podgov: can\'t create file " #fname "\n"); \ return; \ } \ } while (0) CREATE_PODGOV_FILE(block_window); CREATE_PODGOV_FILE(load_max); CREATE_PODGOV_FILE(load_target); CREATE_PODGOV_FILE(bias); CREATE_PODGOV_FILE(damp); CREATE_PODGOV_FILE(hint_hi_limit); CREATE_PODGOV_FILE(hint_lo_limit); CREATE_PODGOV_FILE(scaleup_limit); CREATE_PODGOV_FILE(scaledown_limit); CREATE_PODGOV_FILE(smooth); CREATE_PODGOV_FILE(slowdown_delay); #undef CREATE_PODGOV_FILE } static void nvhost_scale_emc_debug_deinit(struct devfreq *df) { struct podgov_info_rec *podgov = df->data; debugfs_remove_recursive(podgov->debugdir); } #else static void nvhost_scale_emc_debug_init(struct devfreq *df) { (void)df; } static void nvhost_scale_emc_debug_deinit(struct devfreq *df) { (void)df; } #endif /******************************************************************************* * sysfs interface for enabling/disabling 3d scaling ******************************************************************************/ static ssize_t enable_3d_scaling_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf) { struct podgov_info_rec *podgov = container_of(attr, struct podgov_info_rec, enable_3d_scaling_attr); ssize_t res; res = snprintf(buf, PAGE_SIZE, "%d\n", podgov->enable); return res; } static ssize_t enable_3d_scaling_store(struct kobject *kobj, struct kobj_attribute *attr, const char *buf, size_t count) { struct podgov_info_rec *podgov = container_of(attr, struct podgov_info_rec, enable_3d_scaling_attr); unsigned long val = 0; if (kstrtoul(buf, 10, &val) < 0) return -EINVAL; podgov_enable(podgov->power_manager, val); return count; } /******************************************************************************* * sysfs interface for user space control * user = [0,1] disables / enabled user space control * freq_request is the sysfs node user space writes frequency requests to ******************************************************************************/ static ssize_t user_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf) { struct podgov_info_rec *podgov = container_of(attr, struct podgov_info_rec, user_attr); ssize_t res; res = snprintf(buf, PAGE_SIZE, "%d\n", podgov->p_user); return res; } static ssize_t user_store(struct kobject *kobj, struct kobj_attribute *attr, const char *buf, size_t count) { struct podgov_info_rec *podgov = container_of(attr, struct podgov_info_rec, user_attr); unsigned long val = 0; if (kstrtoul(buf, 10, &val) < 0) return -EINVAL; podgov_set_user_ctl(podgov->power_manager, val); return count; } static ssize_t freq_request_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf) { struct podgov_info_rec *podgov = container_of(attr, struct podgov_info_rec, freq_request_attr); ssize_t res; res = snprintf(buf, PAGE_SIZE, "%d\n", podgov->p_freq_request); return res; } static ssize_t freq_request_store(struct kobject *kobj, struct kobj_attribute *attr, const char *buf, size_t count) { struct podgov_info_rec *podgov = container_of(attr, struct podgov_info_rec, freq_request_attr); unsigned long val = 0; if (kstrtoul(buf, 10, &val) < 0) return -EINVAL; podgov_set_freq_request(podgov->power_manager, val); return count; } /******************************************************************************* * nvhost_pod_estimate_freq(df, freq) * * This function is called for re-estimating the frequency. The function is * called in three conditions: * * (1) Internal request to change the frequency. In this case a new clock * target is immediately set for the device. * (2) Call from the client (something has happened and re-estimation * is required). * (3) Some other reason (i.e. periodic call) * ******************************************************************************/ static int nvhost_pod_estimate_freq(struct devfreq *df, unsigned long *freq) { struct podgov_info_rec *podgov = df->data; struct devfreq_dev_status dev_stat; int stat; ktime_t now; /* Ensure maximal clock when scaling is disabled */ if (!podgov->enable) { *freq = df->max_freq; if (*freq == df->previous_freq) return GET_TARGET_FREQ_DONTSCALE; else return 0; } if (podgov->p_user) { *freq = podgov->p_freq_request; return 0; } stat = df->profile->get_dev_status(df->dev.parent, &dev_stat); if (stat < 0) return stat; if (dev_stat.total_time == 0) { *freq = dev_stat.current_frequency; return 0; } stat = 0; now = ktime_get(); /* Local adjustments (i.e. requests from kernel threads) are * handled here */ if (podgov->adjustment_type == ADJUSTMENT_LOCAL) { podgov->adjustment_type = ADJUSTMENT_DEVICE_REQ; /* Do not do unnecessary scaling */ scaling_limit(df, &podgov->adjustment_frequency); trace_podgov_estimate_freq(df->dev.parent, df->previous_freq, podgov->adjustment_frequency); *freq = podgov->adjustment_frequency; return 0; } *freq = dev_stat.current_frequency; /* Sustain local variables */ podgov->last_event_type = dev_stat.busy; podgov->idle = 1000 * (dev_stat.total_time - dev_stat.busy_time); podgov->idle = podgov->idle / dev_stat.total_time; podgov->idle_avg = (podgov->p_smooth * podgov->idle_avg) + podgov->idle; podgov->idle_avg = podgov->idle_avg / (podgov->p_smooth + 1); if (dev_stat.busy) { cancel_delayed_work(&podgov->idle_timer); *freq = scaling_state_check(df, now); } else { /* Launch a work to slowdown the gpu */ *freq = scaling_state_check(df, now); schedule_delayed_work(&podgov->idle_timer, msecs_to_jiffies(podgov->p_slowdown_delay)); } if (!(*freq)) *freq = dev_stat.current_frequency; if (freqlist_up(podgov, *freq, 0) == dev_stat.current_frequency) return 0; podgov->last_scale = now; trace_podgov_estimate_freq(df->dev.parent, df->previous_freq, *freq); return 0; } /******************************************************************************* * nvhost_pod_init(struct devfreq *df) * * Governor initialisation. ******************************************************************************/ static int nvhost_pod_init(struct devfreq *df) { struct podgov_info_rec *podgov; struct platform_device *d = to_platform_device(df->dev.parent); ktime_t now = ktime_get(); enum tegra_chipid cid = tegra_get_chipid(); struct devfreq_dev_status dev_stat; int stat = 0; struct kobj_attribute *attr = NULL; podgov = kzalloc(sizeof(struct podgov_info_rec), GFP_KERNEL); if (!podgov) goto err_alloc_podgov; df->data = (void *)podgov; /* Initialise workers */ INIT_DELAYED_WORK(&podgov->idle_timer, podgov_idle_handler); /* Set scaling parameter defaults */ podgov->enable = 1; podgov->block = 0; if (!strcmp(d->name, "vic03.0")) { podgov->p_load_max = 990; podgov->p_load_target = 250; podgov->p_bias = 80; podgov->p_hint_lo_limit = 500; podgov->p_hint_hi_limit = 997; podgov->p_scaleup_limit = 1100; podgov->p_scaledown_limit = 1300; podgov->p_smooth = 60; podgov->p_damp = 2; } else { switch (cid) { case TEGRA_CHIPID_TEGRA14: case TEGRA_CHIPID_TEGRA11: case TEGRA_CHIPID_TEGRA12: case TEGRA_CHIPID_TEGRA13: case TEGRA_CHIPID_TEGRA21: case TEGRA_CHIPID_TEGRA18: podgov->p_load_max = 900; podgov->p_load_target = 700; podgov->p_bias = 80; podgov->p_hint_lo_limit = 500; podgov->p_hint_hi_limit = 997; podgov->p_scaleup_limit = 1100; podgov->p_scaledown_limit = 1300; podgov->p_smooth = 10; podgov->p_damp = 7; break; default: pr_err("%s: un-supported chip id\n", __func__); goto err_unsupported_chip_id; break; } } podgov->p_slowdown_delay = 10; podgov->p_block_window = 50000; podgov->adjustment_type = ADJUSTMENT_DEVICE_REQ; podgov->p_user = 0; /* Reset clock counters */ podgov->last_scale = now; podgov->power_manager = df; /* Get the current status of the device */ stat = df->profile->get_dev_status(df->dev.parent, &dev_stat); attr = &podgov->enable_3d_scaling_attr; attr->attr.name = "enable_3d_scaling"; attr->attr.mode = S_IWUSR | S_IRUGO; attr->show = enable_3d_scaling_show; attr->store = enable_3d_scaling_store; sysfs_attr_init(&attr->attr); if (sysfs_create_file(&df->dev.parent->kobj, &attr->attr)) goto err_create_enable_sysfs_entry; attr = &podgov->freq_request_attr; attr->attr.name = "freq_request"; attr->attr.mode = S_IWUSR | S_IRUGO; attr->show = freq_request_show; attr->store = freq_request_store; sysfs_attr_init(&attr->attr); if (sysfs_create_file(&df->dev.parent->kobj, &attr->attr)) goto err_create_request_sysfs_entry; attr = &podgov->user_attr; attr->attr.name = "user"; attr->attr.mode = S_IWUSR | S_IRUGO; attr->show = user_show; attr->store = user_store; sysfs_attr_init(&attr->attr); if (sysfs_create_file(&df->dev.parent->kobj, &attr->attr)) goto err_create_user_sysfs_entry; podgov->freq_count = df->profile->max_state; podgov->freqlist = df->profile->freq_table; if (!podgov->freq_count || !podgov->freqlist) goto err_get_freqs; /* store the limits */ df->min_freq = podgov->freqlist[0]; df->max_freq = podgov->freqlist[podgov->freq_count - 1]; podgov->p_freq_request = df->max_freq; podgov->idle_avg = 0; podgov->freq_avg = 0; podgov->hint_avg = 0; nvhost_scale_emc_debug_init(df); return 0; err_get_freqs: sysfs_remove_file(&df->dev.parent->kobj, &podgov->user_attr.attr); err_create_user_sysfs_entry: sysfs_remove_file(&df->dev.parent->kobj, &podgov->freq_request_attr.attr); err_create_request_sysfs_entry: sysfs_remove_file(&df->dev.parent->kobj, &podgov->enable_3d_scaling_attr.attr); err_create_enable_sysfs_entry: dev_err(&d->dev, "failed to create sysfs attributes"); err_unsupported_chip_id: kfree(podgov); err_alloc_podgov: return -ENOMEM; } /******************************************************************************* * nvhost_pod_exit(struct devfreq *df) * * Clean up governor data structures ******************************************************************************/ static void nvhost_pod_exit(struct devfreq *df) { struct podgov_info_rec *podgov = df->data; cancel_delayed_work(&podgov->idle_timer); sysfs_remove_file(&df->dev.parent->kobj, &podgov->user_attr.attr); sysfs_remove_file(&df->dev.parent->kobj, &podgov->freq_request_attr.attr); sysfs_remove_file(&df->dev.parent->kobj, &podgov->enable_3d_scaling_attr.attr); nvhost_scale_emc_debug_deinit(df); kfree(podgov); } static int nvhost_pod_event_handler(struct devfreq *df, unsigned int event, void *data) { int ret = 0; switch (event) { case DEVFREQ_GOV_START: ret = nvhost_pod_init(df); break; case DEVFREQ_GOV_STOP: nvhost_pod_exit(df); break; case DEVFREQ_GOV_SUSPEND: nvhost_pod_suspend(df); break; default: break; } return ret; } static struct devfreq_governor nvhost_podgov = { .name = "nvhost_podgov", .get_target_freq = nvhost_pod_estimate_freq, .event_handler = nvhost_pod_event_handler, }; static int __init podgov_init(void) { return devfreq_add_governor(&nvhost_podgov); } static void __exit podgov_exit(void) { devfreq_remove_governor(&nvhost_podgov); return; } /* governor must be registered before initialising client devices */ rootfs_initcall(podgov_init); module_exit(podgov_exit); MODULE_LICENSE("GPL");