Skip to content

Commit 2b922a9

Browse files
committed
cxl/registers: Fix Documentation warning
Commit 0f06157 ("cxl/core: Move register mapping infrastructure") neglected to add a DOC header for the new drivers/core/regs.c file. Reported-by: Ben Widawsky <ben.widawsky@intel.com> Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Link: https://lore.kernel.org/r/163072206675.2250120.3527179192933919995.stgit@dwillia2-desk3.amr.corp.intel.com Signed-off-by: Dan Williams <dan.j.williams@intel.com>
1 parent a01da6c commit 2b922a9

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

Documentation/driver-api/cxl/memory-devices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ CXL Core
4343
:doc: cxl pmem
4444

4545
.. kernel-doc:: drivers/cxl/core/regs.c
46-
:internal:
46+
:doc: cxl registers
4747

4848
External Interfaces
4949
===================

drivers/cxl/core/regs.c

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
// SPDX-License-Identifier: GPL-2.0-only
22
/* Copyright(c) 2020 Intel Corporation. */
3-
43
#include <linux/io-64-nonatomic-lo-hi.h>
54
#include <linux/device.h>
65
#include <linux/slab.h>
76
#include <linux/pci.h>
87
#include <cxlmem.h>
98

9+
/**
10+
* DOC: cxl registers
11+
*
12+
* CXL device capabilities are enumerated by PCI DVSEC (Designated
13+
* Vendor-specific) and / or descriptors provided by platform firmware.
14+
* They can be defined as a set like the device and component registers
15+
* mandated by CXL Section 8.1.12.2 Memory Device PCIe Capabilities and
16+
* Extended Capabilities, or they can be individual capabilities
17+
* appended to bridged and endpoint devices.
18+
*
19+
* Provide common infrastructure for enumerating and mapping these
20+
* discrete capabilities.
21+
*/
22+
1023
/**
1124
* cxl_probe_component_regs() - Detect CXL Component register blocks
1225
* @dev: Host device of the @base mapping

0 commit comments

Comments
 (0)