include/drm/i915_component.h

   1 /*
   2  * Copyright © 2014 Intel Corporation
   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 (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #ifndef _I915_COMPONENT_H_
  25 #define _I915_COMPONENT_H_
  26
  27 /* MAX_PORT is the number of port
  28  * It must be sync with I915_MAX_PORTS defined i915_drv.h
  29  * 5 should be enough as only HSW, BDW, SKL need such fix.
  30  */
  31 #define MAX_PORTS 5
  32
  33 /**
  34  * struct i915_audio_component_ops - Ops implemented by i915 driver, called by hda driver
  35  */
  36 struct i915_audio_component_ops {
  37         /**
  38          * @owner: i915 module
  39          */
  40         struct module *owner;
  41         /**
  42          * @get_power: get the POWER_DOMAIN_AUDIO power well
  43          *
  44          * Request the power well to be turned on.
  45          */
  46         void (*get_power)(struct device *);
  47         /**
  48          * @put_power: put the POWER_DOMAIN_AUDIO power well
  49          *
  50          * Allow the power well to be turned off.
  51          */
  52         void (*put_power)(struct device *);
  53         /**
  54          * @codec_wake_override: Enable/disable codec wake signal
  55          */
  56         void (*codec_wake_override)(struct device *, bool enable);
  57         /**
  58          * @get_cdclk_freq: Get the Core Display Clock in kHz
  59          */
  60         int (*get_cdclk_freq)(struct device *);
  61         /**
  62          * @sync_audio_rate: set n/cts based on the sample rate
  63          *
  64          * Called from audio driver. After audio driver sets the
  65          * sample rate, it will call this function to set n/cts
  66          */
  67         int (*sync_audio_rate)(struct device *, int port, int rate);
  68 };
  69
  70 /**
  71  * struct i915_audio_component_audio_ops - Ops implemented by hda driver, called by i915 driver
  72  */
  73 struct i915_audio_component_audio_ops {
  74         /**
  75          * @audio_ptr: Pointer to be used in call to pin_eld_notify
  76          */
  77         void *audio_ptr;
  78         /**
  79          * @pin_eld_notify: Notify the HDA driver that pin sense and/or ELD information has changed
  80          *
  81          * Called when the i915 driver has set up audio pipeline or has just
  82          * begun to tear it down. This allows the HDA driver to update its
  83          * status accordingly (even when the HDA controller is in power save
  84          * mode).
  85          */
  86         void (*pin_eld_notify)(void *audio_ptr, int port);
  87 };
  88
  89 /**
  90  * struct i915_audio_component - Used for direct communication between i915 and hda drivers
  91  */
  92 struct i915_audio_component {
  93         /**
  94          * @dev: i915 device, used as parameter for ops
  95          */
  96         struct device *dev;
  97         /**
  98          * @aud_sample_rate: the array of audio sample rate per port
  99          */
 100         int aud_sample_rate[MAX_PORTS];
 101         /**
 102          * @ops: Ops implemented by i915 driver, called by hda driver
 103          */
 104         const struct i915_audio_component_ops *ops;
 105         /**
 106          * @audio_ops: Ops implemented by hda driver, called by i915 driver
 107          */
 108         const struct i915_audio_component_audio_ops *audio_ops;
 109 };
 110
 111 #endif /* _I915_COMPONENT_H_ */