include/linux/i2o.h

   1 /*
   2  * I2O kernel space accessible structures/APIs
   3  *
   4  * (c) Copyright 1999, 2000 Red Hat Software
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  *
  11  *************************************************************************
  12  *
  13  * This header file defined the I2O APIs/structures for use by
  14  * the I2O kernel modules.
  15  *
  16  */
  17
  18 #ifndef _I2O_H
  19 #define _I2O_H
  20
  21 #ifdef __KERNEL__               /* This file to be included by kernel only */
  22
  23 #include <linux/i2o-dev.h>
  24
  25 /* How many different OSM's are we allowing */
  26 #define I2O_MAX_DRIVERS         8
  27
  28 #include <linux/pci.h>
  29 #include <linux/dma-mapping.h>
  30 #include <linux/string.h>
  31 #include <linux/slab.h>
  32 #include <linux/workqueue.h>    /* work_struct */
  33 #include <linux/mempool.h>
  34 #include <linux/mutex.h>
  35
  36 #include <asm/io.h>
  37 #include <asm/semaphore.h>      /* Needed for MUTEX init macros */
  38
  39 /* message queue empty */
  40 #define I2O_QUEUE_EMPTY         0xffffffff
  41
  42 /*
  43  *      Cache strategies
  44  */
  45
  46 /*      The NULL strategy leaves everything up to the controller. This tends to be a
  47  *      pessimal but functional choice.
  48  */
  49 #define CACHE_NULL              0
  50 /*      Prefetch data when reading. We continually attempt to load the next 32 sectors
  51  *      into the controller cache.
  52  */
  53 #define CACHE_PREFETCH          1
  54 /*      Prefetch data when reading. We sometimes attempt to load the next 32 sectors
  55  *      into the controller cache. When an I/O is less <= 8K we assume its probably
  56  *      not sequential and don't prefetch (default)
  57  */
  58 #define CACHE_SMARTFETCH        2
  59 /*      Data is written to the cache and then out on to the disk. The I/O must be
  60  *      physically on the medium before the write is acknowledged (default without
  61  *      NVRAM)
  62  */
  63 #define CACHE_WRITETHROUGH      17
  64 /*      Data is written to the cache and then out on to the disk. The controller
  65  *      is permitted to write back the cache any way it wants. (default if battery
  66  *      backed NVRAM is present). It can be useful to set this for swap regardless of
  67  *      battery state.
  68  */
  69 #define CACHE_WRITEBACK         18
  70 /*      Optimise for under powered controllers, especially on RAID1 and RAID0. We
  71  *      write large I/O's directly to disk bypassing the cache to avoid the extra
  72  *      memory copy hits. Small writes are writeback cached
  73  */
  74 #define CACHE_SMARTBACK         19
  75 /*      Optimise for under powered controllers, especially on RAID1 and RAID0. We
  76  *      write large I/O's directly to disk bypassing the cache to avoid the extra
  77  *      memory copy hits. Small writes are writethrough cached. Suitable for devices
  78  *      lacking battery backup
  79  */
  80 #define CACHE_SMARTTHROUGH      20
  81
  82 /*
  83  *      Ioctl structures
  84  */
  85
  86 #define         BLKI2OGRSTRAT   _IOR('2', 1, int)
  87 #define         BLKI2OGWSTRAT   _IOR('2', 2, int)
  88 #define         BLKI2OSRSTRAT   _IOW('2', 3, int)
  89 #define         BLKI2OSWSTRAT   _IOW('2', 4, int)
  90
  91 /*
  92  *      I2O Function codes
  93  */
  94
  95 /*
  96  *      Executive Class
  97  */
  98 #define I2O_CMD_ADAPTER_ASSIGN          0xB3
  99 #define I2O_CMD_ADAPTER_READ            0xB2
 100 #define I2O_CMD_ADAPTER_RELEASE         0xB5
 101 #define I2O_CMD_BIOS_INFO_SET           0xA5
 102 #define I2O_CMD_BOOT_DEVICE_SET         0xA7
 103 #define I2O_CMD_CONFIG_VALIDATE         0xBB
 104 #define I2O_CMD_CONN_SETUP              0xCA
 105 #define I2O_CMD_DDM_DESTROY             0xB1
 106 #define I2O_CMD_DDM_ENABLE              0xD5
 107 #define I2O_CMD_DDM_QUIESCE             0xC7
 108 #define I2O_CMD_DDM_RESET               0xD9
 109 #define I2O_CMD_DDM_SUSPEND             0xAF
 110 #define I2O_CMD_DEVICE_ASSIGN           0xB7
 111 #define I2O_CMD_DEVICE_RELEASE          0xB9
 112 #define I2O_CMD_HRT_GET                 0xA8
 113 #define I2O_CMD_ADAPTER_CLEAR           0xBE
 114 #define I2O_CMD_ADAPTER_CONNECT         0xC9
 115 #define I2O_CMD_ADAPTER_RESET           0xBD
 116 #define I2O_CMD_LCT_NOTIFY              0xA2
 117 #define I2O_CMD_OUTBOUND_INIT           0xA1
 118 #define I2O_CMD_PATH_ENABLE             0xD3
 119 #define I2O_CMD_PATH_QUIESCE            0xC5
 120 #define I2O_CMD_PATH_RESET              0xD7
 121 #define I2O_CMD_STATIC_MF_CREATE        0xDD
 122 #define I2O_CMD_STATIC_MF_RELEASE       0xDF
 123 #define I2O_CMD_STATUS_GET              0xA0
 124 #define I2O_CMD_SW_DOWNLOAD             0xA9
 125 #define I2O_CMD_SW_UPLOAD               0xAB
 126 #define I2O_CMD_SW_REMOVE               0xAD
 127 #define I2O_CMD_SYS_ENABLE              0xD1
 128 #define I2O_CMD_SYS_MODIFY              0xC1
 129 #define I2O_CMD_SYS_QUIESCE             0xC3
 130 #define I2O_CMD_SYS_TAB_SET             0xA3
 131
 132 /*
 133  * Utility Class
 134  */
 135 #define I2O_CMD_UTIL_NOP                0x00
 136 #define I2O_CMD_UTIL_ABORT              0x01
 137 #define I2O_CMD_UTIL_CLAIM              0x09
 138 #define I2O_CMD_UTIL_RELEASE            0x0B
 139 #define I2O_CMD_UTIL_PARAMS_GET         0x06
 140 #define I2O_CMD_UTIL_PARAMS_SET         0x05
 141 #define I2O_CMD_UTIL_EVT_REGISTER       0x13
 142 #define I2O_CMD_UTIL_EVT_ACK            0x14
 143 #define I2O_CMD_UTIL_CONFIG_DIALOG      0x10
 144 #define I2O_CMD_UTIL_DEVICE_RESERVE     0x0D
 145 #define I2O_CMD_UTIL_DEVICE_RELEASE     0x0F
 146 #define I2O_CMD_UTIL_LOCK               0x17
 147 #define I2O_CMD_UTIL_LOCK_RELEASE       0x19
 148 #define I2O_CMD_UTIL_REPLY_FAULT_NOTIFY 0x15
 149
 150 /*
 151  * SCSI Host Bus Adapter Class
 152  */
 153 #define I2O_CMD_SCSI_EXEC               0x81
 154 #define I2O_CMD_SCSI_ABORT              0x83
 155 #define I2O_CMD_SCSI_BUSRESET           0x27
 156
 157 /*
 158  * Bus Adapter Class
 159  */
 160 #define I2O_CMD_BUS_ADAPTER_RESET       0x85
 161 #define I2O_CMD_BUS_RESET               0x87
 162 #define I2O_CMD_BUS_SCAN                0x89
 163 #define I2O_CMD_BUS_QUIESCE             0x8b
 164
 165 /*
 166  * Random Block Storage Class
 167  */
 168 #define I2O_CMD_BLOCK_READ              0x30
 169 #define I2O_CMD_BLOCK_WRITE             0x31
 170 #define I2O_CMD_BLOCK_CFLUSH            0x37
 171 #define I2O_CMD_BLOCK_MLOCK             0x49
 172 #define I2O_CMD_BLOCK_MUNLOCK           0x4B
 173 #define I2O_CMD_BLOCK_MMOUNT            0x41
 174 #define I2O_CMD_BLOCK_MEJECT            0x43
 175 #define I2O_CMD_BLOCK_POWER             0x70
 176
 177 #define I2O_CMD_PRIVATE                 0xFF
 178
 179 /* Command status values  */
 180
 181 #define I2O_CMD_IN_PROGRESS     0x01
 182 #define I2O_CMD_REJECTED        0x02
 183 #define I2O_CMD_FAILED          0x03
 184 #define I2O_CMD_COMPLETED       0x04
 185
 186 /* I2O API function return values */
 187
 188 #define I2O_RTN_NO_ERROR                        0
 189 #define I2O_RTN_NOT_INIT                        1
 190 #define I2O_RTN_FREE_Q_EMPTY                    2
 191 #define I2O_RTN_TCB_ERROR                       3
 192 #define I2O_RTN_TRANSACTION_ERROR               4
 193 #define I2O_RTN_ADAPTER_ALREADY_INIT            5
 194 #define I2O_RTN_MALLOC_ERROR                    6
 195 #define I2O_RTN_ADPTR_NOT_REGISTERED            7
 196 #define I2O_RTN_MSG_REPLY_TIMEOUT               8
 197 #define I2O_RTN_NO_STATUS                       9
 198 #define I2O_RTN_NO_FIRM_VER                     10
 199 #define I2O_RTN_NO_LINK_SPEED                   11
 200
 201 /* Reply message status defines for all messages */
 202
 203 #define I2O_REPLY_STATUS_SUCCESS                        0x00
 204 #define I2O_REPLY_STATUS_ABORT_DIRTY                    0x01
 205 #define I2O_REPLY_STATUS_ABORT_NO_DATA_TRANSFER         0x02
 206 #define I2O_REPLY_STATUS_ABORT_PARTIAL_TRANSFER         0x03
 207 #define I2O_REPLY_STATUS_ERROR_DIRTY                    0x04
 208 #define I2O_REPLY_STATUS_ERROR_NO_DATA_TRANSFER         0x05
 209 #define I2O_REPLY_STATUS_ERROR_PARTIAL_TRANSFER         0x06
 210 #define I2O_REPLY_STATUS_PROCESS_ABORT_DIRTY            0x08
 211 #define I2O_REPLY_STATUS_PROCESS_ABORT_NO_DATA_TRANSFER 0x09
 212 #define I2O_REPLY_STATUS_PROCESS_ABORT_PARTIAL_TRANSFER 0x0A
 213 #define I2O_REPLY_STATUS_TRANSACTION_ERROR              0x0B
 214 #define I2O_REPLY_STATUS_PROGRESS_REPORT                0x80
 215
 216 /* Status codes and Error Information for Parameter functions */
 217
 218 #define I2O_PARAMS_STATUS_SUCCESS               0x00
 219 #define I2O_PARAMS_STATUS_BAD_KEY_ABORT         0x01
 220 #define I2O_PARAMS_STATUS_BAD_KEY_CONTINUE      0x02
 221 #define I2O_PARAMS_STATUS_BUFFER_FULL           0x03
 222 #define I2O_PARAMS_STATUS_BUFFER_TOO_SMALL      0x04
 223 #define I2O_PARAMS_STATUS_FIELD_UNREADABLE      0x05
 224 #define I2O_PARAMS_STATUS_FIELD_UNWRITEABLE     0x06
 225 #define I2O_PARAMS_STATUS_INSUFFICIENT_FIELDS   0x07
 226 #define I2O_PARAMS_STATUS_INVALID_GROUP_ID      0x08
 227 #define I2O_PARAMS_STATUS_INVALID_OPERATION     0x09
 228 #define I2O_PARAMS_STATUS_NO_KEY_FIELD          0x0A
 229 #define I2O_PARAMS_STATUS_NO_SUCH_FIELD         0x0B
 230 #define I2O_PARAMS_STATUS_NON_DYNAMIC_GROUP     0x0C
 231 #define I2O_PARAMS_STATUS_OPERATION_ERROR       0x0D
 232 #define I2O_PARAMS_STATUS_SCALAR_ERROR          0x0E
 233 #define I2O_PARAMS_STATUS_TABLE_ERROR           0x0F
 234 #define I2O_PARAMS_STATUS_WRONG_GROUP_TYPE      0x10
 235
 236 /* DetailedStatusCode defines for Executive, DDM, Util and Transaction error
 237  * messages: Table 3-2 Detailed Status Codes.*/
 238
 239 #define I2O_DSC_SUCCESS                        0x0000
 240 #define I2O_DSC_BAD_KEY                        0x0002
 241 #define I2O_DSC_TCL_ERROR                      0x0003
 242 #define I2O_DSC_REPLY_BUFFER_FULL              0x0004
 243 #define I2O_DSC_NO_SUCH_PAGE                   0x0005
 244 #define I2O_DSC_INSUFFICIENT_RESOURCE_SOFT     0x0006
 245 #define I2O_DSC_INSUFFICIENT_RESOURCE_HARD     0x0007
 246 #define I2O_DSC_CHAIN_BUFFER_TOO_LARGE         0x0009
 247 #define I2O_DSC_UNSUPPORTED_FUNCTION           0x000A
 248 #define I2O_DSC_DEVICE_LOCKED                  0x000B
 249 #define I2O_DSC_DEVICE_RESET                   0x000C
 250 #define I2O_DSC_INAPPROPRIATE_FUNCTION         0x000D
 251 #define I2O_DSC_INVALID_INITIATOR_ADDRESS      0x000E
 252 #define I2O_DSC_INVALID_MESSAGE_FLAGS          0x000F
 253 #define I2O_DSC_INVALID_OFFSET                 0x0010
 254 #define I2O_DSC_INVALID_PARAMETER              0x0011
 255 #define I2O_DSC_INVALID_REQUEST                0x0012
 256 #define I2O_DSC_INVALID_TARGET_ADDRESS         0x0013
 257 #define I2O_DSC_MESSAGE_TOO_LARGE              0x0014
 258 #define I2O_DSC_MESSAGE_TOO_SMALL              0x0015
 259 #define I2O_DSC_MISSING_PARAMETER              0x0016
 260 #define I2O_DSC_TIMEOUT                        0x0017
 261 #define I2O_DSC_UNKNOWN_ERROR                  0x0018
 262 #define I2O_DSC_UNKNOWN_FUNCTION               0x0019
 263 #define I2O_DSC_UNSUPPORTED_VERSION            0x001A
 264 #define I2O_DSC_DEVICE_BUSY                    0x001B
 265 #define I2O_DSC_DEVICE_NOT_AVAILABLE           0x001C
 266
 267 /* DetailedStatusCode defines for Block Storage Operation: Table 6-7 Detailed
 268    Status Codes.*/
 269
 270 #define I2O_BSA_DSC_SUCCESS               0x0000
 271 #define I2O_BSA_DSC_MEDIA_ERROR           0x0001
 272 #define I2O_BSA_DSC_ACCESS_ERROR          0x0002
 273 #define I2O_BSA_DSC_DEVICE_FAILURE        0x0003
 274 #define I2O_BSA_DSC_DEVICE_NOT_READY      0x0004
 275 #define I2O_BSA_DSC_MEDIA_NOT_PRESENT     0x0005
 276 #define I2O_BSA_DSC_MEDIA_LOCKED          0x0006
 277 #define I2O_BSA_DSC_MEDIA_FAILURE         0x0007
 278 #define I2O_BSA_DSC_PROTOCOL_FAILURE      0x0008
 279 #define I2O_BSA_DSC_BUS_FAILURE           0x0009
 280 #define I2O_BSA_DSC_ACCESS_VIOLATION      0x000A
 281 #define I2O_BSA_DSC_WRITE_PROTECTED       0x000B
 282 #define I2O_BSA_DSC_DEVICE_RESET          0x000C
 283 #define I2O_BSA_DSC_VOLUME_CHANGED        0x000D
 284 #define I2O_BSA_DSC_TIMEOUT               0x000E
 285
 286 /* FailureStatusCodes, Table 3-3 Message Failure Codes */
 287
 288 #define I2O_FSC_TRANSPORT_SERVICE_SUSPENDED             0x81
 289 #define I2O_FSC_TRANSPORT_SERVICE_TERMINATED            0x82
 290 #define I2O_FSC_TRANSPORT_CONGESTION                    0x83
 291 #define I2O_FSC_TRANSPORT_FAILURE                       0x84
 292 #define I2O_FSC_TRANSPORT_STATE_ERROR                   0x85
 293 #define I2O_FSC_TRANSPORT_TIME_OUT                      0x86
 294 #define I2O_FSC_TRANSPORT_ROUTING_FAILURE               0x87
 295 #define I2O_FSC_TRANSPORT_INVALID_VERSION               0x88
 296 #define I2O_FSC_TRANSPORT_INVALID_OFFSET                0x89
 297 #define I2O_FSC_TRANSPORT_INVALID_MSG_FLAGS             0x8A
 298 #define I2O_FSC_TRANSPORT_FRAME_TOO_SMALL               0x8B
 299 #define I2O_FSC_TRANSPORT_FRAME_TOO_LARGE               0x8C
 300 #define I2O_FSC_TRANSPORT_INVALID_TARGET_ID             0x8D
 301 #define I2O_FSC_TRANSPORT_INVALID_INITIATOR_ID          0x8E
 302 #define I2O_FSC_TRANSPORT_INVALID_INITIATOR_CONTEXT     0x8F
 303 #define I2O_FSC_TRANSPORT_UNKNOWN_FAILURE               0xFF
 304
 305 /* Device Claim Types */
 306 #define I2O_CLAIM_PRIMARY                                       0x01000000
 307 #define I2O_CLAIM_MANAGEMENT                                    0x02000000
 308 #define I2O_CLAIM_AUTHORIZED                                    0x03000000
 309 #define I2O_CLAIM_SECONDARY                                     0x04000000
 310
 311 /* Message header defines for VersionOffset */
 312 #define I2OVER15        0x0001
 313 #define I2OVER20        0x0002
 314
 315 /* Default is 1.5 */
 316 #define I2OVERSION      I2OVER15
 317
 318 #define SGL_OFFSET_0    I2OVERSION
 319 #define SGL_OFFSET_4    (0x0040 | I2OVERSION)
 320 #define SGL_OFFSET_5    (0x0050 | I2OVERSION)
 321 #define SGL_OFFSET_6    (0x0060 | I2OVERSION)
 322 #define SGL_OFFSET_7    (0x0070 | I2OVERSION)
 323 #define SGL_OFFSET_8    (0x0080 | I2OVERSION)
 324 #define SGL_OFFSET_9    (0x0090 | I2OVERSION)
 325 #define SGL_OFFSET_10   (0x00A0 | I2OVERSION)
 326 #define SGL_OFFSET_11   (0x00B0 | I2OVERSION)
 327 #define SGL_OFFSET_12   (0x00C0 | I2OVERSION)
 328 #define SGL_OFFSET(x)   (((x)<<4) | I2OVERSION)
 329
 330 /* Transaction Reply Lists (TRL) Control Word structure */
 331 #define TRL_SINGLE_FIXED_LENGTH         0x00
 332 #define TRL_SINGLE_VARIABLE_LENGTH      0x40
 333 #define TRL_MULTIPLE_FIXED_LENGTH       0x80
 334
 335  /* msg header defines for MsgFlags */
 336 #define MSG_STATIC      0x0100
 337 #define MSG_64BIT_CNTXT 0x0200
 338 #define MSG_MULTI_TRANS 0x1000
 339 #define MSG_FAIL        0x2000
 340 #define MSG_FINAL       0x4000
 341 #define MSG_REPLY       0x8000
 342
 343  /* minimum size msg */
 344 #define THREE_WORD_MSG_SIZE     0x00030000
 345 #define FOUR_WORD_MSG_SIZE      0x00040000
 346 #define FIVE_WORD_MSG_SIZE      0x00050000
 347 #define SIX_WORD_MSG_SIZE       0x00060000
 348 #define SEVEN_WORD_MSG_SIZE     0x00070000
 349 #define EIGHT_WORD_MSG_SIZE     0x00080000
 350 #define NINE_WORD_MSG_SIZE      0x00090000
 351 #define TEN_WORD_MSG_SIZE       0x000A0000
 352 #define ELEVEN_WORD_MSG_SIZE    0x000B0000
 353 #define I2O_MESSAGE_SIZE(x)     ((x)<<16)
 354
 355 /* special TID assignments */
 356 #define ADAPTER_TID             0
 357 #define HOST_TID                1
 358
 359 /* outbound queue defines */
 360 #define I2O_MAX_OUTBOUND_MSG_FRAMES     128
 361 #define I2O_OUTBOUND_MSG_FRAME_SIZE     128     /* in 32-bit words */
 362
 363 /* inbound queue definitions */
 364 #define I2O_MSG_INPOOL_MIN              32
 365 #define I2O_INBOUND_MSG_FRAME_SIZE      128     /* in 32-bit words */
 366
 367 #define I2O_POST_WAIT_OK        0
 368 #define I2O_POST_WAIT_TIMEOUT   -ETIMEDOUT
 369
 370 #define I2O_CONTEXT_LIST_MIN_LENGTH     15
 371 #define I2O_CONTEXT_LIST_USED           0x01
 372 #define I2O_CONTEXT_LIST_DELETED        0x02
 373
 374 /* timeouts */
 375 #define I2O_TIMEOUT_INIT_OUTBOUND_QUEUE 15
 376 #define I2O_TIMEOUT_MESSAGE_GET         5
 377 #define I2O_TIMEOUT_RESET               30
 378 #define I2O_TIMEOUT_STATUS_GET          5
 379 #define I2O_TIMEOUT_LCT_GET             360
 380 #define I2O_TIMEOUT_SCSI_SCB_ABORT      240
 381
 382 /* retries */
 383 #define I2O_HRT_GET_TRIES               3
 384 #define I2O_LCT_GET_TRIES               3
 385
 386 /* defines for max_sectors and max_phys_segments */
 387 #define I2O_MAX_SECTORS                 1024
 388 #define I2O_MAX_SECTORS_LIMITED         128
 389 #define I2O_MAX_PHYS_SEGMENTS           MAX_PHYS_SEGMENTS
 390
 391 /*
 392  *      Message structures
 393  */
 394 struct i2o_message {
 395         union {
 396                 struct {
 397                         u8 version_offset;
 398                         u8 flags;
 399                         u16 size;
 400                         u32 target_tid:12;
 401                         u32 init_tid:12;
 402                         u32 function:8;
 403                         u32 icntxt;     /* initiator context */
 404                         u32 tcntxt;     /* transaction context */
 405                 } s;
 406                 u32 head[4];
 407         } u;
 408         /* List follows */
 409         u32 body[0];
 410 };
 411
 412 /* MFA and I2O message used by mempool */
 413 struct i2o_msg_mfa {
 414         u32 mfa;                /* MFA returned by the controller */
 415         struct i2o_message msg; /* I2O message */
 416 };
 417
 418 /*
 419  *      Each I2O device entity has one of these. There is one per device.
 420  */
 421 struct i2o_device {
 422         i2o_lct_entry lct_data; /* Device LCT information */
 423
 424         struct i2o_controller *iop;     /* Controlling IOP */
 425         struct list_head list;  /* node in IOP devices list */
 426
 427         struct device device;
 428
 429         struct mutex lock;      /* device lock */
 430 };
 431
 432 /*
 433  *      Event structure provided to the event handling function
 434  */
 435 struct i2o_event {
 436         struct work_struct work;
 437         struct i2o_device *i2o_dev;     /* I2O device pointer from which the
 438                                            event reply was initiated */
 439         u16 size;               /* Size of data in 32-bit words */
 440         u32 tcntxt;             /* Transaction context used at
 441                                    registration */
 442         u32 event_indicator;    /* Event indicator from reply */
 443         u32 data[0];            /* Event data from reply */
 444 };
 445
 446 /*
 447  *      I2O classes which could be handled by the OSM
 448  */
 449 struct i2o_class_id {
 450         u16 class_id:12;
 451 };
 452
 453 /*
 454  *      I2O driver structure for OSMs
 455  */
 456 struct i2o_driver {
 457         char *name;             /* OSM name */
 458         int context;            /* Low 8 bits of the transaction info */
 459         struct i2o_class_id *classes;   /* I2O classes that this OSM handles */
 460
 461         /* Message reply handler */
 462         int (*reply) (struct i2o_controller *, u32, struct i2o_message *);
 463
 464         /* Event handler */
 465         work_func_t event;
 466
 467         struct workqueue_struct *event_queue;   /* Event queue */
 468
 469         struct device_driver driver;
 470
 471         /* notification of changes */
 472         void (*notify_controller_add) (struct i2o_controller *);
 473         void (*notify_controller_remove) (struct i2o_controller *);
 474         void (*notify_device_add) (struct i2o_device *);
 475         void (*notify_device_remove) (struct i2o_device *);
 476
 477         struct semaphore lock;
 478 };
 479
 480 /*
 481  *      Contains DMA mapped address information
 482  */
 483 struct i2o_dma {
 484         void *virt;
 485         dma_addr_t phys;
 486         size_t len;
 487 };
 488
 489 /*
 490  *      Contains slab cache and mempool information
 491  */
 492 struct i2o_pool {
 493         char *name;
 494         struct kmem_cache *slab;
 495         mempool_t *mempool;
 496 };
 497
 498 /*
 499  *      Contains IO mapped address information
 500  */
 501 struct i2o_io {
 502         void __iomem *virt;
 503         unsigned long phys;
 504         unsigned long len;
 505 };
 506
 507 /*
 508  *      Context queue entry, used for 32-bit context on 64-bit systems
 509  */
 510 struct i2o_context_list_element {
 511         struct list_head list;
 512         u32 context;
 513         void *ptr;
 514         unsigned long timestamp;
 515 };
 516
 517 /*
 518  * Each I2O controller has one of these objects
 519  */
 520 struct i2o_controller {
 521         char name[16];
 522         int unit;
 523         int type;
 524
 525         struct pci_dev *pdev;   /* PCI device */
 526
 527         unsigned int promise:1; /* Promise controller */
 528         unsigned int adaptec:1; /* DPT / Adaptec controller */
 529         unsigned int raptor:1;  /* split bar */
 530         unsigned int no_quiesce:1;      /* dont quiesce before reset */
 531         unsigned int short_req:1;       /* use small block sizes */
 532         unsigned int limit_sectors:1;   /* limit number of sectors / request */
 533         unsigned int pae_support:1;     /* controller has 64-bit SGL support */
 534
 535         struct list_head devices;       /* list of I2O devices */
 536         struct list_head list;  /* Controller list */
 537
 538         void __iomem *in_port;  /* Inbout port address */
 539         void __iomem *out_port; /* Outbound port address */
 540         void __iomem *irq_status;       /* Interrupt status register address */
 541         void __iomem *irq_mask; /* Interrupt mask register address */
 542
 543         struct i2o_dma status;  /* IOP status block */
 544
 545         struct i2o_dma hrt;     /* HW Resource Table */
 546         i2o_lct *lct;           /* Logical Config Table */
 547         struct i2o_dma dlct;    /* Temp LCT */
 548         struct mutex lct_lock;  /* Lock for LCT updates */
 549         struct i2o_dma status_block;    /* IOP status block */
 550
 551         struct i2o_io base;     /* controller messaging unit */
 552         struct i2o_io in_queue; /* inbound message queue Host->IOP */
 553         struct i2o_dma out_queue;       /* outbound message queue IOP->Host */
 554
 555         struct i2o_pool in_msg; /* mempool for inbound messages */
 556
 557         unsigned int battery:1; /* Has a battery backup */
 558         unsigned int io_alloc:1;        /* An I/O resource was allocated */
 559         unsigned int mem_alloc:1;       /* A memory resource was allocated */
 560
 561         struct resource io_resource;    /* I/O resource allocated to the IOP */
 562         struct resource mem_resource;   /* Mem resource allocated to the IOP */
 563
 564         struct device device;
 565         struct i2o_device *exec;        /* Executive */
 566 #if BITS_PER_LONG == 64
 567         spinlock_t context_list_lock;   /* lock for context_list */
 568         atomic_t context_list_counter;  /* needed for unique contexts */
 569         struct list_head context_list;  /* list of context id's
 570                                            and pointers */
 571 #endif
 572         spinlock_t lock;        /* lock for controller
 573                                    configuration */
 574
 575         void *driver_data[I2O_MAX_DRIVERS];     /* storage for drivers */
 576 };
 577
 578 /*
 579  * I2O System table entry
 580  *
 581  * The system table contains information about all the IOPs in the
 582  * system.  It is sent to all IOPs so that they can create peer2peer
 583  * connections between them.
 584  */
 585 struct i2o_sys_tbl_entry {
 586         u16 org_id;
 587         u16 reserved1;
 588         u32 iop_id:12;
 589         u32 reserved2:20;
 590         u16 seg_num:12;
 591         u16 i2o_version:4;
 592         u8 iop_state;
 593         u8 msg_type;
 594         u16 frame_size;
 595         u16 reserved3;
 596         u32 last_changed;
 597         u32 iop_capabilities;
 598         u32 inbound_low;
 599         u32 inbound_high;
 600 };
 601
 602 struct i2o_sys_tbl {
 603         u8 num_entries;
 604         u8 version;
 605         u16 reserved1;
 606         u32 change_ind;
 607         u32 reserved2;
 608         u32 reserved3;
 609         struct i2o_sys_tbl_entry iops[0];
 610 };
 611
 612 extern struct list_head i2o_controllers;
 613
 614 /* Message functions */
 615 static inline struct i2o_message *i2o_msg_get(struct i2o_controller *);
 616 extern struct i2o_message *i2o_msg_get_wait(struct i2o_controller *, int);
 617 static inline void i2o_msg_post(struct i2o_controller *, struct i2o_message *);
 618 static inline int i2o_msg_post_wait(struct i2o_controller *,
 619                                     struct i2o_message *, unsigned long);
 620 extern int i2o_msg_post_wait_mem(struct i2o_controller *, struct i2o_message *,
 621                                  unsigned long, struct i2o_dma *);
 622 static inline void i2o_flush_reply(struct i2o_controller *, u32);
 623
 624 /* IOP functions */
 625 extern int i2o_status_get(struct i2o_controller *);
 626
 627 extern int i2o_event_register(struct i2o_device *, struct i2o_driver *, int,
 628                               u32);
 629 extern struct i2o_device *i2o_iop_find_device(struct i2o_controller *, u16);
 630 extern struct i2o_controller *i2o_find_iop(int);
 631
 632 /* Functions needed for handling 64-bit pointers in 32-bit context */
 633 #if BITS_PER_LONG == 64
 634 extern u32 i2o_cntxt_list_add(struct i2o_controller *, void *);
 635 extern void *i2o_cntxt_list_get(struct i2o_controller *, u32);
 636 extern u32 i2o_cntxt_list_remove(struct i2o_controller *, void *);
 637 extern u32 i2o_cntxt_list_get_ptr(struct i2o_controller *, void *);
 638
 639 static inline u32 i2o_ptr_low(void *ptr)
 640 {
 641         return (u32) (u64) ptr;
 642 };
 643
 644 static inline u32 i2o_ptr_high(void *ptr)
 645 {
 646         return (u32) ((u64) ptr >> 32);
 647 };
 648
 649 static inline u32 i2o_dma_low(dma_addr_t dma_addr)
 650 {
 651         return (u32) (u64) dma_addr;
 652 };
 653
 654 static inline u32 i2o_dma_high(dma_addr_t dma_addr)
 655 {
 656         return (u32) ((u64) dma_addr >> 32);
 657 };
 658 #else
 659 static inline u32 i2o_cntxt_list_add(struct i2o_controller *c, void *ptr)
 660 {
 661         return (u32) ptr;
 662 };
 663
 664 static inline void *i2o_cntxt_list_get(struct i2o_controller *c, u32 context)
 665 {
 666         return (void *)context;
 667 };
 668
 669 static inline u32 i2o_cntxt_list_remove(struct i2o_controller *c, void *ptr)
 670 {
 671         return (u32) ptr;
 672 };
 673
 674 static inline u32 i2o_cntxt_list_get_ptr(struct i2o_controller *c, void *ptr)
 675 {
 676         return (u32) ptr;
 677 };
 678
 679 static inline u32 i2o_ptr_low(void *ptr)
 680 {
 681         return (u32) ptr;
 682 };
 683
 684 static inline u32 i2o_ptr_high(void *ptr)
 685 {
 686         return 0;
 687 };
 688
 689 static inline u32 i2o_dma_low(dma_addr_t dma_addr)
 690 {
 691         return (u32) dma_addr;
 692 };
 693
 694 static inline u32 i2o_dma_high(dma_addr_t dma_addr)
 695 {
 696         return 0;
 697 };
 698 #endif
 699
 700 /**
 701  *      i2o_sg_tablesize - Calculate the maximum number of elements in a SGL
 702  *      @c: I2O controller for which the calculation should be done
 703  *      @body_size: maximum body size used for message in 32-bit words.
 704  *
 705  *      Return the maximum number of SG elements in a SG list.
 706  */
 707 static inline u16 i2o_sg_tablesize(struct i2o_controller *c, u16 body_size)
 708 {
 709         i2o_status_block *sb = c->status_block.virt;
 710         u16 sg_count =
 711             (sb->inbound_frame_size - sizeof(struct i2o_message) / 4) -
 712             body_size;
 713
 714         if (c->pae_support) {
 715                 /*
 716                  * for 64-bit a SG attribute element must be added and each
 717                  * SG element needs 12 bytes instead of 8.
 718                  */
 719                 sg_count -= 2;
 720                 sg_count /= 3;
 721         } else
 722                 sg_count /= 2;
 723
 724         if (c->short_req && (sg_count > 8))
 725                 sg_count = 8;
 726
 727         return sg_count;
 728 };
 729
 730 /**
 731  *      i2o_dma_map_single - Map pointer to controller and fill in I2O message.
 732  *      @c: I2O controller
 733  *      @ptr: pointer to the data which should be mapped
 734  *      @size: size of data in bytes
 735  *      @direction: DMA_TO_DEVICE / DMA_FROM_DEVICE
 736  *      @sg_ptr: pointer to the SG list inside the I2O message
 737  *
 738  *      This function does all necessary DMA handling and also writes the I2O
 739  *      SGL elements into the I2O message. For details on DMA handling see also
 740  *      dma_map_single(). The pointer sg_ptr will only be set to the end of the
 741  *      SG list if the allocation was successful.
 742  *
 743  *      Returns DMA address which must be checked for failures using
 744  *      dma_mapping_error().
 745  */
 746 static inline dma_addr_t i2o_dma_map_single(struct i2o_controller *c, void *ptr,
 747                                             size_t size,
 748                                             enum dma_data_direction direction,
 749                                             u32 ** sg_ptr)
 750 {
 751         u32 sg_flags;
 752         u32 *mptr = *sg_ptr;
 753         dma_addr_t dma_addr;
 754
 755         switch (direction) {
 756         case DMA_TO_DEVICE:
 757                 sg_flags = 0xd4000000;
 758                 break;
 759         case DMA_FROM_DEVICE:
 760                 sg_flags = 0xd0000000;
 761                 break;
 762         default:
 763                 return 0;
 764         }
 765
 766         dma_addr = dma_map_single(&c->pdev->dev, ptr, size, direction);
 767         if (!dma_mapping_error(dma_addr)) {
 768 #ifdef CONFIG_I2O_EXT_ADAPTEC_DMA64
 769                 if ((sizeof(dma_addr_t) > 4) && c->pae_support) {
 770                         *mptr++ = cpu_to_le32(0x7C020002);
 771                         *mptr++ = cpu_to_le32(PAGE_SIZE);
 772                 }
 773 #endif
 774
 775                 *mptr++ = cpu_to_le32(sg_flags | size);
 776                 *mptr++ = cpu_to_le32(i2o_dma_low(dma_addr));
 777 #ifdef CONFIG_I2O_EXT_ADAPTEC_DMA64
 778                 if ((sizeof(dma_addr_t) > 4) && c->pae_support)
 779                         *mptr++ = cpu_to_le32(i2o_dma_high(dma_addr));
 780 #endif
 781                 *sg_ptr = mptr;
 782         }
 783         return dma_addr;
 784 };
 785
 786 /**
 787  *      i2o_dma_map_sg - Map a SG List to controller and fill in I2O message.
 788  *      @c: I2O controller
 789  *      @sg: SG list to be mapped
 790  *      @sg_count: number of elements in the SG list
 791  *      @direction: DMA_TO_DEVICE / DMA_FROM_DEVICE
 792  *      @sg_ptr: pointer to the SG list inside the I2O message
 793  *
 794  *      This function does all necessary DMA handling and also writes the I2O
 795  *      SGL elements into the I2O message. For details on DMA handling see also
 796  *      dma_map_sg(). The pointer sg_ptr will only be set to the end of the SG
 797  *      list if the allocation was successful.
 798  *
 799  *      Returns 0 on failure or 1 on success.
 800  */
 801 static inline int i2o_dma_map_sg(struct i2o_controller *c,
 802                                  struct scatterlist *sg, int sg_count,
 803                                  enum dma_data_direction direction,
 804                                  u32 ** sg_ptr)
 805 {
 806         u32 sg_flags;
 807         u32 *mptr = *sg_ptr;
 808
 809         switch (direction) {
 810         case DMA_TO_DEVICE:
 811                 sg_flags = 0x14000000;
 812                 break;
 813         case DMA_FROM_DEVICE:
 814                 sg_flags = 0x10000000;
 815                 break;
 816         default:
 817                 return 0;
 818         }
 819
 820         sg_count = dma_map_sg(&c->pdev->dev, sg, sg_count, direction);
 821         if (!sg_count)
 822                 return 0;
 823
 824 #ifdef CONFIG_I2O_EXT_ADAPTEC_DMA64
 825         if ((sizeof(dma_addr_t) > 4) && c->pae_support) {
 826                 *mptr++ = cpu_to_le32(0x7C020002);
 827                 *mptr++ = cpu_to_le32(PAGE_SIZE);
 828         }
 829 #endif
 830
 831         while (sg_count-- > 0) {
 832                 if (!sg_count)
 833                         sg_flags |= 0xC0000000;
 834                 *mptr++ = cpu_to_le32(sg_flags | sg_dma_len(sg));
 835                 *mptr++ = cpu_to_le32(i2o_dma_low(sg_dma_address(sg)));
 836 #ifdef CONFIG_I2O_EXT_ADAPTEC_DMA64
 837                 if ((sizeof(dma_addr_t) > 4) && c->pae_support)
 838                         *mptr++ = cpu_to_le32(i2o_dma_high(sg_dma_address(sg)));
 839 #endif
 840                 sg++;
 841         }
 842         *sg_ptr = mptr;
 843
 844         return 1;
 845 };
 846
 847 /**
 848  *      i2o_dma_alloc - Allocate DMA memory
 849  *      @dev: struct device pointer to the PCI device of the I2O controller
 850  *      @addr: i2o_dma struct which should get the DMA buffer
 851  *      @len: length of the new DMA memory
 852  *      @gfp_mask: GFP mask
 853  *
 854  *      Allocate a coherent DMA memory and write the pointers into addr.
 855  *
 856  *      Returns 0 on success or -ENOMEM on failure.
 857  */
 858 static inline int i2o_dma_alloc(struct device *dev, struct i2o_dma *addr,
 859                                 size_t len, gfp_t gfp_mask)
 860 {
 861         struct pci_dev *pdev = to_pci_dev(dev);
 862         int dma_64 = 0;
 863
 864         if ((sizeof(dma_addr_t) > 4) && (pdev->dma_mask == DMA_64BIT_MASK)) {
 865                 dma_64 = 1;
 866                 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK))
 867                         return -ENOMEM;
 868         }
 869
 870         addr->virt = dma_alloc_coherent(dev, len, &addr->phys, gfp_mask);
 871
 872         if ((sizeof(dma_addr_t) > 4) && dma_64)
 873                 if (pci_set_dma_mask(pdev, DMA_64BIT_MASK))
 874                         printk(KERN_WARNING "i2o: unable to set 64-bit DMA");
 875
 876         if (!addr->virt)
 877                 return -ENOMEM;
 878
 879         memset(addr->virt, 0, len);
 880         addr->len = len;
 881
 882         return 0;
 883 };
 884
 885 /**
 886  *      i2o_dma_free - Free DMA memory
 887  *      @dev: struct device pointer to the PCI device of the I2O controller
 888  *      @addr: i2o_dma struct which contains the DMA buffer
 889  *
 890  *      Free a coherent DMA memory and set virtual address of addr to NULL.
 891  */
 892 static inline void i2o_dma_free(struct device *dev, struct i2o_dma *addr)
 893 {
 894         if (addr->virt) {
 895                 if (addr->phys)
 896                         dma_free_coherent(dev, addr->len, addr->virt,
 897                                           addr->phys);
 898                 else
 899                         kfree(addr->virt);
 900                 addr->virt = NULL;
 901         }
 902 };
 903
 904 /**
 905  *      i2o_dma_realloc - Realloc DMA memory
 906  *      @dev: struct device pointer to the PCI device of the I2O controller
 907  *      @addr: pointer to a i2o_dma struct DMA buffer
 908  *      @len: new length of memory
 909  *      @gfp_mask: GFP mask
 910  *
 911  *      If there was something allocated in the addr, free it first. If len > 0
 912  *      than try to allocate it and write the addresses back to the addr
 913  *      structure. If len == 0 set the virtual address to NULL.
 914  *
 915  *      Returns the 0 on success or negative error code on failure.
 916  */
 917 static inline int i2o_dma_realloc(struct device *dev, struct i2o_dma *addr,
 918                                   size_t len, gfp_t gfp_mask)
 919 {
 920         i2o_dma_free(dev, addr);
 921
 922         if (len)
 923                 return i2o_dma_alloc(dev, addr, len, gfp_mask);
 924
 925         return 0;
 926 };
 927
 928 /*
 929  *      i2o_pool_alloc - Allocate an slab cache and mempool
 930  *      @mempool: pointer to struct i2o_pool to write data into.
 931  *      @name: name which is used to identify cache
 932  *      @size: size of each object
 933  *      @min_nr: minimum number of objects
 934  *
 935  *      First allocates a slab cache with name and size. Then allocates a
 936  *      mempool which uses the slab cache for allocation and freeing.
 937  *
 938  *      Returns 0 on success or negative error code on failure.
 939  */
 940 static inline int i2o_pool_alloc(struct i2o_pool *pool, const char *name,
 941                                  size_t size, int min_nr)
 942 {
 943         pool->name = kmalloc(strlen(name) + 1, GFP_KERNEL);
 944         if (!pool->name)
 945                 goto exit;
 946         strcpy(pool->name, name);
 947
 948         pool->slab =
 949             kmem_cache_create(pool->name, size, 0, SLAB_HWCACHE_ALIGN, NULL,
 950                               NULL);
 951         if (!pool->slab)
 952                 goto free_name;
 953
 954         pool->mempool = mempool_create_slab_pool(min_nr, pool->slab);
 955         if (!pool->mempool)
 956                 goto free_slab;
 957
 958         return 0;
 959
 960       free_slab:
 961         kmem_cache_destroy(pool->slab);
 962
 963       free_name:
 964         kfree(pool->name);
 965
 966       exit:
 967         return -ENOMEM;
 968 };
 969
 970 /*
 971  *      i2o_pool_free - Free slab cache and mempool again
 972  *      @mempool: pointer to struct i2o_pool which should be freed
 973  *
 974  *      Note that you have to return all objects to the mempool again before
 975  *      calling i2o_pool_free().
 976  */
 977 static inline void i2o_pool_free(struct i2o_pool *pool)
 978 {
 979         mempool_destroy(pool->mempool);
 980         kmem_cache_destroy(pool->slab);
 981         kfree(pool->name);
 982 };
 983
 984 /* I2O driver (OSM) functions */
 985 extern int i2o_driver_register(struct i2o_driver *);
 986 extern void i2o_driver_unregister(struct i2o_driver *);
 987
 988 /**
 989  *      i2o_driver_notify_controller_add - Send notification of added controller
 990  *      @drv: I2O driver
 991  *      @c: I2O controller
 992  *
 993  *      Send notification of added controller to a single registered driver.
 994  */
 995 static inline void i2o_driver_notify_controller_add(struct i2o_driver *drv,
 996                                                     struct i2o_controller *c)
 997 {
 998         if (drv->notify_controller_add)
 999                 drv->notify_controller_add(c);
1000 };
1001
1002 /**
1003  *      i2o_driver_notify_controller_remove - Send notification of removed controller
1004  *      @drv: I2O driver
1005  *      @c: I2O controller
1006  *
1007  *      Send notification of removed controller to a single registered driver.
1008  */
1009 static inline void i2o_driver_notify_controller_remove(struct i2o_driver *drv,
1010                                                        struct i2o_controller *c)
1011 {
1012         if (drv->notify_controller_remove)
1013                 drv->notify_controller_remove(c);
1014 };
1015
1016 /**
1017  *      i2o_driver_notify_device_add - Send notification of added device
1018  *      @drv: I2O driver
1019  *      @i2o_dev: the added i2o_device
1020  *
1021  *      Send notification of added device to a single registered driver.
1022  */
1023 static inline void i2o_driver_notify_device_add(struct i2o_driver *drv,
1024                                                 struct i2o_device *i2o_dev)
1025 {
1026         if (drv->notify_device_add)
1027                 drv->notify_device_add(i2o_dev);
1028 };
1029
1030 /**
1031  *      i2o_driver_notify_device_remove - Send notification of removed device
1032  *      @drv: I2O driver
1033  *      @i2o_dev: the added i2o_device
1034  *
1035  *      Send notification of removed device to a single registered driver.
1036  */
1037 static inline void i2o_driver_notify_device_remove(struct i2o_driver *drv,
1038                                                    struct i2o_device *i2o_dev)
1039 {
1040         if (drv->notify_device_remove)
1041                 drv->notify_device_remove(i2o_dev);
1042 };
1043
1044 extern void i2o_driver_notify_controller_add_all(struct i2o_controller *);
1045 extern void i2o_driver_notify_controller_remove_all(struct i2o_controller *);
1046 extern void i2o_driver_notify_device_add_all(struct i2o_device *);
1047 extern void i2o_driver_notify_device_remove_all(struct i2o_device *);
1048
1049 /* I2O device functions */
1050 extern int i2o_device_claim(struct i2o_device *);
1051 extern int i2o_device_claim_release(struct i2o_device *);
1052
1053 /* Exec OSM functions */
1054 extern int i2o_exec_lct_get(struct i2o_controller *);
1055
1056 /* device / driver / kobject conversion functions */
1057 #define to_i2o_driver(drv) container_of(drv,struct i2o_driver, driver)
1058 #define to_i2o_device(dev) container_of(dev, struct i2o_device, device)
1059 #define to_i2o_controller(dev) container_of(dev, struct i2o_controller, device)
1060 #define kobj_to_i2o_device(kobj) to_i2o_device(container_of(kobj, struct device, kobj))
1061
1062 /**
1063  *      i2o_out_to_virt - Turn an I2O message to a virtual address
1064  *      @c: controller
1065  *      @m: message engine value
1066  *
1067  *      Turn a receive message from an I2O controller bus address into
1068  *      a Linux virtual address. The shared page frame is a linear block
1069  *      so we simply have to shift the offset. This function does not
1070  *      work for sender side messages as they are ioremap objects
1071  *      provided by the I2O controller.
1072  */
1073 static inline struct i2o_message *i2o_msg_out_to_virt(struct i2o_controller *c,
1074                                                       u32 m)
1075 {
1076         BUG_ON(m < c->out_queue.phys
1077                || m >= c->out_queue.phys + c->out_queue.len);
1078
1079         return c->out_queue.virt + (m - c->out_queue.phys);
1080 };
1081
1082 /**
1083  *      i2o_msg_in_to_virt - Turn an I2O message to a virtual address
1084  *      @c: controller
1085  *      @m: message engine value
1086  *
1087  *      Turn a send message from an I2O controller bus address into
1088  *      a Linux virtual address. The shared page frame is a linear block
1089  *      so we simply have to shift the offset. This function does not
1090  *      work for receive side messages as they are kmalloc objects
1091  *      in a different pool.
1092  */
1093 static inline struct i2o_message __iomem *i2o_msg_in_to_virt(struct
1094                                                              i2o_controller *c,
1095                                                              u32 m)
1096 {
1097         return c->in_queue.virt + m;
1098 };
1099
1100 /**
1101  *      i2o_msg_get - obtain an I2O message from the IOP
1102  *      @c: I2O controller
1103  *
1104  *      This function tries to get a message frame. If no message frame is
1105  *      available do not wait until one is availabe (see also i2o_msg_get_wait).
1106  *      The returned pointer to the message frame is not in I/O memory, it is
1107  *      allocated from a mempool. But because a MFA is allocated from the
1108  *      controller too it is guaranteed that i2o_msg_post() will never fail.
1109  *
1110  *      On a success a pointer to the message frame is returned. If the message
1111  *      queue is empty -EBUSY is returned and if no memory is available -ENOMEM
1112  *      is returned.
1113  */
1114 static inline struct i2o_message *i2o_msg_get(struct i2o_controller *c)
1115 {
1116         struct i2o_msg_mfa *mmsg = mempool_alloc(c->in_msg.mempool, GFP_ATOMIC);
1117         if (!mmsg)
1118                 return ERR_PTR(-ENOMEM);
1119
1120         mmsg->mfa = readl(c->in_port);
1121         if (unlikely(mmsg->mfa >= c->in_queue.len)) {
1122                 u32 mfa = mmsg->mfa;
1123
1124                 mempool_free(mmsg, c->in_msg.mempool);
1125
1126                 if (mfa == I2O_QUEUE_EMPTY)
1127                         return ERR_PTR(-EBUSY);
1128                 return ERR_PTR(-EFAULT);
1129         }
1130
1131         return &mmsg->msg;
1132 };
1133
1134 /**
1135  *      i2o_msg_post - Post I2O message to I2O controller
1136  *      @c: I2O controller to which the message should be send
1137  *      @msg: message returned by i2o_msg_get()
1138  *
1139  *      Post the message to the I2O controller and return immediately.
1140  */
1141 static inline void i2o_msg_post(struct i2o_controller *c,
1142                                 struct i2o_message *msg)
1143 {
1144         struct i2o_msg_mfa *mmsg;
1145
1146         mmsg = container_of(msg, struct i2o_msg_mfa, msg);
1147         memcpy_toio(i2o_msg_in_to_virt(c, mmsg->mfa), msg,
1148                     (le32_to_cpu(msg->u.head[0]) >> 16) << 2);
1149         writel(mmsg->mfa, c->in_port);
1150         mempool_free(mmsg, c->in_msg.mempool);
1151 };
1152
1153 /**
1154  *      i2o_msg_post_wait - Post and wait a message and wait until return
1155  *      @c: controller
1156  *      @msg: message to post
1157  *      @timeout: time in seconds to wait
1158  *
1159  *      This API allows an OSM to post a message and then be told whether or
1160  *      not the system received a successful reply. If the message times out
1161  *      then the value '-ETIMEDOUT' is returned.
1162  *
1163  *      Returns 0 on success or negative error code on failure.
1164  */
1165 static inline int i2o_msg_post_wait(struct i2o_controller *c,
1166                                     struct i2o_message *msg,
1167                                     unsigned long timeout)
1168 {
1169         return i2o_msg_post_wait_mem(c, msg, timeout, NULL);
1170 };
1171
1172 /**
1173  *      i2o_msg_nop_mfa - Returns a fetched MFA back to the controller
1174  *      @c: I2O controller from which the MFA was fetched
1175  *      @mfa: MFA which should be returned
1176  *
1177  *      This function must be used for preserved messages, because i2o_msg_nop()
1178  *      also returns the allocated memory back to the msg_pool mempool.
1179  */
1180 static inline void i2o_msg_nop_mfa(struct i2o_controller *c, u32 mfa)
1181 {
1182         struct i2o_message __iomem *msg;
1183         u32 nop[3] = {
1184                 THREE_WORD_MSG_SIZE | SGL_OFFSET_0,
1185                 I2O_CMD_UTIL_NOP << 24 | HOST_TID << 12 | ADAPTER_TID,
1186                 0x00000000
1187         };
1188
1189         msg = i2o_msg_in_to_virt(c, mfa);
1190         memcpy_toio(msg, nop, sizeof(nop));
1191         writel(mfa, c->in_port);
1192 };
1193
1194 /**
1195  *      i2o_msg_nop - Returns a message which is not used
1196  *      @c: I2O controller from which the message was created
1197  *      @msg: message which should be returned
1198  *
1199  *      If you fetch a message via i2o_msg_get, and can't use it, you must
1200  *      return the message with this function. Otherwise the MFA is lost as well
1201  *      as the allocated memory from the mempool.
1202  */
1203 static inline void i2o_msg_nop(struct i2o_controller *c,
1204                                struct i2o_message *msg)
1205 {
1206         struct i2o_msg_mfa *mmsg;
1207         mmsg = container_of(msg, struct i2o_msg_mfa, msg);
1208
1209         i2o_msg_nop_mfa(c, mmsg->mfa);
1210         mempool_free(mmsg, c->in_msg.mempool);
1211 };
1212
1213 /**
1214  *      i2o_flush_reply - Flush reply from I2O controller
1215  *      @c: I2O controller
1216  *      @m: the message identifier
1217  *
1218  *      The I2O controller must be informed that the reply message is not needed
1219  *      anymore. If you forget to flush the reply, the message frame can't be
1220  *      used by the controller anymore and is therefore lost.
1221  */
1222 static inline void i2o_flush_reply(struct i2o_controller *c, u32 m)
1223 {
1224         writel(m, c->out_port);
1225 };
1226
1227 /*
1228  *      Endian handling wrapped into the macro - keeps the core code
1229  *      cleaner.
1230  */
1231
1232 #define i2o_raw_writel(val, mem)        __raw_writel(cpu_to_le32(val), mem)
1233
1234 extern int i2o_parm_field_get(struct i2o_device *, int, int, void *, int);
1235 extern int i2o_parm_table_get(struct i2o_device *, int, int, int, void *, int,
1236                               void *, int);
1237
1238 /* debugging and troubleshooting/diagnostic helpers. */
1239 #define osm_printk(level, format, arg...)  \
1240         printk(level "%s: " format, OSM_NAME , ## arg)
1241
1242 #ifdef DEBUG
1243 #define osm_debug(format, arg...) \
1244         osm_printk(KERN_DEBUG, format , ## arg)
1245 #else
1246 #define osm_debug(format, arg...) \
1247         do { } while (0)
1248 #endif
1249
1250 #define osm_err(format, arg...)         \
1251         osm_printk(KERN_ERR, format , ## arg)
1252 #define osm_info(format, arg...)                \
1253         osm_printk(KERN_INFO, format , ## arg)
1254 #define osm_warn(format, arg...)                \
1255         osm_printk(KERN_WARNING, format , ## arg)
1256
1257 /* debugging functions */
1258 extern void i2o_report_status(const char *, const char *, struct i2o_message *);
1259 extern void i2o_dump_message(struct i2o_message *);
1260 extern void i2o_dump_hrt(struct i2o_controller *c);
1261 extern void i2o_debug_state(struct i2o_controller *c);
1262
1263 #endif                          /* __KERNEL__ */
1264 #endif                          /* _I2O_H */