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
6 * Copyright (C) 2004-2008 Silicon Graphics, Inc. All rights reserved.
10 * External Cross Partition (XP) structures and defines.
13 #ifndef _DRIVERS_MISC_SGIXP_XP_H
14 #define _DRIVERS_MISC_SGIXP_XP_H
16 #include <linux/cache.h>
17 #include <linux/hardirq.h>
18 #include <linux/mutex.h>
19 #include <asm/sn/types.h>
20 #include <asm/sn/bte.h>
23 #define DBUG_ON(condition) BUG_ON(condition)
25 #define DBUG_ON(condition)
37 #define is_shub() (is_shub1() || is_shub2())
45 * Define the maximum number of logically defined partitions the system
46 * can support. It is constrained by the maximum number of hardware
47 * partitionable regions. The term 'region' in this context refers to the
48 * minimum number of nodes that can comprise an access protection grouping.
49 * The access protection is in regards to memory, IPI and IOI.
51 * The maximum number of hardware partitionable regions is equal to the
52 * maximum number of nodes in the entire system divided by the minimum number
53 * of nodes that comprise an access protection grouping.
55 #define XP_MAX_PARTITIONS 64
58 * Define the number of u64s required to represent all the C-brick nasids
59 * as a bitmap. The cross-partition kernel modules deal only with
60 * C-brick nasids, thus the need for bitmaps which don't account for
61 * odd-numbered (non C-brick) nasids.
63 #define XP_MAX_PHYSNODE_ID (MAX_NUMALINK_NODES / 2)
64 #define XP_NASID_MASK_BYTES ((XP_MAX_PHYSNODE_ID + 7) / 8)
65 #define XP_NASID_MASK_WORDS ((XP_MAX_PHYSNODE_ID + 63) / 64)
68 * Wrapper for bte_copy() that should it return a failure status will retry
69 * the bte_copy() once in the hope that the failure was due to a temporary
70 * aberration (i.e., the link going down temporarily).
72 * src - physical address of the source of the transfer.
73 * vdst - virtual address of the destination of the transfer.
74 * len - number of bytes to transfer from source to destination.
75 * mode - see bte_copy() for definition.
76 * notification - see bte_copy() for definition.
78 * Note: xp_bte_copy() should never be called while holding a spinlock.
80 static inline bte_result_t
81 xp_bte_copy(u64 src, u64 vdst, u64 len, u64 mode, void *notification)
84 u64 pdst = ia64_tpa(vdst);
87 * Ensure that the physically mapped memory is contiguous.
89 * We do this by ensuring that the memory is from region 7 only.
90 * If the need should arise to use memory from one of the other
91 * regions, then modify the BUG_ON() statement to ensure that the
92 * memory from that region is always physically contiguous.
94 BUG_ON(REGION_NUMBER(vdst) != RGN_KERNEL);
96 ret = bte_copy(src, pdst, len, mode, notification);
97 if ((ret != BTE_SUCCESS) && BTE_ERROR_RETRY(ret)) {
101 ret = bte_copy(src, pdst, len, mode, notification);
108 * XPC establishes channel connections between the local partition and any
109 * other partition that is currently up. Over these channels, kernel-level
110 * `users' can communicate with their counterparts on the other partitions.
112 * The maxinum number of channels is limited to eight. For performance reasons,
113 * the internal cross partition structures require sixteen bytes per channel,
114 * and eight allows all of this interface-shared info to fit in one cache line.
116 * XPC_NCHANNELS reflects the total number of channels currently defined.
117 * If the need for additional channels arises, one can simply increase
118 * XPC_NCHANNELS accordingly. If the day should come where that number
119 * exceeds the MAXIMUM number of channels allowed (eight), then one will need
120 * to make changes to the XPC code to allow for this.
122 #define XPC_MEM_CHANNEL 0 /* memory channel number */
123 #define XPC_NET_CHANNEL 1 /* network channel number */
125 #define XPC_NCHANNELS 2 /* #of defined channels */
126 #define XPC_MAX_NCHANNELS 8 /* max #of channels allowed */
128 #if XPC_NCHANNELS > XPC_MAX_NCHANNELS
129 #error XPC_NCHANNELS exceeds MAXIMUM allowed.
133 * The format of an XPC message is as follows:
135 * +-------+--------------------------------+
136 * | flags |////////////////////////////////|
137 * +-------+--------------------------------+
139 * +----------------------------------------+
140 * | payload (user-defined message) |
144 * +----------------------------------------+
146 * The size of the payload is defined by the user via xpc_connect(). A user-
147 * defined message resides in the payload area.
149 * The user should have no dealings with the message header, but only the
150 * message's payload. When a message entry is allocated (via xpc_allocate())
151 * a pointer to the payload area is returned and not the actual beginning of
152 * the XPC message. The user then constructs a message in the payload area
153 * and passes that pointer as an argument on xpc_send() or xpc_send_notify().
155 * The size of a message entry (within a message queue) must be a cacheline
156 * sized multiple in order to facilitate the BTE transfer of messages from one
157 * message queue to another. A macro, XPC_MSG_SIZE(), is provided for the user
158 * that wants to fit as many msg entries as possible in a given memory size
159 * (e.g. a memory page).
162 u8 flags; /* FOR XPC INTERNAL USE ONLY */
163 u8 reserved[7]; /* FOR XPC INTERNAL USE ONLY */
164 s64 number; /* FOR XPC INTERNAL USE ONLY */
166 u64 payload; /* user defined portion of message */
169 #define XPC_MSG_PAYLOAD_OFFSET (u64) (&((struct xpc_msg *)0)->payload)
170 #define XPC_MSG_SIZE(_payload_size) \
171 L1_CACHE_ALIGN(XPC_MSG_PAYLOAD_OFFSET + (_payload_size))
174 * Define the return values and values passed to user's callout functions.
175 * (It is important to add new value codes at the end just preceding
176 * xpUnknownReason, which must have the highest numerical value.)
181 xpNotConnected, /* 1: channel is not connected */
182 xpConnected, /* 2: channel connected (opened) */
183 xpRETIRED1, /* 3: (formerly xpDisconnected) */
185 xpMsgReceived, /* 4: message received */
186 xpMsgDelivered, /* 5: message delivered and acknowledged */
188 xpRETIRED2, /* 6: (formerly xpTransferFailed) */
190 xpNoWait, /* 7: operation would require wait */
191 xpRetry, /* 8: retry operation */
192 xpTimeout, /* 9: timeout in xpc_allocate_msg_wait() */
193 xpInterrupted, /* 10: interrupted wait */
195 xpUnequalMsgSizes, /* 11: message size disparity between sides */
196 xpInvalidAddress, /* 12: invalid address */
198 xpNoMemory, /* 13: no memory available for XPC structures */
199 xpLackOfResources, /* 14: insufficient resources for operation */
200 xpUnregistered, /* 15: channel is not registered */
201 xpAlreadyRegistered, /* 16: channel is already registered */
203 xpPartitionDown, /* 17: remote partition is down */
204 xpNotLoaded, /* 18: XPC module is not loaded */
205 xpUnloading, /* 19: this side is unloading XPC module */
207 xpBadMagic, /* 20: XPC MAGIC string not found */
209 xpReactivating, /* 21: remote partition was reactivated */
211 xpUnregistering, /* 22: this side is unregistering channel */
212 xpOtherUnregistering, /* 23: other side is unregistering channel */
214 xpCloneKThread, /* 24: cloning kernel thread */
215 xpCloneKThreadFailed, /* 25: cloning kernel thread failed */
217 xpNoHeartbeat, /* 26: remote partition has no heartbeat */
219 xpPioReadError, /* 27: PIO read error */
220 xpPhysAddrRegFailed, /* 28: registration of phys addr range failed */
222 xpRETIRED3, /* 29: (formerly xpBteDirectoryError) */
223 xpRETIRED4, /* 30: (formerly xpBtePoisonError) */
224 xpRETIRED5, /* 31: (formerly xpBteWriteError) */
225 xpRETIRED6, /* 32: (formerly xpBteAccessError) */
226 xpRETIRED7, /* 33: (formerly xpBtePWriteError) */
227 xpRETIRED8, /* 34: (formerly xpBtePReadError) */
228 xpRETIRED9, /* 35: (formerly xpBteTimeOutError) */
229 xpRETIRED10, /* 36: (formerly xpBteXtalkError) */
230 xpRETIRED11, /* 37: (formerly xpBteNotAvailable) */
231 xpRETIRED12, /* 38: (formerly xpBteUnmappedError) */
233 xpBadVersion, /* 39: bad version number */
234 xpVarsNotSet, /* 40: the XPC variables are not set up */
235 xpNoRsvdPageAddr, /* 41: unable to get rsvd page's phys addr */
236 xpInvalidPartid, /* 42: invalid partition ID */
237 xpLocalPartid, /* 43: local partition ID */
239 xpOtherGoingDown, /* 44: other side going down, reason unknown */
240 xpSystemGoingDown, /* 45: system is going down, reason unknown */
241 xpSystemHalt, /* 46: system is being halted */
242 xpSystemReboot, /* 47: system is being rebooted */
243 xpSystemPoweroff, /* 48: system is being powered off */
245 xpDisconnecting, /* 49: channel disconnecting (closing) */
247 xpOpenCloseError, /* 50: channel open/close protocol error */
249 xpDisconnected, /* 51: channel disconnected (closed) */
251 xpBteCopyError, /* 52: bte_copy() returned error */
253 xpUnknownReason /* 53: unknown reason - must be last in enum */
257 * Define the callout function type used by XPC to update the user on
258 * connection activity and state changes via the user function registered
263 * reason - reason code.
264 * partid - partition ID associated with condition.
265 * ch_number - channel # associated with condition.
266 * data - pointer to optional data.
267 * key - pointer to optional user-defined value provided as the "key"
268 * argument to xpc_connect().
270 * A reason code of xpConnected indicates that a connection has been
271 * established to the specified partition on the specified channel. The data
272 * argument indicates the max number of entries allowed in the message queue.
274 * A reason code of xpMsgReceived indicates that a XPC message arrived from
275 * the specified partition on the specified channel. The data argument
276 * specifies the address of the message's payload. The user must call
277 * xpc_received() when finished with the payload.
279 * All other reason codes indicate failure. The data argmument is NULL.
280 * When a failure reason code is received, one can assume that the channel
283 typedef void (*xpc_channel_func) (enum xp_retval reason, short partid,
284 int ch_number, void *data, void *key);
287 * Define the callout function type used by XPC to notify the user of
288 * messages received and delivered via the user function registered by
293 * reason - reason code.
294 * partid - partition ID associated with condition.
295 * ch_number - channel # associated with condition.
296 * key - pointer to optional user-defined value provided as the "key"
297 * argument to xpc_send_notify().
299 * A reason code of xpMsgDelivered indicates that the message was delivered
300 * to the intended recipient and that they have acknowledged its receipt by
301 * calling xpc_received().
303 * All other reason codes indicate failure.
305 typedef void (*xpc_notify_func) (enum xp_retval reason, short partid,
306 int ch_number, void *key);
309 * The following is a registration entry. There is a global array of these,
310 * one per channel. It is used to record the connection registration made
311 * by the users of XPC. As long as a registration entry exists, for any
312 * partition that comes up, XPC will attempt to establish a connection on
313 * that channel. Notification that a connection has been made will occur via
314 * the xpc_channel_func function.
316 * The 'func' field points to the function to call when aynchronous
317 * notification is required for such events as: a connection established/lost,
318 * or an incoming message received, or an error condition encountered. A
319 * non-NULL 'func' field indicates that there is an active registration for
322 struct xpc_registration {
324 xpc_channel_func func; /* function to call */
325 void *key; /* pointer to user's key */
326 u16 nentries; /* #of msg entries in local msg queue */
327 u16 msg_size; /* message queue's message size */
328 u32 assigned_limit; /* limit on #of assigned kthreads */
329 u32 idle_limit; /* limit on #of idle kthreads */
330 } ____cacheline_aligned;
332 #define XPC_CHANNEL_REGISTERED(_c) (xpc_registrations[_c].func != NULL)
334 /* the following are valid xpc_allocate() flags */
335 #define XPC_WAIT 0 /* wait flag */
336 #define XPC_NOWAIT 1 /* no wait flag */
338 struct xpc_interface {
339 void (*connect) (int);
340 void (*disconnect) (int);
341 enum xp_retval (*allocate) (short, int, u32, void **);
342 enum xp_retval (*send) (short, int, void *);
343 enum xp_retval (*send_notify) (short, int, void *,
344 xpc_notify_func, void *);
345 void (*received) (short, int, void *);
346 enum xp_retval (*partid_to_nasids) (short, void *);
349 extern struct xpc_interface xpc_interface;
351 extern void xpc_set_interface(void (*)(int),
353 enum xp_retval (*)(short, int, u32, void **),
354 enum xp_retval (*)(short, int, void *),
355 enum xp_retval (*)(short, int, void *,
356 xpc_notify_func, void *),
357 void (*)(short, int, void *),
358 enum xp_retval (*)(short, void *));
359 extern void xpc_clear_interface(void);
361 extern enum xp_retval xpc_connect(int, xpc_channel_func, void *, u16,
363 extern void xpc_disconnect(int);
365 static inline enum xp_retval
366 xpc_allocate(short partid, int ch_number, u32 flags, void **payload)
368 return xpc_interface.allocate(partid, ch_number, flags, payload);
371 static inline enum xp_retval
372 xpc_send(short partid, int ch_number, void *payload)
374 return xpc_interface.send(partid, ch_number, payload);
377 static inline enum xp_retval
378 xpc_send_notify(short partid, int ch_number, void *payload,
379 xpc_notify_func func, void *key)
381 return xpc_interface.send_notify(partid, ch_number, payload, func, key);
385 xpc_received(short partid, int ch_number, void *payload)
387 return xpc_interface.received(partid, ch_number, payload);
390 static inline enum xp_retval
391 xpc_partid_to_nasids(short partid, void *nasids)
393 return xpc_interface.partid_to_nasids(partid, nasids);
396 extern u64 xp_nofault_PIOR_target;
397 extern int xp_nofault_PIOR(void *);
398 extern int xp_error_PIOR(void);
400 #endif /* _DRIVERS_MISC_SGIXP_XP_H */