xref: /openbmc/linux/drivers/gpu/drm/amd/display/dc/inc/hw/abm.h (revision 09b35b41)
1 /* Copyright 2012-15 Advanced Micro Devices, Inc.
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining a
4  * copy of this software and associated documentation files (the "Software"),
5  * to deal in the Software without restriction, including without limitation
6  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
7  * and/or sell copies of the Software, and to permit persons to whom the
8  * Software is furnished to do so, subject to the following conditions:
9  *
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
16  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
17  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
18  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
19  * OTHER DEALINGS IN THE SOFTWARE.
20  *
21  * Authors: AMD
22  *
23  */
24 
25 #ifndef __DC_ABM_H__
26 #define __DC_ABM_H__
27 
28 #include "dm_services_types.h"
29 
30 struct abm_backlight_registers {
31 	unsigned int BL_PWM_CNTL;
32 	unsigned int BL_PWM_CNTL2;
33 	unsigned int BL_PWM_PERIOD_CNTL;
34 	unsigned int LVTMA_PWRSEQ_REF_DIV_BL_PWM_REF_DIV;
35 };
36 
37 struct abm {
38 	struct dc_context *ctx;
39 	const struct abm_funcs *funcs;
40 	bool dmcu_is_running;
41 	/* registers setting needs to be saved and restored at InitBacklight */
42 	struct abm_backlight_registers stored_backlight_registers;
43 };
44 
45 struct abm_funcs {
46 	void (*abm_init)(struct abm *abm);
47 	bool (*set_abm_level)(struct abm *abm, unsigned int abm_level);
48 	bool (*set_abm_immediate_disable)(struct abm *abm);
49 	bool (*set_pipe)(struct abm *abm, unsigned int controller_id);
50 	bool (*init_backlight)(struct abm *abm);
51 
52 	/* backlight_pwm_u16_16 is unsigned 32 bit,
53 	 * 16 bit integer + 16 fractional, where 1.0 is max backlight value.
54 	 */
55 	bool (*set_backlight_level_pwm)(struct abm *abm,
56 			unsigned int backlight_pwm_u16_16,
57 			unsigned int frame_ramp,
58 			unsigned int controller_id,
59 			bool use_smooth_brightness);
60 
61 	unsigned int (*get_current_backlight)(struct abm *abm);
62 	unsigned int (*get_target_backlight)(struct abm *abm);
63 };
64 
65 #endif
66