xref: /dflybsd-src/sys/dev/drm/amd/display/dc/i2caux/i2c_engine.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_I2C_ENGINE_H__
27*b843c749SSergey Zigachev #define __DAL_I2C_ENGINE_H__
28*b843c749SSergey Zigachev 
29*b843c749SSergey Zigachev enum i2c_channel_operation_result {
30*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_SUCCEEDED,
31*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_FAILED,
32*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_NOT_GRANTED,
33*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_IS_BUSY,
34*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_NO_HANDLE_PROVIDED,
35*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_CHANNEL_IN_USE,
36*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_CHANNEL_CLIENT_MAX_ALLOWED,
37*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_ENGINE_BUSY,
38*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_TIMEOUT,
39*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_NO_RESPONSE,
40*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_HW_REQUEST_I2C_BUS,
41*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_WRONG_PARAMETER,
42*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_OUT_NB_OF_RETRIES,
43*b843c749SSergey Zigachev 	I2C_CHANNEL_OPERATION_NOT_STARTED
44*b843c749SSergey Zigachev };
45*b843c749SSergey Zigachev 
46*b843c749SSergey Zigachev struct i2c_request_transaction_data {
47*b843c749SSergey Zigachev 	enum i2caux_transaction_action action;
48*b843c749SSergey Zigachev 	enum i2c_channel_operation_result status;
49*b843c749SSergey Zigachev 	uint8_t address;
50*b843c749SSergey Zigachev 	uint32_t length;
51*b843c749SSergey Zigachev 	uint8_t *data;
52*b843c749SSergey Zigachev };
53*b843c749SSergey Zigachev 
54*b843c749SSergey Zigachev struct i2c_reply_transaction_data {
55*b843c749SSergey Zigachev 	uint32_t length;
56*b843c749SSergey Zigachev 	uint8_t *data;
57*b843c749SSergey Zigachev };
58*b843c749SSergey Zigachev 
59*b843c749SSergey Zigachev struct i2c_engine;
60*b843c749SSergey Zigachev 
61*b843c749SSergey Zigachev struct i2c_engine_funcs {
62*b843c749SSergey Zigachev 	void (*destroy)(
63*b843c749SSergey Zigachev 		struct i2c_engine **ptr);
64*b843c749SSergey Zigachev 	uint32_t (*get_speed)(
65*b843c749SSergey Zigachev 		const struct i2c_engine *engine);
66*b843c749SSergey Zigachev 	void (*set_speed)(
67*b843c749SSergey Zigachev 		struct i2c_engine *engine,
68*b843c749SSergey Zigachev 		uint32_t speed);
69*b843c749SSergey Zigachev 	bool (*acquire_engine)(
70*b843c749SSergey Zigachev 		struct i2c_engine *engine,
71*b843c749SSergey Zigachev 		struct ddc *ddc);
72*b843c749SSergey Zigachev 	bool (*setup_engine)(
73*b843c749SSergey Zigachev 		struct i2c_engine *engine);
74*b843c749SSergey Zigachev 	void (*submit_channel_request)(
75*b843c749SSergey Zigachev 		struct i2c_engine *engine,
76*b843c749SSergey Zigachev 		struct i2c_request_transaction_data *request);
77*b843c749SSergey Zigachev 	void (*process_channel_reply)(
78*b843c749SSergey Zigachev 		struct i2c_engine *engine,
79*b843c749SSergey Zigachev 		struct i2c_reply_transaction_data *reply);
80*b843c749SSergey Zigachev 	enum i2c_channel_operation_result (*get_channel_status)(
81*b843c749SSergey Zigachev 		struct i2c_engine *engine,
82*b843c749SSergey Zigachev 		uint8_t *returned_bytes);
83*b843c749SSergey Zigachev };
84*b843c749SSergey Zigachev 
85*b843c749SSergey Zigachev struct i2c_engine {
86*b843c749SSergey Zigachev 	struct engine base;
87*b843c749SSergey Zigachev 	const struct i2c_engine_funcs *funcs;
88*b843c749SSergey Zigachev 	uint32_t timeout_delay;
89*b843c749SSergey Zigachev 	uint32_t setup_limit;
90*b843c749SSergey Zigachev 	uint32_t send_reset_length;
91*b843c749SSergey Zigachev };
92*b843c749SSergey Zigachev 
93*b843c749SSergey Zigachev void dal_i2c_engine_construct(
94*b843c749SSergey Zigachev 	struct i2c_engine *engine,
95*b843c749SSergey Zigachev 	struct dc_context *ctx);
96*b843c749SSergey Zigachev 
97*b843c749SSergey Zigachev void dal_i2c_engine_destruct(
98*b843c749SSergey Zigachev 	struct i2c_engine *engine);
99*b843c749SSergey Zigachev 
100*b843c749SSergey Zigachev bool dal_i2c_engine_setup_i2c_engine(
101*b843c749SSergey Zigachev 	struct i2c_engine *engine);
102*b843c749SSergey Zigachev 
103*b843c749SSergey Zigachev void dal_i2c_engine_submit_channel_request(
104*b843c749SSergey Zigachev 	struct i2c_engine *engine,
105*b843c749SSergey Zigachev 	struct i2c_request_transaction_data *request);
106*b843c749SSergey Zigachev 
107*b843c749SSergey Zigachev void dal_i2c_engine_process_channel_reply(
108*b843c749SSergey Zigachev 	struct i2c_engine *engine,
109*b843c749SSergey Zigachev 	struct i2c_reply_transaction_data *reply);
110*b843c749SSergey Zigachev 
111*b843c749SSergey Zigachev bool dal_i2c_engine_acquire(
112*b843c749SSergey Zigachev 	struct engine *ptr,
113*b843c749SSergey Zigachev 	struct ddc *ddc_handle);
114*b843c749SSergey Zigachev 
115*b843c749SSergey Zigachev #endif
116