Skip to content

Commit fda78d8

Browse files
ktbowmandavejiang
authored andcommitted
PCI/AER: Update struct aer_err_info with kernel-doc formatting
Update the existing 'struct aer_err_info' definition to use kernel-doc formatting. Remove the inline comments to reduce noise and do not introduce functional changes. This will improve readability and maintainability. Signed-off-by: Terry Bowman <terry.bowman@amd.com> Reviewed-by: Dan Williams <dan.j.williams@intel.com> Reviewed-by: Dave Jiang <dave.jiang@intel.com> Reviewed-by: Jonathan Cameron <jonathan.cameron@huawei.com> Link: https://patch.msgid.link/20260114182055.46029-16-terry.bowman@amd.com Acked-by: Bjorn Helgaas <bhelgaas@google.com> Signed-off-by: Dan Williams <dan.j.williams@intel.com> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
1 parent 83cba5b commit fda78d8

1 file changed

Lines changed: 25 additions & 6 deletions

File tree

drivers/pci/pci.h

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -724,16 +724,35 @@ static inline bool pci_dev_binding_disallowed(struct pci_dev *dev)
724724

725725
#define AER_MAX_MULTI_ERR_DEVICES 5 /* Not likely to have more */
726726

727+
/**
728+
* struct aer_err_info - AER Error Information
729+
* @dev: Devices reporting error
730+
* @ratelimit_print: Flag to log or not log the devices' error. 0=NotLog/1=Log
731+
* @__pad1: Padding for alignment
732+
* @error_dev_num: Number of devices reporting an error
733+
* @level: printk level to use in logging
734+
* @id: Value from register PCI_ERR_ROOT_ERR_SRC
735+
* @severity: AER severity, 0-UNCOR Non-fatal, 1-UNCOR fatal, 2-COR
736+
* @root_ratelimit_print: Flag to log or not log the root's error. 0=NotLog/1=Log
737+
* @multi_error_valid: If multiple errors are reported
738+
* @first_error: First reported error
739+
* @__pad2: Padding for alignment
740+
* @is_cxl: Bus type error: 0-PCI Bus error, 1-CXL Bus error
741+
* @tlp_header_valid: Indicates if TLP field contains error information
742+
* @status: COR/UNCOR error status
743+
* @mask: COR/UNCOR mask
744+
* @tlp: Transaction packet information
745+
*/
727746
struct aer_err_info {
728747
struct pci_dev *dev[AER_MAX_MULTI_ERR_DEVICES];
729748
int ratelimit_print[AER_MAX_MULTI_ERR_DEVICES];
730749
int error_dev_num;
731-
const char *level; /* printk level */
750+
const char *level;
732751

733752
unsigned int id:16;
734753

735-
unsigned int severity:2; /* 0:NONFATAL | 1:FATAL | 2:COR */
736-
unsigned int root_ratelimit_print:1; /* 0=skip, 1=print */
754+
unsigned int severity:2;
755+
unsigned int root_ratelimit_print:1;
737756
unsigned int __pad1:4;
738757
unsigned int multi_error_valid:1;
739758

@@ -742,9 +761,9 @@ struct aer_err_info {
742761
unsigned int is_cxl:1;
743762
unsigned int tlp_header_valid:1;
744763

745-
unsigned int status; /* COR/UNCOR Error Status */
746-
unsigned int mask; /* COR/UNCOR Error Mask */
747-
struct pcie_tlp_log tlp; /* TLP Header */
764+
unsigned int status;
765+
unsigned int mask;
766+
struct pcie_tlp_log tlp;
748767
};
749768

750769
int aer_get_device_error_info(struct aer_err_info *info, int i);

0 commit comments

Comments
 (0)