drivers/ieee1394/sbp2.h

   1 /*
   2  * sbp2.h - Defines and prototypes for sbp2.c
   3  *
   4  * Copyright (C) 2000 James Goodwin, Filanet Corporation (www.filanet.com)
   5  * jamesg@filanet.com
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software Foundation,
  19  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef SBP2_H
  23 #define SBP2_H
  24
  25 #define SBP2_DEVICE_NAME                "sbp2"
  26
  27 /*
  28  * SBP2 specific structures and defines
  29  */
  30
  31 #define ORB_DIRECTION_WRITE_TO_MEDIA    0x0
  32 #define ORB_DIRECTION_READ_FROM_MEDIA   0x1
  33 #define ORB_DIRECTION_NO_DATA_TRANSFER  0x2
  34
  35 #define ORB_SET_NULL_PTR(v)             (((v) & 0x1) << 31)
  36 #define ORB_SET_NOTIFY(v)               (((v) & 0x1) << 31)
  37 #define ORB_SET_RQ_FMT(v)               (((v) & 0x3) << 29)
  38 #define ORB_SET_NODE_ID(v)              (((v) & 0xffff) << 16)
  39 #define ORB_SET_STATUS_FIFO_HI(v, id)   ((v) >> 32 | ORB_SET_NODE_ID(id))
  40 #define ORB_SET_STATUS_FIFO_LO(v)       ((v) & 0xffffffff)
  41 #define ORB_SET_DATA_SIZE(v)            ((v) & 0xffff)
  42 #define ORB_SET_PAGE_SIZE(v)            (((v) & 0x7) << 16)
  43 #define ORB_SET_PAGE_TABLE_PRESENT(v)   (((v) & 0x1) << 19)
  44 #define ORB_SET_MAX_PAYLOAD(v)          (((v) & 0xf) << 20)
  45 #define ORB_SET_SPEED(v)                (((v) & 0x7) << 24)
  46 #define ORB_SET_DIRECTION(v)            (((v) & 0x1) << 27)
  47
  48 struct sbp2_command_orb {
  49         u32 next_ORB_hi;
  50         u32 next_ORB_lo;
  51         u32 data_descriptor_hi;
  52         u32 data_descriptor_lo;
  53         u32 misc;
  54         u8 cdb[12];
  55 } __attribute__((packed));
  56
  57 #define SBP2_LOGIN_REQUEST              0x0
  58 #define SBP2_QUERY_LOGINS_REQUEST       0x1
  59 #define SBP2_RECONNECT_REQUEST          0x3
  60 #define SBP2_SET_PASSWORD_REQUEST       0x4
  61 #define SBP2_LOGOUT_REQUEST             0x7
  62 #define SBP2_ABORT_TASK_REQUEST         0xb
  63 #define SBP2_ABORT_TASK_SET             0xc
  64 #define SBP2_LOGICAL_UNIT_RESET         0xe
  65 #define SBP2_TARGET_RESET_REQUEST       0xf
  66
  67 #define ORB_SET_LUN(v)                  ((v) & 0xffff)
  68 #define ORB_SET_FUNCTION(v)             (((v) & 0xf) << 16)
  69 #define ORB_SET_RECONNECT(v)            (((v) & 0xf) << 20)
  70 #define ORB_SET_EXCLUSIVE(v)            (((v) & 0x1) << 28)
  71 #define ORB_SET_LOGIN_RESP_LENGTH(v)    ((v) & 0xffff)
  72 #define ORB_SET_PASSWD_LENGTH(v)        (((v) & 0xffff) << 16)
  73
  74 struct sbp2_login_orb {
  75         u32 password_hi;
  76         u32 password_lo;
  77         u32 login_response_hi;
  78         u32 login_response_lo;
  79         u32 lun_misc;
  80         u32 passwd_resp_lengths;
  81         u32 status_fifo_hi;
  82         u32 status_fifo_lo;
  83 } __attribute__((packed));
  84
  85 #define RESPONSE_GET_LOGIN_ID(v)        ((v) & 0xffff)
  86 #define RESPONSE_GET_LENGTH(v)          (((v) >> 16) & 0xffff)
  87 #define RESPONSE_GET_RECONNECT_HOLD(v)  ((v) & 0xffff)
  88
  89 struct sbp2_login_response {
  90         u32 length_login_ID;
  91         u32 command_block_agent_hi;
  92         u32 command_block_agent_lo;
  93         u32 reconnect_hold;
  94 } __attribute__((packed));
  95
  96 #define ORB_SET_LOGIN_ID(v)                 ((v) & 0xffff)
  97 #define ORB_SET_QUERY_LOGINS_RESP_LENGTH(v) ((v) & 0xffff)
  98
  99 struct sbp2_query_logins_orb {
 100         u32 reserved1;
 101         u32 reserved2;
 102         u32 query_response_hi;
 103         u32 query_response_lo;
 104         u32 lun_misc;
 105         u32 reserved_resp_length;
 106         u32 status_fifo_hi;
 107         u32 status_fifo_lo;
 108 } __attribute__((packed));
 109
 110 #define RESPONSE_GET_MAX_LOGINS(v)      ((v) & 0xffff)
 111 #define RESPONSE_GET_ACTIVE_LOGINS(v)   ((RESPONSE_GET_LENGTH((v)) - 4) / 12)
 112
 113 struct sbp2_query_logins_response {
 114         u32 length_max_logins;
 115         u32 misc_IDs;
 116         u32 initiator_misc_hi;
 117         u32 initiator_misc_lo;
 118 } __attribute__((packed));
 119
 120 struct sbp2_reconnect_orb {
 121         u32 reserved1;
 122         u32 reserved2;
 123         u32 reserved3;
 124         u32 reserved4;
 125         u32 login_ID_misc;
 126         u32 reserved5;
 127         u32 status_fifo_hi;
 128         u32 status_fifo_lo;
 129 } __attribute__((packed));
 130
 131 struct sbp2_logout_orb {
 132         u32 reserved1;
 133         u32 reserved2;
 134         u32 reserved3;
 135         u32 reserved4;
 136         u32 login_ID_misc;
 137         u32 reserved5;
 138         u32 status_fifo_hi;
 139         u32 status_fifo_lo;
 140 } __attribute__((packed));
 141
 142 #define PAGE_TABLE_SET_SEGMENT_BASE_HI(v)       ((v) & 0xffff)
 143 #define PAGE_TABLE_SET_SEGMENT_LENGTH(v)        (((v) & 0xffff) << 16)
 144
 145 struct sbp2_unrestricted_page_table {
 146         u32 length_segment_base_hi;
 147         u32 segment_base_lo;
 148 } __attribute__((packed));
 149
 150 #define RESP_STATUS_REQUEST_COMPLETE            0x0
 151 #define RESP_STATUS_TRANSPORT_FAILURE           0x1
 152 #define RESP_STATUS_ILLEGAL_REQUEST             0x2
 153 #define RESP_STATUS_VENDOR_DEPENDENT            0x3
 154
 155 #define SBP2_STATUS_NO_ADDITIONAL_INFO          0x0
 156 #define SBP2_STATUS_REQ_TYPE_NOT_SUPPORTED      0x1
 157 #define SBP2_STATUS_SPEED_NOT_SUPPORTED         0x2
 158 #define SBP2_STATUS_PAGE_SIZE_NOT_SUPPORTED     0x3
 159 #define SBP2_STATUS_ACCESS_DENIED               0x4
 160 #define SBP2_STATUS_LU_NOT_SUPPORTED            0x5
 161 #define SBP2_STATUS_MAX_PAYLOAD_TOO_SMALL       0x6
 162 #define SBP2_STATUS_RESOURCES_UNAVAILABLE       0x8
 163 #define SBP2_STATUS_FUNCTION_REJECTED           0x9
 164 #define SBP2_STATUS_LOGIN_ID_NOT_RECOGNIZED     0xa
 165 #define SBP2_STATUS_DUMMY_ORB_COMPLETED         0xb
 166 #define SBP2_STATUS_REQUEST_ABORTED             0xc
 167 #define SBP2_STATUS_UNSPECIFIED_ERROR           0xff
 168
 169 #define SFMT_CURRENT_ERROR                      0x0
 170 #define SFMT_DEFERRED_ERROR                     0x1
 171 #define SFMT_VENDOR_DEPENDENT_STATUS            0x3
 172
 173 #define STATUS_GET_SRC(v)                       (((v) >> 30) & 0x3)
 174 #define STATUS_GET_RESP(v)                      (((v) >> 28) & 0x3)
 175 #define STATUS_GET_LEN(v)                       (((v) >> 24) & 0x7)
 176 #define STATUS_GET_SBP_STATUS(v)                (((v) >> 16) & 0xff)
 177 #define STATUS_GET_ORB_OFFSET_HI(v)             ((v) & 0x0000ffff)
 178 #define STATUS_TEST_DEAD(v)                     ((v) & 0x08000000)
 179 /* test 'resp' | 'dead' | 'sbp2_status' */
 180 #define STATUS_TEST_RDS(v)                      ((v) & 0x38ff0000)
 181
 182 struct sbp2_status_block {
 183         u32 ORB_offset_hi_misc;
 184         u32 ORB_offset_lo;
 185         u8 command_set_dependent[24];
 186 } __attribute__((packed));
 187
 188 /*
 189  * Miscellaneous SBP2 related config rom defines
 190  */
 191
 192 #define SBP2_UNIT_DIRECTORY_OFFSET_KEY          0xd1
 193 #define SBP2_CSR_OFFSET_KEY                     0x54
 194 #define SBP2_UNIT_SPEC_ID_KEY                   0x12
 195 #define SBP2_UNIT_SW_VERSION_KEY                0x13
 196 #define SBP2_COMMAND_SET_SPEC_ID_KEY            0x38
 197 #define SBP2_COMMAND_SET_KEY                    0x39
 198 #define SBP2_UNIT_CHARACTERISTICS_KEY           0x3a
 199 #define SBP2_DEVICE_TYPE_AND_LUN_KEY            0x14
 200 #define SBP2_FIRMWARE_REVISION_KEY              0x3c
 201
 202 #define SBP2_AGENT_STATE_OFFSET                 0x00ULL
 203 #define SBP2_AGENT_RESET_OFFSET                 0x04ULL
 204 #define SBP2_ORB_POINTER_OFFSET                 0x08ULL
 205 #define SBP2_DOORBELL_OFFSET                    0x10ULL
 206 #define SBP2_UNSOLICITED_STATUS_ENABLE_OFFSET   0x14ULL
 207 #define SBP2_UNSOLICITED_STATUS_VALUE           0xf
 208
 209 #define SBP2_BUSY_TIMEOUT_ADDRESS               0xfffff0000210ULL
 210 #define SBP2_BUSY_TIMEOUT_VALUE                 0xf
 211
 212 #define SBP2_AGENT_RESET_DATA                   0xf
 213
 214 /*
 215  * Unit spec id and sw version entry for SBP-2 devices
 216  */
 217
 218 #define SBP2_UNIT_SPEC_ID_ENTRY                 0x0000609e
 219 #define SBP2_SW_VERSION_ENTRY                   0x00010483
 220
 221 /*
 222  * SCSI specific stuff
 223  */
 224
 225 #define SBP2_MAX_SG_ELEMENT_LENGTH              0xf000
 226 #define SBP2_MAX_SECTORS                        255
 227 /* There is no real limitation of the queue depth (i.e. length of the linked
 228  * list of command ORBs) at the target. The chosen depth is merely an
 229  * implementation detail of the sbp2 driver. */
 230 #define SBP2_MAX_CMDS                           8
 231
 232 #define SBP2_SCSI_STATUS_GOOD                   0x0
 233 #define SBP2_SCSI_STATUS_CHECK_CONDITION        0x2
 234 #define SBP2_SCSI_STATUS_CONDITION_MET          0x4
 235 #define SBP2_SCSI_STATUS_BUSY                   0x8
 236 #define SBP2_SCSI_STATUS_RESERVATION_CONFLICT   0x18
 237 #define SBP2_SCSI_STATUS_COMMAND_TERMINATED     0x22
 238 #define SBP2_SCSI_STATUS_SELECTION_TIMEOUT      0xff
 239
 240 /* This is the two dma types we use for cmd_dma below */
 241 enum cmd_dma_types {
 242         CMD_DMA_NONE,
 243         CMD_DMA_PAGE,
 244         CMD_DMA_SINGLE
 245 };
 246
 247 /*
 248  * Encapsulates all the info necessary for an outstanding command.
 249  */
 250 struct sbp2_command_info {
 251
 252         struct list_head list;
 253         struct sbp2_command_orb command_orb ____cacheline_aligned;
 254         dma_addr_t command_orb_dma ____cacheline_aligned;
 255         struct scsi_cmnd *Current_SCpnt;
 256         void (*Current_done)(struct scsi_cmnd *);
 257
 258         /* Also need s/g structure for each sbp2 command */
 259         struct sbp2_unrestricted_page_table scatter_gather_element[SG_ALL] ____cacheline_aligned;
 260         dma_addr_t sge_dma ____cacheline_aligned;
 261         void *sge_buffer;
 262         dma_addr_t cmd_dma;
 263         enum cmd_dma_types dma_type;
 264         unsigned long dma_size;
 265         int dma_dir;
 266
 267 };
 268
 269 struct sbp2scsi_host_info;
 270
 271 /*
 272  * Information needed on a per scsi id basis (one for each sbp2 device)
 273  */
 274 struct scsi_id_instance_data {
 275         /*
 276          * Various sbp2 specific structures
 277          */
 278         struct sbp2_command_orb *last_orb;
 279         dma_addr_t last_orb_dma;
 280         struct sbp2_login_orb *login_orb;
 281         dma_addr_t login_orb_dma;
 282         struct sbp2_login_response *login_response;
 283         dma_addr_t login_response_dma;
 284         struct sbp2_query_logins_orb *query_logins_orb;
 285         dma_addr_t query_logins_orb_dma;
 286         struct sbp2_query_logins_response *query_logins_response;
 287         dma_addr_t query_logins_response_dma;
 288         struct sbp2_reconnect_orb *reconnect_orb;
 289         dma_addr_t reconnect_orb_dma;
 290         struct sbp2_logout_orb *logout_orb;
 291         dma_addr_t logout_orb_dma;
 292         struct sbp2_status_block status_block;
 293
 294         /*
 295          * Stuff we need to know about the sbp2 device itself
 296          */
 297         u64 sbp2_management_agent_addr;
 298         u64 sbp2_command_block_agent_addr;
 299         u32 speed_code;
 300         u32 max_payload_size;
 301
 302         /*
 303          * Values pulled from the device's unit directory
 304          */
 305         u32 sbp2_command_set_spec_id;
 306         u32 sbp2_command_set;
 307         u32 sbp2_unit_characteristics;
 308         u32 sbp2_lun;
 309         u32 sbp2_firmware_revision;
 310
 311         /*
 312          * Address for the device to write status blocks to
 313          */
 314         u64 status_fifo_addr;
 315
 316         /*
 317          * Waitqueue flag for logins, reconnects, logouts, query logins
 318          */
 319         int access_complete:1;
 320
 321         /*
 322          * Pool of command orbs, so we can have more than overlapped command per id
 323          */
 324         spinlock_t sbp2_command_orb_lock;
 325         struct list_head sbp2_command_orb_inuse;
 326         struct list_head sbp2_command_orb_completed;
 327
 328         struct list_head scsi_list;
 329
 330         /* Node entry, as retrieved from NodeMgr entries */
 331         struct node_entry *ne;
 332         struct unit_directory *ud;
 333
 334         /* A backlink to our host_info */
 335         struct sbp2scsi_host_info *hi;
 336
 337         /* SCSI related pointers */
 338         struct scsi_device *sdev;
 339         struct Scsi_Host *scsi_host;
 340
 341         /* Device specific workarounds/brokeness */
 342         unsigned workarounds;
 343
 344         atomic_t state;
 345         struct work_struct protocol_work;
 346 };
 347
 348 /* For use in scsi_id_instance_data.state */
 349 enum sbp2lu_state_types {
 350         SBP2LU_STATE_RUNNING,           /* all normal */
 351         SBP2LU_STATE_IN_RESET,          /* between bus reset and reconnect */
 352         SBP2LU_STATE_IN_SHUTDOWN        /* when sbp2_remove was called */
 353 };
 354
 355 /* Sbp2 host data structure (one per IEEE1394 host) */
 356 struct sbp2scsi_host_info {
 357         struct hpsb_host *host;         /* IEEE1394 host */
 358         struct list_head scsi_ids;      /* List of scsi ids on this host */
 359 };
 360
 361 /* Flags for detected oddities and brokeness */
 362 #define SBP2_WORKAROUND_128K_MAX_TRANS  0x1
 363 #define SBP2_WORKAROUND_INQUIRY_36      0x2
 364 #define SBP2_WORKAROUND_MODE_SENSE_8    0x4
 365 #define SBP2_WORKAROUND_FIX_CAPACITY    0x8
 366 #define SBP2_WORKAROUND_OVERRIDE        0x100
 367
 368 #endif /* SBP2_H */