| Message ID | 03e0ce22-1ebe-24f4-0f49-f4c41ae8f598@xs4all.nl (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | allegro-dvt/nal-h264.h: fix kernel-doc: hdr -> hrd | expand |
On Tue, 23 Mar 2021 08:49:13 +0100, Hans Verkuil wrote: > Give typo in kernel-doc documentation: hdr -> hrd > > Fixes this warning: > > drivers/media/platform/allegro-dvt/nal-h264.h:33: warning: expecting prototype for struct nal_h264_hdr_parameters. Prototype was for struct > nal_h264_hrd_parameters instead > > Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Reviewed-by: Michael Tretter <m.tretter@pengutronix.de> > --- > diff --git a/drivers/media/platform/allegro-dvt/nal-h264.h b/drivers/media/platform/allegro-dvt/nal-h264.h > index 2ba7cbced7a5..8cc5a28bf237 100644 > --- a/drivers/media/platform/allegro-dvt/nal-h264.h > +++ b/drivers/media/platform/allegro-dvt/nal-h264.h > @@ -12,7 +12,7 @@ > #include <linux/types.h> > > /** > - * struct nal_h264_hdr_parameters - HDR parameters > + * struct nal_h264_hrd_parameters - HRD parameters > * > * C struct representation of the sequence parameter set NAL unit as defined by > * Rec. ITU-T H.264 (04/2017) E.1.2 HRD parameters syntax. >
Hi Michael, On 23/03/2021 08:52, Michael Tretter wrote: > On Tue, 23 Mar 2021 08:49:13 +0100, Hans Verkuil wrote: >> Give typo in kernel-doc documentation: hdr -> hrd >> >> Fixes this warning: >> >> drivers/media/platform/allegro-dvt/nal-h264.h:33: warning: expecting prototype for struct nal_h264_hdr_parameters. Prototype was for struct >> nal_h264_hrd_parameters instead >> >> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> > > Reviewed-by: Michael Tretter <m.tretter@pengutronix.de> Since you made the mistake of replying :-) I want to point out that the allegro headers produce a large number of kernel-doc warnings since none of the parameters are documented. You can look at the daily build log for all the warnings, but I've copied them below as well. I think you should either document it all, or change /** to /*. Regards, Hans drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'video_parameter_set_id' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'base_layer_internal_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'base_layer_available_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'max_layers_minus1' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'max_sub_layers_minus1' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'temporal_id_nesting_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'profile_tier_level' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'sub_layer_ordering_info_present_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'max_dec_pic_buffering_minus1' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'max_num_reorder_pics' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'max_latency_increase_plus1' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'max_layer_id' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'num_layer_sets_minus1' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'layer_id_included_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'timing_info_present_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'num_units_in_tick' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'time_scale' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'poc_proportional_to_timing_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'num_ticks_poc_diff_one_minus1' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'num_hrd_parameters' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'hrd_layer_set_idx' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'cprms_present_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'extension_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:95: warning: Function parameter or member 'extension_data_flag' not described in 'nal_hevc_vps' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'aspect_ratio_info_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'aspect_ratio_idc' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'sar_width' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'sar_height' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'overscan_info_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'overscan_appropriate_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'video_signal_type_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'video_format' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'video_full_range_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'colour_description_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'colour_primaries' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'transfer_characteristics' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'matrix_coeffs' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'chroma_loc_info_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'chroma_sample_loc_type_top_field' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'chroma_sample_loc_type_bottom_field' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'neutral_chroma_indication_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'field_seq_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'frame_field_info_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'default_display_window_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'def_disp_win_left_offset' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'def_disp_win_right_offset' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'def_disp_win_top_offset' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'def_disp_win_bottom_offset' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'vui_timing_info_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'vui_num_units_in_tick' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'vui_time_scale' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'vui_poc_proportional_to_timing_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'vui_num_ticks_poc_diff_one_minus1' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'vui_hrd_parameters_present_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'nal_hrd_parameters' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'bitstream_restriction_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'tiles_fixed_structure_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'motion_vectors_over_pic_boundaries_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'restricted_ref_pic_lists_flag' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'min_spatial_segmentation_idc' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'max_bytes_per_pic_denom' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'max_bits_per_min_cu_denom' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'log2_max_mv_length_horizontal' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:193: warning: Function parameter or member 'log2_max_mv_length_vertical' not described in 'nal_hevc_vui_parameters' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'video_parameter_set_id' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'max_sub_layers_minus1' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'temporal_id_nesting_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'profile_tier_level' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'seq_parameter_set_id' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'chroma_format_idc' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'separate_colour_plane_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'pic_width_in_luma_samples' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'pic_height_in_luma_samples' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'conformance_window_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'conf_win_left_offset' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'conf_win_right_offset' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'conf_win_top_offset' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'conf_win_bottom_offset' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'bit_depth_luma_minus8' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'bit_depth_chroma_minus8' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'log2_max_pic_order_cnt_lsb_minus4' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sub_layer_ordering_info_present_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'max_dec_pic_buffering_minus1' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'max_num_reorder_pics' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'max_latency_increase_plus1' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'log2_min_luma_coding_block_size_minus3' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'log2_diff_max_min_luma_coding_block_size' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'log2_min_luma_transform_block_size_minus2' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'log2_diff_max_min_luma_transform_block_size' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'max_transform_hierarchy_depth_inter' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'max_transform_hierarchy_depth_intra' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'scaling_list_enabled_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'scaling_list_data_present_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'amp_enabled_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sample_adaptive_offset_enabled_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'pcm_enabled_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'pcm_sample_bit_depth_luma_minus1' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'pcm_sample_bit_depth_chroma_minus1' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'log2_min_pcm_luma_coding_block_size_minus3' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'log2_diff_max_min_pcm_luma_coding_block_size' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'pcm_loop_filter_disabled_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'num_short_term_ref_pic_sets' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'long_term_ref_pics_present_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sps_temporal_mvp_enabled_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'strong_intra_smoothing_enabled_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'vui_parameters_present_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'vui' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'extension_present_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sps_range_extension_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sps_multilayer_extension_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sps_3d_extension_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sps_scc_extension_flag' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-hevc.h:262: warning: Function parameter or member 'sps_extension_4bits' not described in 'nal_hevc_sps' drivers/media/platform/allegro-dvt/nal-h264.h:33: warning: expecting prototype for struct nal_h264_hdr_parameters. Prototype was for struct nal_h264_hrd_parameters instead drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'aspect_ratio_info_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'aspect_ratio_idc' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'sar_width' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'sar_height' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'overscan_info_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'overscan_appropriate_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'video_signal_type_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'video_format' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'video_full_range_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'colour_description_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'colour_primaries' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'transfer_characteristics' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'matrix_coefficients' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'chroma_loc_info_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'chroma_sample_loc_type_top_field' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'chroma_sample_loc_type_bottom_field' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'timing_info_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'num_units_in_tick' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'time_scale' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'fixed_frame_rate_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'nal_hrd_parameters_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'nal_hrd_parameters' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'vcl_hrd_parameters_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'vcl_hrd_parameters' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'low_delay_hrd_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'pic_struct_present_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'bitstream_restriction_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'motion_vectors_over_pic_boundaries_flag' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'max_bytes_per_pic_denom' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'max_bits_per_mb_denom' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'log2_max_mv_length_horizontal' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'log21_max_mv_length_vertical' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'max_num_reorder_frames' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:88: warning: Function parameter or member 'max_dec_frame_buffering' not described in 'nal_h264_vui_parameters' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'profile_idc' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'constraint_set0_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'constraint_set1_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'constraint_set2_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'constraint_set3_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'constraint_set4_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'constraint_set5_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'reserved_zero_2bits' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'level_idc' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'seq_parameter_set_id' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'chroma_format_idc' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'separate_colour_plane_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'bit_depth_luma_minus8' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'bit_depth_chroma_minus8' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'qpprime_y_zero_transform_bypass_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'seq_scaling_matrix_present_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'log2_max_frame_num_minus4' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'pic_order_cnt_type' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'log2_max_pic_order_cnt_lsb_minus4' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'delta_pic_order_always_zero_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'offset_for_non_ref_pic' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'offset_for_top_to_bottom_field' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'num_ref_frames_in_pic_order_cnt_cycle' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'offset_for_ref_frame' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'max_num_ref_frames' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'gaps_in_frame_num_value_allowed_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'pic_width_in_mbs_minus1' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'pic_height_in_map_units_minus1' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'frame_mbs_only_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'mb_adaptive_frame_field_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'direct_8x8_inference_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'frame_cropping_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'crop_left' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'crop_right' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'crop_top' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'crop_bottom' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'vui_parameters_present_flag' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:143: warning: Function parameter or member 'vui' not described in 'nal_h264_sps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'pic_parameter_set_id' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'seq_parameter_set_id' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'entropy_coding_mode_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'bottom_field_pic_order_in_frame_present_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'num_slice_groups_minus1' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'slice_group_map_type' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'run_length_minus1' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'top_left' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'bottom_right' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'slice_group_change_direction_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'slice_group_change_rate_minus1' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'pic_size_in_map_units_minus1' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'slice_group_id' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'num_ref_idx_l0_default_active_minus1' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'num_ref_idx_l1_default_active_minus1' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'weighted_pred_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'weighted_bipred_idc' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'pic_init_qp_minus26' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'pic_init_qs_minus26' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'chroma_qp_index_offset' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'deblocking_filter_control_present_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'constrained_intra_pred_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'redundant_pic_cnt_present_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'transform_8x8_mode_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'pic_scaling_matrix_present_flag' not described in 'nal_h264_pps' drivers/media/platform/allegro-dvt/nal-h264.h:188: warning: Function parameter or member 'second_chroma_qp_index_offset' not described in 'nal_h264_pps'
Hi Hans, On Tue, 23 Mar 2021 08:57:53 +0100, Hans Verkuil wrote: > On 23/03/2021 08:52, Michael Tretter wrote: > > On Tue, 23 Mar 2021 08:49:13 +0100, Hans Verkuil wrote: > >> Give typo in kernel-doc documentation: hdr -> hrd > >> > >> Fixes this warning: > >> > >> drivers/media/platform/allegro-dvt/nal-h264.h:33: warning: expecting prototype for struct nal_h264_hdr_parameters. Prototype was for struct > >> nal_h264_hrd_parameters instead > >> > >> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> > > > > Reviewed-by: Michael Tretter <m.tretter@pengutronix.de> > > Since you made the mistake of replying :-) I want to point out that the allegro headers > produce a large number of kernel-doc warnings since none of the parameters are documented. :) > > You can look at the daily build log for all the warnings, but I've copied them below as > well. > > I think you should either document it all, or change /** to /*. IMO documenting the parameters is rather pointless, because they are straight copies from the specifications and the documentation would be "see H264 specification" for every single one of them. I guess, I'll go for changing /** to /*. Actually, I thought about using the sps/pps structs defined in include/media/v4l2-ctrls.h. I was not convinced, because these are userspace facing API. Are the sps/pps definitions something, that would help other drivers, too, or should we rather avoid global definitions to discourage sps/pps parsing/generation in drivers? Michael
On 23/03/2021 09:23, Michael Tretter wrote: > Hi Hans, > > On Tue, 23 Mar 2021 08:57:53 +0100, Hans Verkuil wrote: >> On 23/03/2021 08:52, Michael Tretter wrote: >>> On Tue, 23 Mar 2021 08:49:13 +0100, Hans Verkuil wrote: >>>> Give typo in kernel-doc documentation: hdr -> hrd >>>> >>>> Fixes this warning: >>>> >>>> drivers/media/platform/allegro-dvt/nal-h264.h:33: warning: expecting prototype for struct nal_h264_hdr_parameters. Prototype was for struct >>>> nal_h264_hrd_parameters instead >>>> >>>> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> >>> >>> Reviewed-by: Michael Tretter <m.tretter@pengutronix.de> >> >> Since you made the mistake of replying :-) I want to point out that the allegro headers >> produce a large number of kernel-doc warnings since none of the parameters are documented. > > :) > >> >> You can look at the daily build log for all the warnings, but I've copied them below as >> well. >> >> I think you should either document it all, or change /** to /*. > > IMO documenting the parameters is rather pointless, because they are straight > copies from the specifications and the documentation would be "see H264 > specification" for every single one of them. I guess, I'll go for changing /** > to /*. > > Actually, I thought about using the sps/pps structs defined in > include/media/v4l2-ctrls.h. I was not convinced, because these are userspace > facing API. Are the sps/pps definitions something, that would help other > drivers, too, or should we rather avoid global definitions to discourage > sps/pps parsing/generation in drivers? There is nothing wrong with using v4l2_ctrl_h264_sps/pps in your driver instead of your own structs. Just note that these structs are now part of the uAPI, so can't be changed. If you need allegro specific data as well, then you might be better off keeping your own structs. I'm not sure what you mean with your last question. If a driver needs to do sps/pps parsing/generation, then why would it matter if it uses global or local definitions? It still has to do it, right? And having reusable code might help others. Regards, Hans > > Michael >
Hi Hans, On Tue, 23 Mar 2021 09:33:38 +0100, Hans Verkuil wrote: > On 23/03/2021 09:23, Michael Tretter wrote: > > On Tue, 23 Mar 2021 08:57:53 +0100, Hans Verkuil wrote: > >> On 23/03/2021 08:52, Michael Tretter wrote: > >>> On Tue, 23 Mar 2021 08:49:13 +0100, Hans Verkuil wrote: [...] > >> I think you should either document it all, or change /** to /*. > > > > IMO documenting the parameters is rather pointless, because they are straight > > copies from the specifications and the documentation would be "see H264 > > specification" for every single one of them. I guess, I'll go for changing /** > > to /*. > > > > Actually, I thought about using the sps/pps structs defined in > > include/media/v4l2-ctrls.h. I was not convinced, because these are userspace > > facing API. Are the sps/pps definitions something, that would help other > > drivers, too, or should we rather avoid global definitions to discourage > > sps/pps parsing/generation in drivers? > > There is nothing wrong with using v4l2_ctrl_h264_sps/pps in your driver > instead of your own structs. > > Just note that these structs are now part of the uAPI, so can't be changed. > > If you need allegro specific data as well, then you might be better off > keeping your own structs. I checked this and, unfortunately, I need more data than what is available in the uAPI structs (at least cropping information is missing) and cannot reuse the uAPI structs. > > I'm not sure what you mean with your last question. If a driver needs to do > sps/pps parsing/generation, then why would it matter if it uses global or local > definitions? It still has to do it, right? And having reusable code might help > others. The question arises from the stateful video encoder interface specification [0]: Performing software stream processing, header generation etc. in the driver in order to support this interface is strongly discouraged. In case such operations are needed, use of the Stateless Video Encoder Interface (in development) is strongly advised. However, at least the drivers for the Techwell TW5864 and the CODA at least have partial support for writing sps/pps. I guess, having something reusable would be actually pretty helpful. That being said, the API and the documentation of the current sps/pps parsing/generation code is at least a bit sketchy - inconsistent documentation, h264 function being used for h264 and hevc, etc. I'm adding a cleanup of the interface to my todo list. Maybe at one point we could move this code from the driver to some common directory, if possible. Michael [0] https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/dev-encoder.html#memory-to-memory-stateful-video-encoder-interface
diff --git a/drivers/media/platform/allegro-dvt/nal-h264.h b/drivers/media/platform/allegro-dvt/nal-h264.h index 2ba7cbced7a5..8cc5a28bf237 100644 --- a/drivers/media/platform/allegro-dvt/nal-h264.h +++ b/drivers/media/platform/allegro-dvt/nal-h264.h @@ -12,7 +12,7 @@ #include <linux/types.h> /** - * struct nal_h264_hdr_parameters - HDR parameters + * struct nal_h264_hrd_parameters - HRD parameters * * C struct representation of the sequence parameter set NAL unit as defined by * Rec. ITU-T H.264 (04/2017) E.1.2 HRD parameters syntax.
Give typo in kernel-doc documentation: hdr -> hrd Fixes this warning: drivers/media/platform/allegro-dvt/nal-h264.h:33: warning: expecting prototype for struct nal_h264_hdr_parameters. Prototype was for struct nal_h264_hrd_parameters instead Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> ---