xref: /openbmc/linux/drivers/gpu/drm/amd/display/dc/inc/hw/abm.h (revision 6db6b729)
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_save_restore;
31 
32 struct abm {
33 	struct dc_context *ctx;
34 	const struct abm_funcs *funcs;
35 	bool dmcu_is_running;
36 };
37 
38 struct abm_funcs {
39 	void (*abm_init)(struct abm *abm, uint32_t back_light);
40 	bool (*set_abm_level)(struct abm *abm, unsigned int abm_level);
41 	bool (*set_abm_immediate_disable)(struct abm *abm, unsigned int panel_inst);
42 	bool (*set_pipe)(struct abm *abm, unsigned int controller_id, unsigned int panel_inst);
43 
44 	/* backlight_pwm_u16_16 is unsigned 32 bit,
45 	 * 16 bit integer + 16 fractional, where 1.0 is max backlight value.
46 	 */
47 	bool (*set_backlight_level_pwm)(struct abm *abm,
48 			unsigned int backlight_pwm_u16_16,
49 			unsigned int frame_ramp,
50 			unsigned int controller_id,
51 			unsigned int panel_inst);
52 
53 	unsigned int (*get_current_backlight)(struct abm *abm);
54 	unsigned int (*get_target_backlight)(struct abm *abm);
55 	bool (*init_abm_config)(struct abm *abm,
56 			const char *src,
57 			unsigned int bytes,
58 			unsigned int inst);
59 	bool (*set_abm_pause)(struct abm *abm, bool pause, unsigned int panel_inst, unsigned int otg_inst);
60 	bool (*save_restore)(
61 			struct abm *abm,
62 			unsigned int panel_inst,
63 			struct abm_save_restore *pData);
64 	bool (*set_pipe_ex)(struct abm *abm,
65 			unsigned int otg_inst,
66 			unsigned int option,
67 			unsigned int panel_inst);
68 };
69 
70 #endif
71