/*
 * Copyright 2012 The Nouveau community
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Authors: Martin Peres
 */
#include "priv.h"

static void
nvkm_therm_temp_set_defaults(struct nvkm_therm *therm)
{
 therm->bios_sensor.offset_constant = 0;

 therm->bios_sensor.thrs_fan_boost.temp = 90;
 therm->bios_sensor.thrs_fan_boost.hysteresis = 3;

 therm->bios_sensor.thrs_down_clock.temp = 95;
 therm->bios_sensor.thrs_down_clock.hysteresis = 3;

 therm->bios_sensor.thrs_critical.temp = 105;
 therm->bios_sensor.thrs_critical.hysteresis = 5;

 therm->bios_sensor.thrs_shutdown.temp = 135;
 therm->bios_sensor.thrs_shutdown.hysteresis = 5; /*not that it matters */
}

static void
nvkm_therm_temp_safety_checks(struct nvkm_therm *therm)
{
 struct nvbios_therm_sensor *s = &therm->bios_sensor;

 /* enforce a minimum hysteresis on thresholds */
 s->thrs_fan_boost.hysteresis = max_t(u8, s->thrs_fan_boost.hysteresis, 2);
 s->thrs_down_clock.hysteresis = max_t(u8, s->thrs_down_clock.hysteresis, 2);
 s->thrs_critical.hysteresis = max_t(u8, s->thrs_critical.hysteresis, 2);
 s->thrs_shutdown.hysteresis = max_t(u8, s->thrs_shutdown.hysteresis, 2);
}

/* must be called with alarm_program_lock taken ! */
void
nvkm_therm_sensor_set_threshold_state(struct nvkm_therm *therm,
          enum nvkm_therm_thrs thrs,
          enum nvkm_therm_thrs_state st)
{
 therm->sensor.alarm_state[thrs] = st;
}

/* must be called with alarm_program_lock taken ! */
enum nvkm_therm_thrs_state
nvkm_therm_sensor_get_threshold_state(struct nvkm_therm *therm,
          enum nvkm_therm_thrs thrs)
{
 return therm->sensor.alarm_state[thrs];
}

static void
nv_poweroff_work(struct work_struct *work)
{
 orderly_poweroff(true);
 kfree(work);
}

void
nvkm_therm_sensor_event(struct nvkm_therm *therm, enum nvkm_therm_thrs thrs,
   enum nvkm_therm_thrs_direction dir)
{
 struct nvkm_subdev *subdev = &therm->subdev;
 bool active;
 static const char * const thresholds[] = {
  "fanboost", "downclock", "critical", "shutdown"
 };
 int temperature = therm->func->temp_get(therm);

 if (thrs < 0 || thrs > 3)
  return;

 if (dir == NVKM_THERM_THRS_FALLING)
  nvkm_info(subdev,
     "temperature (%i C) went below the '%s' threshold\n",
     temperature, thresholds[thrs]);
 else
  nvkm_info(subdev, "temperature (%i C) hit the '%s' threshold\n",
     temperature, thresholds[thrs]);

 active = (dir == NVKM_THERM_THRS_RISING);
 switch (thrs) {
 case NVKM_THERM_THRS_FANBOOST:
  if (active) {
   nvkm_therm_fan_set(therm, true, 100);
   nvkm_therm_fan_mode(therm, NVKM_THERM_CTRL_AUTO);
  }
  break;
 case NVKM_THERM_THRS_DOWNCLOCK:
  if (therm->emergency.downclock)
   therm->emergency.downclock(therm, active);
  break;
 case NVKM_THERM_THRS_CRITICAL:
  if (therm->emergency.pause)
   therm->emergency.pause(therm, active);
  break;
 case NVKM_THERM_THRS_SHUTDOWN:
  if (active) {
   struct work_struct *work;

   work = kmalloc(sizeof(*work), GFP_ATOMIC);
   if (work) {
    INIT_WORK(work, nv_poweroff_work);
    schedule_work(work);
   }
  }
  break;
 case NVKM_THERM_THRS_NR:
  break;
 }

}

/* must be called with alarm_program_lock taken ! */
static void
nvkm_therm_threshold_hyst_polling(struct nvkm_therm *therm,
      const struct nvbios_therm_threshold *thrs,
      enum nvkm_therm_thrs thrs_name)
{
 enum nvkm_therm_thrs_direction direction;
 enum nvkm_therm_thrs_state prev_state, new_state;
 int temp = therm->func->temp_get(therm);

