Linux 4.6-rc1
[sfrench/cifs-2.6.git] / drivers / scsi / cxlflash / main.h
1 /*
2  * CXL Flash Device Driver
3  *
4  * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
5  *             Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
6  *
7  * Copyright (C) 2015 IBM Corporation
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version
12  * 2 of the License, or (at your option) any later version.
13  */
14
15 #ifndef _CXLFLASH_MAIN_H
16 #define _CXLFLASH_MAIN_H
17
18 #include <linux/list.h>
19 #include <linux/types.h>
20 #include <scsi/scsi.h>
21 #include <scsi/scsi_device.h>
22
23 #define CXLFLASH_NAME           "cxlflash"
24 #define CXLFLASH_ADAPTER_NAME   "IBM POWER CXL Flash Adapter"
25
26 #define PCI_DEVICE_ID_IBM_CORSA         0x04F0
27 #define PCI_DEVICE_ID_IBM_FLASH_GT      0x0600
28
29 /* Since there is only one target, make it 0 */
30 #define CXLFLASH_TARGET         0
31 #define CXLFLASH_MAX_CDB_LEN    16
32
33 /* Really only one target per bus since the Texan is directly attached */
34 #define CXLFLASH_MAX_NUM_TARGETS_PER_BUS        1
35 #define CXLFLASH_MAX_NUM_LUNS_PER_TARGET        65536
36
37 #define CXLFLASH_PCI_ERROR_RECOVERY_TIMEOUT     (120 * HZ)
38
39 #define NUM_FC_PORTS    CXLFLASH_NUM_FC_PORTS   /* ports per AFU */
40
41 /* FC defines */
42 #define FC_MTIP_CMDCONFIG 0x010
43 #define FC_MTIP_STATUS 0x018
44
45 #define FC_PNAME 0x300
46 #define FC_CONFIG 0x320
47 #define FC_CONFIG2 0x328
48 #define FC_STATUS 0x330
49 #define FC_ERROR 0x380
50 #define FC_ERRCAP 0x388
51 #define FC_ERRMSK 0x390
52 #define FC_CNT_CRCERR 0x538
53 #define FC_CRC_THRESH 0x580
54
55 #define FC_MTIP_CMDCONFIG_ONLINE        0x20ULL
56 #define FC_MTIP_CMDCONFIG_OFFLINE       0x40ULL
57
58 #define FC_MTIP_STATUS_MASK             0x30ULL
59 #define FC_MTIP_STATUS_ONLINE           0x20ULL
60 #define FC_MTIP_STATUS_OFFLINE          0x10ULL
61
62 /* TIMEOUT and RETRY definitions */
63
64 /* AFU command timeout values */
65 #define MC_AFU_SYNC_TIMEOUT     5       /* 5 secs */
66
67 /* AFU command room retry limit */
68 #define MC_ROOM_RETRY_CNT       10
69
70 /* FC CRC clear periodic timer */
71 #define MC_CRC_THRESH 100       /* threshold in 5 mins */
72
73 #define FC_PORT_STATUS_RETRY_CNT 100    /* 100 100ms retries = 10 seconds */
74 #define FC_PORT_STATUS_RETRY_INTERVAL_US 100000 /* microseconds */
75
76 /* VPD defines */
77 #define CXLFLASH_VPD_LEN        256
78 #define WWPN_LEN        16
79 #define WWPN_BUF_LEN    (WWPN_LEN + 1)
80
81 enum undo_level {
82         RELEASE_CONTEXT = 0,
83         FREE_IRQ,
84         UNMAP_ONE,
85         UNMAP_TWO,
86         UNMAP_THREE,
87         UNDO_START
88 };
89
90 struct dev_dependent_vals {
91         u64 max_sectors;
92 };
93
94 struct asyc_intr_info {
95         u64 status;
96         char *desc;
97         u8 port;
98         u8 action;
99 #define CLR_FC_ERROR    0x01
100 #define LINK_RESET      0x02
101 #define SCAN_HOST       0x04
102 };
103
104 #ifndef CONFIG_CXL_EEH
105 #define cxl_perst_reloads_same_image(_a, _b) do { } while (0)
106 #endif
107
108 #endif /* _CXLFLASH_MAIN_H */