mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-26 02:39:48 +00:00
![Mauro Carvalho Chehab](/assets/img/avatar_default.png)
Several functions are documented at edac_pci.c and edac_pci_sysfs.c. As we'll be including edac_pci.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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
271 lines
6.8 KiB
C
271 lines
6.8 KiB
C
/*
|
|
* Defines, structures, APIs for edac_pci and edac_pci_sysfs
|
|
*
|
|
* (C) 2007 Linux Networx (http://lnxi.com)
|
|
* This file may be distributed under the terms of the
|
|
* GNU General Public License.
|
|
*
|
|
* Written by Thayne Harbaugh
|
|
* Based on work by Dan Hollis <goemon at anime dot net> and others.
|
|
* http://www.anime.net/~goemon/linux-ecc/
|
|
*
|
|
* NMI handling support added by
|
|
* Dave Peterson <dsp@llnl.gov> <dave_peterson@pobox.com>
|
|
*
|
|
* Refactored for multi-source files:
|
|
* Doug Thompson <norsk5@xmission.com>
|
|
*
|
|
* Please look at Documentation/driver-api/edac.rst for more info about
|
|
* EDAC core structs and functions.
|
|
*/
|
|
|
|
#ifndef _EDAC_PCI_H_
|
|
#define _EDAC_PCI_H_
|
|
|
|
#include <linux/completion.h>
|
|
#include <linux/device.h>
|
|
#include <linux/edac.h>
|
|
#include <linux/kobject.h>
|
|
#include <linux/list.h>
|
|
#include <linux/pci.h>
|
|
#include <linux/types.h>
|
|
#include <linux/workqueue.h>
|
|
|
|
#ifdef CONFIG_PCI
|
|
|
|
struct edac_pci_counter {
|
|
atomic_t pe_count;
|
|
atomic_t npe_count;
|
|
};
|
|
|
|
/*
|
|
* Abstract edac_pci control info structure
|
|
*
|
|
*/
|
|
struct edac_pci_ctl_info {
|
|
/* for global list of edac_pci_ctl_info structs */
|
|
struct list_head link;
|
|
|
|
int pci_idx;
|
|
|
|
struct bus_type *edac_subsys; /* pointer to subsystem */
|
|
|
|
/* the internal state of this controller instance */
|
|
int op_state;
|
|
/* work struct for this instance */
|
|
struct delayed_work work;
|
|
|
|
/* pointer to edac polling checking routine:
|
|
* If NOT NULL: points to polling check routine
|
|
* If NULL: Then assumes INTERRUPT operation, where
|
|
* MC driver will receive events
|
|
*/
|
|
void (*edac_check) (struct edac_pci_ctl_info * edac_dev);
|
|
|
|
struct device *dev; /* pointer to device structure */
|
|
|
|
const char *mod_name; /* module name */
|
|
const char *ctl_name; /* edac controller name */
|
|
const char *dev_name; /* pci/platform/etc... name */
|
|
|
|
void *pvt_info; /* pointer to 'private driver' info */
|
|
|
|
unsigned long start_time; /* edac_pci load start time (jiffies) */
|
|
|
|
struct completion complete;
|
|
|
|
/* sysfs top name under 'edac' directory
|
|
* and instance name:
|
|
* cpu/cpu0/...
|
|
* cpu/cpu1/...
|
|
* cpu/cpu2/...
|
|
* ...
|
|
*/
|
|
char name[EDAC_DEVICE_NAME_LEN + 1];
|
|
|
|
/* Event counters for the this whole EDAC Device */
|
|
struct edac_pci_counter counters;
|
|
|
|
/* edac sysfs device control for the 'name'
|
|
* device this structure controls
|
|
*/
|
|
struct kobject kobj;
|
|
};
|
|
|
|
#define to_edac_pci_ctl_work(w) \
|
|
container_of(w, struct edac_pci_ctl_info,work)
|
|
|
|
/* write all or some bits in a byte-register*/
|
|
static inline void pci_write_bits8(struct pci_dev *pdev, int offset, u8 value,
|
|
u8 mask)
|
|
{
|
|
if (mask != 0xff) {
|
|
u8 buf;
|
|
|
|
pci_read_config_byte(pdev, offset, &buf);
|
|
value &= mask;
|
|
buf &= ~mask;
|
|
value |= buf;
|
|
}
|
|
|
|
pci_write_config_byte(pdev, offset, value);
|
|
}
|
|
|
|
/* write all or some bits in a word-register*/
|
|
static inline void pci_write_bits16(struct pci_dev *pdev, int offset,
|
|
u16 value, u16 mask)
|
|
{
|
|
if (mask != 0xffff) {
|
|
u16 buf;
|
|
|
|
pci_read_config_word(pdev, offset, &buf);
|
|
value &= mask;
|
|
buf &= ~mask;
|
|
value |= buf;
|
|
}
|
|
|
|
pci_write_config_word(pdev, offset, value);
|
|
}
|
|
|
|
/*
|
|
* pci_write_bits32
|
|
*
|
|
* edac local routine to do pci_write_config_dword, but adds
|
|
* a mask parameter. If mask is all ones, ignore the mask.
|
|
* Otherwise utilize the mask to isolate specified bits
|
|
*
|
|
* write all or some bits in a dword-register
|
|
*/
|
|
static inline void pci_write_bits32(struct pci_dev *pdev, int offset,
|
|
u32 value, u32 mask)
|
|
{
|
|
if (mask != 0xffffffff) {
|
|
u32 buf;
|
|
|
|
pci_read_config_dword(pdev, offset, &buf);
|
|
value &= mask;
|
|
buf &= ~mask;
|
|
value |= buf;
|
|
}
|
|
|
|
pci_write_config_dword(pdev, offset, value);
|
|
}
|
|
|
|
#endif /* CONFIG_PCI */
|
|
|
|
/*
|
|
* edac_pci APIs
|
|
*/
|
|
|
|
/**
|
|
* edac_pci_alloc_ctl_info:
|
|
* The alloc() function for the 'edac_pci' control info
|
|
* structure.
|
|
*
|
|
* @sz_pvt: size of the private info at struct &edac_pci_ctl_info
|
|
* @edac_pci_name: name of the PCI device
|
|
*
|
|
* The chip driver will allocate one of these for each
|
|
* edac_pci it is going to control/register with the EDAC CORE.
|
|
*
|
|
* Returns: a pointer to struct &edac_pci_ctl_info on success; %NULL otherwise.
|
|
*/
|
|
extern struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
|
|
const char *edac_pci_name);
|
|
|
|
/**
|
|
* edac_pci_free_ctl_info():
|
|
* Last action on the pci control structure.
|
|
*
|
|
* @pci: pointer to struct &edac_pci_ctl_info
|
|
*
|
|
* Calls the remove sysfs information, which will unregister
|
|
* this control struct's kobj. When that kobj's ref count
|
|
* goes to zero, its release function will be call and then
|
|
* kfree() the memory.
|
|
*/
|
|
extern void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci);
|
|
|
|
/**
|
|
* edac_pci_alloc_index: Allocate a unique PCI index number
|
|
*
|
|
* Returns:
|
|
* allocated index number
|
|
*
|
|
*/
|
|
extern int edac_pci_alloc_index(void);
|
|
|
|
/**
|
|
* edac_pci_add_device(): Insert the 'edac_dev' structure into the
|
|
* edac_pci global list and create sysfs entries associated with
|
|
* edac_pci structure.
|
|
*
|
|
* @pci: pointer to the edac_device structure to be added to the list
|
|
* @edac_idx: A unique numeric identifier to be assigned to the
|
|
* 'edac_pci' structure.
|
|
*
|
|
* Returns:
|
|
* 0 on Success, or an error code on failure
|
|
*/
|
|
extern int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx);
|
|
|
|
/**
|
|
* edac_pci_del_device()
|
|
* Remove sysfs entries for specified edac_pci structure and
|
|
* then remove edac_pci structure from global list
|
|
*
|
|
* @dev:
|
|
* Pointer to 'struct device' representing edac_pci structure
|
|
* to remove
|
|
*
|
|
* Returns:
|
|
* Pointer to removed edac_pci structure,
|
|
* or %NULL if device not found
|
|
*/
|
|
extern struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev);
|
|
|
|
/**
|
|
* edac_pci_create_generic_ctl()
|
|
* A generic constructor for a PCI parity polling device
|
|
* Some systems have more than one domain of PCI busses.
|
|
* For systems with one domain, then this API will
|
|
* provide for a generic poller.
|
|
*
|
|
* @dev: pointer to struct &device;
|
|
* @mod_name: name of the PCI device
|
|
*
|
|
* This routine calls the edac_pci_alloc_ctl_info() for
|
|
* the generic device, with default values
|
|
*
|
|
* Returns: Pointer to struct &edac_pci_ctl_info on success, %NULL on
|
|
* failure.
|
|
*/
|
|
extern struct edac_pci_ctl_info *edac_pci_create_generic_ctl(
|
|
struct device *dev,
|
|
const char *mod_name);
|
|
|
|
/**
|
|
* edac_pci_release_generic_ctl
|
|
* The release function of a generic EDAC PCI polling device
|
|
*
|
|
* @pci: pointer to struct &edac_pci_ctl_info
|
|
*/
|
|
extern void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci);
|
|
|
|
/**
|
|
* edac_pci_create_sysfs
|
|
* Create the controls/attributes for the specified EDAC PCI device
|
|
*
|
|
* @pci: pointer to struct &edac_pci_ctl_info
|
|
*/
|
|
extern int edac_pci_create_sysfs(struct edac_pci_ctl_info *pci);
|
|
|
|
/**
|
|
* edac_pci_remove_sysfs()
|
|
* remove the controls and attributes for this EDAC PCI device
|
|
*
|
|
* @pci: pointer to struct &edac_pci_ctl_info
|
|
*/
|
|
extern void edac_pci_remove_sysfs(struct edac_pci_ctl_info *pci);
|
|
|
|
#endif
|