1 /*
2  * Copyright 2012-15 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: AMD
23  *
24  */
25 
26 #ifndef __DAL_I2C_GENERIC_HW_ENGINE_H__
27 #define __DAL_I2C_GENERIC_HW_ENGINE_H__
28 
29 struct i2c_generic_transaction_attributes {
30 	enum i2caux_transaction_action action;
31 	uint32_t transaction_size;
32 	bool start_bit;
33 	bool stop_bit;
34 	bool last_read;
35 };
36 
37 struct i2c_generic_hw_engine;
38 
39 struct i2c_generic_hw_engine_funcs {
40 	void (*write_address)(
41 		struct i2c_generic_hw_engine *engine,
42 		uint8_t address);
43 	void (*write_data)(
44 		struct i2c_generic_hw_engine *engine,
45 		const uint8_t *buffer,
46 		uint32_t length);
47 	void (*read_data)(
48 		struct i2c_generic_hw_engine *engine,
49 		uint8_t *buffer,
50 		uint32_t length,
51 		uint32_t offset);
52 	void (*execute_transaction)(
53 		struct i2c_generic_hw_engine *engine,
54 		struct i2c_generic_transaction_attributes *attributes);
55 };
56 
57 struct i2c_generic_hw_engine {
58 	struct i2c_hw_engine base;
59 	const struct i2c_generic_hw_engine_funcs *funcs;
60 };
61 
62 void dal_i2c_generic_hw_engine_construct(
63 	struct i2c_generic_hw_engine *engine,
64 	struct dc_context *ctx);
65 
66 void dal_i2c_generic_hw_engine_destruct(
67 	struct i2c_generic_hw_engine *engine);
68 enum i2caux_engine_type dal_i2c_generic_hw_engine_get_engine_type(
69 	const struct engine *engine);
70 bool dal_i2c_generic_hw_engine_submit_request(
71 	struct engine *ptr,
72 	struct i2caux_transaction_request *i2caux_request,
73 	bool middle_of_transaction);
74 uint32_t dal_i2c_generic_hw_engine_get_transaction_timeout(
75 	const struct i2c_hw_engine *engine,
76 	uint32_t length);
77 #endif
78