drivers/gpu/drm/amd/display/dc/i2caux/i2c_hw_engine.h

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