Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5336f754 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

edac: move documentation from edac_device to edac_core.h 



Several functions are documented at edac_device.c.

As we'll be including edac_core.h at drivers-api book, move those,
in order for the kernel-doc markups be part of the API
documentation book.

As several of those kernel-doc macros are not in the right format,
fix them.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 78d88e8a

drivers/edac/edac_device.c

+0 −58
Original line number Diff line number Diff line
@@ -47,21 +47,6 @@ static void edac_device_dump_device(struct edac_device_ctl_info *edac_dev) 
}

#endif				/* CONFIG_EDAC_DEBUG */





/*

 * edac_device_alloc_ctl_info()

 *	Allocate a new edac device control info structure

 *

 *	The control structure is allocated in complete chunk

 *	from the OS. It is in turn sub allocated to the

 *	various objects that compose the structure

 *

 *	The structure has a 'nr_instance' array within itself.

 *	Each instance represents a major component

 *		Example:  L1 cache and L2 cache are 2 instance components

 *

 *	Within each instance is an array of 'nr_blocks' blockoffsets

 */

struct edac_device_ctl_info *edac_device_alloc_ctl_info(

	unsigned sz_private,

	char *edac_device_name, unsigned nr_instances,
@@ -241,11 +226,6 @@ struct edac_device_ctl_info *edac_device_alloc_ctl_info( 
}

EXPORT_SYMBOL_GPL(edac_device_alloc_ctl_info);



/*

 * edac_device_free_ctl_info()

 *	frees the memory allocated by the edac_device_alloc_ctl_info()

 *	function

 */

void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info)

{

	edac_device_unregister_sysfs_main_kobj(ctl_info);
@@ -457,12 +437,6 @@ void edac_device_reset_delay_period(struct edac_device_ctl_info *edac_dev, 
	edac_mod_work(&edac_dev->work, jiffs);

}



/*

 * edac_device_alloc_index: Allocate a unique device index number

 *

 * Return:

 *	allocated index number

 */

int edac_device_alloc_index(void)

{

	static atomic_t device_indexes = ATOMIC_INIT(0);
@@ -471,17 +445,6 @@ int edac_device_alloc_index(void) 
}

EXPORT_SYMBOL_GPL(edac_device_alloc_index);



/**

 * edac_device_add_device: Insert the 'edac_dev' structure into the

 * edac_device global list and create sysfs entries associated with

 * edac_device structure.

 * @edac_device: pointer to the edac_device structure to be added to the list

 * 'edac_device' structure.

 *

 * Return:

 *	0	Success

 *	!0	Failure

 */

int edac_device_add_device(struct edac_device_ctl_info *edac_dev)

{

	edac_dbg(0, "\n");
@@ -538,19 +501,6 @@ int edac_device_add_device(struct edac_device_ctl_info *edac_dev) 
}

EXPORT_SYMBOL_GPL(edac_device_add_device);



/**

 * edac_device_del_device:

 *	Remove sysfs entries for specified edac_device structure and

 *	then remove edac_device structure from global list

 *

 * @dev:

 *	Pointer to 'struct device' representing edac_device

 *	structure to remove.

 *

 * Return:

 *	Pointer to removed edac_device structure,

 *	OR NULL if device not found.

 */

struct edac_device_ctl_info *edac_device_del_device(struct device *dev)

{

	struct edac_device_ctl_info *edac_dev;
@@ -605,10 +555,6 @@ static inline int edac_device_get_panic_on_ue(struct edac_device_ctl_info 
	return edac_dev->panic_on_ue;

}



/*

 * edac_device_handle_ce

 *	perform a common output and handling of an 'edac_dev' CE event

 */

void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,

			int inst_nr, int block_nr, const char *msg)

{
@@ -651,10 +597,6 @@ void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev, 
}

EXPORT_SYMBOL_GPL(edac_device_handle_ce);



/*

 * edac_device_handle_ue

 *	perform a common output and handling of an 'edac_dev' UE event

 */

void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,

			int inst_nr, int block_nr, const char *msg)

{

drivers/edac/edac_device.h

+51 −0
Original line number Diff line number Diff line
@@ -257,12 +257,63 @@ extern struct edac_device_ctl_info *edac_device_alloc_ctl_info( 


extern void edac_device_free_ctl_info(struct edac_device_ctl_info *ctl_info);



/**

 * edac_device_add_device: Insert the 'edac_dev' structure into the

 *	 edac_device global list and create sysfs entries associated with

 *	 edac_device structure.

 *

 * @edac_dev: pointer to edac_device structure to be added to the list

 *	'edac_device' structure.

 *

 * Returns:

 *	0 on Success, or an error code on failure

 */

extern int edac_device_add_device(struct edac_device_ctl_info *edac_dev);



/**

 * edac_device_del_device:

 *	Remove sysfs entries for specified edac_device structure and

 *	then remove edac_device structure from global list

 *

 * @dev:

 *	Pointer to struct &device representing the edac device

 *	structure to remove.

 *

 * Returns:

 *	Pointer to removed edac_device structure,

 *	or %NULL if device not found.

 */

extern struct edac_device_ctl_info *edac_device_del_device(struct device *dev);



/**

 * edac_device_handle_ue():

 *	perform a common output and handling of an 'edac_dev' UE event

 *

 * @edac_dev: pointer to struct &edac_device_ctl_info

 * @inst_nr: number of the instance where the UE error happened

 * @block_nr: number of the block where the UE error happened

 * @msg: message to be printed

 */

extern void edac_device_handle_ue(struct edac_device_ctl_info *edac_dev,

				int inst_nr, int block_nr, const char *msg);

/**

 * edac_device_handle_ce():

 *	perform a common output and handling of an 'edac_dev' CE event

 *

 * @edac_dev: pointer to struct &edac_device_ctl_info

 * @inst_nr: number of the instance where the CE error happened

 * @block_nr: number of the block where the CE error happened

 * @msg: message to be printed

 */

extern void edac_device_handle_ce(struct edac_device_ctl_info *edac_dev,

				int inst_nr, int block_nr, const char *msg);



/**

 * edac_device_alloc_index: Allocate a unique device index number

 *

 * Returns:

 *	allocated index number

 */

extern int edac_device_alloc_index(void);

extern const char *edac_layer_name[];