blob: 8aad480e9b642077ed533c14493107067062c2cf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * ipr.h -- driver for IBM Power Linux RAID adapters
3 *
4 * Written By: Brian King <brking@us.ibm.com>, IBM Corporation
5 *
6 * Copyright (C) 2003, 2004 IBM Corporation
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 *
22 * Alan Cox <alan@redhat.com> - Removed several careless u32/dma_addr_t errors
23 * that broke 64bit platforms.
24 */
25
26#ifndef _IPR_H
27#define _IPR_H
28
29#include <linux/types.h>
30#include <linux/completion.h>
31#include <linux/list.h>
32#include <linux/kref.h>
33#include <scsi/scsi.h>
34#include <scsi/scsi_cmnd.h>
35
36/*
37 * Literals
38 */
brking@us.ibm.com f80ed132005-05-02 19:51:06 -050039#define IPR_DRIVER_VERSION "2.0.14"
40#define IPR_DRIVER_DATE "(May 2, 2005)"
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 * IPR_MAX_CMD_PER_LUN: This defines the maximum number of outstanding
44 * ops per device for devices not running tagged command queuing.
45 * This can be adjusted at runtime through sysfs device attributes.
46 */
47#define IPR_MAX_CMD_PER_LUN 6
48
49/*
50 * IPR_NUM_BASE_CMD_BLKS: This defines the maximum number of
51 * ops the mid-layer can send to the adapter.
52 */
53#define IPR_NUM_BASE_CMD_BLKS 100
54
55#define IPR_SUBS_DEV_ID_2780 0x0264
56#define IPR_SUBS_DEV_ID_5702 0x0266
57#define IPR_SUBS_DEV_ID_5703 0x0278
58#define IPR_SUBS_DEV_ID_572E 0x028D
59#define IPR_SUBS_DEV_ID_573E 0x02D3
60#define IPR_SUBS_DEV_ID_573D 0x02D4
61#define IPR_SUBS_DEV_ID_571A 0x02C0
62#define IPR_SUBS_DEV_ID_571B 0x02BE
63#define IPR_SUBS_DEV_ID_571E 0x02BF
64
65#define IPR_NAME "ipr"
66
67/*
68 * Return codes
69 */
70#define IPR_RC_JOB_CONTINUE 1
71#define IPR_RC_JOB_RETURN 2
72
73/*
74 * IOASCs
75 */
76#define IPR_IOASC_NR_INIT_CMD_REQUIRED 0x02040200
77#define IPR_IOASC_SYNC_REQUIRED 0x023f0000
78#define IPR_IOASC_MED_DO_NOT_REALLOC 0x03110C00
79#define IPR_IOASC_HW_SEL_TIMEOUT 0x04050000
80#define IPR_IOASC_HW_DEV_BUS_STATUS 0x04448500
81#define IPR_IOASC_IOASC_MASK 0xFFFFFF00
82#define IPR_IOASC_SCSI_STATUS_MASK 0x000000FF
83#define IPR_IOASC_IR_RESOURCE_HANDLE 0x05250000
brking@us.ibm.comb0df54b2005-11-01 17:01:47 -060084#define IPR_IOASC_IR_NO_CMDS_TO_2ND_IOA 0x05258100
85#define IPR_IOASA_IR_DUAL_IOA_DISABLED 0x052C8000
Linus Torvalds1da177e2005-04-16 15:20:36 -070086#define IPR_IOASC_BUS_WAS_RESET 0x06290000
87#define IPR_IOASC_BUS_WAS_RESET_BY_OTHER 0x06298000
88#define IPR_IOASC_ABORTED_CMD_TERM_BY_HOST 0x0B5A0000
89
90#define IPR_FIRST_DRIVER_IOASC 0x10000000
91#define IPR_IOASC_IOA_WAS_RESET 0x10000001
92#define IPR_IOASC_PCI_ACCESS_ERROR 0x10000002
93
94#define IPR_NUM_LOG_HCAMS 2
95#define IPR_NUM_CFG_CHG_HCAMS 2
96#define IPR_NUM_HCAMS (IPR_NUM_LOG_HCAMS + IPR_NUM_CFG_CHG_HCAMS)
97#define IPR_MAX_NUM_TARGETS_PER_BUS 0x10
98#define IPR_MAX_NUM_LUNS_PER_TARGET 256
99#define IPR_MAX_NUM_VSET_LUNS_PER_TARGET 8
100#define IPR_VSET_BUS 0xff
101#define IPR_IOA_BUS 0xff
102#define IPR_IOA_TARGET 0xff
103#define IPR_IOA_LUN 0xff
104#define IPR_MAX_NUM_BUSES 4
105#define IPR_MAX_BUS_TO_SCAN IPR_MAX_NUM_BUSES
106
107#define IPR_NUM_RESET_RELOAD_RETRIES 3
108
109/* We need resources for HCAMS, IOA reset, IOA bringdown, and ERP */
110#define IPR_NUM_INTERNAL_CMD_BLKS (IPR_NUM_HCAMS + \
111 ((IPR_NUM_RESET_RELOAD_RETRIES + 1) * 2) + 3)
112
113#define IPR_MAX_COMMANDS IPR_NUM_BASE_CMD_BLKS
114#define IPR_NUM_CMD_BLKS (IPR_NUM_BASE_CMD_BLKS + \
115 IPR_NUM_INTERNAL_CMD_BLKS)
116
117#define IPR_MAX_PHYSICAL_DEVS 192
118
119#define IPR_MAX_SGLIST 64
120#define IPR_IOA_MAX_SECTORS 32767
121#define IPR_VSET_MAX_SECTORS 512
122#define IPR_MAX_CDB_LEN 16
123
124#define IPR_DEFAULT_BUS_WIDTH 16
125#define IPR_80MBs_SCSI_RATE ((80 * 10) / (IPR_DEFAULT_BUS_WIDTH / 8))
126#define IPR_U160_SCSI_RATE ((160 * 10) / (IPR_DEFAULT_BUS_WIDTH / 8))
127#define IPR_U320_SCSI_RATE ((320 * 10) / (IPR_DEFAULT_BUS_WIDTH / 8))
128#define IPR_MAX_SCSI_RATE(width) ((320 * 10) / ((width) / 8))
129
130#define IPR_IOA_RES_HANDLE 0xffffffff
131#define IPR_IOA_RES_ADDR 0x00ffffff
132
133/*
134 * Adapter Commands
135 */
136#define IPR_QUERY_RSRC_STATE 0xC2
137#define IPR_RESET_DEVICE 0xC3
138#define IPR_RESET_TYPE_SELECT 0x80
139#define IPR_LUN_RESET 0x40
140#define IPR_TARGET_RESET 0x20
141#define IPR_BUS_RESET 0x10
142#define IPR_ID_HOST_RR_Q 0xC4
143#define IPR_QUERY_IOA_CONFIG 0xC5
144#define IPR_CANCEL_ALL_REQUESTS 0xCE
145#define IPR_HOST_CONTROLLED_ASYNC 0xCF
146#define IPR_HCAM_CDB_OP_CODE_CONFIG_CHANGE 0x01
147#define IPR_HCAM_CDB_OP_CODE_LOG_DATA 0x02
148#define IPR_SET_SUPPORTED_DEVICES 0xFB
149#define IPR_IOA_SHUTDOWN 0xF7
150#define IPR_WR_BUF_DOWNLOAD_AND_SAVE 0x05
151
152/*
153 * Timeouts
154 */
155#define IPR_SHUTDOWN_TIMEOUT (ipr_fastfail ? 60 * HZ : 10 * 60 * HZ)
156#define IPR_VSET_RW_TIMEOUT (ipr_fastfail ? 30 * HZ : 2 * 60 * HZ)
157#define IPR_ABBREV_SHUTDOWN_TIMEOUT (10 * HZ)
158#define IPR_DEVICE_RESET_TIMEOUT (ipr_fastfail ? 10 * HZ : 30 * HZ)
159#define IPR_CANCEL_ALL_TIMEOUT (ipr_fastfail ? 10 * HZ : 30 * HZ)
160#define IPR_ABORT_TASK_TIMEOUT (ipr_fastfail ? 10 * HZ : 30 * HZ)
161#define IPR_INTERNAL_TIMEOUT (ipr_fastfail ? 10 * HZ : 30 * HZ)
162#define IPR_WRITE_BUFFER_TIMEOUT (10 * 60 * HZ)
163#define IPR_SET_SUP_DEVICE_TIMEOUT (2 * 60 * HZ)
164#define IPR_REQUEST_SENSE_TIMEOUT (10 * HZ)
165#define IPR_OPERATIONAL_TIMEOUT (5 * 60)
166#define IPR_WAIT_FOR_RESET_TIMEOUT (2 * HZ)
167#define IPR_CHECK_FOR_RESET_TIMEOUT (HZ / 10)
168#define IPR_WAIT_FOR_BIST_TIMEOUT (2 * HZ)
169#define IPR_DUMP_TIMEOUT (15 * HZ)
170
171/*
172 * SCSI Literals
173 */
174#define IPR_VENDOR_ID_LEN 8
175#define IPR_PROD_ID_LEN 16
176#define IPR_SERIAL_NUM_LEN 8
177
178/*
179 * Hardware literals
180 */
181#define IPR_FMT2_MBX_ADDR_MASK 0x0fffffff
182#define IPR_FMT2_MBX_BAR_SEL_MASK 0xf0000000
183#define IPR_FMT2_MKR_BAR_SEL_SHIFT 28
184#define IPR_GET_FMT2_BAR_SEL(mbx) \
185(((mbx) & IPR_FMT2_MBX_BAR_SEL_MASK) >> IPR_FMT2_MKR_BAR_SEL_SHIFT)
186#define IPR_SDT_FMT2_BAR0_SEL 0x0
187#define IPR_SDT_FMT2_BAR1_SEL 0x1
188#define IPR_SDT_FMT2_BAR2_SEL 0x2
189#define IPR_SDT_FMT2_BAR3_SEL 0x3
190#define IPR_SDT_FMT2_BAR4_SEL 0x4
191#define IPR_SDT_FMT2_BAR5_SEL 0x5
192#define IPR_SDT_FMT2_EXP_ROM_SEL 0x8
193#define IPR_FMT2_SDT_READY_TO_USE 0xC4D4E3F2
194#define IPR_DOORBELL 0x82800000
brking@us.ibm.com3d1d0da2005-11-01 17:01:54 -0600195#define IPR_RUNTIME_RESET 0x40000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197#define IPR_PCII_IOA_TRANS_TO_OPER (0x80000000 >> 0)
198#define IPR_PCII_IOARCB_XFER_FAILED (0x80000000 >> 3)
199#define IPR_PCII_IOA_UNIT_CHECKED (0x80000000 >> 4)
200#define IPR_PCII_NO_HOST_RRQ (0x80000000 >> 5)
201#define IPR_PCII_CRITICAL_OPERATION (0x80000000 >> 6)
202#define IPR_PCII_IO_DEBUG_ACKNOWLEDGE (0x80000000 >> 7)
203#define IPR_PCII_IOARRIN_LOST (0x80000000 >> 27)
204#define IPR_PCII_MMIO_ERROR (0x80000000 >> 28)
205#define IPR_PCII_PROC_ERR_STATE (0x80000000 >> 29)
206#define IPR_PCII_HRRQ_UPDATED (0x80000000 >> 30)
207#define IPR_PCII_CORE_ISSUED_RST_REQ (0x80000000 >> 31)
208
209#define IPR_PCII_ERROR_INTERRUPTS \
210(IPR_PCII_IOARCB_XFER_FAILED | IPR_PCII_IOA_UNIT_CHECKED | \
211IPR_PCII_NO_HOST_RRQ | IPR_PCII_IOARRIN_LOST | IPR_PCII_MMIO_ERROR)
212
213#define IPR_PCII_OPER_INTERRUPTS \
214(IPR_PCII_ERROR_INTERRUPTS | IPR_PCII_HRRQ_UPDATED | IPR_PCII_IOA_TRANS_TO_OPER)
215
216#define IPR_UPROCI_RESET_ALERT (0x80000000 >> 7)
217#define IPR_UPROCI_IO_DEBUG_ALERT (0x80000000 >> 9)
218
219#define IPR_LDUMP_MAX_LONG_ACK_DELAY_IN_USEC 200000 /* 200 ms */
220#define IPR_LDUMP_MAX_SHORT_ACK_DELAY_IN_USEC 200000 /* 200 ms */
221
222/*
223 * Dump literals
224 */
225#define IPR_MAX_IOA_DUMP_SIZE (4 * 1024 * 1024)
226#define IPR_NUM_SDT_ENTRIES 511
227#define IPR_MAX_NUM_DUMP_PAGES ((IPR_MAX_IOA_DUMP_SIZE / PAGE_SIZE) + 1)
228
229/*
230 * Misc literals
231 */
232#define IPR_NUM_IOADL_ENTRIES IPR_MAX_SGLIST
233
234/*
235 * Adapter interface types
236 */
237
238struct ipr_res_addr {
239 u8 reserved;
240 u8 bus;
241 u8 target;
242 u8 lun;
243#define IPR_GET_PHYS_LOC(res_addr) \
244 (((res_addr).bus << 16) | ((res_addr).target << 8) | (res_addr).lun)
245}__attribute__((packed, aligned (4)));
246
247struct ipr_std_inq_vpids {
248 u8 vendor_id[IPR_VENDOR_ID_LEN];
249 u8 product_id[IPR_PROD_ID_LEN];
250}__attribute__((packed));
251
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600252struct ipr_vpd {
253 struct ipr_std_inq_vpids vpids;
254 u8 sn[IPR_SERIAL_NUM_LEN];
255}__attribute__((packed));
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257struct ipr_std_inq_data {
258 u8 peri_qual_dev_type;
259#define IPR_STD_INQ_PERI_QUAL(peri) ((peri) >> 5)
260#define IPR_STD_INQ_PERI_DEV_TYPE(peri) ((peri) & 0x1F)
261
262 u8 removeable_medium_rsvd;
263#define IPR_STD_INQ_REMOVEABLE_MEDIUM 0x80
264
265#define IPR_IS_DASD_DEVICE(std_inq) \
266((IPR_STD_INQ_PERI_DEV_TYPE((std_inq).peri_qual_dev_type) == TYPE_DISK) && \
267!(((std_inq).removeable_medium_rsvd) & IPR_STD_INQ_REMOVEABLE_MEDIUM))
268
269#define IPR_IS_SES_DEVICE(std_inq) \
270(IPR_STD_INQ_PERI_DEV_TYPE((std_inq).peri_qual_dev_type) == TYPE_ENCLOSURE)
271
272 u8 version;
273 u8 aen_naca_fmt;
274 u8 additional_len;
275 u8 sccs_rsvd;
276 u8 bq_enc_multi;
277 u8 sync_cmdq_flags;
278
279 struct ipr_std_inq_vpids vpids;
280
281 u8 ros_rsvd_ram_rsvd[4];
282
283 u8 serial_num[IPR_SERIAL_NUM_LEN];
284}__attribute__ ((packed));
285
286struct ipr_config_table_entry {
287 u8 service_level;
288 u8 array_id;
289 u8 flags;
290#define IPR_IS_IOA_RESOURCE 0x80
291#define IPR_IS_ARRAY_MEMBER 0x20
292#define IPR_IS_HOT_SPARE 0x10
293
294 u8 rsvd_subtype;
295#define IPR_RES_SUBTYPE(res) (((res)->cfgte.rsvd_subtype) & 0x0f)
296#define IPR_SUBTYPE_AF_DASD 0
297#define IPR_SUBTYPE_GENERIC_SCSI 1
298#define IPR_SUBTYPE_VOLUME_SET 2
299
300 struct ipr_res_addr res_addr;
301 __be32 res_handle;
302 __be32 reserved4[2];
303 struct ipr_std_inq_data std_inq_data;
304}__attribute__ ((packed, aligned (4)));
305
306struct ipr_config_table_hdr {
307 u8 num_entries;
308 u8 flags;
309#define IPR_UCODE_DOWNLOAD_REQ 0x10
310 __be16 reserved;
311}__attribute__((packed, aligned (4)));
312
313struct ipr_config_table {
314 struct ipr_config_table_hdr hdr;
315 struct ipr_config_table_entry dev[IPR_MAX_PHYSICAL_DEVS];
316}__attribute__((packed, aligned (4)));
317
318struct ipr_hostrcb_cfg_ch_not {
319 struct ipr_config_table_entry cfgte;
320 u8 reserved[936];
321}__attribute__((packed, aligned (4)));
322
323struct ipr_supported_device {
324 __be16 data_length;
325 u8 reserved;
326 u8 num_records;
327 struct ipr_std_inq_vpids vpids;
328 u8 reserved2[16];
329}__attribute__((packed, aligned (4)));
330
331/* Command packet structure */
332struct ipr_cmd_pkt {
333 __be16 reserved; /* Reserved by IOA */
334 u8 request_type;
335#define IPR_RQTYPE_SCSICDB 0x00
336#define IPR_RQTYPE_IOACMD 0x01
337#define IPR_RQTYPE_HCAM 0x02
338
339 u8 luntar_luntrn;
340
341 u8 flags_hi;
342#define IPR_FLAGS_HI_WRITE_NOT_READ 0x80
343#define IPR_FLAGS_HI_NO_ULEN_CHK 0x20
344#define IPR_FLAGS_HI_SYNC_OVERRIDE 0x10
345#define IPR_FLAGS_HI_SYNC_COMPLETE 0x08
346#define IPR_FLAGS_HI_NO_LINK_DESC 0x04
347
348 u8 flags_lo;
349#define IPR_FLAGS_LO_ALIGNED_BFR 0x20
350#define IPR_FLAGS_LO_DELAY_AFTER_RST 0x10
351#define IPR_FLAGS_LO_UNTAGGED_TASK 0x00
352#define IPR_FLAGS_LO_SIMPLE_TASK 0x02
353#define IPR_FLAGS_LO_ORDERED_TASK 0x04
354#define IPR_FLAGS_LO_HEAD_OF_Q_TASK 0x06
355#define IPR_FLAGS_LO_ACA_TASK 0x08
356
357 u8 cdb[16];
358 __be16 timeout;
359}__attribute__ ((packed, aligned(4)));
360
361/* IOA Request Control Block 128 bytes */
362struct ipr_ioarcb {
363 __be32 ioarcb_host_pci_addr;
364 __be32 reserved;
365 __be32 res_handle;
366 __be32 host_response_handle;
367 __be32 reserved1;
368 __be32 reserved2;
369 __be32 reserved3;
370
371 __be32 write_data_transfer_length;
372 __be32 read_data_transfer_length;
373 __be32 write_ioadl_addr;
374 __be32 write_ioadl_len;
375 __be32 read_ioadl_addr;
376 __be32 read_ioadl_len;
377
378 __be32 ioasa_host_pci_addr;
379 __be16 ioasa_len;
380 __be16 reserved4;
381
382 struct ipr_cmd_pkt cmd_pkt;
383
384 __be32 add_cmd_parms_len;
385 __be32 add_cmd_parms[10];
386}__attribute__((packed, aligned (4)));
387
388struct ipr_ioadl_desc {
389 __be32 flags_and_data_len;
390#define IPR_IOADL_FLAGS_MASK 0xff000000
391#define IPR_IOADL_GET_FLAGS(x) (be32_to_cpu(x) & IPR_IOADL_FLAGS_MASK)
392#define IPR_IOADL_DATA_LEN_MASK 0x00ffffff
393#define IPR_IOADL_GET_DATA_LEN(x) (be32_to_cpu(x) & IPR_IOADL_DATA_LEN_MASK)
394#define IPR_IOADL_FLAGS_READ 0x48000000
395#define IPR_IOADL_FLAGS_READ_LAST 0x49000000
396#define IPR_IOADL_FLAGS_WRITE 0x68000000
397#define IPR_IOADL_FLAGS_WRITE_LAST 0x69000000
398#define IPR_IOADL_FLAGS_LAST 0x01000000
399
400 __be32 address;
401}__attribute__((packed, aligned (8)));
402
403struct ipr_ioasa_vset {
404 __be32 failing_lba_hi;
405 __be32 failing_lba_lo;
406 __be32 ioa_data[22];
407}__attribute__((packed, aligned (4)));
408
409struct ipr_ioasa_af_dasd {
410 __be32 failing_lba;
411}__attribute__((packed, aligned (4)));
412
413struct ipr_ioasa_gpdd {
414 u8 end_state;
415 u8 bus_phase;
416 __be16 reserved;
417 __be32 ioa_data[23];
418}__attribute__((packed, aligned (4)));
419
420struct ipr_ioasa_raw {
421 __be32 ioa_data[24];
422}__attribute__((packed, aligned (4)));
423
424struct ipr_ioasa {
425 __be32 ioasc;
426#define IPR_IOASC_SENSE_KEY(ioasc) ((ioasc) >> 24)
427#define IPR_IOASC_SENSE_CODE(ioasc) (((ioasc) & 0x00ff0000) >> 16)
428#define IPR_IOASC_SENSE_QUAL(ioasc) (((ioasc) & 0x0000ff00) >> 8)
429#define IPR_IOASC_SENSE_STATUS(ioasc) ((ioasc) & 0x000000ff)
430
431 __be16 ret_stat_len; /* Length of the returned IOASA */
432
433 __be16 avail_stat_len; /* Total Length of status available. */
434
435 __be32 residual_data_len; /* number of bytes in the host data */
436 /* buffers that were not used by the IOARCB command. */
437
438 __be32 ilid;
439#define IPR_NO_ILID 0
440#define IPR_DRIVER_ILID 0xffffffff
441
442 __be32 fd_ioasc;
443
444 __be32 fd_phys_locator;
445
446 __be32 fd_res_handle;
447
448 __be32 ioasc_specific; /* status code specific field */
449#define IPR_IOASC_SPECIFIC_MASK 0x00ffffff
450#define IPR_FIELD_POINTER_VALID (0x80000000 >> 8)
451#define IPR_FIELD_POINTER_MASK 0x0000ffff
452
453 union {
454 struct ipr_ioasa_vset vset;
455 struct ipr_ioasa_af_dasd dasd;
456 struct ipr_ioasa_gpdd gpdd;
457 struct ipr_ioasa_raw raw;
458 } u;
459}__attribute__((packed, aligned (4)));
460
461struct ipr_mode_parm_hdr {
462 u8 length;
463 u8 medium_type;
464 u8 device_spec_parms;
465 u8 block_desc_len;
466}__attribute__((packed));
467
468struct ipr_mode_pages {
469 struct ipr_mode_parm_hdr hdr;
470 u8 data[255 - sizeof(struct ipr_mode_parm_hdr)];
471}__attribute__((packed));
472
473struct ipr_mode_page_hdr {
474 u8 ps_page_code;
475#define IPR_MODE_PAGE_PS 0x80
476#define IPR_GET_MODE_PAGE_CODE(hdr) ((hdr)->ps_page_code & 0x3F)
477 u8 page_length;
478}__attribute__ ((packed));
479
480struct ipr_dev_bus_entry {
481 struct ipr_res_addr res_addr;
482 u8 flags;
483#define IPR_SCSI_ATTR_ENABLE_QAS 0x80
484#define IPR_SCSI_ATTR_DISABLE_QAS 0x40
485#define IPR_SCSI_ATTR_QAS_MASK 0xC0
486#define IPR_SCSI_ATTR_ENABLE_TM 0x20
487#define IPR_SCSI_ATTR_NO_TERM_PWR 0x10
488#define IPR_SCSI_ATTR_TM_SUPPORTED 0x08
489#define IPR_SCSI_ATTR_LVD_TO_SE_NOT_ALLOWED 0x04
490
491 u8 scsi_id;
492 u8 bus_width;
493 u8 extended_reset_delay;
494#define IPR_EXTENDED_RESET_DELAY 7
495
496 __be32 max_xfer_rate;
497
498 u8 spinup_delay;
499 u8 reserved3;
500 __be16 reserved4;
501}__attribute__((packed, aligned (4)));
502
503struct ipr_mode_page28 {
504 struct ipr_mode_page_hdr hdr;
505 u8 num_entries;
506 u8 entry_length;
507 struct ipr_dev_bus_entry bus[0];
508}__attribute__((packed));
509
510struct ipr_ioa_vpd {
511 struct ipr_std_inq_data std_inq_data;
512 u8 ascii_part_num[12];
513 u8 reserved[40];
514 u8 ascii_plant_code[4];
515}__attribute__((packed));
516
517struct ipr_inquiry_page3 {
518 u8 peri_qual_dev_type;
519 u8 page_code;
520 u8 reserved1;
521 u8 page_length;
522 u8 ascii_len;
523 u8 reserved2[3];
524 u8 load_id[4];
525 u8 major_release;
526 u8 card_type;
527 u8 minor_release[2];
528 u8 ptf_number[4];
529 u8 patch_number[4];
530}__attribute__((packed));
531
brking@us.ibm.com62275042005-11-01 17:01:14 -0600532#define IPR_INQUIRY_PAGE0_ENTRIES 20
533struct ipr_inquiry_page0 {
534 u8 peri_qual_dev_type;
535 u8 page_code;
536 u8 reserved1;
537 u8 len;
538 u8 page[IPR_INQUIRY_PAGE0_ENTRIES];
539}__attribute__((packed));
540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541struct ipr_hostrcb_device_data_entry {
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600542 struct ipr_vpd vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 struct ipr_res_addr dev_res_addr;
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600544 struct ipr_vpd new_vpd;
545 struct ipr_vpd ioa_last_with_dev_vpd;
546 struct ipr_vpd cfc_last_with_dev_vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 __be32 ioa_data[5];
548}__attribute__((packed, aligned (4)));
549
550struct ipr_hostrcb_array_data_entry {
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600551 struct ipr_vpd vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 struct ipr_res_addr expected_dev_res_addr;
553 struct ipr_res_addr dev_res_addr;
554}__attribute__((packed, aligned (4)));
555
556struct ipr_hostrcb_type_ff_error {
557 __be32 ioa_data[246];
558}__attribute__((packed, aligned (4)));
559
560struct ipr_hostrcb_type_01_error {
561 __be32 seek_counter;
562 __be32 read_counter;
563 u8 sense_data[32];
564 __be32 ioa_data[236];
565}__attribute__((packed, aligned (4)));
566
567struct ipr_hostrcb_type_02_error {
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600568 struct ipr_vpd ioa_vpd;
569 struct ipr_vpd cfc_vpd;
570 struct ipr_vpd ioa_last_attached_to_cfc_vpd;
571 struct ipr_vpd cfc_last_attached_to_ioa_vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 __be32 ioa_data[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573}__attribute__((packed, aligned (4)));
574
575struct ipr_hostrcb_type_03_error {
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600576 struct ipr_vpd ioa_vpd;
577 struct ipr_vpd cfc_vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 __be32 errors_detected;
579 __be32 errors_logged;
580 u8 ioa_data[12];
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600581 struct ipr_hostrcb_device_data_entry dev[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582}__attribute__((packed, aligned (4)));
583
584struct ipr_hostrcb_type_04_error {
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600585 struct ipr_vpd ioa_vpd;
586 struct ipr_vpd cfc_vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 u8 ioa_data[12];
588 struct ipr_hostrcb_array_data_entry array_member[10];
589 __be32 exposed_mode_adn;
590 __be32 array_id;
brking@us.ibm.comcfc32132005-11-01 17:00:18 -0600591 struct ipr_vpd incomp_dev_vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 __be32 ioa_data2;
593 struct ipr_hostrcb_array_data_entry array_member2[8];
594 struct ipr_res_addr last_func_vset_res_addr;
595 u8 vset_serial_num[IPR_SERIAL_NUM_LEN];
596 u8 protection_level[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}__attribute__((packed, aligned (4)));
598
brking@us.ibm.comb0df54b2005-11-01 17:01:47 -0600599struct ipr_hostrcb_type_07_error {
600 u8 failure_reason[64];
601 struct ipr_vpd vpd;
602 u32 data[222];
603}__attribute__((packed, aligned (4)));
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605struct ipr_hostrcb_error {
606 __be32 failing_dev_ioasc;
607 struct ipr_res_addr failing_dev_res_addr;
608 __be32 failing_dev_res_handle;
609 __be32 prc;
610 union {
611 struct ipr_hostrcb_type_ff_error type_ff_error;
612 struct ipr_hostrcb_type_01_error type_01_error;
613 struct ipr_hostrcb_type_02_error type_02_error;
614 struct ipr_hostrcb_type_03_error type_03_error;
615 struct ipr_hostrcb_type_04_error type_04_error;
brking@us.ibm.comb0df54b2005-11-01 17:01:47 -0600616 struct ipr_hostrcb_type_07_error type_07_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 } u;
618}__attribute__((packed, aligned (4)));
619
620struct ipr_hostrcb_raw {
621 __be32 data[sizeof(struct ipr_hostrcb_error)/sizeof(__be32)];
622}__attribute__((packed, aligned (4)));
623
624struct ipr_hcam {
625 u8 op_code;
626#define IPR_HOST_RCB_OP_CODE_CONFIG_CHANGE 0xE1
627#define IPR_HOST_RCB_OP_CODE_LOG_DATA 0xE2
628
629 u8 notify_type;
630#define IPR_HOST_RCB_NOTIF_TYPE_EXISTING_CHANGED 0x00
631#define IPR_HOST_RCB_NOTIF_TYPE_NEW_ENTRY 0x01
632#define IPR_HOST_RCB_NOTIF_TYPE_REM_ENTRY 0x02
633#define IPR_HOST_RCB_NOTIF_TYPE_ERROR_LOG_ENTRY 0x10
634#define IPR_HOST_RCB_NOTIF_TYPE_INFORMATION_ENTRY 0x11
635
636 u8 notifications_lost;
637#define IPR_HOST_RCB_NO_NOTIFICATIONS_LOST 0
638#define IPR_HOST_RCB_NOTIFICATIONS_LOST 0x80
639
640 u8 flags;
641#define IPR_HOSTRCB_INTERNAL_OPER 0x80
642#define IPR_HOSTRCB_ERR_RESP_SENT 0x40
643
644 u8 overlay_id;
645#define IPR_HOST_RCB_OVERLAY_ID_1 0x01
646#define IPR_HOST_RCB_OVERLAY_ID_2 0x02
647#define IPR_HOST_RCB_OVERLAY_ID_3 0x03
648#define IPR_HOST_RCB_OVERLAY_ID_4 0x04
649#define IPR_HOST_RCB_OVERLAY_ID_6 0x06
brking@us.ibm.comb0df54b2005-11-01 17:01:47 -0600650#define IPR_HOST_RCB_OVERLAY_ID_7 0x07
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651#define IPR_HOST_RCB_OVERLAY_ID_DEFAULT 0xFF
652
653 u8 reserved1[3];
654 __be32 ilid;
655 __be32 time_since_last_ioa_reset;
656 __be32 reserved2;
657 __be32 length;
658
659 union {
660 struct ipr_hostrcb_error error;
661 struct ipr_hostrcb_cfg_ch_not ccn;
662 struct ipr_hostrcb_raw raw;
663 } u;
664}__attribute__((packed, aligned (4)));
665
666struct ipr_hostrcb {
667 struct ipr_hcam hcam;
668 dma_addr_t hostrcb_dma;
669 struct list_head queue;
670};
671
672/* IPR smart dump table structures */
673struct ipr_sdt_entry {
674 __be32 bar_str_offset;
675 __be32 end_offset;
676 u8 entry_byte;
677 u8 reserved[3];
678
679 u8 flags;
680#define IPR_SDT_ENDIAN 0x80
681#define IPR_SDT_VALID_ENTRY 0x20
682
683 u8 resv;
684 __be16 priority;
685}__attribute__((packed, aligned (4)));
686
687struct ipr_sdt_header {
688 __be32 state;
689 __be32 num_entries;
690 __be32 num_entries_used;
691 __be32 dump_size;
692}__attribute__((packed, aligned (4)));
693
694struct ipr_sdt {
695 struct ipr_sdt_header hdr;
696 struct ipr_sdt_entry entry[IPR_NUM_SDT_ENTRIES];
697}__attribute__((packed, aligned (4)));
698
699struct ipr_uc_sdt {
700 struct ipr_sdt_header hdr;
701 struct ipr_sdt_entry entry[1];
702}__attribute__((packed, aligned (4)));
703
704/*
705 * Driver types
706 */
707struct ipr_bus_attributes {
708 u8 bus;
709 u8 qas_enabled;
710 u8 bus_width;
711 u8 reserved;
712 u32 max_xfer_rate;
713};
714
715struct ipr_resource_entry {
716 struct ipr_config_table_entry cfgte;
717 u8 needs_sync_complete:1;
718 u8 in_erp:1;
719 u8 add_to_ml:1;
720 u8 del_from_ml:1;
721 u8 resetting_device:1;
722
723 struct scsi_device *sdev;
724 struct list_head queue;
725};
726
727struct ipr_resource_hdr {
728 u16 num_entries;
729 u16 reserved;
730};
731
732struct ipr_resource_table {
733 struct ipr_resource_hdr hdr;
734 struct ipr_resource_entry dev[IPR_MAX_PHYSICAL_DEVS];
735};
736
737struct ipr_misc_cbs {
738 struct ipr_ioa_vpd ioa_vpd;
brking@us.ibm.com62275042005-11-01 17:01:14 -0600739 struct ipr_inquiry_page0 page0_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 struct ipr_inquiry_page3 page3_data;
741 struct ipr_mode_pages mode_pages;
742 struct ipr_supported_device supp_dev;
743};
744
745struct ipr_interrupt_offsets {
746 unsigned long set_interrupt_mask_reg;
747 unsigned long clr_interrupt_mask_reg;
748 unsigned long sense_interrupt_mask_reg;
749 unsigned long clr_interrupt_reg;
750
751 unsigned long sense_interrupt_reg;
752 unsigned long ioarrin_reg;
753 unsigned long sense_uproc_interrupt_reg;
754 unsigned long set_uproc_interrupt_reg;
755 unsigned long clr_uproc_interrupt_reg;
756};
757
758struct ipr_interrupts {
759 void __iomem *set_interrupt_mask_reg;
760 void __iomem *clr_interrupt_mask_reg;
761 void __iomem *sense_interrupt_mask_reg;
762 void __iomem *clr_interrupt_reg;
763
764 void __iomem *sense_interrupt_reg;
765 void __iomem *ioarrin_reg;
766 void __iomem *sense_uproc_interrupt_reg;
767 void __iomem *set_uproc_interrupt_reg;
768 void __iomem *clr_uproc_interrupt_reg;
769};
770
771struct ipr_chip_cfg_t {
772 u32 mailbox;
773 u8 cache_line_size;
774 struct ipr_interrupt_offsets regs;
775};
776
777struct ipr_chip_t {
778 u16 vendor;
779 u16 device;
780 const struct ipr_chip_cfg_t *cfg;
781};
782
783enum ipr_shutdown_type {
784 IPR_SHUTDOWN_NORMAL = 0x00,
785 IPR_SHUTDOWN_PREPARE_FOR_NORMAL = 0x40,
786 IPR_SHUTDOWN_ABBREV = 0x80,
787 IPR_SHUTDOWN_NONE = 0x100
788};
789
790struct ipr_trace_entry {
791 u32 time;
792
793 u8 op_code;
794 u8 type;
795#define IPR_TRACE_START 0x00
796#define IPR_TRACE_FINISH 0xff
797 u16 cmd_index;
798
799 __be32 res_handle;
800 union {
801 u32 ioasc;
802 u32 add_data;
803 u32 res_addr;
804 } u;
805};
806
807struct ipr_sglist {
808 u32 order;
809 u32 num_sg;
brking@us.ibm.com12baa422005-11-01 17:01:27 -0600810 u32 num_dma_sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 u32 buffer_len;
812 struct scatterlist scatterlist[1];
813};
814
815enum ipr_sdt_state {
816 INACTIVE,
817 WAIT_FOR_DUMP,
818 GET_DUMP,
819 ABORT_DUMP,
820 DUMP_OBTAINED
821};
822
brking@us.ibm.com62275042005-11-01 17:01:14 -0600823enum ipr_cache_state {
824 CACHE_NONE,
825 CACHE_DISABLED,
826 CACHE_ENABLED,
827 CACHE_INVALID
828};
829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830/* Per-controller data */
831struct ipr_ioa_cfg {
832 char eye_catcher[8];
833#define IPR_EYECATCHER "iprcfg"
834
835 struct list_head queue;
836
837 u8 allow_interrupts:1;
838 u8 in_reset_reload:1;
839 u8 in_ioa_bringdown:1;
840 u8 ioa_unit_checked:1;
841 u8 ioa_is_dead:1;
842 u8 dump_taken:1;
843 u8 allow_cmds:1;
844 u8 allow_ml_add_del:1;
845
brking@us.ibm.com62275042005-11-01 17:01:14 -0600846 enum ipr_cache_state cache_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 u16 type; /* CCIN of the card */
848
849 u8 log_level;
850#define IPR_MAX_LOG_LEVEL 4
851#define IPR_DEFAULT_LOG_LEVEL 2
852
853#define IPR_NUM_TRACE_INDEX_BITS 8
854#define IPR_NUM_TRACE_ENTRIES (1 << IPR_NUM_TRACE_INDEX_BITS)
855#define IPR_TRACE_SIZE (sizeof(struct ipr_trace_entry) * IPR_NUM_TRACE_ENTRIES)
856 char trace_start[8];
857#define IPR_TRACE_START_LABEL "trace"
858 struct ipr_trace_entry *trace;
859 u32 trace_index:IPR_NUM_TRACE_INDEX_BITS;
860
861 /*
862 * Queue for free command blocks
863 */
864 char ipr_free_label[8];
865#define IPR_FREEQ_LABEL "free-q"
866 struct list_head free_q;
867
868 /*
869 * Queue for command blocks outstanding to the adapter
870 */
871 char ipr_pending_label[8];
872#define IPR_PENDQ_LABEL "pend-q"
873 struct list_head pending_q;
874
875 char cfg_table_start[8];
876#define IPR_CFG_TBL_START "cfg"
877 struct ipr_config_table *cfg_table;
878 dma_addr_t cfg_table_dma;
879
880 char resource_table_label[8];
881#define IPR_RES_TABLE_LABEL "res_tbl"
882 struct ipr_resource_entry *res_entries;
883 struct list_head free_res_q;
884 struct list_head used_res_q;
885
886 char ipr_hcam_label[8];
887#define IPR_HCAM_LABEL "hcams"
888 struct ipr_hostrcb *hostrcb[IPR_NUM_HCAMS];
889 dma_addr_t hostrcb_dma[IPR_NUM_HCAMS];
890 struct list_head hostrcb_free_q;
891 struct list_head hostrcb_pending_q;
892
893 __be32 *host_rrq;
894 dma_addr_t host_rrq_dma;
895#define IPR_HRRQ_REQ_RESP_HANDLE_MASK 0xfffffffc
896#define IPR_HRRQ_RESP_BIT_SET 0x00000002
897#define IPR_HRRQ_TOGGLE_BIT 0x00000001
898#define IPR_HRRQ_REQ_RESP_HANDLE_SHIFT 2
899 volatile __be32 *hrrq_start;
900 volatile __be32 *hrrq_end;
901 volatile __be32 *hrrq_curr;
902 volatile u32 toggle_bit;
903
904 struct ipr_bus_attributes bus_attr[IPR_MAX_NUM_BUSES];
905
906 const struct ipr_chip_cfg_t *chip_cfg;
907
908 void __iomem *hdw_dma_regs; /* iomapped PCI memory space */
909 unsigned long hdw_dma_regs_pci; /* raw PCI memory space */
910 void __iomem *ioa_mailbox;
911 struct ipr_interrupts regs;
912
913 u16 saved_pcix_cmd_reg;
914 u16 reset_retries;
915
916 u32 errors_logged;
brking@us.ibm.com3d1d0da2005-11-01 17:01:54 -0600917 u32 doorbell;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919 struct Scsi_Host *host;
920 struct pci_dev *pdev;
921 struct ipr_sglist *ucode_sglist;
922 struct ipr_mode_pages *saved_mode_pages;
923 u8 saved_mode_page_len;
924
925 struct work_struct work_q;
926
927 wait_queue_head_t reset_wait_q;
928
929 struct ipr_dump *dump;
930 enum ipr_sdt_state sdt_state;
931
932 struct ipr_misc_cbs *vpd_cbs;
933 dma_addr_t vpd_cbs_dma;
934
935 struct pci_pool *ipr_cmd_pool;
936
937 struct ipr_cmnd *reset_cmd;
938
939 char ipr_cmd_label[8];
940#define IPR_CMD_LABEL "ipr_cmnd"
941 struct ipr_cmnd *ipr_cmnd_list[IPR_NUM_CMD_BLKS];
942 u32 ipr_cmnd_list_dma[IPR_NUM_CMD_BLKS];
943};
944
945struct ipr_cmnd {
946 struct ipr_ioarcb ioarcb;
947 struct ipr_ioasa ioasa;
948 struct ipr_ioadl_desc ioadl[IPR_NUM_IOADL_ENTRIES];
949 struct list_head queue;
950 struct scsi_cmnd *scsi_cmd;
951 struct completion completion;
952 struct timer_list timer;
953 void (*done) (struct ipr_cmnd *);
954 int (*job_step) (struct ipr_cmnd *);
955 u16 cmd_index;
956 u8 sense_buffer[SCSI_SENSE_BUFFERSIZE];
957 dma_addr_t sense_buffer_dma;
958 unsigned short dma_use_sg;
959 dma_addr_t dma_handle;
960 struct ipr_cmnd *sibling;
961 union {
962 enum ipr_shutdown_type shutdown_type;
963 struct ipr_hostrcb *hostrcb;
964 unsigned long time_left;
965 unsigned long scratch;
966 struct ipr_resource_entry *res;
967 struct scsi_device *sdev;
968 } u;
969
970 struct ipr_ioa_cfg *ioa_cfg;
971};
972
973struct ipr_ses_table_entry {
974 char product_id[17];
975 char compare_product_id_byte[17];
976 u32 max_bus_speed_limit; /* MB/sec limit for this backplane */
977};
978
979struct ipr_dump_header {
980 u32 eye_catcher;
981#define IPR_DUMP_EYE_CATCHER 0xC5D4E3F2
982 u32 len;
983 u32 num_entries;
984 u32 first_entry_offset;
985 u32 status;
986#define IPR_DUMP_STATUS_SUCCESS 0
987#define IPR_DUMP_STATUS_QUAL_SUCCESS 2
988#define IPR_DUMP_STATUS_FAILED 0xffffffff
989 u32 os;
990#define IPR_DUMP_OS_LINUX 0x4C4E5558
991 u32 driver_name;
992#define IPR_DUMP_DRIVER_NAME 0x49505232
993}__attribute__((packed, aligned (4)));
994
995struct ipr_dump_entry_header {
996 u32 eye_catcher;
997#define IPR_DUMP_EYE_CATCHER 0xC5D4E3F2
998 u32 len;
999 u32 num_elems;
1000 u32 offset;
1001 u32 data_type;
1002#define IPR_DUMP_DATA_TYPE_ASCII 0x41534349
1003#define IPR_DUMP_DATA_TYPE_BINARY 0x42494E41
1004 u32 id;
1005#define IPR_DUMP_IOA_DUMP_ID 0x494F4131
1006#define IPR_DUMP_LOCATION_ID 0x4C4F4341
1007#define IPR_DUMP_TRACE_ID 0x54524143
1008#define IPR_DUMP_DRIVER_VERSION_ID 0x44525652
1009#define IPR_DUMP_DRIVER_TYPE_ID 0x54595045
1010#define IPR_DUMP_IOA_CTRL_BLK 0x494F4342
1011#define IPR_DUMP_PEND_OPS 0x414F5053
1012 u32 status;
1013}__attribute__((packed, aligned (4)));
1014
1015struct ipr_dump_location_entry {
1016 struct ipr_dump_entry_header hdr;
1017 u8 location[BUS_ID_SIZE];
1018}__attribute__((packed));
1019
1020struct ipr_dump_trace_entry {
1021 struct ipr_dump_entry_header hdr;
1022 u32 trace[IPR_TRACE_SIZE / sizeof(u32)];
1023}__attribute__((packed, aligned (4)));
1024
1025struct ipr_dump_version_entry {
1026 struct ipr_dump_entry_header hdr;
1027 u8 version[sizeof(IPR_DRIVER_VERSION)];
1028};
1029
1030struct ipr_dump_ioa_type_entry {
1031 struct ipr_dump_entry_header hdr;
1032 u32 type;
1033 u32 fw_version;
1034};
1035
1036struct ipr_driver_dump {
1037 struct ipr_dump_header hdr;
1038 struct ipr_dump_version_entry version_entry;
1039 struct ipr_dump_location_entry location_entry;
1040 struct ipr_dump_ioa_type_entry ioa_type_entry;
1041 struct ipr_dump_trace_entry trace_entry;
1042}__attribute__((packed));
1043
1044struct ipr_ioa_dump {
1045 struct ipr_dump_entry_header hdr;
1046 struct ipr_sdt sdt;
1047 __be32 *ioa_data[IPR_MAX_NUM_DUMP_PAGES];
1048 u32 reserved;
1049 u32 next_page_index;
1050 u32 page_offset;
1051 u32 format;
1052#define IPR_SDT_FMT2 2
1053#define IPR_SDT_UNKNOWN 3
1054}__attribute__((packed, aligned (4)));
1055
1056struct ipr_dump {
1057 struct kref kref;
1058 struct ipr_ioa_cfg *ioa_cfg;
1059 struct ipr_driver_dump driver_dump;
1060 struct ipr_ioa_dump ioa_dump;
1061};
1062
1063struct ipr_error_table_t {
1064 u32 ioasc;
1065 int log_ioasa;
1066 int log_hcam;
1067 char *error;
1068};
1069
1070struct ipr_software_inq_lid_info {
1071 __be32 load_id;
1072 __be32 timestamp[3];
1073}__attribute__((packed, aligned (4)));
1074
1075struct ipr_ucode_image_header {
1076 __be32 header_length;
1077 __be32 lid_table_offset;
1078 u8 major_release;
1079 u8 card_type;
1080 u8 minor_release[2];
1081 u8 reserved[20];
1082 char eyecatcher[16];
1083 __be32 num_lids;
1084 struct ipr_software_inq_lid_info lid[1];
1085}__attribute__((packed, aligned (4)));
1086
1087/*
1088 * Macros
1089 */
brking@us.ibm.comd3c74872005-11-01 17:01:34 -06001090#define IPR_DBG_CMD(CMD) if (ipr_debug) { CMD; }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
1092#ifdef CONFIG_SCSI_IPR_TRACE
1093#define ipr_create_trace_file(kobj, attr) sysfs_create_bin_file(kobj, attr)
1094#define ipr_remove_trace_file(kobj, attr) sysfs_remove_bin_file(kobj, attr)
1095#else
1096#define ipr_create_trace_file(kobj, attr) 0
1097#define ipr_remove_trace_file(kobj, attr) do { } while(0)
1098#endif
1099
1100#ifdef CONFIG_SCSI_IPR_DUMP
1101#define ipr_create_dump_file(kobj, attr) sysfs_create_bin_file(kobj, attr)
1102#define ipr_remove_dump_file(kobj, attr) sysfs_remove_bin_file(kobj, attr)
1103#else
1104#define ipr_create_dump_file(kobj, attr) 0
1105#define ipr_remove_dump_file(kobj, attr) do { } while(0)
1106#endif
1107
1108/*
1109 * Error logging macros
1110 */
1111#define ipr_err(...) printk(KERN_ERR IPR_NAME ": "__VA_ARGS__)
1112#define ipr_info(...) printk(KERN_INFO IPR_NAME ": "__VA_ARGS__)
1113#define ipr_crit(...) printk(KERN_CRIT IPR_NAME ": "__VA_ARGS__)
1114#define ipr_warn(...) printk(KERN_WARNING IPR_NAME": "__VA_ARGS__)
1115#define ipr_dbg(...) IPR_DBG_CMD(printk(KERN_INFO IPR_NAME ": "__VA_ARGS__))
1116
Jeff Garzik017560f2005-10-24 18:04:36 -04001117#define ipr_sdev_printk(level, sdev, fmt, args...) \
1118 sdev_printk(level, sdev, fmt, ## args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
1120#define ipr_sdev_err(sdev, fmt, ...) \
1121 ipr_sdev_printk(KERN_ERR, sdev, fmt, ##__VA_ARGS__)
1122
1123#define ipr_sdev_info(sdev, fmt, ...) \
1124 ipr_sdev_printk(KERN_INFO, sdev, fmt, ##__VA_ARGS__)
1125
1126#define ipr_sdev_dbg(sdev, fmt, ...) \
1127 IPR_DBG_CMD(ipr_sdev_printk(KERN_INFO, sdev, fmt, ##__VA_ARGS__))
1128
1129#define ipr_res_printk(level, ioa_cfg, res, fmt, ...) \
1130 printk(level IPR_NAME ": %d:%d:%d:%d: " fmt, ioa_cfg->host->host_no, \
1131 res.bus, res.target, res.lun, ##__VA_ARGS__)
1132
1133#define ipr_res_err(ioa_cfg, res, fmt, ...) \
1134 ipr_res_printk(KERN_ERR, ioa_cfg, res, fmt, ##__VA_ARGS__)
1135#define ipr_res_dbg(ioa_cfg, res, fmt, ...) \
1136 IPR_DBG_CMD(ipr_res_printk(KERN_INFO, ioa_cfg, res, fmt, ##__VA_ARGS__))
1137
brking@us.ibm.comfa15b1f2005-11-01 17:00:27 -06001138#define ipr_phys_res_err(ioa_cfg, res, fmt, ...) \
1139{ \
1140 if ((res).bus >= IPR_MAX_NUM_BUSES) { \
1141 ipr_err(fmt": unknown\n", ##__VA_ARGS__); \
1142 } else { \
1143 ipr_err(fmt": %d:%d:%d:%d\n", \
1144 ##__VA_ARGS__, (ioa_cfg)->host->host_no, \
1145 (res).bus, (res).target, (res).lun); \
1146 } \
1147}
1148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149#define ipr_trace ipr_dbg("%s: %s: Line: %d\n",\
1150 __FILE__, __FUNCTION__, __LINE__)
1151
brking@us.ibm.comd3c74872005-11-01 17:01:34 -06001152#define ENTER IPR_DBG_CMD(printk(KERN_INFO IPR_NAME": Entering %s\n", __FUNCTION__))
1153#define LEAVE IPR_DBG_CMD(printk(KERN_INFO IPR_NAME": Leaving %s\n", __FUNCTION__))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154
1155#define ipr_err_separator \
1156ipr_err("----------------------------------------------------------\n")
1157
1158
1159/*
1160 * Inlines
1161 */
1162
1163/**
1164 * ipr_is_ioa_resource - Determine if a resource is the IOA
1165 * @res: resource entry struct
1166 *
1167 * Return value:
1168 * 1 if IOA / 0 if not IOA
1169 **/
1170static inline int ipr_is_ioa_resource(struct ipr_resource_entry *res)
1171{
1172 return (res->cfgte.flags & IPR_IS_IOA_RESOURCE) ? 1 : 0;
1173}
1174
1175/**
1176 * ipr_is_af_dasd_device - Determine if a resource is an AF DASD
1177 * @res: resource entry struct
1178 *
1179 * Return value:
1180 * 1 if AF DASD / 0 if not AF DASD
1181 **/
1182static inline int ipr_is_af_dasd_device(struct ipr_resource_entry *res)
1183{
1184 if (IPR_IS_DASD_DEVICE(res->cfgte.std_inq_data) &&
1185 !ipr_is_ioa_resource(res) &&
1186 IPR_RES_SUBTYPE(res) == IPR_SUBTYPE_AF_DASD)
1187 return 1;
1188 else
1189 return 0;
1190}
1191
1192/**
1193 * ipr_is_vset_device - Determine if a resource is a VSET
1194 * @res: resource entry struct
1195 *
1196 * Return value:
1197 * 1 if VSET / 0 if not VSET
1198 **/
1199static inline int ipr_is_vset_device(struct ipr_resource_entry *res)
1200{
1201 if (IPR_IS_DASD_DEVICE(res->cfgte.std_inq_data) &&
1202 !ipr_is_ioa_resource(res) &&
1203 IPR_RES_SUBTYPE(res) == IPR_SUBTYPE_VOLUME_SET)
1204 return 1;
1205 else
1206 return 0;
1207}
1208
1209/**
1210 * ipr_is_gscsi - Determine if a resource is a generic scsi resource
1211 * @res: resource entry struct
1212 *
1213 * Return value:
1214 * 1 if GSCSI / 0 if not GSCSI
1215 **/
1216static inline int ipr_is_gscsi(struct ipr_resource_entry *res)
1217{
1218 if (!ipr_is_ioa_resource(res) &&
1219 IPR_RES_SUBTYPE(res) == IPR_SUBTYPE_GENERIC_SCSI)
1220 return 1;
1221 else
1222 return 0;
1223}
1224
1225/**
1226 * ipr_is_device - Determine if resource address is that of a device
1227 * @res_addr: resource address struct
1228 *
1229 * Return value:
1230 * 1 if AF / 0 if not AF
1231 **/
1232static inline int ipr_is_device(struct ipr_res_addr *res_addr)
1233{
1234 if ((res_addr->bus < IPR_MAX_NUM_BUSES) &&
1235 (res_addr->target < IPR_MAX_NUM_TARGETS_PER_BUS))
1236 return 1;
1237
1238 return 0;
1239}
1240
1241/**
1242 * ipr_sdt_is_fmt2 - Determine if a SDT address is in format 2
1243 * @sdt_word: SDT address
1244 *
1245 * Return value:
1246 * 1 if format 2 / 0 if not
1247 **/
1248static inline int ipr_sdt_is_fmt2(u32 sdt_word)
1249{
1250 u32 bar_sel = IPR_GET_FMT2_BAR_SEL(sdt_word);
1251
1252 switch (bar_sel) {
1253 case IPR_SDT_FMT2_BAR0_SEL:
1254 case IPR_SDT_FMT2_BAR1_SEL:
1255 case IPR_SDT_FMT2_BAR2_SEL:
1256 case IPR_SDT_FMT2_BAR3_SEL:
1257 case IPR_SDT_FMT2_BAR4_SEL:
1258 case IPR_SDT_FMT2_BAR5_SEL:
1259 case IPR_SDT_FMT2_EXP_ROM_SEL:
1260 return 1;
1261 };
1262
1263 return 0;
1264}
1265
1266#endif