1eb3ae0aaSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
212eb4683SFrank Haverkamp #ifndef __CARD_BASE_H__
312eb4683SFrank Haverkamp #define __CARD_BASE_H__
412eb4683SFrank Haverkamp
512eb4683SFrank Haverkamp /**
612eb4683SFrank Haverkamp * IBM Accelerator Family 'GenWQE'
712eb4683SFrank Haverkamp *
812eb4683SFrank Haverkamp * (C) Copyright IBM Corp. 2013
912eb4683SFrank Haverkamp *
1012eb4683SFrank Haverkamp * Author: Frank Haverkamp <haver@linux.vnet.ibm.com>
1112eb4683SFrank Haverkamp * Author: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
1226d8f6f1SFrank Haverkamp * Author: Michael Jung <mijung@gmx.net>
1312eb4683SFrank Haverkamp * Author: Michael Ruettger <michael@ibmra.de>
1412eb4683SFrank Haverkamp */
1512eb4683SFrank Haverkamp
1612eb4683SFrank Haverkamp /*
1712eb4683SFrank Haverkamp * Interfaces within the GenWQE module. Defines genwqe_card and
1812eb4683SFrank Haverkamp * ddcb_queue as well as ddcb_requ.
1912eb4683SFrank Haverkamp */
2012eb4683SFrank Haverkamp
2112eb4683SFrank Haverkamp #include <linux/kernel.h>
2212eb4683SFrank Haverkamp #include <linux/types.h>
2312eb4683SFrank Haverkamp #include <linux/cdev.h>
2412eb4683SFrank Haverkamp #include <linux/stringify.h>
2512eb4683SFrank Haverkamp #include <linux/pci.h>
2612eb4683SFrank Haverkamp #include <linux/semaphore.h>
2712eb4683SFrank Haverkamp #include <linux/uaccess.h>
2812eb4683SFrank Haverkamp #include <linux/io.h>
2912eb4683SFrank Haverkamp #include <linux/debugfs.h>
3090b4e97eSFrank Haverkamp #include <linux/slab.h>
3112eb4683SFrank Haverkamp
3212eb4683SFrank Haverkamp #include <linux/genwqe/genwqe_card.h>
3312eb4683SFrank Haverkamp #include "genwqe_driver.h"
3412eb4683SFrank Haverkamp
3512eb4683SFrank Haverkamp #define GENWQE_MSI_IRQS 4 /* Just one supported, no MSIx */
3612eb4683SFrank Haverkamp
3712eb4683SFrank Haverkamp #define GENWQE_MAX_VFS 15 /* maximum 15 VFs are possible */
3812eb4683SFrank Haverkamp #define GENWQE_MAX_FUNCS 16 /* 1 PF and 15 VFs */
3912eb4683SFrank Haverkamp #define GENWQE_CARD_NO_MAX (16 * GENWQE_MAX_FUNCS)
4012eb4683SFrank Haverkamp
4112eb4683SFrank Haverkamp /* Compile parameters, some of them appear in debugfs for later adjustment */
429d14e766SGuilherme G. Piccoli #define GENWQE_DDCB_MAX 32 /* DDCBs on the work-queue */
439d14e766SGuilherme G. Piccoli #define GENWQE_POLLING_ENABLED 0 /* in case of irqs not working */
449d14e766SGuilherme G. Piccoli #define GENWQE_DDCB_SOFTWARE_TIMEOUT 10 /* timeout per DDCB in seconds */
459d14e766SGuilherme G. Piccoli #define GENWQE_KILL_TIMEOUT 8 /* time until process gets killed */
469d14e766SGuilherme G. Piccoli #define GENWQE_VF_JOBTIMEOUT_MSEC 250 /* 250 msec */
479d14e766SGuilherme G. Piccoli #define GENWQE_PF_JOBTIMEOUT_MSEC 8000 /* 8 sec should be ok */
489d14e766SGuilherme G. Piccoli #define GENWQE_HEALTH_CHECK_INTERVAL 4 /* <= 0: disabled */
4912eb4683SFrank Haverkamp
5012eb4683SFrank Haverkamp /* Sysfs attribute groups used when we create the genwqe device */
5112eb4683SFrank Haverkamp extern const struct attribute_group *genwqe_attribute_groups[];
5212eb4683SFrank Haverkamp
5312eb4683SFrank Haverkamp /*
5412eb4683SFrank Haverkamp * Config space for Genwqe5 A7:
5512eb4683SFrank Haverkamp * 00:[14 10 4b 04]40 00 10 00[00 00 00 12]00 00 00 00
5612eb4683SFrank Haverkamp * 10: 0c 00 00 f0 07 3c 00 00 00 00 00 00 00 00 00 00
5712eb4683SFrank Haverkamp * 20: 00 00 00 00 00 00 00 00 00 00 00 00[14 10 4b 04]
5812eb4683SFrank Haverkamp * 30: 00 00 00 00 50 00 00 00 00 00 00 00 00 00 00 00
5912eb4683SFrank Haverkamp */
6012eb4683SFrank Haverkamp #define PCI_DEVICE_GENWQE 0x044b /* Genwqe DeviceID */
6112eb4683SFrank Haverkamp
6212eb4683SFrank Haverkamp #define PCI_SUBSYSTEM_ID_GENWQE5 0x035f /* Genwqe A5 Subsystem-ID */
6312eb4683SFrank Haverkamp #define PCI_SUBSYSTEM_ID_GENWQE5_NEW 0x044b /* Genwqe A5 Subsystem-ID */
6412eb4683SFrank Haverkamp #define PCI_CLASSCODE_GENWQE5 0x1200 /* UNKNOWN */
6512eb4683SFrank Haverkamp
6612eb4683SFrank Haverkamp #define PCI_SUBVENDOR_ID_IBM_SRIOV 0x0000
6712eb4683SFrank Haverkamp #define PCI_SUBSYSTEM_ID_GENWQE5_SRIOV 0x0000 /* Genwqe A5 Subsystem-ID */
6812eb4683SFrank Haverkamp #define PCI_CLASSCODE_GENWQE5_SRIOV 0x1200 /* UNKNOWN */
6912eb4683SFrank Haverkamp
7012eb4683SFrank Haverkamp #define GENWQE_SLU_ARCH_REQ 2 /* Required SLU architecture level */
7112eb4683SFrank Haverkamp
7212eb4683SFrank Haverkamp /**
7312eb4683SFrank Haverkamp * struct genwqe_reg - Genwqe data dump functionality
7412eb4683SFrank Haverkamp */
7512eb4683SFrank Haverkamp struct genwqe_reg {
7612eb4683SFrank Haverkamp u32 addr;
7712eb4683SFrank Haverkamp u32 idx;
7812eb4683SFrank Haverkamp u64 val;
7912eb4683SFrank Haverkamp };
8012eb4683SFrank Haverkamp
8112eb4683SFrank Haverkamp /*
8212eb4683SFrank Haverkamp * enum genwqe_dbg_type - Specify chip unit to dump/debug
8312eb4683SFrank Haverkamp */
8412eb4683SFrank Haverkamp enum genwqe_dbg_type {
8512eb4683SFrank Haverkamp GENWQE_DBG_UNIT0 = 0, /* captured before prev errs cleared */
8612eb4683SFrank Haverkamp GENWQE_DBG_UNIT1 = 1,
8712eb4683SFrank Haverkamp GENWQE_DBG_UNIT2 = 2,
8812eb4683SFrank Haverkamp GENWQE_DBG_UNIT3 = 3,
8912eb4683SFrank Haverkamp GENWQE_DBG_UNIT4 = 4,
9012eb4683SFrank Haverkamp GENWQE_DBG_UNIT5 = 5,
9112eb4683SFrank Haverkamp GENWQE_DBG_UNIT6 = 6,
9212eb4683SFrank Haverkamp GENWQE_DBG_UNIT7 = 7,
9312eb4683SFrank Haverkamp GENWQE_DBG_REGS = 8,
9412eb4683SFrank Haverkamp GENWQE_DBG_DMA = 9,
9512eb4683SFrank Haverkamp GENWQE_DBG_UNITS = 10, /* max number of possible debug units */
9612eb4683SFrank Haverkamp };
9712eb4683SFrank Haverkamp
9812eb4683SFrank Haverkamp /* Software error injection to simulate card failures */
9912eb4683SFrank Haverkamp #define GENWQE_INJECT_HARDWARE_FAILURE 0x00000001 /* injects -1 reg reads */
10012eb4683SFrank Haverkamp #define GENWQE_INJECT_BUS_RESET_FAILURE 0x00000002 /* pci_bus_reset fail */
10112eb4683SFrank Haverkamp #define GENWQE_INJECT_GFIR_FATAL 0x00000004 /* GFIR = 0x0000ffff */
10212eb4683SFrank Haverkamp #define GENWQE_INJECT_GFIR_INFO 0x00000008 /* GFIR = 0xffff0000 */
10312eb4683SFrank Haverkamp
10412eb4683SFrank Haverkamp /*
10512eb4683SFrank Haverkamp * Genwqe card description and management data.
10612eb4683SFrank Haverkamp *
10712eb4683SFrank Haverkamp * Error-handling in case of card malfunction
10812eb4683SFrank Haverkamp * ------------------------------------------
10912eb4683SFrank Haverkamp *
11012eb4683SFrank Haverkamp * If the card is detected to be defective the outside environment
11112eb4683SFrank Haverkamp * will cause the PCI layer to call deinit (the cleanup function for
11212eb4683SFrank Haverkamp * probe). This is the same effect like doing a unbind/bind operation
11312eb4683SFrank Haverkamp * on the card.
11412eb4683SFrank Haverkamp *
11512eb4683SFrank Haverkamp * The genwqe card driver implements a health checking thread which
11612eb4683SFrank Haverkamp * verifies the card function. If this detects a problem the cards
11712eb4683SFrank Haverkamp * device is being shutdown and restarted again, along with a reset of
11812eb4683SFrank Haverkamp * the card and queue.
11912eb4683SFrank Haverkamp *
12012eb4683SFrank Haverkamp * All functions accessing the card device return either -EIO or -ENODEV
12112eb4683SFrank Haverkamp * code to indicate the malfunction to the user. The user has to close
12212eb4683SFrank Haverkamp * the file descriptor and open a new one, once the card becomes
12312eb4683SFrank Haverkamp * available again.
12412eb4683SFrank Haverkamp *
12512eb4683SFrank Haverkamp * If the open file descriptor is setup to receive SIGIO, the signal is
12612eb4683SFrank Haverkamp * genereated for the application which has to provide a handler to
12712eb4683SFrank Haverkamp * react on it. If the application does not close the open
12812eb4683SFrank Haverkamp * file descriptor a SIGKILL is send to enforce freeing the cards
12912eb4683SFrank Haverkamp * resources.
13012eb4683SFrank Haverkamp *
13112eb4683SFrank Haverkamp * I did not find a different way to prevent kernel problems due to
13212eb4683SFrank Haverkamp * reference counters for the cards character devices getting out of
13312eb4683SFrank Haverkamp * sync. The character device deallocation does not block, even if
13412eb4683SFrank Haverkamp * there is still an open file descriptor pending. If this pending
13512eb4683SFrank Haverkamp * descriptor is closed, the data structures used by the character
13612eb4683SFrank Haverkamp * device is reinstantiated, which will lead to the reference counter
13712eb4683SFrank Haverkamp * dropping below the allowed values.
13812eb4683SFrank Haverkamp *
13912eb4683SFrank Haverkamp * Card recovery
14012eb4683SFrank Haverkamp * -------------
14112eb4683SFrank Haverkamp *
14212eb4683SFrank Haverkamp * To test the internal driver recovery the following command can be used:
14312eb4683SFrank Haverkamp * sudo sh -c 'echo 0xfffff > /sys/class/genwqe/genwqe0_card/err_inject'
14412eb4683SFrank Haverkamp */
14512eb4683SFrank Haverkamp
14612eb4683SFrank Haverkamp
14712eb4683SFrank Haverkamp /**
14812eb4683SFrank Haverkamp * struct dma_mapping_type - Mapping type definition
14912eb4683SFrank Haverkamp *
15012eb4683SFrank Haverkamp * To avoid memcpying data arround we use user memory directly. To do
15112eb4683SFrank Haverkamp * this we need to pin/swap-in the memory and request a DMA address
15212eb4683SFrank Haverkamp * for it.
15312eb4683SFrank Haverkamp */
15412eb4683SFrank Haverkamp enum dma_mapping_type {
15512eb4683SFrank Haverkamp GENWQE_MAPPING_RAW = 0, /* contignous memory buffer */
15612eb4683SFrank Haverkamp GENWQE_MAPPING_SGL_TEMP, /* sglist dynamically used */
15712eb4683SFrank Haverkamp GENWQE_MAPPING_SGL_PINNED, /* sglist used with pinning */
15812eb4683SFrank Haverkamp };
15912eb4683SFrank Haverkamp
16012eb4683SFrank Haverkamp /**
16112eb4683SFrank Haverkamp * struct dma_mapping - Information about memory mappings done by the driver
16212eb4683SFrank Haverkamp */
16312eb4683SFrank Haverkamp struct dma_mapping {
16412eb4683SFrank Haverkamp enum dma_mapping_type type;
16512eb4683SFrank Haverkamp
16612eb4683SFrank Haverkamp void *u_vaddr; /* user-space vaddr/non-aligned */
16712eb4683SFrank Haverkamp void *k_vaddr; /* kernel-space vaddr/non-aligned */
16812eb4683SFrank Haverkamp dma_addr_t dma_addr; /* physical DMA address */
16912eb4683SFrank Haverkamp
17012eb4683SFrank Haverkamp struct page **page_list; /* list of pages used by user buff */
17112eb4683SFrank Haverkamp dma_addr_t *dma_list; /* list of dma addresses per page */
17212eb4683SFrank Haverkamp unsigned int nr_pages; /* number of pages */
17312eb4683SFrank Haverkamp unsigned int size; /* size in bytes */
17412eb4683SFrank Haverkamp
17512eb4683SFrank Haverkamp struct list_head card_list; /* list of usr_maps for card */
17612eb4683SFrank Haverkamp struct list_head pin_list; /* list of pinned memory for dev */
177de4ce2d1SGuilherme G. Piccoli int write; /* writable map? useful in unmapping */
17812eb4683SFrank Haverkamp };
17912eb4683SFrank Haverkamp
genwqe_mapping_init(struct dma_mapping * m,enum dma_mapping_type type)18012eb4683SFrank Haverkamp static inline void genwqe_mapping_init(struct dma_mapping *m,
18112eb4683SFrank Haverkamp enum dma_mapping_type type)
18212eb4683SFrank Haverkamp {
18312eb4683SFrank Haverkamp memset(m, 0, sizeof(*m));
18412eb4683SFrank Haverkamp m->type = type;
185de4ce2d1SGuilherme G. Piccoli m->write = 1; /* Assume the maps we create are R/W */
18612eb4683SFrank Haverkamp }
18712eb4683SFrank Haverkamp
18812eb4683SFrank Haverkamp /**
18912eb4683SFrank Haverkamp * struct ddcb_queue - DDCB queue data
19012eb4683SFrank Haverkamp * @ddcb_max: Number of DDCBs on the queue
19112eb4683SFrank Haverkamp * @ddcb_next: Next free DDCB
19212eb4683SFrank Haverkamp * @ddcb_act: Next DDCB supposed to finish
19312eb4683SFrank Haverkamp * @ddcb_seq: Sequence number of last DDCB
19412eb4683SFrank Haverkamp * @ddcbs_in_flight: Currently enqueued DDCBs
19512eb4683SFrank Haverkamp * @ddcbs_completed: Number of already completed DDCBs
1961451f414SFrank Haverkamp * @return_on_busy: Number of -EBUSY returns on full queue
1971451f414SFrank Haverkamp * @wait_on_busy: Number of waits on full queue
19812eb4683SFrank Haverkamp * @ddcb_daddr: DMA address of first DDCB in the queue
19912eb4683SFrank Haverkamp * @ddcb_vaddr: Kernel virtual address of first DDCB in the queue
20012eb4683SFrank Haverkamp * @ddcb_req: Associated requests (one per DDCB)
20112eb4683SFrank Haverkamp * @ddcb_waitqs: Associated wait queues (one per DDCB)
20212eb4683SFrank Haverkamp * @ddcb_lock: Lock to protect queuing operations
20312eb4683SFrank Haverkamp * @ddcb_waitq: Wait on next DDCB finishing
20412eb4683SFrank Haverkamp */
20512eb4683SFrank Haverkamp
20612eb4683SFrank Haverkamp struct ddcb_queue {
20712eb4683SFrank Haverkamp int ddcb_max; /* amount of DDCBs */
20812eb4683SFrank Haverkamp int ddcb_next; /* next available DDCB num */
20912eb4683SFrank Haverkamp int ddcb_act; /* DDCB to be processed */
21012eb4683SFrank Haverkamp u16 ddcb_seq; /* slc seq num */
21112eb4683SFrank Haverkamp unsigned int ddcbs_in_flight; /* number of ddcbs in processing */
21212eb4683SFrank Haverkamp unsigned int ddcbs_completed;
21312eb4683SFrank Haverkamp unsigned int ddcbs_max_in_flight;
2141451f414SFrank Haverkamp unsigned int return_on_busy; /* how many times -EBUSY? */
2151451f414SFrank Haverkamp unsigned int wait_on_busy;
21612eb4683SFrank Haverkamp
21712eb4683SFrank Haverkamp dma_addr_t ddcb_daddr; /* DMA address */
21812eb4683SFrank Haverkamp struct ddcb *ddcb_vaddr; /* kernel virtual addr for DDCBs */
21912eb4683SFrank Haverkamp struct ddcb_requ **ddcb_req; /* ddcb processing parameter */
22012eb4683SFrank Haverkamp wait_queue_head_t *ddcb_waitqs; /* waitqueue per ddcb */
22112eb4683SFrank Haverkamp
22212eb4683SFrank Haverkamp spinlock_t ddcb_lock; /* exclusive access to queue */
2231451f414SFrank Haverkamp wait_queue_head_t busy_waitq; /* wait for ddcb processing */
22412eb4683SFrank Haverkamp
22512eb4683SFrank Haverkamp /* registers or the respective queue to be used */
22612eb4683SFrank Haverkamp u32 IO_QUEUE_CONFIG;
22712eb4683SFrank Haverkamp u32 IO_QUEUE_STATUS;
22812eb4683SFrank Haverkamp u32 IO_QUEUE_SEGMENT;
22912eb4683SFrank Haverkamp u32 IO_QUEUE_INITSQN;
23012eb4683SFrank Haverkamp u32 IO_QUEUE_WRAP;
23112eb4683SFrank Haverkamp u32 IO_QUEUE_OFFSET;
23212eb4683SFrank Haverkamp u32 IO_QUEUE_WTIME;
23312eb4683SFrank Haverkamp u32 IO_QUEUE_ERRCNTS;
23412eb4683SFrank Haverkamp u32 IO_QUEUE_LRW;
23512eb4683SFrank Haverkamp };
23612eb4683SFrank Haverkamp
23712eb4683SFrank Haverkamp /*
23812eb4683SFrank Haverkamp * GFIR, SLU_UNITCFG, APP_UNITCFG
23912eb4683SFrank Haverkamp * 8 Units with FIR/FEC + 64 * 2ndary FIRS/FEC.
24012eb4683SFrank Haverkamp */
24112eb4683SFrank Haverkamp #define GENWQE_FFDC_REGS (3 + (8 * (2 + 2 * 64)))
24212eb4683SFrank Haverkamp
24312eb4683SFrank Haverkamp struct genwqe_ffdc {
24412eb4683SFrank Haverkamp unsigned int entries;
24512eb4683SFrank Haverkamp struct genwqe_reg *regs;
24612eb4683SFrank Haverkamp };
24712eb4683SFrank Haverkamp
24812eb4683SFrank Haverkamp /**
24912eb4683SFrank Haverkamp * struct genwqe_dev - GenWQE device information
25012eb4683SFrank Haverkamp * @card_state: Card operation state, see above
25112eb4683SFrank Haverkamp * @ffdc: First Failure Data Capture buffers for each unit
25212eb4683SFrank Haverkamp * @card_thread: Working thread to operate the DDCB queue
25312eb4683SFrank Haverkamp * @card_waitq: Wait queue used in card_thread
25412eb4683SFrank Haverkamp * @queue: DDCB queue
25512eb4683SFrank Haverkamp * @health_thread: Card monitoring thread (only for PFs)
25612eb4683SFrank Haverkamp * @health_waitq: Wait queue used in health_thread
25712eb4683SFrank Haverkamp * @pci_dev: Associated PCI device (function)
25812eb4683SFrank Haverkamp * @mmio: Base address of 64-bit register space
25912eb4683SFrank Haverkamp * @mmio_len: Length of register area
26012eb4683SFrank Haverkamp * @file_lock: Lock to protect access to file_list
26112eb4683SFrank Haverkamp * @file_list: List of all processes with open GenWQE file descriptors
26212eb4683SFrank Haverkamp *
26312eb4683SFrank Haverkamp * This struct contains all information needed to communicate with a
26412eb4683SFrank Haverkamp * GenWQE card. It is initialized when a GenWQE device is found and
26512eb4683SFrank Haverkamp * destroyed when it goes away. It holds data to maintain the queue as
26612eb4683SFrank Haverkamp * well as data needed to feed the user interfaces.
26712eb4683SFrank Haverkamp */
26812eb4683SFrank Haverkamp struct genwqe_dev {
26912eb4683SFrank Haverkamp enum genwqe_card_state card_state;
27012eb4683SFrank Haverkamp spinlock_t print_lock;
27112eb4683SFrank Haverkamp
27212eb4683SFrank Haverkamp int card_idx; /* card index 0..CARD_NO_MAX-1 */
27312eb4683SFrank Haverkamp u64 flags; /* general flags */
27412eb4683SFrank Haverkamp
27512eb4683SFrank Haverkamp /* FFDC data gathering */
27612eb4683SFrank Haverkamp struct genwqe_ffdc ffdc[GENWQE_DBG_UNITS];
27712eb4683SFrank Haverkamp
27812eb4683SFrank Haverkamp /* DDCB workqueue */
27912eb4683SFrank Haverkamp struct task_struct *card_thread;
28012eb4683SFrank Haverkamp wait_queue_head_t queue_waitq;
28112eb4683SFrank Haverkamp struct ddcb_queue queue; /* genwqe DDCB queue */
28212eb4683SFrank Haverkamp unsigned int irqs_processed;
28312eb4683SFrank Haverkamp
28412eb4683SFrank Haverkamp /* Card health checking thread */
28512eb4683SFrank Haverkamp struct task_struct *health_thread;
28612eb4683SFrank Haverkamp wait_queue_head_t health_waitq;
28712eb4683SFrank Haverkamp
288fb145456SKleber Sacilotto de Souza int use_platform_recovery; /* use platform recovery mechanisms */
289fb145456SKleber Sacilotto de Souza
29012eb4683SFrank Haverkamp /* char device */
29112eb4683SFrank Haverkamp dev_t devnum_genwqe; /* major/minor num card */
292*b5fa3379SIvan Orlov const struct class *class_genwqe; /* reference to class object */
29312eb4683SFrank Haverkamp struct device *dev; /* for device creation */
29412eb4683SFrank Haverkamp struct cdev cdev_genwqe; /* char device for card */
29512eb4683SFrank Haverkamp
29612eb4683SFrank Haverkamp struct dentry *debugfs_root; /* debugfs card root directory */
29712eb4683SFrank Haverkamp struct dentry *debugfs_genwqe; /* debugfs driver root directory */
29812eb4683SFrank Haverkamp
29912eb4683SFrank Haverkamp /* pci resources */
30012eb4683SFrank Haverkamp struct pci_dev *pci_dev; /* PCI device */
30112eb4683SFrank Haverkamp void __iomem *mmio; /* BAR-0 MMIO start */
30212eb4683SFrank Haverkamp unsigned long mmio_len;
30395a8825cSFrank Haverkamp int num_vfs;
30412eb4683SFrank Haverkamp u32 vf_jobtimeout_msec[GENWQE_MAX_VFS];
30512eb4683SFrank Haverkamp int is_privileged; /* access to all regs possible */
30612eb4683SFrank Haverkamp
30712eb4683SFrank Haverkamp /* config regs which we need often */
30812eb4683SFrank Haverkamp u64 slu_unitcfg;
30912eb4683SFrank Haverkamp u64 app_unitcfg;
31012eb4683SFrank Haverkamp u64 softreset;
31112eb4683SFrank Haverkamp u64 err_inject;
31212eb4683SFrank Haverkamp u64 last_gfir;
31312eb4683SFrank Haverkamp char app_name[5];
31412eb4683SFrank Haverkamp
31512eb4683SFrank Haverkamp spinlock_t file_lock; /* lock for open files */
31612eb4683SFrank Haverkamp struct list_head file_list; /* list of open files */
31712eb4683SFrank Haverkamp
31812eb4683SFrank Haverkamp /* debugfs parameters */
31912eb4683SFrank Haverkamp int ddcb_software_timeout; /* wait until DDCB times out */
32012eb4683SFrank Haverkamp int skip_recovery; /* circumvention if recovery fails */
32112eb4683SFrank Haverkamp int kill_timeout; /* wait after sending SIGKILL */
32212eb4683SFrank Haverkamp };
32312eb4683SFrank Haverkamp
32412eb4683SFrank Haverkamp /**
32512eb4683SFrank Haverkamp * enum genwqe_requ_state - State of a DDCB execution request
32612eb4683SFrank Haverkamp */
32712eb4683SFrank Haverkamp enum genwqe_requ_state {
32812eb4683SFrank Haverkamp GENWQE_REQU_NEW = 0,
32912eb4683SFrank Haverkamp GENWQE_REQU_ENQUEUED = 1,
33012eb4683SFrank Haverkamp GENWQE_REQU_TAPPED = 2,
33112eb4683SFrank Haverkamp GENWQE_REQU_FINISHED = 3,
33212eb4683SFrank Haverkamp GENWQE_REQU_STATE_MAX,
33312eb4683SFrank Haverkamp };
33412eb4683SFrank Haverkamp
33512eb4683SFrank Haverkamp /**
336718f762eSFrank Haverkamp * struct genwqe_sgl - Scatter gather list describing user-space memory
337718f762eSFrank Haverkamp * @sgl: scatter gather list needs to be 128 byte aligned
338718f762eSFrank Haverkamp * @sgl_dma_addr: dma address of sgl
339718f762eSFrank Haverkamp * @sgl_size: size of area used for sgl
340718f762eSFrank Haverkamp * @user_addr: user-space address of memory area
341718f762eSFrank Haverkamp * @user_size: size of user-space memory area
342718f762eSFrank Haverkamp * @page: buffer for partial pages if needed
343718f762eSFrank Haverkamp * @page_dma_addr: dma address partial pages
344de4ce2d1SGuilherme G. Piccoli * @write: should we write it back to userspace?
345718f762eSFrank Haverkamp */
346718f762eSFrank Haverkamp struct genwqe_sgl {
347718f762eSFrank Haverkamp dma_addr_t sgl_dma_addr;
348718f762eSFrank Haverkamp struct sg_entry *sgl;
349718f762eSFrank Haverkamp size_t sgl_size; /* size of sgl */
350718f762eSFrank Haverkamp
351718f762eSFrank Haverkamp void __user *user_addr; /* user-space base-address */
352718f762eSFrank Haverkamp size_t user_size; /* size of memory area */
353718f762eSFrank Haverkamp
354de4ce2d1SGuilherme G. Piccoli int write;
355de4ce2d1SGuilherme G. Piccoli
356718f762eSFrank Haverkamp unsigned long nr_pages;
357718f762eSFrank Haverkamp unsigned long fpage_offs;
358718f762eSFrank Haverkamp size_t fpage_size;
359718f762eSFrank Haverkamp size_t lpage_size;
360718f762eSFrank Haverkamp
361718f762eSFrank Haverkamp void *fpage;
362718f762eSFrank Haverkamp dma_addr_t fpage_dma_addr;
363718f762eSFrank Haverkamp
364718f762eSFrank Haverkamp void *lpage;
365718f762eSFrank Haverkamp dma_addr_t lpage_dma_addr;
366718f762eSFrank Haverkamp };
367718f762eSFrank Haverkamp
368718f762eSFrank Haverkamp int genwqe_alloc_sync_sgl(struct genwqe_dev *cd, struct genwqe_sgl *sgl,
369de4ce2d1SGuilherme G. Piccoli void __user *user_addr, size_t user_size, int write);
370718f762eSFrank Haverkamp
371718f762eSFrank Haverkamp int genwqe_setup_sgl(struct genwqe_dev *cd, struct genwqe_sgl *sgl,
372718f762eSFrank Haverkamp dma_addr_t *dma_list);
373718f762eSFrank Haverkamp
374718f762eSFrank Haverkamp int genwqe_free_sync_sgl(struct genwqe_dev *cd, struct genwqe_sgl *sgl);
375718f762eSFrank Haverkamp
376718f762eSFrank Haverkamp /**
37712eb4683SFrank Haverkamp * struct ddcb_requ - Kernel internal representation of the DDCB request
37812eb4683SFrank Haverkamp * @cmd: User space representation of the DDCB execution request
37912eb4683SFrank Haverkamp */
38012eb4683SFrank Haverkamp struct ddcb_requ {
38112eb4683SFrank Haverkamp /* kernel specific content */
38212eb4683SFrank Haverkamp enum genwqe_requ_state req_state; /* request status */
38312eb4683SFrank Haverkamp int num; /* ddcb_no for this request */
38412eb4683SFrank Haverkamp struct ddcb_queue *queue; /* associated queue */
38512eb4683SFrank Haverkamp
38612eb4683SFrank Haverkamp struct dma_mapping dma_mappings[DDCB_FIXUPS];
387718f762eSFrank Haverkamp struct genwqe_sgl sgls[DDCB_FIXUPS];
38812eb4683SFrank Haverkamp
38912eb4683SFrank Haverkamp /* kernel/user shared content */
39012eb4683SFrank Haverkamp struct genwqe_ddcb_cmd cmd; /* ddcb_no for this request */
39112eb4683SFrank Haverkamp struct genwqe_debug_data debug_data;
39212eb4683SFrank Haverkamp };
39312eb4683SFrank Haverkamp
39412eb4683SFrank Haverkamp /**
39512eb4683SFrank Haverkamp * struct genwqe_file - Information for open GenWQE devices
39612eb4683SFrank Haverkamp */
39712eb4683SFrank Haverkamp struct genwqe_file {
39812eb4683SFrank Haverkamp struct genwqe_dev *cd;
39912eb4683SFrank Haverkamp struct genwqe_driver *client;
40012eb4683SFrank Haverkamp struct file *filp;
40112eb4683SFrank Haverkamp
40212eb4683SFrank Haverkamp struct fasync_struct *async_queue;
4030ab93e9cSEric W. Biederman struct pid *opener;
40412eb4683SFrank Haverkamp struct list_head list; /* entry in list of open files */
40512eb4683SFrank Haverkamp
40612eb4683SFrank Haverkamp spinlock_t map_lock; /* lock for dma_mappings */
40712eb4683SFrank Haverkamp struct list_head map_list; /* list of dma_mappings */
40812eb4683SFrank Haverkamp
40912eb4683SFrank Haverkamp spinlock_t pin_lock; /* lock for pinned memory */
41012eb4683SFrank Haverkamp struct list_head pin_list; /* list of pinned memory */
41112eb4683SFrank Haverkamp };
41212eb4683SFrank Haverkamp
41312eb4683SFrank Haverkamp int genwqe_setup_service_layer(struct genwqe_dev *cd); /* for PF only */
41412eb4683SFrank Haverkamp int genwqe_finish_queue(struct genwqe_dev *cd);
41512eb4683SFrank Haverkamp int genwqe_release_service_layer(struct genwqe_dev *cd);
41612eb4683SFrank Haverkamp
41712eb4683SFrank Haverkamp /**
41812eb4683SFrank Haverkamp * genwqe_get_slu_id() - Read Service Layer Unit Id
41912eb4683SFrank Haverkamp * Return: 0x00: Development code
42012eb4683SFrank Haverkamp * 0x01: SLC1 (old)
42112eb4683SFrank Haverkamp * 0x02: SLC2 (sept2012)
42212eb4683SFrank Haverkamp * 0x03: SLC2 (feb2013, generic driver)
42312eb4683SFrank Haverkamp */
genwqe_get_slu_id(struct genwqe_dev * cd)42412eb4683SFrank Haverkamp static inline int genwqe_get_slu_id(struct genwqe_dev *cd)
42512eb4683SFrank Haverkamp {
42612eb4683SFrank Haverkamp return (int)((cd->slu_unitcfg >> 32) & 0xff);
42712eb4683SFrank Haverkamp }
42812eb4683SFrank Haverkamp
42912eb4683SFrank Haverkamp int genwqe_ddcbs_in_flight(struct genwqe_dev *cd);
43012eb4683SFrank Haverkamp
43112eb4683SFrank Haverkamp u8 genwqe_card_type(struct genwqe_dev *cd);
43212eb4683SFrank Haverkamp int genwqe_card_reset(struct genwqe_dev *cd);
43312eb4683SFrank Haverkamp int genwqe_set_interrupt_capability(struct genwqe_dev *cd, int count);
43412eb4683SFrank Haverkamp void genwqe_reset_interrupt_capability(struct genwqe_dev *cd);
43512eb4683SFrank Haverkamp
43612eb4683SFrank Haverkamp int genwqe_device_create(struct genwqe_dev *cd);
43712eb4683SFrank Haverkamp int genwqe_device_remove(struct genwqe_dev *cd);
43812eb4683SFrank Haverkamp
43912eb4683SFrank Haverkamp /* debugfs */
440d7ef4857SGreg Kroah-Hartman void genwqe_init_debugfs(struct genwqe_dev *cd);
44112eb4683SFrank Haverkamp void genqwe_exit_debugfs(struct genwqe_dev *cd);
44212eb4683SFrank Haverkamp
44312eb4683SFrank Haverkamp int genwqe_read_softreset(struct genwqe_dev *cd);
44412eb4683SFrank Haverkamp
44512eb4683SFrank Haverkamp /* Hardware Circumventions */
44612eb4683SFrank Haverkamp int genwqe_recovery_on_fatal_gfir_required(struct genwqe_dev *cd);
44712eb4683SFrank Haverkamp int genwqe_flash_readback_fails(struct genwqe_dev *cd);
44812eb4683SFrank Haverkamp
44912eb4683SFrank Haverkamp /**
45012eb4683SFrank Haverkamp * genwqe_write_vreg() - Write register in VF window
45112eb4683SFrank Haverkamp * @cd: genwqe device
45212eb4683SFrank Haverkamp * @reg: register address
45312eb4683SFrank Haverkamp * @val: value to write
45412eb4683SFrank Haverkamp * @func: 0: PF, 1: VF0, ..., 15: VF14
45512eb4683SFrank Haverkamp */
45612eb4683SFrank Haverkamp int genwqe_write_vreg(struct genwqe_dev *cd, u32 reg, u64 val, int func);
45712eb4683SFrank Haverkamp
45812eb4683SFrank Haverkamp /**
45912eb4683SFrank Haverkamp * genwqe_read_vreg() - Read register in VF window
46012eb4683SFrank Haverkamp * @cd: genwqe device
46112eb4683SFrank Haverkamp * @reg: register address
46212eb4683SFrank Haverkamp * @func: 0: PF, 1: VF0, ..., 15: VF14
46312eb4683SFrank Haverkamp *
46412eb4683SFrank Haverkamp * Return: content of the register
46512eb4683SFrank Haverkamp */
46612eb4683SFrank Haverkamp u64 genwqe_read_vreg(struct genwqe_dev *cd, u32 reg, int func);
46712eb4683SFrank Haverkamp
46812eb4683SFrank Haverkamp /* FFDC Buffer Management */
46912eb4683SFrank Haverkamp int genwqe_ffdc_buff_size(struct genwqe_dev *cd, int unit_id);
47012eb4683SFrank Haverkamp int genwqe_ffdc_buff_read(struct genwqe_dev *cd, int unit_id,
47112eb4683SFrank Haverkamp struct genwqe_reg *regs, unsigned int max_regs);
47212eb4683SFrank Haverkamp int genwqe_read_ffdc_regs(struct genwqe_dev *cd, struct genwqe_reg *regs,
47312eb4683SFrank Haverkamp unsigned int max_regs, int all);
47412eb4683SFrank Haverkamp int genwqe_ffdc_dump_dma(struct genwqe_dev *cd,
47512eb4683SFrank Haverkamp struct genwqe_reg *regs, unsigned int max_regs);
47612eb4683SFrank Haverkamp
47712eb4683SFrank Haverkamp int genwqe_init_debug_data(struct genwqe_dev *cd,
47812eb4683SFrank Haverkamp struct genwqe_debug_data *d);
47912eb4683SFrank Haverkamp
48012eb4683SFrank Haverkamp void genwqe_init_crc32(void);
48112eb4683SFrank Haverkamp int genwqe_read_app_id(struct genwqe_dev *cd, char *app_name, int len);
48212eb4683SFrank Haverkamp
48312eb4683SFrank Haverkamp /* Memory allocation/deallocation; dma address handling */
48412eb4683SFrank Haverkamp int genwqe_user_vmap(struct genwqe_dev *cd, struct dma_mapping *m,
485658a494aSGuilherme G. Piccoli void *uaddr, unsigned long size);
48612eb4683SFrank Haverkamp
487658a494aSGuilherme G. Piccoli int genwqe_user_vunmap(struct genwqe_dev *cd, struct dma_mapping *m);
48812eb4683SFrank Haverkamp
dma_mapping_used(struct dma_mapping * m)48912eb4683SFrank Haverkamp static inline bool dma_mapping_used(struct dma_mapping *m)
49012eb4683SFrank Haverkamp {
49112eb4683SFrank Haverkamp if (!m)
4927a927193SGustavo A. R. Silva return false;
49312eb4683SFrank Haverkamp return m->size != 0;
49412eb4683SFrank Haverkamp }
49512eb4683SFrank Haverkamp
49612eb4683SFrank Haverkamp /**
49712eb4683SFrank Haverkamp * __genwqe_execute_ddcb() - Execute DDCB request with addr translation
49812eb4683SFrank Haverkamp *
49912eb4683SFrank Haverkamp * This function will do the address translation changes to the DDCBs
50012eb4683SFrank Haverkamp * according to the definitions required by the ATS field. It looks up
50112eb4683SFrank Haverkamp * the memory allocation buffer or does vmap/vunmap for the respective
50212eb4683SFrank Haverkamp * user-space buffers, inclusive page pinning and scatter gather list
50312eb4683SFrank Haverkamp * buildup and teardown.
50412eb4683SFrank Haverkamp */
50512eb4683SFrank Haverkamp int __genwqe_execute_ddcb(struct genwqe_dev *cd,
5061451f414SFrank Haverkamp struct genwqe_ddcb_cmd *cmd, unsigned int f_flags);
50712eb4683SFrank Haverkamp
50812eb4683SFrank Haverkamp /**
50912eb4683SFrank Haverkamp * __genwqe_execute_raw_ddcb() - Execute DDCB request without addr translation
51012eb4683SFrank Haverkamp *
5114d4896a5SGeliang Tang * This version will not do address translation or any modification of
51212eb4683SFrank Haverkamp * the DDCB data. It is used e.g. for the MoveFlash DDCB which is
51312eb4683SFrank Haverkamp * entirely prepared by the driver itself. That means the appropriate
51412eb4683SFrank Haverkamp * DMA addresses are already in the DDCB and do not need any
51512eb4683SFrank Haverkamp * modification.
51612eb4683SFrank Haverkamp */
51712eb4683SFrank Haverkamp int __genwqe_execute_raw_ddcb(struct genwqe_dev *cd,
5181451f414SFrank Haverkamp struct genwqe_ddcb_cmd *cmd,
5191451f414SFrank Haverkamp unsigned int f_flags);
5201451f414SFrank Haverkamp int __genwqe_enqueue_ddcb(struct genwqe_dev *cd,
5211451f414SFrank Haverkamp struct ddcb_requ *req,
5221451f414SFrank Haverkamp unsigned int f_flags);
52312eb4683SFrank Haverkamp
52412eb4683SFrank Haverkamp int __genwqe_wait_ddcb(struct genwqe_dev *cd, struct ddcb_requ *req);
52512eb4683SFrank Haverkamp int __genwqe_purge_ddcb(struct genwqe_dev *cd, struct ddcb_requ *req);
52612eb4683SFrank Haverkamp
52712eb4683SFrank Haverkamp /* register access */
52812eb4683SFrank Haverkamp int __genwqe_writeq(struct genwqe_dev *cd, u64 byte_offs, u64 val);
52912eb4683SFrank Haverkamp u64 __genwqe_readq(struct genwqe_dev *cd, u64 byte_offs);
53012eb4683SFrank Haverkamp int __genwqe_writel(struct genwqe_dev *cd, u64 byte_offs, u32 val);
53112eb4683SFrank Haverkamp u32 __genwqe_readl(struct genwqe_dev *cd, u64 byte_offs);
53212eb4683SFrank Haverkamp
53312eb4683SFrank Haverkamp void *__genwqe_alloc_consistent(struct genwqe_dev *cd, size_t size,
53412eb4683SFrank Haverkamp dma_addr_t *dma_handle);
53512eb4683SFrank Haverkamp void __genwqe_free_consistent(struct genwqe_dev *cd, size_t size,
53612eb4683SFrank Haverkamp void *vaddr, dma_addr_t dma_handle);
53712eb4683SFrank Haverkamp
53812eb4683SFrank Haverkamp /* Base clock frequency in MHz */
53912eb4683SFrank Haverkamp int genwqe_base_clock_frequency(struct genwqe_dev *cd);
54012eb4683SFrank Haverkamp
54112eb4683SFrank Haverkamp /* Before FFDC is captured the traps should be stopped. */
54212eb4683SFrank Haverkamp void genwqe_stop_traps(struct genwqe_dev *cd);
54312eb4683SFrank Haverkamp void genwqe_start_traps(struct genwqe_dev *cd);
54412eb4683SFrank Haverkamp
54512eb4683SFrank Haverkamp /* Hardware circumvention */
54612eb4683SFrank Haverkamp bool genwqe_need_err_masking(struct genwqe_dev *cd);
54712eb4683SFrank Haverkamp
54812eb4683SFrank Haverkamp /**
54912eb4683SFrank Haverkamp * genwqe_is_privileged() - Determine operation mode for PCI function
55012eb4683SFrank Haverkamp *
55112eb4683SFrank Haverkamp * On Intel with SRIOV support we see:
55212eb4683SFrank Haverkamp * PF: is_physfn = 1 is_virtfn = 0
55312eb4683SFrank Haverkamp * VF: is_physfn = 0 is_virtfn = 1
55412eb4683SFrank Haverkamp *
55512eb4683SFrank Haverkamp * On Systems with no SRIOV support _and_ virtualized systems we get:
55612eb4683SFrank Haverkamp * is_physfn = 0 is_virtfn = 0
55712eb4683SFrank Haverkamp *
55812eb4683SFrank Haverkamp * Other vendors have individual pci device ids to distinguish between
55912eb4683SFrank Haverkamp * virtual function drivers and physical function drivers. GenWQE
56012eb4683SFrank Haverkamp * unfortunately has just on pci device id for both, VFs and PF.
56112eb4683SFrank Haverkamp *
56212eb4683SFrank Haverkamp * The following code is used to distinguish if the card is running in
56312eb4683SFrank Haverkamp * privileged mode, either as true PF or in a virtualized system with
56412eb4683SFrank Haverkamp * full register access e.g. currently on PowerPC.
56512eb4683SFrank Haverkamp *
56612eb4683SFrank Haverkamp * if (pci_dev->is_virtfn)
56712eb4683SFrank Haverkamp * cd->is_privileged = 0;
56812eb4683SFrank Haverkamp * else
56912eb4683SFrank Haverkamp * cd->is_privileged = (__genwqe_readq(cd, IO_SLU_BITSTREAM)
57012eb4683SFrank Haverkamp * != IO_ILLEGAL_VALUE);
57112eb4683SFrank Haverkamp */
genwqe_is_privileged(struct genwqe_dev * cd)57212eb4683SFrank Haverkamp static inline int genwqe_is_privileged(struct genwqe_dev *cd)
57312eb4683SFrank Haverkamp {
57412eb4683SFrank Haverkamp return cd->is_privileged;
57512eb4683SFrank Haverkamp }
57612eb4683SFrank Haverkamp
57712eb4683SFrank Haverkamp #endif /* __CARD_BASE_H__ */
578