xref: /dflybsd-src/sys/dev/drm/amd/display/include/i2caux_interface.h (revision b843c749addef9340ee7d4e250b09fdd492602a1)
1*b843c749SSergey Zigachev /*
2*b843c749SSergey Zigachev  * Copyright 2012-15 Advanced Micro Devices, Inc.
3*b843c749SSergey Zigachev  *
4*b843c749SSergey Zigachev  * Permission is hereby granted, free of charge, to any person obtaining a
5*b843c749SSergey Zigachev  * copy of this software and associated documentation files (the "Software"),
6*b843c749SSergey Zigachev  * to deal in the Software without restriction, including without limitation
7*b843c749SSergey Zigachev  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8*b843c749SSergey Zigachev  * and/or sell copies of the Software, and to permit persons to whom the
9*b843c749SSergey Zigachev  * Software is furnished to do so, subject to the following conditions:
10*b843c749SSergey Zigachev  *
11*b843c749SSergey Zigachev  * The above copyright notice and this permission notice shall be included in
12*b843c749SSergey Zigachev  * all copies or substantial portions of the Software.
13*b843c749SSergey Zigachev  *
14*b843c749SSergey Zigachev  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15*b843c749SSergey Zigachev  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16*b843c749SSergey Zigachev  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17*b843c749SSergey Zigachev  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18*b843c749SSergey Zigachev  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19*b843c749SSergey Zigachev  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20*b843c749SSergey Zigachev  * OTHER DEALINGS IN THE SOFTWARE.
21*b843c749SSergey Zigachev  *
22*b843c749SSergey Zigachev  * Authors: AMD
23*b843c749SSergey Zigachev  *
24*b843c749SSergey Zigachev  */
25*b843c749SSergey Zigachev 
26*b843c749SSergey Zigachev #ifndef __DAL_I2CAUX_INTERFACE_H__
27*b843c749SSergey Zigachev #define __DAL_I2CAUX_INTERFACE_H__
28*b843c749SSergey Zigachev 
29*b843c749SSergey Zigachev #include "dc_types.h"
30*b843c749SSergey Zigachev #include "gpio_service_interface.h"
31*b843c749SSergey Zigachev 
32*b843c749SSergey Zigachev 
33*b843c749SSergey Zigachev #define DEFAULT_AUX_MAX_DATA_SIZE 16
34*b843c749SSergey Zigachev #define AUX_MAX_DEFER_WRITE_RETRY 20
35*b843c749SSergey Zigachev 
36*b843c749SSergey Zigachev struct aux_payload {
37*b843c749SSergey Zigachev 	/* set following flag to read/write I2C data,
38*b843c749SSergey Zigachev 	 * reset it to read/write DPCD data */
39*b843c749SSergey Zigachev 	bool i2c_over_aux;
40*b843c749SSergey Zigachev 	/* set following flag to write data,
41*b843c749SSergey Zigachev 	 * reset it to read data */
42*b843c749SSergey Zigachev 	bool write;
43*b843c749SSergey Zigachev 	uint32_t address;
44*b843c749SSergey Zigachev 	uint8_t length;
45*b843c749SSergey Zigachev 	uint8_t *data;
46*b843c749SSergey Zigachev };
47*b843c749SSergey Zigachev 
48*b843c749SSergey Zigachev struct aux_command {
49*b843c749SSergey Zigachev 	struct aux_payload *payloads;
50*b843c749SSergey Zigachev 	uint8_t number_of_payloads;
51*b843c749SSergey Zigachev 
52*b843c749SSergey Zigachev 	/* expressed in milliseconds
53*b843c749SSergey Zigachev 	 * zero means "use default value" */
54*b843c749SSergey Zigachev 	uint32_t defer_delay;
55*b843c749SSergey Zigachev 
56*b843c749SSergey Zigachev 	/* zero means "use default value" */
57*b843c749SSergey Zigachev 	uint32_t max_defer_write_retry;
58*b843c749SSergey Zigachev 
59*b843c749SSergey Zigachev 	enum i2c_mot_mode mot;
60*b843c749SSergey Zigachev };
61*b843c749SSergey Zigachev 
62*b843c749SSergey Zigachev union aux_config {
63*b843c749SSergey Zigachev 	struct {
64*b843c749SSergey Zigachev 		uint32_t ALLOW_AUX_WHEN_HPD_LOW:1;
65*b843c749SSergey Zigachev 	} bits;
66*b843c749SSergey Zigachev 	uint32_t raw;
67*b843c749SSergey Zigachev };
68*b843c749SSergey Zigachev 
69*b843c749SSergey Zigachev struct i2caux;
70*b843c749SSergey Zigachev 
71*b843c749SSergey Zigachev struct i2caux *dal_i2caux_create(
72*b843c749SSergey Zigachev 	struct dc_context *ctx);
73*b843c749SSergey Zigachev 
74*b843c749SSergey Zigachev bool dal_i2caux_submit_i2c_command(
75*b843c749SSergey Zigachev 	struct i2caux *i2caux,
76*b843c749SSergey Zigachev 	struct ddc *ddc,
77*b843c749SSergey Zigachev 	struct i2c_command *cmd);
78*b843c749SSergey Zigachev 
79*b843c749SSergey Zigachev bool dal_i2caux_submit_aux_command(
80*b843c749SSergey Zigachev 	struct i2caux *i2caux,
81*b843c749SSergey Zigachev 	struct ddc *ddc,
82*b843c749SSergey Zigachev 	struct aux_command *cmd);
83*b843c749SSergey Zigachev 
84*b843c749SSergey Zigachev void dal_i2caux_configure_aux(
85*b843c749SSergey Zigachev 	struct i2caux *i2caux,
86*b843c749SSergey Zigachev 	struct ddc *ddc,
87*b843c749SSergey Zigachev 	union aux_config cfg);
88*b843c749SSergey Zigachev 
89*b843c749SSergey Zigachev void dal_i2caux_destroy(
90*b843c749SSergey Zigachev 	struct i2caux **ptr);
91*b843c749SSergey Zigachev 
92*b843c749SSergey Zigachev #endif
93