err.no Git - linux-2.6/blob - drivers/misc/sgi-xp/xp.h

   1 /*
   2  * This file is subject to the terms and conditions of the GNU General Public
   3  * License.  See the file "COPYING" in the main directory of this archive
   4  * for more details.
   5  *
   6  * Copyright (C) 2004-2008 Silicon Graphics, Inc. All rights reserved.
   7  */
   8
   9 /*
  10  * External Cross Partition (XP) structures and defines.
  11  */
  12
  13 #ifndef _DRIVERS_MISC_SGIXP_XP_H
  14 #define _DRIVERS_MISC_SGIXP_XP_H
  15
  16 #include <linux/cache.h>
  17 #include <linux/hardirq.h>
  18 #include <linux/mutex.h>
  19 #include <asm/sn/types.h>
  20 #ifdef CONFIG_IA64
  21 #include <asm/sn/arch.h>
  22 #endif
  23
  24 /* >>> Add this #define to some linux header file some day. */
  25 #define BYTES_PER_WORD  sizeof(void *)
  26
  27 #ifdef USE_DBUG_ON
  28 #define DBUG_ON(condition)      BUG_ON(condition)
  29 #else
  30 #define DBUG_ON(condition)
  31 #endif
  32
  33 #ifndef is_shub1
  34 #define is_shub1()      0
  35 #endif
  36
  37 #ifndef is_shub2
  38 #define is_shub2()      0
  39 #endif
  40
  41 #ifndef is_shub
  42 #define is_shub()       (is_shub1() || is_shub2())
  43 #endif
  44
  45 #ifndef is_uv
  46 #define is_uv()         0
  47 #endif
  48
  49 /*
  50  * Define the maximum number of partitions the system can possibly support.
  51  * It is based on the maximum number of hardware partitionable regions. The
  52  * term 'region' in this context refers to the minimum number of nodes that
  53  * can comprise an access protection grouping. The access protection is in
  54  * regards to memory, IPI and IOI.
  55  *
  56  * The maximum number of hardware partitionable regions is equal to the
  57  * maximum number of nodes in the entire system divided by the minimum number
  58  * of nodes that comprise an access protection grouping.
  59  */
  60 #define XP_MAX_NPARTITIONS_SN2  64
  61 #define XP_MAX_NPARTITIONS_UV   256
  62
  63 /*
  64  * XPC establishes channel connections between the local partition and any
  65  * other partition that is currently up. Over these channels, kernel-level
  66  * `users' can communicate with their counterparts on the other partitions.
  67  *
  68 >>> The following described limitation of a max of eight channels possible
  69 >>> pertains only to ia64-sn2. THIS ISN'T TRUE SINCE I'M PLANNING TO JUST
  70 >>> TIE INTO THE EXISTING MECHANISM ONCE THE CHANNEL MESSAGES ARE RECEIVED.
  71 >>> THE 128-BYTE CACHELINE PERFORMANCE ISSUE IS TIED TO IA64-SN2.
  72  *
  73  * If the need for additional channels arises, one can simply increase
  74  * XPC_MAX_NCHANNELS accordingly. If the day should come where that number
  75  * exceeds the absolute MAXIMUM number of channels possible (eight), then one
  76  * will need to make changes to the XPC code to accommodate for this.
  77  *
  78  * The absolute maximum number of channels possible is currently limited to
  79  * eight for performance reasons. The internal cross partition structures
  80  * require sixteen bytes per channel, and eight allows all of this
  81  * interface-shared info to fit in one 128-byte cacheline.
  82  */
  83 #define XPC_MEM_CHANNEL         0       /* memory channel number */
  84 #define XPC_NET_CHANNEL         1       /* network channel number */
  85
  86 #define XPC_MAX_NCHANNELS       2       /* max #of channels allowed */
  87
  88 #if XPC_MAX_NCHANNELS > 8
  89 #error  XPC_MAX_NCHANNELS exceeds absolute MAXIMUM possible.
  90 #endif
  91
  92 /*
  93  * The format of an XPC message is as follows:
  94  *
  95  *      +-------+--------------------------------+
  96  *      | flags |////////////////////////////////|
  97  *      +-------+--------------------------------+
  98  *      |             message #                  |
  99  *      +----------------------------------------+
 100  *      |     payload (user-defined message)     |
 101  *      |                                        |
 102  *                      :
 103  *      |                                        |
 104  *      +----------------------------------------+
 105  *
 106  * The size of the payload is defined by the user via xpc_connect(). A user-
 107  * defined message resides in the payload area.
 108  *
 109  * The size of a message entry (within a message queue) must be a cacheline
 110  * sized multiple in order to facilitate the BTE transfer of messages from one
 111  * message queue to another. A macro, XPC_MSG_SIZE(), is provided for the user
 112  * that wants to fit as many msg entries as possible in a given memory size
 113  * (e.g. a memory page).
 114  */
 115 struct xpc_msg {
 116         u8 flags;               /* FOR XPC INTERNAL USE ONLY */
 117         u8 reserved[7];         /* FOR XPC INTERNAL USE ONLY */
 118         s64 number;             /* FOR XPC INTERNAL USE ONLY */
 119
 120         u64 payload;            /* user defined portion of message */
 121 };
 122
 123 #define XPC_MSG_PAYLOAD_OFFSET  (u64) (&((struct xpc_msg *)0)->payload)
 124 #define XPC_MSG_SIZE(_payload_size) \
 125                 L1_CACHE_ALIGN(XPC_MSG_PAYLOAD_OFFSET + (_payload_size))
 126
 127 /*
 128  * Define the return values and values passed to user's callout functions.
 129  * (It is important to add new value codes at the end just preceding
 130  * xpUnknownReason, which must have the highest numerical value.)
 131  */
 132 enum xp_retval {
 133         xpSuccess = 0,
 134
 135         xpNotConnected,         /*  1: channel is not connected */
 136         xpConnected,            /*  2: channel connected (opened) */
 137         xpRETIRED1,             /*  3: (formerly xpDisconnected) */
 138
 139         xpMsgReceived,          /*  4: message received */
 140         xpMsgDelivered,         /*  5: message delivered and acknowledged */
 141
 142         xpRETIRED2,             /*  6: (formerly xpTransferFailed) */
 143
 144         xpNoWait,               /*  7: operation would require wait */
 145         xpRetry,                /*  8: retry operation */
 146         xpTimeout,              /*  9: timeout in xpc_allocate_msg_wait() */
 147         xpInterrupted,          /* 10: interrupted wait */
 148
 149         xpUnequalMsgSizes,      /* 11: message size disparity between sides */
 150         xpInvalidAddress,       /* 12: invalid address */
 151
 152         xpNoMemory,             /* 13: no memory available for XPC structures */
 153         xpLackOfResources,      /* 14: insufficient resources for operation */
 154         xpUnregistered,         /* 15: channel is not registered */
 155         xpAlreadyRegistered,    /* 16: channel is already registered */
 156
 157         xpPartitionDown,        /* 17: remote partition is down */
 158         xpNotLoaded,            /* 18: XPC module is not loaded */
 159         xpUnloading,            /* 19: this side is unloading XPC module */
 160
 161         xpBadMagic,             /* 20: XPC MAGIC string not found */
 162
 163         xpReactivating,         /* 21: remote partition was reactivated */
 164
 165         xpUnregistering,        /* 22: this side is unregistering channel */
 166         xpOtherUnregistering,   /* 23: other side is unregistering channel */
 167
 168         xpCloneKThread,         /* 24: cloning kernel thread */
 169         xpCloneKThreadFailed,   /* 25: cloning kernel thread failed */
 170
 171         xpNoHeartbeat,          /* 26: remote partition has no heartbeat */
 172
 173         xpPioReadError,         /* 27: PIO read error */
 174         xpPhysAddrRegFailed,    /* 28: registration of phys addr range failed */
 175
 176         xpRETIRED3,             /* 29: (formerly xpBteDirectoryError) */
 177         xpRETIRED4,             /* 30: (formerly xpBtePoisonError) */
 178         xpRETIRED5,             /* 31: (formerly xpBteWriteError) */
 179         xpRETIRED6,             /* 32: (formerly xpBteAccessError) */
 180         xpRETIRED7,             /* 33: (formerly xpBtePWriteError) */
 181         xpRETIRED8,             /* 34: (formerly xpBtePReadError) */
 182         xpRETIRED9,             /* 35: (formerly xpBteTimeOutError) */
 183         xpRETIRED10,            /* 36: (formerly xpBteXtalkError) */
 184         xpRETIRED11,            /* 37: (formerly xpBteNotAvailable) */
 185         xpRETIRED12,            /* 38: (formerly xpBteUnmappedError) */
 186
 187         xpBadVersion,           /* 39: bad version number */
 188         xpVarsNotSet,           /* 40: the XPC variables are not set up */
 189         xpNoRsvdPageAddr,       /* 41: unable to get rsvd page's phys addr */
 190         xpInvalidPartid,        /* 42: invalid partition ID */
 191         xpLocalPartid,          /* 43: local partition ID */
 192
 193         xpOtherGoingDown,       /* 44: other side going down, reason unknown */
 194         xpSystemGoingDown,      /* 45: system is going down, reason unknown */
 195         xpSystemHalt,           /* 46: system is being halted */
 196         xpSystemReboot,         /* 47: system is being rebooted */
 197         xpSystemPoweroff,       /* 48: system is being powered off */
 198
 199         xpDisconnecting,        /* 49: channel disconnecting (closing) */
 200
 201         xpOpenCloseError,       /* 50: channel open/close protocol error */
 202
 203         xpDisconnected,         /* 51: channel disconnected (closed) */
 204
 205         xpBteCopyError,         /* 52: bte_copy() returned error */
 206         xpSalError,             /* 53: sn SAL error */
 207         xpRsvdPageNotSet,       /* 54: the reserved page is not set up */
 208         xpPayloadTooBig,        /* 55: payload too large for message slot */
 209
 210         xpUnsupported,          /* 56: unsupported functionality or resource */
 211         xpUnknownReason         /* 57: unknown reason - must be last in enum */
 212 };
 213
 214 /*
 215  * Define the callout function type used by XPC to update the user on
 216  * connection activity and state changes via the user function registered
 217  * by xpc_connect().
 218  *
 219  * Arguments:
 220  *
 221  *      reason - reason code.
 222  *      partid - partition ID associated with condition.
 223  *      ch_number - channel # associated with condition.
 224  *      data - pointer to optional data.
 225  *      key - pointer to optional user-defined value provided as the "key"
 226  *            argument to xpc_connect().
 227  *
 228  * A reason code of xpConnected indicates that a connection has been
 229  * established to the specified partition on the specified channel. The data
 230  * argument indicates the max number of entries allowed in the message queue.
 231  *
 232  * A reason code of xpMsgReceived indicates that a XPC message arrived from
 233  * the specified partition on the specified channel. The data argument
 234  * specifies the address of the message's payload. The user must call
 235  * xpc_received() when finished with the payload.
 236  *
 237  * All other reason codes indicate failure. The data argmument is NULL.
 238  * When a failure reason code is received, one can assume that the channel
 239  * is not connected.
 240  */
 241 typedef void (*xpc_channel_func) (enum xp_retval reason, short partid,
 242                                   int ch_number, void *data, void *key);
 243
 244 /*
 245  * Define the callout function type used by XPC to notify the user of
 246  * messages received and delivered via the user function registered by
 247  * xpc_send_notify().
 248  *
 249  * Arguments:
 250  *
 251  *      reason - reason code.
 252  *      partid - partition ID associated with condition.
 253  *      ch_number - channel # associated with condition.
 254  *      key - pointer to optional user-defined value provided as the "key"
 255  *            argument to xpc_send_notify().
 256  *
 257  * A reason code of xpMsgDelivered indicates that the message was delivered
 258  * to the intended recipient and that they have acknowledged its receipt by
 259  * calling xpc_received().
 260  *
 261  * All other reason codes indicate failure.
 262  */
 263 typedef void (*xpc_notify_func) (enum xp_retval reason, short partid,
 264                                  int ch_number, void *key);
 265
 266 /*
 267  * The following is a registration entry. There is a global array of these,
 268  * one per channel. It is used to record the connection registration made
 269  * by the users of XPC. As long as a registration entry exists, for any
 270  * partition that comes up, XPC will attempt to establish a connection on
 271  * that channel. Notification that a connection has been made will occur via
 272  * the xpc_channel_func function.
 273  *
 274  * The 'func' field points to the function to call when aynchronous
 275  * notification is required for such events as: a connection established/lost,
 276  * or an incoming message received, or an error condition encountered. A
 277  * non-NULL 'func' field indicates that there is an active registration for
 278  * the channel.
 279  */
 280 struct xpc_registration {
 281         struct mutex mutex;
 282         xpc_channel_func func;  /* function to call */
 283         void *key;              /* pointer to user's key */
 284         u16 nentries;           /* #of msg entries in local msg queue */
 285         u16 msg_size;           /* message queue's message size */
 286         u32 assigned_limit;     /* limit on #of assigned kthreads */
 287         u32 idle_limit;         /* limit on #of idle kthreads */
 288 } ____cacheline_aligned;
 289
 290 #define XPC_CHANNEL_REGISTERED(_c)      (xpc_registrations[_c].func != NULL)
 291
 292 /* the following are valid xpc_send() or xpc_send_notify() flags */
 293 #define XPC_WAIT        0       /* wait flag */
 294 #define XPC_NOWAIT      1       /* no wait flag */
 295
 296 struct xpc_interface {
 297         void (*connect) (int);
 298         void (*disconnect) (int);
 299         enum xp_retval (*send) (short, int, u32, void *, u16);
 300         enum xp_retval (*send_notify) (short, int, u32, void *, u16,
 301                                         xpc_notify_func, void *);
 302         void (*received) (short, int, void *);
 303         enum xp_retval (*partid_to_nasids) (short, void *);
 304 };
 305
 306 extern struct xpc_interface xpc_interface;
 307
 308 extern void xpc_set_interface(void (*)(int),
 309                               void (*)(int),
 310                               enum xp_retval (*)(short, int, u32, void *, u16),
 311                               enum xp_retval (*)(short, int, u32, void *, u16,
 312                                                  xpc_notify_func, void *),
 313                               void (*)(short, int, void *),
 314                               enum xp_retval (*)(short, void *));
 315 extern void xpc_clear_interface(void);
 316
 317 extern enum xp_retval xpc_connect(int, xpc_channel_func, void *, u16,
 318                                    u16, u32, u32);
 319 extern void xpc_disconnect(int);
 320
 321 static inline enum xp_retval
 322 xpc_send(short partid, int ch_number, u32 flags, void *payload,
 323          u16 payload_size)
 324 {
 325         return xpc_interface.send(partid, ch_number, flags, payload,
 326                                   payload_size);
 327 }
 328
 329 static inline enum xp_retval
 330 xpc_send_notify(short partid, int ch_number, u32 flags, void *payload,
 331                 u16 payload_size, xpc_notify_func func, void *key)
 332 {
 333         return xpc_interface.send_notify(partid, ch_number, flags, payload,
 334                                          payload_size, func, key);
 335 }
 336
 337 static inline void
 338 xpc_received(short partid, int ch_number, void *payload)
 339 {
 340         return xpc_interface.received(partid, ch_number, payload);
 341 }
 342
 343 static inline enum xp_retval
 344 xpc_partid_to_nasids(short partid, void *nasids)
 345 {
 346         return xpc_interface.partid_to_nasids(partid, nasids);
 347 }
 348
 349 extern short xp_max_npartitions;
 350
 351 extern enum xp_retval (*xp_remote_memcpy) (void *, const void *, size_t);
 352
 353 extern u64 xp_nofault_PIOR_target;
 354 extern int xp_nofault_PIOR(void *);
 355 extern int xp_error_PIOR(void);
 356
 357 extern struct device *xp;
 358 extern enum xp_retval xp_init_sn2(void);
 359 extern enum xp_retval xp_init_uv(void);
 360 extern void xp_exit_sn2(void);
 361 extern void xp_exit_uv(void);
 362
 363 #endif /* _DRIVERS_MISC_SGIXP_XP_H */