/* Copyright 2012-15 Advanced Micro Devices, Inc.
 *
 * 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: AMD
 *
 */

#ifndef __DC_ABM_H__
#define __DC_ABM_H__

#include "dm_services_types.h"

struct abm_save_restore;

struct abm {
 struct dc_context *ctx;
 const struct abm_funcs *funcs;
 bool dmcu_is_running;
};

struct abm_funcs {
 void (*abm_init)(struct abm *abm, uint32_t back_light, uint32_t user_level);
 bool (*set_abm_level)(struct abm *abm, unsigned int abm_level);
 bool (*set_abm_immediate_disable)(struct abm *abm, unsigned int panel_inst);
 bool (*set_pipe)(struct abm *abm, unsigned int controller_id, unsigned int panel_inst);

 /* backlight_pwm_u16_16 is unsigned 32 bit,
  * 16 bit integer + 16 fractional, where 1.0 is max backlight value.
 */
 bool (*set_backlight_level_pwm)(struct abm *abm,
   unsigned int backlight_pwm_u16_16,
   unsigned int frame_ramp,
   unsigned int controller_id,
   unsigned int panel_inst);

 unsigned int (*get_current_backlight)(struct abm *abm);
 unsigned int (*get_target_backlight)(struct abm *abm);
 bool (*init_abm_config)(struct abm *abm,
   const char *src,
   unsigned int bytes,
   unsigned int inst);
 bool (*set_abm_pause)(struct abm *abm, bool pause, unsigned int panel_inst, unsigned int otg_inst);
 bool (*save_restore)(
   struct abm *abm,
   unsigned int panel_inst,
   struct abm_save_restore *pData);
 bool (*set_pipe_ex)(struct abm *abm,
   unsigned int otg_inst,
   unsigned int option,
   unsigned int panel_inst,
   unsigned int pwrseq_inst);
};

#endif