 prev_state = nvkm_therm_sensor_get_threshold_state(therm, thrs_name);

 if (temp >= thrs->temp && prev_state == NVKM_THERM_THRS_LOWER) {
  direction = NVKM_THERM_THRS_RISING;
  new_state = NVKM_THERM_THRS_HIGHER;
 } else if (temp <= thrs->temp - thrs->hysteresis &&
   prev_state == NVKM_THERM_THRS_HIGHER) {
  direction = NVKM_THERM_THRS_FALLING;
  new_state = NVKM_THERM_THRS_LOWER;
 } else
  return; /* nothing to do */

 nvkm_therm_sensor_set_threshold_state(therm, thrs_name, new_state);
 nvkm_therm_sensor_event(therm, thrs_name, direction);
}

static void
alarm_timer_callback(struct nvkm_alarm *alarm)
{
 struct nvkm_therm *therm =
  container_of(alarm, struct nvkm_therm, sensor.therm_poll_alarm);
 struct nvbios_therm_sensor *sensor = &therm->bios_sensor;
 struct nvkm_timer *tmr = therm->subdev.device->timer;
 unsigned long flags;

 spin_lock_irqsave(&therm->sensor.alarm_program_lock, flags);

 nvkm_therm_threshold_hyst_polling(therm, &sensor->thrs_fan_boost,
       NVKM_THERM_THRS_FANBOOST);

 nvkm_therm_threshold_hyst_polling(therm,
       &sensor->thrs_down_clock,
       NVKM_THERM_THRS_DOWNCLOCK);

 nvkm_therm_threshold_hyst_polling(therm, &sensor->thrs_critical,
       NVKM_THERM_THRS_CRITICAL);

 nvkm_therm_threshold_hyst_polling(therm, &sensor->thrs_shutdown,
       NVKM_THERM_THRS_SHUTDOWN);

 spin_unlock_irqrestore(&therm->sensor.alarm_program_lock, flags);

 /* schedule the next poll in one second */
 if (therm->func->temp_get(therm) >= 0)
  nvkm_timer_alarm(tmr, 1000000000ULL, alarm);
}

void
nvkm_therm_program_alarms_polling(struct nvkm_therm *therm)
{
 struct nvbios_therm_sensor *sensor = &therm->bios_sensor;

 nvkm_debug(&therm->subdev,
     "programmed thresholds [ %d(%d), %d(%d), %d(%d), %d(%d) ]\n",
     sensor->thrs_fan_boost.temp,
     sensor->thrs_fan_boost.hysteresis,
     sensor->thrs_down_clock.temp,
     sensor->thrs_down_clock.hysteresis,
     sensor->thrs_critical.temp,
     sensor->thrs_critical.hysteresis,
     sensor->thrs_shutdown.temp,
     sensor->thrs_shutdown.hysteresis);

 alarm_timer_callback(&therm->sensor.therm_poll_alarm);
}

int
nvkm_therm_sensor_init(struct nvkm_therm *therm)
{
 therm->func->program_alarms(therm);
 return 0;
}

int
nvkm_therm_sensor_fini(struct nvkm_therm *therm, bool suspend)
{
 struct nvkm_timer *tmr = therm->subdev.device->timer;
 if (suspend)
  nvkm_timer_alarm(tmr, 0, &therm->sensor.therm_poll_alarm);
 return 0;
}

void
nvkm_therm_sensor_preinit(struct nvkm_therm *therm)
{
 const char *sensor_avail = "yes";

 if (therm->func->temp_get(therm) < 0)
  sensor_avail = "no";

 nvkm_debug(&therm->subdev, "internal sensor: %s\n", sensor_avail);
}

int
nvkm_therm_sensor_ctor(struct nvkm_therm *therm)
{
 struct nvkm_subdev *subdev = &therm->subdev;
 struct nvkm_bios *bios = subdev->device->bios;

 nvkm_alarm_init(&therm->sensor.therm_poll_alarm, alarm_timer_callback);

 nvkm_therm_temp_set_defaults(therm);
 if (nvbios_therm_sensor_parse(bios, NVBIOS_THERM_DOMAIN_CORE,
          &therm->bios_sensor))
  nvkm_error(subdev, "nvbios_therm_sensor_parse failed\n");
 nvkm_therm_temp_safety_checks(therm);

 return 0;
}