xref: /dflybsd-src/sys/dev/drm/amd/display/dc/i2caux/i2c_hw_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_HW_ENGINE_H__
27*b843c749SSergey Zigachev #define __DAL_I2C_HW_ENGINE_H__
28*b843c749SSergey Zigachev 
29*b843c749SSergey Zigachev enum {
30*b843c749SSergey Zigachev 	TRANSACTION_TIMEOUT_IN_I2C_CLOCKS = 32
31*b843c749SSergey Zigachev };
32*b843c749SSergey Zigachev 
33*b843c749SSergey Zigachev struct i2c_hw_engine;
34*b843c749SSergey Zigachev 
35*b843c749SSergey Zigachev struct i2c_hw_engine_funcs {
36*b843c749SSergey Zigachev 	uint32_t (*get_hw_buffer_available_size)(
37*b843c749SSergey Zigachev 		const struct i2c_hw_engine *engine);
38*b843c749SSergey Zigachev 	enum i2c_channel_operation_result (*wait_on_operation_result)(
39*b843c749SSergey Zigachev 		struct i2c_hw_engine *engine,
40*b843c749SSergey Zigachev 		uint32_t timeout,
41*b843c749SSergey Zigachev 		enum i2c_channel_operation_result expected_result);
42*b843c749SSergey Zigachev 	uint32_t (*get_transaction_timeout)(
43*b843c749SSergey Zigachev 		const struct i2c_hw_engine *engine,
44*b843c749SSergey Zigachev 		uint32_t length);
45*b843c749SSergey Zigachev };
46*b843c749SSergey Zigachev 
47*b843c749SSergey Zigachev struct i2c_hw_engine {
48*b843c749SSergey Zigachev 	struct i2c_engine base;
49*b843c749SSergey Zigachev 	const struct i2c_hw_engine_funcs *funcs;
50*b843c749SSergey Zigachev 
51*b843c749SSergey Zigachev 	/* Values below are in kilohertz */
52*b843c749SSergey Zigachev 	uint32_t original_speed;
53*b843c749SSergey Zigachev 	uint32_t default_speed;
54*b843c749SSergey Zigachev };
55*b843c749SSergey Zigachev 
56*b843c749SSergey Zigachev void dal_i2c_hw_engine_construct(
57*b843c749SSergey Zigachev 	struct i2c_hw_engine *engine,
58*b843c749SSergey Zigachev 	struct dc_context *ctx);
59*b843c749SSergey Zigachev 
60*b843c749SSergey Zigachev void dal_i2c_hw_engine_destruct(
61*b843c749SSergey Zigachev 	struct i2c_hw_engine *engine);
62*b843c749SSergey Zigachev 
63*b843c749SSergey Zigachev enum i2c_channel_operation_result dal_i2c_hw_engine_wait_on_operation_result(
64*b843c749SSergey Zigachev 	struct i2c_hw_engine *engine,
65*b843c749SSergey Zigachev 	uint32_t timeout,
66*b843c749SSergey Zigachev 	enum i2c_channel_operation_result expected_result);
67*b843c749SSergey Zigachev 
68*b843c749SSergey Zigachev bool dal_i2c_hw_engine_acquire_engine(
69*b843c749SSergey Zigachev 	struct i2c_engine *engine,
70*b843c749SSergey Zigachev 	struct ddc *ddc);
71*b843c749SSergey Zigachev 
72*b843c749SSergey Zigachev bool dal_i2c_hw_engine_submit_request(
73*b843c749SSergey Zigachev 	struct engine *ptr,
74*b843c749SSergey Zigachev 	struct i2caux_transaction_request *i2caux_request,
75*b843c749SSergey Zigachev 	bool middle_of_transaction);
76*b843c749SSergey Zigachev 
77*b843c749SSergey Zigachev enum i2caux_engine_type dal_i2c_hw_engine_get_engine_type(
78*b843c749SSergey Zigachev 	const struct engine *engine);
79*b843c749SSergey Zigachev 
80*b843c749SSergey Zigachev #endif
81