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) 2000-2006 Silicon Graphics, Inc. All Rights Reserved.
10 #ifndef _ASM_IA64_SN_BTE_H
11 #define _ASM_IA64_SN_BTE_H
13 #include <linux/timer.h>
14 #include <linux/spinlock.h>
15 #include <linux/cache.h>
16 #include <asm/sn/pda.h>
17 #include <asm/sn/types.h>
18 #include <asm/sn/shub_mmr.h>
20 #define IBCT_NOTIFY (0x1UL << 4)
21 #define IBCT_ZFIL_MODE (0x1UL << 0)
23 /* #define BTE_DEBUG */
24 /* #define BTE_DEBUG_VERBOSE */
27 # define BTE_PRINTK(x) printk x /* Terse */
28 # ifdef BTE_DEBUG_VERBOSE
29 # define BTE_PRINTKV(x) printk x /* Verbose */
31 # define BTE_PRINTKV(x)
32 # endif /* BTE_DEBUG_VERBOSE */
34 # define BTE_PRINTK(x)
35 # define BTE_PRINTKV(x)
36 #endif /* BTE_DEBUG */
39 /* BTE status register only supports 16 bits for length field */
40 #define BTE_LEN_BITS (16)
41 #define BTE_LEN_MASK ((1 << BTE_LEN_BITS) - 1)
42 #define BTE_MAX_XFER ((1 << BTE_LEN_BITS) * L1_CACHE_BYTES)
46 #define BTES_PER_NODE (is_shub2() ? 4 : 2)
47 #define MAX_BTES_PER_NODE 4
49 #define BTE2OFF_CTRL 0
50 #define BTE2OFF_SRC (SH2_BT_ENG_SRC_ADDR_0 - SH2_BT_ENG_CSR_0)
51 #define BTE2OFF_DEST (SH2_BT_ENG_DEST_ADDR_0 - SH2_BT_ENG_CSR_0)
52 #define BTE2OFF_NOTIFY (SH2_BT_ENG_NOTIF_ADDR_0 - SH2_BT_ENG_CSR_0)
54 #define BTE_BASE_ADDR(interface) \
55 (is_shub2() ? (interface == 0) ? SH2_BT_ENG_CSR_0 : \
56 (interface == 1) ? SH2_BT_ENG_CSR_1 : \
57 (interface == 2) ? SH2_BT_ENG_CSR_2 : \
59 : (interface == 0) ? IIO_IBLS0 : IIO_IBLS1)
61 #define BTE_SOURCE_ADDR(base) \
62 (is_shub2() ? base + (BTE2OFF_SRC/8) \
63 : base + (BTEOFF_SRC/8))
65 #define BTE_DEST_ADDR(base) \
66 (is_shub2() ? base + (BTE2OFF_DEST/8) \
67 : base + (BTEOFF_DEST/8))
69 #define BTE_CTRL_ADDR(base) \
70 (is_shub2() ? base + (BTE2OFF_CTRL/8) \
71 : base + (BTEOFF_CTRL/8))
73 #define BTE_NOTIF_ADDR(base) \
74 (is_shub2() ? base + (BTE2OFF_NOTIFY/8) \
75 : base + (BTEOFF_NOTIFY/8))
77 /* Define hardware modes */
78 #define BTE_NOTIFY IBCT_NOTIFY
79 #define BTE_NORMAL BTE_NOTIFY
80 #define BTE_ZERO_FILL (BTE_NOTIFY | IBCT_ZFIL_MODE)
81 /* Use a reserved bit to let the caller specify a wait for any BTE */
82 #define BTE_WACQUIRE 0x4000
83 /* Use the BTE on the node with the destination memory */
84 #define BTE_USE_DEST (BTE_WACQUIRE << 1)
85 /* Use any available BTE interface on any node for the transfer */
86 #define BTE_USE_ANY (BTE_USE_DEST << 1)
87 /* macro to force the IBCT0 value valid */
88 #define BTE_VALID_MODE(x) ((x) & (IBCT_NOTIFY | IBCT_ZFIL_MODE))
90 #define BTE_ACTIVE (IBLS_BUSY | IBLS_ERROR)
91 #define BTE_WORD_AVAILABLE (IBLS_BUSY << 1)
92 #define BTE_WORD_BUSY (~BTE_WORD_AVAILABLE)
95 * Some macros to simplify reading.
96 * Start with macros to locate the BTE control registers.
98 #define BTE_LNSTAT_LOAD(_bte) \
99 HUB_L(_bte->bte_base_addr)
100 #define BTE_LNSTAT_STORE(_bte, _x) \
101 HUB_S(_bte->bte_base_addr, (_x))
102 #define BTE_SRC_STORE(_bte, _x) \
104 u64 __addr = ((_x) & ~AS_MASK); \
106 __addr = SH2_TIO_PHYS_TO_DMA(__addr); \
107 HUB_S(_bte->bte_source_addr, __addr); \
109 #define BTE_DEST_STORE(_bte, _x) \
111 u64 __addr = ((_x) & ~AS_MASK); \
113 __addr = SH2_TIO_PHYS_TO_DMA(__addr); \
114 HUB_S(_bte->bte_destination_addr, __addr); \
116 #define BTE_CTRL_STORE(_bte, _x) \
117 HUB_S(_bte->bte_control_addr, (_x))
118 #define BTE_NOTIF_STORE(_bte, _x) \
120 u64 __addr = ia64_tpa((_x) & ~AS_MASK); \
122 __addr = SH2_TIO_PHYS_TO_DMA(__addr); \
123 HUB_S(_bte->bte_notify_addr, __addr); \
126 #define BTE_START_TRANSFER(_bte, _len, _mode) \
127 is_shub2() ? BTE_CTRL_STORE(_bte, IBLS_BUSY | (_mode << 24) | _len) \
128 : BTE_LNSTAT_STORE(_bte, _len); \
129 BTE_CTRL_STORE(_bte, _mode)
131 /* Possible results from bte_copy and bte_unaligned_copy */
132 /* The following error codes map into the BTE hardware codes
133 * IIO_ICRB_ECODE_* (in shubio.h). The hardware uses
134 * an error code of 0 (IIO_ICRB_ECODE_DERR), but we want zero
135 * to mean BTE_SUCCESS, so add one (BTEFAIL_OFFSET) to the error
136 * codes to give the following error codes.
138 #define BTEFAIL_OFFSET 1
141 BTE_SUCCESS, /* 0 is success */
142 BTEFAIL_DIR, /* Directory error due to IIO access*/
143 BTEFAIL_POISON, /* poison error on IO access (write to poison page) */
144 BTEFAIL_WERR, /* Write error (ie WINV to a Read only line) */
145 BTEFAIL_ACCESS, /* access error (protection violation) */
146 BTEFAIL_PWERR, /* Partial Write Error */
147 BTEFAIL_PRERR, /* Partial Read Error */
148 BTEFAIL_TOUT, /* CRB Time out */
149 BTEFAIL_XTERR, /* Incoming xtalk pkt had error bit */
150 BTEFAIL_NOTAVAIL, /* BTE not available */
155 * Structure defining a bte. An instance of this
156 * structure is created in the nodepda for each
157 * bte on that node (as defined by BTES_PER_NODE)
158 * This structure contains everything necessary
159 * to work with a BTE.
162 volatile u64 notify ____cacheline_aligned;
163 u64 *bte_base_addr ____cacheline_aligned;
164 u64 *bte_source_addr;
165 u64 *bte_destination_addr;
166 u64 *bte_control_addr;
167 u64 *bte_notify_addr;
169 cnodeid_t bte_cnode; /* cnode */
170 int bte_error_count; /* Number of errors encountered */
171 int bte_num; /* 0 --> BTE0, 1 --> BTE1 */
172 int cleanup_active; /* Interface is locked for cleanup */
173 volatile bte_result_t bh_error; /* error while processing */
174 volatile u64 *most_rcnt_na;
175 struct bteinfo_s *btes_to_try[MAX_BTES_PER_NODE];
180 * Function prototypes (functions defined in bte.c, used elsewhere)
182 extern bte_result_t bte_copy(u64, u64, u64, u64, void *);
183 extern bte_result_t bte_unaligned_copy(u64, u64, u64, u64);
184 extern void bte_error_handler(unsigned long);
186 #define bte_zero(dest, len, mode, notification) \
187 bte_copy(0, dest, len, ((mode) | BTE_ZERO_FILL), notification)
190 * The following is the prefered way of calling bte_unaligned_copy
191 * If the copy is fully cache line aligned, then bte_copy is
192 * used instead. Since bte_copy is inlined, this saves a call
193 * stack. NOTE: bte_copy is called synchronously and does block
194 * until the transfer is complete. In order to get the asynch
195 * version of bte_copy, you must perform this check yourself.
197 #define BTE_UNALIGNED_COPY(src, dest, len, mode) \
198 (((len & L1_CACHE_MASK) || (src & L1_CACHE_MASK) || \
199 (dest & L1_CACHE_MASK)) ? \
200 bte_unaligned_copy(src, dest, len, mode) : \
201 bte_copy(src, dest, len, mode, NULL))
204 #endif /* _ASM_IA64_SN_BTE_H */