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