edac: use Documentation-nano format for some data structs

No functional changes. Just comment improvements. Reviewed-by: Aristeu Rozanski <arozansk@redhat.com> Cc: Doug Thompson <norsk5@yahoo.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

edac: use Documentation-nano format for some data structs
No functional changes. Just comment improvements. Reviewed-by: Aristeu Rozanski <arozansk@redhat.com> Cc: Doug Thompson <norsk5@yahoo.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Mauro Carvalho Chehab
1 parent fd687502dc
Showing 1 changed file with 59 additions and 23 deletions Side-by-side Diff
include/linux/edac.h
@@ -49,7 +49,19 @@
 #define EDAC_MC_LABEL_LEN	31
 #define MC_PROC_NAME_MAX_LEN	7
  
-/* memory devices */
+/**
+ * enum dev_type - describe the type of memory DRAM chips used at the stick
+ * @DEV_UNKNOWN:	Can't be determined, or MC doesn't support detect it
+ * @DEV_X1:		1 bit for data
+ * @DEV_X2:		2 bits for data
+ * @DEV_X4:		4 bits for data
+ * @DEV_X8:		8 bits for data
+ * @DEV_X16:		16 bits for data
+ * @DEV_X32:		32 bits for data
+ * @DEV_X64:		64 bits for data
+ *
+ * Typical values are x4 and x8.
+ */
 enum dev_type {
 	DEV_UNKNOWN = 0,
 	DEV_X1,
  
@@ -167,18 +179,30 @@
 #define MEM_FLAG_DDR3		 BIT(MEM_DDR3)
 #define MEM_FLAG_RDDR3		 BIT(MEM_RDDR3)
  
-/* chipset Error Detection and Correction capabilities and mode */
+/**
+ * enum edac-type - Error Detection and Correction capabilities and mode
+ * @EDAC_UNKNOWN:	Unknown if ECC is available
+ * @EDAC_NONE:		Doesn't support ECC
+ * @EDAC_RESERVED:	Reserved ECC type
+ * @EDAC_PARITY:	Detects parity errors
+ * @EDAC_EC:		Error Checking - no correction
+ * @EDAC_SECDED:	Single bit error correction, Double detection
+ * @EDAC_S2ECD2ED:	Chipkill x2 devices - do these exist?
+ * @EDAC_S4ECD4ED:	Chipkill x4 devices
+ * @EDAC_S8ECD8ED:	Chipkill x8 devices
+ * @EDAC_S16ECD16ED:	Chipkill x16 devices
+ */
 enum edac_type {
-	EDAC_UNKNOWN = 0,	/* Unknown if ECC is available */
-	EDAC_NONE,		/* Doesn't support ECC */
-	EDAC_RESERVED,		/* Reserved ECC type */
-	EDAC_PARITY,		/* Detects parity errors */
-	EDAC_EC,		/* Error Checking - no correction */
-	EDAC_SECDED,		/* Single bit error correction, Double detection */
-	EDAC_S2ECD2ED,		/* Chipkill x2 devices - do these exist? */
-	EDAC_S4ECD4ED,		/* Chipkill x4 devices */
-	EDAC_S8ECD8ED,		/* Chipkill x8 devices */
-	EDAC_S16ECD16ED,	/* Chipkill x16 devices */
+	EDAC_UNKNOWN =	0,
+	EDAC_NONE,
+	EDAC_RESERVED,
+	EDAC_PARITY,
+	EDAC_EC,
+	EDAC_SECDED,
+	EDAC_S2ECD2ED,
+	EDAC_S4ECD4ED,
+	EDAC_S8ECD8ED,
+	EDAC_S16ECD16ED,
 };
  
 #define EDAC_FLAG_UNKNOWN	BIT(EDAC_UNKNOWN)
  
@@ -191,18 +215,30 @@
 #define EDAC_FLAG_S8ECD8ED	BIT(EDAC_S8ECD8ED)
 #define EDAC_FLAG_S16ECD16ED	BIT(EDAC_S16ECD16ED)
  
-/* scrubbing capabilities */
+/**
+ * enum scrub_type - scrubbing capabilities
+ * @SCRUB_UNKNOWN		Unknown if scrubber is available
+ * @SCRUB_NONE:			No scrubber
+ * @SCRUB_SW_PROG:		SW progressive (sequential) scrubbing
+ * @SCRUB_SW_SRC:		Software scrub only errors
+ * @SCRUB_SW_PROG_SRC:		Progressive software scrub from an error
+ * @SCRUB_SW_TUNABLE:		Software scrub frequency is tunable
+ * @SCRUB_HW_PROG:		HW progressive (sequential) scrubbing
+ * @SCRUB_HW_SRC:		Hardware scrub only errors
+ * @SCRUB_HW_PROG_SRC:		Progressive hardware scrub from an error
+ * SCRUB_HW_TUNABLE:		Hardware scrub frequency is tunable
+ */
 enum scrub_type {
-	SCRUB_UNKNOWN = 0,	/* Unknown if scrubber is available */
-	SCRUB_NONE,		/* No scrubber */
-	SCRUB_SW_PROG,		/* SW progressive (sequential) scrubbing */
-	SCRUB_SW_SRC,		/* Software scrub only errors */
-	SCRUB_SW_PROG_SRC,	/* Progressive software scrub from an error */
-	SCRUB_SW_TUNABLE,	/* Software scrub frequency is tunable */
-	SCRUB_HW_PROG,		/* HW progressive (sequential) scrubbing */
-	SCRUB_HW_SRC,		/* Hardware scrub only errors */
-	SCRUB_HW_PROG_SRC,	/* Progressive hardware scrub from an error */
-	SCRUB_HW_TUNABLE	/* Hardware scrub frequency is tunable */
+	SCRUB_UNKNOWN =	0,
+	SCRUB_NONE,
+	SCRUB_SW_PROG,
+	SCRUB_SW_SRC,
+	SCRUB_SW_PROG_SRC,
+	SCRUB_SW_TUNABLE,
+	SCRUB_HW_PROG,
+	SCRUB_HW_SRC,
+	SCRUB_HW_PROG_SRC,
+	SCRUB_HW_TUNABLE
 };
  
 #define SCRUB_FLAG_SW_PROG	BIT(SCRUB_SW_PROG)
...	...	@@ -49,7 +49,19 @@
49	49	#define EDAC_MC_LABEL_LEN 31
50	50	#define MC_PROC_NAME_MAX_LEN 7
51	51
52		-/* memory devices */
	52	+/**
	53	+ * enum dev_type - describe the type of memory DRAM chips used at the stick
	54	+ * @DEV_UNKNOWN: Can't be determined, or MC doesn't support detect it
	55	+ * @DEV_X1: 1 bit for data
	56	+ * @DEV_X2: 2 bits for data
	57	+ * @DEV_X4: 4 bits for data
	58	+ * @DEV_X8: 8 bits for data
	59	+ * @DEV_X16: 16 bits for data
	60	+ * @DEV_X32: 32 bits for data
	61	+ * @DEV_X64: 64 bits for data
	62	+ *
	63	+ * Typical values are x4 and x8.
	64	+ */
53	65	enum dev_type {
54	66	DEV_UNKNOWN = 0,
55	67	DEV_X1,
56	68
...	...	@@ -167,18 +179,30 @@
167	179	#define MEM_FLAG_DDR3 BIT(MEM_DDR3)
168	180	#define MEM_FLAG_RDDR3 BIT(MEM_RDDR3)
169	181
170		-/* chipset Error Detection and Correction capabilities and mode */
	182	+/**
	183	+ * enum edac-type - Error Detection and Correction capabilities and mode
	184	+ * @EDAC_UNKNOWN: Unknown if ECC is available
	185	+ * @EDAC_NONE: Doesn't support ECC
	186	+ * @EDAC_RESERVED: Reserved ECC type
	187	+ * @EDAC_PARITY: Detects parity errors
	188	+ * @EDAC_EC: Error Checking - no correction
	189	+ * @EDAC_SECDED: Single bit error correction, Double detection
	190	+ * @EDAC_S2ECD2ED: Chipkill x2 devices - do these exist?
	191	+ * @EDAC_S4ECD4ED: Chipkill x4 devices
	192	+ * @EDAC_S8ECD8ED: Chipkill x8 devices
	193	+ * @EDAC_S16ECD16ED: Chipkill x16 devices
	194	+ */
171	195	enum edac_type {
172		- EDAC_UNKNOWN = 0, /* Unknown if ECC is available */
173		- EDAC_NONE, /* Doesn't support ECC */
174		- EDAC_RESERVED, /* Reserved ECC type */
175		- EDAC_PARITY, /* Detects parity errors */
176		- EDAC_EC, /* Error Checking - no correction */
177		- EDAC_SECDED, /* Single bit error correction, Double detection */
178		- EDAC_S2ECD2ED, /* Chipkill x2 devices - do these exist? */
179		- EDAC_S4ECD4ED, /* Chipkill x4 devices */
180		- EDAC_S8ECD8ED, /* Chipkill x8 devices */
181		- EDAC_S16ECD16ED, /* Chipkill x16 devices */
	196	+ EDAC_UNKNOWN = 0,
	197	+ EDAC_NONE,
	198	+ EDAC_RESERVED,
	199	+ EDAC_PARITY,
	200	+ EDAC_EC,
	201	+ EDAC_SECDED,
	202	+ EDAC_S2ECD2ED,
	203	+ EDAC_S4ECD4ED,
	204	+ EDAC_S8ECD8ED,
	205	+ EDAC_S16ECD16ED,
182	206	};
183	207
184	208	#define EDAC_FLAG_UNKNOWN BIT(EDAC_UNKNOWN)
185	209
...	...	@@ -191,18 +215,30 @@
191	215	#define EDAC_FLAG_S8ECD8ED BIT(EDAC_S8ECD8ED)
192	216	#define EDAC_FLAG_S16ECD16ED BIT(EDAC_S16ECD16ED)
193	217
194		-/* scrubbing capabilities */
	218	+/**
	219	+ * enum scrub_type - scrubbing capabilities
	220	+ * @SCRUB_UNKNOWN Unknown if scrubber is available
	221	+ * @SCRUB_NONE: No scrubber
	222	+ * @SCRUB_SW_PROG: SW progressive (sequential) scrubbing
	223	+ * @SCRUB_SW_SRC: Software scrub only errors
	224	+ * @SCRUB_SW_PROG_SRC: Progressive software scrub from an error
	225	+ * @SCRUB_SW_TUNABLE: Software scrub frequency is tunable
	226	+ * @SCRUB_HW_PROG: HW progressive (sequential) scrubbing
	227	+ * @SCRUB_HW_SRC: Hardware scrub only errors
	228	+ * @SCRUB_HW_PROG_SRC: Progressive hardware scrub from an error
	229	+ * SCRUB_HW_TUNABLE: Hardware scrub frequency is tunable
	230	+ */
195	231	enum scrub_type {
196		- SCRUB_UNKNOWN = 0, /* Unknown if scrubber is available */
197		- SCRUB_NONE, /* No scrubber */
198		- SCRUB_SW_PROG, /* SW progressive (sequential) scrubbing */
199		- SCRUB_SW_SRC, /* Software scrub only errors */
200		- SCRUB_SW_PROG_SRC, /* Progressive software scrub from an error */
201		- SCRUB_SW_TUNABLE, /* Software scrub frequency is tunable */
202		- SCRUB_HW_PROG, /* HW progressive (sequential) scrubbing */
203		- SCRUB_HW_SRC, /* Hardware scrub only errors */
204		- SCRUB_HW_PROG_SRC, /* Progressive hardware scrub from an error */
205		- SCRUB_HW_TUNABLE /* Hardware scrub frequency is tunable */
	232	+ SCRUB_UNKNOWN = 0,
	233	+ SCRUB_NONE,
	234	+ SCRUB_SW_PROG,
	235	+ SCRUB_SW_SRC,
	236	+ SCRUB_SW_PROG_SRC,
	237	+ SCRUB_SW_TUNABLE,
	238	+ SCRUB_HW_PROG,
	239	+ SCRUB_HW_SRC,
	240	+ SCRUB_HW_PROG_SRC,
	241	+ SCRUB_HW_TUNABLE
206	242	};
207	243
208	244	#define SCRUB_FLAG_SW_PROG BIT(SCRUB_SW_PROG)