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 */ 30 #define MAX_PORTS 6 31 32 /** 33 * struct i915_audio_component_ops - Ops implemented by i915 driver, called by hda driver 34 */ 35 struct i915_audio_component_ops { 36 /** 37 * @owner: i915 module 38 */ 39 struct module *owner; 40 /** 41 * @get_power: get the POWER_DOMAIN_AUDIO power well 42 * 43 * Request the power well to be turned on. 44 */ 45 void (*get_power)(struct device *); 46 /** 47 * @put_power: put the POWER_DOMAIN_AUDIO power well 48 * 49 * Allow the power well to be turned off. 50 */ 51 void (*put_power)(struct device *); 52 /** 53 * @codec_wake_override: Enable/disable codec wake signal 54 */ 55 void (*codec_wake_override)(struct device *, bool enable); 56 /** 57 * @get_cdclk_freq: Get the Core Display Clock in kHz 58 */ 59 int (*get_cdclk_freq)(struct device *); 60 /** 61 * @sync_audio_rate: set n/cts based on the sample rate 62 * 63 * Called from audio driver. After audio driver sets the 64 * sample rate, it will call this function to set n/cts 65 */ 66 int (*sync_audio_rate)(struct device *, int port, int pipe, int rate); 67 /** 68 * @get_eld: fill the audio state and ELD bytes for the given port 69 * 70 * Called from audio driver to get the HDMI/DP audio state of the given 71 * digital port, and also fetch ELD bytes to the given pointer. 72 * 73 * It returns the byte size of the original ELD (not the actually 74 * copied size), zero for an invalid ELD, or a negative error code. 75 * 76 * Note that the returned size may be over @max_bytes. Then it 77 * implies that only a part of ELD has been copied to the buffer. 78 */ 79 int (*get_eld)(struct device *, int port, int pipe, bool *enabled, 80 unsigned char *buf, int max_bytes); 81 }; 82 83 /** 84 * struct i915_audio_component_audio_ops - Ops implemented by hda driver, called by i915 driver 85 */ 86 struct i915_audio_component_audio_ops { 87 /** 88 * @audio_ptr: Pointer to be used in call to pin_eld_notify 89 */ 90 void *audio_ptr; 91 /** 92 * @pin_eld_notify: Notify the HDA driver that pin sense and/or ELD information has changed 93 * 94 * Called when the i915 driver has set up audio pipeline or has just 95 * begun to tear it down. This allows the HDA driver to update its 96 * status accordingly (even when the HDA controller is in power save 97 * mode). 98 */ 99 void (*pin_eld_notify)(void *audio_ptr, int port, int pipe); 100 }; 101 102 /** 103 * struct i915_audio_component - Used for direct communication between i915 and hda drivers 104 */ 105 struct i915_audio_component { 106 /** 107 * @dev: i915 device, used as parameter for ops 108 */ 109 struct device *dev; 110 /** 111 * @aud_sample_rate: the array of audio sample rate per port 112 */ 113 int aud_sample_rate[MAX_PORTS]; 114 /** 115 * @ops: Ops implemented by i915 driver, called by hda driver 116 */ 117 const struct i915_audio_component_ops *ops; 118 /** 119 * @audio_ops: Ops implemented by hda driver, called by i915 driver 120 */ 121 const struct i915_audio_component_audio_ops *audio_ops; 122 }; 123 124 #endif /* _I915_COMPONENT_H_ */ 125