tree: https://git.kernel.org/pub/scm/linux/kernel/git/helgaas/pci.git pci/docs head: 5b76337ac1d54eb1c82414f17e29883290ce87de commit: fe6cdee86aeb83ee6ed2dc98928fb9fefc138612 [2/12] Documentation: PCI: convert pci.txt to reST reproduce: make htmldocs If you fix the issue, kindly add following tag Reported-by: kbuild test robot <lkp@xxxxxxxxx> All warnings (new ones prefixed by >>): WARNING: convert(1) not found, for SVG to PDF conversion install ImageMagick (https://www.imagemagick.org) include/linux/pci.h:158: warning: cannot understand function prototype: 'typedef unsigned int __bitwise pci_channel_state_t; ' >> include/linux/pci.h:831: warning: Function parameter or member 'node' not described in 'pci_driver' >> include/linux/pci.h:831: warning: Function parameter or member 'name' not described in 'pci_driver' >> include/linux/pci.h:831: warning: Function parameter or member 'sriov_configure' not described in 'pci_driver' >> include/linux/pci.h:831: warning: Function parameter or member 'groups' not described in 'pci_driver' >> include/linux/pci.h:831: warning: Function parameter or member 'driver' not described in 'pci_driver' >> include/linux/pci.h:831: warning: Function parameter or member 'dynids' not described in 'pci_driver' include/linux/pci.h:2251: warning: Excess function parameter 'lrdt' description in 'pci_vpd_info_field_size' include/linux/generic-radix-tree.h:1: warning: no structured comments found lib/sort.c:59: warning: Excess function parameter 'size' description in 'swap_words_32' lib/sort.c:83: warning: Excess function parameter 'size' description in 'swap_words_64' lib/sort.c:110: warning: Excess function parameter 'size' description in 'swap_bytes' block/genhd.c:540: warning: Function parameter or member 'devt' not described in 'blk_invalidate_devt' kernel/rcu/tree_plugin.h:1: warning: no structured comments found include/net/cfg80211.h:1074: warning: Function parameter or member 'txpwr' not described in 'station_parameters' include/net/mac80211.h:4037: warning: Function parameter or member 'sta_set_txpwr' not described in 'ieee80211_ops' include/net/mac80211.h:2004: warning: Function parameter or member 'txpwr' not described in 'ieee80211_sta' kernel/rcu/tree_plugin.h:1: warning: no structured comments found include/linux/firmware/intel/stratix10-svc-client.h:1: warning: no structured comments found Error: Cannot open file drivers/counter/generic-counter.c Error: Cannot open file drivers/counter/generic-counter.c WARNING: kernel-doc 'scripts/kernel-doc -rst -enable-lineno -export drivers/counter/generic-counter.c' failed with return code 2 include/linux/gpio/driver.h:374: warning: Function parameter or member 'init_valid_mask' not described in 'gpio_chip' include/linux/i2c.h:343: warning: Function parameter or member 'init_irq' not described in 'i2c_client' include/linux/iio/hw-consumer.h:1: warning: no structured comments found drivers/base/node.c:78: warning: Function parameter or member 'hmem_attrs' not described in 'node_access_nodes' drivers/base/node.c:690: warning: Function parameter or member 'mem_nid' not described in 'register_memory_node_under_compute_node' drivers/base/node.c:690: warning: Function parameter or member 'cpu_nid' not described in 'register_memory_node_under_compute_node' drivers/base/node.c:690: warning: Excess function parameter 'mem_node' description in 'register_memory_node_under_compute_node' drivers/base/node.c:690: warning: Excess function parameter 'cpu_node' description in 'register_memory_node_under_compute_node' include/linux/input/sparse-keymap.h:46: warning: Function parameter or member 'sw' not described in 'key_entry' include/linux/regulator/machine.h:199: warning: Function parameter or member 'max_uV_step' not described in 'regulation_constraints' include/linux/regulator/driver.h:228: warning: Function parameter or member 'resume' not described in 'regulator_ops' drivers/slimbus/stream.c:1: warning: no structured comments found include/linux/spi/spi.h:188: warning: Function parameter or member 'driver_override' not described in 'spi_device' drivers/target/target_core_device.c:1: warning: no structured comments found drivers/usb/typec/bus.c:1: warning: no structured comments found drivers/usb/typec/class.c:1: warning: no structured comments found include/linux/w1.h:281: warning: Function parameter or member 'of_match_table' not described in 'w1_family' fs/direct-io.c:257: warning: Excess function parameter 'offset' description in 'dio_complete' fs/file_table.c:1: warning: no structured comments found fs/libfs.c:479: warning: Excess function parameter 'available' description in 'simple_write_end' fs/posix_acl.c:646: warning: Function parameter or member 'inode' not described in 'posix_acl_update_mode' fs/posix_acl.c:646: warning: Function parameter or member 'mode_p' not described in 'posix_acl_update_mode' fs/posix_acl.c:646: warning: Function parameter or member 'acl' not described in 'posix_acl_update_mode' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:294: warning: Excess function parameter 'mm' description in 'amdgpu_mn_invalidate_range_start_hsa' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:294: warning: Excess function parameter 'start' description in 'amdgpu_mn_invalidate_range_start_hsa' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:294: warning: Excess function parameter 'end' description in 'amdgpu_mn_invalidate_range_start_hsa' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:343: warning: Excess function parameter 'mm' description in 'amdgpu_mn_invalidate_range_end' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:343: warning: Excess function parameter 'start' description in 'amdgpu_mn_invalidate_range_end' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:343: warning: Excess function parameter 'end' description in 'amdgpu_mn_invalidate_range_end' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:183: warning: Function parameter or member 'blockable' not described in 'amdgpu_mn_read_lock' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:295: warning: Function parameter or member 'range' not described in 'amdgpu_mn_invalidate_range_start_hsa' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:295: warning: Excess function parameter 'mm' description in 'amdgpu_mn_invalidate_range_start_hsa' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:295: warning: Excess function parameter 'start' description in 'amdgpu_mn_invalidate_range_start_hsa' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:295: warning: Excess function parameter 'end' description in 'amdgpu_mn_invalidate_range_start_hsa' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:344: warning: Function parameter or member 'range' not described in 'amdgpu_mn_invalidate_range_end' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:344: warning: Excess function parameter 'mm' description in 'amdgpu_mn_invalidate_range_end' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:344: warning: Excess function parameter 'start' description in 'amdgpu_mn_invalidate_range_end' drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:344: warning: Excess function parameter 'end' description in 'amdgpu_mn_invalidate_range_end' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:347: warning: cannot understand function prototype: 'struct amdgpu_vm_pt_cursor ' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:348: warning: cannot understand function prototype: 'struct amdgpu_vm_pt_cursor ' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:494: warning: Function parameter or member 'start' not described in 'amdgpu_vm_pt_first_dfs' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'adev' not described in 'for_each_amdgpu_vm_pt_dfs_safe' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'vm' not described in 'for_each_amdgpu_vm_pt_dfs_safe' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'start' not described in 'for_each_amdgpu_vm_pt_dfs_safe' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'cursor' not described in 'for_each_amdgpu_vm_pt_dfs_safe' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:546: warning: Function parameter or member 'entry' not described in 'for_each_amdgpu_vm_pt_dfs_safe' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:823: warning: Function parameter or member 'level' not described in 'amdgpu_vm_bo_param' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'params' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'bo' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'level' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'pe' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'addr' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'count' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'incr' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:1285: warning: Function parameter or member 'flags' not described in 'amdgpu_vm_update_flags' drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:2812: warning: Function parameter or member 'pasid' not described in 'amdgpu_vm_make_compute' drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:375: warning: Excess function parameter 'entry' description in 'amdgpu_irq_dispatch' drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:376: warning: Function parameter or member 'ih' not described in 'amdgpu_irq_dispatch' drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c:376: warning: Excess function parameter 'entry' description in 'amdgpu_irq_dispatch' drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c:1: warning: no structured comments found drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:128: warning: Incorrect use of kernel-doc format: Documentation Makefile include scripts source @atomic_obj drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:210: warning: Function parameter or member 'atomic_obj' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:210: warning: Function parameter or member 'backlight_link' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:210: warning: Function parameter or member 'backlight_caps' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:210: warning: Function parameter or member 'freesync_module' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:210: warning: Function parameter or member 'fw_dmcu' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:210: warning: Function parameter or member 'dmcu_fw_version' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c:1: warning: no structured comments found include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_pin' not described in 'drm_driver' include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_unpin' not described in 'drm_driver' include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_res_obj' not described in 'drm_driver' include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_get_sg_table' not described in 'drm_driver' include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_import_sg_table' not described in 'drm_driver' include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_vmap' not described in 'drm_driver' include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_vunmap' not described in 'drm_driver' include/drm/drm_drv.h:722: warning: Function parameter or member 'gem_prime_mmap' not described in 'drm_driver' include/drm/drm_modeset_helper_vtables.h:1004: warning: Function parameter or member 'prepare_writeback_job' not described in 'drm_connector_helper_funcs' include/drm/drm_modeset_helper_vtables.h:1004: warning: Function parameter or member 'cleanup_writeback_job' not described in 'drm_connector_helper_funcs' include/drm/drm_atomic_state_helper.h:1: warning: no structured comments found drivers/gpu/drm/scheduler/sched_main.c:419: warning: Function parameter or member 'full_recovery' not described in 'drm_sched_start' drivers/gpu/drm/i915/i915_vma.h:50: warning: cannot understand function prototype: 'struct i915_vma ' drivers/gpu/drm/i915/i915_vma.h:1: warning: no structured comments found drivers/gpu/drm/i915/intel_guc_fwif.h:536: warning: cannot understand function prototype: 'struct guc_log_buffer_state ' drivers/gpu/drm/i915/i915_trace.h:1: warning: no structured comments found drivers/gpu/drm/i915/i915_reg.h:156: warning: bad line: vim +831 include/linux/pci.h fe6cdee8 Changbin Du 2019-05-14 778 fe6cdee8 Changbin Du 2019-05-14 779 /** fe6cdee8 Changbin Du 2019-05-14 780 * struct pci_driver - PCI driver structure fe6cdee8 Changbin Du 2019-05-14 781 * @id_table: Pointer to table of device IDs the driver is fe6cdee8 Changbin Du 2019-05-14 782 * interested in. Most drivers should export this fe6cdee8 Changbin Du 2019-05-14 783 * table using MODULE_DEVICE_TABLE(pci,...). fe6cdee8 Changbin Du 2019-05-14 784 * @probe: This probing function gets called (during execution fe6cdee8 Changbin Du 2019-05-14 785 * of pci_register_driver() for already existing fe6cdee8 Changbin Du 2019-05-14 786 * devices or later if a new device gets inserted) for fe6cdee8 Changbin Du 2019-05-14 787 * all PCI devices which match the ID table and are not fe6cdee8 Changbin Du 2019-05-14 788 * "owned" by the other drivers yet. This function gets fe6cdee8 Changbin Du 2019-05-14 789 * passed a "struct pci_dev *" for each device whose fe6cdee8 Changbin Du 2019-05-14 790 * entry in the ID table matches the device. The probe fe6cdee8 Changbin Du 2019-05-14 791 * function returns zero when the driver chooses to fe6cdee8 Changbin Du 2019-05-14 792 * take "ownership" of the device or an error code fe6cdee8 Changbin Du 2019-05-14 793 * (negative number) otherwise. fe6cdee8 Changbin Du 2019-05-14 794 * The probe function always gets called from process fe6cdee8 Changbin Du 2019-05-14 795 * context, so it can sleep. fe6cdee8 Changbin Du 2019-05-14 796 * @remove: The remove() function gets called whenever a device fe6cdee8 Changbin Du 2019-05-14 797 * being handled by this driver is removed (either during fe6cdee8 Changbin Du 2019-05-14 798 * deregistration of the driver or when it's manually fe6cdee8 Changbin Du 2019-05-14 799 * pulled out of a hot-pluggable slot). fe6cdee8 Changbin Du 2019-05-14 800 * The remove function always gets called from process fe6cdee8 Changbin Du 2019-05-14 801 * context, so it can sleep. fe6cdee8 Changbin Du 2019-05-14 802 * @suspend: Put device into low power state. fe6cdee8 Changbin Du 2019-05-14 803 * @suspend_late: Put device into low power state. fe6cdee8 Changbin Du 2019-05-14 804 * @resume_early: Wake device from low power state. fe6cdee8 Changbin Du 2019-05-14 805 * @resume: Wake device from low power state. fe6cdee8 Changbin Du 2019-05-14 806 * (Please see Documentation/power/pci.txt for descriptions fe6cdee8 Changbin Du 2019-05-14 807 * of PCI Power Management and the related functions.) fe6cdee8 Changbin Du 2019-05-14 808 * @shutdown: Hook into reboot_notifier_list (kernel/sys.c). fe6cdee8 Changbin Du 2019-05-14 809 * Intended to stop any idling DMA operations. fe6cdee8 Changbin Du 2019-05-14 810 * Useful for enabling wake-on-lan (NIC) or changing fe6cdee8 Changbin Du 2019-05-14 811 * the power state of a device before reboot. fe6cdee8 Changbin Du 2019-05-14 812 * e.g. drivers/net/e100.c. fe6cdee8 Changbin Du 2019-05-14 813 * @err_handler: See Documentation/PCI/pci-error-recovery.rst fe6cdee8 Changbin Du 2019-05-14 814 */ ^1da177e Linus Torvalds 2005-04-16 815 struct pci_driver { ^1da177e Linus Torvalds 2005-04-16 816 struct list_head node; 42b21932 Stephen Hemminger 2010-09-02 817 const char *name; 0aa0f5d1 Bjorn Helgaas 2017-12-02 818 const struct pci_device_id *id_table; /* Must be non-NULL for probe to be called */ ^1da177e Linus Torvalds 2005-04-16 819 int (*probe)(struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */ ^1da177e Linus Torvalds 2005-04-16 820 void (*remove)(struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */ ^1da177e Linus Torvalds 2005-04-16 821 int (*suspend)(struct pci_dev *dev, pm_message_t state); /* Device suspended */ cbd69dbb Linus Torvalds 2006-06-24 822 int (*suspend_late)(struct pci_dev *dev, pm_message_t state); cbd69dbb Linus Torvalds 2006-06-24 823 int (*resume_early)(struct pci_dev *dev); ^1da177e Linus Torvalds 2005-04-16 824 int (*resume)(struct pci_dev *dev); /* Device woken up */ c8958177 Greg Kroah-Hartman 2005-04-08 825 void (*shutdown)(struct pci_dev *dev); 0aa0f5d1 Bjorn Helgaas 2017-12-02 826 int (*sriov_configure)(struct pci_dev *dev, int num_vfs); /* On PF */ 49453028 Stephen Hemminger 2012-09-07 827 const struct pci_error_handlers *err_handler; 92d50fc1 Greg Kroah-Hartman 2017-07-19 828 const struct attribute_group **groups; ^1da177e Linus Torvalds 2005-04-16 829 struct device_driver driver; ^1da177e Linus Torvalds 2005-04-16 830 struct pci_dynids dynids; ^1da177e Linus Torvalds 2005-04-16 @831 }; ^1da177e Linus Torvalds 2005-04-16 832 :::::: The code at line 831 was first introduced by commit :::::: 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 Linux-2.6.12-rc2 :::::: TO: Linus Torvalds <torvalds@xxxxxxxxxxxxxxx> :::::: CC: Linus Torvalds <torvalds@xxxxxxxxxxxxxxx> --- 0-DAY kernel test infrastructure Open Source Technology Center https://lists.01.org/pipermail/kbuild-all Intel Corporation
Attachment:
.config.gz
Description: application/gzip