forked from Minki/linux
media: venus: core: Fix kerneldoc warnings
Fix kerneldoc warnings in description of venus_core and venus_inst structures Signed-off-by: Stanimir Varbanov <stanimir.varbanov@linaro.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
parent
4f4e6644cd
commit
c9072b674f
@ -90,18 +90,25 @@ struct venus_format {
|
|||||||
* struct venus_core - holds core parameters valid for all instances
|
* struct venus_core - holds core parameters valid for all instances
|
||||||
*
|
*
|
||||||
* @base: IO memory base address
|
* @base: IO memory base address
|
||||||
* @vbif_base IO memory vbif base address
|
* @vbif_base: IO memory vbif base address
|
||||||
* @cpu_base IO memory cpu base address
|
* @cpu_base: IO memory cpu base address
|
||||||
* @cpu_cs_base IO memory cpu_cs base address
|
* @cpu_cs_base: IO memory cpu_cs base address
|
||||||
* @cpu_ic_base IO memory cpu_ic base address
|
* @cpu_ic_base: IO memory cpu_ic base address
|
||||||
* @wrapper_base IO memory wrapper base address
|
* @wrapper_base: IO memory wrapper base address
|
||||||
* @wrapper_base IO memory wrapper TZ base address
|
* @wrapper_tz_base: IO memory wrapper TZ base address
|
||||||
* @aon_base AON base address
|
* @aon_base: AON base address
|
||||||
* @irq: Venus irq
|
* @irq: Venus irq
|
||||||
* @clks: an array of struct clk pointers
|
* @clks: an array of struct clk pointers
|
||||||
* @vcodec0_clks: an array of vcodec0 struct clk pointers
|
* @vcodec0_clks: an array of vcodec0 struct clk pointers
|
||||||
* @vcodec1_clks: an array of vcodec1 struct clk pointers
|
* @vcodec1_clks: an array of vcodec1 struct clk pointers
|
||||||
|
* @video_path: an interconnect handle to video to/from memory path
|
||||||
|
* @cpucfg_path: an interconnect handle to cpu configuration path
|
||||||
|
* @opp_table: an device OPP table handle
|
||||||
|
* @has_opp_table: does OPP table exist
|
||||||
* @pmdomains: an array of pmdomains struct device pointers
|
* @pmdomains: an array of pmdomains struct device pointers
|
||||||
|
* @opp_dl_venus: an device-link for device OPP
|
||||||
|
* @opp_pmdomain: an OPP power-domain
|
||||||
|
* @resets: an array of reset signals
|
||||||
* @vdev_dec: a reference to video device structure for decoder instances
|
* @vdev_dec: a reference to video device structure for decoder instances
|
||||||
* @vdev_enc: a reference to video device structure for encoder instances
|
* @vdev_enc: a reference to video device structure for encoder instances
|
||||||
* @v4l2_dev: a holder for v4l2 device structure
|
* @v4l2_dev: a holder for v4l2 device structure
|
||||||
@ -110,6 +117,7 @@ struct venus_format {
|
|||||||
* @dev_dec: convenience struct device pointer for decoder device
|
* @dev_dec: convenience struct device pointer for decoder device
|
||||||
* @dev_enc: convenience struct device pointer for encoder device
|
* @dev_enc: convenience struct device pointer for encoder device
|
||||||
* @use_tz: a flag that suggests presence of trustzone
|
* @use_tz: a flag that suggests presence of trustzone
|
||||||
|
* @fw: structure of firmware parameters
|
||||||
* @lock: a lock for this strucure
|
* @lock: a lock for this strucure
|
||||||
* @instances: a list_head of all instances
|
* @instances: a list_head of all instances
|
||||||
* @insts_count: num of instances
|
* @insts_count: num of instances
|
||||||
@ -118,6 +126,7 @@ struct venus_format {
|
|||||||
* @error: an error returned during last HFI sync operations
|
* @error: an error returned during last HFI sync operations
|
||||||
* @sys_error: an error flag that signal system error event
|
* @sys_error: an error flag that signal system error event
|
||||||
* @core_ops: the core operations
|
* @core_ops: the core operations
|
||||||
|
* @pm_ops: a pointer to pm operations
|
||||||
* @pm_lock: a lock for PM operations
|
* @pm_lock: a lock for PM operations
|
||||||
* @enc_codecs: encoders supported by this core
|
* @enc_codecs: encoders supported by this core
|
||||||
* @dec_codecs: decoders supported by this core
|
* @dec_codecs: decoders supported by this core
|
||||||
@ -125,6 +134,10 @@ struct venus_format {
|
|||||||
* @priv: a private filed for HFI operations
|
* @priv: a private filed for HFI operations
|
||||||
* @ops: the core HFI operations
|
* @ops: the core HFI operations
|
||||||
* @work: a delayed work for handling system fatal error
|
* @work: a delayed work for handling system fatal error
|
||||||
|
* @caps: an array of supported HFI capabilities
|
||||||
|
* @codecs_count: platform codecs count
|
||||||
|
* @core0_usage_count: usage counter for core0
|
||||||
|
* @core1_usage_count: usage counter for core1
|
||||||
* @root: debugfs root directory
|
* @root: debugfs root directory
|
||||||
*/
|
*/
|
||||||
struct venus_core {
|
struct venus_core {
|
||||||
@ -309,10 +322,11 @@ struct venus_ts_metadata {
|
|||||||
* @list: used for attach an instance to the core
|
* @list: used for attach an instance to the core
|
||||||
* @lock: instance lock
|
* @lock: instance lock
|
||||||
* @core: a reference to the core struct
|
* @core: a reference to the core struct
|
||||||
|
* @clk_data: clock data per core ID
|
||||||
* @dpbbufs: a list of decoded picture buffers
|
* @dpbbufs: a list of decoded picture buffers
|
||||||
* @internalbufs: a list of internal bufferes
|
* @internalbufs: a list of internal bufferes
|
||||||
* @registeredbufs: a list of registered capture bufferes
|
* @registeredbufs: a list of registered capture bufferes
|
||||||
* @delayed_process a list of delayed buffers
|
* @delayed_process: a list of delayed buffers
|
||||||
* @delayed_process_work: a work_struct for process delayed buffers
|
* @delayed_process_work: a work_struct for process delayed buffers
|
||||||
* @ctrl_handler: v4l control handler
|
* @ctrl_handler: v4l control handler
|
||||||
* @controls: a union of decoder and encoder control parameters
|
* @controls: a union of decoder and encoder control parameters
|
||||||
@ -321,22 +335,26 @@ struct venus_ts_metadata {
|
|||||||
* @streamon_out: stream on flag for output queue
|
* @streamon_out: stream on flag for output queue
|
||||||
* @width: current capture width
|
* @width: current capture width
|
||||||
* @height: current capture height
|
* @height: current capture height
|
||||||
|
* @crop: current crop rectangle
|
||||||
* @out_width: current output width
|
* @out_width: current output width
|
||||||
* @out_height: current output height
|
* @out_height: current output height
|
||||||
* @colorspace: current color space
|
* @colorspace: current color space
|
||||||
|
* @ycbcr_enc: current YCbCr encoding
|
||||||
* @quantization: current quantization
|
* @quantization: current quantization
|
||||||
* @xfer_func: current xfer function
|
* @xfer_func: current xfer function
|
||||||
* @codec_state: current codec API state (see DEC/ENC_STATE_)
|
* @codec_state: current codec API state (see DEC/ENC_STATE_)
|
||||||
* @reconf_wait: wait queue for resolution change event
|
* @reconf_wait: wait queue for resolution change event
|
||||||
* @subscriptions: used to hold current events subscriptions
|
* @subscriptions: used to hold current events subscriptions
|
||||||
* @buf_count: used to count number of buffers (reqbuf(0))
|
* @buf_count: used to count number of buffers (reqbuf(0))
|
||||||
|
* @tss: timestamp metadata
|
||||||
|
* @payloads: cache plane payload to use it for clock/BW scaling
|
||||||
* @fps: holds current FPS
|
* @fps: holds current FPS
|
||||||
* @timeperframe: holds current time per frame structure
|
* @timeperframe: holds current time per frame structure
|
||||||
* @fmt_out: a reference to output format structure
|
* @fmt_out: a reference to output format structure
|
||||||
* @fmt_cap: a reference to capture format structure
|
* @fmt_cap: a reference to capture format structure
|
||||||
* @num_input_bufs: holds number of input buffers
|
* @num_input_bufs: holds number of input buffers
|
||||||
* @num_output_bufs: holds number of output buffers
|
* @num_output_bufs: holds number of output buffers
|
||||||
* @input_buf_size holds input buffer size
|
* @input_buf_size: holds input buffer size
|
||||||
* @output_buf_size: holds output buffer size
|
* @output_buf_size: holds output buffer size
|
||||||
* @output2_buf_size: holds secondary decoder output buffer size
|
* @output2_buf_size: holds secondary decoder output buffer size
|
||||||
* @dpb_buftype: decoded picture buffer type
|
* @dpb_buftype: decoded picture buffer type
|
||||||
@ -357,7 +375,11 @@ struct venus_ts_metadata {
|
|||||||
* @priv: a private for HFI operations callbacks
|
* @priv: a private for HFI operations callbacks
|
||||||
* @session_type: the type of the session (decoder or encoder)
|
* @session_type: the type of the session (decoder or encoder)
|
||||||
* @hprop: a union used as a holder by get property
|
* @hprop: a union used as a holder by get property
|
||||||
|
* @core_acquired: the Core has been acquired
|
||||||
|
* @bit_depth: current bitstream bit-depth
|
||||||
|
* @pic_struct: bitstream progressive vs interlaced
|
||||||
* @next_buf_last: a flag to mark next queued capture buffer as last
|
* @next_buf_last: a flag to mark next queued capture buffer as last
|
||||||
|
* @drain_active: Drain sequence is in progress
|
||||||
*/
|
*/
|
||||||
struct venus_inst {
|
struct venus_inst {
|
||||||
struct list_head list;
|
struct list_head list;
|
||||||
|
Loading…
Reference in New Issue
Block a user