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