| Message ID | 20200702162651.49526-4-luc.vanoostenryck@gmail.com (mailing list archive) |
|---|---|
| State | Accepted, archived |
| Delegated to: | Bjorn Helgaas |
| Headers | show |
| Series | pci: enforce usage of 'pci_channel_state_t' | expand |
diff --git a/Documentation/PCI/pci-error-recovery.rst b/Documentation/PCI/pci-error-recovery.rst index c055deec8c56..ccd713423133 100644 --- a/Documentation/PCI/pci-error-recovery.rst +++ b/Documentation/PCI/pci-error-recovery.rst @@ -87,11 +87,11 @@ This structure has the form:: The possible channel states are:: - enum pci_channel_state { + typedef enum { pci_channel_io_normal, /* I/O channel is in normal state */ pci_channel_io_frozen, /* I/O to channel is blocked */ pci_channel_io_perm_failure, /* PCI card is dead */ - }; + } pci_channel_state_t; Possible return values are::
The type used to describe the PCI channel state is a combination of a bitwise typedef 'pci_channel_state_t' and an enumeration of constant __force casted to this typedef: enum pci_channel_state. It's a bit complex and quite ugly because: * in C enums are weakly typed (they're essentially the same as 'int') * sparse only allow to define bitwise ints, not bitwise enums. But the idea is clearly to enforce typechecking and thus to use 'pci_channel_state_t' everywhere. So, update the documentation to use 'pci_chanell_state_t' and hide 'enum pci_channel_state' by showing a simplified but somehow equivalent definition: typedef enum { ... } pci_channel_state_t; which makes abstraction of the '__bitwise' which would otherwise just bring unneeded complications here. Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com> --- Documentation/PCI/pci-error-recovery.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)