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