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